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

Class FirestoreDatabaseCmekConfig.Builder

java.lang.Object

com.hashicorp.cdktf.providers.google.firestore_database.FirestoreDatabaseCmekConfig.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<FirestoreDatabaseCmekConfig>

Enclosing interface:

FirestoreDatabaseCmekConfig

@Stability(Stable)
public static final class FirestoreDatabaseCmekConfig.Builder
extends Object
implements software.amazon.jsii.Builder<FirestoreDatabaseCmekConfig>

A builder for FirestoreDatabaseCmekConfig

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
FirestoreDatabaseCmekConfig	build()	Builds the configured instance.
FirestoreDatabaseCmekConfig.Builder	kmsKeyName(String kmsKeyName)	Sets the value of FirestoreDatabaseCmekConfig.getKmsKeyName()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Builder

public Builder()

Method Detail

kmsKeyName

@Stability(Stable)
public FirestoreDatabaseCmekConfig.Builder kmsKeyName(String kmsKeyName)

Sets the value of FirestoreDatabaseCmekConfig.getKmsKeyName()

Parameters:

kmsKeyName - The resource ID of a Cloud KMS key. This parameter is required. 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}

Returns:

this

build

@Stability(Stable)
public FirestoreDatabaseCmekConfig build()

Builds the configured instance.

Specified by:

build in interface software.amazon.jsii.Builder<FirestoreDatabaseCmekConfig>

Returns:

a new instance of FirestoreDatabaseCmekConfig

Throws:

NullPointerException - if any required attribute was not provided