com.amazonaws.services.rds.model
Class ModifyDBInstanceRequest

java.lang.Object
  com.amazonaws.AmazonWebServiceRequest
      com.amazonaws.services.rds.model.ModifyDBInstanceRequest

public class ModifyDBInstanceRequest
extends AmazonWebServiceRequest

Container for the parameters to the ModifyDBInstance operation.

Modify settings for a DB Instance. You can change one or more database configuration parameters by specifying these parameters and the new values in the request.

See Also:

AmazonRDS.modifyDBInstance(ModifyDBInstanceRequest)

Constructor Summary

ModifyDBInstanceRequest()
Default constructor for a new ModifyDBInstanceRequest object.

ModifyDBInstanceRequest(String dBInstanceIdentifier)
Constructs a new ModifyDBInstanceRequest object.

Method Summary

boolean	equals(Object obj)
Integer	getAllocatedStorage() The new storage capacity of the RDS instance.
Boolean	getAllowMajorVersionUpgrade() Indicates that major version upgrades are allowed.
Boolean	getApplyImmediately() Specifies whether or not the modifications in this request and any pending modifications are asynchronously applied as soon as possible, regardless of the PreferredMaintenanceWindow setting for the DB Instance.
Boolean	getAutoMinorVersionUpgrade() Indicates that minor version upgrades will be applied automatically to the DB Instance during the maintenance window.
Integer	getBackupRetentionPeriod() The number of days to retain automated backups.
String	getDBInstanceClass() The new compute and memory capacity of the DB Instance.
String	getDBInstanceIdentifier() The DB Instance identifier.
String	getDBParameterGroupName() The name of the DB Parameter Group to apply to this DB Instance.
List<String>	getDBSecurityGroups() A list of DB Security Groups to authorize on this DB Instance.
String	getEngineVersion() The version number of the database engine to upgrade to.
String	getMasterUserPassword() The new password for the DB Instance master user.
Boolean	getMultiAZ() Specifies if the DB Instance is a Multi-AZ deployment.
String	getOptionGroupName() Indicates that the DB Instance should be associated with the specified option group.
String	getPreferredBackupWindow() The daily time range during which automated backups are created if automated backups are enabled, as determined by the BackupRetentionPeriod.
String	getPreferredMaintenanceWindow() The weekly time range (in UTC) during which system maintenance can occur, which may result in an outage.
int	hashCode()
Boolean	isAllowMajorVersionUpgrade() Indicates that major version upgrades are allowed.
Boolean	isApplyImmediately() Specifies whether or not the modifications in this request and any pending modifications are asynchronously applied as soon as possible, regardless of the PreferredMaintenanceWindow setting for the DB Instance.
Boolean	isAutoMinorVersionUpgrade() Indicates that minor version upgrades will be applied automatically to the DB Instance during the maintenance window.
Boolean	isMultiAZ() Specifies if the DB Instance is a Multi-AZ deployment.
void	setAllocatedStorage(Integer allocatedStorage) The new storage capacity of the RDS instance.
void	setAllowMajorVersionUpgrade(Boolean allowMajorVersionUpgrade) Indicates that major version upgrades are allowed.
void	setApplyImmediately(Boolean applyImmediately) Specifies whether or not the modifications in this request and any pending modifications are asynchronously applied as soon as possible, regardless of the PreferredMaintenanceWindow setting for the DB Instance.
void	setAutoMinorVersionUpgrade(Boolean autoMinorVersionUpgrade) Indicates that minor version upgrades will be applied automatically to the DB Instance during the maintenance window.
void	setBackupRetentionPeriod(Integer backupRetentionPeriod) The number of days to retain automated backups.
void	setDBInstanceClass(String dBInstanceClass) The new compute and memory capacity of the DB Instance.
void	setDBInstanceIdentifier(String dBInstanceIdentifier) The DB Instance identifier.
void	setDBParameterGroupName(String dBParameterGroupName) The name of the DB Parameter Group to apply to this DB Instance.
void	setDBSecurityGroups(Collection<String> dBSecurityGroups) A list of DB Security Groups to authorize on this DB Instance.
void	setEngineVersion(String engineVersion) The version number of the database engine to upgrade to.
void	setMasterUserPassword(String masterUserPassword) The new password for the DB Instance master user.
void	setMultiAZ(Boolean multiAZ) Specifies if the DB Instance is a Multi-AZ deployment.
void	setOptionGroupName(String optionGroupName) Indicates that the DB Instance should be associated with the specified option group.
void	setPreferredBackupWindow(String preferredBackupWindow) The daily time range during which automated backups are created if automated backups are enabled, as determined by the BackupRetentionPeriod.
void	setPreferredMaintenanceWindow(String preferredMaintenanceWindow) The weekly time range (in UTC) during which system maintenance can occur, which may result in an outage.
String	toString() Returns a string representation of this object; useful for testing and debugging.
ModifyDBInstanceRequest	withAllocatedStorage(Integer allocatedStorage) The new storage capacity of the RDS instance.
ModifyDBInstanceRequest	withAllowMajorVersionUpgrade(Boolean allowMajorVersionUpgrade) Indicates that major version upgrades are allowed.
ModifyDBInstanceRequest	withApplyImmediately(Boolean applyImmediately) Specifies whether or not the modifications in this request and any pending modifications are asynchronously applied as soon as possible, regardless of the PreferredMaintenanceWindow setting for the DB Instance.
ModifyDBInstanceRequest	withAutoMinorVersionUpgrade(Boolean autoMinorVersionUpgrade) Indicates that minor version upgrades will be applied automatically to the DB Instance during the maintenance window.
ModifyDBInstanceRequest	withBackupRetentionPeriod(Integer backupRetentionPeriod) The number of days to retain automated backups.
ModifyDBInstanceRequest	withDBInstanceClass(String dBInstanceClass) The new compute and memory capacity of the DB Instance.
ModifyDBInstanceRequest	withDBInstanceIdentifier(String dBInstanceIdentifier) The DB Instance identifier.
ModifyDBInstanceRequest	withDBParameterGroupName(String dBParameterGroupName) The name of the DB Parameter Group to apply to this DB Instance.
ModifyDBInstanceRequest	withDBSecurityGroups(Collection<String> dBSecurityGroups) A list of DB Security Groups to authorize on this DB Instance.
ModifyDBInstanceRequest	withDBSecurityGroups(String... dBSecurityGroups) A list of DB Security Groups to authorize on this DB Instance.
ModifyDBInstanceRequest	withEngineVersion(String engineVersion) The version number of the database engine to upgrade to.
ModifyDBInstanceRequest	withMasterUserPassword(String masterUserPassword) The new password for the DB Instance master user.
ModifyDBInstanceRequest	withMultiAZ(Boolean multiAZ) Specifies if the DB Instance is a Multi-AZ deployment.
ModifyDBInstanceRequest	withOptionGroupName(String optionGroupName) Indicates that the DB Instance should be associated with the specified option group.
ModifyDBInstanceRequest	withPreferredBackupWindow(String preferredBackupWindow) The daily time range during which automated backups are created if automated backups are enabled, as determined by the BackupRetentionPeriod.
ModifyDBInstanceRequest	withPreferredMaintenanceWindow(String preferredMaintenanceWindow) The weekly time range (in UTC) during which system maintenance can occur, which may result in an outage.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

