@Generated(value="software.amazon.awssdk:codegen") public class ModifyDBClusterRequest extends RDSRequest implements ToCopyableBuilder<ModifyDBClusterRequest.Builder,ModifyDBClusterRequest>
Modifier and Type | Class and Description |
---|---|
static interface |
ModifyDBClusterRequest.Builder |
Modifier and Type | Method and Description |
---|---|
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. |
Integer |
backupRetentionPeriod()
The number of days for which automated backups are retained.
|
static ModifyDBClusterRequest.Builder |
builder() |
String |
dbClusterIdentifier()
The DB cluster identifier for the cluster being modified.
|
String |
dbClusterParameterGroupName()
The name of the DB cluster parameter group to use for the DB cluster.
|
Boolean |
enableIAMDatabaseAuthentication()
True to enable mapping of AWS Identity and Access Management (IAM) accounts to database accounts, and otherwise
false.
|
boolean |
equals(Object obj) |
<T> Optional<T> |
getValueForField(String fieldName,
Class<T> clazz)
Used to retrieve the value of a field from any class that extends
SdkRequest . |
int |
hashCode() |
String |
masterUserPassword()
The new password for the master database user.
|
String |
newDBClusterIdentifier()
The new DB cluster identifier for the DB cluster when renaming a DB cluster.
|
String |
optionGroupName()
A value that indicates that the DB cluster should be associated with the specified option group.
|
Integer |
port()
The port number on which the DB cluster accepts connections.
|
String |
preferredBackupWindow()
The daily time range during which automated backups are created if automated backups are enabled, using the
BackupRetentionPeriod parameter. |
String |
preferredMaintenanceWindow()
The weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).
|
static Class<? extends ModifyDBClusterRequest.Builder> |
serializableBuilderClass() |
ModifyDBClusterRequest.Builder |
toBuilder()
Take this object and create a builder that contains all of the current property values of this object.
|
String |
toString() |
List<String> |
vpcSecurityGroupIds()
A list of VPC security groups that the DB cluster will belong to.
|
requestOverrideConfig
copy
public String dbClusterIdentifier()
The DB cluster identifier for the cluster being modified. This parameter is not case-sensitive.
Constraints:
Must match the identifier of an existing DBCluster.
Constraints:
Must match the identifier of an existing DBCluster.
public String newDBClusterIdentifier()
The new DB cluster identifier for the DB cluster when renaming a DB cluster. This value is stored as a lowercase string.
Constraints:
Must contain from 1 to 63 letters, numbers, or hyphens
The first character must be a letter
Cannot end with a hyphen or contain two consecutive hyphens
Example: my-cluster2
Constraints:
Must contain from 1 to 63 letters, numbers, or hyphens
The first character must be a letter
Cannot end with a hyphen or contain two consecutive hyphens
Example: my-cluster2
public 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. 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 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
Default: 1
Constraints:
Must be a value from 1 to 35
public String dbClusterParameterGroupName()
The name of the DB cluster parameter group to use for the DB cluster.
public List<String> vpcSecurityGroupIds()
A list of VPC security groups that the DB cluster will belong to.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
public Integer 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.
Constraints: Value must be 1150-65535
Default: The same port as the original DB cluster.
public String 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.
Constraints: Must contain from 8 to 41 characters.
public String 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 can't be removed from an option group. The option group can't be removed from a DB cluster once it is associated with a DB cluster.
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 can't be removed from an option group. The option group can't be removed from a DB cluster once it is associated with a DB cluster.
public String preferredBackupWindow()
The daily time range during which automated backups are created if automated backups are enabled, using the
BackupRetentionPeriod
parameter.
The default is a 30-minute window selected at random from an 8-hour block of time for each AWS Region. To see the time blocks available, see Adjusting the Preferred Maintenance Window in the Amazon RDS User Guide.
Constraints:
Must be in the format hh24:mi-hh24:mi
.
Must be in Universal Coordinated Time (UTC).
Must not conflict with the preferred maintenance window.
Must be at least 30 minutes.
BackupRetentionPeriod
parameter.
The default is a 30-minute window selected at random from an 8-hour block of time for each AWS Region. To see the time blocks available, see Adjusting the Preferred Maintenance Window in the Amazon RDS User Guide.
Constraints:
Must be in the format hh24:mi-hh24:mi
.
Must be in Universal Coordinated Time (UTC).
Must not conflict with the preferred maintenance window.
Must be at least 30 minutes.
public String preferredMaintenanceWindow()
The weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).
Format: ddd:hh24:mi-ddd:hh24:mi
The default is a 30-minute window selected at random from an 8-hour block of time for each AWS Region, occurring on a random day of the week. To see the time blocks available, see Adjusting the Preferred 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
The default is a 30-minute window selected at random from an 8-hour block of time for each AWS Region, occurring on a random day of the week. To see the time blocks available, see Adjusting the Preferred Maintenance Window in the Amazon RDS User Guide.
Valid Days: Mon, Tue, Wed, Thu, Fri, Sat, Sun.
Constraints: Minimum 30-minute window.
public Boolean enableIAMDatabaseAuthentication()
True to enable mapping of AWS Identity and Access Management (IAM) accounts to database accounts, and otherwise false.
Default: false
Default: false
public ModifyDBClusterRequest.Builder toBuilder()
ToCopyableBuilder
toBuilder
in interface ToCopyableBuilder<ModifyDBClusterRequest.Builder,ModifyDBClusterRequest>
toBuilder
in class RDSRequest
public static ModifyDBClusterRequest.Builder builder()
public static Class<? extends ModifyDBClusterRequest.Builder> serializableBuilderClass()
public <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
SdkRequest
SdkRequest
. The field name
specified should match the member name from the corresponding service-2.json model specified in the
codegen-resources folder for a given service. The class specifies what class to cast the returned value to.
If the returned value is also a modeled class, the SdkRequest.getValueForField(String, Class)
method will
again be available.getValueForField
in class SdkRequest
fieldName
- The name of the member to be retrieved.clazz
- The class to cast the returned object to.Copyright © 2017 Amazon Web Services, Inc. All Rights Reserved.