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

Class DocdbCluster.Builder

  • All Implemented Interfaces:
    software.amazon.jsii.Builder<DocdbCluster>
    Enclosing class:
    DocdbCluster
    @Stability(Stable)
public static final class DocdbCluster.Builder
extends Object
implements software.amazon.jsii.Builder<DocdbCluster>
    A fluent builder for DocdbCluster.

    • Method Detail

      • create

        @Stability(Stable)
public static DocdbCluster.Builder create​(software.constructs.Construct scope,
                                          String id)
        Parameters:
        scope - The scope in which to define this construct. This parameter is required.
        id - The scoped construct ID. This parameter is required.
        Returns:
        a new instance of DocdbCluster.Builder.

      • connection

        @Stability(Experimental)
public DocdbCluster.Builder connection​(com.hashicorp.cdktf.SSHProvisionerConnection connection)
        Parameters:
        connection - This parameter is required.
        Returns:
        this

      • connection

        @Stability(Experimental)
public DocdbCluster.Builder connection​(com.hashicorp.cdktf.WinrmProvisionerConnection connection)
        Parameters:
        connection - This parameter is required.
        Returns:
        this

      • count

        @Stability(Experimental)
public DocdbCluster.Builder count​(Number count)
        Parameters:
        count - This parameter is required.
        Returns:
        this

      • count

        @Stability(Experimental)
public DocdbCluster.Builder count​(com.hashicorp.cdktf.TerraformCount count)
        Parameters:
        count - This parameter is required.
        Returns:
        this

      • dependsOn

        @Stability(Experimental)
public DocdbCluster.Builder dependsOn​(List<? extends com.hashicorp.cdktf.ITerraformDependable> dependsOn)
        Parameters:
        dependsOn - This parameter is required.
        Returns:
        this

      • forEach

        @Stability(Experimental)
public DocdbCluster.Builder forEach​(com.hashicorp.cdktf.ITerraformIterator forEach)
        Parameters:
        forEach - This parameter is required.
        Returns:
        this

      • lifecycle

        @Stability(Experimental)
public DocdbCluster.Builder lifecycle​(com.hashicorp.cdktf.TerraformResourceLifecycle lifecycle)
        Parameters:
        lifecycle - This parameter is required.
        Returns:
        this

      • provider

        @Stability(Experimental)
public DocdbCluster.Builder provider​(com.hashicorp.cdktf.TerraformProvider provider)
        Parameters:
        provider - This parameter is required.
        Returns:
        this

      • provisioners

        @Stability(Experimental)
public DocdbCluster.Builder provisioners​(List<? extends Object> provisioners)
        Parameters:
        provisioners - This parameter is required.
        Returns:
        this

      • applyImmediately

        @Stability(Stable)
public DocdbCluster.Builder applyImmediately​(Boolean applyImmediately)
        Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.6.1/docs/resources/docdb_cluster#apply_immediately DocdbCluster#apply_immediately}.

        Parameters:
        applyImmediately - Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.6.1/docs/resources/docdb_cluster#apply_immediately DocdbCluster#apply_immediately}. This parameter is required.
        Returns:
        this

      • applyImmediately

        @Stability(Stable)
public DocdbCluster.Builder applyImmediately​(com.hashicorp.cdktf.IResolvable applyImmediately)
        Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.6.1/docs/resources/docdb_cluster#apply_immediately DocdbCluster#apply_immediately}.

        Parameters:
        applyImmediately - Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.6.1/docs/resources/docdb_cluster#apply_immediately DocdbCluster#apply_immediately}. This parameter is required.
        Returns:
        this

      • availabilityZones

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

        Parameters:
        availabilityZones - Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.6.1/docs/resources/docdb_cluster#availability_zones DocdbCluster#availability_zones}. This parameter is required.
        Returns:
        this

      • backupRetentionPeriod

        @Stability(Stable)
