Package software.amazon.awscdk.services.docdbelastic

Class CfnCluster.Builder

java.lang.Object

software.amazon.awscdk.services.docdbelastic.CfnCluster.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<CfnCluster>

Enclosing class:

CfnCluster

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

A fluent builder for CfnCluster.

Method Summary

Modifier and Type	Method	Description
CfnCluster.Builder	adminUserName(String adminUserName)	The name of the Amazon DocumentDB elastic clusters administrator.
CfnCluster.Builder	adminUserPassword(String adminUserPassword)	The password for the Elastic DocumentDB cluster administrator and can contain any printable ASCII characters.
CfnCluster.Builder	authType(String authType)	The authentication type used to determine where to fetch the password used for accessing the elastic cluster.
CfnCluster.Builder	backupRetentionPeriod(Number backupRetentionPeriod)	The number of days for which automatic snapshots are retained.
CfnCluster	build()
CfnCluster.Builder	clusterName(String clusterName)	The name of the new elastic cluster.
static CfnCluster.Builder	create(software.constructs.Construct scope, String id)
CfnCluster.Builder	kmsKeyId(String kmsKeyId)	The KMS key identifier to use to encrypt the new elastic cluster.
CfnCluster.Builder	preferredBackupWindow(String preferredBackupWindow)	The daily time range during which automated backups are created if automated backups are enabled, as determined by backupRetentionPeriod .
CfnCluster.Builder	preferredMaintenanceWindow(String preferredMaintenanceWindow)	The weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).
CfnCluster.Builder	shardCapacity(Number shardCapacity)	The number of vCPUs assigned to each elastic cluster shard.
CfnCluster.Builder	shardCount(Number shardCount)	The number of shards assigned to the elastic cluster.
CfnCluster.Builder	shardInstanceCount(Number shardInstanceCount)	The number of replica instances applying to all shards in the cluster.
CfnCluster.Builder	subnetIds(List<String> subnetIds)	The Amazon EC2 subnet IDs for the new elastic cluster.
CfnCluster.Builder	tags(List<? extends CfnTag> tags)	The tags to be assigned to the new elastic cluster.
CfnCluster.Builder	vpcSecurityGroupIds(List<String> vpcSecurityGroupIds)	A list of EC2 VPC security groups to associate with the new elastic 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 CfnCluster.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 CfnCluster.Builder.

adminUserName

@Stability(Stable)
public CfnCluster.Builder adminUserName(String adminUserName)

The name of the Amazon DocumentDB elastic clusters administrator.

Constraints :

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

Parameters:

adminUserName - The name of the Amazon DocumentDB elastic clusters administrator. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-docdbelastic-cluster.html#cfn-docdbelastic-cluster-adminusername

authType

@Stability(Stable)
public CfnCluster.Builder authType(String authType)

The authentication type used to determine where to fetch the password used for accessing the elastic cluster.

Valid types are PLAIN_TEXT or SECRET_ARN .

Parameters:

authType - The authentication type used to determine where to fetch the password used for accessing the elastic cluster. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-docdbelastic-cluster.html#cfn-docdbelastic-cluster-authtype

clusterName

@Stability(Stable)
public CfnCluster.Builder clusterName(String clusterName)

The name of the new elastic cluster. 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:

clusterName - The name of the new elastic cluster. 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-docdbelastic-cluster.html#cfn-docdbelastic-cluster-clustername

shardCapacity

@Stability(Stable)
public CfnCluster.Builder shardCapacity(Number shardCapacity)

The number of vCPUs assigned to each elastic cluster shard.

Maximum is 64. Allowed values are 2, 4, 8, 16, 32, 64.

Parameters:

shardCapacity - The number of vCPUs assigned to each elastic cluster shard. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-docdbelastic-cluster.html#cfn-docdbelastic-cluster-shardcapacity

shardCount

@Stability(Stable)
public CfnCluster.Builder shardCount(Number shardCount)

The number of shards assigned to the elastic cluster.

Maximum is 32.

Parameters:

shardCount - The number of shards assigned to the elastic cluster. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-docdbelastic-cluster.html#cfn-docdbelastic-cluster-shardcount

adminUserPassword

@Stability(Stable)
public CfnCluster.Builder adminUserPassword(String adminUserPassword)

The password for the Elastic DocumentDB cluster administrator and can contain any printable ASCII characters.

Constraints :

• Must contain from 8 to 100 characters.
• Cannot contain a forward slash (/), double quote ("), or the "at" symbol (@).
• A valid AdminUserName entry is also required.

Parameters:

adminUserPassword - The password for the Elastic DocumentDB cluster administrator and can contain any printable ASCII characters. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-docdbelastic-cluster.html#cfn-docdbelastic-cluster-adminuserpassword

backupRetentionPeriod

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

The number of days for which automatic snapshots are retained.

Parameters:

backupRetentionPeriod - The number of days for which automatic snapshots are retained. This parameter is required.

Returns:

this

See Also:

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

kmsKeyId

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

The KMS key identifier to use to encrypt the new elastic cluster.

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

If an encryption key is not specified, Amazon DocumentDB uses the default encryption key that KMS creates for your account. Your account has a different default encryption key for each Amazon Region.

Parameters:

kmsKeyId - The KMS key identifier to use to encrypt the new elastic cluster. This parameter is required.

Returns:

this

See Also:

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

preferredBackupWindow

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

The daily time range during which automated backups are created if automated backups are enabled, as determined by backupRetentionPeriod .

Parameters:

preferredBackupWindow - The daily time range during which automated backups are created if automated backups are enabled, as determined by backupRetentionPeriod . This parameter is required.

Returns:

this

See Also:

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

preferredMaintenanceWindow

@Stability(Stable)
public CfnCluster.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

Default : 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-docdbelastic-cluster.html#cfn-docdbelastic-cluster-preferredmaintenancewindow

shardInstanceCount

@Stability(Stable)
public CfnCluster.Builder shardInstanceCount(Number shardInstanceCount)

The number of replica instances applying to all shards in the cluster.

A shardInstanceCount value of 1 means there is one writer instance, and any additional instances are replicas that can be used for reads and to improve availability.

Parameters:

shardInstanceCount - The number of replica instances applying to all shards in the cluster. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-docdbelastic-cluster.html#cfn-docdbelastic-cluster-shardinstancecount

subnetIds

@Stability(Stable)
public CfnCluster.Builder subnetIds(List<String> subnetIds)

The Amazon EC2 subnet IDs for the new elastic cluster.

Parameters:

subnetIds - The Amazon EC2 subnet IDs for the new elastic cluster. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-docdbelastic-cluster.html#cfn-docdbelastic-cluster-subnetids

tags

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

The tags to be assigned to the new elastic cluster.

Parameters:

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

Returns:

this

See Also:

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

vpcSecurityGroupIds

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

A list of EC2 VPC security groups to associate with the new elastic cluster.

Parameters:

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

Returns:

this

See Also:

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

build

@Stability(Stable)
public CfnCluster build()

Specified by:

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

Returns:

a newly built instance of CfnCluster.