Package software.amazon.awscdk.services.docdb

Class CfnDBCluster.Builder

java.lang.Object

software.amazon.awscdk.services.docdb.CfnDBCluster.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<CfnDBCluster>

Enclosing class:

CfnDBCluster

@Stability(Stable)
public static final class CfnDBCluster.Builder
extends Object
implements software.amazon.jsii.Builder<CfnDBCluster>

A fluent builder for CfnDBCluster.

Method Summary

Modifier and Type	Method	Description
CfnDBCluster.Builder	availabilityZones(List<String> availabilityZones)	A list of Amazon EC2 Availability Zones that instances in the cluster can be created in.
CfnDBCluster.Builder	backupRetentionPeriod(Number backupRetentionPeriod)	The number of days for which automated backups are retained.
CfnDBCluster	build()
CfnDBCluster.Builder	copyTagsToSnapshot(Boolean copyTagsToSnapshot)
CfnDBCluster.Builder	copyTagsToSnapshot(IResolvable copyTagsToSnapshot)
static CfnDBCluster.Builder	create(software.constructs.Construct scope, String id)
CfnDBCluster.Builder	dbClusterIdentifier(String dbClusterIdentifier)	The cluster identifier.
CfnDBCluster.Builder	dbClusterParameterGroupName(String dbClusterParameterGroupName)	The name of the cluster parameter group to associate with this cluster.
CfnDBCluster.Builder	dbSubnetGroupName(String dbSubnetGroupName)	A subnet group to associate with this cluster.
CfnDBCluster.Builder	deletionProtection(Boolean deletionProtection)	Protects clusters from being accidentally deleted.
CfnDBCluster.Builder	deletionProtection(IResolvable deletionProtection)	Protects clusters from being accidentally deleted.
CfnDBCluster.Builder	enableCloudwatchLogsExports(List<String> enableCloudwatchLogsExports)	The list of log types that need to be enabled for exporting to Amazon CloudWatch Logs.
CfnDBCluster.Builder	engineVersion(String engineVersion)	The version number of the database engine to use.
CfnDBCluster.Builder	kmsKeyId(String kmsKeyId)	The AWS KMS key identifier for an encrypted cluster.
CfnDBCluster.Builder	masterUsername(String masterUsername)	The name of the master user for the cluster.
CfnDBCluster.Builder	masterUserPassword(String masterUserPassword)	The password for the master database user.
CfnDBCluster.Builder	port(Number port)	Specifies the port that the database engine is listening on.
CfnDBCluster.Builder	preferredBackupWindow(String preferredBackupWindow)	The daily time range during which automated backups are created if automated backups are enabled using the BackupRetentionPeriod parameter.
CfnDBCluster.Builder	preferredMaintenanceWindow(String preferredMaintenanceWindow)	The weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).
CfnDBCluster.Builder	restoreToTime(String restoreToTime)	The date and time to restore the cluster to.
CfnDBCluster.Builder	restoreType(String restoreType)	The type of restore to be performed.
CfnDBCluster.Builder	snapshotIdentifier(String snapshotIdentifier)	The identifier for the snapshot or cluster snapshot to restore from.
CfnDBCluster.Builder	sourceDbClusterIdentifier(String sourceDbClusterIdentifier)	The identifier of the source cluster from which to restore.
CfnDBCluster.Builder	storageEncrypted(Boolean storageEncrypted)	Specifies whether the cluster is encrypted.
CfnDBCluster.Builder	storageEncrypted(IResolvable storageEncrypted)	Specifies whether the cluster is encrypted.
CfnDBCluster.Builder	storageType(String storageType)	The storage type to associate with the DB cluster.
CfnDBCluster.Builder	tags(List<? extends CfnTag> tags)	The tags to be assigned to the cluster.
CfnDBCluster.Builder	useLatestRestorableTime(Boolean useLatestRestorableTime)	A value that is set to true to restore the cluster to the latest restorable backup time, and false otherwise.
CfnDBCluster.Builder	useLatestRestorableTime(IResolvable useLatestRestorableTime)	A value that is set to true to restore the cluster to the latest restorable backup time, and false otherwise.
CfnDBCluster.Builder	vpcSecurityGroupIds(List<String> vpcSecurityGroupIds)	A list of EC2 VPC security groups to associate with this cluster.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Details

create

@Stability(Stable)
public static CfnDBCluster.Builder create(software.constructs.Construct scope,
 String id)

Parameters:

scope - Scope in which this resource is defined. This parameter is required.

id - Construct identifier for this resource (unique in its scope). This parameter is required.

Returns:

a new instance of CfnDBCluster.Builder.

availabilityZones