public DocdbCluster.Builder backupRetentionPeriod​(Number backupRetentionPeriod)
        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}.

        Parameters:
        backupRetentionPeriod - 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}. This parameter is required.
        Returns:
        this

      • clusterIdentifier

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

        Parameters:
        clusterIdentifier - Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.6.1/docs/resources/docdb_cluster#cluster_identifier DocdbCluster#cluster_identifier}. This parameter is required.
        Returns:
        this

      • clusterIdentifierPrefix

        @Stability(Stable)
public DocdbCluster.Builder clusterIdentifierPrefix​(String clusterIdentifierPrefix)
        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}.

        Parameters:
        clusterIdentifierPrefix - 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}. This parameter is required.
        Returns:
        this

      • clusterMembers

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

        Parameters:
        clusterMembers - Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.6.1/docs/resources/docdb_cluster#cluster_members DocdbCluster#cluster_members}. This parameter is required.
        Returns:
        this

      • dbClusterParameterGroupName

        @Stability(Stable)
public DocdbCluster.Builder dbClusterParameterGroupName​(String dbClusterParameterGroupName)
        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}.

        Parameters:
        dbClusterParameterGroupName - 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}. This parameter is required.
        Returns:
        this

      • dbSubnetGroupName

        @Stability(Stable)
public DocdbCluster.Builder dbSubnetGroupName​(String dbSubnetGroupName)
        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}.

        Parameters:
        dbSubnetGroupName - 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}. This parameter is required.
        Returns:
        this

      • deletionProtection

        @Stability(Stable)
public DocdbCluster.Builder deletionProtection​(Boolean deletionProtection)
        Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.6.1/docs/resources/docdb_cluster#deletion_protection DocdbCluster#deletion_protection}.

        Parameters:
        deletionProtection - Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.6.1/docs/resources/docdb_cluster#deletion_protection DocdbCluster#deletion_protection}. This parameter is required.
        Returns:
        this

      • deletionProtection

        @Stability(Stable)
public DocdbCluster.Builder deletionProtection​(com.hashicorp.cdktf.IResolvable deletionProtection)
        Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.6.1/docs/resources/docdb_cluster#deletion_protection DocdbCluster#deletion_protection}.

        Parameters:
        deletionProtection - Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.6.1/docs/resources/docdb_cluster#deletion_protection DocdbCluster#deletion_protection}. This parameter is required.
        Returns:
        this

      • enabledCloudwatchLogsExports

        @Stability(Stable)
public DocdbCluster.Builder enabledCloudwatchLogsExports​(List<String> enabledCloudwatchLogsExports)
        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}.

        Parameters:
        enabledCloudwatchLogsExports - 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}. This parameter is required.
        Returns:
        this

      • engine

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

        Parameters:
        engine - Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.6.1/docs/resources/docdb_cluster#engine DocdbCluster#engine}. This parameter is required.
        Returns:
        this

      • engineVersion

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

        Parameters:
        engineVersion - Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.6.1/docs/resources/docdb_cluster#engine_version DocdbCluster#engine_version}. This parameter is required.
        Returns:
        this

      • finalSnapshotIdentifier

        @Stability(Stable)
public DocdbCluster.Builder finalSnapshotIdentifier​(String finalSnapshotIdentifier)
        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}.

        Parameters:
        finalSnapshotIdentifier - 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}. This parameter is required.
        Returns:
        this

      • globalClusterIdentifier

        @Stability(Stable)
public DocdbCluster.Builder globalClusterIdentifier​(String globalClusterIdentifier)
        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}.

        Parameters:
        globalClusterIdentifier - 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}. This parameter is required.
        Returns:
        this

      • id

        @Stability(Stable)
public DocdbCluster.Builder id​(String id)
        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.

        Parameters:
        id - Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.6.1/docs/resources/docdb_cluster#id DocdbCluster#id}. This parameter is required.
        Returns:
        this

      • kmsKeyId

        @Stability(Stable)
