Package software.amazon.awssdk.services.rds.model

Interface CreateDBClusterRequest.Builder

All Superinterfaces:

CopyableBuilder<CreateDBClusterRequest.Builder,CreateDBClusterRequest>, SdkBuilder<CreateDBClusterRequest.Builder,CreateDBClusterRequest>

Enclosing class:

CreateDBClusterRequest

public static interface CreateDBClusterRequest.Builder
extends CopyableBuilder<CreateDBClusterRequest.Builder,CreateDBClusterRequest>

Method Summary

Modifier and Type	Method	Description
CreateDBClusterRequest.Builder	availabilityZones(String... availabilityZones)	A list of EC2 Availability Zones that instances in the DB cluster can be created in.
CreateDBClusterRequest.Builder	availabilityZones(Collection<String> availabilityZones)	A list of EC2 Availability Zones that instances in the DB cluster can be created in.
CreateDBClusterRequest.Builder	backupRetentionPeriod(Integer backupRetentionPeriod)	The number of days for which automated backups are retained.
CreateDBClusterRequest.Builder	characterSetName(String characterSetName)	A value that indicates that the DB cluster should be associated with the specified CharacterSet.
CreateDBClusterRequest.Builder	databaseName(String databaseName)	The name for your database of up to 64 alpha-numeric characters.
CreateDBClusterRequest.Builder	dbClusterIdentifier(String dbClusterIdentifier)	The DB cluster identifier.
CreateDBClusterRequest.Builder	dbClusterParameterGroupName(String dbClusterParameterGroupName)	The name of the DB cluster parameter group to associate with this DB cluster.
CreateDBClusterRequest.Builder	dbSubnetGroupName(String dbSubnetGroupName)	A DB subnet group to associate with this DB cluster.
CreateDBClusterRequest.Builder	enableIAMDatabaseAuthentication(Boolean enableIAMDatabaseAuthentication)	A Boolean value that is true to enable mapping of AWS Identity and Access Management (IAM) accounts to database accounts, and otherwise false.
CreateDBClusterRequest.Builder	engine(String engine)	The name of the database engine to be used for this DB cluster.
CreateDBClusterRequest.Builder	engineVersion(String engineVersion)	The version number of the database engine to use.
CreateDBClusterRequest.Builder	kmsKeyId(String kmsKeyId)	The KMS key identifier for an encrypted DB cluster.
CreateDBClusterRequest.Builder	masterUsername(String masterUsername)	The name of the master user for the DB cluster.
CreateDBClusterRequest.Builder	masterUserPassword(String masterUserPassword)	The password for the master database user.
CreateDBClusterRequest.Builder	optionGroupName(String optionGroupName)	A value that indicates that the DB cluster should be associated with the specified option group.
CreateDBClusterRequest.Builder	port(Integer port)	The port number on which the instances in the DB 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)	A URL that contains a Signature Version 4 signed request for the CreateDBCluster action to be called in the source region where the DB cluster will be replicated from.
CreateDBClusterRequest.Builder	replicationSourceIdentifier(String replicationSourceIdentifier)	The Amazon Resource Name (ARN) of the source DB instance or DB cluster if this DB cluster is created as a Read Replica.
CreateDBClusterRequest.Builder	storageEncrypted(Boolean storageEncrypted)	Specifies whether the DB cluster is encrypted.
CreateDBClusterRequest.Builder	tags(Collection<Tag> tags)
CreateDBClusterRequest.Builder	tags(Tag... tags)	NOTE: This method appends the values to the existing list (if any).
CreateDBClusterRequest.Builder	vpcSecurityGroupIds(String... vpcSecurityGroupIds)	A list of EC2 VPC security groups to associate with this DB cluster.
CreateDBClusterRequest.Builder	vpcSecurityGroupIds(Collection<String> vpcSecurityGroupIds)	A list of EC2 VPC security groups to associate with this DB cluster.

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

copy

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

apply, build

Method Detail

availabilityZones

CreateDBClusterRequest.Builder availabilityZones(Collection<String> availabilityZones)

A list of EC2 Availability Zones that instances in the DB cluster can be created in. For information on regions and Availability Zones, see Regions and Availability Zones.

Parameters:

availabilityZones - A list of EC2 Availability Zones that instances in the DB cluster can be created in. For information on regions and Availability Zones, see Regions and Availability Zones.

Returns:

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

availabilityZones

CreateDBClusterRequest.Builder availabilityZones(String... availabilityZones)

A list of EC2 Availability Zones that instances in the DB cluster can be created in. For information on regions and Availability Zones, see Regions and Availability Zones.

NOTE: This method appends the values to the existing list (if any). Use #setAvailabilityZones(java.util.Collection) or #withAvailabilityZones(java.util.Collection) if you want to override the existing values.

Parameters:

availabilityZones - A list of EC2 Availability Zones that instances in the DB cluster can be created in. For information on regions and Availability Zones, see Regions and Availability Zones.

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.

characterSetName

