@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 EC2 Availability Zones that instances in the DB cluster can be created in.
|
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.
|
String |
getDatabaseName()
The name for your database of up to 64 alpha-numeric 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 |
getEnableIAMDatabaseAuthentication()
A Boolean value that is true to enable mapping of AWS Identity and Access Management (IAM) accounts to database
accounts, and otherwise false.
|
String |
getEngine()
The name of the database engine to be used for this DB cluster.
|
String |
getEngineVersion()
The version number of the database engine to use.
|
String |
getKmsKeyId()
The 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.
|
String |
getSourceRegion()
The region where the source instance is located.
|
Boolean |
getStorageEncrypted()
Specifies whether the DB cluster is encrypted.
|
List<Tag> |
getTags() |
List<String> |
getVpcSecurityGroupIds()
A list of EC2 VPC security groups to associate with this DB cluster.
|
int |
hashCode() |
Boolean |
isEnableIAMDatabaseAuthentication()
A Boolean value that is true to enable mapping of AWS Identity and Access Management (IAM) accounts to database
accounts, and otherwise false.
|
Boolean |
isStorageEncrypted()
Specifies whether the DB cluster is encrypted.
|
void |
setAvailabilityZones(Collection<String> availabilityZones)
A list of EC2 Availability Zones that instances in the DB cluster can be created in.
|
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 |
setDatabaseName(String databaseName)
The name for your database of up to 64 alpha-numeric 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 |
setEnableIAMDatabaseAuthentication(Boolean enableIAMDatabaseAuthentication)
A Boolean value that is true to enable mapping of AWS Identity and Access Management (IAM) accounts to database
accounts, and otherwise false.
|
void |
setEngine(String engine)
The name of the database engine to be used for this DB cluster.
|
void |
setEngineVersion(String engineVersion)
The version number of the database engine to use.
|
void |
setKmsKeyId(String kmsKeyId)
The 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 |
setSourceRegion(String sourceRegion)
The region where the source instance is located.
|
void |
setStorageEncrypted(Boolean storageEncrypted)
Specifies whether the DB cluster is encrypted.
|
void |
setTags(Collection<Tag> tags) |
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; useful for testing and debugging.
|
CreateDBClusterRequest |
withAvailabilityZones(Collection<String> availabilityZones)
A list of EC2 Availability Zones that instances in the DB cluster can be created in.
|
CreateDBClusterRequest |
withAvailabilityZones(String... availabilityZones)
A list of EC2 Availability Zones that instances in the DB cluster can be created in.
|
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 |
withDatabaseName(String databaseName)
The name for your database of up to 64 alpha-numeric 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 |
withEnableIAMDatabaseAuthentication(Boolean enableIAMDatabaseAuthentication)
A Boolean value that is true to enable mapping of AWS Identity and Access Management (IAM) accounts to database
accounts, and otherwise false.
|
CreateDBClusterRequest |
withEngine(String engine)
The name of the database engine to be used for this DB cluster.
|
CreateDBClusterRequest |
withEngineVersion(String engineVersion)
The version number of the database engine to use.
|
CreateDBClusterRequest |
withKmsKeyId(String kmsKeyId)
The 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 |
withSourceRegion(String sourceRegion)
The region where the source instance is located.
|
CreateDBClusterRequest |
withStorageEncrypted(Boolean storageEncrypted)
Specifies whether the DB cluster is encrypted.
|
CreateDBClusterRequest |
withTags(Collection<Tag> tags) |
CreateDBClusterRequest |
withTags(Tag... tags)
NOTE: This method appends the values to the existing list (if any).
|
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 EC2 Availability Zones that instances in the DB cluster can be created in. For information on regions and Availability Zones, see Regions and Availability Zones.
public void setAvailabilityZones(Collection<String> availabilityZones)
A list of EC2 Availability Zones that instances in the DB cluster can be created in. For information on regions and Availability Zones, see Regions and Availability Zones.
availabilityZones
- A list of EC2 Availability Zones that instances in the DB cluster can be created in. For information on
regions and Availability Zones, see Regions and Availability Zones.public CreateDBClusterRequest withAvailabilityZones(String... availabilityZones)
A list of EC2 Availability Zones that instances in the DB cluster can be created in. For information on regions and Availability Zones, see Regions and Availability Zones.
NOTE: This method appends the values to the existing list (if any). Use
setAvailabilityZones(java.util.Collection)
or withAvailabilityZones(java.util.Collection)
if
you want to override the existing values.
availabilityZones
- A list of EC2 Availability Zones that instances in the DB cluster can be created in. For information on
regions and Availability Zones, see Regions and Availability Zones.public CreateDBClusterRequest withAvailabilityZones(Collection<String> availabilityZones)
A list of EC2 Availability Zones that instances in the DB cluster can be created in. For information on regions and Availability Zones, see Regions and Availability Zones.
availabilityZones
- A list of EC2 Availability Zones that instances in the DB cluster can be created in. For information on
regions and Availability Zones, see Regions and Availability Zones.public void setBackupRetentionPeriod(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
public Integer getBackupRetentionPeriod()
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
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. 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
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 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.public String getDatabaseName()
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.
public CreateDBClusterRequest withDatabaseName(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.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.
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
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.
Cannot 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.
Cannot 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.
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
public void setDBClusterParameterGroupName(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.
public String getDBClusterParameterGroupName()
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.
default.aurora5.6
is used.
Constraints:
If supplied, must match the name of an existing DBClusterParameterGroup.
public CreateDBClusterRequest withDBClusterParameterGroupName(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.
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
engine
- The name of the database engine to be used for this DB cluster.
Valid Values: aurora
public String getEngine()
The name of the database engine to be used for this DB cluster.
Valid Values: aurora
Valid Values: aurora
public CreateDBClusterRequest withEngine(String engine)
The name of the database engine to be used for this DB cluster.
Valid Values: aurora
engine
- The name of the database engine to be used for this DB cluster.
Valid Values: aurora
public void setEngineVersion(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
public String getEngineVersion()
The version number of the database engine to use.
Aurora
Example: 5.6.10a
Aurora
Example: 5.6.10a
public CreateDBClusterRequest withEngineVersion(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
public void setPort(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
public Integer getPort()
The port number on which the instances in the DB cluster accept connections.
Default: 3306
Default: 3306
public CreateDBClusterRequest withPort(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
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.
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.
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.
Cannot be a reserved word for the chosen database engine.
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.
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.
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.
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 cannot be removed from an option group. The option group cannot be removed from a DB cluster once it is associated with a DB cluster.
optionGroupName
- A value that indicates that the DB cluster should be associated with the specified option group.
Permanent options cannot be removed from an option group. The option group cannot be removed from a DB cluster once it is associated with a DB cluster.
public String getOptionGroupName()
A value that indicates that the DB cluster should be associated with the specified option group.
Permanent options cannot be removed from an option group. The option group cannot be removed from a DB cluster once it is associated with a DB cluster.
Permanent options cannot be removed from an option group. The option group cannot be removed from a DB cluster once it is associated with a DB cluster.
public CreateDBClusterRequest withOptionGroupName(String optionGroupName)
A value that indicates that the DB cluster should be associated with the specified option group.
Permanent options cannot be removed from an option group. The option group cannot be removed from a DB cluster once it is associated with a DB cluster.
optionGroupName
- A value that indicates that the DB cluster should be associated with the specified option group.
Permanent options cannot be removed from an option group. The option group cannot be removed from a DB cluster once it is associated with a DB cluster.
public void setPreferredBackupWindow(String preferredBackupWindow)
The daily time range during which automated backups are created if automated backups are enabled using the
BackupRetentionPeriod
parameter.
Default: A 30-minute window selected at random from an 8-hour block of time per 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
.
Times should 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.
Default: A 30-minute window selected at random from an 8-hour block of time per 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
.
Times should 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.
Default: A 30-minute window selected at random from an 8-hour block of time per 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
.
Times should be in Universal Coordinated Time (UTC).
Must not conflict with the preferred maintenance window.
Must be at least 30 minutes.
BackupRetentionPeriod
parameter.
Default: A 30-minute window selected at random from an 8-hour block of time per 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
.
Times should 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.
Default: A 30-minute window selected at random from an 8-hour block of time per 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
.
Times should 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.
Default: A 30-minute window selected at random from an 8-hour block of time per 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
.
Times should 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
Default: A 30-minute window selected at random from an 8-hour block of time per 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
Default: A 30-minute window selected at random from an 8-hour block of time per 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.
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
Default: A 30-minute window selected at random from an 8-hour block of time per 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.
Format: ddd:hh24:mi-ddd:hh24:mi
Default: A 30-minute window selected at random from an 8-hour block of time per 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.
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
Default: A 30-minute window selected at random from an 8-hour block of time per 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
Default: A 30-minute window selected at random from an 8-hour block of time per 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.
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 void setTags(Collection<Tag> tags)
tags
- public CreateDBClusterRequest withTags(Tag... tags)
NOTE: This method appends the values to the existing list (if any). Use
setTags(java.util.Collection)
or withTags(java.util.Collection)
if you want to override the
existing values.
tags
- public CreateDBClusterRequest withTags(Collection<Tag> tags)
tags
- public void setStorageEncrypted(Boolean storageEncrypted)
Specifies whether the DB cluster is encrypted.
storageEncrypted
- Specifies whether the DB cluster is encrypted.public Boolean getStorageEncrypted()
Specifies whether the DB cluster is encrypted.
public CreateDBClusterRequest withStorageEncrypted(Boolean storageEncrypted)
Specifies whether the DB cluster is encrypted.
storageEncrypted
- Specifies whether the DB cluster is encrypted.public Boolean isStorageEncrypted()
Specifies whether the DB cluster is encrypted.
public void setKmsKeyId(String kmsKeyId)
The KMS key identifier for an encrypted DB cluster.
The KMS key identifier is the Amazon Resource Name (ARN) for the KMS encryption key. If you are creating a DB cluster with the same AWS account that owns the KMS encryption key used to encrypt the new DB cluster, then you can use the KMS key alias instead of the ARN for the KMS encryption key.
If 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 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.
public String getKmsKeyId()
The KMS key identifier for an encrypted DB cluster.
The KMS key identifier is the Amazon Resource Name (ARN) for the KMS encryption key. If you are creating a DB cluster with the same AWS account that owns the KMS encryption key used to encrypt the new DB cluster, then you can use the KMS key alias instead of the ARN for the KMS encryption key.
If 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.
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.
public CreateDBClusterRequest withKmsKeyId(String kmsKeyId)
The KMS key identifier for an encrypted DB cluster.
The KMS key identifier is the Amazon Resource Name (ARN) for the KMS encryption key. If you are creating a DB cluster with the same AWS account that owns the KMS encryption key used to encrypt the new DB cluster, then you can use the KMS key alias instead of the ARN for the KMS encryption key.
If 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 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.
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 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 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 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 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.
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 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 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.
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 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 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.
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 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 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 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 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.
public void setEnableIAMDatabaseAuthentication(Boolean enableIAMDatabaseAuthentication)
A Boolean value that is true to enable mapping of AWS Identity and Access Management (IAM) accounts to database accounts, and otherwise false.
Default: false
enableIAMDatabaseAuthentication
- A Boolean value that is true to enable mapping of AWS Identity and Access Management (IAM) accounts to
database accounts, and otherwise false.
Default: false
public Boolean getEnableIAMDatabaseAuthentication()
A Boolean value that is true to enable mapping of AWS Identity and Access Management (IAM) accounts to database accounts, and otherwise false.
Default: false
Default: false
public CreateDBClusterRequest withEnableIAMDatabaseAuthentication(Boolean enableIAMDatabaseAuthentication)
A Boolean value that is true to enable mapping of AWS Identity and Access Management (IAM) accounts to database accounts, and otherwise false.
Default: false
enableIAMDatabaseAuthentication
- A Boolean value that is true to enable mapping of AWS Identity and Access Management (IAM) accounts to
database accounts, and otherwise false.
Default: false
public Boolean isEnableIAMDatabaseAuthentication()
A Boolean value that is true to enable mapping of AWS Identity and Access Management (IAM) accounts to database accounts, and otherwise false.
Default: false
Default: false
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()
Copyright © 2013 Amazon Web Services, Inc. All Rights Reserved.