Package com.hashicorp.cdktf.providers.google.data_google_kms_crypto_keys

Interface DataGoogleKmsCryptoKeysConfig

All Superinterfaces:

software.amazon.jsii.JsiiSerializable, com.hashicorp.cdktf.TerraformMetaArguments

All Known Implementing Classes:

DataGoogleKmsCryptoKeysConfig.Jsii$Proxy

@Generated(value="jsii-pacmak/1.102.0 (build e354887)",
           date="2024-08-31T03:59:19.956Z")
@Stability(Stable)
public interface DataGoogleKmsCryptoKeysConfig
extends software.amazon.jsii.JsiiSerializable, com.hashicorp.cdktf.TerraformMetaArguments

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static class	DataGoogleKmsCryptoKeysConfig.Builder	A builder for DataGoogleKmsCryptoKeysConfig
static class	DataGoogleKmsCryptoKeysConfig.Jsii$Proxy	An implementation for DataGoogleKmsCryptoKeysConfig

Method Summary

Modifier and Type	Method	Description
static DataGoogleKmsCryptoKeysConfig.Builder	builder()
default String	getFilter()	The filter argument is used to add a filter query parameter that limits which keys are retrieved by the data source: ?filter={{filter}}.
default String	getId()	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/data-sources/kms_crypto_keys#id DataGoogleKmsCryptoKeys#id}.
String	getKeyRing()	The key ring that the keys belongs to.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Methods inherited from interface com.hashicorp.cdktf.TerraformMetaArguments

getConnection, getCount, getDependsOn, getForEach, getLifecycle, getProvider, getProvisioners

Method Detail

getKeyRing

@Stability(Stable)
@NotNull
String getKeyRing()

The key ring that the keys belongs to. Format: 'projects/{{project}}/locations/{{location}}/keyRings/{{keyRing}}'.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/data-sources/kms_crypto_keys#key_ring DataGoogleKmsCryptoKeys#key_ring}

getFilter

@Stability(Stable)
@Nullable
default String getFilter()

The filter argument is used to add a filter query parameter that limits which keys are retrieved by the data source: ?filter={{filter}}. Example values:.

* "name:my-key-" will retrieve keys that contain "my-key-" anywhere in their name. Note: names take the form projects/{{project}}/locations/{{location}}/keyRings/{{keyRing}}/cryptoKeys/{{cryptoKey}}. * "name=projects/my-project/locations/global/keyRings/my-key-ring/cryptoKeys/my-key-1" will only retrieve a key with that exact name. [See the documentation about using filters](https://cloud.google.com/kms/docs/sorting-and-filtering) Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/data-sources/kms_crypto_keys#filter DataGoogleKmsCryptoKeys#filter}

getId

@Stability(Stable)
@Nullable
default String getId()

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/data-sources/kms_crypto_keys#id DataGoogleKmsCryptoKeys#id}.

Please be aware that the id field is automatically added to all resources in Terraform providers using a Terraform provider SDK version below 2. If you experience problems setting this value it might not be settable. Please take a look at the provider documentation to ensure it should be settable.

builder

@Stability(Stable)
static DataGoogleKmsCryptoKeysConfig.Builder builder()

Returns:

a DataGoogleKmsCryptoKeysConfig.Builder of DataGoogleKmsCryptoKeysConfig