CreateDBClusterRequest.Builder characterSetName(String characterSetName)

A value that indicates that the DB cluster should be associated with the specified CharacterSet.

Parameters:

characterSetName - A value that indicates that the DB cluster should be associated with the specified CharacterSet.

Returns:

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

databaseName

CreateDBClusterRequest.Builder databaseName(String databaseName)

The name for your database of up to 64 alpha-numeric characters. If you do not provide a name, Amazon RDS will not create a database in the DB cluster you are creating.

Parameters:

databaseName - The name for your database of up to 64 alpha-numeric characters. If you do not provide a name, Amazon RDS will not create a database in the DB cluster you are creating.

Returns:

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

dbClusterIdentifier

CreateDBClusterRequest.Builder dbClusterIdentifier(String dbClusterIdentifier)

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

Constraints:

• Must contain from 1 to 63 alphanumeric characters or hyphens.

• First character must be a letter.

• Cannot end with a hyphen or contain two consecutive hyphens.

Example: my-cluster1

Parameters:

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

Constraints:

• Must contain from 1 to 63 alphanumeric characters or hyphens.

• First character must be a letter.

• Cannot end with a hyphen or contain two consecutive hyphens.

Example: my-cluster1

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 DB cluster parameter group to associate with this DB cluster. If this argument is omitted, default.aurora5.6 will be used.

Constraints:

• Must be 1 to 255 alphanumeric characters

• First character must be a letter

• Cannot end with a hyphen or contain two consecutive hyphens

Parameters:

dbClusterParameterGroupName - The name of the DB cluster parameter group to associate with this DB cluster. If this argument is omitted, default.aurora5.6 will be used.

Constraints:

• Must be 1 to 255 alphanumeric characters

• First character must be a letter

• Cannot end with a hyphen or contain two consecutive hyphens

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 DB cluster.

Parameters:

vpcSecurityGroupIds - A list of EC2 VPC security groups to associate with this DB 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 DB cluster.

NOTE: This method appends the values to the existing list (if any). Use #setVpcSecurityGroupIds(java.util.Collection) or #withVpcSecurityGroupIds(java.util.Collection) if you want to override the existing values.

Parameters:

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

Returns:

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

dbSubnetGroupName

CreateDBClusterRequest.Builder dbSubnetGroupName(String dbSubnetGroupName)

A DB subnet group to associate with this DB cluster.

Constraints: Must contain no more than 255 alphanumeric characters, periods, underscores, spaces, or hyphens. Must not be default.

Example: mySubnetgroup

Parameters:

dbSubnetGroupName - A DB subnet group to associate with this DB cluster.

Constraints: Must contain no more than 255 alphanumeric characters, periods, underscores, spaces, or hyphens. 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 DB cluster.

Valid Values: aurora

Parameters:

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

Valid Values: aurora

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.

Aurora

Example: 5.6.10a

Parameters:

engineVersion - The version number of the database engine to use.

Aurora

Example: 5.6.10a

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 DB cluster accept connections.

Default: 3306

Parameters:

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

Default: 3306

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 DB cluster.

Constraints:

• Must be 1 to 16 alphanumeric characters.

• 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 DB cluster.

Constraints:

• Must be 1 to 16 alphanumeric characters.

• 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 "/", """, or "@".

Constraints: Must contain from 8 to 41 characters.

Parameters:

masterUserPassword - The password for the master database user. This password can contain any printable ASCII character except "/", """, or "@".

Constraints: Must contain from 8 to 41 characters.

Returns:

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

optionGroupName

CreateDBClusterRequest.Builder optionGroupName(String optionGroupName)

A value that indicates that the DB cluster should be associated with the specified option group.

Permanent options cannot be removed from an option group. The option group cannot be removed from a DB cluster once it is associated with a DB cluster.

Parameters:

optionGroupName - A value that indicates that the DB cluster should be associated with the specified option group.

Permanent options cannot be removed from an option group. The option group cannot be removed from a DB cluster once it is associated with a DB cluster.

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.

Default: A 30-minute window selected at random from an 8-hour block of time per region. To see the time blocks available, see Adjusting the Preferred Maintenance Window in the Amazon RDS User Guide.

Constraints:

• Must be in the format hh24:mi-hh24:mi.

• Times should 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.

Default: A 30-minute window selected at random from an 8-hour block of time per region. To see the time blocks available, see Adjusting the Preferred Maintenance Window in the Amazon RDS User Guide.

Constraints:

• Must be in the format hh24:mi-hh24:mi.

• Times should 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

Default: A 30-minute window selected at random from an 8-hour block of time per region, occurring on a random day of the week. To see the time blocks available, see Adjusting the Preferred Maintenance Window in the Amazon RDS User Guide.

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

Default: A 30-minute window selected at random from an 8-hour block of time per region, occurring on a random day of the week. To see the time blocks available, see Adjusting the Preferred Maintenance Window in the Amazon RDS User Guide.

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.

replicationSourceIdentifier

