public static interface CreateDbClusterRequest.Builder extends RdsRequest.Builder, CopyableBuilder<CreateDbClusterRequest.Builder,CreateDbClusterRequest>
Modifier and Type | Method and Description |
---|---|
CreateDbClusterRequest.Builder |
availabilityZones(Collection<String> availabilityZones)
A list of EC2 Availability Zones that instances in the DB cluster can be created in.
|
CreateDbClusterRequest.Builder |
availabilityZones(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)
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 AWS 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 |
overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
Add an optional request override configuration.
|
CreateDbClusterRequest.Builder |
overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
Add an optional request override configuration.
|
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 AWS Region where the DB cluster is 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)
Sets the value of the Tags property for this object.
|
CreateDbClusterRequest.Builder |
tags(Consumer<Tag.Builder>... tags)
Sets the value of the Tags property for this object.
|
CreateDbClusterRequest.Builder |
tags(Tag... tags)
Sets the value of the Tags property for this object.
|
CreateDbClusterRequest.Builder |
vpcSecurityGroupIds(Collection<String> vpcSecurityGroupIds)
A list of EC2 VPC security groups to associate with this DB cluster.
|
CreateDbClusterRequest.Builder |
vpcSecurityGroupIds(String... vpcSecurityGroupIds)
A list of EC2 VPC security groups to associate with this DB cluster.
|
build
overrideConfiguration
copy
applyMutation, build
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 AWS Regions and Availability Zones, see Regions and Availability Zones.
availabilityZones
- A list of EC2 Availability Zones that instances in the DB cluster can be created in. For information
on AWS Regions and Availability Zones, see Regions and Availability Zones.CreateDbClusterRequest.Builder availabilityZones(String... availabilityZones)
A list of EC2 Availability Zones that instances in the DB cluster can be created in. For information on AWS Regions and Availability Zones, see Regions and Availability Zones.
availabilityZones
- A list of EC2 Availability Zones that instances in the DB cluster can be created in. For information
on AWS Regions and Availability Zones, see Regions and Availability Zones.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
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
CreateDbClusterRequest.Builder characterSetName(String characterSetName)
A value that indicates that the DB cluster should be associated with the specified CharacterSet.
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. If you do not provide a name, Amazon RDS will not create a database in the DB cluster you are creating.
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.CreateDbClusterRequest.Builder dbClusterIdentifier(String dbClusterIdentifier)
The DB cluster identifier. This parameter is stored as a lowercase string.
Constraints:
Must contain from 1 to 63 letters, numbers, or hyphens.
First character must be a letter.
Cannot end with a hyphen or contain two consecutive hyphens.
Example: my-cluster1
dbClusterIdentifier
- The DB cluster identifier. This parameter is stored as a lowercase string.
Constraints:
Must contain from 1 to 63 letters, numbers, or hyphens.
First character must be a letter.
Cannot end with a hyphen or contain two consecutive hyphens.
Example: my-cluster1
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
is used.
Constraints:
If supplied, must match the name of an existing DBClusterParameterGroup.
dbClusterParameterGroupName
- The name of the DB cluster parameter group to associate with this DB cluster. If this argument is
omitted, default.aurora5.6
is used.
Constraints:
If supplied, must match the name of an existing DBClusterParameterGroup.
CreateDbClusterRequest.Builder vpcSecurityGroupIds(Collection<String> vpcSecurityGroupIds)
A list of EC2 VPC security groups to associate with this DB cluster.
vpcSecurityGroupIds
- A list of EC2 VPC security groups to associate with this DB cluster.CreateDbClusterRequest.Builder vpcSecurityGroupIds(String... vpcSecurityGroupIds)
A list of EC2 VPC security groups to associate with this DB cluster.
vpcSecurityGroupIds
- A list of EC2 VPC security groups to associate with this DB cluster.CreateDbClusterRequest.Builder dbSubnetGroupName(String dbSubnetGroupName)
A DB subnet group to associate with this DB cluster.
Constraints: Must match the name of an existing DBSubnetGroup. Must not be default.
Example: mySubnetgroup
dbSubnetGroupName
- A DB subnet group to associate with this DB cluster.
Constraints: Must match the name of an existing DBSubnetGroup. Must not be default.
Example: mySubnetgroup
CreateDbClusterRequest.Builder engine(String engine)
The name of the database engine to be used for this DB cluster.
Valid Values: aurora
, aurora-postgresql
engine
- The name of the database engine to be used for this DB cluster.
Valid Values: aurora
, aurora-postgresql
CreateDbClusterRequest.Builder engineVersion(String engineVersion)
The version number of the database engine to use.
Aurora
Example: 5.6.10a
engineVersion
- The version number of the database engine to use.
Aurora
Example: 5.6.10a
CreateDbClusterRequest.Builder port(Integer port)
The port number on which the instances in the DB cluster accept connections.
Default: 3306
port
- The port number on which the instances in the DB cluster accept connections.
Default: 3306
CreateDbClusterRequest.Builder masterUsername(String masterUsername)
The name of the master user for the DB cluster.
Constraints:
Must be 1 to 16 letters or numbers.
First character must be a letter.
Cannot be a reserved word for the chosen database engine.
masterUsername
- The name of the master user for the DB cluster.
Constraints:
Must be 1 to 16 letters or numbers.
First character must be a letter.
Cannot be a reserved word for the chosen database engine.
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.
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.
CreateDbClusterRequest.Builder optionGroupName(String optionGroupName)
A value that indicates that the DB cluster should be associated with the specified option group.
Permanent options can't be removed from an option group. The option group can't be removed from a DB cluster once it is associated with a DB cluster.
optionGroupName
- A value that indicates that the DB cluster should be associated with the specified option group.
Permanent options can't be removed from an option group. The option group can't be removed from a DB cluster once it is associated with a DB cluster.
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 AWS 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
.
Must be in Universal Coordinated Time (UTC).
Must not conflict with the preferred maintenance window.
Must be at least 30 minutes.
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. 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
.
Must be in Universal Coordinated Time (UTC).
Must not conflict with the preferred maintenance window.
Must be at least 30 minutes.
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 AWS 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.
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. 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.
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.
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 tags(Collection<Tag> tags)
tags
- The new value for the Tags property for this object.CreateDbClusterRequest.Builder tags(Tag... tags)
tags
- The new value for the Tags property for this object.CreateDbClusterRequest.Builder tags(Consumer<Tag.Builder>... tags)
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)
.tags
- a consumer that will call methods on List.Builder
#tags(List)
CreateDbClusterRequest.Builder storageEncrypted(Boolean storageEncrypted)
Specifies whether the DB cluster is encrypted.
storageEncrypted
- Specifies whether the DB cluster is encrypted.CreateDbClusterRequest.Builder kmsKeyId(String kmsKeyId)
The AWS 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 an encryption key is not specified in KmsKeyId
:
If ReplicationSourceIdentifier
identifies an encrypted source, then Amazon RDS will use the
encryption key used to encrypt the source. Otherwise, Amazon RDS will use your default encryption key.
If the StorageEncrypted
parameter is true and ReplicationSourceIdentifier
is not
specified, 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 AWS Region, you must set
KmsKeyId
to a KMS key ID that is valid in the destination AWS Region. This key is used to
encrypt the Read Replica in that AWS Region.
kmsKeyId
- The AWS 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 an encryption key is not specified in KmsKeyId
:
If ReplicationSourceIdentifier
identifies an encrypted source, then Amazon RDS will use
the encryption key used to encrypt the source. Otherwise, Amazon RDS will use your default encryption
key.
If the StorageEncrypted
parameter is true and ReplicationSourceIdentifier
is
not specified, 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 AWS Region, you must set
KmsKeyId
to a KMS key ID that is valid in the destination AWS Region. This key is used to
encrypt the Read Replica in that AWS Region.
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 AWS Region where the DB cluster is 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 AWS Region that contains the encrypted DB cluster to be copied.
The pre-signed URL request must contain the following parameter values:
KmsKeyId
- The AWS KMS key identifier for the key to use to encrypt the copy of the DB cluster
in the destination AWS Region. This should refer to the same KMS key for both the
CreateDBCluster
action that is called in the destination AWS Region, and the action contained in
the pre-signed URL.
DestinationRegion
- The name of the AWS 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 AWS Region. For
example, if you are copying an encrypted DB cluster from the us-west-2 AWS 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.
preSignedUrl
- A URL that contains a Signature Version 4 signed request for the CreateDBCluster
action
to be called in the source AWS Region where the DB cluster is 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 AWS Region that contains the encrypted DB cluster to be copied.
The pre-signed URL request must contain the following parameter values:
KmsKeyId
- The AWS KMS key identifier for the key to use to encrypt the copy of the DB
cluster in the destination AWS Region. This should refer to the same KMS key for both the
CreateDBCluster
action that is called in the destination AWS Region, and the action
contained in the pre-signed URL.
DestinationRegion
- The name of the AWS 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 AWS Region.
For example, if you are copying an encrypted DB cluster from the us-west-2 AWS 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.
CreateDbClusterRequest.Builder enableIAMDatabaseAuthentication(Boolean enableIAMDatabaseAuthentication)
True to enable mapping of AWS Identity and Access Management (IAM) accounts to database accounts, and otherwise false.
Default: false
enableIAMDatabaseAuthentication
- True to enable mapping of AWS Identity and Access Management (IAM) accounts to database accounts, and
otherwise false.
Default: false
CreateDbClusterRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
AwsRequest.Builder
overrideConfiguration
in interface AwsRequest.Builder
overrideConfiguration
- The override configuration.CreateDbClusterRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
AwsRequest.Builder
overrideConfiguration
in interface AwsRequest.Builder
builderConsumer
- A Consumer
to which an empty AwsRequestOverrideConfiguration.Builder
will be
given.Copyright © 2017 Amazon Web Services, Inc. All Rights Reserved.