@Stability(Stable)
public CfnDBCluster.Builder availabilityZones(List<String> availabilityZones)

A list of Amazon EC2 Availability Zones that instances in the cluster can be created in.

Parameters:

availabilityZones - A list of Amazon EC2 Availability Zones that instances in the cluster can be created in. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-docdb-dbcluster.html#cfn-docdb-dbcluster-availabilityzones

backupRetentionPeriod

@Stability(Stable)
public CfnDBCluster.Builder backupRetentionPeriod(Number backupRetentionPeriod)

The number of days for which automated backups are retained. You must specify a minimum value of 1.

Default: 1

Constraints:

• Must be a value from 1 to 35.

Parameters:

backupRetentionPeriod - The number of days for which automated backups are retained. You must specify a minimum value of 1. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-docdb-dbcluster.html#cfn-docdb-dbcluster-backupretentionperiod

copyTagsToSnapshot

@Stability(Stable)
public CfnDBCluster.Builder copyTagsToSnapshot(Boolean copyTagsToSnapshot)

Parameters:

copyTagsToSnapshot - This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-docdb-dbcluster.html#cfn-docdb-dbcluster-copytagstosnapshot

copyTagsToSnapshot

@Stability(Stable)
public CfnDBCluster.Builder copyTagsToSnapshot(IResolvable copyTagsToSnapshot)

Parameters:

copyTagsToSnapshot - This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-docdb-dbcluster.html#cfn-docdb-dbcluster-copytagstosnapshot

dbClusterIdentifier

@Stability(Stable)
public CfnDBCluster.Builder dbClusterIdentifier(String dbClusterIdentifier)

The cluster identifier. This parameter is stored as a lowercase string.

Constraints:

• Must contain from 1 to 63 letters, numbers, or hyphens.
• The first character must be a letter.
• Cannot end with a hyphen or contain two consecutive hyphens.

Example: my-cluster

Parameters:

dbClusterIdentifier - The cluster identifier. This parameter is stored as a lowercase string. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-docdb-dbcluster.html#cfn-docdb-dbcluster-dbclusteridentifier

dbClusterParameterGroupName

@Stability(Stable)
public CfnDBCluster.Builder dbClusterParameterGroupName(String dbClusterParameterGroupName)

The name of the cluster parameter group to associate with this cluster.

Parameters:

dbClusterParameterGroupName - The name of the cluster parameter group to associate with this cluster. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-docdb-dbcluster.html#cfn-docdb-dbcluster-dbclusterparametergroupname

dbSubnetGroupName

@Stability(Stable)
public CfnDBCluster.Builder dbSubnetGroupName(String dbSubnetGroupName)

A subnet group to associate with this cluster.

Constraints: Must match the name of an existing DBSubnetGroup . Must not be default.

Example: mySubnetgroup

Parameters:

dbSubnetGroupName - A subnet group to associate with this cluster. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-docdb-dbcluster.html#cfn-docdb-dbcluster-dbsubnetgroupname

deletionProtection

@Stability(Stable)
public CfnDBCluster.Builder deletionProtection(Boolean deletionProtection)

Protects clusters from being accidentally deleted.

If enabled, the cluster cannot be deleted unless it is modified and DeletionProtection is disabled.

Parameters:

deletionProtection - Protects clusters from being accidentally deleted. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-docdb-dbcluster.html#cfn-docdb-dbcluster-deletionprotection

deletionProtection

@Stability(Stable)
public CfnDBCluster.Builder deletionProtection(IResolvable deletionProtection)

Protects clusters from being accidentally deleted.

If enabled, the cluster cannot be deleted unless it is modified and DeletionProtection is disabled.

Parameters:

deletionProtection - Protects clusters from being accidentally deleted. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-docdb-dbcluster.html#cfn-docdb-dbcluster-deletionprotection

enableCloudwatchLogsExports

@Stability(Stable)
public CfnDBCluster.Builder enableCloudwatchLogsExports(List<String> enableCloudwatchLogsExports)

The list of log types that need to be enabled for exporting to Amazon CloudWatch Logs.

You can enable audit logs or profiler logs. For more information, see Auditing Amazon DocumentDB Events and Profiling Amazon DocumentDB Operations .

Parameters:

enableCloudwatchLogsExports - The list of log types that need to be enabled for exporting to Amazon CloudWatch Logs. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-docdb-dbcluster.html#cfn-docdb-dbcluster-enablecloudwatchlogsexports

engineVersion

@Stability(Stable)
public CfnDBCluster.Builder engineVersion(String engineVersion)

The version number of the database engine to use.

The --engine-version will default to the latest major engine version. For production workloads, we recommend explicitly declaring this parameter with the intended major engine version.

