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

Class CreateDBClusterRequest

java.lang.Object

software.amazon.awssdk.AmazonWebServiceRequest

software.amazon.awssdk.services.rds.model.CreateDBClusterRequest

All Implemented Interfaces:

Cloneable, ReadLimitInfo, ToCopyableBuilder<CreateDBClusterRequest.Builder,CreateDBClusterRequest>

@Generated("software.amazon.awssdk:codegen")
public class CreateDBClusterRequest
extends AmazonWebServiceRequest
implements ToCopyableBuilder<CreateDBClusterRequest.Builder,CreateDBClusterRequest>

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	CreateDBClusterRequest.Builder

Field Summary

Fields inherited from class software.amazon.awssdk.AmazonWebServiceRequest

NOOP

Method Summary

Modifier and Type	Method	Description
List<String>	availabilityZones()	A list of EC2 Availability Zones that instances in the DB cluster can be created in.
Integer	backupRetentionPeriod()	The number of days for which automated backups are retained.
static CreateDBClusterRequest.Builder	builder()
String	characterSetName()	A value that indicates that the DB cluster should be associated with the specified CharacterSet.
String	databaseName()	The name for your database of up to 64 alpha-numeric characters.
String	dbClusterIdentifier()	The DB cluster identifier.
String	dbClusterParameterGroupName()	The name of the DB cluster parameter group to associate with this DB cluster.
String	dbSubnetGroupName()	A DB subnet group to associate with this DB cluster.
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.
String	engine()	The name of the database engine to be used for this DB cluster.
String	engineVersion()	The version number of the database engine to use.
boolean	equals(Object obj)
int	hashCode()
String	kmsKeyId()	The KMS key identifier for an encrypted DB cluster.
String	masterUsername()	The name of the master user for the DB cluster.
String	masterUserPassword()	The password for the master database user.
String	optionGroupName()	A value that indicates that the DB cluster should be associated with the specified option group.
Integer	port()	The port number on which the instances in the DB cluster accept connections.
String	preferredBackupWindow()	The daily time range during which automated backups are created if automated backups are enabled using the BackupRetentionPeriod parameter.
String	preferredMaintenanceWindow()	The weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).
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.
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.
static Class<? extends CreateDBClusterRequest.Builder>	serializableBuilderClass()
Boolean	storageEncrypted()	Specifies whether the DB cluster is encrypted.
List<Tag>	tags()
CreateDBClusterRequest.Builder	toBuilder()	Take this object and create a builder that contains all of the current property values of this object.
String	toString()
List<String>	vpcSecurityGroupIds()	A list of EC2 VPC security groups to associate with this DB cluster.

Methods inherited from class software.amazon.awssdk.AmazonWebServiceRequest

clone, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getReadLimit, getRequestClientOptions, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, withGeneralProgressListener, withRequestMetricCollector, withSdkClientExecutionTimeout

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Method Detail

availabilityZones

public List<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.

Returns:

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.

backupRetentionPeriod

public 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

Returns:

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

characterSetName

public String characterSetName()

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

Returns:

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

databaseName

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

Returns:

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.

dbClusterIdentifier

public 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

Returns:

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

dbClusterParameterGroupName

public 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

Returns:

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

vpcSecurityGroupIds

public List<String> vpcSecurityGroupIds()

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

Returns:

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

dbSubnetGroupName

public 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

Returns:

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

engine

public String engine()

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

Valid Values: aurora

Returns:

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

Valid Values: aurora

engineVersion

public String engineVersion()

The version number of the database engine to use.

Aurora

Example: 5.6.10a

Returns:

The version number of the database engine to use.

Aurora

Example: 5.6.10a

port

public Integer port()

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

Default: 3306

Returns:

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

Default: 3306

masterUsername

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

Returns:

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.

masterUserPassword

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

Returns:

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.

optionGroupName

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

Returns:

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.

preferredBackupWindow

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

Returns:

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.

preferredMaintenanceWindow

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

Returns:

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.

replicationSourceIdentifier

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

Returns:

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

tags

public List<Tag> tags()

Returns:

storageEncrypted

public Boolean storageEncrypted()

Specifies whether the DB cluster is encrypted.

Returns:

Specifies whether the DB cluster is encrypted.

kmsKeyId

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

Returns:

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.

preSignedUrl

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

Returns:

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.

enableIAMDatabaseAuthentication

public 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

Returns:

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

toBuilder

public CreateDBClusterRequest.Builder toBuilder()

Description copied from interface: ToCopyableBuilder

Take this object and create a builder that contains all of the current property values of this object.

Specified by:

toBuilder in interface ToCopyableBuilder<CreateDBClusterRequest.Builder,CreateDBClusterRequest>

Returns:

a builder for type T

builder

public static CreateDBClusterRequest.Builder builder()

serializableBuilderClass

public static Class<? extends CreateDBClusterRequest.Builder> serializableBuilderClass()

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object