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

Interface DocdbClusterConfig

  • All Superinterfaces:
    software.amazon.jsii.JsiiSerializable, com.hashicorp.cdktf.TerraformMetaArguments
    All Known Implementing Classes:
    DocdbClusterConfig.Jsii$Proxy
    @Generated(value="jsii-pacmak/1.84.0 (build 5404dcf)",
           date="2023-06-30T04:56:52.627Z")
@Stability(Stable)
public interface DocdbClusterConfig
extends software.amazon.jsii.JsiiSerializable, com.hashicorp.cdktf.TerraformMetaArguments

    • Method Summary

      All Methods Static Methods Instance Methods Default Methods 
      Modifier and Type Method Description
      static DocdbClusterConfig.Builder builder()  
      default Object getApplyImmediately()
      Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.6.1/docs/resources/docdb_cluster#apply_immediately DocdbCluster#apply_immediately}.
      default List<String> getAvailabilityZones()
      Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.6.1/docs/resources/docdb_cluster#availability_zones DocdbCluster#availability_zones}.
      default Number getBackupRetentionPeriod()
      Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.6.1/docs/resources/docdb_cluster#backup_retention_period DocdbCluster#backup_retention_period}.
      default String getClusterIdentifier()
      Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.6.1/docs/resources/docdb_cluster#cluster_identifier DocdbCluster#cluster_identifier}.
      default String getClusterIdentifierPrefix()
      Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.6.1/docs/resources/docdb_cluster#cluster_identifier_prefix DocdbCluster#cluster_identifier_prefix}.
      default List<String> getClusterMembers()
      Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.6.1/docs/resources/docdb_cluster#cluster_members DocdbCluster#cluster_members}.
      default String getDbClusterParameterGroupName()
      Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.6.1/docs/resources/docdb_cluster#db_cluster_parameter_group_name DocdbCluster#db_cluster_parameter_group_name}.
      default String getDbSubnetGroupName()
      Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.6.1/docs/resources/docdb_cluster#db_subnet_group_name DocdbCluster#db_subnet_group_name}.
      default Object getDeletionProtection()
      Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.6.1/docs/resources/docdb_cluster#deletion_protection DocdbCluster#deletion_protection}.
      default List<String> getEnabledCloudwatchLogsExports()
      Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.6.1/docs/resources/docdb_cluster#enabled_cloudwatch_logs_exports DocdbCluster#enabled_cloudwatch_logs_exports}.
      default String getEngine()
      Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.6.1/docs/resources/docdb_cluster#engine DocdbCluster#engine}.
      default String getEngineVersion()
      Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.6.1/docs/resources/docdb_cluster#engine_version DocdbCluster#engine_version}.
      default String getFinalSnapshotIdentifier()
      Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.6.1/docs/resources/docdb_cluster#final_snapshot_identifier DocdbCluster#final_snapshot_identifier}.
      default String getGlobalClusterIdentifier()
      Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.6.1/docs/resources/docdb_cluster#global_cluster_identifier DocdbCluster#global_cluster_identifier}.
      default String getId()
      Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.6.1/docs/resources/docdb_cluster#id DocdbCluster#id}.
      default String getKmsKeyId()
      Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.6.1/docs/resources/docdb_cluster#kms_key_id DocdbCluster#kms_key_id}.
      default String getMasterPassword()
      Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.6.1/docs/resources/docdb_cluster#master_password DocdbCluster#master_password}.
      default String getMasterUsername()
      Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.6.1/docs/resources/docdb_cluster#master_username DocdbCluster#master_username}.
      default Number getPort()
      Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.6.1/docs/resources/docdb_cluster#port DocdbCluster#port}.
      default String getPreferredBackupWindow()
      Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.6.1/docs/resources/docdb_cluster#preferred_backup_window DocdbCluster#preferred_backup_window}.
      default String getPreferredMaintenanceWindow()
      Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.6.1/docs/resources/docdb_cluster#preferred_maintenance_window DocdbCluster#preferred_maintenance_window}.
      default Object getSkipFinalSnapshot()
      Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.6.1/docs/resources/docdb_cluster#skip_final_snapshot DocdbCluster#skip_final_snapshot}.
      default String getSnapshotIdentifier()
      Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.6.1/docs/resources/docdb_cluster#snapshot_identifier DocdbCluster#snapshot_identifier}.
      default Object getStorageEncrypted()
      Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.6.1/docs/resources/docdb_cluster#storage_encrypted DocdbCluster#storage_encrypted}.
      default Map<String,​String> getTags()
      Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.6.1/docs/resources/docdb_cluster#tags DocdbCluster#tags}.
      default Map<String,​String> getTagsAll()
      Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.6.1/docs/resources/docdb_cluster#tags_all DocdbCluster#tags_all}.
      default DocdbClusterTimeouts getTimeouts()
      timeouts block.
      default List<String> getVpcSecurityGroupIds()
      Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.6.1/docs/resources/docdb_cluster#vpc_security_group_ids DocdbCluster#vpc_security_group_ids}.

      • 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

      • getApplyImmediately

        @Stability(Stable)
@Nullable
default Object getApplyImmediately()
        Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.6.1/docs/resources/docdb_cluster#apply_immediately DocdbCluster#apply_immediately}.

      • getAvailabilityZones

        @Stability(Stable)
@Nullable
default List<String> getAvailabilityZones()
        Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.6.1/docs/resources/docdb_cluster#availability_zones DocdbCluster#availability_zones}.

      • getBackupRetentionPeriod

        @Stability(Stable)
@Nullable
default Number getBackupRetentionPeriod()
        Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.6.1/docs/resources/docdb_cluster#backup_retention_period DocdbCluster#backup_retention_period}.

      • getClusterIdentifier

        @Stability(Stable)