Parameters:

engineVersion - The version number of the database engine to use. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-docdb-dbcluster.html#cfn-docdb-dbcluster-engineversion

kmsKeyId

@Stability(Stable)
public CfnDBCluster.Builder kmsKeyId(String kmsKeyId)

The AWS KMS key identifier for an encrypted cluster.

The AWS KMS key identifier is the Amazon Resource Name (ARN) for the AWS KMS encryption key. If you are creating a cluster using the same AWS account that owns the AWS KMS encryption key that is used to encrypt the new cluster, you can use the AWS KMS key alias instead of the ARN for the AWS KMS encryption key.

If an encryption key is not specified in KmsKeyId :

• If the StorageEncrypted parameter is true , Amazon DocumentDB uses your default encryption key.

AWS KMS creates the default encryption key for your AWS account . Your AWS account has a different default encryption key for each AWS Regions .

Parameters:

kmsKeyId - The AWS KMS key identifier for an encrypted cluster. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-docdb-dbcluster.html#cfn-docdb-dbcluster-kmskeyid

masterUsername

@Stability(Stable)
public CfnDBCluster.Builder masterUsername(String masterUsername)

The name of the master user for the cluster.

Constraints:

• Must be from 1 to 63 letters or numbers.
• The first character must be a letter.
• Cannot be a reserved word for the chosen database engine.

Parameters:

masterUsername - The name of the master user for the cluster. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-docdb-dbcluster.html#cfn-docdb-dbcluster-masterusername

masterUserPassword

@Stability(Stable)
public CfnDBCluster.Builder masterUserPassword(String masterUserPassword)

The password for the master database user.

This password can contain any printable ASCII character except forward slash (/), double quote ("), or the "at" symbol (@).

Constraints: Must contain from 8 to 100 characters.

Parameters:

masterUserPassword - The password for the master database user. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-docdb-dbcluster.html#cfn-docdb-dbcluster-masteruserpassword

port

@Stability(Stable)
public CfnDBCluster.Builder port(Number port)

Specifies the port that the database engine is listening on.

Parameters:

port - Specifies the port that the database engine is listening on. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-docdb-dbcluster.html#cfn-docdb-dbcluster-port

preferredBackupWindow

@Stability(Stable)
public CfnDBCluster.Builder preferredBackupWindow(String preferredBackupWindow)

The daily time range during which automated backups are created if automated backups are enabled using the BackupRetentionPeriod parameter.

The default is a 30-minute window selected at random from an 8-hour block of time for each AWS Region .

Constraints:

• Must be in the format hh24:mi-hh24:mi .
• Must be in Universal Coordinated Time (UTC).
• Must not conflict with the preferred maintenance window.
• Must be at least 30 minutes.

Parameters:

preferredBackupWindow - The daily time range during which automated backups are created if automated backups are enabled using the BackupRetentionPeriod parameter. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-docdb-dbcluster.html#cfn-docdb-dbcluster-preferredbackupwindow

preferredMaintenanceWindow

@Stability(Stable)
public CfnDBCluster.Builder preferredMaintenanceWindow(String preferredMaintenanceWindow)

The weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).

Format: ddd:hh24:mi-ddd:hh24:mi

The default is a 30-minute window selected at random from an 8-hour block of time for each AWS Region , occurring on a random day of the week.

Valid days: Mon, Tue, Wed, Thu, Fri, Sat, Sun

Constraints: Minimum 30-minute window.

Parameters:

preferredMaintenanceWindow - The weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC). This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-docdb-dbcluster.html#cfn-docdb-dbcluster-preferredmaintenancewindow

restoreToTime

@Stability(Stable)
public CfnDBCluster.Builder restoreToTime(String restoreToTime)

The date and time to restore the cluster to.

Valid values: A time in Universal Coordinated Time (UTC) format.

Constraints:

• Must be before the latest restorable time for the instance.
• Must be specified if the UseLatestRestorableTime parameter is not provided.
• Cannot be specified if the UseLatestRestorableTime parameter is true .
• Cannot be specified if the RestoreType parameter is copy-on-write .

Example: 2015-03-07T23:45:00Z

Parameters:

restoreToTime - The date and time to restore the cluster to. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-docdb-dbcluster.html#cfn-docdb-dbcluster-restoretotime

restoreType

@Stability(Stable)
public CfnDBCluster.Builder restoreType(String restoreType)

The type of restore to be performed. You can specify one of the following values:.

• full-copy - The new DB cluster is restored as a full copy of the source DB cluster.
• copy-on-write - The new DB cluster is restored as a clone of the source DB cluster.

Constraints: You can't specify copy-on-write if the engine version of the source DB cluster is earlier than 1.11.

