com.amazonaws.services.rds.model.ModifyDBInstanceRequest Maven / Gradle / Ivy
/*
* Copyright 2010-2014 Amazon.com, Inc. or its affiliates. All Rights Reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License").
* You may not use this file except in compliance with the License.
* A copy of the License is located at
*
* http://aws.amazon.com/apache2.0
*
* or in the "license" file accompanying this file. This file is distributed
* on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either
* express or implied. See the License for the specific language governing
* permissions and limitations under the License.
*/
package com.amazonaws.services.rds.model;
import java.io.Serializable;
import com.amazonaws.AmazonWebServiceRequest;
/**
* Container for the parameters to the {@link com.amazonaws.services.rds.AmazonRDS#modifyDBInstance(ModifyDBInstanceRequest) 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 com.amazonaws.services.rds.AmazonRDS#modifyDBInstance(ModifyDBInstanceRequest)
*/
public class ModifyDBInstanceRequest extends AmazonWebServiceRequest implements Serializable {
/**
* The DB instance identifier. This value is stored as a lowercase
* string. 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
*
*/
private String dBInstanceIdentifier;
/**
* The new storage capacity of the RDS instance. Changing this parameter
* does not result in an outage and the change is applied during the next
* maintenance window unless the ApplyImmediately parameter
* is set to 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.
If you choose to migrate your DB
* instance from using standard storage to using Provisioned IOPS, or
* from using Provisioned IOPS to using standard storage, the process can
* take time. The duration of the migration depends on several factors
* such as database load, storage size, storage type (standard or
* Provisioned IOPS), amount of IOPS provisioned (if any), and the number
* of prior scale storage operations. Typical migration times are under
* 24 hours, but the process can take up to several days in some cases.
* During the migration, the DB instance will be available for use, but
* may experience performance degradation. While the migration takes
* place, nightly backups for the instance will be suspended. No other
* Amazon RDS operations can take place for the instance, including
* modifying the instance, rebooting the instance, deleting the instance,
* creating a read replica for the instance, and creating a DB snapshot
* of the instance.
*/
private Integer allocatedStorage;
/**
* 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.medium |
* db.m1.large | db.m1.xlarge | db.m2.xlarge | db.m2.2xlarge |
* db.m2.4xlarge
*/
private String dBInstanceClass;
/**
* A list of DB security groups to authorize on this DB instance.
* Changing this parameter does not result in an outage and the 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
*/
private com.amazonaws.internal.ListWithAutoConstructFlag dBSecurityGroups;
/**
* A list of EC2 VPC 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
*/
private com.amazonaws.internal.ListWithAutoConstructFlag vpcSecurityGroupIds;
/**
* 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. See each parameter to
* determine when a change is applied.
Default: false
*/
private Boolean applyImmediately;
/**
* The new password for the DB instance master user. Can be any printable
* ASCII character except "/", """, or "@".
Changing this parameter
* does not result in an outage and the 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.
*/
private String masterUserPassword;
/**
* The name of the DB parameter group to apply to this DB instance.
* Changing this parameter does not result in an outage and the change is
* applied during the next maintenance window unless the
* ApplyImmediately parameter is set to 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.
*/
private String dBParameterGroupName;
/**
* 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.
Changing this parameter can result in
* an outage if you change from 0 to a non-zero value or from a non-zero
* value to 0. These changes are applied during the next maintenance
* window unless the ApplyImmediately parameter is set to
* true for this request. If you change the parameter from
* one non-zero value to another non-zero value, the change is
* asynchronously applied as soon as possible.
Default: Uses existing
* setting
Constraints:
- Must be a value from 0 to 35
* - Can be specified for a read replica only if the source is running
* MySQL 5.6
- Cannot be set to 0 if the DB instance is a source
* to read replicas
*/
private Integer backupRetentionPeriod;
/**
* The daily time range during which automated backups are created if
* automated backups are enabled, as determined by the
* BackupRetentionPeriod. Changing this parameter does not
* result in an outage and the change is asynchronously applied as soon
* as possible. 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
*/
private String preferredBackupWindow;
/**
* The weekly time range (in UTC) during which system maintenance can
* occur, which may result in an outage. Changing this parameter does not
* result in an outage, except in the following situation, and the change
* is asynchronously applied as soon as possible. If there are pending
* actions that cause a reboot, and the maintenance window is changed to
* include the current time, then changing this parameter will cause a
* reboot of the DB instance. If moving this window to the current time,
* there must be at least 30 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
*/
private String preferredMaintenanceWindow;
/**
* Specifies if the DB instance is a Multi-AZ deployment. Changing this
* parameter does not result in an outage and the change is applied
* during the next maintenance window unless the
* ApplyImmediately parameter is set to true
* for this request.
Constraints: Cannot be specified if the DB
* instance is a read replica.
*/
private Boolean multiAZ;
/**
* The version number of the database engine to upgrade to. Changing this
* parameter results in an outage and the change is applied during the
* next maintenance window unless the ApplyImmediately
* parameter is set to true for this request.
For major
* version upgrades, if a non-default 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
*/
private String engineVersion;
/**
* Indicates that major version upgrades are allowed. Changing this
* parameter does not result in an outage and the change is
* asynchronously applied as soon as possible.
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.
*/
private Boolean allowMajorVersionUpgrade;
/**
* Indicates that minor version upgrades will be applied automatically to
* the DB instance during the maintenance window. Changing this parameter
* does not result in an outage except in the following case and the
* change is asynchronously applied as soon as possible. An outage will
* result if this parameter is set to true during the
* maintenance window, and a newer minor version is available, and RDS
* has enabled auto patching for that engine version.
*/
private Boolean autoMinorVersionUpgrade;
/**
* The new Provisioned IOPS (I/O operations per second) value for the RDS
* instance. Changing this parameter does not result in an outage and the
* change is applied during the next maintenance window unless the
* ApplyImmediately parameter is set to true
* for this request.
Default: Uses existing setting
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
If you choose to migrate your DB instance from
* using standard storage to using Provisioned IOPS, or from using
* Provisioned IOPS to using standard storage, the process can take time.
* The duration of the migration depends on several factors such as
* database load, storage size, storage type (standard or Provisioned
* IOPS), amount of IOPS provisioned (if any), and the number of prior
* scale storage operations. Typical migration times are under 24 hours,
* but the process can take up to several days in some cases. During the
* migration, the DB instance will be available for use, but may
* experience performance degradation. While the migration takes place,
* nightly backups for the instance will be suspended. No other Amazon
* RDS operations can take place for the instance, including modifying
* the instance, rebooting the instance, deleting the instance, creating
* a read replica for the instance, and creating a DB snapshot of the
* instance.
*/
private Integer iops;
/**
* Indicates that the DB instance should be associated with the specified
* option group. Changing this parameter does not result in an outage
* except in the following case and the change is applied during the next
* maintenance window unless the ApplyImmediately parameter
* is set to true for this request. If the parameter change
* results in an option group that enables OEM, this change can cause a
* brief (sub-second) period during which new connections are rejected
* but existing connections are not interrupted.
Permanent options,
* such as the TDE option for Oracle Advanced Security TDE, cannot be
* removed from an option group, and that option group cannot be removed
* from a DB instance once it is associated with a DB instance
*/
private String optionGroupName;
/**
* The new DB instance identifier for the DB instance when renaming a DB
* Instance. This value is stored as a lowercase string.
Constraints:
*
- Must contain from 1 to 63 alphanumeric characters or
* hyphens
- First character must be a letter
- Cannot end
* with a hyphen or contain two consecutive hyphens
*/
private String newDBInstanceIdentifier;
/**
* Default constructor for a new ModifyDBInstanceRequest object. Callers should use the
* setter or fluent setter (with...) methods to initialize this object after creating it.
*/
public ModifyDBInstanceRequest() {}
/**
* Constructs a new ModifyDBInstanceRequest object.
* Callers should use the setter or fluent setter (with...) methods to
* initialize any additional object members.
*
* @param dBInstanceIdentifier The DB instance identifier. This value is
* stored as a lowercase string. 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
*/
public ModifyDBInstanceRequest(String dBInstanceIdentifier) {
setDBInstanceIdentifier(dBInstanceIdentifier);
}
/**
* The DB instance identifier. This value is stored as a lowercase
* string. 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
*
*
* @return The DB instance identifier. This value is stored as a lowercase
* string. 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
*
*/
public String getDBInstanceIdentifier() {
return dBInstanceIdentifier;
}
/**
* The DB instance identifier. This value is stored as a lowercase
* string. 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
*
*
* @param dBInstanceIdentifier The DB instance identifier. This value is stored as a lowercase
* string. 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
*
*/
public void setDBInstanceIdentifier(String dBInstanceIdentifier) {
this.dBInstanceIdentifier = dBInstanceIdentifier;
}
/**
* The DB instance identifier. This value is stored as a lowercase
* string. 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
*
*
* Returns a reference to this object so that method calls can be chained together.
*
* @param dBInstanceIdentifier The DB instance identifier. This value is stored as a lowercase
* string.
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
*
*
* @return A reference to this updated object so that method calls can be chained
* together.
*/
public ModifyDBInstanceRequest withDBInstanceIdentifier(String dBInstanceIdentifier) {
this.dBInstanceIdentifier = dBInstanceIdentifier;
return this;
}
/**
* The new storage capacity of the RDS instance. Changing this parameter
* does not result in an outage and the change is applied during the next
* maintenance window unless the ApplyImmediately parameter
* is set to 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.
If you choose to migrate your DB
* instance from using standard storage to using Provisioned IOPS, or
* from using Provisioned IOPS to using standard storage, the process can
* take time. The duration of the migration depends on several factors
* such as database load, storage size, storage type (standard or
* Provisioned IOPS), amount of IOPS provisioned (if any), and the number
* of prior scale storage operations. Typical migration times are under
* 24 hours, but the process can take up to several days in some cases.
* During the migration, the DB instance will be available for use, but
* may experience performance degradation. While the migration takes
* place, nightly backups for the instance will be suspended. No other
* Amazon RDS operations can take place for the instance, including
* modifying the instance, rebooting the instance, deleting the instance,
* creating a read replica for the instance, and creating a DB snapshot
* of the instance.
*
* @return The new storage capacity of the RDS instance. Changing this parameter
* does not result in an outage and the change is applied during the next
* maintenance window unless the ApplyImmediately parameter
* is set to 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.
If you choose to migrate your DB
* instance from using standard storage to using Provisioned IOPS, or
* from using Provisioned IOPS to using standard storage, the process can
* take time. The duration of the migration depends on several factors
* such as database load, storage size, storage type (standard or
* Provisioned IOPS), amount of IOPS provisioned (if any), and the number
* of prior scale storage operations. Typical migration times are under
* 24 hours, but the process can take up to several days in some cases.
* During the migration, the DB instance will be available for use, but
* may experience performance degradation. While the migration takes
* place, nightly backups for the instance will be suspended. No other
* Amazon RDS operations can take place for the instance, including
* modifying the instance, rebooting the instance, deleting the instance,
* creating a read replica for the instance, and creating a DB snapshot
* of the instance.
*/
public Integer getAllocatedStorage() {
return allocatedStorage;
}
/**
* The new storage capacity of the RDS instance. Changing this parameter
* does not result in an outage and the change is applied during the next
* maintenance window unless the ApplyImmediately parameter
* is set to 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.
If you choose to migrate your DB
* instance from using standard storage to using Provisioned IOPS, or
* from using Provisioned IOPS to using standard storage, the process can
* take time. The duration of the migration depends on several factors
* such as database load, storage size, storage type (standard or
* Provisioned IOPS), amount of IOPS provisioned (if any), and the number
* of prior scale storage operations. Typical migration times are under
* 24 hours, but the process can take up to several days in some cases.
* During the migration, the DB instance will be available for use, but
* may experience performance degradation. While the migration takes
* place, nightly backups for the instance will be suspended. No other
* Amazon RDS operations can take place for the instance, including
* modifying the instance, rebooting the instance, deleting the instance,
* creating a read replica for the instance, and creating a DB snapshot
* of the instance.
*
* @param allocatedStorage The new storage capacity of the RDS instance. Changing this parameter
* does not result in an outage and the change is applied during the next
* maintenance window unless the ApplyImmediately parameter
* is set to 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.
If you choose to migrate your DB
* instance from using standard storage to using Provisioned IOPS, or
* from using Provisioned IOPS to using standard storage, the process can
* take time. The duration of the migration depends on several factors
* such as database load, storage size, storage type (standard or
* Provisioned IOPS), amount of IOPS provisioned (if any), and the number
* of prior scale storage operations. Typical migration times are under
* 24 hours, but the process can take up to several days in some cases.
* During the migration, the DB instance will be available for use, but
* may experience performance degradation. While the migration takes
* place, nightly backups for the instance will be suspended. No other
* Amazon RDS operations can take place for the instance, including
* modifying the instance, rebooting the instance, deleting the instance,
* creating a read replica for the instance, and creating a DB snapshot
* of the instance.
*/
public void setAllocatedStorage(Integer allocatedStorage) {
this.allocatedStorage = allocatedStorage;
}
/**
* The new storage capacity of the RDS instance. Changing this parameter
* does not result in an outage and the change is applied during the next
* maintenance window unless the ApplyImmediately parameter
* is set to 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.
If you choose to migrate your DB
* instance from using standard storage to using Provisioned IOPS, or
* from using Provisioned IOPS to using standard storage, the process can
* take time. The duration of the migration depends on several factors
* such as database load, storage size, storage type (standard or
* Provisioned IOPS), amount of IOPS provisioned (if any), and the number
* of prior scale storage operations. Typical migration times are under
* 24 hours, but the process can take up to several days in some cases.
* During the migration, the DB instance will be available for use, but
* may experience performance degradation. While the migration takes
* place, nightly backups for the instance will be suspended. No other
* Amazon RDS operations can take place for the instance, including
* modifying the instance, rebooting the instance, deleting the instance,
* creating a read replica for the instance, and creating a DB snapshot
* of the instance.
*
* Returns a reference to this object so that method calls can be chained together.
*
* @param allocatedStorage The new storage capacity of the RDS instance. Changing this parameter
* does not result in an outage and the change is applied during the next
* maintenance window unless the ApplyImmediately parameter
* is set to 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.
If you choose to migrate your DB
* instance from using standard storage to using Provisioned IOPS, or
* from using Provisioned IOPS to using standard storage, the process can
* take time. The duration of the migration depends on several factors
* such as database load, storage size, storage type (standard or
* Provisioned IOPS), amount of IOPS provisioned (if any), and the number
* of prior scale storage operations. Typical migration times are under
* 24 hours, but the process can take up to several days in some cases.
* During the migration, the DB instance will be available for use, but
* may experience performance degradation. While the migration takes
* place, nightly backups for the instance will be suspended. No other
* Amazon RDS operations can take place for the instance, including
* modifying the instance, rebooting the instance, deleting the instance,
* creating a read replica for the instance, and creating a DB snapshot
* of the instance.
*
* @return A reference to this updated object so that method calls can be chained
* together.
*/
public ModifyDBInstanceRequest withAllocatedStorage(Integer allocatedStorage) {
this.allocatedStorage = allocatedStorage;
return this;
}
/**
* 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.medium |
* db.m1.large | db.m1.xlarge | db.m2.xlarge | db.m2.2xlarge |
* db.m2.4xlarge
*
* @return 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.medium |
* db.m1.large | db.m1.xlarge | db.m2.xlarge | db.m2.2xlarge |
* db.m2.4xlarge
*/
public String getDBInstanceClass() {
return 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.medium |
* db.m1.large | db.m1.xlarge | db.m2.xlarge | db.m2.2xlarge |
* db.m2.4xlarge
*
* @param 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.medium |
* db.m1.large | db.m1.xlarge | db.m2.xlarge | db.m2.2xlarge |
* db.m2.4xlarge
*/
public void setDBInstanceClass(String dBInstanceClass) {
this.dBInstanceClass = 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.medium |
* 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.
*
* @param 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.medium |
* db.m1.large | db.m1.xlarge | db.m2.xlarge | db.m2.2xlarge |
* db.m2.4xlarge
*
* @return A reference to this updated object so that method calls can be chained
* together.
*/
public ModifyDBInstanceRequest withDBInstanceClass(String dBInstanceClass) {
this.dBInstanceClass = dBInstanceClass;
return this;
}
/**
* A list of DB security groups to authorize on this DB instance.
* Changing this parameter does not result in an outage and the 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
*
* @return A list of DB security groups to authorize on this DB instance.
* Changing this parameter does not result in an outage and the 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
*/
public java.util.List getDBSecurityGroups() {
if (dBSecurityGroups == null) {
dBSecurityGroups = new com.amazonaws.internal.ListWithAutoConstructFlag();
dBSecurityGroups.setAutoConstruct(true);
}
return dBSecurityGroups;
}
/**
* A list of DB security groups to authorize on this DB instance.
* Changing this parameter does not result in an outage and the 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
*
* @param dBSecurityGroups A list of DB security groups to authorize on this DB instance.
* Changing this parameter does not result in an outage and the 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
*/
public void setDBSecurityGroups(java.util.Collection dBSecurityGroups) {
if (dBSecurityGroups == null) {
this.dBSecurityGroups = null;
return;
}
com.amazonaws.internal.ListWithAutoConstructFlag dBSecurityGroupsCopy = new com.amazonaws.internal.ListWithAutoConstructFlag(dBSecurityGroups.size());
dBSecurityGroupsCopy.addAll(dBSecurityGroups);
this.dBSecurityGroups = dBSecurityGroupsCopy;
}
/**
* A list of DB security groups to authorize on this DB instance.
* Changing this parameter does not result in an outage and the 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.
*
* @param dBSecurityGroups A list of DB security groups to authorize on this DB instance.
* Changing this parameter does not result in an outage and the 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
*
* @return A reference to this updated object so that method calls can be chained
* together.
*/
public ModifyDBInstanceRequest withDBSecurityGroups(String... dBSecurityGroups) {
if (getDBSecurityGroups() == null) setDBSecurityGroups(new java.util.ArrayList(dBSecurityGroups.length));
for (String value : dBSecurityGroups) {
getDBSecurityGroups().add(value);
}
return this;
}
/**
* A list of DB security groups to authorize on this DB instance.
* Changing this parameter does not result in an outage and the 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.
*
* @param dBSecurityGroups A list of DB security groups to authorize on this DB instance.
* Changing this parameter does not result in an outage and the 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
*
* @return A reference to this updated object so that method calls can be chained
* together.
*/
public ModifyDBInstanceRequest withDBSecurityGroups(java.util.Collection dBSecurityGroups) {
if (dBSecurityGroups == null) {
this.dBSecurityGroups = null;
} else {
com.amazonaws.internal.ListWithAutoConstructFlag dBSecurityGroupsCopy = new com.amazonaws.internal.ListWithAutoConstructFlag(dBSecurityGroups.size());
dBSecurityGroupsCopy.addAll(dBSecurityGroups);
this.dBSecurityGroups = dBSecurityGroupsCopy;
}
return this;
}
/**
* A list of EC2 VPC 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
*
* @return A list of EC2 VPC 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
*/
public java.util.List getVpcSecurityGroupIds() {
if (vpcSecurityGroupIds == null) {
vpcSecurityGroupIds = new com.amazonaws.internal.ListWithAutoConstructFlag();
vpcSecurityGroupIds.setAutoConstruct(true);
}
return vpcSecurityGroupIds;
}
/**
* A list of EC2 VPC 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
*
* @param vpcSecurityGroupIds A list of EC2 VPC 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
*/
public void setVpcSecurityGroupIds(java.util.Collection vpcSecurityGroupIds) {
if (vpcSecurityGroupIds == null) {
this.vpcSecurityGroupIds = null;
return;
}
com.amazonaws.internal.ListWithAutoConstructFlag vpcSecurityGroupIdsCopy = new com.amazonaws.internal.ListWithAutoConstructFlag(vpcSecurityGroupIds.size());
vpcSecurityGroupIdsCopy.addAll(vpcSecurityGroupIds);
this.vpcSecurityGroupIds = vpcSecurityGroupIdsCopy;
}
/**
* A list of EC2 VPC 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.
*
* @param vpcSecurityGroupIds A list of EC2 VPC 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
*
* @return A reference to this updated object so that method calls can be chained
* together.
*/
public ModifyDBInstanceRequest withVpcSecurityGroupIds(String... vpcSecurityGroupIds) {
if (getVpcSecurityGroupIds() == null) setVpcSecurityGroupIds(new java.util.ArrayList(vpcSecurityGroupIds.length));
for (String value : vpcSecurityGroupIds) {
getVpcSecurityGroupIds().add(value);
}
return this;
}
/**
* A list of EC2 VPC 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.
*
* @param vpcSecurityGroupIds A list of EC2 VPC 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
*
* @return A reference to this updated object so that method calls can be chained
* together.
*/
public ModifyDBInstanceRequest withVpcSecurityGroupIds(java.util.Collection vpcSecurityGroupIds) {
if (vpcSecurityGroupIds == null) {
this.vpcSecurityGroupIds = null;
} else {
com.amazonaws.internal.ListWithAutoConstructFlag vpcSecurityGroupIdsCopy = new com.amazonaws.internal.ListWithAutoConstructFlag(vpcSecurityGroupIds.size());
vpcSecurityGroupIdsCopy.addAll(vpcSecurityGroupIds);
this.vpcSecurityGroupIds = vpcSecurityGroupIdsCopy;
}
return this;
}
/**
* 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. See each parameter to
* determine when a change is applied.
Default: false
*
* @return 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. See each parameter to
* determine when a change is applied.
Default: false
*/
public Boolean isApplyImmediately() {
return 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. See each parameter to
* determine when a change is applied.
Default: false
*
* @param 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. See each parameter to
* determine when a change is applied.
Default: false
*/
public void setApplyImmediately(Boolean applyImmediately) {
this.applyImmediately = 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. See each parameter to
* determine when a change is applied.
Default: false
*
* Returns a reference to this object so that method calls can be chained together.
*
* @param 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. See each parameter to
* determine when a change is applied.
Default: false
*
* @return A reference to this updated object so that method calls can be chained
* together.
*/
public ModifyDBInstanceRequest withApplyImmediately(Boolean applyImmediately) {
this.applyImmediately = applyImmediately;
return this;
}
/**
* 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. See each parameter to
* determine when a change is applied.
Default: false
*
* @return 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. See each parameter to
* determine when a change is applied.
Default: false
*/
public Boolean getApplyImmediately() {
return applyImmediately;
}
/**
* The new password for the DB instance master user. Can be any printable
* ASCII character except "/", """, or "@".
Changing this parameter
* does not result in an outage and the 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.
*
* @return The new password for the DB instance master user. Can be any printable
* ASCII character except "/", """, or "@".
Changing this parameter
* does not result in an outage and the 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.
*/
public String getMasterUserPassword() {
return masterUserPassword;
}
/**
* The new password for the DB instance master user. Can be any printable
* ASCII character except "/", """, or "@".
Changing this parameter
* does not result in an outage and the 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.
*
* @param masterUserPassword The new password for the DB instance master user. Can be any printable
* ASCII character except "/", """, or "@".
Changing this parameter
* does not result in an outage and the 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.
*/
public void setMasterUserPassword(String masterUserPassword) {
this.masterUserPassword = masterUserPassword;
}
/**
* The new password for the DB instance master user. Can be any printable
* ASCII character except "/", """, or "@".
Changing this parameter
* does not result in an outage and the 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.
*
* @param masterUserPassword The new password for the DB instance master user. Can be any printable
* ASCII character except "/", """, or "@".
Changing this parameter
* does not result in an outage and the 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.
*
* @return A reference to this updated object so that method calls can be chained
* together.
*/
public ModifyDBInstanceRequest withMasterUserPassword(String masterUserPassword) {
this.masterUserPassword = masterUserPassword;
return this;
}
/**
* The name of the DB parameter group to apply to this DB instance.
* Changing this parameter does not result in an outage and the change is
* applied during the next maintenance window unless the
* ApplyImmediately parameter is set to 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.
*
* @return The name of the DB parameter group to apply to this DB instance.
* Changing this parameter does not result in an outage and the change is
* applied during the next maintenance window unless the
* ApplyImmediately parameter is set to 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.
*/
public String getDBParameterGroupName() {
return dBParameterGroupName;
}
/**
* The name of the DB parameter group to apply to this DB instance.
* Changing this parameter does not result in an outage and the change is
* applied during the next maintenance window unless the
* ApplyImmediately parameter is set to 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.
*
* @param dBParameterGroupName The name of the DB parameter group to apply to this DB instance.
* Changing this parameter does not result in an outage and the change is
* applied during the next maintenance window unless the
* ApplyImmediately parameter is set to 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.
*/
public void setDBParameterGroupName(String dBParameterGroupName) {
this.dBParameterGroupName = dBParameterGroupName;
}
/**
* The name of the DB parameter group to apply to this DB instance.
* Changing this parameter does not result in an outage and the change is
* applied during the next maintenance window unless the
* ApplyImmediately parameter is set to 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.
*
* @param dBParameterGroupName The name of the DB parameter group to apply to this DB instance.
* Changing this parameter does not result in an outage and the change is
* applied during the next maintenance window unless the
* ApplyImmediately parameter is set to 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.
*
* @return A reference to this updated object so that method calls can be chained
* together.
*/
public ModifyDBInstanceRequest withDBParameterGroupName(String dBParameterGroupName) {
this.dBParameterGroupName = dBParameterGroupName;
return this;
}
/**
* 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.
Changing this parameter can result in
* an outage if you change from 0 to a non-zero value or from a non-zero
* value to 0. These changes are applied during the next maintenance
* window unless the ApplyImmediately parameter is set to
* true for this request. If you change the parameter from
* one non-zero value to another non-zero value, the change is
* asynchronously applied as soon as possible.
Default: Uses existing
* setting
Constraints:
- Must be a value from 0 to 35
* - Can be specified for a read replica only if the source is running
* MySQL 5.6
- Cannot be set to 0 if the DB instance is a source
* to read replicas
*
* @return 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. Changing this parameter can result in
* an outage if you change from 0 to a non-zero value or from a non-zero
* value to 0. These changes are applied during the next maintenance
* window unless the ApplyImmediately parameter is set to
* true for this request. If you change the parameter from
* one non-zero value to another non-zero value, the change is
* asynchronously applied as soon as possible.
Default: Uses existing
* setting
Constraints:
- Must be a value from 0 to 35
* - Can be specified for a read replica only if the source is running
* MySQL 5.6
- Cannot be set to 0 if the DB instance is a source
* to read replicas
*/
public Integer getBackupRetentionPeriod() {
return 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. Changing this parameter can result in
* an outage if you change from 0 to a non-zero value or from a non-zero
* value to 0. These changes are applied during the next maintenance
* window unless the ApplyImmediately parameter is set to
* true for this request. If you change the parameter from
* one non-zero value to another non-zero value, the change is
* asynchronously applied as soon as possible.
Default: Uses existing
* setting
Constraints:
- Must be a value from 0 to 35
* - Can be specified for a read replica only if the source is running
* MySQL 5.6
- Cannot be set to 0 if the DB instance is a source
* to read replicas
*
* @param 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. Changing this parameter can result in
* an outage if you change from 0 to a non-zero value or from a non-zero
* value to 0. These changes are applied during the next maintenance
* window unless the ApplyImmediately parameter is set to
* true for this request. If you change the parameter from
* one non-zero value to another non-zero value, the change is
* asynchronously applied as soon as possible.
Default: Uses existing
* setting
Constraints:
- Must be a value from 0 to 35
* - Can be specified for a read replica only if the source is running
* MySQL 5.6
- Cannot be set to 0 if the DB instance is a source
* to read replicas
*/
public void setBackupRetentionPeriod(Integer backupRetentionPeriod) {
this.backupRetentionPeriod = 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. Changing this parameter can result in
* an outage if you change from 0 to a non-zero value or from a non-zero
* value to 0. These changes are applied during the next maintenance
* window unless the ApplyImmediately parameter is set to
* true for this request. If you change the parameter from
* one non-zero value to another non-zero value, the change is
* asynchronously applied as soon as possible.
Default: Uses existing
* setting
Constraints:
- Must be a value from 0 to 35
* - Can be specified for a read replica only if the source is running
* MySQL 5.6
- Cannot be set to 0 if the DB instance is a source
* to read replicas
*
* Returns a reference to this object so that method calls can be chained together.
*
* @param 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.
Changing this parameter can result in
* an outage if you change from 0 to a non-zero value or from a non-zero
* value to 0. These changes are applied during the next maintenance
* window unless the ApplyImmediately parameter is set to
* true for this request. If you change the parameter from
* one non-zero value to another non-zero value, the change is
* asynchronously applied as soon as possible.
Default: Uses existing
* setting
Constraints:
- Must be a value from 0 to 35
* - Can be specified for a read replica only if the source is running
* MySQL 5.6
- Cannot be set to 0 if the DB instance is a source
* to read replicas
*
* @return A reference to this updated object so that method calls can be chained
* together.
*/
public ModifyDBInstanceRequest withBackupRetentionPeriod(Integer backupRetentionPeriod) {
this.backupRetentionPeriod = backupRetentionPeriod;
return this;
}
/**
* The daily time range during which automated backups are created if
* automated backups are enabled, as determined by the
* BackupRetentionPeriod. Changing this parameter does not
* result in an outage and the change is asynchronously applied as soon
* as possible. 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
*
* @return The daily time range during which automated backups are created if
* automated backups are enabled, as determined by the
* BackupRetentionPeriod. Changing this parameter does not
* result in an outage and the change is asynchronously applied as soon
* as possible. 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
*/
public String getPreferredBackupWindow() {
return preferredBackupWindow;
}
/**
* The daily time range during which automated backups are created if
* automated backups are enabled, as determined by the
* BackupRetentionPeriod. Changing this parameter does not
* result in an outage and the change is asynchronously applied as soon
* as possible. 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
*
* @param preferredBackupWindow The daily time range during which automated backups are created if
* automated backups are enabled, as determined by the
* BackupRetentionPeriod. Changing this parameter does not
* result in an outage and the change is asynchronously applied as soon
* as possible. 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
*/
public void setPreferredBackupWindow(String preferredBackupWindow) {
this.preferredBackupWindow = preferredBackupWindow;
}
/**
* The daily time range during which automated backups are created if
* automated backups are enabled, as determined by the
* BackupRetentionPeriod. Changing this parameter does not
* result in an outage and the change is asynchronously applied as soon
* as possible. 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.
*
* @param preferredBackupWindow The daily time range during which automated backups are created if
* automated backups are enabled, as determined by the
* BackupRetentionPeriod. Changing this parameter does not
* result in an outage and the change is asynchronously applied as soon
* as possible.
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
*
* @return A reference to this updated object so that method calls can be chained
* together.
*/
public ModifyDBInstanceRequest withPreferredBackupWindow(String preferredBackupWindow) {
this.preferredBackupWindow = preferredBackupWindow;
return this;
}
/**
* The weekly time range (in UTC) during which system maintenance can
* occur, which may result in an outage. Changing this parameter does not
* result in an outage, except in the following situation, and the change
* is asynchronously applied as soon as possible. If there are pending
* actions that cause a reboot, and the maintenance window is changed to
* include the current time, then changing this parameter will cause a
* reboot of the DB instance. If moving this window to the current time,
* there must be at least 30 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
*
* @return The weekly time range (in UTC) during which system maintenance can
* occur, which may result in an outage. Changing this parameter does not
* result in an outage, except in the following situation, and the change
* is asynchronously applied as soon as possible. If there are pending
* actions that cause a reboot, and the maintenance window is changed to
* include the current time, then changing this parameter will cause a
* reboot of the DB instance. If moving this window to the current time,
* there must be at least 30 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
*/
public String getPreferredMaintenanceWindow() {
return preferredMaintenanceWindow;
}
/**
* The weekly time range (in UTC) during which system maintenance can
* occur, which may result in an outage. Changing this parameter does not
* result in an outage, except in the following situation, and the change
* is asynchronously applied as soon as possible. If there are pending
* actions that cause a reboot, and the maintenance window is changed to
* include the current time, then changing this parameter will cause a
* reboot of the DB instance. If moving this window to the current time,
* there must be at least 30 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
*
* @param preferredMaintenanceWindow The weekly time range (in UTC) during which system maintenance can
* occur, which may result in an outage. Changing this parameter does not
* result in an outage, except in the following situation, and the change
* is asynchronously applied as soon as possible. If there are pending
* actions that cause a reboot, and the maintenance window is changed to
* include the current time, then changing this parameter will cause a
* reboot of the DB instance. If moving this window to the current time,
* there must be at least 30 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
*/
public void setPreferredMaintenanceWindow(String preferredMaintenanceWindow) {
this.preferredMaintenanceWindow = preferredMaintenanceWindow;
}
/**
* The weekly time range (in UTC) during which system maintenance can
* occur, which may result in an outage. Changing this parameter does not
* result in an outage, except in the following situation, and the change
* is asynchronously applied as soon as possible. If there are pending
* actions that cause a reboot, and the maintenance window is changed to
* include the current time, then changing this parameter will cause a
* reboot of the DB instance. If moving this window to the current time,
* there must be at least 30 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.
*
* @param preferredMaintenanceWindow The weekly time range (in UTC) during which system maintenance can
* occur, which may result in an outage. Changing this parameter does not
* result in an outage, except in the following situation, and the change
* is asynchronously applied as soon as possible. If there are pending
* actions that cause a reboot, and the maintenance window is changed to
* include the current time, then changing this parameter will cause a
* reboot of the DB instance. If moving this window to the current time,
* there must be at least 30 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
*
* @return A reference to this updated object so that method calls can be chained
* together.
*/
public ModifyDBInstanceRequest withPreferredMaintenanceWindow(String preferredMaintenanceWindow) {
this.preferredMaintenanceWindow = preferredMaintenanceWindow;
return this;
}
/**
* Specifies if the DB instance is a Multi-AZ deployment. Changing this
* parameter does not result in an outage and the change is applied
* during the next maintenance window unless the
* ApplyImmediately parameter is set to true
* for this request.
Constraints: Cannot be specified if the DB
* instance is a read replica.
*
* @return Specifies if the DB instance is a Multi-AZ deployment. Changing this
* parameter does not result in an outage and the change is applied
* during the next maintenance window unless the
* ApplyImmediately parameter is set to true
* for this request.
Constraints: Cannot be specified if the DB
* instance is a read replica.
*/
public Boolean isMultiAZ() {
return multiAZ;
}
/**
* Specifies if the DB instance is a Multi-AZ deployment. Changing this
* parameter does not result in an outage and the change is applied
* during the next maintenance window unless the
* ApplyImmediately parameter is set to true
* for this request.
Constraints: Cannot be specified if the DB
* instance is a read replica.
*
* @param multiAZ Specifies if the DB instance is a Multi-AZ deployment. Changing this
* parameter does not result in an outage and the change is applied
* during the next maintenance window unless the
* ApplyImmediately parameter is set to true
* for this request.
Constraints: Cannot be specified if the DB
* instance is a read replica.
*/
public void setMultiAZ(Boolean multiAZ) {
this.multiAZ = multiAZ;
}
/**
* Specifies if the DB instance is a Multi-AZ deployment. Changing this
* parameter does not result in an outage and the change is applied
* during the next maintenance window unless the
* ApplyImmediately parameter is set to true
* for this request.
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.
*
* @param multiAZ Specifies if the DB instance is a Multi-AZ deployment. Changing this
* parameter does not result in an outage and the change is applied
* during the next maintenance window unless the
* ApplyImmediately parameter is set to true
* for this request.
Constraints: Cannot be specified if the DB
* instance is a read replica.
*
* @return A reference to this updated object so that method calls can be chained
* together.
*/
public ModifyDBInstanceRequest withMultiAZ(Boolean multiAZ) {
this.multiAZ = multiAZ;
return this;
}
/**
* Specifies if the DB instance is a Multi-AZ deployment. Changing this
* parameter does not result in an outage and the change is applied
* during the next maintenance window unless the
* ApplyImmediately parameter is set to true
* for this request.
Constraints: Cannot be specified if the DB
* instance is a read replica.
*
* @return Specifies if the DB instance is a Multi-AZ deployment. Changing this
* parameter does not result in an outage and the change is applied
* during the next maintenance window unless the
* ApplyImmediately parameter is set to true
* for this request.
Constraints: Cannot be specified if the DB
* instance is a read replica.
*/
public Boolean getMultiAZ() {
return multiAZ;
}
/**
* The version number of the database engine to upgrade to. Changing this
* parameter results in an outage and the change is applied during the
* next maintenance window unless the ApplyImmediately
* parameter is set to true for this request.
For major
* version upgrades, if a non-default 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
*
* @return The version number of the database engine to upgrade to. Changing this
* parameter results in an outage and the change is applied during the
* next maintenance window unless the ApplyImmediately
* parameter is set to true for this request.
For major
* version upgrades, if a non-default 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
*/
public String getEngineVersion() {
return engineVersion;
}
/**
* The version number of the database engine to upgrade to. Changing this
* parameter results in an outage and the change is applied during the
* next maintenance window unless the ApplyImmediately
* parameter is set to true for this request.
For major
* version upgrades, if a non-default 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
*
* @param engineVersion The version number of the database engine to upgrade to. Changing this
* parameter results in an outage and the change is applied during the
* next maintenance window unless the ApplyImmediately
* parameter is set to true for this request.
For major
* version upgrades, if a non-default 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
*/
public void setEngineVersion(String engineVersion) {
this.engineVersion = engineVersion;
}
/**
* The version number of the database engine to upgrade to. Changing this
* parameter results in an outage and the change is applied during the
* next maintenance window unless the ApplyImmediately
* parameter is set to true for this request.
For major
* version upgrades, if a non-default 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.
*
* @param engineVersion The version number of the database engine to upgrade to. Changing this
* parameter results in an outage and the change is applied during the
* next maintenance window unless the ApplyImmediately
* parameter is set to true for this request.
For major
* version upgrades, if a non-default 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
*
* @return A reference to this updated object so that method calls can be chained
* together.
*/
public ModifyDBInstanceRequest withEngineVersion(String engineVersion) {
this.engineVersion = engineVersion;
return this;
}
/**
* Indicates that major version upgrades are allowed. Changing this
* parameter does not result in an outage and the change is
* asynchronously applied as soon as possible.
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.
*
* @return Indicates that major version upgrades are allowed. Changing this
* parameter does not result in an outage and the change is
* asynchronously applied as soon as possible.
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.
*/
public Boolean isAllowMajorVersionUpgrade() {
return allowMajorVersionUpgrade;
}
/**
* Indicates that major version upgrades are allowed. Changing this
* parameter does not result in an outage and the change is
* asynchronously applied as soon as possible.
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.
*
* @param allowMajorVersionUpgrade Indicates that major version upgrades are allowed. Changing this
* parameter does not result in an outage and the change is
* asynchronously applied as soon as possible.
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.
*/
public void setAllowMajorVersionUpgrade(Boolean allowMajorVersionUpgrade) {
this.allowMajorVersionUpgrade = allowMajorVersionUpgrade;
}
/**
* Indicates that major version upgrades are allowed. Changing this
* parameter does not result in an outage and the change is
* asynchronously applied as soon as possible.
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.
*
* @param allowMajorVersionUpgrade Indicates that major version upgrades are allowed. Changing this
* parameter does not result in an outage and the change is
* asynchronously applied as soon as possible.
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.
*
* @return A reference to this updated object so that method calls can be chained
* together.
*/
public ModifyDBInstanceRequest withAllowMajorVersionUpgrade(Boolean allowMajorVersionUpgrade) {
this.allowMajorVersionUpgrade = allowMajorVersionUpgrade;
return this;
}
/**
* Indicates that major version upgrades are allowed. Changing this
* parameter does not result in an outage and the change is
* asynchronously applied as soon as possible.
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.
*
* @return Indicates that major version upgrades are allowed. Changing this
* parameter does not result in an outage and the change is
* asynchronously applied as soon as possible.
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.
*/
public Boolean getAllowMajorVersionUpgrade() {
return allowMajorVersionUpgrade;
}
/**
* Indicates that minor version upgrades will be applied automatically to
* the DB instance during the maintenance window. Changing this parameter
* does not result in an outage except in the following case and the
* change is asynchronously applied as soon as possible. An outage will
* result if this parameter is set to true during the
* maintenance window, and a newer minor version is available, and RDS
* has enabled auto patching for that engine version.
*
* @return Indicates that minor version upgrades will be applied automatically to
* the DB instance during the maintenance window. Changing this parameter
* does not result in an outage except in the following case and the
* change is asynchronously applied as soon as possible. An outage will
* result if this parameter is set to true during the
* maintenance window, and a newer minor version is available, and RDS
* has enabled auto patching for that engine version.
*/
public Boolean isAutoMinorVersionUpgrade() {
return autoMinorVersionUpgrade;
}
/**
* Indicates that minor version upgrades will be applied automatically to
* the DB instance during the maintenance window. Changing this parameter
* does not result in an outage except in the following case and the
* change is asynchronously applied as soon as possible. An outage will
* result if this parameter is set to true during the
* maintenance window, and a newer minor version is available, and RDS
* has enabled auto patching for that engine version.
*
* @param autoMinorVersionUpgrade Indicates that minor version upgrades will be applied automatically to
* the DB instance during the maintenance window. Changing this parameter
* does not result in an outage except in the following case and the
* change is asynchronously applied as soon as possible. An outage will
* result if this parameter is set to true during the
* maintenance window, and a newer minor version is available, and RDS
* has enabled auto patching for that engine version.
*/
public void setAutoMinorVersionUpgrade(Boolean autoMinorVersionUpgrade) {
this.autoMinorVersionUpgrade = autoMinorVersionUpgrade;
}
/**
* Indicates that minor version upgrades will be applied automatically to
* the DB instance during the maintenance window. Changing this parameter
* does not result in an outage except in the following case and the
* change is asynchronously applied as soon as possible. An outage will
* result if this parameter is set to true during the
* maintenance window, and a newer minor version is available, and RDS
* has enabled auto patching for that engine version.
*
* Returns a reference to this object so that method calls can be chained together.
*
* @param autoMinorVersionUpgrade Indicates that minor version upgrades will be applied automatically to
* the DB instance during the maintenance window. Changing this parameter
* does not result in an outage except in the following case and the
* change is asynchronously applied as soon as possible. An outage will
* result if this parameter is set to true during the
* maintenance window, and a newer minor version is available, and RDS
* has enabled auto patching for that engine version.
*
* @return A reference to this updated object so that method calls can be chained
* together.
*/
public ModifyDBInstanceRequest withAutoMinorVersionUpgrade(Boolean autoMinorVersionUpgrade) {
this.autoMinorVersionUpgrade = autoMinorVersionUpgrade;
return this;
}
/**
* Indicates that minor version upgrades will be applied automatically to
* the DB instance during the maintenance window. Changing this parameter
* does not result in an outage except in the following case and the
* change is asynchronously applied as soon as possible. An outage will
* result if this parameter is set to true during the
* maintenance window, and a newer minor version is available, and RDS
* has enabled auto patching for that engine version.
*
* @return Indicates that minor version upgrades will be applied automatically to
* the DB instance during the maintenance window. Changing this parameter
* does not result in an outage except in the following case and the
* change is asynchronously applied as soon as possible. An outage will
* result if this parameter is set to true during the
* maintenance window, and a newer minor version is available, and RDS
* has enabled auto patching for that engine version.
*/
public Boolean getAutoMinorVersionUpgrade() {
return autoMinorVersionUpgrade;
}
/**
* The new Provisioned IOPS (I/O operations per second) value for the RDS
* instance. Changing this parameter does not result in an outage and the
* change is applied during the next maintenance window unless the
* ApplyImmediately parameter is set to true
* for this request.
Default: Uses existing setting
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
If you choose to migrate your DB instance from
* using standard storage to using Provisioned IOPS, or from using
* Provisioned IOPS to using standard storage, the process can take time.
* The duration of the migration depends on several factors such as
* database load, storage size, storage type (standard or Provisioned
* IOPS), amount of IOPS provisioned (if any), and the number of prior
* scale storage operations. Typical migration times are under 24 hours,
* but the process can take up to several days in some cases. During the
* migration, the DB instance will be available for use, but may
* experience performance degradation. While the migration takes place,
* nightly backups for the instance will be suspended. No other Amazon
* RDS operations can take place for the instance, including modifying
* the instance, rebooting the instance, deleting the instance, creating
* a read replica for the instance, and creating a DB snapshot of the
* instance.
*
* @return The new Provisioned IOPS (I/O operations per second) value for the RDS
* instance. Changing this parameter does not result in an outage and the
* change is applied during the next maintenance window unless the
* ApplyImmediately parameter is set to true
* for this request.
Default: Uses existing setting
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
If you choose to migrate your DB instance from
* using standard storage to using Provisioned IOPS, or from using
* Provisioned IOPS to using standard storage, the process can take time.
* The duration of the migration depends on several factors such as
* database load, storage size, storage type (standard or Provisioned
* IOPS), amount of IOPS provisioned (if any), and the number of prior
* scale storage operations. Typical migration times are under 24 hours,
* but the process can take up to several days in some cases. During the
* migration, the DB instance will be available for use, but may
* experience performance degradation. While the migration takes place,
* nightly backups for the instance will be suspended. No other Amazon
* RDS operations can take place for the instance, including modifying
* the instance, rebooting the instance, deleting the instance, creating
* a read replica for the instance, and creating a DB snapshot of the
* instance.
*/
public Integer getIops() {
return iops;
}
/**
* The new Provisioned IOPS (I/O operations per second) value for the RDS
* instance. Changing this parameter does not result in an outage and the
* change is applied during the next maintenance window unless the
* ApplyImmediately parameter is set to true
* for this request.
Default: Uses existing setting
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
If you choose to migrate your DB instance from
* using standard storage to using Provisioned IOPS, or from using
* Provisioned IOPS to using standard storage, the process can take time.
* The duration of the migration depends on several factors such as
* database load, storage size, storage type (standard or Provisioned
* IOPS), amount of IOPS provisioned (if any), and the number of prior
* scale storage operations. Typical migration times are under 24 hours,
* but the process can take up to several days in some cases. During the
* migration, the DB instance will be available for use, but may
* experience performance degradation. While the migration takes place,
* nightly backups for the instance will be suspended. No other Amazon
* RDS operations can take place for the instance, including modifying
* the instance, rebooting the instance, deleting the instance, creating
* a read replica for the instance, and creating a DB snapshot of the
* instance.
*
* @param iops The new Provisioned IOPS (I/O operations per second) value for the RDS
* instance. Changing this parameter does not result in an outage and the
* change is applied during the next maintenance window unless the
* ApplyImmediately parameter is set to true
* for this request.
Default: Uses existing setting
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
If you choose to migrate your DB instance from
* using standard storage to using Provisioned IOPS, or from using
* Provisioned IOPS to using standard storage, the process can take time.
* The duration of the migration depends on several factors such as
* database load, storage size, storage type (standard or Provisioned
* IOPS), amount of IOPS provisioned (if any), and the number of prior
* scale storage operations. Typical migration times are under 24 hours,
* but the process can take up to several days in some cases. During the
* migration, the DB instance will be available for use, but may
* experience performance degradation. While the migration takes place,
* nightly backups for the instance will be suspended. No other Amazon
* RDS operations can take place for the instance, including modifying
* the instance, rebooting the instance, deleting the instance, creating
* a read replica for the instance, and creating a DB snapshot of the
* instance.
*/
public void setIops(Integer iops) {
this.iops = iops;
}
/**
* The new Provisioned IOPS (I/O operations per second) value for the RDS
* instance. Changing this parameter does not result in an outage and the
* change is applied during the next maintenance window unless the
* ApplyImmediately parameter is set to true
* for this request.
Default: Uses existing setting
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
If you choose to migrate your DB instance from
* using standard storage to using Provisioned IOPS, or from using
* Provisioned IOPS to using standard storage, the process can take time.
* The duration of the migration depends on several factors such as
* database load, storage size, storage type (standard or Provisioned
* IOPS), amount of IOPS provisioned (if any), and the number of prior
* scale storage operations. Typical migration times are under 24 hours,
* but the process can take up to several days in some cases. During the
* migration, the DB instance will be available for use, but may
* experience performance degradation. While the migration takes place,
* nightly backups for the instance will be suspended. No other Amazon
* RDS operations can take place for the instance, including modifying
* the instance, rebooting the instance, deleting the instance, creating
* a read replica for the instance, and creating a DB snapshot of the
* instance.
*
* Returns a reference to this object so that method calls can be chained together.
*
* @param iops The new Provisioned IOPS (I/O operations per second) value for the RDS
* instance. Changing this parameter does not result in an outage and the
* change is applied during the next maintenance window unless the
* ApplyImmediately parameter is set to true
* for this request.
Default: Uses existing setting
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
If you choose to migrate your DB instance from
* using standard storage to using Provisioned IOPS, or from using
* Provisioned IOPS to using standard storage, the process can take time.
* The duration of the migration depends on several factors such as
* database load, storage size, storage type (standard or Provisioned
* IOPS), amount of IOPS provisioned (if any), and the number of prior
* scale storage operations. Typical migration times are under 24 hours,
* but the process can take up to several days in some cases. During the
* migration, the DB instance will be available for use, but may
* experience performance degradation. While the migration takes place,
* nightly backups for the instance will be suspended. No other Amazon
* RDS operations can take place for the instance, including modifying
* the instance, rebooting the instance, deleting the instance, creating
* a read replica for the instance, and creating a DB snapshot of the
* instance.
*
* @return A reference to this updated object so that method calls can be chained
* together.
*/
public ModifyDBInstanceRequest withIops(Integer iops) {
this.iops = iops;
return this;
}
/**
* Indicates that the DB instance should be associated with the specified
* option group. Changing this parameter does not result in an outage
* except in the following case and the change is applied during the next
* maintenance window unless the ApplyImmediately parameter
* is set to true for this request. If the parameter change
* results in an option group that enables OEM, this change can cause a
* brief (sub-second) period during which new connections are rejected
* but existing connections are not interrupted.
Permanent options,
* such as the TDE option for Oracle Advanced Security TDE, cannot be
* removed from an option group, and that option group cannot be removed
* from a DB instance once it is associated with a DB instance
*
* @return Indicates that the DB instance should be associated with the specified
* option group. Changing this parameter does not result in an outage
* except in the following case and the change is applied during the next
* maintenance window unless the ApplyImmediately parameter
* is set to true for this request. If the parameter change
* results in an option group that enables OEM, this change can cause a
* brief (sub-second) period during which new connections are rejected
* but existing connections are not interrupted.
Permanent options,
* such as the TDE option for Oracle Advanced Security TDE, cannot be
* removed from an option group, and that option group cannot be removed
* from a DB instance once it is associated with a DB instance
*/
public String getOptionGroupName() {
return optionGroupName;
}
/**
* Indicates that the DB instance should be associated with the specified
* option group. Changing this parameter does not result in an outage
* except in the following case and the change is applied during the next
* maintenance window unless the ApplyImmediately parameter
* is set to true for this request. If the parameter change
* results in an option group that enables OEM, this change can cause a
* brief (sub-second) period during which new connections are rejected
* but existing connections are not interrupted.
Permanent options,
* such as the TDE option for Oracle Advanced Security TDE, cannot be
* removed from an option group, and that option group cannot be removed
* from a DB instance once it is associated with a DB instance
*
* @param optionGroupName Indicates that the DB instance should be associated with the specified
* option group. Changing this parameter does not result in an outage
* except in the following case and the change is applied during the next
* maintenance window unless the ApplyImmediately parameter
* is set to true for this request. If the parameter change
* results in an option group that enables OEM, this change can cause a
* brief (sub-second) period during which new connections are rejected
* but existing connections are not interrupted.
Permanent options,
* such as the TDE option for Oracle Advanced Security TDE, cannot be
* removed from an option group, and that option group cannot be removed
* from a DB instance once it is associated with a DB instance
*/
public void setOptionGroupName(String optionGroupName) {
this.optionGroupName = optionGroupName;
}
/**
* Indicates that the DB instance should be associated with the specified
* option group. Changing this parameter does not result in an outage
* except in the following case and the change is applied during the next
* maintenance window unless the ApplyImmediately parameter
* is set to true for this request. If the parameter change
* results in an option group that enables OEM, this change can cause a
* brief (sub-second) period during which new connections are rejected
* but existing connections are not interrupted.
Permanent options,
* such as the TDE option for Oracle Advanced Security TDE, cannot be
* removed from an option group, and that option group cannot be removed
* from a DB instance once it is associated with a DB instance
*
* Returns a reference to this object so that method calls can be chained together.
*
* @param optionGroupName Indicates that the DB instance should be associated with the specified
* option group. Changing this parameter does not result in an outage
* except in the following case and the change is applied during the next
* maintenance window unless the ApplyImmediately parameter
* is set to true for this request. If the parameter change
* results in an option group that enables OEM, this change can cause a
* brief (sub-second) period during which new connections are rejected
* but existing connections are not interrupted.
Permanent options,
* such as the TDE option for Oracle Advanced Security TDE, cannot be
* removed from an option group, and that option group cannot be removed
* from a DB instance once it is associated with a DB instance
*
* @return A reference to this updated object so that method calls can be chained
* together.
*/
public ModifyDBInstanceRequest withOptionGroupName(String optionGroupName) {
this.optionGroupName = optionGroupName;
return this;
}
/**
* The new DB instance identifier for the DB instance when renaming a DB
* Instance. This value is stored as a lowercase string.
Constraints:
*
- Must contain from 1 to 63 alphanumeric characters or
* hyphens
- First character must be a letter
- Cannot end
* with a hyphen or contain two consecutive hyphens
*
* @return The new DB instance identifier for the DB instance when renaming a DB
* Instance. This value is stored as a lowercase string. Constraints:
*
- Must contain from 1 to 63 alphanumeric characters or
* hyphens
- First character must be a letter
- Cannot end
* with a hyphen or contain two consecutive hyphens
*/
public String getNewDBInstanceIdentifier() {
return newDBInstanceIdentifier;
}
/**
* The new DB instance identifier for the DB instance when renaming a DB
* Instance. This value is stored as a lowercase string. Constraints:
*
- Must contain from 1 to 63 alphanumeric characters or
* hyphens
- First character must be a letter
- Cannot end
* with a hyphen or contain two consecutive hyphens
*
* @param newDBInstanceIdentifier The new DB instance identifier for the DB instance when renaming a DB
* Instance. This value is stored as a lowercase string. Constraints:
*
- Must contain from 1 to 63 alphanumeric characters or
* hyphens
- First character must be a letter
- Cannot end
* with a hyphen or contain two consecutive hyphens
*/
public void setNewDBInstanceIdentifier(String newDBInstanceIdentifier) {
this.newDBInstanceIdentifier = newDBInstanceIdentifier;
}
/**
* The new DB instance identifier for the DB instance when renaming a DB
* Instance. This value is stored as a lowercase string. Constraints:
*
- Must contain from 1 to 63 alphanumeric characters or
* hyphens
- First character must be a letter
- Cannot end
* with a hyphen or contain two consecutive hyphens
*
* Returns a reference to this object so that method calls can be chained together.
*
* @param newDBInstanceIdentifier The new DB instance identifier for the DB instance when renaming a DB
* Instance. This value is stored as a lowercase string.
Constraints:
*
- Must contain from 1 to 63 alphanumeric characters or
* hyphens
- First character must be a letter
- Cannot end
* with a hyphen or contain two consecutive hyphens
*
* @return A reference to this updated object so that method calls can be chained
* together.
*/
public ModifyDBInstanceRequest withNewDBInstanceIdentifier(String newDBInstanceIdentifier) {
this.newDBInstanceIdentifier = newDBInstanceIdentifier;
return this;
}
/**
* Returns a string representation of this object; useful for testing and
* debugging.
*
* @return A string representation of this object.
*
* @see java.lang.Object#toString()
*/
@Override
public String toString() {
StringBuilder sb = new StringBuilder();
sb.append("{");
if (getDBInstanceIdentifier() != null) sb.append("DBInstanceIdentifier: " + getDBInstanceIdentifier() + ",");
if (getAllocatedStorage() != null) sb.append("AllocatedStorage: " + getAllocatedStorage() + ",");
if (getDBInstanceClass() != null) sb.append("DBInstanceClass: " + getDBInstanceClass() + ",");
if (getDBSecurityGroups() != null) sb.append("DBSecurityGroups: " + getDBSecurityGroups() + ",");
if (getVpcSecurityGroupIds() != null) sb.append("VpcSecurityGroupIds: " + getVpcSecurityGroupIds() + ",");
if (isApplyImmediately() != null) sb.append("ApplyImmediately: " + isApplyImmediately() + ",");
if (getMasterUserPassword() != null) sb.append("MasterUserPassword: " + getMasterUserPassword() + ",");
if (getDBParameterGroupName() != null) sb.append("DBParameterGroupName: " + getDBParameterGroupName() + ",");
if (getBackupRetentionPeriod() != null) sb.append("BackupRetentionPeriod: " + getBackupRetentionPeriod() + ",");
if (getPreferredBackupWindow() != null) sb.append("PreferredBackupWindow: " + getPreferredBackupWindow() + ",");
if (getPreferredMaintenanceWindow() != null) sb.append("PreferredMaintenanceWindow: " + getPreferredMaintenanceWindow() + ",");
if (isMultiAZ() != null) sb.append("MultiAZ: " + isMultiAZ() + ",");
if (getEngineVersion() != null) sb.append("EngineVersion: " + getEngineVersion() + ",");
if (isAllowMajorVersionUpgrade() != null) sb.append("AllowMajorVersionUpgrade: " + isAllowMajorVersionUpgrade() + ",");
if (isAutoMinorVersionUpgrade() != null) sb.append("AutoMinorVersionUpgrade: " + isAutoMinorVersionUpgrade() + ",");
if (getIops() != null) sb.append("Iops: " + getIops() + ",");
if (getOptionGroupName() != null) sb.append("OptionGroupName: " + getOptionGroupName() + ",");
if (getNewDBInstanceIdentifier() != null) sb.append("NewDBInstanceIdentifier: " + getNewDBInstanceIdentifier() );
sb.append("}");
return sb.toString();
}
@Override
public int hashCode() {
final int prime = 31;
int hashCode = 1;
hashCode = prime * hashCode + ((getDBInstanceIdentifier() == null) ? 0 : getDBInstanceIdentifier().hashCode());
hashCode = prime * hashCode + ((getAllocatedStorage() == null) ? 0 : getAllocatedStorage().hashCode());
hashCode = prime * hashCode + ((getDBInstanceClass() == null) ? 0 : getDBInstanceClass().hashCode());
hashCode = prime * hashCode + ((getDBSecurityGroups() == null) ? 0 : getDBSecurityGroups().hashCode());
hashCode = prime * hashCode + ((getVpcSecurityGroupIds() == null) ? 0 : getVpcSecurityGroupIds().hashCode());
hashCode = prime * hashCode + ((isApplyImmediately() == null) ? 0 : isApplyImmediately().hashCode());
hashCode = prime * hashCode + ((getMasterUserPassword() == null) ? 0 : getMasterUserPassword().hashCode());
hashCode = prime * hashCode + ((getDBParameterGroupName() == null) ? 0 : getDBParameterGroupName().hashCode());
hashCode = prime * hashCode + ((getBackupRetentionPeriod() == null) ? 0 : getBackupRetentionPeriod().hashCode());
hashCode = prime * hashCode + ((getPreferredBackupWindow() == null) ? 0 : getPreferredBackupWindow().hashCode());
hashCode = prime * hashCode + ((getPreferredMaintenanceWindow() == null) ? 0 : getPreferredMaintenanceWindow().hashCode());
hashCode = prime * hashCode + ((isMultiAZ() == null) ? 0 : isMultiAZ().hashCode());
hashCode = prime * hashCode + ((getEngineVersion() == null) ? 0 : getEngineVersion().hashCode());
hashCode = prime * hashCode + ((isAllowMajorVersionUpgrade() == null) ? 0 : isAllowMajorVersionUpgrade().hashCode());
hashCode = prime * hashCode + ((isAutoMinorVersionUpgrade() == null) ? 0 : isAutoMinorVersionUpgrade().hashCode());
hashCode = prime * hashCode + ((getIops() == null) ? 0 : getIops().hashCode());
hashCode = prime * hashCode + ((getOptionGroupName() == null) ? 0 : getOptionGroupName().hashCode());
hashCode = prime * hashCode + ((getNewDBInstanceIdentifier() == null) ? 0 : getNewDBInstanceIdentifier().hashCode());
return hashCode;
}
@Override
public boolean equals(Object obj) {
if (this == obj) return true;
if (obj == null) return false;
if (obj instanceof ModifyDBInstanceRequest == false) return false;
ModifyDBInstanceRequest other = (ModifyDBInstanceRequest)obj;
if (other.getDBInstanceIdentifier() == null ^ this.getDBInstanceIdentifier() == null) return false;
if (other.getDBInstanceIdentifier() != null && other.getDBInstanceIdentifier().equals(this.getDBInstanceIdentifier()) == false) return false;
if (other.getAllocatedStorage() == null ^ this.getAllocatedStorage() == null) return false;
if (other.getAllocatedStorage() != null && other.getAllocatedStorage().equals(this.getAllocatedStorage()) == false) return false;
if (other.getDBInstanceClass() == null ^ this.getDBInstanceClass() == null) return false;
if (other.getDBInstanceClass() != null && other.getDBInstanceClass().equals(this.getDBInstanceClass()) == false) return false;
if (other.getDBSecurityGroups() == null ^ this.getDBSecurityGroups() == null) return false;
if (other.getDBSecurityGroups() != null && other.getDBSecurityGroups().equals(this.getDBSecurityGroups()) == false) return false;
if (other.getVpcSecurityGroupIds() == null ^ this.getVpcSecurityGroupIds() == null) return false;
if (other.getVpcSecurityGroupIds() != null && other.getVpcSecurityGroupIds().equals(this.getVpcSecurityGroupIds()) == false) return false;
if (other.isApplyImmediately() == null ^ this.isApplyImmediately() == null) return false;
if (other.isApplyImmediately() != null && other.isApplyImmediately().equals(this.isApplyImmediately()) == false) return false;
if (other.getMasterUserPassword() == null ^ this.getMasterUserPassword() == null) return false;
if (other.getMasterUserPassword() != null && other.getMasterUserPassword().equals(this.getMasterUserPassword()) == false) return false;
if (other.getDBParameterGroupName() == null ^ this.getDBParameterGroupName() == null) return false;
if (other.getDBParameterGroupName() != null && other.getDBParameterGroupName().equals(this.getDBParameterGroupName()) == false) return false;
if (other.getBackupRetentionPeriod() == null ^ this.getBackupRetentionPeriod() == null) return false;
if (other.getBackupRetentionPeriod() != null && other.getBackupRetentionPeriod().equals(this.getBackupRetentionPeriod()) == false) return false;
if (other.getPreferredBackupWindow() == null ^ this.getPreferredBackupWindow() == null) return false;
if (other.getPreferredBackupWindow() != null && other.getPreferredBackupWindow().equals(this.getPreferredBackupWindow()) == false) return false;
if (other.getPreferredMaintenanceWindow() == null ^ this.getPreferredMaintenanceWindow() == null) return false;
if (other.getPreferredMaintenanceWindow() != null && other.getPreferredMaintenanceWindow().equals(this.getPreferredMaintenanceWindow()) == false) return false;
if (other.isMultiAZ() == null ^ this.isMultiAZ() == null) return false;
if (other.isMultiAZ() != null && other.isMultiAZ().equals(this.isMultiAZ()) == false) return false;
if (other.getEngineVersion() == null ^ this.getEngineVersion() == null) return false;
if (other.getEngineVersion() != null && other.getEngineVersion().equals(this.getEngineVersion()) == false) return false;
if (other.isAllowMajorVersionUpgrade() == null ^ this.isAllowMajorVersionUpgrade() == null) return false;
if (other.isAllowMajorVersionUpgrade() != null && other.isAllowMajorVersionUpgrade().equals(this.isAllowMajorVersionUpgrade()) == false) return false;
if (other.isAutoMinorVersionUpgrade() == null ^ this.isAutoMinorVersionUpgrade() == null) return false;
if (other.isAutoMinorVersionUpgrade() != null && other.isAutoMinorVersionUpgrade().equals(this.isAutoMinorVersionUpgrade()) == false) return false;
if (other.getIops() == null ^ this.getIops() == null) return false;
if (other.getIops() != null && other.getIops().equals(this.getIops()) == false) return false;
if (other.getOptionGroupName() == null ^ this.getOptionGroupName() == null) return false;
if (other.getOptionGroupName() != null && other.getOptionGroupName().equals(this.getOptionGroupName()) == false) return false;
if (other.getNewDBInstanceIdentifier() == null ^ this.getNewDBInstanceIdentifier() == null) return false;
if (other.getNewDBInstanceIdentifier() != null && other.getNewDBInstanceIdentifier().equals(this.getNewDBInstanceIdentifier()) == false) return false;
return true;
}
}