Package com.hashicorp.cdktf.providers.google.firestore_database

Interface FirestoreDatabaseCmekConfig

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

FirestoreDatabaseCmekConfig.Jsii$Proxy

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

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static FirestoreDatabaseCmekConfig.Builder	builder()
String	getKmsKeyName()	The resource ID of a Cloud KMS key.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getKmsKeyName

@Stability(Stable)
@NotNull
String getKmsKeyName()

The resource ID of a Cloud KMS key.

If set, the database created will be a Customer-managed Encryption Key (CMEK) database encrypted with this key. This feature is allowlist only in initial launch. Only keys in the same location as this database are allowed to be used for encryption. For Firestore's nam5 multi-region, this corresponds to Cloud KMS multi-region us. For Firestore's eur3 multi-region, this corresponds to Cloud KMS multi-region europe. See https://cloud.google.com/kms/docs/locations. This value should be the KMS key resource ID in the format of 'projects/{project_id}/locations/{kms_location}/keyRings/{key_ring}/cryptoKeys/{crypto_key}'. How to retrive this resource ID is listed at https://cloud.google.com/kms/docs/getting-resource-ids#getting_the_id_for_a_key_and_version. Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/firestore_database#kms_key_name FirestoreDatabase#kms_key_name}

builder

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

Returns:

a FirestoreDatabaseCmekConfig.Builder of FirestoreDatabaseCmekConfig