Package com.hashicorp.cdktf.providers.google.data_google_kms_key_rings

Interface DataGoogleKmsKeyRingsConfig

All Superinterfaces:

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

All Known Implementing Classes:

DataGoogleKmsKeyRingsConfig.Jsii$Proxy

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

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static DataGoogleKmsKeyRingsConfig.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_key_rings#id DataGoogleKmsKeyRings#id}.
String	getLocation()	The canonical id for the location.
default String	getProject()	Project ID of the project.

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

getLocation

@Stability(Stable)
@NotNull
String getLocation()

The canonical id for the location. For example: "us-east1".

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

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 key rings that contain "my-key-" anywhere in their name. Note: names take the form projects/{{project}}/locations/{{location}}/keyRings/{{keyRing}}. * "name=projects/my-project/locations/global/keyRings/my-key-ring" will only retrieve a key ring 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_key_rings#filter DataGoogleKmsKeyRings#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_key_rings#id DataGoogleKmsKeyRings#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.

getProject

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

Project ID of the project.

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

builder

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

Returns:

a DataGoogleKmsKeyRingsConfig.Builder of DataGoogleKmsKeyRingsConfig