public DocdbCluster.Builder kmsKeyId​(String kmsKeyId)
        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}.

        Parameters:
        kmsKeyId - 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}. This parameter is required.
        Returns:
        this

      • masterPassword

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

        Parameters:
        masterPassword - Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.6.1/docs/resources/docdb_cluster#master_password DocdbCluster#master_password}. This parameter is required.
        Returns:
        this

      • masterUsername

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

        Parameters:
        masterUsername - Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.6.1/docs/resources/docdb_cluster#master_username DocdbCluster#master_username}. This parameter is required.
        Returns:
        this

      • port

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

        Parameters:
        port - Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.6.1/docs/resources/docdb_cluster#port DocdbCluster#port}. This parameter is required.
        Returns:
        this

      • preferredBackupWindow

        @Stability(Stable)
public DocdbCluster.Builder preferredBackupWindow​(String preferredBackupWindow)
        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}.

        Parameters:
        preferredBackupWindow - 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}. This parameter is required.
        Returns:
        this

      • preferredMaintenanceWindow

        @Stability(Stable)
public DocdbCluster.Builder preferredMaintenanceWindow​(String preferredMaintenanceWindow)
        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}.

        Parameters:
        preferredMaintenanceWindow - 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}. This parameter is required.
        Returns:
        this

      • skipFinalSnapshot

        @Stability(Stable)
public DocdbCluster.Builder skipFinalSnapshot​(Boolean skipFinalSnapshot)
        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}.

        Parameters:
        skipFinalSnapshot - 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}. This parameter is required.
        Returns:
        this

      • skipFinalSnapshot

        @Stability(Stable)
public DocdbCluster.Builder skipFinalSnapshot​(com.hashicorp.cdktf.IResolvable skipFinalSnapshot)
        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}.

        Parameters:
        skipFinalSnapshot - 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}. This parameter is required.
        Returns:
        this

      • snapshotIdentifier

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

        Parameters:
        snapshotIdentifier - Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.6.1/docs/resources/docdb_cluster#snapshot_identifier DocdbCluster#snapshot_identifier}. This parameter is required.
        Returns:
        this

      • storageEncrypted

        @Stability(Stable)
public DocdbCluster.Builder storageEncrypted​(Boolean storageEncrypted)
        Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.6.1/docs/resources/docdb_cluster#storage_encrypted DocdbCluster#storage_encrypted}.

        Parameters:
        storageEncrypted - Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.6.1/docs/resources/docdb_cluster#storage_encrypted DocdbCluster#storage_encrypted}. This parameter is required.
        Returns:
        this

      • storageEncrypted

        @Stability(Stable)
public DocdbCluster.Builder storageEncrypted​(com.hashicorp.cdktf.IResolvable storageEncrypted)
        Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.6.1/docs/resources/docdb_cluster#storage_encrypted DocdbCluster#storage_encrypted}.

        Parameters:
        storageEncrypted - Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.6.1/docs/resources/docdb_cluster#storage_encrypted DocdbCluster#storage_encrypted}. This parameter is required.
        Returns:
        this

      • tags

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

        Parameters:
        tags - Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.6.1/docs/resources/docdb_cluster#tags DocdbCluster#tags}. This parameter is required.
        Returns:
        this

      • tagsAll

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

        Parameters:
        tagsAll - Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.6.1/docs/resources/docdb_cluster#tags_all DocdbCluster#tags_all}. This parameter is required.
        Returns:
        this

      • timeouts

        @Stability(Stable)
public DocdbCluster.Builder timeouts​(DocdbClusterTimeouts timeouts)
        timeouts block.

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

        Parameters:
        timeouts - timeouts block. This parameter is required.
        Returns:
        this

      • vpcSecurityGroupIds

        @Stability(Stable)
public DocdbCluster.Builder vpcSecurityGroupIds​(List<String> vpcSecurityGroupIds)
        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}.

        Parameters:
        vpcSecurityGroupIds - 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}. This parameter is required.
        Returns:
        this

      • build

        @Stability(Stable)
public DocdbCluster build()
        Specified by:
        build in interface software.amazon.jsii.Builder<DocdbCluster>
        Returns:
        a newly built instance of DocdbCluster.