Package com.hashicorp.cdktf.providers.google.kms_crypto_key

Class KmsCryptoKey

  • All Implemented Interfaces:
    com.hashicorp.cdktf.IInterpolatingParent, com.hashicorp.cdktf.ITerraformAddressable, com.hashicorp.cdktf.ITerraformDependable, com.hashicorp.cdktf.ITerraformResource, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable
    @Generated(value="jsii-pacmak/1.102.0 (build e354887)",
           date="2024-08-31T03:59:21.757Z")
@Stability(Stable)
public class KmsCryptoKey
extends com.hashicorp.cdktf.TerraformResource
    Represents a {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/kms_crypto_key google_kms_crypto_key}.

    • Field Detail

      • TF_RESOURCE_TYPE

        @Stability(Stable)
public static final String TF_RESOURCE_TYPE

    • Constructor Detail

      • KmsCryptoKey

        protected KmsCryptoKey​(software.amazon.jsii.JsiiObjectRef objRef)

      • KmsCryptoKey

        protected KmsCryptoKey​(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

      • KmsCryptoKey

        @Stability(Stable)
public KmsCryptoKey​(@NotNull
                    software.constructs.Construct scope,
                    @NotNull
                    String id,
                    @NotNull
                    KmsCryptoKeyConfig config)
        Create a new {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/kms_crypto_key google_kms_crypto_key} Resource.

        Parameters:
        scope - The scope in which to define this construct. This parameter is required.
        id - The scoped construct ID. This parameter is required.
        config - This parameter is required.

    • Method Detail

      • generateConfigForImport

        @Stability(Stable)
@NotNull
public static com.hashicorp.cdktf.ImportableResource generateConfigForImport​(@NotNull
                                                                             software.constructs.Construct scope,
                                                                             @NotNull
                                                                             String importToId,
                                                                             @NotNull
                                                                             String importFromId,
                                                                             @Nullable
                                                                             com.hashicorp.cdktf.TerraformProvider provider)
        Generates CDKTF code for importing a KmsCryptoKey resource upon running "cdktf plan ".

        Parameters:
        scope - The scope in which to define this construct. This parameter is required.
        importToId - The construct id used in the generated config for the KmsCryptoKey to import. This parameter is required.
        importFromId - The id of the existing KmsCryptoKey that should be imported. This parameter is required.
        provider - ? Optional instance of the provider where the KmsCryptoKey to import is found.

      • generateConfigForImport

        @Stability(Stable)
@NotNull
public static com.hashicorp.cdktf.ImportableResource generateConfigForImport​(@NotNull
                                                                             software.constructs.Construct scope,
                                                                             @NotNull
                                                                             String importToId,
                                                                             @NotNull
                                                                             String importFromId)
        Generates CDKTF code for importing a KmsCryptoKey resource upon running "cdktf plan ".

        Parameters:
        scope - The scope in which to define this construct. This parameter is required.
        importToId - The construct id used in the generated config for the KmsCryptoKey to import. This parameter is required.
        importFromId - The id of the existing KmsCryptoKey that should be imported. This parameter is required.

      • putTimeouts

        @Stability(Stable)
public void putTimeouts​(@NotNull
                        KmsCryptoKeyTimeouts value)
        Parameters:
        value - This parameter is required.

      • putVersionTemplate

        @Stability(Stable)
public void putVersionTemplate​(@NotNull
                               KmsCryptoKeyVersionTemplate value)
        Parameters:
        value - This parameter is required.

      • resetCryptoKeyBackend

        @Stability(Stable)
public void resetCryptoKeyBackend()

      • resetDestroyScheduledDuration

        @Stability(Stable)
public void resetDestroyScheduledDuration()

      • resetId

        @Stability(Stable)
public void resetId()

      • resetImportOnly

        @Stability(Stable)
public void resetImportOnly()

      • resetLabels

        @Stability(Stable)
public void resetLabels()

      • resetPurpose

        @Stability(Stable)
public void resetPurpose()

      • resetRotationPeriod

        @Stability(Stable)
public void resetRotationPeriod()

      • resetSkipInitialVersionCreation

        @Stability(Stable)
public void resetSkipInitialVersionCreation()

      • resetTimeouts

        @Stability(Stable)
public void resetTimeouts()

      • resetVersionTemplate

        @Stability(Stable)
public void resetVersionTemplate()

      • synthesizeAttributes

        @Stability(Stable)
@NotNull
protected Map<String,​Object> synthesizeAttributes()
        Overrides:
        synthesizeAttributes in class com.hashicorp.cdktf.TerraformResource

      • synthesizeHclAttributes

        @Stability(Stable)
@NotNull
protected Map<String,​Object> synthesizeHclAttributes()
        Overrides:
        synthesizeHclAttributes in class com.hashicorp.cdktf.TerraformResource

      • getEffectiveLabels

        @Stability(Stable)
@NotNull
public com.hashicorp.cdktf.StringMap getEffectiveLabels()

      • getTerraformLabels

        @Stability(Stable)
@NotNull
public com.hashicorp.cdktf.StringMap getTerraformLabels()

      • getCryptoKeyBackendInput

        @Stability(Stable)
@Nullable
public String getCryptoKeyBackendInput()

      • getDestroyScheduledDurationInput

        @Stability(Stable)
@Nullable
public String getDestroyScheduledDurationInput()

      • getIdInput

        @Stability(Stable)
@Nullable
public String getIdInput()

      • getImportOnlyInput

        @Stability(Stable)
@Nullable
public Object getImportOnlyInput()

      • getKeyRingInput

        @Stability(Stable)
@Nullable
public String getKeyRingInput()

      • getLabelsInput

        @Stability(Stable)
@Nullable
public Map<String,​String> getLabelsInput()

      • getNameInput

        @Stability(Stable)
@Nullable
public String getNameInput()

      • getPurposeInput

        @Stability(Stable)
@Nullable
public String getPurposeInput()

      • getRotationPeriodInput

        @Stability(Stable)
@Nullable
public String getRotationPeriodInput()

      • getSkipInitialVersionCreationInput

        @Stability(Stable)
@Nullable
public Object getSkipInitialVersionCreationInput()

      • getTimeoutsInput

        @Stability(Stable)
@Nullable
public Object getTimeoutsInput()

      • getCryptoKeyBackend

        @Stability(Stable)
@NotNull
public String getCryptoKeyBackend()

      • setCryptoKeyBackend

        @Stability(Stable)
public void setCryptoKeyBackend​(@NotNull
                                String value)

      • getDestroyScheduledDuration

        @Stability(Stable)
@NotNull
public String getDestroyScheduledDuration()

      • setDestroyScheduledDuration

        @Stability(Stable)
public void setDestroyScheduledDuration​(@NotNull
                                        String value)

      • getId

        @Stability(Stable)
@NotNull
public String getId()

      • setId

        @Stability(Stable)
public void setId​(@NotNull
                  String value)

      • getImportOnly

        @Stability(Stable)
@NotNull
public Object getImportOnly()

      • setImportOnly

        @Stability(Stable)
public void setImportOnly​(@NotNull
                          Boolean value)

      • setImportOnly

        @Stability(Stable)
public void setImportOnly​(@NotNull
                          com.hashicorp.cdktf.IResolvable value)

      • getKeyRing

        @Stability(Stable)
@NotNull
public String getKeyRing()

      • setKeyRing

        @Stability(Stable)
public void setKeyRing​(@NotNull
                       String value)

      • getLabels

        @Stability(Stable)
@NotNull
public Map<String,​String> getLabels()

      • setLabels

        @Stability(Stable)
public void setLabels​(@NotNull
                      Map<String,​String> value)

      • getName

        @Stability(Stable)
@NotNull
public String getName()

      • setName

        @Stability(Stable)
public void setName​(@NotNull
                    String value)

      • getPurpose

        @Stability(Stable)
@NotNull
public String getPurpose()

      • setPurpose

        @Stability(Stable)
public void setPurpose​(@NotNull
                       String value)

      • getRotationPeriod

        @Stability(Stable)
@NotNull
public String getRotationPeriod()

      • setRotationPeriod

        @Stability(Stable)
public void setRotationPeriod​(@NotNull
                              String value)

      • getSkipInitialVersionCreation

        @Stability(Stable)
@NotNull
public Object getSkipInitialVersionCreation()

      • setSkipInitialVersionCreation

        @Stability(Stable)
public void setSkipInitialVersionCreation​(@NotNull
                                          Boolean value)

      • setSkipInitialVersionCreation

        @Stability(Stable)
public void setSkipInitialVersionCreation​(@NotNull
                                          com.hashicorp.cdktf.IResolvable value)