CreateDBClusterRequest.Builder replicationSourceIdentifier(String replicationSourceIdentifier)

The Amazon Resource Name (ARN) of the source DB instance or DB cluster if this DB cluster is created as a Read Replica.

Parameters:

replicationSourceIdentifier - The Amazon Resource Name (ARN) of the source DB instance or DB cluster if this DB cluster is created as a Read Replica.

Returns:

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

tags

CreateDBClusterRequest.Builder tags(Collection<Tag> tags)

Parameters:

tags -

Returns:

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

tags

CreateDBClusterRequest.Builder tags(Tag... tags)

NOTE: This method appends the values to the existing list (if any). Use #setTags(java.util.Collection) or #withTags(java.util.Collection) if you want to override the existing values.

Parameters:

tags -

Returns:

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

storageEncrypted

CreateDBClusterRequest.Builder storageEncrypted(Boolean storageEncrypted)

Specifies whether the DB cluster is encrypted.

Parameters:

storageEncrypted - Specifies whether the DB 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 DB cluster.

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

If the StorageEncrypted parameter is true, and you do not specify a value for the KmsKeyId parameter, then Amazon RDS will use 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 region.

If you create a Read Replica of an encrypted DB cluster in another region, you must set KmsKeyId to a KMS key ID that is valid in the destination region. This key is used to encrypt the Read Replica in that region.

Parameters:

kmsKeyId - The KMS key identifier for an encrypted DB cluster.

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

If the StorageEncrypted parameter is true, and you do not specify a value for the KmsKeyId parameter, then Amazon RDS will use 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 region.

If you create a Read Replica of an encrypted DB cluster in another region, you must set KmsKeyId to a KMS key ID that is valid in the destination region. This key is used to encrypt the Read Replica in that region.

Returns:

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

preSignedUrl

CreateDBClusterRequest.Builder preSignedUrl(String preSignedUrl)

A URL that contains a Signature Version 4 signed request for the CreateDBCluster action to be called in the source region where the DB cluster will be replicated from. You only need to specify PreSignedUrl when you are performing cross-region replication from an encrypted DB cluster.

The pre-signed URL must be a valid request for the CreateDBCluster API action that can be executed in the source region that contains the encrypted DB cluster to be copied.

The pre-signed URL request must contain the following parameter values:

• KmsKeyId - The KMS key identifier for the key to use to encrypt the copy of the DB cluster in the destination region. This should refer to the same KMS key for both the CreateDBCluster action that is called in the destination region, and the action contained in the pre-signed URL.

• DestinationRegion - The name of the region that Aurora Read Replica will be created in.

• ReplicationSourceIdentifier - The DB cluster identifier for the encrypted DB cluster to be copied. This identifier must be in the Amazon Resource Name (ARN) format for the source region. For example, if you are copying an encrypted DB cluster from the us-west-2 region, then your ReplicationSourceIdentifier would look like Example: arn:aws:rds:us-west-2:123456789012:cluster:aurora-cluster1.

To learn how to generate a Signature Version 4 signed request, see Authenticating Requests: Using Query Parameters (AWS Signature Version 4) and Signature Version 4 Signing Process.

Parameters:

preSignedUrl - A URL that contains a Signature Version 4 signed request for the CreateDBCluster action to be called in the source region where the DB cluster will be replicated from. You only need to specify PreSignedUrl when you are performing cross-region replication from an encrypted DB cluster.

The pre-signed URL must be a valid request for the CreateDBCluster API action that can be executed in the source region that contains the encrypted DB cluster to be copied.

The pre-signed URL request must contain the following parameter values:

• KmsKeyId - The KMS key identifier for the key to use to encrypt the copy of the DB cluster in the destination region. This should refer to the same KMS key for both the CreateDBCluster action that is called in the destination region, and the action contained in the pre-signed URL.

• DestinationRegion - The name of the region that Aurora Read Replica will be created in.

• ReplicationSourceIdentifier - The DB cluster identifier for the encrypted DB cluster to be copied. This identifier must be in the Amazon Resource Name (ARN) format for the source region. For example, if you are copying an encrypted DB cluster from the us-west-2 region, then your ReplicationSourceIdentifier would look like Example: arn:aws:rds:us-west-2:123456789012:cluster:aurora-cluster1.

To learn how to generate a Signature Version 4 signed request, see Authenticating Requests: Using Query Parameters (AWS Signature Version 4) and Signature Version 4 Signing Process.

Returns:

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

enableIAMDatabaseAuthentication

CreateDBClusterRequest.Builder enableIAMDatabaseAuthentication(Boolean enableIAMDatabaseAuthentication)

A Boolean value that is true to enable mapping of AWS Identity and Access Management (IAM) accounts to database accounts, and otherwise false.

Default: false

Parameters:

enableIAMDatabaseAuthentication - A Boolean value that is true to enable mapping of AWS Identity and Access Management (IAM) accounts to database accounts, and otherwise false.

Default: false

Returns:

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