copyPrivateRequestParameters, getRequestClientOptions, getRequestCredentials, setRequestCredentials

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

ModifyDBInstanceRequest

public ModifyDBInstanceRequest()

Default constructor for a new ModifyDBInstanceRequest object. Callers should use the setter or fluent setter (with...) methods to initialize this object after creating it.

ModifyDBInstanceRequest

public ModifyDBInstanceRequest(String dBInstanceIdentifier)

Constructs a new ModifyDBInstanceRequest object. Callers should use the setter or fluent setter (with...) methods to initialize any additional object members.

Parameters:

dBInstanceIdentifier - The DB Instance identifier. This value is stored as a lowercase string. For a SQL Server DB Instance, this value cannot be changed.

Constraints:

• Must be the identifier for an existing DB Instance
• 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: mydbinstance

Method Detail

getDBInstanceIdentifier

public String getDBInstanceIdentifier()

The DB Instance identifier. This value is stored as a lowercase string. For a SQL Server DB Instance, this value cannot be changed.

Constraints:

• Must be the identifier for an existing DB Instance
• 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: mydbinstance

Returns:

The DB Instance identifier. This value is stored as a lowercase string. For a SQL Server DB Instance, this value cannot be changed.

Constraints:

• Must be the identifier for an existing DB Instance
• 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: mydbinstance

setDBInstanceIdentifier

public void setDBInstanceIdentifier(String dBInstanceIdentifier)

The DB Instance identifier. This value is stored as a lowercase string. For a SQL Server DB Instance, this value cannot be changed.

Constraints:

• Must be the identifier for an existing DB Instance
• 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: mydbinstance

Parameters:

dBInstanceIdentifier - The DB Instance identifier. This value is stored as a lowercase string. For a SQL Server DB Instance, this value cannot be changed.

Constraints:

• Must be the identifier for an existing DB Instance
• 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: mydbinstance

withDBInstanceIdentifier

public ModifyDBInstanceRequest withDBInstanceIdentifier(String dBInstanceIdentifier)

The DB Instance identifier. This value is stored as a lowercase string. For a SQL Server DB Instance, this value cannot be changed.

Constraints:

• Must be the identifier for an existing DB Instance
• 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: mydbinstance

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

Parameters:

dBInstanceIdentifier - The DB Instance identifier. This value is stored as a lowercase string. For a SQL Server DB Instance, this value cannot be changed.

Constraints:

• Must be the identifier for an existing DB Instance
• 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: mydbinstance

Returns:

A reference to this updated object so that method calls can be chained together.

getAllocatedStorage

public Integer getAllocatedStorage()

The new storage capacity of the RDS instance.

This change does not result in an outage and is applied during the next maintenance window unless the ApplyImmediately parameter is specified as true for this request.

MySQL

Default: Uses existing setting

Valid Values: 5-1024

Constraints: Value supplied must be at least 10% greater than the current value. Values that are not at least 10% greater than the existing value are rounded up so that they are 10% greater than the current value.

Type: Integer

Oracle

Default: Uses existing setting

Valid Values: 10-1024

Constraints: Value supplied must be at least 10% greater than the current value. Values that are not at least 10% greater than the existing value are rounded up so that they are 10% greater than the current value.

SQL Server

Cannot be modified.

Returns:

The new storage capacity of the RDS instance.

