com.amazonaws.services.rds.model

Class ModifyDBClusterRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.rds.model.ModifyDBClusterRequest

All Implemented Interfaces:

HandlerContextAware, ReadLimitInfo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class ModifyDBClusterRequest
extends AmazonWebServiceRequest
implements Serializable, Cloneable

See Also:

AWS API Documentation, Serialized Form

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

NOOP

Constructor Summary

Constructors

Constructor and Description
ModifyDBClusterRequest()

Method Summary

Modifier and Type	Method and Description
ModifyDBClusterRequest	clone() Creates a shallow clone of this object for all fields except the handler context.
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.
Long	getBacktrackWindow() The target backtrack window, in seconds.
Integer	getBackupRetentionPeriod() The number of days for which automated backups are retained.
CloudwatchLogsExportConfiguration	getCloudwatchLogsExportConfiguration() The configuration setting for the log types to be enabled for export to CloudWatch Logs for a specific DB cluster.
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.
Boolean	getDeletionProtection() Indicates if the DB cluster has deletion protection enabled.
Boolean	getEnableIAMDatabaseAuthentication() True to enable mapping of AWS Identity and Access Management (IAM) accounts to database accounts, and otherwise false.
String	getEngineVersion() The version number of the database engine to which you want to upgrade.
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).
ScalingConfiguration	getScalingConfiguration() The scaling properties of the DB cluster.
List<String>	getVpcSecurityGroupIds() A list 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.
Boolean	isDeletionProtection() Indicates if the DB cluster has deletion protection enabled.
Boolean	isEnableIAMDatabaseAuthentication() True to enable mapping of AWS Identity and Access Management (IAM) accounts to database accounts, and otherwise false.
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	setBacktrackWindow(Long backtrackWindow) The target backtrack window, in seconds.
void	setBackupRetentionPeriod(Integer backupRetentionPeriod) The number of days for which automated backups are retained.
void	setCloudwatchLogsExportConfiguration(CloudwatchLogsExportConfiguration cloudwatchLogsExportConfiguration) The configuration setting for the log types to be enabled for export to CloudWatch Logs for a specific DB cluster.
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	setDeletionProtection(Boolean deletionProtection) Indicates if the DB cluster has deletion protection enabled.
void	setEnableIAMDatabaseAuthentication(Boolean enableIAMDatabaseAuthentication) True to enable mapping of AWS Identity and Access Management (IAM) accounts to database accounts, and otherwise false.
void	setEngineVersion(String engineVersion) The version number of the database engine to which you want to upgrade.
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	setScalingConfiguration(ScalingConfiguration scalingConfiguration) The scaling properties of the DB cluster.
void	setVpcSecurityGroupIds(Collection<String> vpcSecurityGroupIds) A list 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	withBacktrackWindow(Long backtrackWindow) The target backtrack window, in seconds.
ModifyDBClusterRequest	withBackupRetentionPeriod(Integer backupRetentionPeriod) The number of days for which automated backups are retained.
ModifyDBClusterRequest	withCloudwatchLogsExportConfiguration(CloudwatchLogsExportConfiguration cloudwatchLogsExportConfiguration) The configuration setting for the log types to be enabled for export to CloudWatch Logs for a specific DB cluster.
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	withDeletionProtection(Boolean deletionProtection) Indicates if the DB cluster has deletion protection enabled.
ModifyDBClusterRequest	withEnableIAMDatabaseAuthentication(Boolean enableIAMDatabaseAuthentication) True to enable mapping of AWS Identity and Access Management (IAM) accounts to database accounts, and otherwise false.
ModifyDBClusterRequest	withEngineVersion(String engineVersion) The version number of the database engine to which you want to upgrade.
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	withScalingConfiguration(ScalingConfiguration scalingConfiguration) The scaling properties of the DB cluster.
ModifyDBClusterRequest	withVpcSecurityGroupIds(Collection<String> vpcSecurityGroupIds) A list of VPC security groups that the DB cluster will belong to.
ModifyDBClusterRequest	withVpcSecurityGroupIds(String... vpcSecurityGroupIds) A list of VPC security groups that the DB cluster will belong to.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

