public class ModifyDBClusterRequest extends AmazonWebServiceRequest implements Serializable, Cloneable
ModifyDBCluster operation
.
Modify a setting for an Amazon Aurora DB cluster. You can change one or more database configuration parameters by specifying these parameters and the new values in the request. For more information on Amazon Aurora, see Aurora on Amazon RDS in the Amazon RDS User Guide.
NOOP
Constructor and Description |
---|
ModifyDBClusterRequest() |
Modifier and Type | Method and Description |
---|---|
ModifyDBClusterRequest |
clone()
Creates a shallow clone of this request.
|
boolean |
equals(Object obj) |
Boolean |
getApplyImmediately()
A value that specifies whether the modifications in this request and
any pending modifications are asynchronously applied as soon as
possible, regardless of the
PreferredMaintenanceWindow
setting for the DB cluster. |
Integer |
getBackupRetentionPeriod()
The number of days for which automated backups are retained.
|
String |
getDBClusterIdentifier()
The DB cluster identifier for the cluster being modified.
|
String |
getDBClusterParameterGroupName()
The name of the DB cluster parameter group to use for the DB cluster.
|
String |
getMasterUserPassword()
The new password for the master database user.
|
String |
getNewDBClusterIdentifier()
The new DB cluster identifier for the DB cluster when renaming a DB
cluster.
|
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 DB cluster accepts 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<String> |
getVpcSecurityGroupIds()
A lst of VPC security groups that the DB cluster will belong to.
|
int |
hashCode() |
Boolean |
isApplyImmediately()
A value that specifies whether the modifications in this request and
any pending modifications are asynchronously applied as soon as
possible, regardless of the
PreferredMaintenanceWindow
setting for the DB cluster. |
void |
setApplyImmediately(Boolean applyImmediately)
A value that specifies whether the modifications in this request and
any pending modifications are asynchronously applied as soon as
possible, regardless of the
PreferredMaintenanceWindow
setting for the DB cluster. |
void |
setBackupRetentionPeriod(Integer backupRetentionPeriod)
The number of days for which automated backups are retained.
|
void |
setDBClusterIdentifier(String dBClusterIdentifier)
The DB cluster identifier for the cluster being modified.
|
void |
setDBClusterParameterGroupName(String dBClusterParameterGroupName)
The name of the DB cluster parameter group to use for the DB cluster.
|
void |
setMasterUserPassword(String masterUserPassword)
The new password for the master database user.
|
void |
setNewDBClusterIdentifier(String newDBClusterIdentifier)
The new DB cluster identifier for the DB cluster when renaming a DB
cluster.
|
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 DB cluster accepts 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 |
setVpcSecurityGroupIds(Collection<String> vpcSecurityGroupIds)
A lst of VPC security groups that the DB cluster will belong to.
|
String |
toString()
Returns a string representation of this object; useful for testing and
debugging.
|
ModifyDBClusterRequest |
withApplyImmediately(Boolean applyImmediately)
A value that specifies whether the modifications in this request and
any pending modifications are asynchronously applied as soon as
possible, regardless of the
PreferredMaintenanceWindow
setting for the DB cluster. |
ModifyDBClusterRequest |
withBackupRetentionPeriod(Integer backupRetentionPeriod)
The number of days for which automated backups are retained.
|
ModifyDBClusterRequest |
withDBClusterIdentifier(String dBClusterIdentifier)
The DB cluster identifier for the cluster being modified.
|
ModifyDBClusterRequest |
withDBClusterParameterGroupName(String dBClusterParameterGroupName)
The name of the DB cluster parameter group to use for the DB cluster.
|
ModifyDBClusterRequest |
withMasterUserPassword(String masterUserPassword)
The new password for the master database user.
|
ModifyDBClusterRequest |
withNewDBClusterIdentifier(String newDBClusterIdentifier)
The new DB cluster identifier for the DB cluster when renaming a DB
cluster.
|
ModifyDBClusterRequest |
withOptionGroupName(String optionGroupName)
A value that indicates that the DB cluster should be associated with
the specified option group.
|
ModifyDBClusterRequest |
withPort(Integer port)
The port number on which the DB cluster accepts connections.
|
ModifyDBClusterRequest |
withPreferredBackupWindow(String preferredBackupWindow)
The daily time range during which automated backups are created if
automated backups are enabled, using the
BackupRetentionPeriod parameter. |
ModifyDBClusterRequest |
withPreferredMaintenanceWindow(String preferredMaintenanceWindow)
The weekly time range during which system maintenance can occur, in
Universal Coordinated Time (UTC).
|
ModifyDBClusterRequest |
withVpcSecurityGroupIds(Collection<String> vpcSecurityGroupIds)
A lst of VPC security groups that the DB cluster will belong to.
|
ModifyDBClusterRequest |
withVpcSecurityGroupIds(String... vpcSecurityGroupIds)
A lst of VPC security groups that the DB cluster will belong to.
|
getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestMetricCollector, withSdkClientExecutionTimeout, withSdkRequestTimeout
public String getDBClusterIdentifier()
Constraints:
Constraints:
public void setDBClusterIdentifier(String dBClusterIdentifier)
Constraints:
dBClusterIdentifier
- The DB cluster identifier for the cluster being modified. This
parameter is not case-sensitive. Constraints:
public ModifyDBClusterRequest withDBClusterIdentifier(String dBClusterIdentifier)
Constraints:
Returns a reference to this object so that method calls can be chained together.
dBClusterIdentifier
- The DB cluster identifier for the cluster being modified. This
parameter is not case-sensitive. Constraints:
public String getNewDBClusterIdentifier()
Constraints:
Example: my-cluster2
Constraints:
Example: my-cluster2
public void setNewDBClusterIdentifier(String newDBClusterIdentifier)
Constraints:
Example: my-cluster2
newDBClusterIdentifier
- The new DB cluster identifier for the DB cluster when renaming a DB
cluster. This value is stored as a lowercase string. Constraints:
Example: my-cluster2
public ModifyDBClusterRequest withNewDBClusterIdentifier(String newDBClusterIdentifier)
Constraints:
Example: my-cluster2
Returns a reference to this object so that method calls can be chained together.
newDBClusterIdentifier
- The new DB cluster identifier for the DB cluster when renaming a DB
cluster. This value is stored as a lowercase string. Constraints:
Example: my-cluster2
public Boolean isApplyImmediately()
PreferredMaintenanceWindow
setting for the DB cluster. If this parameter is set to
false
, changes to the DB cluster are applied during the
next maintenance window. The ApplyImmediately
parameter only affects the NewDBClusterIdentifier
and
MasterUserPassword
values. If you set the
ApplyImmediately
parameter value to false, then changes
to the NewDBClusterIdentifier
and
MasterUserPassword
values are applied during the next
maintenance window. All other changes are applied immediately,
regardless of the value of the ApplyImmediately
parameter.
Default: false
PreferredMaintenanceWindow
setting for the DB cluster. If this parameter is set to
false
, changes to the DB cluster are applied during the
next maintenance window. The ApplyImmediately
parameter only affects the NewDBClusterIdentifier
and
MasterUserPassword
values. If you set the
ApplyImmediately
parameter value to false, then changes
to the NewDBClusterIdentifier
and
MasterUserPassword
values are applied during the next
maintenance window. All other changes are applied immediately,
regardless of the value of the ApplyImmediately
parameter.
Default: false
public void setApplyImmediately(Boolean applyImmediately)
PreferredMaintenanceWindow
setting for the DB cluster. If this parameter is set to
false
, changes to the DB cluster are applied during the
next maintenance window. The ApplyImmediately
parameter only affects the NewDBClusterIdentifier
and
MasterUserPassword
values. If you set the
ApplyImmediately
parameter value to false, then changes
to the NewDBClusterIdentifier
and
MasterUserPassword
values are applied during the next
maintenance window. All other changes are applied immediately,
regardless of the value of the ApplyImmediately
parameter.
Default: false
applyImmediately
- A value that specifies whether the modifications in this request and
any pending modifications are asynchronously applied as soon as
possible, regardless of the PreferredMaintenanceWindow
setting for the DB cluster. If this parameter is set to
false
, changes to the DB cluster are applied during the
next maintenance window. The ApplyImmediately
parameter only affects the NewDBClusterIdentifier
and
MasterUserPassword
values. If you set the
ApplyImmediately
parameter value to false, then changes
to the NewDBClusterIdentifier
and
MasterUserPassword
values are applied during the next
maintenance window. All other changes are applied immediately,
regardless of the value of the ApplyImmediately
parameter.
Default: false
public ModifyDBClusterRequest withApplyImmediately(Boolean applyImmediately)
PreferredMaintenanceWindow
setting for the DB cluster. If this parameter is set to
false
, changes to the DB cluster are applied during the
next maintenance window. The ApplyImmediately
parameter only affects the NewDBClusterIdentifier
and
MasterUserPassword
values. If you set the
ApplyImmediately
parameter value to false, then changes
to the NewDBClusterIdentifier
and
MasterUserPassword
values are applied during the next
maintenance window. All other changes are applied immediately,
regardless of the value of the ApplyImmediately
parameter.
Default: false
Returns a reference to this object so that method calls can be chained together.
applyImmediately
- A value that specifies whether the modifications in this request and
any pending modifications are asynchronously applied as soon as
possible, regardless of the PreferredMaintenanceWindow
setting for the DB cluster. If this parameter is set to
false
, changes to the DB cluster are applied during the
next maintenance window. The ApplyImmediately
parameter only affects the NewDBClusterIdentifier
and
MasterUserPassword
values. If you set the
ApplyImmediately
parameter value to false, then changes
to the NewDBClusterIdentifier
and
MasterUserPassword
values are applied during the next
maintenance window. All other changes are applied immediately,
regardless of the value of the ApplyImmediately
parameter.
Default: false
public Boolean getApplyImmediately()
PreferredMaintenanceWindow
setting for the DB cluster. If this parameter is set to
false
, changes to the DB cluster are applied during the
next maintenance window. The ApplyImmediately
parameter only affects the NewDBClusterIdentifier
and
MasterUserPassword
values. If you set the
ApplyImmediately
parameter value to false, then changes
to the NewDBClusterIdentifier
and
MasterUserPassword
values are applied during the next
maintenance window. All other changes are applied immediately,
regardless of the value of the ApplyImmediately
parameter.
Default: false
PreferredMaintenanceWindow
setting for the DB cluster. If this parameter is set to
false
, changes to the DB cluster are applied during the
next maintenance window. The ApplyImmediately
parameter only affects the NewDBClusterIdentifier
and
MasterUserPassword
values. If you set the
ApplyImmediately
parameter value to false, then changes
to the NewDBClusterIdentifier
and
MasterUserPassword
values are applied during the next
maintenance window. All other changes are applied immediately,
regardless of the value of the ApplyImmediately
parameter.
Default: false
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. You must
specify a minimum value of 1. Default: 1
Constraints:
public ModifyDBClusterRequest 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. You must
specify a minimum value of 1. Default: 1
Constraints:
public String getDBClusterParameterGroupName()
public void setDBClusterParameterGroupName(String dBClusterParameterGroupName)
dBClusterParameterGroupName
- The name of the DB cluster parameter group to use for the DB cluster.public ModifyDBClusterRequest withDBClusterParameterGroupName(String dBClusterParameterGroupName)
Returns a reference to this object so that method calls can be chained together.
dBClusterParameterGroupName
- The name of the DB cluster parameter group to use for the DB cluster.public List<String> getVpcSecurityGroupIds()
public void setVpcSecurityGroupIds(Collection<String> vpcSecurityGroupIds)
vpcSecurityGroupIds
- A lst of VPC security groups that the DB cluster will belong to.public ModifyDBClusterRequest 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 lst of VPC security groups that the DB cluster will belong to.public ModifyDBClusterRequest withVpcSecurityGroupIds(Collection<String> vpcSecurityGroupIds)
Returns a reference to this object so that method calls can be chained together.
vpcSecurityGroupIds
- A lst of VPC security groups that the DB cluster will belong to.public Integer getPort()
Constraints: Value must be 1150-65535
Default: The same port as the original DB cluster.
Constraints: Value must be 1150-65535
Default: The same port as the original DB cluster.
public void setPort(Integer port)
Constraints: Value must be 1150-65535
Default: The same port as the original DB cluster.
port
- The port number on which the DB cluster accepts connections.
Constraints: Value must be 1150-65535
Default: The same port as the original DB cluster.
public ModifyDBClusterRequest withPort(Integer port)
Constraints: Value must be 1150-65535
Default: The same port as the original DB cluster.
Returns a reference to this object so that method calls can be chained together.
port
- The port number on which the DB cluster accepts connections.
Constraints: Value must be 1150-65535
Default: The same port as the original DB cluster.
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 new 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 ModifyDBClusterRequest 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 new 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()
ApplyImmediately
parameter is set to true
for this request. If the parameter change results in an option group
that enables OEM, this change can cause a brief (sub-second) period
during which new connections are rejected but existing connections are
not interrupted. 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.
ApplyImmediately
parameter is set to true
for this request. If the parameter change results in an option group
that enables OEM, this change can cause a brief (sub-second) period
during which new connections are rejected but existing connections are
not interrupted. 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)
ApplyImmediately
parameter is set to true
for this request. If the parameter change results in an option group
that enables OEM, this change can cause a brief (sub-second) period
during which new connections are rejected but existing connections are
not interrupted. 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. Changing this parameter does not result in
an outage except in the following case, and the change is applied
during the next maintenance window unless the
ApplyImmediately
parameter is set to true
for this request. If the parameter change results in an option group
that enables OEM, this change can cause a brief (sub-second) period
during which new connections are rejected but existing connections are
not interrupted. 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 ModifyDBClusterRequest withOptionGroupName(String optionGroupName)
ApplyImmediately
parameter is set to true
for this request. If the parameter change results in an option group
that enables OEM, this change can cause a brief (sub-second) period
during which new connections are rejected but existing connections are
not interrupted. 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. Changing this parameter does not result in
an outage except in the following case, and the change is applied
during the next maintenance window unless the
ApplyImmediately
parameter is set to true
for this request. If the parameter change results in an option group
that enables OEM, this change can cause a brief (sub-second) period
during which new connections are rejected but existing connections are
not interrupted. 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 ModifyDBClusterRequest 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 ModifyDBClusterRequest 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 String toString()
toString
in class Object
Object.toString()
public ModifyDBClusterRequest clone()
AmazonWebServiceRequest
clone
in class AmazonWebServiceRequest
Object.clone()
Copyright © 2013 Amazon Web Services, Inc. All Rights Reserved.