This change does not result in an outage and is applied during the next maintenance window unless the ApplyImmediately parameter is specified as true for this request.

MySQL

Default: Uses existing setting

Valid Values: 5-1024

Constraints: Value supplied must be at least 10% greater than the current value. Values that are not at least 10% greater than the existing value are rounded up so that they are 10% greater than the current value.

Type: Integer

Oracle

Default: Uses existing setting

Valid Values: 10-1024

Constraints: Value supplied must be at least 10% greater than the current value. Values that are not at least 10% greater than the existing value are rounded up so that they are 10% greater than the current value.

SQL Server

Cannot be modified.

setAllocatedStorage

public void setAllocatedStorage(Integer allocatedStorage)

The new storage capacity of the RDS instance.

This change does not result in an outage and is applied during the next maintenance window unless the ApplyImmediately parameter is specified as true for this request.

MySQL

Default: Uses existing setting

Valid Values: 5-1024

Constraints: Value supplied must be at least 10% greater than the current value. Values that are not at least 10% greater than the existing value are rounded up so that they are 10% greater than the current value.

Type: Integer

Oracle

Default: Uses existing setting

Valid Values: 10-1024

Constraints: Value supplied must be at least 10% greater than the current value. Values that are not at least 10% greater than the existing value are rounded up so that they are 10% greater than the current value.

SQL Server

Cannot be modified.

Parameters:

allocatedStorage - The new storage capacity of the RDS instance.

This change does not result in an outage and is applied during the next maintenance window unless the ApplyImmediately parameter is specified as true for this request.

MySQL

Default: Uses existing setting

Valid Values: 5-1024

Constraints: Value supplied must be at least 10% greater than the current value. Values that are not at least 10% greater than the existing value are rounded up so that they are 10% greater than the current value.

Type: Integer

Oracle

Default: Uses existing setting

Valid Values: 10-1024

Constraints: Value supplied must be at least 10% greater than the current value. Values that are not at least 10% greater than the existing value are rounded up so that they are 10% greater than the current value.

SQL Server

Cannot be modified.

withAllocatedStorage

public ModifyDBInstanceRequest withAllocatedStorage(Integer allocatedStorage)

The new storage capacity of the RDS instance.

This change does not result in an outage and is applied during the next maintenance window unless the ApplyImmediately parameter is specified as true for this request.

MySQL

Default: Uses existing setting

Valid Values: 5-1024

Constraints: Value supplied must be at least 10% greater than the current value. Values that are not at least 10% greater than the existing value are rounded up so that they are 10% greater than the current value.

Type: Integer

Oracle

Default: Uses existing setting

Valid Values: 10-1024

Constraints: Value supplied must be at least 10% greater than the current value. Values that are not at least 10% greater than the existing value are rounded up so that they are 10% greater than the current value.

SQL Server

Cannot be modified.

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

Parameters:

allocatedStorage - The new storage capacity of the RDS instance.

This change does not result in an outage and is applied during the next maintenance window unless the ApplyImmediately parameter is specified as true for this request.

MySQL

Default: Uses existing setting

Valid Values: 5-1024

Constraints: Value supplied must be at least 10% greater than the current value. Values that are not at least 10% greater than the existing value are rounded up so that they are 10% greater than the current value.

Type: Integer

Oracle

Default: Uses existing setting

Valid Values: 10-1024

Constraints: Value supplied must be at least 10% greater than the current value. Values that are not at least 10% greater than the existing value are rounded up so that they are 10% greater than the current value.

SQL Server

Cannot be modified.

Returns:

A reference to this updated object so that method calls can be chained together.

getDBInstanceClass

public String getDBInstanceClass()

The new compute and memory capacity of the DB Instance. To determine the instance classes that are available for a particular DB engine, use the DescribeOrderableDBInstanceOptions action.

Passing a value for this parameter causes an outage during the change and is applied during the next maintenance window, unless the ApplyImmediately parameter is specified as true for this request.

Default: Uses existing setting

Valid Values: db.t1.micro | db.m1.small | db.m1.large | db.m1.xlarge | db.m2.xlarge | db.m2.2xlarge | db.m2.4xlarge

Returns:

The new compute and memory capacity of the DB Instance. To determine the instance classes that are available for a particular DB engine, use the DescribeOrderableDBInstanceOptions action.

Passing a value for this parameter causes an outage during the change and is applied during the next maintenance window, unless the ApplyImmediately parameter is specified as true for this request.

Default: Uses existing setting

Valid Values: db.t1.micro | db.m1.small | db.m1.large | db.m1.xlarge | db.m2.xlarge | db.m2.2xlarge | db.m2.4xlarge

setDBInstanceClass

public void setDBInstanceClass(String dBInstanceClass)

The new compute and memory capacity of the DB Instance. To determine the instance classes that are available for a particular DB engine, use the DescribeOrderableDBInstanceOptions action.

Passing a value for this parameter causes an outage during the change and is applied during the next maintenance window, unless the ApplyImmediately parameter is specified as true for this request.

Default: Uses existing setting

Valid Values: db.t1.micro | db.m1.small | db.m1.large | db.m1.xlarge | db.m2.xlarge | db.m2.2xlarge | db.m2.4xlarge

Parameters:

dBInstanceClass - The new compute and memory capacity of the DB Instance. To determine the instance classes that are available for a particular DB engine, use the DescribeOrderableDBInstanceOptions action.