addHandlerContext, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getHandlerContext, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestCredentialsProvider, withRequestMetricCollector, withSdkClientExecutionTimeout, withSdkRequestTimeout

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

ModifyDBClusterRequest

public ModifyDBClusterRequest()

Method Detail

setDBClusterIdentifier

public void setDBClusterIdentifier(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.

Parameters:

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.

getDBClusterIdentifier

public String getDBClusterIdentifier()

The DB cluster identifier for the cluster being modified. This parameter is not case-sensitive.

Constraints:

• Must match the identifier of an existing DBCluster.

Returns:

The DB cluster identifier for the cluster being modified. This parameter is not case-sensitive.

Constraints:

• Must match the identifier of an existing DBCluster.

withDBClusterIdentifier

public ModifyDBClusterRequest withDBClusterIdentifier(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.

Parameters:

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.

Returns:

Returns a reference to this object so that method calls can be chained together.

setNewDBClusterIdentifier

public void setNewDBClusterIdentifier(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

• Can't end with a hyphen or contain two consecutive hyphens

Example: my-cluster2

Parameters:

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

• Can't end with a hyphen or contain two consecutive hyphens

Example: my-cluster2

getNewDBClusterIdentifier

public String getNewDBClusterIdentifier()

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

• Can't end with a hyphen or contain two consecutive hyphens

Example: my-cluster2

Returns:

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

• Can't end with a hyphen or contain two consecutive hyphens

Example: my-cluster2

withNewDBClusterIdentifier

public ModifyDBClusterRequest withNewDBClusterIdentifier(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

• Can't end with a hyphen or contain two consecutive hyphens

Example: my-cluster2

Parameters:

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

• Can't end with a hyphen or contain two consecutive hyphens

Example: my-cluster2

Returns:

Returns a reference to this object so that method calls can be chained together.

setApplyImmediately

public 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. 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 EnableIAMDatabaseAuthentication, MasterUserPassword, and NewDBClusterIdentifier values. If you set the ApplyImmediately parameter value to false, then changes to the EnableIAMDatabaseAuthentication, MasterUserPassword, and NewDBClusterIdentifier values are applied during the next maintenance window. All other changes are applied immediately, regardless of the value of the ApplyImmediately parameter.

Default: false

Parameters:

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 EnableIAMDatabaseAuthentication, MasterUserPassword, and NewDBClusterIdentifier values. If you set the ApplyImmediately parameter value to false, then changes to the EnableIAMDatabaseAuthentication, MasterUserPassword, and NewDBClusterIdentifier values are applied during the next maintenance window. All other changes are applied immediately, regardless of the value of the ApplyImmediately parameter.

Default: false

getApplyImmediately

public 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. 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 EnableIAMDatabaseAuthentication, MasterUserPassword, and NewDBClusterIdentifier values. If you set the ApplyImmediately parameter value to false, then changes to the EnableIAMDatabaseAuthentication, MasterUserPassword, and NewDBClusterIdentifier 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 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 EnableIAMDatabaseAuthentication, MasterUserPassword, and NewDBClusterIdentifier values. If you set the ApplyImmediately parameter value to false, then changes to the EnableIAMDatabaseAuthentication, MasterUserPassword, and NewDBClusterIdentifier values are applied during the next maintenance window. All other changes are applied immediately, regardless of the value of the ApplyImmediately parameter.

Default: false

withApplyImmediately

public 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. 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 EnableIAMDatabaseAuthentication, MasterUserPassword, and NewDBClusterIdentifier values. If you set the ApplyImmediately parameter value to false, then changes to the EnableIAMDatabaseAuthentication, MasterUserPassword, and NewDBClusterIdentifier values are applied during the next maintenance window. All other changes are applied immediately, regardless of the value of the ApplyImmediately parameter.

Default: false

Parameters:

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 EnableIAMDatabaseAuthentication, MasterUserPassword, and NewDBClusterIdentifier values. If you set the ApplyImmediately parameter value to false, then changes to the EnableIAMDatabaseAuthentication, MasterUserPassword, and NewDBClusterIdentifier 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:

Returns a reference to this object so that method calls can be chained together.

isApplyImmediately

public 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. 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 EnableIAMDatabaseAuthentication, MasterUserPassword, and NewDBClusterIdentifier values. If you set the ApplyImmediately parameter value to false, then changes to the EnableIAMDatabaseAuthentication, MasterUserPassword, and NewDBClusterIdentifier 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 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 EnableIAMDatabaseAuthentication, MasterUserPassword, and NewDBClusterIdentifier values. If you set the ApplyImmediately parameter value to false, then changes to the EnableIAMDatabaseAuthentication, MasterUserPassword, and NewDBClusterIdentifier values are applied during the next maintenance window. All other changes are applied immediately, regardless of the value of the ApplyImmediately parameter.

Default: false

setBackupRetentionPeriod

public void setBackupRetentionPeriod(Integer backupRetentionPeriod)

The number of days for which automated backups are retained. You must specify a minimum value of 1.

Default: 1

Constraints:

• Must be a value from 1 to 35

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

public Integer getBackupRetentionPeriod()

The number of days for which automated backups are retained. You must specify a minimum value of 1.

Default: 1

Constraints:

• Must be a value from 1 to 35

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

public ModifyDBClusterRequest withBackupRetentionPeriod(Integer backupRetentionPeriod)

The number of days for which automated backups are retained. You must specify a minimum value of 1.

Default: 1

Constraints:

• Must be a value from 1 to 35

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.

setDBClusterParameterGroupName

public void setDBClusterParameterGroupName(String dBClusterParameterGroupName)

The name of the DB cluster parameter group to use for the DB cluster.

Parameters:

dBClusterParameterGroupName - The name of the DB cluster parameter group to use for the DB cluster.

getDBClusterParameterGroupName

public String getDBClusterParameterGroupName()

The name of the DB cluster parameter group to use for the DB cluster.

Returns:

The name of the DB cluster parameter group to use for the DB cluster.

withDBClusterParameterGroupName

public ModifyDBClusterRequest withDBClusterParameterGroupName(String dBClusterParameterGroupName)

The name of the DB cluster parameter group to use for the DB cluster.

Parameters:

dBClusterParameterGroupName - The name of the DB cluster parameter group to use for the DB cluster.

Returns:

Returns a reference to this object so that method calls can be chained together.

getVpcSecurityGroupIds

public List<String> getVpcSecurityGroupIds()

A list of VPC security groups that the DB cluster will belong to.

Returns:

A list of VPC security groups that the DB cluster will belong to.

setVpcSecurityGroupIds

public void setVpcSecurityGroupIds(Collection<String> vpcSecurityGroupIds)

A list of VPC security groups that the DB cluster will belong to.

Parameters:

vpcSecurityGroupIds - A list of VPC security groups that the DB cluster will belong to.

withVpcSecurityGroupIds

public ModifyDBClusterRequest withVpcSecurityGroupIds(String... vpcSecurityGroupIds)

A list of VPC security groups that the DB cluster will belong to.

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.

Parameters:

vpcSecurityGroupIds - A list of VPC security groups that the DB cluster will belong to.

Returns:

Returns a reference to this object so that method calls can be chained together.

withVpcSecurityGroupIds

public ModifyDBClusterRequest withVpcSecurityGroupIds(Collection<String> vpcSecurityGroupIds)

A list of VPC security groups that the DB cluster will belong to.

Parameters:

vpcSecurityGroupIds - A list of VPC security groups that the DB cluster will belong to.

Returns:

Returns a reference to this object so that method calls can be chained together.

setPort

public void setPort(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.

Parameters:

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.

getPort

public Integer getPort()

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.

Returns:

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.

withPort

public ModifyDBClusterRequest withPort(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.

Parameters:

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.

Returns:

Returns a reference to this object so that method calls can be chained together.

setMasterUserPassword

public void setMasterUserPassword(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.

Parameters:

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.

getMasterUserPassword

public String getMasterUserPassword()

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.

Returns:

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.

withMasterUserPassword

public ModifyDBClusterRequest withMasterUserPassword(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.

Parameters:

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.

Returns:

Returns a reference to this object so that method calls can be chained together.

setOptionGroupName

public void setOptionGroupName(String optionGroupName)

A value that indicates that the DB cluster should be associated with the specified option group. Changing this parameter doesn't 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.

Parameters:

optionGroupName - A value that indicates that the DB cluster should be associated with the specified option group. Changing this parameter doesn't 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.

getOptionGroupName

public String getOptionGroupName()

A value that indicates that the DB cluster should be associated with the specified option group. Changing this parameter doesn't 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.

Returns:

A value that indicates that the DB cluster should be associated with the specified option group. Changing this parameter doesn't 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.

withOptionGroupName

public ModifyDBClusterRequest withOptionGroupName(String optionGroupName)

A value that indicates that the DB cluster should be associated with the specified option group. Changing this parameter doesn't 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.

Parameters:

optionGroupName - A value that indicates that the DB cluster should be associated with the specified option group. Changing this parameter doesn't 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.

Returns:

Returns a reference to this object so that method calls can be chained together.

setPreferredBackupWindow

public void setPreferredBackupWindow(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 DB Cluster Maintenance Window in the Amazon Aurora 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.

Parameters:

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 DB Cluster Maintenance Window in the Amazon Aurora 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.

getPreferredBackupWindow

public String getPreferredBackupWindow()

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 DB Cluster Maintenance Window in the Amazon Aurora 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.

Returns:

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 DB Cluster Maintenance Window in the Amazon Aurora 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.

withPreferredBackupWindow

public ModifyDBClusterRequest withPreferredBackupWindow(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 DB Cluster Maintenance Window in the Amazon Aurora 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.

Parameters:

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 DB Cluster Maintenance Window in the Amazon Aurora 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.

Returns:

Returns a reference to this object so that method calls can be chained together.

setPreferredMaintenanceWindow

public void setPreferredMaintenanceWindow(String preferredMaintenanceWindow)

The weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).

Format: ddd:hh24:mi-ddd:hh24:mi

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 DB Cluster Maintenance Window in the Amazon Aurora 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

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 DB Cluster Maintenance Window in the Amazon Aurora User Guide.

Valid Days: Mon, Tue, Wed, Thu, Fri, Sat, Sun.

Constraints: Minimum 30-minute window.

getPreferredMaintenanceWindow

public String getPreferredMaintenanceWindow()

The weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).

Format: ddd:hh24:mi-ddd:hh24:mi

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 DB Cluster Maintenance Window in the Amazon Aurora 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

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 DB Cluster Maintenance Window in the Amazon Aurora User Guide.

Valid Days: Mon, Tue, Wed, Thu, Fri, Sat, Sun.

Constraints: Minimum 30-minute window.

withPreferredMaintenanceWindow

public ModifyDBClusterRequest withPreferredMaintenanceWindow(String preferredMaintenanceWindow)

The weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).

Format: ddd:hh24:mi-ddd:hh24:mi

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 DB Cluster Maintenance Window in the Amazon Aurora 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

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 DB Cluster Maintenance Window in the Amazon Aurora 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.

setEnableIAMDatabaseAuthentication

public void setEnableIAMDatabaseAuthentication(Boolean enableIAMDatabaseAuthentication)

True to enable mapping of AWS Identity and Access Management (IAM) accounts to database accounts, and otherwise false.

Default: false

Parameters:

enableIAMDatabaseAuthentication - True to enable mapping of AWS Identity and Access Management (IAM) accounts to database accounts, and otherwise false.

Default: false

getEnableIAMDatabaseAuthentication

public Boolean getEnableIAMDatabaseAuthentication()

True to enable mapping of AWS Identity and Access Management (IAM) accounts to database accounts, and otherwise false.

Default: false

Returns:

True to enable mapping of AWS Identity and Access Management (IAM) accounts to database accounts, and otherwise false.

Default: false

withEnableIAMDatabaseAuthentication

public ModifyDBClusterRequest withEnableIAMDatabaseAuthentication(Boolean enableIAMDatabaseAuthentication)

True to enable mapping of AWS Identity and Access Management (IAM) accounts to database accounts, and otherwise false.

Default: false

Parameters:

enableIAMDatabaseAuthentication - True to enable mapping of AWS Identity and Access Management (IAM) accounts to database accounts, and otherwise false.

Default: false

Returns:

Returns a reference to this object so that method calls can be chained together.

isEnableIAMDatabaseAuthentication

public Boolean isEnableIAMDatabaseAuthentication()

True to enable mapping of AWS Identity and Access Management (IAM) accounts to database accounts, and otherwise false.

Default: false

Returns:

True to enable mapping of AWS Identity and Access Management (IAM) accounts to database accounts, and otherwise false.

Default: false

setBacktrackWindow

public void setBacktrackWindow(Long backtrackWindow)

The target backtrack window, in seconds. To disable backtracking, set this value to 0.

Default: 0

Constraints:

• If specified, this value must be set to a number from 0 to 259,200 (72 hours).

Parameters:

backtrackWindow - The target backtrack window, in seconds. To disable backtracking, set this value to 0.

Default: 0

Constraints:

• If specified, this value must be set to a number from 0 to 259,200 (72 hours).

getBacktrackWindow

public Long getBacktrackWindow()

The target backtrack window, in seconds. To disable backtracking, set this value to 0.

Default: 0

Constraints:

• If specified, this value must be set to a number from 0 to 259,200 (72 hours).

Returns:

The target backtrack window, in seconds. To disable backtracking, set this value to 0.

Default: 0

Constraints:

• If specified, this value must be set to a number from 0 to 259,200 (72 hours).

withBacktrackWindow

public ModifyDBClusterRequest withBacktrackWindow(Long backtrackWindow)

The target backtrack window, in seconds. To disable backtracking, set this value to 0.

Default: 0

Constraints:

• If specified, this value must be set to a number from 0 to 259,200 (72 hours).

Parameters:

backtrackWindow - The target backtrack window, in seconds. To disable backtracking, set this value to 0.

Default: 0

Constraints:

• If specified, this value must be set to a number from 0 to 259,200 (72 hours).

Returns:

Returns a reference to this object so that method calls can be chained together.

setCloudwatchLogsExportConfiguration

public void setCloudwatchLogsExportConfiguration(CloudwatchLogsExportConfiguration cloudwatchLogsExportConfiguration)

The configuration setting for the log types to be enabled for export to CloudWatch Logs for a specific DB cluster.

Parameters:

cloudwatchLogsExportConfiguration - The configuration setting for the log types to be enabled for export to CloudWatch Logs for a specific DB cluster.

getCloudwatchLogsExportConfiguration

public CloudwatchLogsExportConfiguration getCloudwatchLogsExportConfiguration()

The configuration setting for the log types to be enabled for export to CloudWatch Logs for a specific DB cluster.

Returns:

The configuration setting for the log types to be enabled for export to CloudWatch Logs for a specific DB cluster.

withCloudwatchLogsExportConfiguration

public ModifyDBClusterRequest withCloudwatchLogsExportConfiguration(CloudwatchLogsExportConfiguration cloudwatchLogsExportConfiguration)

The configuration setting for the log types to be enabled for export to CloudWatch Logs for a specific DB cluster.

Parameters:

cloudwatchLogsExportConfiguration - The configuration setting for the log types to be enabled for export to CloudWatch Logs for a specific DB cluster.

Returns:

Returns a reference to this object so that method calls can be chained together.

setEngineVersion

public void setEngineVersion(String engineVersion)

The version number of the database engine to which you want to upgrade. Changing this parameter results in an outage. The change is applied during the next maintenance window unless the ApplyImmediately parameter is set to true.

For a list of valid engine versions, see CreateDBCluster, or call DescribeDBEngineVersions.

Parameters:

engineVersion - The version number of the database engine to which you want to upgrade. Changing this parameter results in an outage. The change is applied during the next maintenance window unless the ApplyImmediately parameter is set to true.

For a list of valid engine versions, see CreateDBCluster, or call DescribeDBEngineVersions.

getEngineVersion

public String getEngineVersion()

The version number of the database engine to which you want to upgrade. Changing this parameter results in an outage. The change is applied during the next maintenance window unless the ApplyImmediately parameter is set to true.

For a list of valid engine versions, see CreateDBCluster, or call DescribeDBEngineVersions.

Returns:

The version number of the database engine to which you want to upgrade. Changing this parameter results in an outage. The change is applied during the next maintenance window unless the ApplyImmediately parameter is set to true.

For a list of valid engine versions, see CreateDBCluster, or call DescribeDBEngineVersions.

withEngineVersion

public ModifyDBClusterRequest withEngineVersion(String engineVersion)

The version number of the database engine to which you want to upgrade. Changing this parameter results in an outage. The change is applied during the next maintenance window unless the ApplyImmediately parameter is set to true.

For a list of valid engine versions, see CreateDBCluster, or call DescribeDBEngineVersions.

Parameters:

engineVersion - The version number of the database engine to which you want to upgrade. Changing this parameter results in an outage. The change is applied during the next maintenance window unless the ApplyImmediately parameter is set to true.

For a list of valid engine versions, see CreateDBCluster, or call DescribeDBEngineVersions.

Returns:

Returns a reference to this object so that method calls can be chained together.

setScalingConfiguration

public void setScalingConfiguration(ScalingConfiguration scalingConfiguration)

The scaling properties of the DB cluster. You can only modify scaling properties for DB clusters in serverless DB engine mode.

Parameters:

scalingConfiguration - The scaling properties of the DB cluster. You can only modify scaling properties for DB clusters in serverless DB engine mode.

getScalingConfiguration

public ScalingConfiguration getScalingConfiguration()

The scaling properties of the DB cluster. You can only modify scaling properties for DB clusters in serverless DB engine mode.

Returns:

The scaling properties of the DB cluster. You can only modify scaling properties for DB clusters in serverless DB engine mode.

withScalingConfiguration

public ModifyDBClusterRequest withScalingConfiguration(ScalingConfiguration scalingConfiguration)

The scaling properties of the DB cluster. You can only modify scaling properties for DB clusters in serverless DB engine mode.

Parameters:

scalingConfiguration - The scaling properties of the DB cluster. You can only modify scaling properties for DB clusters in serverless DB engine mode.

Returns:

Returns a reference to this object so that method calls can be chained together.

setDeletionProtection

public void setDeletionProtection(Boolean deletionProtection)

Indicates if the DB cluster has deletion protection enabled. The database can't be deleted when this value is set to true.

Parameters:

deletionProtection - Indicates if the DB cluster has deletion protection enabled. The database can't be deleted when this value is set to true.

getDeletionProtection

public Boolean getDeletionProtection()

Indicates if the DB cluster has deletion protection enabled. The database can't be deleted when this value is set to true.

Returns:

Indicates if the DB cluster has deletion protection enabled. The database can't be deleted when this value is set to true.

withDeletionProtection

public ModifyDBClusterRequest withDeletionProtection(Boolean deletionProtection)

Indicates if the DB cluster has deletion protection enabled. The database can't be deleted when this value is set to true.

Parameters:

deletionProtection - Indicates if the DB cluster has deletion protection enabled. The database can't be deleted when this value is set to true.

Returns:

Returns a reference to this object so that method calls can be chained together.

isDeletionProtection

public Boolean isDeletionProtection()

Indicates if the DB cluster has deletion protection enabled. The database can't be deleted when this value is set to true.

Returns:

Indicates if the DB cluster has deletion protection enabled. The database can't be deleted when this value is set to true.

toString

public String toString()

Returns a string representation of this object; useful for testing and debugging.

Overrides:

toString in class Object

Returns:

A string representation of this object.

See Also:

Object.toString()

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

clone

public ModifyDBClusterRequest clone()

Description copied from class: AmazonWebServiceRequest

Creates a shallow clone of this object for all fields except the handler context. Explicitly does not clone the deep structure of the other fields in the message.

Overrides:

clone in class AmazonWebServiceRequest

See Also:

Object.clone()