Package com.hashicorp.cdktf.providers.aws.docdb_cluster

Class DocdbCluster

  • 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.84.0 (build 5404dcf)",
           date="2023-06-30T04:56:52.625Z")
@Stability(Stable)
public class DocdbCluster
extends com.hashicorp.cdktf.TerraformResource
    Represents a {@link https://registry.terraform.io/providers/hashicorp/aws/5.6.1/docs/resources/docdb_cluster aws_docdb_cluster}.

    • Field Detail

      • TF_RESOURCE_TYPE

        @Stability(Stable)
public static final String TF_RESOURCE_TYPE

    • Constructor Detail

      • DocdbCluster

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

      • DocdbCluster

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

      • DocdbCluster

        @Stability(Stable)
public DocdbCluster​(@NotNull
                    software.constructs.Construct scope,
                    @NotNull
                    String id,
                    @Nullable
                    DocdbClusterConfig config)
        Create a new {@link https://registry.terraform.io/providers/hashicorp/aws/5.6.1/docs/resources/docdb_cluster aws_docdb_cluster} 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 -

      • DocdbCluster

        @Stability(Stable)
public DocdbCluster​(@NotNull
                    software.constructs.Construct scope,
                    @NotNull
                    String id)
        Create a new {@link https://registry.terraform.io/providers/hashicorp/aws/5.6.1/docs/resources/docdb_cluster aws_docdb_cluster} Resource.

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

    • Method Detail

      • putTimeouts

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

      • resetApplyImmediately

        @Stability(Stable)
public void resetApplyImmediately()

      • resetAvailabilityZones

        @Stability(Stable)
public void resetAvailabilityZones()

      • resetBackupRetentionPeriod

        @Stability(Stable)
public void resetBackupRetentionPeriod()

      • resetClusterIdentifier

        @Stability(Stable)
public void resetClusterIdentifier()

      • resetClusterIdentifierPrefix

        @Stability(Stable)
public void resetClusterIdentifierPrefix()

      • resetClusterMembers

        @Stability(Stable)
public void resetClusterMembers()

      • resetDbClusterParameterGroupName

        @Stability(Stable)
public void resetDbClusterParameterGroupName()

      • resetDbSubnetGroupName

        @Stability(Stable)
public void resetDbSubnetGroupName()

      • resetDeletionProtection

        @Stability(Stable)
public void resetDeletionProtection()

      • resetEnabledCloudwatchLogsExports

        @Stability(Stable)
public void resetEnabledCloudwatchLogsExports()

      • resetEngine

        @Stability(Stable)
public void resetEngine()

      • resetEngineVersion

        @Stability(Stable)
public void resetEngineVersion()

      • resetFinalSnapshotIdentifier

        @Stability(Stable)
public void resetFinalSnapshotIdentifier()

      • resetGlobalClusterIdentifier

        @Stability(Stable)
public void resetGlobalClusterIdentifier()

      • resetId

        @Stability(Stable)
public void resetId()

      • resetKmsKeyId

        @Stability(Stable)
public void resetKmsKeyId()

      • resetMasterPassword

        @Stability(Stable)
public void resetMasterPassword()

      • resetMasterUsername

        @Stability(Stable)
public void resetMasterUsername()

      • resetPort

        @Stability(Stable)
public void resetPort()

      • resetPreferredBackupWindow

        @Stability(Stable)
public void resetPreferredBackupWindow()

      • resetPreferredMaintenanceWindow

        @Stability(Stable)
public void resetPreferredMaintenanceWindow()

      • resetSkipFinalSnapshot

        @Stability(Stable)
public void resetSkipFinalSnapshot()

      • resetSnapshotIdentifier

        @Stability(Stable)
public void resetSnapshotIdentifier()

      • resetStorageEncrypted

        @Stability(Stable)
public void resetStorageEncrypted()

      • resetTags

        @Stability(Stable)
public void resetTags()

      • resetTagsAll

        @Stability(Stable)
public void resetTagsAll()

      • resetTimeouts

        @Stability(Stable)
public void resetTimeouts()

      • resetVpcSecurityGroupIds

        @Stability(Stable)
public void resetVpcSecurityGroupIds()

      • synthesizeAttributes

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

      • getArn

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

      • getClusterResourceId

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

      • getEndpoint

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

      • getHostedZoneId

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

      • getReaderEndpoint

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

      • getApplyImmediatelyInput

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

      • getAvailabilityZonesInput

        @Stability(Stable)
@Nullable
public List<String> getAvailabilityZonesInput()

      • getBackupRetentionPeriodInput

        @Stability(Stable)
@Nullable
public Number getBackupRetentionPeriodInput()

      • getClusterIdentifierInput

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

      • getClusterIdentifierPrefixInput

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

      • getClusterMembersInput

        @Stability(Stable)
@Nullable
public List<String> getClusterMembersInput()

      • getDbClusterParameterGroupNameInput

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

      • getDbSubnetGroupNameInput

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

      • getDeletionProtectionInput

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

      • getEnabledCloudwatchLogsExportsInput

        @Stability(Stable)
@Nullable
public List<String> getEnabledCloudwatchLogsExportsInput()

      • getEngineInput

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

      • getEngineVersionInput

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

      • getFinalSnapshotIdentifierInput

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

      • getGlobalClusterIdentifierInput

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

      • getIdInput

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

      • getKmsKeyIdInput

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

      • getMasterPasswordInput

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

      • getMasterUsernameInput

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

      • getPortInput

        @Stability(Stable)
@Nullable
public Number getPortInput()

      • getPreferredBackupWindowInput

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

      • getPreferredMaintenanceWindowInput

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

      • getSkipFinalSnapshotInput

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

      • getSnapshotIdentifierInput

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

      • getStorageEncryptedInput

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

      • getTagsAllInput

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

      • getTagsInput

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

      • getTimeoutsInput

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

      • getVpcSecurityGroupIdsInput

        @Stability(Stable)
@Nullable
public List<String> getVpcSecurityGroupIdsInput()

      • getApplyImmediately

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

      • setApplyImmediately

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

      • setApplyImmediately

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

      • getAvailabilityZones

        @Stability(Stable)
@NotNull
public List<String> getAvailabilityZones()

      • setAvailabilityZones

        @Stability(Stable)
public void setAvailabilityZones​(@NotNull
                                 List<String> value)

      • getBackupRetentionPeriod

        @Stability(Stable)
@NotNull
public Number getBackupRetentionPeriod()

      • setBackupRetentionPeriod

        @Stability(Stable)
public void setBackupRetentionPeriod​(@NotNull
                                     Number value)

      • getClusterIdentifier

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

      • setClusterIdentifier

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

      • getClusterIdentifierPrefix

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

      • setClusterIdentifierPrefix

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

      • getClusterMembers

        @Stability(Stable)
@NotNull
public List<String> getClusterMembers()

      • setClusterMembers

        @Stability(Stable)
public void setClusterMembers​(@NotNull
                              List<String> value)

      • getDbClusterParameterGroupName

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

      • setDbClusterParameterGroupName

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

      • getDbSubnetGroupName

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

      • setDbSubnetGroupName

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

      • getDeletionProtection

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

      • setDeletionProtection

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

      • setDeletionProtection

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

      • getEnabledCloudwatchLogsExports

        @Stability(Stable)
@NotNull
public List<String> getEnabledCloudwatchLogsExports()

      • setEnabledCloudwatchLogsExports

        @Stability(Stable)
public void setEnabledCloudwatchLogsExports​(@NotNull
                                            List<String> value)

      • getEngine

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

      • setEngine

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

      • getEngineVersion

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

      • setEngineVersion

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

      • getFinalSnapshotIdentifier

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

      • setFinalSnapshotIdentifier

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

      • getGlobalClusterIdentifier

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

      • setGlobalClusterIdentifier

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

      • getId

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

      • setId

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

      • getKmsKeyId

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

      • setKmsKeyId

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

      • getMasterPassword

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

      • setMasterPassword

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

      • getMasterUsername

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

      • setMasterUsername

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

      • getPort

        @Stability(Stable)
@NotNull
public Number getPort()

      • setPort

        @Stability(Stable)
public void setPort​(@NotNull
                    Number value)

      • getPreferredBackupWindow

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

      • setPreferredBackupWindow

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

      • getPreferredMaintenanceWindow

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

      • setPreferredMaintenanceWindow

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

      • getSkipFinalSnapshot

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

      • setSkipFinalSnapshot

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

      • setSkipFinalSnapshot

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

      • getSnapshotIdentifier

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

      • setSnapshotIdentifier

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

      • getStorageEncrypted

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

      • setStorageEncrypted

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

      • setStorageEncrypted

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

      • getTags

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

      • setTags

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

      • getTagsAll

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

      • setTagsAll

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

      • getVpcSecurityGroupIds

        @Stability(Stable)
@NotNull
public List<String> getVpcSecurityGroupIds()

      • setVpcSecurityGroupIds

        @Stability(Stable)
public void setVpcSecurityGroupIds​(@NotNull
                                   List<String> value)