pulumi-gcp-kotlin/com.pulumi.gcp.kms.kotlin/KmsFunctions/getKeyRings

getKeyRings

suspend fun getKeyRings(argument: GetKeyRingsPlainArgs): GetKeyRingsResult

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.

Return

A collection of values returned by getKeyRings.

Parameters

argument

A collection of arguments for invoking getKeyRings.

suspend fun getKeyRings(filter: String? = null, location: String, project: String? = null): GetKeyRingsResult

Return

A collection of values returned by getKeyRings.

Parameters

filter

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. See the documentation about using filters

location

The location that the underlying key ring resides in. e.g us-west1

project

The Project ID of the project.

See also

.

suspend fun getKeyRings(argument: suspend GetKeyRingsPlainArgsBuilder.() -> Unit): GetKeyRingsResult

Return

A collection of values returned by getKeyRings.

Parameters

argument

Builder for com.pulumi.gcp.kms.kotlin.inputs.GetKeyRingsPlainArgs.

See also

.