Docs Home
gcp.kms.getKeyRings
Explore with Pulumi AI
Provides access to all Google Cloud Platform KMS CryptoKeyRings in a set location. For more information see the official documentation and API.
A key ring organizes keys in a specific Google Cloud location and lets you manage access control on groups of keys. A key ring’s name does not need to be unique across a Google Cloud project, but must be unique within a given location. After creation, a key ring cannot be deleted. Key rings don’t incur any costs.
Using getKeyRings
Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.
function getKeyRings(args: GetKeyRingsArgs, opts?: InvokeOptions): Promise<GetKeyRingsResult>
function getKeyRingsOutput(args: GetKeyRingsOutputArgs, opts?: InvokeOptions): Output<GetKeyRingsResult>def get_key_rings(filter: Optional[str] = None,
location: Optional[str] = None,
project: Optional[str] = None,
opts: Optional[InvokeOptions] = None) -> GetKeyRingsResult
def get_key_rings_output(filter: Optional[pulumi.Input[str]] = None,
location: Optional[pulumi.Input[str]] = None,
project: Optional[pulumi.Input[str]] = None,
opts: Optional[InvokeOptions] = None) -> Output[GetKeyRingsResult]func GetKeyRings(ctx *Context, args *GetKeyRingsArgs, opts ...InvokeOption) (*GetKeyRingsResult, error)
func GetKeyRingsOutput(ctx *Context, args *GetKeyRingsOutputArgs, opts ...InvokeOption) GetKeyRingsResultOutput> Note: This function is named GetKeyRings in the Go SDK.
public static class GetKeyRings
{
public static Task<GetKeyRingsResult> InvokeAsync(GetKeyRingsArgs args, InvokeOptions? opts = null)
public static Output<GetKeyRingsResult> Invoke(GetKeyRingsInvokeArgs args, InvokeOptions? opts = null)
}public static CompletableFuture<GetKeyRingsResult> getKeyRings(GetKeyRingsArgs args, InvokeOptions options)
public static Output<GetKeyRingsResult> getKeyRings(GetKeyRingsArgs args, InvokeOptions options)
fn::invoke:
function: gcp:kms/getKeyRings:getKeyRings
arguments:
# arguments dictionaryThe following arguments are supported:
- Location string
- The location that the underlying key ring resides in. e.g us-west1
- Filter string
The filter argument is used to add a filter query parameter that limits which key rings are retrieved by the data source: ?filter={{filter}}. When no value is provided there is no filtering.
Example filter values if filtering on name. Note: names take the form projects/{{project}}/locations/{{location}}/keyRings/{{keyRing}}.
"name:my-key-"will retrieve key rings that contain "my-key-" anywhere in their name."name=projects/my-project/locations/global/keyRings/my-key-ring"will only retrieve a key with that exact name.
- Project string
- The Project ID of the project.
- Location string
- The location that the underlying key ring resides in. e.g us-west1
- Filter string
The filter argument is used to add a filter query parameter that limits which key rings are retrieved by the data source: ?filter={{filter}}. When no value is provided there is no filtering.
Example filter values if filtering on name. Note: names take the form projects/{{project}}/locations/{{location}}/keyRings/{{keyRing}}.
"name:my-key-"will retrieve key rings that contain "my-key-" anywhere in their name."name=projects/my-project/locations/global/keyRings/my-key-ring"will only retrieve a key with that exact name.
- Project string
- The Project ID of the project.
- location String
- The location that the underlying key ring resides in. e.g us-west1
- filter String
The filter argument is used to add a filter query parameter that limits which key rings are retrieved by the data source: ?filter={{filter}}. When no value is provided there is no filtering.
Example filter values if filtering on name. Note: names take the form projects/{{project}}/locations/{{location}}/keyRings/{{keyRing}}.
"name:my-key-"will retrieve key rings that contain "my-key-" anywhere in their name."name=projects/my-project/locations/global/keyRings/my-key-ring"will only retrieve a key with that exact name.
- project String
- The Project ID of the project.
- location string
- The location that the underlying key ring resides in. e.g us-west1
- filter string
The filter argument is used to add a filter query parameter that limits which key rings are retrieved by the data source: ?filter={{filter}}. When no value is provided there is no filtering.
Example filter values if filtering on name. Note: names take the form projects/{{project}}/locations/{{location}}/keyRings/{{keyRing}}.
"name:my-key-"will retrieve key rings that contain "my-key-" anywhere in their name."name=projects/my-project/locations/global/keyRings/my-key-ring"will only retrieve a key with that exact name.
- project string
- The Project ID of the project.
- location str
- The location that the underlying key ring resides in. e.g us-west1
- filter str
The filter argument is used to add a filter query parameter that limits which key rings are retrieved by the data source: ?filter={{filter}}. When no value is provided there is no filtering.
Example filter values if filtering on name. Note: names take the form projects/{{project}}/locations/{{location}}/keyRings/{{keyRing}}.
"name:my-key-"will retrieve key rings that contain "my-key-" anywhere in their name."name=projects/my-project/locations/global/keyRings/my-key-ring"will only retrieve a key with that exact name.
- project str
- The Project ID of the project.
- location String
- The location that the underlying key ring resides in. e.g us-west1
- filter String
The filter argument is used to add a filter query parameter that limits which key rings are retrieved by the data source: ?filter={{filter}}. When no value is provided there is no filtering.
Example filter values if filtering on name. Note: names take the form projects/{{project}}/locations/{{location}}/keyRings/{{keyRing}}.
"name:my-key-"will retrieve key rings that contain "my-key-" anywhere in their name."name=projects/my-project/locations/global/keyRings/my-key-ring"will only retrieve a key with that exact name.
- project String
- The Project ID of the project.
getKeyRings Result
The following output properties are available:
Supporting Types
GetKeyRingsKeyRing
Package Details
- Repository
- Google Cloud (GCP) Classic pulumi/pulumi-gcp
- License
- Apache-2.0
- Notes
- This Pulumi package is based on the
google-betaTerraform Provider.