public class CreateDBClusterRequest extends AmazonWebServiceRequest implements Serializable, Cloneable
CreateDBCluster operation
.
Creates a new Amazon Aurora DB cluster. For more information on Amazon Aurora, see Aurora on Amazon RDS in the Amazon RDS User Guide.
NOOP
Constructor and Description |
---|
CreateDBClusterRequest() |
Modifier and Type | Method and Description |
---|---|
CreateDBClusterRequest |
clone()
Creates a shallow clone of this request.
|
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 8 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.
|
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 |
getMasterUsername()
The name of the master user for the client 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).
|
List<Tag> |
getTags()
A list of tags.
|
List<String> |
getVpcSecurityGroupIds()
A list of EC2 VPC security groups to associate with this DB cluster.
|
int |
hashCode() |
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 8 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 |
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 |
setMasterUsername(String masterUsername)
The name of the master user for the client 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 |
setTags(Collection<Tag> tags)
A list of 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 8 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 |
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 |
withMasterUsername(String masterUsername)
The name of the master user for the client 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 |
withTags(Collection<Tag> tags)
A list of tags.
|
CreateDBClusterRequest |
withTags(Tag... tags)
A list of tags.
|
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.
|
copyBaseTo, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestMetricCollector, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestMetricCollector, withGeneralProgressListener, withRequestMetricCollector
public List<String> getAvailabilityZones()
public void setAvailabilityZones(Collection<String> availabilityZones)
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)
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.
Returns a reference to this object so that method calls can be chained together.
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)
Returns a reference to this object so that method calls can be chained together.
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 Integer getBackupRetentionPeriod()
Default: 1
Constraints:
Default: 1
Constraints:
public void setBackupRetentionPeriod(Integer backupRetentionPeriod)
Default: 1
Constraints:
backupRetentionPeriod
- The number of days for which automated backups are retained. Setting
this parameter to a positive number enables backups. Setting this
parameter to 0 disables automated backups. Default: 1
Constraints:
public CreateDBClusterRequest withBackupRetentionPeriod(Integer backupRetentionPeriod)
Default: 1
Constraints:
Returns a reference to this object so that method calls can be chained together.
backupRetentionPeriod
- The number of days for which automated backups are retained. Setting
this parameter to a positive number enables backups. Setting this
parameter to 0 disables automated backups. Default: 1
Constraints:
public String getCharacterSetName()
public void setCharacterSetName(String characterSetName)
characterSetName
- A value that indicates that the DB cluster should be associated with
the specified CharacterSet.public CreateDBClusterRequest withCharacterSetName(String characterSetName)
Returns a reference to this object so that method calls can be chained together.
characterSetName
- A value that indicates that the DB cluster should be associated with
the specified CharacterSet.public String getDatabaseName()
public void setDatabaseName(String databaseName)
databaseName
- The name for your database of up to 8 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)
Returns a reference to this object so that method calls can be chained together.
databaseName
- The name for your database of up to 8 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 getDBClusterIdentifier()
Constraints:
Example: my-cluster1
Constraints:
Example: my-cluster1
public void setDBClusterIdentifier(String dBClusterIdentifier)
Constraints:
Example: my-cluster1
dBClusterIdentifier
- The DB cluster identifier. This parameter is stored as a lowercase
string. Constraints:
Example: my-cluster1
public CreateDBClusterRequest withDBClusterIdentifier(String dBClusterIdentifier)
Constraints:
Example: my-cluster1
Returns a reference to this object so that method calls can be chained together.
dBClusterIdentifier
- The DB cluster identifier. This parameter is stored as a lowercase
string. Constraints:
Example: my-cluster1
public String getDBClusterParameterGroupName()
default.aurora5.6
for the specified engine will be used. Constraints:
default.aurora5.6
for the specified engine will be used. Constraints:
public void setDBClusterParameterGroupName(String dBClusterParameterGroupName)
default.aurora5.6
for the specified engine will be used. Constraints:
dBClusterParameterGroupName
- The name of the DB cluster parameter group to associate with this DB
cluster. If this argument is omitted, default.aurora5.6
for the specified engine will be used. Constraints:
public CreateDBClusterRequest withDBClusterParameterGroupName(String dBClusterParameterGroupName)
default.aurora5.6
for the specified engine will be used. Constraints:
Returns a reference to this object so that method calls can be chained together.
dBClusterParameterGroupName
- The name of the DB cluster parameter group to associate with this DB
cluster. If this argument is omitted, default.aurora5.6
for the specified engine will be used. Constraints:
public List<String> getVpcSecurityGroupIds()
public void setVpcSecurityGroupIds(Collection<String> vpcSecurityGroupIds)
vpcSecurityGroupIds
- A list of EC2 VPC security groups to associate with this DB cluster.public CreateDBClusterRequest withVpcSecurityGroupIds(String... vpcSecurityGroupIds)
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.
Returns a reference to this object so that method calls can be chained together.
vpcSecurityGroupIds
- A list of EC2 VPC security groups to associate with this DB cluster.public CreateDBClusterRequest withVpcSecurityGroupIds(Collection<String> vpcSecurityGroupIds)
Returns a reference to this object so that method calls can be chained together.
vpcSecurityGroupIds
- A list of EC2 VPC security groups to associate with this DB cluster.public String getDBSubnetGroupName()
public void setDBSubnetGroupName(String dBSubnetGroupName)
dBSubnetGroupName
- A DB subnet group to associate with this DB cluster.public CreateDBClusterRequest withDBSubnetGroupName(String dBSubnetGroupName)
Returns a reference to this object so that method calls can be chained together.
dBSubnetGroupName
- A DB subnet group to associate with this DB cluster.public String getEngine()
Valid Values: MySQL
Valid Values: MySQL
public void setEngine(String engine)
Valid Values: MySQL
engine
- The name of the database engine to be used for this DB cluster.
Valid Values: MySQL
public CreateDBClusterRequest withEngine(String engine)
Valid Values: MySQL
Returns a reference to this object so that method calls can be chained together.
engine
- The name of the database engine to be used for this DB cluster.
Valid Values: MySQL
public String getEngineVersion()
Aurora
Example: 5.6.0
Aurora
Example: 5.6.0
public void setEngineVersion(String engineVersion)
Aurora
Example: 5.6.0
engineVersion
- The version number of the database engine to use. Aurora
Example: 5.6.0
public CreateDBClusterRequest withEngineVersion(String engineVersion)
Aurora
Example: 5.6.0
Returns a reference to this object so that method calls can be chained together.
engineVersion
- The version number of the database engine to use. Aurora
Example: 5.6.0
public Integer getPort()
Default: 3306
Default: 3306
public void setPort(Integer port)
Default: 3306
port
- The port number on which the instances in the DB cluster accept
connections. Default: 3306
public CreateDBClusterRequest withPort(Integer port)
Default: 3306
Returns a reference to this object so that method calls can be chained together.
port
- The port number on which the instances in the DB cluster accept
connections. Default: 3306
public String getMasterUsername()
Constraints:
Constraints:
public void setMasterUsername(String masterUsername)
Constraints:
masterUsername
- The name of the master user for the client DB cluster. Constraints:
public CreateDBClusterRequest withMasterUsername(String masterUsername)
Constraints:
Returns a reference to this object so that method calls can be chained together.
masterUsername
- The name of the master user for the client DB cluster. Constraints:
public String getMasterUserPassword()
Constraints: Must contain from 8 to 41 characters.
Constraints: Must contain from 8 to 41 characters.
public void setMasterUserPassword(String masterUserPassword)
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 CreateDBClusterRequest withMasterUserPassword(String masterUserPassword)
Constraints: Must contain from 8 to 41 characters.
Returns a reference to this object so that method calls can be chained together.
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 getOptionGroupName()
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 void setOptionGroupName(String optionGroupName)
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 CreateDBClusterRequest withOptionGroupName(String optionGroupName)
Permanent options cannot be removed from an option group. The option group cannot be removed from a DB cluster once it is associated with a DB cluster.
Returns a reference to this object so that method calls can be chained together.
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 getPreferredBackupWindow()
BackupRetentionPeriod
parameter. Default: A 30-minute window selected at random from an 8-hour block of time per region. To see the time blocks available, see Adjusting the Preferred Maintenance Window in the Amazon RDS User Guide.
Constraints:
hh24:mi-hh24:mi
.BackupRetentionPeriod
parameter. Default: A 30-minute window selected at random from an 8-hour block of time per region. To see the time blocks available, see Adjusting the Preferred Maintenance Window in the Amazon RDS User Guide.
Constraints:
hh24:mi-hh24:mi
.public void setPreferredBackupWindow(String preferredBackupWindow)
BackupRetentionPeriod
parameter. Default: A 30-minute window selected at random from an 8-hour block of time per region. To see the time blocks available, see Adjusting the Preferred Maintenance Window in the Amazon RDS User Guide.
Constraints:
hh24:mi-hh24:mi
.preferredBackupWindow
- The daily time range during which automated backups are created if
automated backups are enabled using the
BackupRetentionPeriod
parameter. Default: A 30-minute window selected at random from an 8-hour block of time per region. To see the time blocks available, see Adjusting the Preferred Maintenance Window in the Amazon RDS User Guide.
Constraints:
hh24:mi-hh24:mi
.public CreateDBClusterRequest withPreferredBackupWindow(String preferredBackupWindow)
BackupRetentionPeriod
parameter. Default: A 30-minute window selected at random from an 8-hour block of time per region. To see the time blocks available, see Adjusting the Preferred Maintenance Window in the Amazon RDS User Guide.
Constraints:
hh24:mi-hh24:mi
.Returns a reference to this object so that method calls can be chained together.
preferredBackupWindow
- The daily time range during which automated backups are created if
automated backups are enabled using the
BackupRetentionPeriod
parameter. Default: A 30-minute window selected at random from an 8-hour block of time per region. To see the time blocks available, see Adjusting the Preferred Maintenance Window in the Amazon RDS User Guide.
Constraints:
hh24:mi-hh24:mi
.public String getPreferredMaintenanceWindow()
Format:
ddd:hh24:mi-ddd:hh24:mi
Default: A 30-minute window selected at random from an 8-hour block of time per region, occurring on a random day of the week. To see the time blocks available, see Adjusting the Preferred Maintenance Window in the Amazon RDS User Guide.
Valid Days: Mon, Tue, Wed, Thu, Fri, Sat, Sun
Constraints: Minimum 30-minute window.
Format:
ddd:hh24:mi-ddd:hh24:mi
Default: A 30-minute window selected at random from an 8-hour block of time per region, occurring on a random day of the week. To see the time blocks available, see Adjusting the Preferred Maintenance Window in the Amazon RDS User Guide.
Valid Days: Mon, Tue, Wed, Thu, Fri, Sat, Sun
Constraints: Minimum 30-minute window.
public void setPreferredMaintenanceWindow(String preferredMaintenanceWindow)
Format:
ddd:hh24:mi-ddd:hh24:mi
Default: A 30-minute window selected at random from an 8-hour block of time per region, occurring on a random day of the week. To see the time blocks available, see Adjusting the Preferred Maintenance Window in the Amazon RDS User Guide.
Valid Days: Mon, Tue, Wed, Thu, Fri, Sat, Sun
Constraints: Minimum 30-minute window.
preferredMaintenanceWindow
- The weekly time range during which system maintenance can occur, in
Universal Coordinated Time (UTC). Format:
ddd:hh24:mi-ddd:hh24:mi
Default: A 30-minute window selected at random from an 8-hour block of time per region, occurring on a random day of the week. To see the time blocks available, see Adjusting the Preferred Maintenance Window in the Amazon RDS User Guide.
Valid Days: Mon, Tue, Wed, Thu, Fri, Sat, Sun
Constraints: Minimum 30-minute window.
public CreateDBClusterRequest withPreferredMaintenanceWindow(String preferredMaintenanceWindow)
Format:
ddd:hh24:mi-ddd:hh24:mi
Default: A 30-minute window selected at random from an 8-hour block of time per region, occurring on a random day of the week. To see the time blocks available, see Adjusting the Preferred Maintenance Window in the Amazon RDS User Guide.
Valid Days: Mon, Tue, Wed, Thu, Fri, Sat, Sun
Constraints: Minimum 30-minute window.
Returns a reference to this object so that method calls can be chained together.
preferredMaintenanceWindow
- The weekly time range during which system maintenance can occur, in
Universal Coordinated Time (UTC). Format:
ddd:hh24:mi-ddd:hh24:mi
Default: A 30-minute window selected at random from an 8-hour block of time per region, occurring on a random day of the week. To see the time blocks available, see Adjusting the Preferred Maintenance Window in the Amazon RDS User Guide.
Valid Days: Mon, Tue, Wed, Thu, Fri, Sat, Sun
Constraints: Minimum 30-minute window.
public void setTags(Collection<Tag> tags)
tags
- A list of 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.
Returns a reference to this object so that method calls can be chained together.
tags
- A list of tags.public CreateDBClusterRequest withTags(Collection<Tag> tags)
Returns a reference to this object so that method calls can be chained together.
tags
- A list of tags.public String toString()
toString
in class Object
Object.toString()
public CreateDBClusterRequest clone()
AmazonWebServiceRequest
clone
in class AmazonWebServiceRequest
Object.clone()
Copyright © 2015. All rights reserved.