@Nullable
default String getClusterIdentifier()
        Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.6.1/docs/resources/docdb_cluster#cluster_identifier DocdbCluster#cluster_identifier}.

      • getClusterIdentifierPrefix

        @Stability(Stable)
@Nullable
default String getClusterIdentifierPrefix()
        Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.6.1/docs/resources/docdb_cluster#cluster_identifier_prefix DocdbCluster#cluster_identifier_prefix}.

      • getClusterMembers

        @Stability(Stable)
@Nullable
default List<String> getClusterMembers()
        Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.6.1/docs/resources/docdb_cluster#cluster_members DocdbCluster#cluster_members}.

      • getDbClusterParameterGroupName

        @Stability(Stable)
@Nullable
default String getDbClusterParameterGroupName()
        Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.6.1/docs/resources/docdb_cluster#db_cluster_parameter_group_name DocdbCluster#db_cluster_parameter_group_name}.

      • getDbSubnetGroupName

        @Stability(Stable)
@Nullable
default String getDbSubnetGroupName()
        Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.6.1/docs/resources/docdb_cluster#db_subnet_group_name DocdbCluster#db_subnet_group_name}.

      • getDeletionProtection

        @Stability(Stable)
@Nullable
default Object getDeletionProtection()
        Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.6.1/docs/resources/docdb_cluster#deletion_protection DocdbCluster#deletion_protection}.

      • getEnabledCloudwatchLogsExports

        @Stability(Stable)
@Nullable
default List<String> getEnabledCloudwatchLogsExports()
        Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.6.1/docs/resources/docdb_cluster#enabled_cloudwatch_logs_exports DocdbCluster#enabled_cloudwatch_logs_exports}.

      • getEngine

        @Stability(Stable)
@Nullable
default String getEngine()
        Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.6.1/docs/resources/docdb_cluster#engine DocdbCluster#engine}.

      • getEngineVersion

        @Stability(Stable)
@Nullable
default String getEngineVersion()
        Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.6.1/docs/resources/docdb_cluster#engine_version DocdbCluster#engine_version}.

      • getFinalSnapshotIdentifier

        @Stability(Stable)
@Nullable
default String getFinalSnapshotIdentifier()
        Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.6.1/docs/resources/docdb_cluster#final_snapshot_identifier DocdbCluster#final_snapshot_identifier}.

      • getGlobalClusterIdentifier

        @Stability(Stable)
@Nullable
default String getGlobalClusterIdentifier()
        Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.6.1/docs/resources/docdb_cluster#global_cluster_identifier DocdbCluster#global_cluster_identifier}.

      • getId

        @Stability(Stable)
@Nullable
default String getId()
        Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.6.1/docs/resources/docdb_cluster#id DocdbCluster#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.

      • getKmsKeyId

        @Stability(Stable)
@Nullable
default String getKmsKeyId()
        Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.6.1/docs/resources/docdb_cluster#kms_key_id DocdbCluster#kms_key_id}.

      • getMasterPassword

        @Stability(Stable)
@Nullable
default String getMasterPassword()
        Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.6.1/docs/resources/docdb_cluster#master_password DocdbCluster#master_password}.

      • getMasterUsername

        @Stability(Stable)
@Nullable
default String getMasterUsername()
        Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.6.1/docs/resources/docdb_cluster#master_username DocdbCluster#master_username}.

      • getPort

        @Stability(Stable)
@Nullable
default Number getPort()
        Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.6.1/docs/resources/docdb_cluster#port DocdbCluster#port}.

      • getPreferredBackupWindow

        @Stability(Stable)
@Nullable
default String getPreferredBackupWindow()
        Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.6.1/docs/resources/docdb_cluster#preferred_backup_window DocdbCluster#preferred_backup_window}.

      • getPreferredMaintenanceWindow

        @Stability(Stable)
@Nullable
default String getPreferredMaintenanceWindow()
        Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.6.1/docs/resources/docdb_cluster#preferred_maintenance_window DocdbCluster#preferred_maintenance_window}.

      • getSkipFinalSnapshot

        @Stability(Stable)
@Nullable
default Object getSkipFinalSnapshot()
        Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.6.1/docs/resources/docdb_cluster#skip_final_snapshot DocdbCluster#skip_final_snapshot}.

      • getSnapshotIdentifier

        @Stability(Stable)
@Nullable
default String getSnapshotIdentifier()
        Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.6.1/docs/resources/docdb_cluster#snapshot_identifier DocdbCluster#snapshot_identifier}.

      • getStorageEncrypted

        @Stability(Stable)
@Nullable
default Object getStorageEncrypted()
        Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.6.1/docs/resources/docdb_cluster#storage_encrypted DocdbCluster#storage_encrypted}.

      • getTags

        @Stability(Stable)
@Nullable
default Map<String,​String> getTags()
        Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.6.1/docs/resources/docdb_cluster#tags DocdbCluster#tags}.

      • getTagsAll

        @Stability(Stable)
@Nullable
default Map<String,​String> getTagsAll()
        Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.6.1/docs/resources/docdb_cluster#tags_all DocdbCluster#tags_all}.

      • getTimeouts

        @Stability(Stable)
@Nullable
default DocdbClusterTimeouts getTimeouts()
        timeouts block.

        Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.6.1/docs/resources/docdb_cluster#timeouts DocdbCluster#timeouts}

      • getVpcSecurityGroupIds

        @Stability(Stable)
@Nullable
default List<String> getVpcSecurityGroupIds()
        Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.6.1/docs/resources/docdb_cluster#vpc_security_group_ids DocdbCluster#vpc_security_group_ids}.