Passing a value for this parameter causes an outage during the change and is applied during the next maintenance window, unless the ApplyImmediately parameter is specified as true for this request.

Default: Uses existing setting

Valid Values: db.t1.micro | db.m1.small | db.m1.large | db.m1.xlarge | db.m2.xlarge | db.m2.2xlarge | db.m2.4xlarge

withDBInstanceClass

public ModifyDBInstanceRequest withDBInstanceClass(String dBInstanceClass)

The new compute and memory capacity of the DB Instance. To determine the instance classes that are available for a particular DB engine, use the DescribeOrderableDBInstanceOptions action.

Passing a value for this parameter causes an outage during the change and is applied during the next maintenance window, unless the ApplyImmediately parameter is specified as true for this request.

Default: Uses existing setting

Valid Values: db.t1.micro | db.m1.small | db.m1.large | db.m1.xlarge | db.m2.xlarge | db.m2.2xlarge | db.m2.4xlarge

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

Parameters:

dBInstanceClass - The new compute and memory capacity of the DB Instance. To determine the instance classes that are available for a particular DB engine, use the DescribeOrderableDBInstanceOptions action.

Passing a value for this parameter causes an outage during the change and is applied during the next maintenance window, unless the ApplyImmediately parameter is specified as true for this request.

Default: Uses existing setting

Valid Values: db.t1.micro | db.m1.small | db.m1.large | db.m1.xlarge | db.m2.xlarge | db.m2.2xlarge | db.m2.4xlarge

Returns:

A reference to this updated object so that method calls can be chained together.

getDBSecurityGroups

public List<String> getDBSecurityGroups()

A list of DB Security Groups to authorize on this DB Instance. This change is asynchronously applied as soon as possible.

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:

A list of DB Security Groups to authorize on this DB Instance. This change is asynchronously applied as soon as possible.

Constraints:

• Must be 1 to 255 alphanumeric characters
• First character must be a letter
• Cannot end with a hyphen or contain two consecutive hyphens

setDBSecurityGroups

public void setDBSecurityGroups(Collection<String> dBSecurityGroups)

A list of DB Security Groups to authorize on this DB Instance. This change is asynchronously applied as soon as possible.

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:

dBSecurityGroups - A list of DB Security Groups to authorize on this DB Instance. This change is asynchronously applied as soon as possible.

Constraints:

• Must be 1 to 255 alphanumeric characters
• First character must be a letter
• Cannot end with a hyphen or contain two consecutive hyphens

withDBSecurityGroups

public ModifyDBInstanceRequest withDBSecurityGroups(String... dBSecurityGroups)

A list of DB Security Groups to authorize on this DB Instance. This change is asynchronously applied as soon as possible.

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 a reference to this object so that method calls can be chained together.

Parameters:

dBSecurityGroups - A list of DB Security Groups to authorize on this DB Instance. This change is asynchronously applied as soon as possible.

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:

A reference to this updated object so that method calls can be chained together.

withDBSecurityGroups

public ModifyDBInstanceRequest withDBSecurityGroups(Collection<String> dBSecurityGroups)

A list of DB Security Groups to authorize on this DB Instance. This change is asynchronously applied as soon as possible.

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 a reference to this object so that method calls can be chained together.

Parameters:

dBSecurityGroups - A list of DB Security Groups to authorize on this DB Instance. This change is asynchronously applied as soon as possible.

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:

A reference to this updated object so that method calls can be chained together.

isApplyImmediately

public Boolean isApplyImmediately()

Specifies whether or not the modifications in this request and any pending modifications are asynchronously applied as soon as possible, regardless of the PreferredMaintenanceWindow setting for the DB Instance.

If this parameter is passed as false, changes to the DB Instance are applied on the next call to RebootDBInstance, the next maintenance reboot, or the next failure reboot, whichever occurs first.

Default: false

Returns:

Specifies whether or not the modifications in this request and any pending modifications are asynchronously applied as soon as possible, regardless of the PreferredMaintenanceWindow setting for the DB Instance.

If this parameter is passed as false, changes to the DB Instance are applied on the next call to RebootDBInstance, the next maintenance reboot, or the next failure reboot, whichever occurs first.

Default: false

setApplyImmediately

public void setApplyImmediately(Boolean applyImmediately)

Specifies whether or not the modifications in this request and any pending modifications are asynchronously applied as soon as possible, regardless of the PreferredMaintenanceWindow setting for the DB Instance.

If this parameter is passed as false, changes to the DB Instance are applied on the next call to RebootDBInstance, the next maintenance reboot, or the next failure reboot, whichever occurs first.

Default: false

Parameters:

applyImmediately - Specifies whether or not the modifications in this request and any pending modifications are asynchronously applied as soon as possible, regardless of the PreferredMaintenanceWindow setting for the DB Instance.

If this parameter is passed as false, changes to the DB Instance are applied on the next call to RebootDBInstance, the next maintenance reboot, or the next failure reboot, whichever occurs first.

Default: false

withApplyImmediately

public ModifyDBInstanceRequest withApplyImmediately(Boolean applyImmediately)

Specifies whether or not the modifications in this request and any pending modifications are asynchronously applied as soon as possible, regardless of the PreferredMaintenanceWindow setting for the DB Instance.

If this parameter is passed as false, changes to the DB Instance are applied on the next call to RebootDBInstance, the next maintenance reboot, or the next failure reboot, whichever occurs first.

