software.amazon.awssdk.services.docdb.model

Interface CreateDbClusterRequest.Builder

All Superinterfaces:

AwsRequest.Builder, Buildable, CopyableBuilder<CreateDbClusterRequest.Builder,CreateDbClusterRequest>, DocDbRequest.Builder, SdkBuilder<CreateDbClusterRequest.Builder,CreateDbClusterRequest>, SdkPojo, SdkRequest.Builder

Enclosing class:

CreateDbClusterRequest

public static interface CreateDbClusterRequest.Builder
extends DocDbRequest.Builder, SdkPojo, CopyableBuilder<CreateDbClusterRequest.Builder,CreateDbClusterRequest>

Method Summary

Modifier and Type	Method and Description
CreateDbClusterRequest.Builder	availabilityZones(Collection<String> availabilityZones) A list of Amazon EC2 Availability Zones that instances in the cluster can be created in.
CreateDbClusterRequest.Builder	availabilityZones(String... availabilityZones) A list of Amazon EC2 Availability Zones that instances in the cluster can be created in.
CreateDbClusterRequest.Builder	backupRetentionPeriod(Integer backupRetentionPeriod) The number of days for which automated backups are retained.
CreateDbClusterRequest.Builder	dbClusterIdentifier(String dbClusterIdentifier) The cluster identifier.
CreateDbClusterRequest.Builder	dbClusterParameterGroupName(String dbClusterParameterGroupName) The name of the cluster parameter group to associate with this cluster.
CreateDbClusterRequest.Builder	dbSubnetGroupName(String dbSubnetGroupName) A subnet group to associate with this cluster.
CreateDbClusterRequest.Builder	deletionProtection(Boolean deletionProtection) Specifies whether this cluster can be deleted.
CreateDbClusterRequest.Builder	enableCloudwatchLogsExports(Collection<String> enableCloudwatchLogsExports) A list of log types that need to be enabled for exporting to Amazon CloudWatch Logs.
CreateDbClusterRequest.Builder	enableCloudwatchLogsExports(String... enableCloudwatchLogsExports) A list of log types that need to be enabled for exporting to Amazon CloudWatch Logs.
CreateDbClusterRequest.Builder	engine(String engine) The name of the database engine to be used for this cluster.
CreateDbClusterRequest.Builder	engineVersion(String engineVersion) The version number of the database engine to use.
CreateDbClusterRequest.Builder	globalClusterIdentifier(String globalClusterIdentifier) The cluster identifier of the new global cluster.
CreateDbClusterRequest.Builder	kmsKeyId(String kmsKeyId) The KMS key identifier for an encrypted cluster.
CreateDbClusterRequest.Builder	masterUsername(String masterUsername) The name of the master user for the cluster.
CreateDbClusterRequest.Builder	masterUserPassword(String masterUserPassword) The password for the master database user.
CreateDbClusterRequest.Builder	overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
CreateDbClusterRequest.Builder	overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
CreateDbClusterRequest.Builder	port(Integer port) The port number on which the instances in the cluster accept connections.
CreateDbClusterRequest.Builder	preferredBackupWindow(String preferredBackupWindow) The daily time range during which automated backups are created if automated backups are enabled using the BackupRetentionPeriod parameter.
CreateDbClusterRequest.Builder	preferredMaintenanceWindow(String preferredMaintenanceWindow) The weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).
CreateDbClusterRequest.Builder	preSignedUrl(String preSignedUrl) Not currently supported.
CreateDbClusterRequest.Builder	sourceRegion(String sourceRegion) If PreSignedUrl is not specified, this is the region where the source snapshot is located.
CreateDbClusterRequest.Builder	storageEncrypted(Boolean storageEncrypted) Specifies whether the cluster is encrypted.
CreateDbClusterRequest.Builder	tags(Collection<Tag> tags) The tags to be assigned to the cluster.
CreateDbClusterRequest.Builder	tags(Consumer<Tag.Builder>... tags) The tags to be assigned to the cluster.
CreateDbClusterRequest.Builder	tags(Tag... tags) The tags to be assigned to the cluster.
CreateDbClusterRequest.Builder	vpcSecurityGroupIds(Collection<String> vpcSecurityGroupIds) A list of EC2 VPC security groups to associate with this cluster.
CreateDbClusterRequest.Builder	vpcSecurityGroupIds(String... vpcSecurityGroupIds) A list of EC2 VPC security groups to associate with this cluster.

