@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class CreateDBClusterRequest extends AmazonWebServiceRequest implements Serializable, Cloneable
NOOP
Constructor and Description |
---|
CreateDBClusterRequest() |
Modifier and Type | Method and Description |
---|---|
CreateDBClusterRequest |
clone()
Creates a shallow clone of this object for all fields except the handler context.
|
boolean |
equals(Object obj) |
List<String> |
getAvailabilityZones()
A list of Availability Zones (AZs) where instances in the DB cluster can be created.
|
Long |
getBacktrackWindow()
The target backtrack window, in seconds.
|
Integer |
getBackupRetentionPeriod()
The number of days for which automated backups are retained.
|
String |
getCharacterSetName()
A value that indicates that the DB cluster should be associated with the specified CharacterSet.
|
Boolean |
getCopyTagsToSnapshot()
A value that indicates whether to copy all tags from the DB cluster to snapshots of the DB cluster.
|
String |
getDatabaseName()
The name for your database of up to 64 alphanumeric characters.
|
String |
getDBClusterIdentifier()
The DB cluster identifier.
|
String |
getDBClusterParameterGroupName()
The name of the DB cluster parameter group to associate with this DB cluster.
|
String |
getDBSubnetGroupName()
A DB subnet group to associate with this DB cluster.
|
Boolean |
getDeletionProtection()
A value that indicates whether the DB cluster has deletion protection enabled.
|
String |
getDomain()
The Active Directory directory ID to create the DB cluster in.
|
String |
getDomainIAMRoleName()
Specify the name of the IAM role to be used when making API calls to the Directory Service.
|
List<String> |
getEnableCloudwatchLogsExports()
The list of log types that need to be enabled for exporting to CloudWatch Logs.
|
Boolean |
getEnableGlobalWriteForwarding()
A value that indicates whether to enable write operations to be forwarded from this cluster to the primary
cluster in an Aurora global database.
|
Boolean |
getEnableHttpEndpoint()
A value that indicates whether to enable the HTTP endpoint for an Aurora Serverless DB cluster.
|
Boolean |
getEnableIAMDatabaseAuthentication()
A value that indicates whether to enable mapping of AWS Identity and Access Management (IAM) accounts to database
accounts.
|
String |
getEngine()
The name of the database engine to be used for this DB cluster.
|
String |
getEngineMode()
The DB engine mode of the DB cluster, either
provisioned , serverless ,
parallelquery , global , or multimaster . |
String |
getEngineVersion()
The version number of the database engine to use.
|
String |
getGlobalClusterIdentifier()
The global cluster ID of an Aurora cluster that becomes the primary cluster in the new global database cluster.
|
String |
getKmsKeyId()
The AWS KMS key identifier for an encrypted DB cluster.
|
String |
getMasterUsername()
The name of the master user for the DB cluster.
|
String |
getMasterUserPassword()
The password for the master database user.
|
String |
getOptionGroupName()
A value that indicates that the DB cluster should be associated with the specified option group.
|
Integer |
getPort()
The port number on which the instances in the DB cluster accept connections.
|
String |
getPreferredBackupWindow()
The daily time range during which automated backups are created if automated backups are enabled using the
BackupRetentionPeriod parameter. |
String |
getPreferredMaintenanceWindow()
The weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).
|
String |
getPreSignedUrl()
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. |
String |
getReplicationSourceIdentifier()
The Amazon Resource Name (ARN) of the source DB instance or DB cluster if this DB cluster is created as a read
replica.
|
ScalingConfiguration |
getScalingConfiguration()
For DB clusters in
serverless DB engine mode, the scaling properties of the DB cluster. |
String |
getSourceRegion()
The region where the source instance is located.
|
Boolean |
getStorageEncrypted()
A value that indicates whether the DB cluster is encrypted.
|
List<Tag> |
getTags()
Tags to assign to the DB cluster.
|
List<String> |
getVpcSecurityGroupIds()
A list of EC2 VPC security groups to associate with this DB cluster.
|
int |
hashCode() |
Boolean |
isCopyTagsToSnapshot()
A value that indicates whether to copy all tags from the DB cluster to snapshots of the DB cluster.
|
Boolean |
isDeletionProtection()
A value that indicates whether the DB cluster has deletion protection enabled.
|
Boolean |
isEnableGlobalWriteForwarding()
A value that indicates whether to enable write operations to be forwarded from this cluster to the primary
cluster in an Aurora global database.
|
Boolean |
isEnableHttpEndpoint()
A value that indicates whether to enable the HTTP endpoint for an Aurora Serverless DB cluster.
|
Boolean |
isEnableIAMDatabaseAuthentication()
A value that indicates whether to enable mapping of AWS Identity and Access Management (IAM) accounts to database
accounts.
|
Boolean |
isStorageEncrypted()
A value that indicates whether the DB cluster is encrypted.
|
void |
setAvailabilityZones(Collection<String> availabilityZones)
A list of Availability Zones (AZs) where instances in the DB cluster can be created.
|
void |
setBacktrackWindow(Long backtrackWindow)
The target backtrack window, in seconds.
|
void |
setBackupRetentionPeriod(Integer backupRetentionPeriod)
The number of days for which automated backups are retained.
|
void |
setCharacterSetName(String characterSetName)
A value that indicates that the DB cluster should be associated with the specified CharacterSet.
|
void |
setCopyTagsToSnapshot(Boolean copyTagsToSnapshot)
A value that indicates whether to copy all tags from the DB cluster to snapshots of the DB cluster.
|
void |
setDatabaseName(String databaseName)
The name for your database of up to 64 alphanumeric characters.
|
void |
setDBClusterIdentifier(String dBClusterIdentifier)
The DB cluster identifier.
|
void |
setDBClusterParameterGroupName(String dBClusterParameterGroupName)
The name of the DB cluster parameter group to associate with this DB cluster.
|
void |
setDBSubnetGroupName(String dBSubnetGroupName)
A DB subnet group to associate with this DB cluster.
|
void |
setDeletionProtection(Boolean deletionProtection)
A value that indicates whether the DB cluster has deletion protection enabled.
|
void |
setDomain(String domain)
The Active Directory directory ID to create the DB cluster in.
|
void |
setDomainIAMRoleName(String domainIAMRoleName)
Specify the name of the IAM role to be used when making API calls to the Directory Service.
|
void |
setEnableCloudwatchLogsExports(Collection<String> enableCloudwatchLogsExports)
The list of log types that need to be enabled for exporting to CloudWatch Logs.
|
void |
setEnableGlobalWriteForwarding(Boolean enableGlobalWriteForwarding)
A value that indicates whether to enable write operations to be forwarded from this cluster to the primary
cluster in an Aurora global database.
|
void |
setEnableHttpEndpoint(Boolean enableHttpEndpoint)
A value that indicates whether to enable the HTTP endpoint for an Aurora Serverless DB cluster.
|
void |
setEnableIAMDatabaseAuthentication(Boolean enableIAMDatabaseAuthentication)
A value that indicates whether to enable mapping of AWS Identity and Access Management (IAM) accounts to database
accounts.
|
void |
setEngine(String engine)
The name of the database engine to be used for this DB cluster.
|
void |
setEngineMode(String engineMode)
The DB engine mode of the DB cluster, either
provisioned , serverless ,
parallelquery , global , or multimaster . |
void |
setEngineVersion(String engineVersion)
The version number of the database engine to use.
|
void |
setGlobalClusterIdentifier(String globalClusterIdentifier)
The global cluster ID of an Aurora cluster that becomes the primary cluster in the new global database cluster.
|
void |
setKmsKeyId(String kmsKeyId)
The AWS KMS key identifier for an encrypted DB cluster.
|
void |
setMasterUsername(String masterUsername)
The name of the master user for the DB cluster.
|
void |
setMasterUserPassword(String masterUserPassword)
The password for the master database user.
|
void |
setOptionGroupName(String optionGroupName)
A value that indicates that the DB cluster should be associated with the specified option group.
|
void |
setPort(Integer port)
The port number on which the instances in the DB cluster accept connections.
|
void |
setPreferredBackupWindow(String preferredBackupWindow)
The daily time range during which automated backups are created if automated backups are enabled using the
BackupRetentionPeriod parameter. |
void |
setPreferredMaintenanceWindow(String preferredMaintenanceWindow)
The weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).
|
void |
setPreSignedUrl(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. |
void |
setReplicationSourceIdentifier(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.
|
void |
setScalingConfiguration(ScalingConfiguration scalingConfiguration)
For DB clusters in
serverless DB engine mode, the scaling properties of the DB cluster. |
void |
setSourceRegion(String sourceRegion)
The region where the source instance is located.
|
void |
setStorageEncrypted(Boolean storageEncrypted)
A value that indicates whether the DB cluster is encrypted.
|
void |
setTags(Collection<Tag> tags)
Tags to assign to the DB cluster.
|
void |
setVpcSecurityGroupIds(Collection<String> vpcSecurityGroupIds)
A list of EC2 VPC security groups to associate with this DB cluster.
|
String |
toString()
Returns a string representation of this object.
|
CreateDBClusterRequest |
withAvailabilityZones(Collection<String> availabilityZones)
A list of Availability Zones (AZs) where instances in the DB cluster can be created.
|
CreateDBClusterRequest |
withAvailabilityZones(String... availabilityZones)
A list of Availability Zones (AZs) where instances in the DB cluster can be created.
|
CreateDBClusterRequest |
withBacktrackWindow(Long backtrackWindow)
The target backtrack window, in seconds.
|
CreateDBClusterRequest |
withBackupRetentionPeriod(Integer backupRetentionPeriod)
The number of days for which automated backups are retained.
|
CreateDBClusterRequest |
withCharacterSetName(String characterSetName)
A value that indicates that the DB cluster should be associated with the specified CharacterSet.
|
CreateDBClusterRequest |
withCopyTagsToSnapshot(Boolean copyTagsToSnapshot)
A value that indicates whether to copy all tags from the DB cluster to snapshots of the DB cluster.
|
CreateDBClusterRequest |
withDatabaseName(String databaseName)
The name for your database of up to 64 alphanumeric characters.
|
CreateDBClusterRequest |
withDBClusterIdentifier(String dBClusterIdentifier)
The DB cluster identifier.
|
CreateDBClusterRequest |
withDBClusterParameterGroupName(String dBClusterParameterGroupName)
The name of the DB cluster parameter group to associate with this DB cluster.
|
CreateDBClusterRequest |
withDBSubnetGroupName(String dBSubnetGroupName)
A DB subnet group to associate with this DB cluster.
|
CreateDBClusterRequest |
withDeletionProtection(Boolean deletionProtection)
A value that indicates whether the DB cluster has deletion protection enabled.
|
CreateDBClusterRequest |
withDomain(String domain)
The Active Directory directory ID to create the DB cluster in.
|
CreateDBClusterRequest |
withDomainIAMRoleName(String domainIAMRoleName)
Specify the name of the IAM role to be used when making API calls to the Directory Service.
|
CreateDBClusterRequest |
withEnableCloudwatchLogsExports(Collection<String> enableCloudwatchLogsExports)
The list of log types that need to be enabled for exporting to CloudWatch Logs.
|
CreateDBClusterRequest |
withEnableCloudwatchLogsExports(String... enableCloudwatchLogsExports)
The list of log types that need to be enabled for exporting to CloudWatch Logs.
|
CreateDBClusterRequest |
withEnableGlobalWriteForwarding(Boolean enableGlobalWriteForwarding)
A value that indicates whether to enable write operations to be forwarded from this cluster to the primary
cluster in an Aurora global database.
|
CreateDBClusterRequest |
withEnableHttpEndpoint(Boolean enableHttpEndpoint)
A value that indicates whether to enable the HTTP endpoint for an Aurora Serverless DB cluster.
|
CreateDBClusterRequest |
withEnableIAMDatabaseAuthentication(Boolean enableIAMDatabaseAuthentication)
A value that indicates whether to enable mapping of AWS Identity and Access Management (IAM) accounts to database
accounts.
|
CreateDBClusterRequest |
withEngine(String engine)
The name of the database engine to be used for this DB cluster.
|
CreateDBClusterRequest |
withEngineMode(String engineMode)
The DB engine mode of the DB cluster, either
provisioned , serverless ,
parallelquery , global , or multimaster . |
CreateDBClusterRequest |
withEngineVersion(String engineVersion)
The version number of the database engine to use.
|
CreateDBClusterRequest |
withGlobalClusterIdentifier(String globalClusterIdentifier)
The global cluster ID of an Aurora cluster that becomes the primary cluster in the new global database cluster.
|
CreateDBClusterRequest |
withKmsKeyId(String kmsKeyId)
The AWS KMS key identifier for an encrypted DB cluster.
|
CreateDBClusterRequest |
withMasterUsername(String masterUsername)
The name of the master user for the DB cluster.
|
CreateDBClusterRequest |
withMasterUserPassword(String masterUserPassword)
The password for the master database user.
|
CreateDBClusterRequest |
withOptionGroupName(String optionGroupName)
A value that indicates that the DB cluster should be associated with the specified option group.
|
CreateDBClusterRequest |
withPort(Integer port)
The port number on which the instances in the DB cluster accept connections.
|
CreateDBClusterRequest |
withPreferredBackupWindow(String preferredBackupWindow)
The daily time range during which automated backups are created if automated backups are enabled using the
BackupRetentionPeriod parameter. |
CreateDBClusterRequest |
withPreferredMaintenanceWindow(String preferredMaintenanceWindow)
The weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).
|
CreateDBClusterRequest |
withPreSignedUrl(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 |
withReplicationSourceIdentifier(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 |
withScalingConfiguration(ScalingConfiguration scalingConfiguration)
For DB clusters in
serverless DB engine mode, the scaling properties of the DB cluster. |
CreateDBClusterRequest |
withSourceRegion(String sourceRegion)
The region where the source instance is located.
|
CreateDBClusterRequest |
withStorageEncrypted(Boolean storageEncrypted)
A value that indicates whether the DB cluster is encrypted.
|
CreateDBClusterRequest |
withTags(Collection<Tag> tags)
Tags to assign to the DB cluster.
|
CreateDBClusterRequest |
withTags(Tag... tags)
Tags to assign to the DB cluster.
|
CreateDBClusterRequest |
withVpcSecurityGroupIds(Collection<String> vpcSecurityGroupIds)
A list of EC2 VPC security groups to associate with this DB cluster.
|
CreateDBClusterRequest |
withVpcSecurityGroupIds(String... vpcSecurityGroupIds)
A list of EC2 VPC security groups to associate with this DB cluster.
|
addHandlerContext, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getHandlerContext, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestCredentialsProvider, withRequestMetricCollector, withSdkClientExecutionTimeout, withSdkRequestTimeout
public List<String> getAvailabilityZones()
A list of Availability Zones (AZs) where instances in the DB cluster can be created. For information on AWS Regions and Availability Zones, see Choosing the Regions and Availability Zones in the Amazon Aurora User Guide.
public void setAvailabilityZones(Collection<String> availabilityZones)
A list of Availability Zones (AZs) where instances in the DB cluster can be created. For information on AWS Regions and Availability Zones, see Choosing the Regions and Availability Zones in the Amazon Aurora User Guide.
availabilityZones
- A list of Availability Zones (AZs) where instances in the DB cluster can be created. For information on
AWS Regions and Availability Zones, see Choosing the Regions and Availability Zones in the Amazon Aurora User Guide.public CreateDBClusterRequest withAvailabilityZones(String... availabilityZones)
A list of Availability Zones (AZs) where instances in the DB cluster can be created. For information on AWS Regions and Availability Zones, see Choosing the Regions and Availability Zones in the Amazon Aurora User Guide.
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.
availabilityZones
- A list of Availability Zones (AZs) where instances in the DB cluster can be created. For information on
AWS Regions and Availability Zones, see Choosing the Regions and Availability Zones in the Amazon Aurora User Guide.public CreateDBClusterRequest withAvailabilityZones(Collection<String> availabilityZones)
A list of Availability Zones (AZs) where instances in the DB cluster can be created. For information on AWS Regions and Availability Zones, see Choosing the Regions and Availability Zones in the Amazon Aurora User Guide.
availabilityZones
- A list of Availability Zones (AZs) where instances in the DB cluster can be created. For information on
AWS Regions and Availability Zones, see Choosing the Regions and Availability Zones in the Amazon Aurora User Guide.public void setBackupRetentionPeriod(Integer backupRetentionPeriod)
The number of days for which automated backups are retained.
Default: 1
Constraints:
Must be a value from 1 to 35
backupRetentionPeriod
- The number of days for which automated backups are retained.
Default: 1
Constraints:
Must be a value from 1 to 35
public Integer getBackupRetentionPeriod()
The number of days for which automated backups are retained.
Default: 1
Constraints:
Must be a value from 1 to 35
Default: 1
Constraints:
Must be a value from 1 to 35
public CreateDBClusterRequest withBackupRetentionPeriod(Integer backupRetentionPeriod)
The number of days for which automated backups are retained.
Default: 1
Constraints:
Must be a value from 1 to 35
backupRetentionPeriod
- The number of days for which automated backups are retained.
Default: 1
Constraints:
Must be a value from 1 to 35
public void setCharacterSetName(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.public String getCharacterSetName()
A value that indicates that the DB cluster should be associated with the specified CharacterSet.
public CreateDBClusterRequest withCharacterSetName(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.public void setDatabaseName(String databaseName)
The name for your database of up to 64 alphanumeric characters. If you do not provide a name, Amazon RDS doesn't create a database in the DB cluster you are creating.
databaseName
- The name for your database of up to 64 alphanumeric characters. If you do not provide a name, Amazon RDS
doesn't create a database in the DB cluster you are creating.public String getDatabaseName()
The name for your database of up to 64 alphanumeric characters. If you do not provide a name, Amazon RDS doesn't create a database in the DB cluster you are creating.
public CreateDBClusterRequest withDatabaseName(String databaseName)
The name for your database of up to 64 alphanumeric characters. If you do not provide a name, Amazon RDS doesn't create a database in the DB cluster you are creating.
databaseName
- The name for your database of up to 64 alphanumeric characters. If you do not provide a name, Amazon RDS
doesn't create a database in the DB cluster you are creating.public void setDBClusterIdentifier(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.
Can't 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.
Can't end with a hyphen or contain two consecutive hyphens.
Example: my-cluster1
public String getDBClusterIdentifier()
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.
Can't end with a hyphen or contain two consecutive hyphens.
Example: my-cluster1
Constraints:
Must contain from 1 to 63 letters, numbers, or hyphens.
First character must be a letter.
Can't end with a hyphen or contain two consecutive hyphens.
Example: my-cluster1
public CreateDBClusterRequest withDBClusterIdentifier(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.
Can't 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.
Can't end with a hyphen or contain two consecutive hyphens.
Example: my-cluster1
public void setDBClusterParameterGroupName(String dBClusterParameterGroupName)
The name of the DB cluster parameter group to associate with this DB cluster. If you do not specify a value, then the default DB cluster parameter group for the specified DB engine and version is used.
Constraints:
If supplied, must match the name of an existing DB cluster parameter group.
dBClusterParameterGroupName
- The name of the DB cluster parameter group to associate with this DB cluster. If you do not specify a
value, then the default DB cluster parameter group for the specified DB engine and version is used.
Constraints:
If supplied, must match the name of an existing DB cluster parameter group.
public String getDBClusterParameterGroupName()
The name of the DB cluster parameter group to associate with this DB cluster. If you do not specify a value, then the default DB cluster parameter group for the specified DB engine and version is used.
Constraints:
If supplied, must match the name of an existing DB cluster parameter group.
Constraints:
If supplied, must match the name of an existing DB cluster parameter group.
public CreateDBClusterRequest withDBClusterParameterGroupName(String dBClusterParameterGroupName)
The name of the DB cluster parameter group to associate with this DB cluster. If you do not specify a value, then the default DB cluster parameter group for the specified DB engine and version is used.
Constraints:
If supplied, must match the name of an existing DB cluster parameter group.
dBClusterParameterGroupName
- The name of the DB cluster parameter group to associate with this DB cluster. If you do not specify a
value, then the default DB cluster parameter group for the specified DB engine and version is used.
Constraints:
If supplied, must match the name of an existing DB cluster parameter group.
public List<String> getVpcSecurityGroupIds()
A list of EC2 VPC security groups to associate with this DB cluster.
public void setVpcSecurityGroupIds(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.public CreateDBClusterRequest withVpcSecurityGroupIds(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.
vpcSecurityGroupIds
- A list of EC2 VPC security groups to associate with this DB cluster.public CreateDBClusterRequest withVpcSecurityGroupIds(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.public void setDBSubnetGroupName(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
public String getDBSubnetGroupName()
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
Constraints: Must match the name of an existing DBSubnetGroup. Must not be default.
Example: mySubnetgroup
public CreateDBClusterRequest withDBSubnetGroupName(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
public void setEngine(String engine)
The name of the database engine to be used for this DB cluster.
Valid Values: aurora
(for MySQL 5.6-compatible Aurora), aurora-mysql
(for MySQL
5.7-compatible Aurora), and aurora-postgresql
engine
- The name of the database engine to be used for this DB cluster.
Valid Values: aurora
(for MySQL 5.6-compatible Aurora), aurora-mysql
(for MySQL
5.7-compatible Aurora), and aurora-postgresql
public String getEngine()
The name of the database engine to be used for this DB cluster.
Valid Values: aurora
(for MySQL 5.6-compatible Aurora), aurora-mysql
(for MySQL
5.7-compatible Aurora), and aurora-postgresql
Valid Values: aurora
(for MySQL 5.6-compatible Aurora), aurora-mysql
(for MySQL
5.7-compatible Aurora), and aurora-postgresql
public CreateDBClusterRequest withEngine(String engine)
The name of the database engine to be used for this DB cluster.
Valid Values: aurora
(for MySQL 5.6-compatible Aurora), aurora-mysql
(for MySQL
5.7-compatible Aurora), and aurora-postgresql
engine
- The name of the database engine to be used for this DB cluster.
Valid Values: aurora
(for MySQL 5.6-compatible Aurora), aurora-mysql
(for MySQL
5.7-compatible Aurora), and aurora-postgresql
public void setEngineVersion(String engineVersion)
The version number of the database engine to use.
To list all of the available engine versions for aurora
(for MySQL 5.6-compatible Aurora), use the
following command:
aws rds describe-db-engine-versions --engine aurora --query "DBEngineVersions[].EngineVersion"
To list all of the available engine versions for aurora-mysql
(for MySQL 5.7-compatible Aurora), use
the following command:
aws rds describe-db-engine-versions --engine aurora-mysql --query "DBEngineVersions[].EngineVersion"
To list all of the available engine versions for aurora-postgresql
, use the following command:
aws rds describe-db-engine-versions --engine aurora-postgresql --query "DBEngineVersions[].EngineVersion"
Aurora MySQL
Example: 5.6.10a
, 5.6.mysql_aurora.1.19.2
, 5.7.12
,
5.7.mysql_aurora.2.04.5
Aurora PostgreSQL
Example: 9.6.3
, 10.7
engineVersion
- The version number of the database engine to use.
To list all of the available engine versions for aurora
(for MySQL 5.6-compatible Aurora),
use the following command:
aws rds describe-db-engine-versions --engine aurora --query "DBEngineVersions[].EngineVersion"
To list all of the available engine versions for aurora-mysql
(for MySQL 5.7-compatible
Aurora), use the following command:
aws rds describe-db-engine-versions --engine aurora-mysql --query "DBEngineVersions[].EngineVersion"
To list all of the available engine versions for aurora-postgresql
, use the following
command:
aws rds describe-db-engine-versions --engine aurora-postgresql --query "DBEngineVersions[].EngineVersion"
Aurora MySQL
Example: 5.6.10a
, 5.6.mysql_aurora.1.19.2
, 5.7.12
,
5.7.mysql_aurora.2.04.5
Aurora PostgreSQL
Example: 9.6.3
, 10.7
public String getEngineVersion()
The version number of the database engine to use.
To list all of the available engine versions for aurora
(for MySQL 5.6-compatible Aurora), use the
following command:
aws rds describe-db-engine-versions --engine aurora --query "DBEngineVersions[].EngineVersion"
To list all of the available engine versions for aurora-mysql
(for MySQL 5.7-compatible Aurora), use
the following command:
aws rds describe-db-engine-versions --engine aurora-mysql --query "DBEngineVersions[].EngineVersion"
To list all of the available engine versions for aurora-postgresql
, use the following command:
aws rds describe-db-engine-versions --engine aurora-postgresql --query "DBEngineVersions[].EngineVersion"
Aurora MySQL
Example: 5.6.10a
, 5.6.mysql_aurora.1.19.2
, 5.7.12
,
5.7.mysql_aurora.2.04.5
Aurora PostgreSQL
Example: 9.6.3
, 10.7
To list all of the available engine versions for aurora
(for MySQL 5.6-compatible Aurora),
use the following command:
aws rds describe-db-engine-versions --engine aurora --query "DBEngineVersions[].EngineVersion"
To list all of the available engine versions for aurora-mysql
(for MySQL 5.7-compatible
Aurora), use the following command:
aws rds describe-db-engine-versions --engine aurora-mysql --query "DBEngineVersions[].EngineVersion"
To list all of the available engine versions for aurora-postgresql
, use the following
command:
aws rds describe-db-engine-versions --engine aurora-postgresql --query "DBEngineVersions[].EngineVersion"
Aurora MySQL
Example: 5.6.10a
, 5.6.mysql_aurora.1.19.2
, 5.7.12
,
5.7.mysql_aurora.2.04.5
Aurora PostgreSQL
Example: 9.6.3
, 10.7
public CreateDBClusterRequest withEngineVersion(String engineVersion)
The version number of the database engine to use.
To list all of the available engine versions for aurora
(for MySQL 5.6-compatible Aurora), use the
following command:
aws rds describe-db-engine-versions --engine aurora --query "DBEngineVersions[].EngineVersion"
To list all of the available engine versions for aurora-mysql
(for MySQL 5.7-compatible Aurora), use
the following command:
aws rds describe-db-engine-versions --engine aurora-mysql --query "DBEngineVersions[].EngineVersion"
To list all of the available engine versions for aurora-postgresql
, use the following command:
aws rds describe-db-engine-versions --engine aurora-postgresql --query "DBEngineVersions[].EngineVersion"
Aurora MySQL
Example: 5.6.10a
, 5.6.mysql_aurora.1.19.2
, 5.7.12
,
5.7.mysql_aurora.2.04.5
Aurora PostgreSQL
Example: 9.6.3
, 10.7
engineVersion
- The version number of the database engine to use.
To list all of the available engine versions for aurora
(for MySQL 5.6-compatible Aurora),
use the following command:
aws rds describe-db-engine-versions --engine aurora --query "DBEngineVersions[].EngineVersion"
To list all of the available engine versions for aurora-mysql
(for MySQL 5.7-compatible
Aurora), use the following command:
aws rds describe-db-engine-versions --engine aurora-mysql --query "DBEngineVersions[].EngineVersion"
To list all of the available engine versions for aurora-postgresql
, use the following
command:
aws rds describe-db-engine-versions --engine aurora-postgresql --query "DBEngineVersions[].EngineVersion"
Aurora MySQL
Example: 5.6.10a
, 5.6.mysql_aurora.1.19.2
, 5.7.12
,
5.7.mysql_aurora.2.04.5
Aurora PostgreSQL
Example: 9.6.3
, 10.7
public void setPort(Integer port)
The port number on which the instances in the DB cluster accept connections.
Default: 3306
if engine is set as aurora or 5432
if set to aurora-postgresql.
port
- The port number on which the instances in the DB cluster accept connections.
Default: 3306
if engine is set as aurora or 5432
if set to aurora-postgresql.
public Integer getPort()
The port number on which the instances in the DB cluster accept connections.
Default: 3306
if engine is set as aurora or 5432
if set to aurora-postgresql.
Default: 3306
if engine is set as aurora or 5432
if set to aurora-postgresql.
public CreateDBClusterRequest withPort(Integer port)
The port number on which the instances in the DB cluster accept connections.
Default: 3306
if engine is set as aurora or 5432
if set to aurora-postgresql.
port
- The port number on which the instances in the DB cluster accept connections.
Default: 3306
if engine is set as aurora or 5432
if set to aurora-postgresql.
public void setMasterUsername(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.
Can't 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.
Can't be a reserved word for the chosen database engine.
public String getMasterUsername()
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.
Can't be a reserved word for the chosen database engine.
Constraints:
Must be 1 to 16 letters or numbers.
First character must be a letter.
Can't be a reserved word for the chosen database engine.
public CreateDBClusterRequest withMasterUsername(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.
Can't 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.
Can't be a reserved word for the chosen database engine.
public void setMasterUserPassword(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.
public String getMasterUserPassword()
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.
Constraints: Must contain from 8 to 41 characters.
public CreateDBClusterRequest withMasterUserPassword(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.
public void setOptionGroupName(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.
public String getOptionGroupName()
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.
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.
public CreateDBClusterRequest withOptionGroupName(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.
public void setPreferredBackupWindow(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 DB Cluster Maintenance Window in the Amazon Aurora 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 DB Cluster Maintenance Window in the Amazon Aurora 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.
public String getPreferredBackupWindow()
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 DB Cluster Maintenance Window in the Amazon Aurora 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.
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 DB Cluster Maintenance Window in the Amazon Aurora 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.
public CreateDBClusterRequest withPreferredBackupWindow(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 DB Cluster Maintenance Window in the Amazon Aurora 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 DB Cluster Maintenance Window in the Amazon Aurora 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.
public void setPreferredMaintenanceWindow(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 DB Cluster Maintenance Window in the Amazon Aurora 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 DB Cluster Maintenance Window in the Amazon Aurora User Guide.
Valid Days: Mon, Tue, Wed, Thu, Fri, Sat, Sun.
Constraints: Minimum 30-minute window.
public String getPreferredMaintenanceWindow()
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 DB Cluster Maintenance Window in the Amazon Aurora User Guide.
Valid Days: Mon, Tue, Wed, Thu, Fri, Sat, Sun.
Constraints: Minimum 30-minute window.
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 DB Cluster Maintenance Window in the Amazon Aurora User Guide.
Valid Days: Mon, Tue, Wed, Thu, Fri, Sat, Sun.
Constraints: Minimum 30-minute window.
public CreateDBClusterRequest withPreferredMaintenanceWindow(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 DB Cluster Maintenance Window in the Amazon Aurora 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 DB Cluster Maintenance Window in the Amazon Aurora User Guide.
Valid Days: Mon, Tue, Wed, Thu, Fri, Sat, Sun.
Constraints: Minimum 30-minute window.
public void setReplicationSourceIdentifier(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.public String getReplicationSourceIdentifier()
The Amazon Resource Name (ARN) of the source DB instance or DB cluster if this DB cluster is created as a read replica.
public CreateDBClusterRequest withReplicationSourceIdentifier(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.public List<Tag> getTags()
Tags to assign to the DB cluster.
public void setTags(Collection<Tag> tags)
Tags to assign to the DB cluster.
tags
- Tags to assign to the DB cluster.public CreateDBClusterRequest withTags(Tag... tags)
Tags to assign to the DB cluster.
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.
tags
- Tags to assign to the DB cluster.public CreateDBClusterRequest withTags(Collection<Tag> tags)
Tags to assign to the DB cluster.
tags
- Tags to assign to the DB cluster.public void setStorageEncrypted(Boolean storageEncrypted)
A value that indicates whether the DB cluster is encrypted.
storageEncrypted
- A value that indicates whether the DB cluster is encrypted.public Boolean getStorageEncrypted()
A value that indicates whether the DB cluster is encrypted.
public CreateDBClusterRequest withStorageEncrypted(Boolean storageEncrypted)
A value that indicates whether the DB cluster is encrypted.
storageEncrypted
- A value that indicates whether the DB cluster is encrypted.public Boolean isStorageEncrypted()
A value that indicates whether the DB cluster is encrypted.
public void setKmsKeyId(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 isn't 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 enabled and ReplicationSourceIdentifier
isn't
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 isn't 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 enabled and ReplicationSourceIdentifier
isn't 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.
public String getKmsKeyId()
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 isn't 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 enabled and ReplicationSourceIdentifier
isn't
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.
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 isn't 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 enabled and ReplicationSourceIdentifier
isn't 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.
public CreateDBClusterRequest withKmsKeyId(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 isn't 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 enabled and ReplicationSourceIdentifier
isn't
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 isn't 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 enabled and ReplicationSourceIdentifier
isn't 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.
public void setPreSignedUrl(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.
If you are using an AWS SDK tool or the AWS CLI, you can specify SourceRegion
(or
--source-region
for the AWS CLI) instead of specifying PreSignedUrl
manually.
Specifying SourceRegion
autogenerates a pre-signed URL that is a valid request for the operation
that can be executed in the source AWS Region.
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.
If you are using an AWS SDK tool or the AWS CLI, you can specify SourceRegion
(or
--source-region
for the AWS CLI) instead of specifying PreSignedUrl
manually.
Specifying SourceRegion
autogenerates a pre-signed URL that is a valid request for the
operation that can be executed in the source AWS Region.
public String getPreSignedUrl()
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.
If you are using an AWS SDK tool or the AWS CLI, you can specify SourceRegion
(or
--source-region
for the AWS CLI) instead of specifying PreSignedUrl
manually.
Specifying SourceRegion
autogenerates a pre-signed URL that is a valid request for the operation
that can be executed in the source AWS Region.
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.
If you are using an AWS SDK tool or the AWS CLI, you can specify SourceRegion
(or
--source-region
for the AWS CLI) instead of specifying PreSignedUrl
manually.
Specifying SourceRegion
autogenerates a pre-signed URL that is a valid request for the
operation that can be executed in the source AWS Region.
public CreateDBClusterRequest withPreSignedUrl(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.
If you are using an AWS SDK tool or the AWS CLI, you can specify SourceRegion
(or
--source-region
for the AWS CLI) instead of specifying PreSignedUrl
manually.
Specifying SourceRegion
autogenerates a pre-signed URL that is a valid request for the operation
that can be executed in the source AWS Region.
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.
If you are using an AWS SDK tool or the AWS CLI, you can specify SourceRegion
(or
--source-region
for the AWS CLI) instead of specifying PreSignedUrl
manually.
Specifying SourceRegion
autogenerates a pre-signed URL that is a valid request for the
operation that can be executed in the source AWS Region.
public void setEnableIAMDatabaseAuthentication(Boolean enableIAMDatabaseAuthentication)
A value that indicates whether to enable mapping of AWS Identity and Access Management (IAM) accounts to database accounts. By default, mapping is disabled.
For more information, see IAM Database Authentication in the Amazon Aurora User Guide.
enableIAMDatabaseAuthentication
- A value that indicates whether to enable mapping of AWS Identity and Access Management (IAM) accounts to
database accounts. By default, mapping is disabled.
For more information, see IAM Database Authentication in the Amazon Aurora User Guide.
public Boolean getEnableIAMDatabaseAuthentication()
A value that indicates whether to enable mapping of AWS Identity and Access Management (IAM) accounts to database accounts. By default, mapping is disabled.
For more information, see IAM Database Authentication in the Amazon Aurora User Guide.
For more information, see IAM Database Authentication in the Amazon Aurora User Guide.
public CreateDBClusterRequest withEnableIAMDatabaseAuthentication(Boolean enableIAMDatabaseAuthentication)
A value that indicates whether to enable mapping of AWS Identity and Access Management (IAM) accounts to database accounts. By default, mapping is disabled.
For more information, see IAM Database Authentication in the Amazon Aurora User Guide.
enableIAMDatabaseAuthentication
- A value that indicates whether to enable mapping of AWS Identity and Access Management (IAM) accounts to
database accounts. By default, mapping is disabled.
For more information, see IAM Database Authentication in the Amazon Aurora User Guide.
public Boolean isEnableIAMDatabaseAuthentication()
A value that indicates whether to enable mapping of AWS Identity and Access Management (IAM) accounts to database accounts. By default, mapping is disabled.
For more information, see IAM Database Authentication in the Amazon Aurora User Guide.
For more information, see IAM Database Authentication in the Amazon Aurora User Guide.
public void setBacktrackWindow(Long backtrackWindow)
The target backtrack window, in seconds. To disable backtracking, set this value to 0.
Currently, Backtrack is only supported for Aurora MySQL DB clusters.
Default: 0
Constraints:
If specified, this value must be set to a number from 0 to 259,200 (72 hours).
backtrackWindow
- The target backtrack window, in seconds. To disable backtracking, set this value to 0. Currently, Backtrack is only supported for Aurora MySQL DB clusters.
Default: 0
Constraints:
If specified, this value must be set to a number from 0 to 259,200 (72 hours).
public Long getBacktrackWindow()
The target backtrack window, in seconds. To disable backtracking, set this value to 0.
Currently, Backtrack is only supported for Aurora MySQL DB clusters.
Default: 0
Constraints:
If specified, this value must be set to a number from 0 to 259,200 (72 hours).
Currently, Backtrack is only supported for Aurora MySQL DB clusters.
Default: 0
Constraints:
If specified, this value must be set to a number from 0 to 259,200 (72 hours).
public CreateDBClusterRequest withBacktrackWindow(Long backtrackWindow)
The target backtrack window, in seconds. To disable backtracking, set this value to 0.
Currently, Backtrack is only supported for Aurora MySQL DB clusters.
Default: 0
Constraints:
If specified, this value must be set to a number from 0 to 259,200 (72 hours).
backtrackWindow
- The target backtrack window, in seconds. To disable backtracking, set this value to 0. Currently, Backtrack is only supported for Aurora MySQL DB clusters.
Default: 0
Constraints:
If specified, this value must be set to a number from 0 to 259,200 (72 hours).
public List<String> getEnableCloudwatchLogsExports()
The list of log types that need to be enabled for exporting to CloudWatch Logs. The values in the list depend on the DB engine being used. For more information, see Publishing Database Logs to Amazon CloudWatch Logs in the Amazon Aurora User Guide.
public void setEnableCloudwatchLogsExports(Collection<String> enableCloudwatchLogsExports)
The list of log types that need to be enabled for exporting to CloudWatch Logs. The values in the list depend on the DB engine being used. For more information, see Publishing Database Logs to Amazon CloudWatch Logs in the Amazon Aurora User Guide.
enableCloudwatchLogsExports
- The list of log types that need to be enabled for exporting to CloudWatch Logs. The values in the list
depend on the DB engine being used. For more information, see Publishing Database Logs to Amazon CloudWatch Logs in the Amazon Aurora User Guide.public CreateDBClusterRequest withEnableCloudwatchLogsExports(String... enableCloudwatchLogsExports)
The list of log types that need to be enabled for exporting to CloudWatch Logs. The values in the list depend on the DB engine being used. For more information, see Publishing Database Logs to Amazon CloudWatch Logs in the Amazon Aurora User Guide.
NOTE: This method appends the values to the existing list (if any). Use
setEnableCloudwatchLogsExports(java.util.Collection)
or
withEnableCloudwatchLogsExports(java.util.Collection)
if you want to override the existing values.
enableCloudwatchLogsExports
- The list of log types that need to be enabled for exporting to CloudWatch Logs. The values in the list
depend on the DB engine being used. For more information, see Publishing Database Logs to Amazon CloudWatch Logs in the Amazon Aurora User Guide.public CreateDBClusterRequest withEnableCloudwatchLogsExports(Collection<String> enableCloudwatchLogsExports)
The list of log types that need to be enabled for exporting to CloudWatch Logs. The values in the list depend on the DB engine being used. For more information, see Publishing Database Logs to Amazon CloudWatch Logs in the Amazon Aurora User Guide.
enableCloudwatchLogsExports
- The list of log types that need to be enabled for exporting to CloudWatch Logs. The values in the list
depend on the DB engine being used. For more information, see Publishing Database Logs to Amazon CloudWatch Logs in the Amazon Aurora User Guide.public void setEngineMode(String engineMode)
The DB engine mode of the DB cluster, either provisioned
, serverless
,
parallelquery
, global
, or multimaster
.
global
engine mode only applies for global database clusters created with Aurora MySQL version
5.6.10a. For higher Aurora MySQL versions, the clusters in a global database use provisioned
engine
mode.
Limitations and requirements apply to some DB engine modes. For more information, see the following sections in the Amazon Aurora User Guide:
engineMode
- The DB engine mode of the DB cluster, either provisioned
, serverless
,
parallelquery
, global
, or multimaster
.
global
engine mode only applies for global database clusters created with Aurora MySQL
version 5.6.10a. For higher Aurora MySQL versions, the clusters in a global database use
provisioned
engine mode.
Limitations and requirements apply to some DB engine modes. For more information, see the following sections in the Amazon Aurora User Guide:
public String getEngineMode()
The DB engine mode of the DB cluster, either provisioned
, serverless
,
parallelquery
, global
, or multimaster
.
global
engine mode only applies for global database clusters created with Aurora MySQL version
5.6.10a. For higher Aurora MySQL versions, the clusters in a global database use provisioned
engine
mode.
Limitations and requirements apply to some DB engine modes. For more information, see the following sections in the Amazon Aurora User Guide:
provisioned
, serverless
,
parallelquery
, global
, or multimaster
.
global
engine mode only applies for global database clusters created with Aurora MySQL
version 5.6.10a. For higher Aurora MySQL versions, the clusters in a global database use
provisioned
engine mode.
Limitations and requirements apply to some DB engine modes. For more information, see the following sections in the Amazon Aurora User Guide:
public CreateDBClusterRequest withEngineMode(String engineMode)
The DB engine mode of the DB cluster, either provisioned
, serverless
,
parallelquery
, global
, or multimaster
.
global
engine mode only applies for global database clusters created with Aurora MySQL version
5.6.10a. For higher Aurora MySQL versions, the clusters in a global database use provisioned
engine
mode.
Limitations and requirements apply to some DB engine modes. For more information, see the following sections in the Amazon Aurora User Guide:
engineMode
- The DB engine mode of the DB cluster, either provisioned
, serverless
,
parallelquery
, global
, or multimaster
.
global
engine mode only applies for global database clusters created with Aurora MySQL
version 5.6.10a. For higher Aurora MySQL versions, the clusters in a global database use
provisioned
engine mode.
Limitations and requirements apply to some DB engine modes. For more information, see the following sections in the Amazon Aurora User Guide:
public void setScalingConfiguration(ScalingConfiguration scalingConfiguration)
For DB clusters in serverless
DB engine mode, the scaling properties of the DB cluster.
scalingConfiguration
- For DB clusters in serverless
DB engine mode, the scaling properties of the DB cluster.public ScalingConfiguration getScalingConfiguration()
For DB clusters in serverless
DB engine mode, the scaling properties of the DB cluster.
serverless
DB engine mode, the scaling properties of the DB cluster.public CreateDBClusterRequest withScalingConfiguration(ScalingConfiguration scalingConfiguration)
For DB clusters in serverless
DB engine mode, the scaling properties of the DB cluster.
scalingConfiguration
- For DB clusters in serverless
DB engine mode, the scaling properties of the DB cluster.public void setDeletionProtection(Boolean deletionProtection)
A value that indicates whether the DB cluster has deletion protection enabled. The database can't be deleted when deletion protection is enabled. By default, deletion protection is disabled.
deletionProtection
- A value that indicates whether the DB cluster has deletion protection enabled. The database can't be
deleted when deletion protection is enabled. By default, deletion protection is disabled.public Boolean getDeletionProtection()
A value that indicates whether the DB cluster has deletion protection enabled. The database can't be deleted when deletion protection is enabled. By default, deletion protection is disabled.
public CreateDBClusterRequest withDeletionProtection(Boolean deletionProtection)
A value that indicates whether the DB cluster has deletion protection enabled. The database can't be deleted when deletion protection is enabled. By default, deletion protection is disabled.
deletionProtection
- A value that indicates whether the DB cluster has deletion protection enabled. The database can't be
deleted when deletion protection is enabled. By default, deletion protection is disabled.public Boolean isDeletionProtection()
A value that indicates whether the DB cluster has deletion protection enabled. The database can't be deleted when deletion protection is enabled. By default, deletion protection is disabled.
public void setGlobalClusterIdentifier(String globalClusterIdentifier)
The global cluster ID of an Aurora cluster that becomes the primary cluster in the new global database cluster.
globalClusterIdentifier
- The global cluster ID of an Aurora cluster that becomes the primary cluster in the new global database
cluster.public String getGlobalClusterIdentifier()
The global cluster ID of an Aurora cluster that becomes the primary cluster in the new global database cluster.
public CreateDBClusterRequest withGlobalClusterIdentifier(String globalClusterIdentifier)
The global cluster ID of an Aurora cluster that becomes the primary cluster in the new global database cluster.
globalClusterIdentifier
- The global cluster ID of an Aurora cluster that becomes the primary cluster in the new global database
cluster.public void setEnableHttpEndpoint(Boolean enableHttpEndpoint)
A value that indicates whether to enable the HTTP endpoint for an Aurora Serverless DB cluster. By default, the HTTP endpoint is disabled.
When enabled, the HTTP endpoint provides a connectionless web service API for running SQL queries on the Aurora Serverless DB cluster. You can also query your database from inside the RDS console with the query editor.
For more information, see Using the Data API for Aurora Serverless in the Amazon Aurora User Guide.
enableHttpEndpoint
- A value that indicates whether to enable the HTTP endpoint for an Aurora Serverless DB cluster. By
default, the HTTP endpoint is disabled.
When enabled, the HTTP endpoint provides a connectionless web service API for running SQL queries on the Aurora Serverless DB cluster. You can also query your database from inside the RDS console with the query editor.
For more information, see Using the Data API for Aurora Serverless in the Amazon Aurora User Guide.
public Boolean getEnableHttpEndpoint()
A value that indicates whether to enable the HTTP endpoint for an Aurora Serverless DB cluster. By default, the HTTP endpoint is disabled.
When enabled, the HTTP endpoint provides a connectionless web service API for running SQL queries on the Aurora Serverless DB cluster. You can also query your database from inside the RDS console with the query editor.
For more information, see Using the Data API for Aurora Serverless in the Amazon Aurora User Guide.
When enabled, the HTTP endpoint provides a connectionless web service API for running SQL queries on the Aurora Serverless DB cluster. You can also query your database from inside the RDS console with the query editor.
For more information, see Using the Data API for Aurora Serverless in the Amazon Aurora User Guide.
public CreateDBClusterRequest withEnableHttpEndpoint(Boolean enableHttpEndpoint)
A value that indicates whether to enable the HTTP endpoint for an Aurora Serverless DB cluster. By default, the HTTP endpoint is disabled.
When enabled, the HTTP endpoint provides a connectionless web service API for running SQL queries on the Aurora Serverless DB cluster. You can also query your database from inside the RDS console with the query editor.
For more information, see Using the Data API for Aurora Serverless in the Amazon Aurora User Guide.
enableHttpEndpoint
- A value that indicates whether to enable the HTTP endpoint for an Aurora Serverless DB cluster. By
default, the HTTP endpoint is disabled.
When enabled, the HTTP endpoint provides a connectionless web service API for running SQL queries on the Aurora Serverless DB cluster. You can also query your database from inside the RDS console with the query editor.
For more information, see Using the Data API for Aurora Serverless in the Amazon Aurora User Guide.
public Boolean isEnableHttpEndpoint()
A value that indicates whether to enable the HTTP endpoint for an Aurora Serverless DB cluster. By default, the HTTP endpoint is disabled.
When enabled, the HTTP endpoint provides a connectionless web service API for running SQL queries on the Aurora Serverless DB cluster. You can also query your database from inside the RDS console with the query editor.
For more information, see Using the Data API for Aurora Serverless in the Amazon Aurora User Guide.
When enabled, the HTTP endpoint provides a connectionless web service API for running SQL queries on the Aurora Serverless DB cluster. You can also query your database from inside the RDS console with the query editor.
For more information, see Using the Data API for Aurora Serverless in the Amazon Aurora User Guide.
public void setCopyTagsToSnapshot(Boolean copyTagsToSnapshot)
A value that indicates whether to copy all tags from the DB cluster to snapshots of the DB cluster. The default is not to copy them.
copyTagsToSnapshot
- A value that indicates whether to copy all tags from the DB cluster to snapshots of the DB cluster. The
default is not to copy them.public Boolean getCopyTagsToSnapshot()
A value that indicates whether to copy all tags from the DB cluster to snapshots of the DB cluster. The default is not to copy them.
public CreateDBClusterRequest withCopyTagsToSnapshot(Boolean copyTagsToSnapshot)
A value that indicates whether to copy all tags from the DB cluster to snapshots of the DB cluster. The default is not to copy them.
copyTagsToSnapshot
- A value that indicates whether to copy all tags from the DB cluster to snapshots of the DB cluster. The
default is not to copy them.public Boolean isCopyTagsToSnapshot()
A value that indicates whether to copy all tags from the DB cluster to snapshots of the DB cluster. The default is not to copy them.
public void setDomain(String domain)
The Active Directory directory ID to create the DB cluster in.
For Amazon Aurora DB clusters, Amazon RDS can use Kerberos Authentication to authenticate users that connect to the DB cluster. For more information, see Kerberos Authentication in the Amazon Aurora User Guide.
domain
- The Active Directory directory ID to create the DB cluster in.
For Amazon Aurora DB clusters, Amazon RDS can use Kerberos Authentication to authenticate users that connect to the DB cluster. For more information, see Kerberos Authentication in the Amazon Aurora User Guide.
public String getDomain()
The Active Directory directory ID to create the DB cluster in.
For Amazon Aurora DB clusters, Amazon RDS can use Kerberos Authentication to authenticate users that connect to the DB cluster. For more information, see Kerberos Authentication in the Amazon Aurora User Guide.
For Amazon Aurora DB clusters, Amazon RDS can use Kerberos Authentication to authenticate users that connect to the DB cluster. For more information, see Kerberos Authentication in the Amazon Aurora User Guide.
public CreateDBClusterRequest withDomain(String domain)
The Active Directory directory ID to create the DB cluster in.
For Amazon Aurora DB clusters, Amazon RDS can use Kerberos Authentication to authenticate users that connect to the DB cluster. For more information, see Kerberos Authentication in the Amazon Aurora User Guide.
domain
- The Active Directory directory ID to create the DB cluster in.
For Amazon Aurora DB clusters, Amazon RDS can use Kerberos Authentication to authenticate users that connect to the DB cluster. For more information, see Kerberos Authentication in the Amazon Aurora User Guide.
public void setDomainIAMRoleName(String domainIAMRoleName)
Specify the name of the IAM role to be used when making API calls to the Directory Service.
domainIAMRoleName
- Specify the name of the IAM role to be used when making API calls to the Directory Service.public String getDomainIAMRoleName()
Specify the name of the IAM role to be used when making API calls to the Directory Service.
public CreateDBClusterRequest withDomainIAMRoleName(String domainIAMRoleName)
Specify the name of the IAM role to be used when making API calls to the Directory Service.
domainIAMRoleName
- Specify the name of the IAM role to be used when making API calls to the Directory Service.public void setEnableGlobalWriteForwarding(Boolean enableGlobalWriteForwarding)
A value that indicates whether to enable write operations to be forwarded from this cluster to the primary cluster in an Aurora global database. The resulting changes are replicated back to this cluster. This parameter only applies to DB clusters that are secondary clusters in an Aurora global database. By default, Aurora disallows write operations for secondary clusters.
enableGlobalWriteForwarding
- A value that indicates whether to enable write operations to be forwarded from this cluster to the primary
cluster in an Aurora global database. The resulting changes are replicated back to this cluster. This
parameter only applies to DB clusters that are secondary clusters in an Aurora global database. By
default, Aurora disallows write operations for secondary clusters.public Boolean getEnableGlobalWriteForwarding()
A value that indicates whether to enable write operations to be forwarded from this cluster to the primary cluster in an Aurora global database. The resulting changes are replicated back to this cluster. This parameter only applies to DB clusters that are secondary clusters in an Aurora global database. By default, Aurora disallows write operations for secondary clusters.
public CreateDBClusterRequest withEnableGlobalWriteForwarding(Boolean enableGlobalWriteForwarding)
A value that indicates whether to enable write operations to be forwarded from this cluster to the primary cluster in an Aurora global database. The resulting changes are replicated back to this cluster. This parameter only applies to DB clusters that are secondary clusters in an Aurora global database. By default, Aurora disallows write operations for secondary clusters.
enableGlobalWriteForwarding
- A value that indicates whether to enable write operations to be forwarded from this cluster to the primary
cluster in an Aurora global database. The resulting changes are replicated back to this cluster. This
parameter only applies to DB clusters that are secondary clusters in an Aurora global database. By
default, Aurora disallows write operations for secondary clusters.public Boolean isEnableGlobalWriteForwarding()
A value that indicates whether to enable write operations to be forwarded from this cluster to the primary cluster in an Aurora global database. The resulting changes are replicated back to this cluster. This parameter only applies to DB clusters that are secondary clusters in an Aurora global database. By default, Aurora disallows write operations for secondary clusters.
public void setSourceRegion(String sourceRegion)
sourceRegion
- The region where the source instance is located.public String getSourceRegion()
public CreateDBClusterRequest withSourceRegion(String sourceRegion)
sourceRegion
- The region where the source instance is located.public String toString()
toString
in class Object
Object.toString()
public CreateDBClusterRequest clone()
AmazonWebServiceRequest
clone
in class AmazonWebServiceRequest
Object.clone()