Package com.hashicorp.cdktf.providers.google.kms_secret_ciphertext

Interface KmsSecretCiphertextConfig

All Superinterfaces:

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

All Known Implementing Classes:

KmsSecretCiphertextConfig.Jsii$Proxy

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

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static KmsSecretCiphertextConfig.Builder	builder()
default String	getAdditionalAuthenticatedData()	The additional authenticated data used for integrity checks during encryption and decryption.
String	getCryptoKey()	The full name of the CryptoKey that will be used to encrypt the provided plaintext.
default String	getId()	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/kms_secret_ciphertext#id KmsSecretCiphertext#id}.
String	getPlaintext()	The plaintext to be encrypted.
default KmsSecretCiphertextTimeouts	getTimeouts()	timeouts block.

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

getCryptoKey

@Stability(Stable)
@NotNull
String getCryptoKey()

The full name of the CryptoKey that will be used to encrypt the provided plaintext. Format: ''projects/{{project}}/locations/{{location}}/keyRings/{{keyRing}}/cryptoKeys/{{cryptoKey}}''.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/kms_secret_ciphertext#crypto_key KmsSecretCiphertext#crypto_key}

getPlaintext

@Stability(Stable)
@NotNull
String getPlaintext()

The plaintext to be encrypted.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/kms_secret_ciphertext#plaintext KmsSecretCiphertext#plaintext}

getAdditionalAuthenticatedData

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

The additional authenticated data used for integrity checks during encryption and decryption.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/kms_secret_ciphertext#additional_authenticated_data KmsSecretCiphertext#additional_authenticated_data}

getId

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

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/kms_secret_ciphertext#id KmsSecretCiphertext#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.

getTimeouts

@Stability(Stable)
@Nullable
default KmsSecretCiphertextTimeouts getTimeouts()

timeouts block.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/kms_secret_ciphertext#timeouts KmsSecretCiphertext#timeouts}

builder

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

Returns:

a KmsSecretCiphertextConfig.Builder of KmsSecretCiphertextConfig