Default: false

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

Parameters:

applyImmediately - Specifies whether or not the modifications in this request and any pending modifications are asynchronously applied as soon as possible, regardless of the PreferredMaintenanceWindow setting for the DB Instance.

If this parameter is passed as false, changes to the DB Instance are applied on the next call to RebootDBInstance, the next maintenance reboot, or the next failure reboot, whichever occurs first.

Default: false

Returns:

A reference to this updated object so that method calls can be chained together.

getApplyImmediately

public Boolean getApplyImmediately()

Specifies whether or not the modifications in this request and any pending modifications are asynchronously applied as soon as possible, regardless of the PreferredMaintenanceWindow setting for the DB Instance.

If this parameter is passed as false, changes to the DB Instance are applied on the next call to RebootDBInstance, the next maintenance reboot, or the next failure reboot, whichever occurs first.

Default: false

Returns:

Specifies whether or not the modifications in this request and any pending modifications are asynchronously applied as soon as possible, regardless of the PreferredMaintenanceWindow setting for the DB Instance.

If this parameter is passed as false, changes to the DB Instance are applied on the next call to RebootDBInstance, the next maintenance reboot, or the next failure reboot, whichever occurs first.

Default: false

getMasterUserPassword

public String getMasterUserPassword()

The new password for the DB Instance master user. This change is asynchronously applied as soon as possible. Between the time of the request and the completion of the request, the MasterUserPassword element exists in the PendingModifiedValues element of the operation response.

Default: Uses existing setting

Constraints: Must be 8 to 41 alphanumeric characters (MySQL), 8 to 30 alphanumeric characters (Oracle), or 8 to 128 alphanumeric characters (SQL Server). Amazon RDS API actions never return the password, so this action provides a way to regain access to a master instance user if the password is lost.

Returns:

The new password for the DB Instance master user. This change is asynchronously applied as soon as possible. Between the time of the request and the completion of the request, the MasterUserPassword element exists in the PendingModifiedValues element of the operation response.

Default: Uses existing setting

Constraints: Must be 8 to 41 alphanumeric characters (MySQL), 8 to 30 alphanumeric characters (Oracle), or 8 to 128 alphanumeric characters (SQL Server). Amazon RDS API actions never return the password, so this action provides a way to regain access to a master instance user if the password is lost.

setMasterUserPassword

public void setMasterUserPassword(String masterUserPassword)

The new password for the DB Instance master user. This change is asynchronously applied as soon as possible. Between the time of the request and the completion of the request, the MasterUserPassword element exists in the PendingModifiedValues element of the operation response.

Default: Uses existing setting

Constraints: Must be 8 to 41 alphanumeric characters (MySQL), 8 to 30 alphanumeric characters (Oracle), or 8 to 128 alphanumeric characters (SQL Server). Amazon RDS API actions never return the password, so this action provides a way to regain access to a master instance user if the password is lost.

Parameters:

masterUserPassword - The new password for the DB Instance master user. This change is asynchronously applied as soon as possible. Between the time of the request and the completion of the request, the MasterUserPassword element exists in the PendingModifiedValues element of the operation response.

Default: Uses existing setting

Constraints: Must be 8 to 41 alphanumeric characters (MySQL), 8 to 30 alphanumeric characters (Oracle), or 8 to 128 alphanumeric characters (SQL Server). Amazon RDS API actions never return the password, so this action provides a way to regain access to a master instance user if the password is lost.

withMasterUserPassword

public ModifyDBInstanceRequest withMasterUserPassword(String masterUserPassword)

The new password for the DB Instance master user. This change is asynchronously applied as soon as possible. Between the time of the request and the completion of the request, the MasterUserPassword element exists in the PendingModifiedValues element of the operation response.

Default: Uses existing setting

Constraints: Must be 8 to 41 alphanumeric characters (MySQL), 8 to 30 alphanumeric characters (Oracle), or 8 to 128 alphanumeric characters (SQL Server). Amazon RDS API actions never return the password, so this action provides a way to regain access to a master instance user if the password is lost.

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

Parameters:

masterUserPassword - The new password for the DB Instance master user. This change is asynchronously applied as soon as possible. Between the time of the request and the completion of the request, the MasterUserPassword element exists in the PendingModifiedValues element of the operation response.

Default: Uses existing setting

Constraints: Must be 8 to 41 alphanumeric characters (MySQL), 8 to 30 alphanumeric characters (Oracle), or 8 to 128 alphanumeric characters (SQL Server). Amazon RDS API actions never return the password, so this action provides a way to regain access to a master instance user if the password is lost.

Returns:

A reference to this updated object so that method calls can be chained together.

getDBParameterGroupName

public String getDBParameterGroupName()

The name of the DB Parameter Group to apply to this DB Instance. This change is asynchronously applied as soon as possible for parameters when the ApplyImmediately parameter is specified as true for this request.

Default: Uses existing setting

Constraints: The DB Parameter Group must be in the same DB Parameter Group family as this DB Instance.

Returns:

The name of the DB Parameter Group to apply to this DB Instance. This change is asynchronously applied as soon as possible for parameters when the ApplyImmediately parameter is specified as true for this request.

Default: Uses existing setting

Constraints: The DB Parameter Group must be in the same DB Parameter Group family as this DB Instance.

setDBParameterGroupName