Methods inherited from interface software.amazon.awssdk.services.docdb.model.DocDbRequest.Builder

build

Methods inherited from interface software.amazon.awssdk.awscore.AwsRequest.Builder

overrideConfiguration

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

equalsBySdkFields, sdkFields

Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder

copy

Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder

applyMutation, build

Method Detail

availabilityZones

CreateDbClusterRequest.Builder availabilityZones(Collection<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.

Returns:

Returns a reference to this object so that method calls can be chained together.

availabilityZones

CreateDbClusterRequest.Builder availabilityZones(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.

Returns:

Returns a reference to this object so that method calls can be chained together.

backupRetentionPeriod

CreateDbClusterRequest.Builder backupRetentionPeriod(Integer 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.

Default: 1

Constraints:

• Must be a value from 1 to 35.

Returns:

Returns a reference to this object so that method calls can be chained together.

dbClusterIdentifier

CreateDbClusterRequest.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.

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

Returns:

Returns a reference to this object so that method calls can be chained together.

dbClusterParameterGroupName

CreateDbClusterRequest.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.

Returns:

Returns a reference to this object so that method calls can be chained together.

vpcSecurityGroupIds

CreateDbClusterRequest.Builder vpcSecurityGroupIds(Collection<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.

Returns:

Returns a reference to this object so that method calls can be chained together.

vpcSecurityGroupIds

CreateDbClusterRequest.Builder vpcSecurityGroupIds(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.

Returns:

Returns a reference to this object so that method calls can be chained together.

dbSubnetGroupName

CreateDbClusterRequest.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.

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

Example: mySubnetgroup

Returns:

Returns a reference to this object so that method calls can be chained together.

engine

CreateDbClusterRequest.Builder engine(String engine)

The name of the database engine to be used for this cluster.

Valid values: docdb

Parameters:

engine - The name of the database engine to be used for this cluster.

Valid values: docdb

Returns:

Returns a reference to this object so that method calls can be chained together.

engineVersion

CreateDbClusterRequest.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. 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.

Returns:

Returns a reference to this object so that method calls can be chained together.

port

CreateDbClusterRequest.Builder port(Integer port)

The port number on which the instances in the cluster accept connections.

Parameters:

port - The port number on which the instances in the cluster accept connections.

Returns:

Returns a reference to this object so that method calls can be chained together.

masterUsername

CreateDbClusterRequest.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.

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.

Returns:

Returns a reference to this object so that method calls can be chained together.

masterUserPassword

CreateDbClusterRequest.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 password can contain any printable ASCII character except forward slash (/), double quote ("), or the "at" symbol (@).

Constraints: Must contain from 8 to 100 characters.

Returns:

Returns a reference to this object so that method calls can be chained together.

preferredBackupWindow

CreateDbClusterRequest.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 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.

The default is a 30-minute window selected at random from an 8-hour block of time for each 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.

Returns:

Returns a reference to this object so that method calls can be chained together.

preferredMaintenanceWindow

CreateDbClusterRequest.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 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).

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 Region, occurring on a random day of the week.

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

Constraints: Minimum 30-minute window.

Returns:

Returns a reference to this object so that method calls can be chained together.

tags

CreateDbClusterRequest.Builder tags(Collection<Tag> tags)

The tags to be assigned to the cluster.

Parameters:

tags - The tags to be assigned to the cluster.

Returns:

Returns a reference to this object so that method calls can be chained together.

tags

CreateDbClusterRequest.Builder tags(Tag... tags)

The tags to be assigned to the cluster.

Parameters:

tags - The tags to be assigned to the cluster.

Returns:

Returns a reference to this object so that method calls can be chained together.

tags

CreateDbClusterRequest.Builder tags(Consumer<Tag.Builder>... tags)

The tags to be assigned to the cluster.

This is a convenience that creates an instance of the List.Builder avoiding the need to create one manually via List#builder(). When the Consumer completes, List.Builder#build() is called immediately and its result is passed to #tags(List).

Parameters:

tags - a consumer that will call methods on List.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

#tags(List)

storageEncrypted

CreateDbClusterRequest.Builder storageEncrypted(Boolean storageEncrypted)

Specifies whether the cluster is encrypted.

Parameters:

storageEncrypted - Specifies whether the cluster is encrypted.

Returns:

Returns a reference to this object so that method calls can be chained together.

kmsKeyId

CreateDbClusterRequest.Builder kmsKeyId(String kmsKeyId)

The KMS key identifier for an encrypted 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 account that owns the KMS encryption key that is used to encrypt the new cluster, you can use the KMS key alias instead of the ARN for the 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.

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

Parameters:

kmsKeyId - The KMS key identifier for an encrypted 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 account that owns the KMS encryption key that is used to encrypt the new cluster, you can use the KMS key alias instead of the ARN for the 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.

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

Returns:

Returns a reference to this object so that method calls can be chained together.

preSignedUrl

CreateDbClusterRequest.Builder preSignedUrl(String preSignedUrl)

Not currently supported.

Parameters:

preSignedUrl - Not currently supported.

Returns:

Returns a reference to this object so that method calls can be chained together.

enableCloudwatchLogsExports

CreateDbClusterRequest.Builder enableCloudwatchLogsExports(Collection<String> enableCloudwatchLogsExports)

A 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 - A 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.

Returns:

Returns a reference to this object so that method calls can be chained together.

enableCloudwatchLogsExports

CreateDbClusterRequest.Builder enableCloudwatchLogsExports(String... enableCloudwatchLogsExports)

A 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 - A 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.

Returns:

Returns a reference to this object so that method calls can be chained together.

deletionProtection

CreateDbClusterRequest.Builder deletionProtection(Boolean deletionProtection)

Specifies whether this cluster can be deleted. If DeletionProtection is enabled, the cluster cannot be deleted unless it is modified and DeletionProtection is disabled. DeletionProtection protects clusters from being accidentally deleted.

Parameters:

deletionProtection - Specifies whether this cluster can be deleted. If DeletionProtection is enabled, the cluster cannot be deleted unless it is modified and DeletionProtection is disabled. DeletionProtection protects clusters from being accidentally deleted.

Returns:

Returns a reference to this object so that method calls can be chained together.

globalClusterIdentifier

CreateDbClusterRequest.Builder globalClusterIdentifier(String globalClusterIdentifier)

The cluster identifier of the new global cluster.

Parameters:

globalClusterIdentifier - The cluster identifier of the new global cluster.

Returns:

Returns a reference to this object so that method calls can be chained together.

sourceRegion

CreateDbClusterRequest.Builder sourceRegion(String sourceRegion)

If PreSignedUrl is not specified, this is the region where the source snapshot is located. A PreSignedUrl will be generated automatically by the SDK.

Parameters:

sourceRegion - If PreSignedUrl is not specified, this is the region where the source snapshot is located. A PreSignedUrl will be generated automatically by the SDK.

Returns:

Returns a reference to this object so that method calls can be chained together.

overrideConfiguration

CreateDbClusterRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)

Specified by:

overrideConfiguration in interface AwsRequest.Builder

overrideConfiguration

CreateDbClusterRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)

Specified by:

overrideConfiguration in interface AwsRequest.Builder