If you don't specify a RestoreType value, then the new DB cluster is restored as a full copy of the source DB cluster.

Parameters:

restoreType - The type of restore to be performed. You can specify one of the following values:. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-docdb-dbcluster.html#cfn-docdb-dbcluster-restoretype

snapshotIdentifier

@Stability(Stable)
public CfnDBCluster.Builder snapshotIdentifier(String snapshotIdentifier)

The identifier for the snapshot or cluster snapshot to restore from.

You can use either the name or the Amazon Resource Name (ARN) to specify a cluster snapshot. However, you can use only the ARN to specify a snapshot.

Constraints:

• Must match the identifier of an existing snapshot.

Parameters:

snapshotIdentifier - The identifier for the snapshot or cluster snapshot to restore from. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-docdb-dbcluster.html#cfn-docdb-dbcluster-snapshotidentifier

sourceDbClusterIdentifier

@Stability(Stable)
public CfnDBCluster.Builder sourceDbClusterIdentifier(String sourceDbClusterIdentifier)

The identifier of the source cluster from which to restore.

Constraints:

• Must match the identifier of an existing DBCluster .

Parameters:

sourceDbClusterIdentifier - The identifier of the source cluster from which to restore. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-docdb-dbcluster.html#cfn-docdb-dbcluster-sourcedbclusteridentifier

storageEncrypted

@Stability(Stable)
public CfnDBCluster.Builder storageEncrypted(Boolean storageEncrypted)

Specifies whether the cluster is encrypted.

Parameters:

storageEncrypted - Specifies whether the cluster is encrypted. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-docdb-dbcluster.html#cfn-docdb-dbcluster-storageencrypted

storageEncrypted

@Stability(Stable)
public CfnDBCluster.Builder storageEncrypted(IResolvable storageEncrypted)

Specifies whether the cluster is encrypted.

Parameters:

storageEncrypted - Specifies whether the cluster is encrypted. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-docdb-dbcluster.html#cfn-docdb-dbcluster-storageencrypted

storageType

@Stability(Stable)
public CfnDBCluster.Builder storageType(String storageType)

The storage type to associate with the DB cluster.

For information on storage types for Amazon DocumentDB clusters, see Cluster storage configurations in the Amazon DocumentDB Developer Guide .

Valid values for storage type - standard | iopt1

Default value is standard

When you create a DocumentDB DB cluster with the storage type set to iopt1 , the storage type is returned in the response. The storage type isn't returned when you set it to standard .

Parameters:

storageType - The storage type to associate with the DB cluster. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-docdb-dbcluster.html#cfn-docdb-dbcluster-storagetype

tags

@Stability(Stable)
public CfnDBCluster.Builder tags(List<? extends CfnTag> tags)

The tags to be assigned to the cluster.

Parameters:

tags - The tags to be assigned to the cluster. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-docdb-dbcluster.html#cfn-docdb-dbcluster-tags

useLatestRestorableTime

@Stability(Stable)
public CfnDBCluster.Builder useLatestRestorableTime(Boolean useLatestRestorableTime)

A value that is set to true to restore the cluster to the latest restorable backup time, and false otherwise.

Default: false

Constraints: Cannot be specified if the RestoreToTime parameter is provided.

Parameters:

useLatestRestorableTime - A value that is set to true to restore the cluster to the latest restorable backup time, and false otherwise. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-docdb-dbcluster.html#cfn-docdb-dbcluster-uselatestrestorabletime

useLatestRestorableTime

@Stability(Stable)
public CfnDBCluster.Builder useLatestRestorableTime(IResolvable useLatestRestorableTime)

A value that is set to true to restore the cluster to the latest restorable backup time, and false otherwise.

Default: false

Constraints: Cannot be specified if the RestoreToTime parameter is provided.

Parameters:

useLatestRestorableTime - A value that is set to true to restore the cluster to the latest restorable backup time, and false otherwise. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-docdb-dbcluster.html#cfn-docdb-dbcluster-uselatestrestorabletime

vpcSecurityGroupIds

@Stability(Stable)
public CfnDBCluster.Builder vpcSecurityGroupIds(List<String> vpcSecurityGroupIds)

A list of EC2 VPC security groups to associate with this cluster.

Parameters:

vpcSecurityGroupIds - A list of EC2 VPC security groups to associate with this cluster. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-docdb-dbcluster.html#cfn-docdb-dbcluster-vpcsecuritygroupids

build

@Stability(Stable)
public CfnDBCluster build()

Specified by:

build in interface software.amazon.jsii.Builder<CfnDBCluster>

Returns:

a newly built instance of CfnDBCluster.