public void setDBParameterGroupName(String dBParameterGroupName)

The name of the DB Parameter Group to apply to this DB Instance. This change is asynchronously applied as soon as possible for parameters when the ApplyImmediately parameter is specified as true for this request.

Default: Uses existing setting

Constraints: The DB Parameter Group must be in the same DB Parameter Group family as this DB Instance.

Parameters:

dBParameterGroupName - The name of the DB Parameter Group to apply to this DB Instance. This change is asynchronously applied as soon as possible for parameters when the ApplyImmediately parameter is specified as true for this request.

Default: Uses existing setting

Constraints: The DB Parameter Group must be in the same DB Parameter Group family as this DB Instance.

withDBParameterGroupName

public ModifyDBInstanceRequest withDBParameterGroupName(String dBParameterGroupName)

The name of the DB Parameter Group to apply to this DB Instance. This change is asynchronously applied as soon as possible for parameters when the ApplyImmediately parameter is specified as true for this request.

Default: Uses existing setting

Constraints: The DB Parameter Group must be in the same DB Parameter Group family as this DB Instance.

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

Parameters:

dBParameterGroupName - The name of the DB Parameter Group to apply to this DB Instance. This change is asynchronously applied as soon as possible for parameters when the ApplyImmediately parameter is specified as true for this request.

Default: Uses existing setting

Constraints: The DB Parameter Group must be in the same DB Parameter Group family as this DB Instance.

Returns:

A reference to this updated object so that method calls can be chained together.

getBackupRetentionPeriod

public Integer getBackupRetentionPeriod()

The number of days to retain automated backups. Setting this parameter to a positive number enables backups. Setting this parameter to 0 disables automated backups.

Default: Uses existing setting

Constraints:

• Must be a value from 0 to 8
• Cannot be set to 0 if the DB Instance is a master instance with read replicas or of the DB Instance is a read replica

Returns:

The number of days to retain automated backups. Setting this parameter to a positive number enables backups. Setting this parameter to 0 disables automated backups.

Default: Uses existing setting

Constraints:

• Must be a value from 0 to 8
• Cannot be set to 0 if the DB Instance is a master instance with read replicas or of the DB Instance is a read replica

setBackupRetentionPeriod

public void setBackupRetentionPeriod(Integer backupRetentionPeriod)

The number of days to retain automated backups. Setting this parameter to a positive number enables backups. Setting this parameter to 0 disables automated backups.

Default: Uses existing setting

Constraints:

• Must be a value from 0 to 8
• Cannot be set to 0 if the DB Instance is a master instance with read replicas or of the DB Instance is a read replica

Parameters:

backupRetentionPeriod - The number of days to retain automated backups. Setting this parameter to a positive number enables backups. Setting this parameter to 0 disables automated backups.

Default: Uses existing setting

Constraints:

• Must be a value from 0 to 8
• Cannot be set to 0 if the DB Instance is a master instance with read replicas or of the DB Instance is a read replica

withBackupRetentionPeriod

public ModifyDBInstanceRequest withBackupRetentionPeriod(Integer backupRetentionPeriod)

The number of days to retain automated backups. Setting this parameter to a positive number enables backups. Setting this parameter to 0 disables automated backups.

Default: Uses existing setting

Constraints:

• Must be a value from 0 to 8
• Cannot be set to 0 if the DB Instance is a master instance with read replicas or of the DB Instance is a read replica

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

Parameters:

backupRetentionPeriod - The number of days to retain automated backups. Setting this parameter to a positive number enables backups. Setting this parameter to 0 disables automated backups.

Default: Uses existing setting

Constraints:

• Must be a value from 0 to 8
• Cannot be set to 0 if the DB Instance is a master instance with read replicas or of the DB Instance is a read replica

Returns:

A reference to this updated object so that method calls can be chained together.

getPreferredBackupWindow

public String getPreferredBackupWindow()

The daily time range during which automated backups are created if automated backups are enabled, as determined by the BackupRetentionPeriod.

Constraints:

• Must be in the format hh24:mi-hh24:mi
• Times should be Universal Time Coordinated (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, as determined by the BackupRetentionPeriod.

Constraints:

• Must be in the format hh24:mi-hh24:mi
• Times should be Universal Time Coordinated (UTC)
• Must not conflict with the preferred maintenance window
• Must be at least 30 minutes

setPreferredBackupWindow

public void setPreferredBackupWindow(String preferredBackupWindow)

The daily time range during which automated backups are created if automated backups are enabled, as determined by the BackupRetentionPeriod.

Constraints:

• Must be in the format hh24:mi-hh24:mi
• Times should be Universal Time Coordinated (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, as determined by the BackupRetentionPeriod.

Constraints:

• Must be in the format hh24:mi-hh24:mi
• Times should be Universal Time Coordinated (UTC)
• Must not conflict with the preferred maintenance window
• Must be at least 30 minutes

withPreferredBackupWindow

public ModifyDBInstanceRequest withPreferredBackupWindow(String preferredBackupWindow)

The daily time range during which automated backups are created if automated backups are enabled, as determined by the BackupRetentionPeriod.

Constraints:

• Must be in the format hh24:mi-hh24:mi
• Times should be Universal Time Coordinated (UTC)
• Must not conflict with the preferred maintenance window
• Must be at least 30 minutes

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

Parameters:

preferredBackupWindow - The daily time range during which automated backups are created if automated backups are enabled, as determined by the BackupRetentionPeriod.

Constraints:

• Must be in the format hh24:mi-hh24:mi
• Times should be Universal Time Coordinated (UTC)
• Must not conflict with the preferred maintenance window
• Must be at least 30 minutes

Returns:

A reference to this updated object so that method calls can be chained together.

getPreferredMaintenanceWindow

public String getPreferredMaintenanceWindow()

The weekly time range (in UTC) during which system maintenance can occur, which may result in an outage. This change is made immediately. If moving this window to the current time, there must be at least 120 minutes between the current time and end of the window to ensure pending changes are applied.

Default: Uses existing setting

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

Valid Days: Mon | Tue | Wed | Thu | Fri | Sat | Sun

Constraints: Must be at least 30 minutes

Returns:

The weekly time range (in UTC) during which system maintenance can occur, which may result in an outage. This change is made immediately. If moving this window to the current time, there must be at least 120 minutes between the current time and end of the window to ensure pending changes are applied.

Default: Uses existing setting

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

Valid Days: Mon | Tue | Wed | Thu | Fri | Sat | Sun

Constraints: Must be at least 30 minutes

setPreferredMaintenanceWindow

public void setPreferredMaintenanceWindow(String preferredMaintenanceWindow)

The weekly time range (in UTC) during which system maintenance can occur, which may result in an outage. This change is made immediately. If moving this window to the current time, there must be at least 120 minutes between the current time and end of the window to ensure pending changes are applied.

Default: Uses existing setting

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

Valid Days: Mon | Tue | Wed | Thu | Fri | Sat | Sun

Constraints: Must be at least 30 minutes

Parameters:

preferredMaintenanceWindow - The weekly time range (in UTC) during which system maintenance can occur, which may result in an outage. This change is made immediately. If moving this window to the current time, there must be at least 120 minutes between the current time and end of the window to ensure pending changes are applied.

Default: Uses existing setting

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

Valid Days: Mon | Tue | Wed | Thu | Fri | Sat | Sun

Constraints: Must be at least 30 minutes

withPreferredMaintenanceWindow

public ModifyDBInstanceRequest withPreferredMaintenanceWindow(String preferredMaintenanceWindow)

The weekly time range (in UTC) during which system maintenance can occur, which may result in an outage. This change is made immediately. If moving this window to the current time, there must be at least 120 minutes between the current time and end of the window to ensure pending changes are applied.

Default: Uses existing setting

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

Valid Days: Mon | Tue | Wed | Thu | Fri | Sat | Sun

Constraints: Must be at least 30 minutes

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

Parameters:

preferredMaintenanceWindow - The weekly time range (in UTC) during which system maintenance can occur, which may result in an outage. This change is made immediately. If moving this window to the current time, there must be at least 120 minutes between the current time and end of the window to ensure pending changes are applied.

Default: Uses existing setting

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

Valid Days: Mon | Tue | Wed | Thu | Fri | Sat | Sun

Constraints: Must be at least 30 minutes

Returns:

A reference to this updated object so that method calls can be chained together.

isMultiAZ

public Boolean isMultiAZ()

Specifies if the DB Instance is a Multi-AZ deployment.

Constraints: Cannot be specified if the DB Instance is a read replica.

Returns:

Specifies if the DB Instance is a Multi-AZ deployment.

Constraints: Cannot be specified if the DB Instance is a read replica.

setMultiAZ

public void setMultiAZ(Boolean multiAZ)

Specifies if the DB Instance is a Multi-AZ deployment.

Constraints: Cannot be specified if the DB Instance is a read replica.

Parameters:

multiAZ - Specifies if the DB Instance is a Multi-AZ deployment.

Constraints: Cannot be specified if the DB Instance is a read replica.

withMultiAZ

public ModifyDBInstanceRequest withMultiAZ(Boolean multiAZ)

Specifies if the DB Instance is a Multi-AZ deployment.

Constraints: Cannot be specified if the DB Instance is a read replica.

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

Parameters:

multiAZ - Specifies if the DB Instance is a Multi-AZ deployment.

Constraints: Cannot be specified if the DB Instance is a read replica.

Returns:

A reference to this updated object so that method calls can be chained together.

getMultiAZ

public Boolean getMultiAZ()

Specifies if the DB Instance is a Multi-AZ deployment.

Constraints: Cannot be specified if the DB Instance is a read replica.

Returns:

Specifies if the DB Instance is a Multi-AZ deployment.

Constraints: Cannot be specified if the DB Instance is a read replica.

getEngineVersion

public String getEngineVersion()

The version number of the database engine to upgrade to.

For major version upgrades, if a nondefault DB Parameter Group is currently in use, a new DB Parameter Group in the DB Parameter Group Family for the new engine version must be specified. The new DB Parameter Group can be the default for that DB Parameter Group Family.

Example: 5.1.42

Returns:

The version number of the database engine to upgrade to.

For major version upgrades, if a nondefault DB Parameter Group is currently in use, a new DB Parameter Group in the DB Parameter Group Family for the new engine version must be specified. The new DB Parameter Group can be the default for that DB Parameter Group Family.

Example: 5.1.42

setEngineVersion

public void setEngineVersion(String engineVersion)

The version number of the database engine to upgrade to.

For major version upgrades, if a nondefault DB Parameter Group is currently in use, a new DB Parameter Group in the DB Parameter Group Family for the new engine version must be specified. The new DB Parameter Group can be the default for that DB Parameter Group Family.

Example: 5.1.42

Parameters:

engineVersion - The version number of the database engine to upgrade to.

For major version upgrades, if a nondefault DB Parameter Group is currently in use, a new DB Parameter Group in the DB Parameter Group Family for the new engine version must be specified. The new DB Parameter Group can be the default for that DB Parameter Group Family.

Example: 5.1.42

withEngineVersion

public ModifyDBInstanceRequest withEngineVersion(String engineVersion)

The version number of the database engine to upgrade to.

For major version upgrades, if a nondefault DB Parameter Group is currently in use, a new DB Parameter Group in the DB Parameter Group Family for the new engine version must be specified. The new DB Parameter Group can be the default for that DB Parameter Group Family.

Example: 5.1.42

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

Parameters:

engineVersion - The version number of the database engine to upgrade to.

For major version upgrades, if a nondefault DB Parameter Group is currently in use, a new DB Parameter Group in the DB Parameter Group Family for the new engine version must be specified. The new DB Parameter Group can be the default for that DB Parameter Group Family.

Example: 5.1.42

Returns:

A reference to this updated object so that method calls can be chained together.

isAllowMajorVersionUpgrade

public Boolean isAllowMajorVersionUpgrade()

Indicates that major version upgrades are allowed.

Constraints: This parameter must be set to true when specifying a value for the EngineVersion parameter that is a different major version than the DB Instance's current version.

Returns:

Indicates that major version upgrades are allowed.

Constraints: This parameter must be set to true when specifying a value for the EngineVersion parameter that is a different major version than the DB Instance's current version.

setAllowMajorVersionUpgrade

public void setAllowMajorVersionUpgrade(Boolean allowMajorVersionUpgrade)

Indicates that major version upgrades are allowed.

Constraints: This parameter must be set to true when specifying a value for the EngineVersion parameter that is a different major version than the DB Instance's current version.

Parameters:

allowMajorVersionUpgrade - Indicates that major version upgrades are allowed.

Constraints: This parameter must be set to true when specifying a value for the EngineVersion parameter that is a different major version than the DB Instance's current version.

withAllowMajorVersionUpgrade

public ModifyDBInstanceRequest withAllowMajorVersionUpgrade(Boolean allowMajorVersionUpgrade)

Indicates that major version upgrades are allowed.

Constraints: This parameter must be set to true when specifying a value for the EngineVersion parameter that is a different major version than the DB Instance's current version.

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

Parameters:

allowMajorVersionUpgrade - Indicates that major version upgrades are allowed.

Constraints: This parameter must be set to true when specifying a value for the EngineVersion parameter that is a different major version than the DB Instance's current version.

Returns:

A reference to this updated object so that method calls can be chained together.

getAllowMajorVersionUpgrade

public Boolean getAllowMajorVersionUpgrade()

Indicates that major version upgrades are allowed.

Constraints: This parameter must be set to true when specifying a value for the EngineVersion parameter that is a different major version than the DB Instance's current version.

Returns:

Indicates that major version upgrades are allowed.

Constraints: This parameter must be set to true when specifying a value for the EngineVersion parameter that is a different major version than the DB Instance's current version.

isAutoMinorVersionUpgrade

public Boolean isAutoMinorVersionUpgrade()

Indicates that minor version upgrades will be applied automatically to the DB Instance during the maintenance window.

Returns:

Indicates that minor version upgrades will be applied automatically to the DB Instance during the maintenance window.

setAutoMinorVersionUpgrade

public void setAutoMinorVersionUpgrade(Boolean autoMinorVersionUpgrade)

Indicates that minor version upgrades will be applied automatically to the DB Instance during the maintenance window.

Parameters:

autoMinorVersionUpgrade - Indicates that minor version upgrades will be applied automatically to the DB Instance during the maintenance window.

withAutoMinorVersionUpgrade

public ModifyDBInstanceRequest withAutoMinorVersionUpgrade(Boolean autoMinorVersionUpgrade)

Indicates that minor version upgrades will be applied automatically to the DB Instance during the maintenance window.

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

Parameters:

autoMinorVersionUpgrade - Indicates that minor version upgrades will be applied automatically to the DB Instance during the maintenance window.

Returns:

A reference to this updated object so that method calls can be chained together.

getAutoMinorVersionUpgrade

public Boolean getAutoMinorVersionUpgrade()

Indicates that minor version upgrades will be applied automatically to the DB Instance during the maintenance window.

Returns:

Indicates that minor version upgrades will be applied automatically to the DB Instance during the maintenance window.

getOptionGroupName

public String getOptionGroupName()

Indicates that the DB Instance should be associated with the specified option group.

Returns:

Indicates that the DB Instance should be associated with the specified option group.

setOptionGroupName

public void setOptionGroupName(String optionGroupName)

Indicates that the DB Instance should be associated with the specified option group.

Parameters:

optionGroupName - Indicates that the DB Instance should be associated with the specified option group.

withOptionGroupName

public ModifyDBInstanceRequest withOptionGroupName(String optionGroupName)

Indicates that the DB Instance should be associated with the specified option group.

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

Parameters:

optionGroupName - Indicates that the DB Instance should be associated with the specified option group.

Returns:

A reference to this updated object so that method calls can be chained together.

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()

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object