public class ModifyDBInstanceRequest extends AmazonWebServiceRequest implements Serializable, Cloneable
NOOP
Constructor and Description |
---|
ModifyDBInstanceRequest()
Default constructor for ModifyDBInstanceRequest object.
|
ModifyDBInstanceRequest(String dBInstanceIdentifier)
Constructs a new ModifyDBInstanceRequest object.
|
Modifier and Type | Method and Description |
---|---|
ModifyDBInstanceRequest |
clone()
Creates a shallow clone of this request.
|
boolean |
equals(Object obj) |
Integer |
getAllocatedStorage()
The new storage capacity of the RDS instance.
|
Boolean |
getAllowMajorVersionUpgrade()
Indicates that major version upgrades are allowed.
|
Boolean |
getApplyImmediately()
Specifies whether the modifications in this request and any pending
modifications are asynchronously applied as soon as possible, regardless
of the
PreferredMaintenanceWindow setting for the DB
instance. |
Boolean |
getAutoMinorVersionUpgrade()
Indicates that minor version upgrades will be applied automatically to
the DB instance during the maintenance window.
|
Integer |
getBackupRetentionPeriod()
The number of days to retain automated backups.
|
String |
getCACertificateIdentifier()
Indicates the certificate that needs to be associated with the instance.
|
Boolean |
getCopyTagsToSnapshot()
True to copy all tags from the DB instance to snapshots of the DB
instance; otherwise false.
|
String |
getDBInstanceClass()
The new compute and memory capacity of the DB instance.
|
String |
getDBInstanceIdentifier()
The DB instance identifier.
|
String |
getDBParameterGroupName()
The name of the DB parameter group to apply to the DB instance.
|
Integer |
getDBPortNumber()
The port number on which the database accepts connections.
|
List<String> |
getDBSecurityGroups()
A list of DB security groups to authorize on this DB instance.
|
String |
getDomain()
Specify the Active Directory Domain to move the instance to.
|
String |
getDomainIAMRoleName()
Specify the name of the IAM role to be used when making API calls to the
Directory Service.
|
String |
getEngineVersion()
The version number of the database engine to upgrade to.
|
Integer |
getIops()
The new Provisioned IOPS (I/O operations per second) value for the RDS
instance.
|
String |
getMasterUserPassword()
The new password for the DB instance master user.
|
Integer |
getMonitoringInterval()
The interval, in seconds, between points when Enhanced Monitoring metrics
are collected for the DB instance.
|
String |
getMonitoringRoleArn()
The ARN for the IAM role that permits RDS to send enhanced monitoring
metrics to CloudWatch Logs.
|
Boolean |
getMultiAZ()
Specifies if the DB instance is a Multi-AZ deployment.
|
String |
getNewDBInstanceIdentifier()
The new DB instance identifier for the DB instance when renaming a DB
instance.
|
String |
getOptionGroupName()
Indicates that the DB instance should be associated with the specified
option group.
|
String |
getPreferredBackupWindow()
The daily time range during which automated backups are created if
automated backups are enabled, as determined by the
BackupRetentionPeriod parameter. |
String |
getPreferredMaintenanceWindow()
The weekly time range (in UTC) during which system maintenance can occur,
which might result in an outage.
|
Integer |
getPromotionTier()
A value that specifies the order in which an Aurora Replica is promoted
to the primary instance after a failure of the existing primary instance.
|
Boolean |
getPubliclyAccessible()
Boolean value that indicates if the DB instance has a publicly resolvable
DNS name.
|
String |
getStorageType()
Specifies the storage type to be associated with the DB instance.
|
String |
getTdeCredentialArn()
The ARN from the Key Store with which to associate the instance for TDE
encryption.
|
String |
getTdeCredentialPassword()
The password for the given ARN from the Key Store in order to access the
device.
|
List<String> |
getVpcSecurityGroupIds()
A list of EC2 VPC security groups to authorize on this DB instance.
|
int |
hashCode() |
Boolean |
isAllowMajorVersionUpgrade()
Indicates that major version upgrades are allowed.
|
Boolean |
isApplyImmediately()
Specifies whether the modifications in this request and any pending
modifications are asynchronously applied as soon as possible, regardless
of the
PreferredMaintenanceWindow setting for the DB
instance. |
Boolean |
isAutoMinorVersionUpgrade()
Indicates that minor version upgrades will be applied automatically to
the DB instance during the maintenance window.
|
Boolean |
isCopyTagsToSnapshot()
True to copy all tags from the DB instance to snapshots of the DB
instance; otherwise false.
|
Boolean |
isMultiAZ()
Specifies if the DB instance is a Multi-AZ deployment.
|
Boolean |
isPubliclyAccessible()
Boolean value that indicates if the DB instance has a publicly resolvable
DNS name.
|
void |
setAllocatedStorage(Integer allocatedStorage)
The new storage capacity of the RDS instance.
|
void |
setAllowMajorVersionUpgrade(Boolean allowMajorVersionUpgrade)
Indicates that major version upgrades are allowed.
|
void |
setApplyImmediately(Boolean applyImmediately)
Specifies whether the modifications in this request and any pending
modifications are asynchronously applied as soon as possible, regardless
of the
PreferredMaintenanceWindow setting for the DB
instance. |
void |
setAutoMinorVersionUpgrade(Boolean autoMinorVersionUpgrade)
Indicates that minor version upgrades will be applied automatically to
the DB instance during the maintenance window.
|
void |
setBackupRetentionPeriod(Integer backupRetentionPeriod)
The number of days to retain automated backups.
|
void |
setCACertificateIdentifier(String cACertificateIdentifier)
Indicates the certificate that needs to be associated with the instance.
|
void |
setCopyTagsToSnapshot(Boolean copyTagsToSnapshot)
True to copy all tags from the DB instance to snapshots of the DB
instance; otherwise false.
|
void |
setDBInstanceClass(String dBInstanceClass)
The new compute and memory capacity of the DB instance.
|
void |
setDBInstanceIdentifier(String dBInstanceIdentifier)
The DB instance identifier.
|
void |
setDBParameterGroupName(String dBParameterGroupName)
The name of the DB parameter group to apply to the DB instance.
|
void |
setDBPortNumber(Integer dBPortNumber)
The port number on which the database accepts connections.
|
void |
setDBSecurityGroups(Collection<String> dBSecurityGroups)
A list of DB security groups to authorize on this DB instance.
|
void |
setDomain(String domain)
Specify the Active Directory Domain to move the instance to.
|
void |
setDomainIAMRoleName(String domainIAMRoleName)
Specify the name of the IAM role to be used when making API calls to the
Directory Service.
|
void |
setEngineVersion(String engineVersion)
The version number of the database engine to upgrade to.
|
void |
setIops(Integer iops)
The new Provisioned IOPS (I/O operations per second) value for the RDS
instance.
|
void |
setMasterUserPassword(String masterUserPassword)
The new password for the DB instance master user.
|
void |
setMonitoringInterval(Integer monitoringInterval)
The interval, in seconds, between points when Enhanced Monitoring metrics
are collected for the DB instance.
|
void |
setMonitoringRoleArn(String monitoringRoleArn)
The ARN for the IAM role that permits RDS to send enhanced monitoring
metrics to CloudWatch Logs.
|
void |
setMultiAZ(Boolean multiAZ)
Specifies if the DB instance is a Multi-AZ deployment.
|
void |
setNewDBInstanceIdentifier(String newDBInstanceIdentifier)
The new DB instance identifier for the DB instance when renaming a DB
instance.
|
void |
setOptionGroupName(String optionGroupName)
Indicates that the DB instance should be associated with the specified
option group.
|
void |
setPreferredBackupWindow(String preferredBackupWindow)
The daily time range during which automated backups are created if
automated backups are enabled, as determined by the
BackupRetentionPeriod parameter. |
void |
setPreferredMaintenanceWindow(String preferredMaintenanceWindow)
The weekly time range (in UTC) during which system maintenance can occur,
which might result in an outage.
|
void |
setPromotionTier(Integer promotionTier)
A value that specifies the order in which an Aurora Replica is promoted
to the primary instance after a failure of the existing primary instance.
|
void |
setPubliclyAccessible(Boolean publiclyAccessible)
Boolean value that indicates if the DB instance has a publicly resolvable
DNS name.
|
void |
setStorageType(String storageType)
Specifies the storage type to be associated with the DB instance.
|
void |
setTdeCredentialArn(String tdeCredentialArn)
The ARN from the Key Store with which to associate the instance for TDE
encryption.
|
void |
setTdeCredentialPassword(String tdeCredentialPassword)
The password for the given ARN from the Key Store in order to access the
device.
|
void |
setVpcSecurityGroupIds(Collection<String> vpcSecurityGroupIds)
A list of EC2 VPC security groups to authorize on this DB instance.
|
String |
toString()
Returns a string representation of this object; useful for testing and
debugging.
|
ModifyDBInstanceRequest |
withAllocatedStorage(Integer allocatedStorage)
The new storage capacity of the RDS instance.
|
ModifyDBInstanceRequest |
withAllowMajorVersionUpgrade(Boolean allowMajorVersionUpgrade)
Indicates that major version upgrades are allowed.
|
ModifyDBInstanceRequest |
withApplyImmediately(Boolean applyImmediately)
Specifies whether the modifications in this request and any pending
modifications are asynchronously applied as soon as possible, regardless
of the
PreferredMaintenanceWindow setting for the DB
instance. |
ModifyDBInstanceRequest |
withAutoMinorVersionUpgrade(Boolean autoMinorVersionUpgrade)
Indicates that minor version upgrades will be applied automatically to
the DB instance during the maintenance window.
|
ModifyDBInstanceRequest |
withBackupRetentionPeriod(Integer backupRetentionPeriod)
The number of days to retain automated backups.
|
ModifyDBInstanceRequest |
withCACertificateIdentifier(String cACertificateIdentifier)
Indicates the certificate that needs to be associated with the instance.
|
ModifyDBInstanceRequest |
withCopyTagsToSnapshot(Boolean copyTagsToSnapshot)
True to copy all tags from the DB instance to snapshots of the DB
instance; otherwise false.
|
ModifyDBInstanceRequest |
withDBInstanceClass(String dBInstanceClass)
The new compute and memory capacity of the DB instance.
|
ModifyDBInstanceRequest |
withDBInstanceIdentifier(String dBInstanceIdentifier)
The DB instance identifier.
|
ModifyDBInstanceRequest |
withDBParameterGroupName(String dBParameterGroupName)
The name of the DB parameter group to apply to the DB instance.
|
ModifyDBInstanceRequest |
withDBPortNumber(Integer dBPortNumber)
The port number on which the database accepts connections.
|
ModifyDBInstanceRequest |
withDBSecurityGroups(Collection<String> dBSecurityGroups)
A list of DB security groups to authorize on this DB instance.
|
ModifyDBInstanceRequest |
withDBSecurityGroups(String... dBSecurityGroups)
A list of DB security groups to authorize on this DB instance.
|
ModifyDBInstanceRequest |
withDomain(String domain)
Specify the Active Directory Domain to move the instance to.
|
ModifyDBInstanceRequest |
withDomainIAMRoleName(String domainIAMRoleName)
Specify the name of the IAM role to be used when making API calls to the
Directory Service.
|
ModifyDBInstanceRequest |
withEngineVersion(String engineVersion)
The version number of the database engine to upgrade to.
|
ModifyDBInstanceRequest |
withIops(Integer iops)
The new Provisioned IOPS (I/O operations per second) value for the RDS
instance.
|
ModifyDBInstanceRequest |
withMasterUserPassword(String masterUserPassword)
The new password for the DB instance master user.
|
ModifyDBInstanceRequest |
withMonitoringInterval(Integer monitoringInterval)
The interval, in seconds, between points when Enhanced Monitoring metrics
are collected for the DB instance.
|
ModifyDBInstanceRequest |
withMonitoringRoleArn(String monitoringRoleArn)
The ARN for the IAM role that permits RDS to send enhanced monitoring
metrics to CloudWatch Logs.
|
ModifyDBInstanceRequest |
withMultiAZ(Boolean multiAZ)
Specifies if the DB instance is a Multi-AZ deployment.
|
ModifyDBInstanceRequest |
withNewDBInstanceIdentifier(String newDBInstanceIdentifier)
The new DB instance identifier for the DB instance when renaming a DB
instance.
|
ModifyDBInstanceRequest |
withOptionGroupName(String optionGroupName)
Indicates that the DB instance should be associated with the specified
option group.
|
ModifyDBInstanceRequest |
withPreferredBackupWindow(String preferredBackupWindow)
The daily time range during which automated backups are created if
automated backups are enabled, as determined by the
BackupRetentionPeriod parameter. |
ModifyDBInstanceRequest |
withPreferredMaintenanceWindow(String preferredMaintenanceWindow)
The weekly time range (in UTC) during which system maintenance can occur,
which might result in an outage.
|
ModifyDBInstanceRequest |
withPromotionTier(Integer promotionTier)
A value that specifies the order in which an Aurora Replica is promoted
to the primary instance after a failure of the existing primary instance.
|
ModifyDBInstanceRequest |
withPubliclyAccessible(Boolean publiclyAccessible)
Boolean value that indicates if the DB instance has a publicly resolvable
DNS name.
|
ModifyDBInstanceRequest |
withStorageType(String storageType)
Specifies the storage type to be associated with the DB instance.
|
ModifyDBInstanceRequest |
withTdeCredentialArn(String tdeCredentialArn)
The ARN from the Key Store with which to associate the instance for TDE
encryption.
|
ModifyDBInstanceRequest |
withTdeCredentialPassword(String tdeCredentialPassword)
The password for the given ARN from the Key Store in order to access the
device.
|
ModifyDBInstanceRequest |
withVpcSecurityGroupIds(Collection<String> vpcSecurityGroupIds)
A list of EC2 VPC security groups to authorize on this DB instance.
|
ModifyDBInstanceRequest |
withVpcSecurityGroupIds(String... vpcSecurityGroupIds)
A list of EC2 VPC security groups to authorize on this DB instance.
|
getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestMetricCollector, withSdkClientExecutionTimeout, withSdkRequestTimeout
public ModifyDBInstanceRequest()
public ModifyDBInstanceRequest(String dBInstanceIdentifier)
dBInstanceIdentifier
- The DB instance identifier. This value is stored as a lowercase
string.
Constraints:
public void setDBInstanceIdentifier(String dBInstanceIdentifier)
The DB instance identifier. This value is stored as a lowercase string.
Constraints:
dBInstanceIdentifier
- The DB instance identifier. This value is stored as a lowercase
string.
Constraints:
public String getDBInstanceIdentifier()
The DB instance identifier. This value is stored as a lowercase string.
Constraints:
Constraints:
public ModifyDBInstanceRequest withDBInstanceIdentifier(String dBInstanceIdentifier)
The DB instance identifier. This value is stored as a lowercase string.
Constraints:
dBInstanceIdentifier
- The DB instance identifier. This value is stored as a lowercase
string.
Constraints:
public void setAllocatedStorage(Integer allocatedStorage)
The new storage capacity of the RDS instance. Changing this setting does
not result in an outage and the change is applied during the next
maintenance window unless ApplyImmediately
is set to
true
for this request.
MySQL
Default: Uses existing setting
Valid Values: 5-6144
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
MariaDB
Default: Uses existing setting
Valid Values: 5-6144
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
PostgreSQL
Default: Uses existing setting
Valid Values: 5-6144
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-6144
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 might 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.
allocatedStorage
- The new storage capacity of the RDS instance. Changing this
setting does not result in an outage and the change is applied
during the next maintenance window unless
ApplyImmediately
is set to true
for this
request.
MySQL
Default: Uses existing setting
Valid Values: 5-6144
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
MariaDB
Default: Uses existing setting
Valid Values: 5-6144
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
PostgreSQL
Default: Uses existing setting
Valid Values: 5-6144
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-6144
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 might 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()
The new storage capacity of the RDS instance. Changing this setting does
not result in an outage and the change is applied during the next
maintenance window unless ApplyImmediately
is set to
true
for this request.
MySQL
Default: Uses existing setting
Valid Values: 5-6144
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
MariaDB
Default: Uses existing setting
Valid Values: 5-6144
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
PostgreSQL
Default: Uses existing setting
Valid Values: 5-6144
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-6144
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 might 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.
ApplyImmediately
is set to true
for
this request.
MySQL
Default: Uses existing setting
Valid Values: 5-6144
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
MariaDB
Default: Uses existing setting
Valid Values: 5-6144
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
PostgreSQL
Default: Uses existing setting
Valid Values: 5-6144
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-6144
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 might 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 ModifyDBInstanceRequest withAllocatedStorage(Integer allocatedStorage)
The new storage capacity of the RDS instance. Changing this setting does
not result in an outage and the change is applied during the next
maintenance window unless ApplyImmediately
is set to
true
for this request.
MySQL
Default: Uses existing setting
Valid Values: 5-6144
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
MariaDB
Default: Uses existing setting
Valid Values: 5-6144
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
PostgreSQL
Default: Uses existing setting
Valid Values: 5-6144
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-6144
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 might 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.
allocatedStorage
- The new storage capacity of the RDS instance. Changing this
setting does not result in an outage and the change is applied
during the next maintenance window unless
ApplyImmediately
is set to true
for this
request.
MySQL
Default: Uses existing setting
Valid Values: 5-6144
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
MariaDB
Default: Uses existing setting
Valid Values: 5-6144
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
PostgreSQL
Default: Uses existing setting
Valid Values: 5-6144
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-6144
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 might 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 setDBInstanceClass(String dBInstanceClass)
The new compute and memory capacity of the DB instance. To determine the instance classes that are available for a particular DB engine, use the DescribeOrderableDBInstanceOptions action.
Passing a value for this setting causes an outage during the change and
is applied during the next maintenance window, unless
ApplyImmediately
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 | db.m3.medium | db.m3.large | db.m3.xlarge | db.m3.2xlarge | db.m4.large | db.m4.xlarge | db.m4.2xlarge | db.m4.4xlarge | db.m4.10xlarge | db.r3.large | db.r3.xlarge | db.r3.2xlarge | db.r3.4xlarge | db.r3.8xlarge | db.t2.micro | db.t2.small | db.t2.medium | db.t2.large
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 setting causes an outage during the
change and is applied during the next maintenance window, unless
ApplyImmediately
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 | db.m3.medium | db.m3.large | db.m3.xlarge | db.m3.2xlarge | db.m4.large | db.m4.xlarge | db.m4.2xlarge | db.m4.4xlarge | db.m4.10xlarge | db.r3.large | db.r3.xlarge | db.r3.2xlarge | db.r3.4xlarge | db.r3.8xlarge | db.t2.micro | db.t2.small | db.t2.medium | db.t2.large
public String getDBInstanceClass()
The new compute and memory capacity of the DB instance. To determine the instance classes that are available for a particular DB engine, use the DescribeOrderableDBInstanceOptions action.
Passing a value for this setting causes an outage during the change and
is applied during the next maintenance window, unless
ApplyImmediately
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 | db.m3.medium | db.m3.large | db.m3.xlarge | db.m3.2xlarge | db.m4.large | db.m4.xlarge | db.m4.2xlarge | db.m4.4xlarge | db.m4.10xlarge | db.r3.large | db.r3.xlarge | db.r3.2xlarge | db.r3.4xlarge | db.r3.8xlarge | db.t2.micro | db.t2.small | db.t2.medium | db.t2.large
Passing a value for this setting causes an outage during the
change and is applied during the next maintenance window, unless
ApplyImmediately
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 | db.m3.medium | db.m3.large | db.m3.xlarge | db.m3.2xlarge | db.m4.large | db.m4.xlarge | db.m4.2xlarge | db.m4.4xlarge | db.m4.10xlarge | db.r3.large | db.r3.xlarge | db.r3.2xlarge | db.r3.4xlarge | db.r3.8xlarge | db.t2.micro | db.t2.small | db.t2.medium | db.t2.large
public ModifyDBInstanceRequest withDBInstanceClass(String dBInstanceClass)
The new compute and memory capacity of the DB instance. To determine the instance classes that are available for a particular DB engine, use the DescribeOrderableDBInstanceOptions action.
Passing a value for this setting causes an outage during the change and
is applied during the next maintenance window, unless
ApplyImmediately
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 | db.m3.medium | db.m3.large | db.m3.xlarge | db.m3.2xlarge | db.m4.large | db.m4.xlarge | db.m4.2xlarge | db.m4.4xlarge | db.m4.10xlarge | db.r3.large | db.r3.xlarge | db.r3.2xlarge | db.r3.4xlarge | db.r3.8xlarge | db.t2.micro | db.t2.small | db.t2.medium | db.t2.large
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 setting causes an outage during the
change and is applied during the next maintenance window, unless
ApplyImmediately
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 | db.m3.medium | db.m3.large | db.m3.xlarge | db.m3.2xlarge | db.m4.large | db.m4.xlarge | db.m4.2xlarge | db.m4.4xlarge | db.m4.10xlarge | db.r3.large | db.r3.xlarge | db.r3.2xlarge | db.r3.4xlarge | db.r3.8xlarge | db.t2.micro | db.t2.small | db.t2.medium | db.t2.large
public List<String> getDBSecurityGroups()
A list of DB security groups to authorize on this DB instance. Changing this setting does not result in an outage and the change is asynchronously applied as soon as possible.
Constraints:
Constraints:
public void setDBSecurityGroups(Collection<String> dBSecurityGroups)
A list of DB security groups to authorize on this DB instance. Changing this setting does not result in an outage and the change is asynchronously applied as soon as possible.
Constraints:
dBSecurityGroups
- A list of DB security groups to authorize on this DB instance.
Changing this setting does not result in an outage and the change
is asynchronously applied as soon as possible.
Constraints:
public ModifyDBInstanceRequest withDBSecurityGroups(String... dBSecurityGroups)
A list of DB security groups to authorize on this DB instance. Changing this setting does not result in an outage and the change is asynchronously applied as soon as possible.
Constraints:
NOTE: This method appends the values to the existing list (if
any). Use setDBSecurityGroups(java.util.Collection)
or
withDBSecurityGroups(java.util.Collection)
if you want to
override the existing values.
dBSecurityGroups
- A list of DB security groups to authorize on this DB instance.
Changing this setting does not result in an outage and the change
is asynchronously applied as soon as possible.
Constraints:
public ModifyDBInstanceRequest withDBSecurityGroups(Collection<String> dBSecurityGroups)
A list of DB security groups to authorize on this DB instance. Changing this setting does not result in an outage and the change is asynchronously applied as soon as possible.
Constraints:
dBSecurityGroups
- A list of DB security groups to authorize on this DB instance.
Changing this setting does not result in an outage and the change
is asynchronously applied as soon as possible.
Constraints:
public List<String> getVpcSecurityGroupIds()
A list of EC2 VPC security groups to authorize on this DB instance. This change is asynchronously applied as soon as possible.
Constraints:
Constraints:
public void setVpcSecurityGroupIds(Collection<String> vpcSecurityGroupIds)
A list of EC2 VPC security groups to authorize on this DB instance. This change is asynchronously applied as soon as possible.
Constraints:
vpcSecurityGroupIds
- A list of EC2 VPC security groups to authorize on this DB
instance. This change is asynchronously applied as soon as
possible.
Constraints:
public ModifyDBInstanceRequest withVpcSecurityGroupIds(String... vpcSecurityGroupIds)
A list of EC2 VPC security groups to authorize on this DB instance. This change is asynchronously applied as soon as possible.
Constraints:
NOTE: This method appends the values to the existing list (if
any). Use setVpcSecurityGroupIds(java.util.Collection)
or
withVpcSecurityGroupIds(java.util.Collection)
if you want to
override the existing values.
vpcSecurityGroupIds
- A list of EC2 VPC security groups to authorize on this DB
instance. This change is asynchronously applied as soon as
possible.
Constraints:
public ModifyDBInstanceRequest withVpcSecurityGroupIds(Collection<String> vpcSecurityGroupIds)
A list of EC2 VPC security groups to authorize on this DB instance. This change is asynchronously applied as soon as possible.
Constraints:
vpcSecurityGroupIds
- A list of EC2 VPC security groups to authorize on this DB
instance. This change is asynchronously applied as soon as
possible.
Constraints:
public void setApplyImmediately(Boolean applyImmediately)
Specifies whether the modifications in this request and any pending
modifications are asynchronously applied as soon as possible, regardless
of the PreferredMaintenanceWindow
setting for the DB
instance.
If this parameter is set to false
, changes to the DB
instance are applied during the next maintenance window. Some parameter
changes can cause an outage and will be applied on the next call to
RebootDBInstance, or the next failure reboot. Review the table of
parameters in Modifying a DB Instance and Using the Apply Immediately Parameter to
see the impact that setting ApplyImmediately
to
true
or false
has for each modified parameter
and to determine when the changes will be applied.
Default: false
applyImmediately
- Specifies whether the modifications in this request and any
pending modifications are asynchronously applied as soon as
possible, regardless of the
PreferredMaintenanceWindow
setting for the DB
instance.
If this parameter is set to false
, changes to the DB
instance are applied during the next maintenance window. Some
parameter changes can cause an outage and will be applied on the
next call to RebootDBInstance, or the next failure reboot.
Review the table of parameters in Modifying a DB Instance and Using the Apply Immediately
Parameter to see the impact that setting
ApplyImmediately
to true
or
false
has for each modified parameter and to
determine when the changes will be applied.
Default: false
public Boolean getApplyImmediately()
Specifies whether the modifications in this request and any pending
modifications are asynchronously applied as soon as possible, regardless
of the PreferredMaintenanceWindow
setting for the DB
instance.
If this parameter is set to false
, changes to the DB
instance are applied during the next maintenance window. Some parameter
changes can cause an outage and will be applied on the next call to
RebootDBInstance, or the next failure reboot. Review the table of
parameters in Modifying a DB Instance and Using the Apply Immediately Parameter to
see the impact that setting ApplyImmediately
to
true
or false
has for each modified parameter
and to determine when the changes will be applied.
Default: false
PreferredMaintenanceWindow
setting for the DB
instance.
If this parameter is set to false
, changes to the DB
instance are applied during the next maintenance window. Some
parameter changes can cause an outage and will be applied on the
next call to RebootDBInstance, or the next failure reboot.
Review the table of parameters in Modifying a DB Instance and Using the Apply Immediately
Parameter to see the impact that setting
ApplyImmediately
to true
or
false
has for each modified parameter and to
determine when the changes will be applied.
Default: false
public ModifyDBInstanceRequest withApplyImmediately(Boolean applyImmediately)
Specifies whether the modifications in this request and any pending
modifications are asynchronously applied as soon as possible, regardless
of the PreferredMaintenanceWindow
setting for the DB
instance.
If this parameter is set to false
, changes to the DB
instance are applied during the next maintenance window. Some parameter
changes can cause an outage and will be applied on the next call to
RebootDBInstance, or the next failure reboot. Review the table of
parameters in Modifying a DB Instance and Using the Apply Immediately Parameter to
see the impact that setting ApplyImmediately
to
true
or false
has for each modified parameter
and to determine when the changes will be applied.
Default: false
applyImmediately
- Specifies whether the modifications in this request and any
pending modifications are asynchronously applied as soon as
possible, regardless of the
PreferredMaintenanceWindow
setting for the DB
instance.
If this parameter is set to false
, changes to the DB
instance are applied during the next maintenance window. Some
parameter changes can cause an outage and will be applied on the
next call to RebootDBInstance, or the next failure reboot.
Review the table of parameters in Modifying a DB Instance and Using the Apply Immediately
Parameter to see the impact that setting
ApplyImmediately
to true
or
false
has for each modified parameter and to
determine when the changes will be applied.
Default: false
public Boolean isApplyImmediately()
Specifies whether the modifications in this request and any pending
modifications are asynchronously applied as soon as possible, regardless
of the PreferredMaintenanceWindow
setting for the DB
instance.
If this parameter is set to false
, changes to the DB
instance are applied during the next maintenance window. Some parameter
changes can cause an outage and will be applied on the next call to
RebootDBInstance, or the next failure reboot. Review the table of
parameters in Modifying a DB Instance and Using the Apply Immediately Parameter to
see the impact that setting ApplyImmediately
to
true
or false
has for each modified parameter
and to determine when the changes will be applied.
Default: false
PreferredMaintenanceWindow
setting for the DB
instance.
If this parameter is set to false
, changes to the DB
instance are applied during the next maintenance window. Some
parameter changes can cause an outage and will be applied on the
next call to RebootDBInstance, or the next failure reboot.
Review the table of parameters in Modifying a DB Instance and Using the Apply Immediately
Parameter to see the impact that setting
ApplyImmediately
to true
or
false
has for each modified parameter and to
determine when the changes will be applied.
Default: false
public void setMasterUserPassword(String 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, MariaDB, and Amazon Aurora), 8 to 30 alphanumeric characters (Oracle), or 8 to 128 alphanumeric characters (SQL Server).
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, MariaDB, and Amazon Aurora), 8 to 30 alphanumeric characters (Oracle), or 8 to 128 alphanumeric characters (SQL Server).
public String getMasterUserPassword()
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, MariaDB, and Amazon Aurora), 8 to 30 alphanumeric characters (Oracle), or 8 to 128 alphanumeric characters (SQL Server).
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, MariaDB, and Amazon Aurora), 8 to 30 alphanumeric characters (Oracle), or 8 to 128 alphanumeric characters (SQL Server).
public ModifyDBInstanceRequest withMasterUserPassword(String 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, MariaDB, and Amazon Aurora), 8 to 30 alphanumeric characters (Oracle), or 8 to 128 alphanumeric characters (SQL Server).
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, MariaDB, and Amazon Aurora), 8 to 30 alphanumeric characters (Oracle), or 8 to 128 alphanumeric characters (SQL Server).
public void setDBParameterGroupName(String dBParameterGroupName)
The name of the DB parameter group to apply to the DB instance. Changing this setting does not result in an outage. The parameter group name itself is changed immediately, but the actual parameter changes are not applied until you reboot the instance without failover. The db instance will NOT be rebooted automatically and the parameter changes will NOT be applied during the next maintenance window.
Default: Uses existing setting
Constraints: The DB parameter group must be in the same DB parameter group family as this DB instance.
dBParameterGroupName
- The name of the DB parameter group to apply to the DB instance.
Changing this setting does not result in an outage. The parameter
group name itself is changed immediately, but the actual parameter
changes are not applied until you reboot the instance without
failover. The db instance will NOT be rebooted automatically and
the parameter changes will NOT be applied during the next
maintenance window.
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()
The name of the DB parameter group to apply to the DB instance. Changing this setting does not result in an outage. The parameter group name itself is changed immediately, but the actual parameter changes are not applied until you reboot the instance without failover. The db instance will NOT be rebooted automatically and the parameter changes will NOT be applied during the next maintenance window.
Default: Uses existing setting
Constraints: The DB parameter group must be in the same DB parameter group family as this DB instance.
Default: Uses existing setting
Constraints: The DB parameter group must be in the same DB parameter group family as this DB instance.
public ModifyDBInstanceRequest withDBParameterGroupName(String dBParameterGroupName)
The name of the DB parameter group to apply to the DB instance. Changing this setting does not result in an outage. The parameter group name itself is changed immediately, but the actual parameter changes are not applied until you reboot the instance without failover. The db instance will NOT be rebooted automatically and the parameter changes will NOT be applied during the next maintenance window.
Default: Uses existing setting
Constraints: The DB parameter group must be in the same DB parameter group family as this DB instance.
dBParameterGroupName
- The name of the DB parameter group to apply to the DB instance.
Changing this setting does not result in an outage. The parameter
group name itself is changed immediately, but the actual parameter
changes are not applied until you reboot the instance without
failover. The db instance will NOT be rebooted automatically and
the parameter changes will NOT be applied during the next
maintenance window.
Default: Uses existing setting
Constraints: The DB parameter group must be in the same DB parameter group family as this DB instance.
public void setBackupRetentionPeriod(Integer backupRetentionPeriod)
The number of days to retain automated backups. Setting this parameter to a positive number enables backups. Setting this parameter to 0 disables automated backups.
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:
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:
public Integer getBackupRetentionPeriod()
The number of days to retain automated backups. Setting this parameter to a positive number enables backups. Setting this parameter to 0 disables automated backups.
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:
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:
public ModifyDBInstanceRequest withBackupRetentionPeriod(Integer backupRetentionPeriod)
The number of days to retain automated backups. Setting this parameter to a positive number enables backups. Setting this parameter to 0 disables automated backups.
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:
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:
public void setPreferredBackupWindow(String preferredBackupWindow)
The daily time range during which automated backups are created if
automated backups are enabled, as determined by the
BackupRetentionPeriod
parameter. Changing this parameter
does not result in an outage and the change is asynchronously applied as
soon as possible.
Constraints:
preferredBackupWindow
- The daily time range during which automated backups are created if
automated backups are enabled, as determined by the
BackupRetentionPeriod
parameter. Changing this
parameter does not result in an outage and the change is
asynchronously applied as soon as possible.
Constraints:
public String getPreferredBackupWindow()
The daily time range during which automated backups are created if
automated backups are enabled, as determined by the
BackupRetentionPeriod
parameter. Changing this parameter
does not result in an outage and the change is asynchronously applied as
soon as possible.
Constraints:
BackupRetentionPeriod
parameter. Changing this
parameter does not result in an outage and the change is
asynchronously applied as soon as possible.
Constraints:
public ModifyDBInstanceRequest withPreferredBackupWindow(String preferredBackupWindow)
The daily time range during which automated backups are created if
automated backups are enabled, as determined by the
BackupRetentionPeriod
parameter. Changing this parameter
does not result in an outage and the change is asynchronously applied as
soon as possible.
Constraints:
preferredBackupWindow
- The daily time range during which automated backups are created if
automated backups are enabled, as determined by the
BackupRetentionPeriod
parameter. Changing this
parameter does not result in an outage and the change is
asynchronously applied as soon as possible.
Constraints:
public void setPreferredMaintenanceWindow(String preferredMaintenanceWindow)
The weekly time range (in UTC) during which system maintenance can occur, which might 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
preferredMaintenanceWindow
- The weekly time range (in UTC) during which system maintenance can
occur, which might 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()
The weekly time range (in UTC) during which system maintenance can occur, which might 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
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 ModifyDBInstanceRequest withPreferredMaintenanceWindow(String preferredMaintenanceWindow)
The weekly time range (in UTC) during which system maintenance can occur, which might 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
preferredMaintenanceWindow
- The weekly time range (in UTC) during which system maintenance can
occur, which might 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 setMultiAZ(Boolean 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. This parameter cannot be used with SQL Server DB instances. Multi-AZ for SQL Server DB instances is set using the Mirroring option in an option group associated with the DB instance.
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. This parameter cannot be used with SQL Server DB instances. Multi-AZ for SQL Server DB instances is set using the Mirroring option in an option group associated with the DB instance.
public Boolean getMultiAZ()
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. This parameter cannot be used with SQL Server DB instances. Multi-AZ for SQL Server DB instances is set using the Mirroring option in an option group associated with the DB instance.
ApplyImmediately
parameter is set to
true
for this request.
Constraints: Cannot be specified if the DB instance is a Read Replica. This parameter cannot be used with SQL Server DB instances. Multi-AZ for SQL Server DB instances is set using the Mirroring option in an option group associated with the DB instance.
public ModifyDBInstanceRequest withMultiAZ(Boolean 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. This parameter cannot be used with SQL Server DB instances. Multi-AZ for SQL Server DB instances is set using the Mirroring option in an option group associated with the DB instance.
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. This parameter cannot be used with SQL Server DB instances. Multi-AZ for SQL Server DB instances is set using the Mirroring option in an option group associated with the DB instance.
public Boolean isMultiAZ()
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. This parameter cannot be used with SQL Server DB instances. Multi-AZ for SQL Server DB instances is set using the Mirroring option in an option group associated with the DB instance.
ApplyImmediately
parameter is set to
true
for this request.
Constraints: Cannot be specified if the DB instance is a Read Replica. This parameter cannot be used with SQL Server DB instances. Multi-AZ for SQL Server DB instances is set using the Mirroring option in an option group associated with the DB instance.
public void setEngineVersion(String 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.
For a list of valid engine versions, see CreateDBInstance.
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.
For a list of valid engine versions, see CreateDBInstance.
public String getEngineVersion()
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.
For a list of valid engine versions, see CreateDBInstance.
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.
For a list of valid engine versions, see CreateDBInstance.
public ModifyDBInstanceRequest withEngineVersion(String 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.
For a list of valid engine versions, see CreateDBInstance.
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.
For a list of valid engine versions, see CreateDBInstance.
public void setAllowMajorVersionUpgrade(Boolean 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.
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 Boolean getAllowMajorVersionUpgrade()
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.
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 ModifyDBInstanceRequest withAllowMajorVersionUpgrade(Boolean 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.
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 Boolean isAllowMajorVersionUpgrade()
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.
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 setAutoMinorVersionUpgrade(Boolean 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.
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 Boolean getAutoMinorVersionUpgrade()
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.
true
during the maintenance window, and a newer
minor version is available, and RDS has enabled auto patching for
that engine version.public ModifyDBInstanceRequest withAutoMinorVersionUpgrade(Boolean 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.
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 Boolean isAutoMinorVersionUpgrade()
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.
true
during the maintenance window, and a newer
minor version is available, and RDS has enabled auto patching for
that engine version.public void setIops(Integer iops)
The new Provisioned IOPS (I/O operations per second) value for the RDS
instance. Changing this setting 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. If you are migrating from Provisioned IOPS to standard storage, set this value to 0. The DB instance will require a reboot for the change in storage type to take effect.
SQL Server
Setting the IOPS value for the SQL Server database engine is not supported.
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 might 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.
iops
- The new Provisioned IOPS (I/O operations per second) value for the
RDS instance. Changing this setting 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. If you are migrating from Provisioned IOPS to standard storage, set this value to 0. The DB instance will require a reboot for the change in storage type to take effect.
SQL Server
Setting the IOPS value for the SQL Server database engine is not supported.
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 might 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()
The new Provisioned IOPS (I/O operations per second) value for the RDS
instance. Changing this setting 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. If you are migrating from Provisioned IOPS to standard storage, set this value to 0. The DB instance will require a reboot for the change in storage type to take effect.
SQL Server
Setting the IOPS value for the SQL Server database engine is not supported.
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 might 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.
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. If you are migrating from Provisioned IOPS to standard storage, set this value to 0. The DB instance will require a reboot for the change in storage type to take effect.
SQL Server
Setting the IOPS value for the SQL Server database engine is not supported.
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 might 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 ModifyDBInstanceRequest withIops(Integer iops)
The new Provisioned IOPS (I/O operations per second) value for the RDS
instance. Changing this setting 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. If you are migrating from Provisioned IOPS to standard storage, set this value to 0. The DB instance will require a reboot for the change in storage type to take effect.
SQL Server
Setting the IOPS value for the SQL Server database engine is not supported.
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 might 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.
iops
- The new Provisioned IOPS (I/O operations per second) value for the
RDS instance. Changing this setting 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. If you are migrating from Provisioned IOPS to standard storage, set this value to 0. The DB instance will require a reboot for the change in storage type to take effect.
SQL Server
Setting the IOPS value for the SQL Server database engine is not supported.
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 might 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 setOptionGroupName(String 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
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 String getOptionGroupName()
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
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 ModifyDBInstanceRequest withOptionGroupName(String 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
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 setNewDBInstanceIdentifier(String newDBInstanceIdentifier)
The new DB instance identifier for the DB instance when renaming a DB
instance. When you change the DB instance identifier, an instance reboot
will occur immediately if you set Apply Immediately
to true,
or will occur during the next maintenance window if
Apply Immediately
to false. This value is stored as a
lowercase string.
Constraints:
newDBInstanceIdentifier
- The new DB instance identifier for the DB instance when renaming a
DB instance. When you change the DB instance identifier, an
instance reboot will occur immediately if you set
Apply Immediately
to true, or will occur during the
next maintenance window if Apply Immediately
to
false. This value is stored as a lowercase string.
Constraints:
public String getNewDBInstanceIdentifier()
The new DB instance identifier for the DB instance when renaming a DB
instance. When you change the DB instance identifier, an instance reboot
will occur immediately if you set Apply Immediately
to true,
or will occur during the next maintenance window if
Apply Immediately
to false. This value is stored as a
lowercase string.
Constraints:
Apply Immediately
to true, or will occur during the
next maintenance window if Apply Immediately
to
false. This value is stored as a lowercase string.
Constraints:
public ModifyDBInstanceRequest withNewDBInstanceIdentifier(String newDBInstanceIdentifier)
The new DB instance identifier for the DB instance when renaming a DB
instance. When you change the DB instance identifier, an instance reboot
will occur immediately if you set Apply Immediately
to true,
or will occur during the next maintenance window if
Apply Immediately
to false. This value is stored as a
lowercase string.
Constraints:
newDBInstanceIdentifier
- The new DB instance identifier for the DB instance when renaming a
DB instance. When you change the DB instance identifier, an
instance reboot will occur immediately if you set
Apply Immediately
to true, or will occur during the
next maintenance window if Apply Immediately
to
false. This value is stored as a lowercase string.
Constraints:
public void setStorageType(String storageType)
Specifies the storage type to be associated with the DB instance.
Valid values: standard | gp2 | io1
If you specify io1
, you must also include a value for the
Iops
parameter.
Default: io1
if the Iops
parameter is
specified; otherwise standard
storageType
- Specifies the storage type to be associated with the DB instance.
Valid values: standard | gp2 | io1
If you specify io1
, you must also include a value for
the Iops
parameter.
Default: io1
if the Iops
parameter is
specified; otherwise standard
public String getStorageType()
Specifies the storage type to be associated with the DB instance.
Valid values: standard | gp2 | io1
If you specify io1
, you must also include a value for the
Iops
parameter.
Default: io1
if the Iops
parameter is
specified; otherwise standard
Valid values: standard | gp2 | io1
If you specify io1
, you must also include a value
for the Iops
parameter.
Default: io1
if the Iops
parameter is
specified; otherwise standard
public ModifyDBInstanceRequest withStorageType(String storageType)
Specifies the storage type to be associated with the DB instance.
Valid values: standard | gp2 | io1
If you specify io1
, you must also include a value for the
Iops
parameter.
Default: io1
if the Iops
parameter is
specified; otherwise standard
storageType
- Specifies the storage type to be associated with the DB instance.
Valid values: standard | gp2 | io1
If you specify io1
, you must also include a value for
the Iops
parameter.
Default: io1
if the Iops
parameter is
specified; otherwise standard
public void setTdeCredentialArn(String tdeCredentialArn)
The ARN from the Key Store with which to associate the instance for TDE encryption.
tdeCredentialArn
- The ARN from the Key Store with which to associate the instance
for TDE encryption.public String getTdeCredentialArn()
The ARN from the Key Store with which to associate the instance for TDE encryption.
public ModifyDBInstanceRequest withTdeCredentialArn(String tdeCredentialArn)
The ARN from the Key Store with which to associate the instance for TDE encryption.
tdeCredentialArn
- The ARN from the Key Store with which to associate the instance
for TDE encryption.public void setTdeCredentialPassword(String tdeCredentialPassword)
The password for the given ARN from the Key Store in order to access the device.
tdeCredentialPassword
- The password for the given ARN from the Key Store in order to
access the device.public String getTdeCredentialPassword()
The password for the given ARN from the Key Store in order to access the device.
public ModifyDBInstanceRequest withTdeCredentialPassword(String tdeCredentialPassword)
The password for the given ARN from the Key Store in order to access the device.
tdeCredentialPassword
- The password for the given ARN from the Key Store in order to
access the device.public void setCACertificateIdentifier(String cACertificateIdentifier)
Indicates the certificate that needs to be associated with the instance.
cACertificateIdentifier
- Indicates the certificate that needs to be associated with the
instance.public String getCACertificateIdentifier()
Indicates the certificate that needs to be associated with the instance.
public ModifyDBInstanceRequest withCACertificateIdentifier(String cACertificateIdentifier)
Indicates the certificate that needs to be associated with the instance.
cACertificateIdentifier
- Indicates the certificate that needs to be associated with the
instance.public void setDomain(String domain)
Specify the Active Directory Domain to move the instance to.
The specified Active Directory Domain must be created prior to this operation. Currently only a SQL Server instance can be created in a Active Directory Domain.
domain
- Specify the Active Directory Domain to move the instance to.
The specified Active Directory Domain must be created prior to this operation. Currently only a SQL Server instance can be created in a Active Directory Domain.
public String getDomain()
Specify the Active Directory Domain to move the instance to.
The specified Active Directory Domain must be created prior to this operation. Currently only a SQL Server instance can be created in a Active Directory Domain.
The specified Active Directory Domain must be created prior to this operation. Currently only a SQL Server instance can be created in a Active Directory Domain.
public ModifyDBInstanceRequest withDomain(String domain)
Specify the Active Directory Domain to move the instance to.
The specified Active Directory Domain must be created prior to this operation. Currently only a SQL Server instance can be created in a Active Directory Domain.
domain
- Specify the Active Directory Domain to move the instance to.
The specified Active Directory Domain must be created prior to this operation. Currently only a SQL Server instance can be created in a Active Directory Domain.
public void setCopyTagsToSnapshot(Boolean copyTagsToSnapshot)
True to copy all tags from the DB instance to snapshots of the DB instance; otherwise false. The default is false.
copyTagsToSnapshot
- True to copy all tags from the DB instance to snapshots of the DB
instance; otherwise false. The default is false.public Boolean getCopyTagsToSnapshot()
True to copy all tags from the DB instance to snapshots of the DB instance; otherwise false. The default is false.
public ModifyDBInstanceRequest withCopyTagsToSnapshot(Boolean copyTagsToSnapshot)
True to copy all tags from the DB instance to snapshots of the DB instance; otherwise false. The default is false.
copyTagsToSnapshot
- True to copy all tags from the DB instance to snapshots of the DB
instance; otherwise false. The default is false.public Boolean isCopyTagsToSnapshot()
True to copy all tags from the DB instance to snapshots of the DB instance; otherwise false. The default is false.
public void setMonitoringInterval(Integer monitoringInterval)
The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB instance. To disable collecting Enhanced Monitoring metrics, specify 0. The default is 60.
If MonitoringRoleArn
is specified, then you must also set
MonitoringInterval
to a value other than 0.
Valid Values: 0, 1, 5, 10, 15, 30, 60
monitoringInterval
- The interval, in seconds, between points when Enhanced Monitoring
metrics are collected for the DB instance. To disable collecting
Enhanced Monitoring metrics, specify 0. The default is 60.
If MonitoringRoleArn
is specified, then you must also
set MonitoringInterval
to a value other than 0.
Valid Values: 0, 1, 5, 10, 15, 30, 60
public Integer getMonitoringInterval()
The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB instance. To disable collecting Enhanced Monitoring metrics, specify 0. The default is 60.
If MonitoringRoleArn
is specified, then you must also set
MonitoringInterval
to a value other than 0.
Valid Values: 0, 1, 5, 10, 15, 30, 60
If MonitoringRoleArn
is specified, then you must
also set MonitoringInterval
to a value other than 0.
Valid Values: 0, 1, 5, 10, 15, 30, 60
public ModifyDBInstanceRequest withMonitoringInterval(Integer monitoringInterval)
The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB instance. To disable collecting Enhanced Monitoring metrics, specify 0. The default is 60.
If MonitoringRoleArn
is specified, then you must also set
MonitoringInterval
to a value other than 0.
Valid Values: 0, 1, 5, 10, 15, 30, 60
monitoringInterval
- The interval, in seconds, between points when Enhanced Monitoring
metrics are collected for the DB instance. To disable collecting
Enhanced Monitoring metrics, specify 0. The default is 60.
If MonitoringRoleArn
is specified, then you must also
set MonitoringInterval
to a value other than 0.
Valid Values: 0, 1, 5, 10, 15, 30, 60
public void setDBPortNumber(Integer dBPortNumber)
The port number on which the database accepts connections.
The value of the DBPortNumber
parameter must not match any
of the port values specified for options in the option group for the DB
instance.
Your database will restart when you change the DBPortNumber
value regardless of the value of the ApplyImmediately
parameter.
MySQL
Default: 3306
Valid Values: 1150-65535
MariaDB
Default: 3306
Valid Values: 1150-65535
PostgreSQL
Default: 5432
Valid Values: 1150-65535
Type: Integer
Oracle
Default: 1521
Valid Values: 1150-65535
SQL Server
Default: 1433
Valid Values: 1150-65535
except for 1434
,
3389
, 47001
, 49152
, and
49152
through 49156
.
Amazon Aurora
Default: 3306
Valid Values: 1150-65535
dBPortNumber
- The port number on which the database accepts connections.
The value of the DBPortNumber
parameter must not
match any of the port values specified for options in the option
group for the DB instance.
Your database will restart when you change the
DBPortNumber
value regardless of the value of the
ApplyImmediately
parameter.
MySQL
Default: 3306
Valid Values: 1150-65535
MariaDB
Default: 3306
Valid Values: 1150-65535
PostgreSQL
Default: 5432
Valid Values: 1150-65535
Type: Integer
Oracle
Default: 1521
Valid Values: 1150-65535
SQL Server
Default: 1433
Valid Values: 1150-65535
except for 1434
, 3389
, 47001
, 49152
, and
49152
through 49156
.
Amazon Aurora
Default: 3306
Valid Values: 1150-65535
public Integer getDBPortNumber()
The port number on which the database accepts connections.
The value of the DBPortNumber
parameter must not match any
of the port values specified for options in the option group for the DB
instance.
Your database will restart when you change the DBPortNumber
value regardless of the value of the ApplyImmediately
parameter.
MySQL
Default: 3306
Valid Values: 1150-65535
MariaDB
Default: 3306
Valid Values: 1150-65535
PostgreSQL
Default: 5432
Valid Values: 1150-65535
Type: Integer
Oracle
Default: 1521
Valid Values: 1150-65535
SQL Server
Default: 1433
Valid Values: 1150-65535
except for 1434
,
3389
, 47001
, 49152
, and
49152
through 49156
.
Amazon Aurora
Default: 3306
Valid Values: 1150-65535
The value of the DBPortNumber
parameter must not
match any of the port values specified for options in the option
group for the DB instance.
Your database will restart when you change the
DBPortNumber
value regardless of the value of the
ApplyImmediately
parameter.
MySQL
Default: 3306
Valid Values: 1150-65535
MariaDB
Default: 3306
Valid Values: 1150-65535
PostgreSQL
Default: 5432
Valid Values: 1150-65535
Type: Integer
Oracle
Default: 1521
Valid Values: 1150-65535
SQL Server
Default: 1433
Valid Values: 1150-65535
except for
1434
, 3389
, 47001
,
49152
, and 49152
through
49156
.
Amazon Aurora
Default: 3306
Valid Values: 1150-65535
public ModifyDBInstanceRequest withDBPortNumber(Integer dBPortNumber)
The port number on which the database accepts connections.
The value of the DBPortNumber
parameter must not match any
of the port values specified for options in the option group for the DB
instance.
Your database will restart when you change the DBPortNumber
value regardless of the value of the ApplyImmediately
parameter.
MySQL
Default: 3306
Valid Values: 1150-65535
MariaDB
Default: 3306
Valid Values: 1150-65535
PostgreSQL
Default: 5432
Valid Values: 1150-65535
Type: Integer
Oracle
Default: 1521
Valid Values: 1150-65535
SQL Server
Default: 1433
Valid Values: 1150-65535
except for 1434
,
3389
, 47001
, 49152
, and
49152
through 49156
.
Amazon Aurora
Default: 3306
Valid Values: 1150-65535
dBPortNumber
- The port number on which the database accepts connections.
The value of the DBPortNumber
parameter must not
match any of the port values specified for options in the option
group for the DB instance.
Your database will restart when you change the
DBPortNumber
value regardless of the value of the
ApplyImmediately
parameter.
MySQL
Default: 3306
Valid Values: 1150-65535
MariaDB
Default: 3306
Valid Values: 1150-65535
PostgreSQL
Default: 5432
Valid Values: 1150-65535
Type: Integer
Oracle
Default: 1521
Valid Values: 1150-65535
SQL Server
Default: 1433
Valid Values: 1150-65535
except for 1434
, 3389
, 47001
, 49152
, and
49152
through 49156
.
Amazon Aurora
Default: 3306
Valid Values: 1150-65535
public void setPubliclyAccessible(Boolean publiclyAccessible)
Boolean value that indicates if the DB instance has a publicly resolvable
DNS name. Set to True
to make the DB instance
Internet-facing with a publicly resolvable DNS name, which resolves to a
public IP address. Set to False
to make the DB instance
internal with a DNS name that resolves to a private IP address.
PubliclyAccessible
only applies to DB instances in a VPC.
The DB instance must be part of a public subnet and
PubliclyAccessible
must be true in order for it to be
publicly accessible.
Changes to the PubliclyAccessible
parameter are applied
immediately regardless of the value of the ApplyImmediately
parameter.
Default: false
publiclyAccessible
- Boolean value that indicates if the DB instance has a publicly
resolvable DNS name. Set to True
to make the DB
instance Internet-facing with a publicly resolvable DNS name,
which resolves to a public IP address. Set to False
to make the DB instance internal with a DNS name that resolves to
a private IP address.
PubliclyAccessible
only applies to DB instances in a
VPC. The DB instance must be part of a public subnet and
PubliclyAccessible
must be true in order for it to be
publicly accessible.
Changes to the PubliclyAccessible
parameter are
applied immediately regardless of the value of the
ApplyImmediately
parameter.
Default: false
public Boolean getPubliclyAccessible()
Boolean value that indicates if the DB instance has a publicly resolvable
DNS name. Set to True
to make the DB instance
Internet-facing with a publicly resolvable DNS name, which resolves to a
public IP address. Set to False
to make the DB instance
internal with a DNS name that resolves to a private IP address.
PubliclyAccessible
only applies to DB instances in a VPC.
The DB instance must be part of a public subnet and
PubliclyAccessible
must be true in order for it to be
publicly accessible.
Changes to the PubliclyAccessible
parameter are applied
immediately regardless of the value of the ApplyImmediately
parameter.
Default: false
True
to make the DB
instance Internet-facing with a publicly resolvable DNS name,
which resolves to a public IP address. Set to False
to make the DB instance internal with a DNS name that resolves to
a private IP address.
PubliclyAccessible
only applies to DB instances in a
VPC. The DB instance must be part of a public subnet and
PubliclyAccessible
must be true in order for it to
be publicly accessible.
Changes to the PubliclyAccessible
parameter are
applied immediately regardless of the value of the
ApplyImmediately
parameter.
Default: false
public ModifyDBInstanceRequest withPubliclyAccessible(Boolean publiclyAccessible)
Boolean value that indicates if the DB instance has a publicly resolvable
DNS name. Set to True
to make the DB instance
Internet-facing with a publicly resolvable DNS name, which resolves to a
public IP address. Set to False
to make the DB instance
internal with a DNS name that resolves to a private IP address.
PubliclyAccessible
only applies to DB instances in a VPC.
The DB instance must be part of a public subnet and
PubliclyAccessible
must be true in order for it to be
publicly accessible.
Changes to the PubliclyAccessible
parameter are applied
immediately regardless of the value of the ApplyImmediately
parameter.
Default: false
publiclyAccessible
- Boolean value that indicates if the DB instance has a publicly
resolvable DNS name. Set to True
to make the DB
instance Internet-facing with a publicly resolvable DNS name,
which resolves to a public IP address. Set to False
to make the DB instance internal with a DNS name that resolves to
a private IP address.
PubliclyAccessible
only applies to DB instances in a
VPC. The DB instance must be part of a public subnet and
PubliclyAccessible
must be true in order for it to be
publicly accessible.
Changes to the PubliclyAccessible
parameter are
applied immediately regardless of the value of the
ApplyImmediately
parameter.
Default: false
public Boolean isPubliclyAccessible()
Boolean value that indicates if the DB instance has a publicly resolvable
DNS name. Set to True
to make the DB instance
Internet-facing with a publicly resolvable DNS name, which resolves to a
public IP address. Set to False
to make the DB instance
internal with a DNS name that resolves to a private IP address.
PubliclyAccessible
only applies to DB instances in a VPC.
The DB instance must be part of a public subnet and
PubliclyAccessible
must be true in order for it to be
publicly accessible.
Changes to the PubliclyAccessible
parameter are applied
immediately regardless of the value of the ApplyImmediately
parameter.
Default: false
True
to make the DB
instance Internet-facing with a publicly resolvable DNS name,
which resolves to a public IP address. Set to False
to make the DB instance internal with a DNS name that resolves to
a private IP address.
PubliclyAccessible
only applies to DB instances in a
VPC. The DB instance must be part of a public subnet and
PubliclyAccessible
must be true in order for it to
be publicly accessible.
Changes to the PubliclyAccessible
parameter are
applied immediately regardless of the value of the
ApplyImmediately
parameter.
Default: false
public void setMonitoringRoleArn(String monitoringRoleArn)
The ARN for the IAM role that permits RDS to send enhanced monitoring
metrics to CloudWatch Logs. For example,
arn:aws:iam:123456789012:role/emaccess
. For information on
creating a monitoring role, go to To create an IAM role for Amazon RDS Enhanced Monitoring.
If MonitoringInterval
is set to a value other than 0, then
you must supply a MonitoringRoleArn
value.
monitoringRoleArn
- The ARN for the IAM role that permits RDS to send enhanced
monitoring metrics to CloudWatch Logs. For example,
arn:aws:iam:123456789012:role/emaccess
. For
information on creating a monitoring role, go to To create an IAM role for Amazon RDS Enhanced Monitoring.
If MonitoringInterval
is set to a value other than 0,
then you must supply a MonitoringRoleArn
value.
public String getMonitoringRoleArn()
The ARN for the IAM role that permits RDS to send enhanced monitoring
metrics to CloudWatch Logs. For example,
arn:aws:iam:123456789012:role/emaccess
. For information on
creating a monitoring role, go to To create an IAM role for Amazon RDS Enhanced Monitoring.
If MonitoringInterval
is set to a value other than 0, then
you must supply a MonitoringRoleArn
value.
arn:aws:iam:123456789012:role/emaccess
. For
information on creating a monitoring role, go to To create an IAM role for Amazon RDS Enhanced
Monitoring.
If MonitoringInterval
is set to a value other than
0, then you must supply a MonitoringRoleArn
value.
public ModifyDBInstanceRequest withMonitoringRoleArn(String monitoringRoleArn)
The ARN for the IAM role that permits RDS to send enhanced monitoring
metrics to CloudWatch Logs. For example,
arn:aws:iam:123456789012:role/emaccess
. For information on
creating a monitoring role, go to To create an IAM role for Amazon RDS Enhanced Monitoring.
If MonitoringInterval
is set to a value other than 0, then
you must supply a MonitoringRoleArn
value.
monitoringRoleArn
- The ARN for the IAM role that permits RDS to send enhanced
monitoring metrics to CloudWatch Logs. For example,
arn:aws:iam:123456789012:role/emaccess
. For
information on creating a monitoring role, go to To create an IAM role for Amazon RDS Enhanced Monitoring.
If MonitoringInterval
is set to a value other than 0,
then you must supply a MonitoringRoleArn
value.
public void setDomainIAMRoleName(String domainIAMRoleName)
Specify the name of the IAM role to be used when making API calls to the Directory Service.
domainIAMRoleName
- Specify the name of the IAM role to be used when making API calls
to the Directory Service.public String getDomainIAMRoleName()
Specify the name of the IAM role to be used when making API calls to the Directory Service.
public ModifyDBInstanceRequest withDomainIAMRoleName(String domainIAMRoleName)
Specify the name of the IAM role to be used when making API calls to the Directory Service.
domainIAMRoleName
- Specify the name of the IAM role to be used when making API calls
to the Directory Service.public void setPromotionTier(Integer promotionTier)
A value that specifies the order in which an Aurora Replica is promoted to the primary instance after a failure of the existing primary instance. For more information, see Fault Tolerance for an Aurora DB Cluster.
Default: 1
Valid Values: 0 - 15
promotionTier
- A value that specifies the order in which an Aurora Replica is
promoted to the primary instance after a failure of the existing
primary instance. For more information, see Fault Tolerance for an Aurora DB Cluster.
Default: 1
Valid Values: 0 - 15
public Integer getPromotionTier()
A value that specifies the order in which an Aurora Replica is promoted to the primary instance after a failure of the existing primary instance. For more information, see Fault Tolerance for an Aurora DB Cluster.
Default: 1
Valid Values: 0 - 15
Default: 1
Valid Values: 0 - 15
public ModifyDBInstanceRequest withPromotionTier(Integer promotionTier)
A value that specifies the order in which an Aurora Replica is promoted to the primary instance after a failure of the existing primary instance. For more information, see Fault Tolerance for an Aurora DB Cluster.
Default: 1
Valid Values: 0 - 15
promotionTier
- A value that specifies the order in which an Aurora Replica is
promoted to the primary instance after a failure of the existing
primary instance. For more information, see Fault Tolerance for an Aurora DB Cluster.
Default: 1
Valid Values: 0 - 15
public String toString()
toString
in class Object
Object.toString()
public ModifyDBInstanceRequest clone()
AmazonWebServiceRequest
clone
in class AmazonWebServiceRequest
Object.clone()
Copyright © 2013 Amazon Web Services, Inc. All Rights Reserved.