Class CreateDBClusterRequest
- All Implemented Interfaces:
ReadLimitInfo
,Serializable
,Cloneable
- See Also:
-
Field Summary
Fields inherited from class com.amazonaws.AmazonWebServiceRequest
NOOP
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionclone()
Creates a shallow clone of this request.boolean
A list of EC2 Availability Zones that instances in the DB cluster can be created in.The number of days for which automated backups are retained.A value that indicates that the DB cluster should be associated with the specified CharacterSet.The name for your database of up to 8 alpha-numeric characters.The DB cluster identifier.The name of the DB cluster parameter group to associate with this DB cluster.A DB subnet group to associate with this DB cluster.The name of the database engine to be used for this DB cluster.The version number of the database engine to use.The KMS key identifier for an encrypted DB cluster.The name of the master user for the client DB cluster.The password for the master database user.A value that indicates that the DB cluster should be associated with the specified option group.getPort()
The port number on which the instances in the DB cluster accept connections.The daily time range during which automated backups are created if automated backups are enabled using theBackupRetentionPeriod
parameter.The weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).Specifies whether the DB cluster is encrypted.getTags()
A list of EC2 VPC security groups to associate with this DB cluster.int
hashCode()
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 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
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 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
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 theBackupRetentionPeriod
parameter.void
setPreferredMaintenanceWindow
(String preferredMaintenanceWindow) The weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).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.toString()
Returns a string representation of this object; useful for testing and debugging.withAvailabilityZones
(String... availabilityZones) A list of EC2 Availability Zones that instances in the DB cluster can be created in.withAvailabilityZones
(Collection<String> availabilityZones) A list of EC2 Availability Zones that instances in the DB cluster can be created in.withBackupRetentionPeriod
(Integer backupRetentionPeriod) The number of days for which automated backups are retained.withCharacterSetName
(String characterSetName) A value that indicates that the DB cluster should be associated with the specified CharacterSet.withDatabaseName
(String databaseName) The name for your database of up to 8 alpha-numeric characters.withDBClusterIdentifier
(String dBClusterIdentifier) The DB cluster identifier.withDBClusterParameterGroupName
(String dBClusterParameterGroupName) The name of the DB cluster parameter group to associate with this DB cluster.withDBSubnetGroupName
(String dBSubnetGroupName) A DB subnet group to associate with this DB cluster.withEngine
(String engine) The name of the database engine to be used for this DB cluster.withEngineVersion
(String engineVersion) The version number of the database engine to use.withKmsKeyId
(String kmsKeyId) The KMS key identifier for an encrypted DB cluster.withMasterUsername
(String masterUsername) The name of the master user for the client DB cluster.withMasterUserPassword
(String masterUserPassword) The password for the master database user.withOptionGroupName
(String optionGroupName) A value that indicates that the DB cluster should be associated with the specified option group.The port number on which the instances in the DB cluster accept connections.withPreferredBackupWindow
(String preferredBackupWindow) The daily time range during which automated backups are created if automated backups are enabled using theBackupRetentionPeriod
parameter.withPreferredMaintenanceWindow
(String preferredMaintenanceWindow) The weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).withStorageEncrypted
(Boolean storageEncrypted) Specifies whether the DB cluster is encrypted.NOTE: This method appends the values to the existing list (if any).withTags
(Collection<Tag> tags) withVpcSecurityGroupIds
(String... vpcSecurityGroupIds) A list of EC2 VPC security groups to associate with this DB cluster.withVpcSecurityGroupIds
(Collection<String> vpcSecurityGroupIds) A list of EC2 VPC security groups to associate with this DB cluster.Methods inherited from class com.amazonaws.AmazonWebServiceRequest
copyBaseTo, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestMetricCollector, withSdkClientExecutionTimeout, withSdkRequestTimeout
-
Constructor Details
-
CreateDBClusterRequest
public CreateDBClusterRequest()
-
-
Method Details
-
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.
- Returns:
- A list of EC2 Availability Zones that instances in the DB cluster can be created in. For information on regions and Availability Zones, see Regions and Availability Zones.
-
setAvailabilityZones
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.
- Parameters:
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.
-
withAvailabilityZones
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)
orwithAvailabilityZones(java.util.Collection)
if you want to override the existing values.- Parameters:
availabilityZones
- A list of EC2 Availability Zones that instances in the DB cluster can be created in. For information on regions and Availability Zones, see Regions and Availability Zones.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
withAvailabilityZones
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.
- Parameters:
availabilityZones
- A list of EC2 Availability Zones that instances in the DB cluster can be created in. For information on regions and Availability Zones, see Regions and Availability Zones.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setBackupRetentionPeriod
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
- Parameters:
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
-
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
- Returns:
- The number of days for which automated backups are retained. You
must specify a minimum value of 1.
Default: 1
Constraints:
- Must be a value from 1 to 35
-
withBackupRetentionPeriod
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
- Parameters:
backupRetentionPeriod
- The number of days for which automated backups are retained. You must specify a minimum value of 1.Default: 1
Constraints:
- Must be a value from 1 to 35
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setCharacterSetName
A value that indicates that the DB cluster should be associated with the specified CharacterSet.
- Parameters:
characterSetName
- A value that indicates that the DB cluster should be associated with the specified CharacterSet.
-
getCharacterSetName
A value that indicates that the DB cluster should be associated with the specified CharacterSet.
- Returns:
- A value that indicates that the DB cluster should be associated with the specified CharacterSet.
-
withCharacterSetName
A value that indicates that the DB cluster should be associated with the specified CharacterSet.
- Parameters:
characterSetName
- A value that indicates that the DB cluster should be associated with the specified CharacterSet.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setDatabaseName
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.
- Parameters:
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.
-
getDatabaseName
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.
- Returns:
- 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.
-
withDatabaseName
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.
- Parameters:
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.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setDBClusterIdentifier
The DB cluster identifier. This parameter is stored as a lowercase string.
Constraints:
- Must contain from 1 to 63 alphanumeric characters or hyphens.
- First character must be a letter.
- Cannot end with a hyphen or contain two consecutive hyphens.
Example:
my-cluster1
- Parameters:
dBClusterIdentifier
- The DB cluster identifier. This parameter is stored as a lowercase string.Constraints:
- Must contain from 1 to 63 alphanumeric characters or hyphens.
- First character must be a letter.
- Cannot end with a hyphen or contain two consecutive hyphens.
Example:
my-cluster1
-
getDBClusterIdentifier
The DB cluster identifier. This parameter is stored as a lowercase string.
Constraints:
- Must contain from 1 to 63 alphanumeric characters or hyphens.
- First character must be a letter.
- Cannot end with a hyphen or contain two consecutive hyphens.
Example:
my-cluster1
- Returns:
- The DB cluster identifier. This parameter is stored as a
lowercase string.
Constraints:
- Must contain from 1 to 63 alphanumeric characters or hyphens.
- First character must be a letter.
- Cannot end with a hyphen or contain two consecutive hyphens.
Example:
my-cluster1
-
withDBClusterIdentifier
The DB cluster identifier. This parameter is stored as a lowercase string.
Constraints:
- Must contain from 1 to 63 alphanumeric characters or hyphens.
- First character must be a letter.
- Cannot end with a hyphen or contain two consecutive hyphens.
Example:
my-cluster1
- Parameters:
dBClusterIdentifier
- The DB cluster identifier. This parameter is stored as a lowercase string.Constraints:
- Must contain from 1 to 63 alphanumeric characters or hyphens.
- First character must be a letter.
- Cannot end with a hyphen or contain two consecutive hyphens.
Example:
my-cluster1
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setDBClusterParameterGroupName
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:
- Must be 1 to 255 alphanumeric characters
- First character must be a letter
- Cannot end with a hyphen or contain two consecutive hyphens
- Parameters:
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:
- Must be 1 to 255 alphanumeric characters
- First character must be a letter
- Cannot end with a hyphen or contain two consecutive hyphens
-
getDBClusterParameterGroupName
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:
- Must be 1 to 255 alphanumeric characters
- First character must be a letter
- Cannot end with a hyphen or contain two consecutive hyphens
- Returns:
- The name of the DB cluster parameter group to associate with this
DB cluster. If this argument is omitted,
default.aurora5.6
for the specified engine will be used.Constraints:
- Must be 1 to 255 alphanumeric characters
- First character must be a letter
- Cannot end with a hyphen or contain two consecutive hyphens
-
withDBClusterParameterGroupName
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:
- Must be 1 to 255 alphanumeric characters
- First character must be a letter
- Cannot end with a hyphen or contain two consecutive hyphens
- Parameters:
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:
- Must be 1 to 255 alphanumeric characters
- First character must be a letter
- Cannot end with a hyphen or contain two consecutive hyphens
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
getVpcSecurityGroupIds
A list of EC2 VPC security groups to associate with this DB cluster.
- Returns:
- A list of EC2 VPC security groups to associate with this DB cluster.
-
setVpcSecurityGroupIds
A list of EC2 VPC security groups to associate with this DB cluster.
- Parameters:
vpcSecurityGroupIds
- A list of EC2 VPC security groups to associate with this DB cluster.
-
withVpcSecurityGroupIds
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)
orwithVpcSecurityGroupIds(java.util.Collection)
if you want to override the existing values.- Parameters:
vpcSecurityGroupIds
- A list of EC2 VPC security groups to associate with this DB cluster.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
withVpcSecurityGroupIds
A list of EC2 VPC security groups to associate with this DB cluster.
- Parameters:
vpcSecurityGroupIds
- A list of EC2 VPC security groups to associate with this DB cluster.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setDBSubnetGroupName
A DB subnet group to associate with this DB cluster.
Constraints: Must contain no more than 255 alphanumeric characters, periods, underscores, spaces, or hyphens. Must not be default.
Example:
mySubnetgroup
- Parameters:
dBSubnetGroupName
- A DB subnet group to associate with this DB cluster.Constraints: Must contain no more than 255 alphanumeric characters, periods, underscores, spaces, or hyphens. Must not be default.
Example:
mySubnetgroup
-
getDBSubnetGroupName
A DB subnet group to associate with this DB cluster.
Constraints: Must contain no more than 255 alphanumeric characters, periods, underscores, spaces, or hyphens. Must not be default.
Example:
mySubnetgroup
- Returns:
- A DB subnet group to associate with this DB cluster.
Constraints: Must contain no more than 255 alphanumeric characters, periods, underscores, spaces, or hyphens. Must not be default.
Example:
mySubnetgroup
-
withDBSubnetGroupName
A DB subnet group to associate with this DB cluster.
Constraints: Must contain no more than 255 alphanumeric characters, periods, underscores, spaces, or hyphens. Must not be default.
Example:
mySubnetgroup
- Parameters:
dBSubnetGroupName
- A DB subnet group to associate with this DB cluster.Constraints: Must contain no more than 255 alphanumeric characters, periods, underscores, spaces, or hyphens. Must not be default.
Example:
mySubnetgroup
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setEngine
The name of the database engine to be used for this DB cluster.
Valid Values:
aurora
- Parameters:
engine
- The name of the database engine to be used for this DB cluster.Valid Values:
aurora
-
getEngine
The name of the database engine to be used for this DB cluster.
Valid Values:
aurora
- Returns:
- The name of the database engine to be used for this DB cluster.
Valid Values:
aurora
-
withEngine
The name of the database engine to be used for this DB cluster.
Valid Values:
aurora
- Parameters:
engine
- The name of the database engine to be used for this DB cluster.Valid Values:
aurora
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setEngineVersion
The version number of the database engine to use.
Aurora
Example:
5.6.10a
- Parameters:
engineVersion
- The version number of the database engine to use.Aurora
Example:
5.6.10a
-
getEngineVersion
The version number of the database engine to use.
Aurora
Example:
5.6.10a
- Returns:
- The version number of the database engine to use.
Aurora
Example:
5.6.10a
-
withEngineVersion
The version number of the database engine to use.
Aurora
Example:
5.6.10a
- Parameters:
engineVersion
- The version number of the database engine to use.Aurora
Example:
5.6.10a
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setPort
The port number on which the instances in the DB cluster accept connections.
Default:
3306
- Parameters:
port
- The port number on which the instances in the DB cluster accept connections.Default:
3306
-
getPort
The port number on which the instances in the DB cluster accept connections.
Default:
3306
- Returns:
- The port number on which the instances in the DB cluster accept
connections.
Default:
3306
-
withPort
The port number on which the instances in the DB cluster accept connections.
Default:
3306
- Parameters:
port
- The port number on which the instances in the DB cluster accept connections.Default:
3306
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setMasterUsername
The name of the master user for the client DB cluster.
Constraints:
- Must be 1 to 16 alphanumeric characters.
- First character must be a letter.
- Cannot be a reserved word for the chosen database engine.
- Parameters:
masterUsername
- The name of the master user for the client DB cluster.Constraints:
- Must be 1 to 16 alphanumeric characters.
- First character must be a letter.
- Cannot be a reserved word for the chosen database engine.
-
getMasterUsername
The name of the master user for the client DB cluster.
Constraints:
- Must be 1 to 16 alphanumeric characters.
- First character must be a letter.
- Cannot be a reserved word for the chosen database engine.
- Returns:
- The name of the master user for the client DB cluster.
Constraints:
- Must be 1 to 16 alphanumeric characters.
- First character must be a letter.
- Cannot be a reserved word for the chosen database engine.
-
withMasterUsername
The name of the master user for the client DB cluster.
Constraints:
- Must be 1 to 16 alphanumeric characters.
- First character must be a letter.
- Cannot be a reserved word for the chosen database engine.
- Parameters:
masterUsername
- The name of the master user for the client DB cluster.Constraints:
- Must be 1 to 16 alphanumeric characters.
- First character must be a letter.
- Cannot be a reserved word for the chosen database engine.
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setMasterUserPassword
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.
- Parameters:
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.
-
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.
- Returns:
- The password for the master database user. This password can
contain any printable ASCII character except "/", """, or "@".
Constraints: Must contain from 8 to 41 characters.
-
withMasterUserPassword
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.
- Parameters:
masterUserPassword
- The password for the master database user. This password can contain any printable ASCII character except "/", """, or "@".Constraints: Must contain from 8 to 41 characters.
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setOptionGroupName
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.
- Parameters:
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.
-
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.
- Returns:
- A value that indicates that the DB cluster should be associated
with the specified option group.
Permanent options cannot be removed from an option group. The option group cannot be removed from a DB cluster once it is associated with a DB cluster.
-
withOptionGroupName
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.
- Parameters:
optionGroupName
- A value that indicates that the DB cluster should be associated with the specified option group.Permanent options cannot be removed from an option group. The option group cannot be removed from a DB cluster once it is associated with a DB cluster.
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setPreferredBackupWindow
The daily time range during which automated backups are created if automated backups are enabled using the
BackupRetentionPeriod
parameter.Default: A 30-minute window selected at random from an 8-hour block of time per region. To see the time blocks available, see Adjusting the Preferred Maintenance Window in the Amazon RDS User Guide.
Constraints:
- Must be in the format
hh24:mi-hh24:mi
. - Times should be in Universal Coordinated Time (UTC).
- Must not conflict with the preferred maintenance window.
- Must be at least 30 minutes.
- Parameters:
preferredBackupWindow
- The daily time range during which automated backups are created if automated backups are enabled using theBackupRetentionPeriod
parameter.Default: A 30-minute window selected at random from an 8-hour block of time per region. To see the time blocks available, see Adjusting the Preferred Maintenance Window in the Amazon RDS User Guide.
Constraints:
- Must be in the format
hh24:mi-hh24:mi
. - Times should be in Universal Coordinated Time (UTC).
- Must not conflict with the preferred maintenance window.
- Must be at least 30 minutes.
- Must be in the format
- Must be in the format
-
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 region. To see the time blocks available, see Adjusting the Preferred Maintenance Window in the Amazon RDS User Guide.
Constraints:
- Must be in the format
hh24:mi-hh24:mi
. - Times should be in Universal Coordinated Time (UTC).
- Must not conflict with the preferred maintenance window.
- Must be at least 30 minutes.
- Returns:
- The daily time range during which automated backups are created
if automated backups are enabled using the
BackupRetentionPeriod
parameter.Default: A 30-minute window selected at random from an 8-hour block of time per region. To see the time blocks available, see Adjusting the Preferred Maintenance Window in the Amazon RDS User Guide.
Constraints:
- Must be in the format
hh24:mi-hh24:mi
. - Times should be in Universal Coordinated Time (UTC).
- Must not conflict with the preferred maintenance window.
- Must be at least 30 minutes.
- Must be in the format
- Must be in the format
-
withPreferredBackupWindow
The daily time range during which automated backups are created if automated backups are enabled using the
BackupRetentionPeriod
parameter.Default: A 30-minute window selected at random from an 8-hour block of time per region. To see the time blocks available, see Adjusting the Preferred Maintenance Window in the Amazon RDS User Guide.
Constraints:
- Must be in the format
hh24:mi-hh24:mi
. - Times should be in Universal Coordinated Time (UTC).
- Must not conflict with the preferred maintenance window.
- Must be at least 30 minutes.
- Parameters:
preferredBackupWindow
- The daily time range during which automated backups are created if automated backups are enabled using theBackupRetentionPeriod
parameter.Default: A 30-minute window selected at random from an 8-hour block of time per region. To see the time blocks available, see Adjusting the Preferred Maintenance Window in the Amazon RDS User Guide.
Constraints:
- Must be in the format
hh24:mi-hh24:mi
. - Times should be in Universal Coordinated Time (UTC).
- Must not conflict with the preferred maintenance window.
- Must be at least 30 minutes.
- Must be in the format
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- Must be in the format
-
setPreferredMaintenanceWindow
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.
- Parameters:
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.
-
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 region, occurring on a random day of the week. To see the time blocks available, see Adjusting the Preferred Maintenance Window in the Amazon RDS User Guide.
Valid Days: Mon, Tue, Wed, Thu, Fri, Sat, Sun
Constraints: Minimum 30-minute window.
- Returns:
- The weekly time range during which system maintenance can occur,
in Universal Coordinated Time (UTC).
Format:
ddd:hh24:mi-ddd:hh24:mi
Default: A 30-minute window selected at random from an 8-hour block of time per region, occurring on a random day of the week. To see the time blocks available, see Adjusting the Preferred Maintenance Window in the Amazon RDS User Guide.
Valid Days: Mon, Tue, Wed, Thu, Fri, Sat, Sun
Constraints: Minimum 30-minute window.
-
withPreferredMaintenanceWindow
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.
- Parameters:
preferredMaintenanceWindow
- The weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).Format:
ddd:hh24:mi-ddd:hh24:mi
Default: A 30-minute window selected at random from an 8-hour block of time per region, occurring on a random day of the week. To see the time blocks available, see Adjusting the Preferred Maintenance Window in the Amazon RDS User Guide.
Valid Days: Mon, Tue, Wed, Thu, Fri, Sat, Sun
Constraints: Minimum 30-minute window.
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
getTags
- Returns:
-
setTags
- Parameters:
tags
-
-
withTags
NOTE: This method appends the values to the existing list (if any). Use
setTags(java.util.Collection)
orwithTags(java.util.Collection)
if you want to override the existing values.- Parameters:
tags
-- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
withTags
- Parameters:
tags
-- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setStorageEncrypted
Specifies whether the DB cluster is encrypted.
- Parameters:
storageEncrypted
- Specifies whether the DB cluster is encrypted.
-
getStorageEncrypted
Specifies whether the DB cluster is encrypted.
- Returns:
- Specifies whether the DB cluster is encrypted.
-
withStorageEncrypted
Specifies whether the DB cluster is encrypted.
- Parameters:
storageEncrypted
- Specifies whether the DB cluster is encrypted.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
isStorageEncrypted
Specifies whether the DB cluster is encrypted.
- Returns:
- Specifies whether the DB cluster is encrypted.
-
setKmsKeyId
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 KM encryption key.
If the
StorageEncrypted
parameter is true, and you do not specify a value for theKmsKeyId
parameter, then Amazon RDS will use your default encryption key. AWS KMS creates the default encryption key for your AWS account. Your AWS account has a different default encryption key for each AWS region.- Parameters:
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 KM encryption key.
If the
StorageEncrypted
parameter is true, and you do not specify a value for theKmsKeyId
parameter, then Amazon RDS will use your default encryption key. AWS KMS creates the default encryption key for your AWS account. Your AWS account has a different default encryption key for each AWS region.
-
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 KM encryption key.
If the
StorageEncrypted
parameter is true, and you do not specify a value for theKmsKeyId
parameter, then Amazon RDS will use your default encryption key. AWS KMS creates the default encryption key for your AWS account. Your AWS account has a different default encryption key for each AWS region.- Returns:
- The KMS key identifier for an encrypted DB cluster.
The KMS key identifier is the Amazon Resource Name (ARN) for the KMS encryption key. If you are creating a DB cluster with the same AWS account that owns the KMS encryption key used to encrypt the new DB cluster, then you can use the KMS key alias instead of the ARN for the KM encryption key.
If the
StorageEncrypted
parameter is true, and you do not specify a value for theKmsKeyId
parameter, then Amazon RDS will use your default encryption key. AWS KMS creates the default encryption key for your AWS account. Your AWS account has a different default encryption key for each AWS region.
-
withKmsKeyId
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 KM encryption key.
If the
StorageEncrypted
parameter is true, and you do not specify a value for theKmsKeyId
parameter, then Amazon RDS will use your default encryption key. AWS KMS creates the default encryption key for your AWS account. Your AWS account has a different default encryption key for each AWS region.- Parameters:
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 KM encryption key.
If the
StorageEncrypted
parameter is true, and you do not specify a value for theKmsKeyId
parameter, then Amazon RDS will use your default encryption key. AWS KMS creates the default encryption key for your AWS account. Your AWS account has a different default encryption key for each AWS region.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
toString
Returns a string representation of this object; useful for testing and debugging. -
equals
-
hashCode
public int hashCode() -
clone
Description copied from class:AmazonWebServiceRequest
Creates a shallow clone of this request. Explicitly does not clone the deep structure of the request object.- Overrides:
clone
in classAmazonWebServiceRequest
- See Also:
-