@Generated(value="com.amazonaws:aws-java-sdk-code-generator") 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 object for all fields except the handler context.
|
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 are 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, for example,
db.m4.large . |
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 |
getDBSubnetGroupName()
The new DB subnet group for the DB instance.
|
String |
getDomain()
The Active Directory Domain to move the instance to.
|
String |
getDomainIAMRoleName()
The name of the IAM role to use when making API calls to the Directory Service.
|
Boolean |
getEnableIAMDatabaseAuthentication()
True to enable mapping of AWS Identity and Access Management (IAM) accounts to database accounts; otherwise
false.
|
Boolean |
getEnablePerformanceInsights()
True to enable Performance Insights for the DB instance; otherwise false.
|
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 |
getLicenseModel()
The license model for the DB instance.
|
String |
getMasterUserPassword()
The new password for the 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 |
getPerformanceInsightsKMSKeyId()
The KMS key identifier for encryption of Performance Insights data.
|
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 are 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 |
isEnableIAMDatabaseAuthentication()
True to enable mapping of AWS Identity and Access Management (IAM) accounts to database accounts; otherwise
false.
|
Boolean |
isEnablePerformanceInsights()
True to enable Performance Insights for 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 are 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, for example,
db.m4.large . |
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 |
setDBSubnetGroupName(String dBSubnetGroupName)
The new DB subnet group for the DB instance.
|
void |
setDomain(String domain)
The Active Directory Domain to move the instance to.
|
void |
setDomainIAMRoleName(String domainIAMRoleName)
The name of the IAM role to use when making API calls to the Directory Service.
|
void |
setEnableIAMDatabaseAuthentication(Boolean enableIAMDatabaseAuthentication)
True to enable mapping of AWS Identity and Access Management (IAM) accounts to database accounts; otherwise
false.
|
void |
setEnablePerformanceInsights(Boolean enablePerformanceInsights)
True to enable Performance Insights for the DB instance; otherwise false.
|
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 |
setLicenseModel(String licenseModel)
The license model for the DB instance.
|
void |
setMasterUserPassword(String masterUserPassword)
The new password for the 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 |
setPerformanceInsightsKMSKeyId(String performanceInsightsKMSKeyId)
The KMS key identifier for encryption of Performance Insights data.
|
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 are 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, for example,
db.m4.large . |
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 |
withDBSubnetGroupName(String dBSubnetGroupName)
The new DB subnet group for the DB instance.
|
ModifyDBInstanceRequest |
withDomain(String domain)
The Active Directory Domain to move the instance to.
|
ModifyDBInstanceRequest |
withDomainIAMRoleName(String domainIAMRoleName)
The name of the IAM role to use when making API calls to the Directory Service.
|
ModifyDBInstanceRequest |
withEnableIAMDatabaseAuthentication(Boolean enableIAMDatabaseAuthentication)
True to enable mapping of AWS Identity and Access Management (IAM) accounts to database accounts; otherwise
false.
|
ModifyDBInstanceRequest |
withEnablePerformanceInsights(Boolean enablePerformanceInsights)
True to enable Performance Insights for the DB instance; otherwise false.
|
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 |
withLicenseModel(String licenseModel)
The license model for the DB instance.
|
ModifyDBInstanceRequest |
withMasterUserPassword(String masterUserPassword)
The new password for the 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 |
withPerformanceInsightsKMSKeyId(String performanceInsightsKMSKeyId)
The KMS key identifier for encryption of Performance Insights data.
|
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.
|
addHandlerContext, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getHandlerContext, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestCredentialsProvider, withRequestMetricCollector, withSdkClientExecutionTimeout, withSdkRequestTimeout
public ModifyDBInstanceRequest()
public ModifyDBInstanceRequest(String dBInstanceIdentifier)
dBInstanceIdentifier
- The DB instance identifier. This value is stored as a lowercase string.
Constraints:
Must match the identifier of an existing DBInstance.
public void setDBInstanceIdentifier(String dBInstanceIdentifier)
The DB instance identifier. This value is stored as a lowercase string.
Constraints:
Must match the identifier of an existing DBInstance.
dBInstanceIdentifier
- The DB instance identifier. This value is stored as a lowercase string.
Constraints:
Must match the identifier of an existing DBInstance.
public String getDBInstanceIdentifier()
The DB instance identifier. This value is stored as a lowercase string.
Constraints:
Must match the identifier of an existing DBInstance.
Constraints:
Must match the identifier of an existing DBInstance.
public ModifyDBInstanceRequest withDBInstanceIdentifier(String dBInstanceIdentifier)
The DB instance identifier. This value is stored as a lowercase string.
Constraints:
Must match the identifier of an existing DBInstance.
dBInstanceIdentifier
- The DB instance identifier. This value is stored as a lowercase string.
Constraints:
Must match the identifier of an existing DBInstance.
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 is available for use, but might experience performance degradation. While the migration takes place, nightly backups for the instance are 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 is available for use, but might experience performance degradation. While the migration takes place, nightly backups for the instance are 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 is available for use, but might experience performance degradation. While the migration takes place, nightly backups for the instance are 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 is available for use, but might experience performance degradation. While the migration takes place, nightly backups for the instance are 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 is available for use, but might experience performance degradation. While the migration takes place, nightly backups for the instance are 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 is available for use, but might experience performance degradation. While the migration takes place, nightly backups for the instance are 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, for example, db.m4.large
. Not all DB
instance classes are available in all regions, or for all database engines. For the full list of DB instance
classes, and availability for your engine, see DB Instance Class
in the Amazon RDS User Guide.
If you modify the DB instance class, an outage occurs during the change. The change is applied during the next
maintenance window, unless ApplyImmediately
is specified as true
for this request.
Default: Uses existing setting
dBInstanceClass
- The new compute and memory capacity of the DB instance, for example, db.m4.large
. Not all DB
instance classes are available in all regions, or for all database engines. For the full list of DB
instance classes, and availability for your engine, see DB Instance
Class in the Amazon RDS User Guide.
If you modify the DB instance class, an outage occurs during the change. The change is applied during the
next maintenance window, unless ApplyImmediately
is specified as true
for this
request.
Default: Uses existing setting
public String getDBInstanceClass()
The new compute and memory capacity of the DB instance, for example, db.m4.large
. Not all DB
instance classes are available in all regions, or for all database engines. For the full list of DB instance
classes, and availability for your engine, see DB Instance Class
in the Amazon RDS User Guide.
If you modify the DB instance class, an outage occurs during the change. The change is applied during the next
maintenance window, unless ApplyImmediately
is specified as true
for this request.
Default: Uses existing setting
db.m4.large
. Not all DB
instance classes are available in all regions, or for all database engines. For the full list of DB
instance classes, and availability for your engine, see DB Instance
Class in the Amazon RDS User Guide.
If you modify the DB instance class, an outage occurs during the change. The change is applied during the
next maintenance window, unless ApplyImmediately
is specified as true
for this
request.
Default: Uses existing setting
public ModifyDBInstanceRequest withDBInstanceClass(String dBInstanceClass)
The new compute and memory capacity of the DB instance, for example, db.m4.large
. Not all DB
instance classes are available in all regions, or for all database engines. For the full list of DB instance
classes, and availability for your engine, see DB Instance Class
in the Amazon RDS User Guide.
If you modify the DB instance class, an outage occurs during the change. The change is applied during the next
maintenance window, unless ApplyImmediately
is specified as true
for this request.
Default: Uses existing setting
dBInstanceClass
- The new compute and memory capacity of the DB instance, for example, db.m4.large
. Not all DB
instance classes are available in all regions, or for all database engines. For the full list of DB
instance classes, and availability for your engine, see DB Instance
Class in the Amazon RDS User Guide.
If you modify the DB instance class, an outage occurs during the change. The change is applied during the
next maintenance window, unless ApplyImmediately
is specified as true
for this
request.
Default: Uses existing setting
public void setDBSubnetGroupName(String dBSubnetGroupName)
The new DB subnet group for the DB instance. You can use this parameter to move your DB instance to a different VPC. If your DB instance is not in a VPC, you can also use this parameter to move your DB instance into a VPC. For more information, see Updating the VPC for a DB Instance.
Changing the subnet group causes an outage during the change. The change is applied during the next maintenance
window, unless you specify true
for the ApplyImmediately
parameter.
Constraints: If supplied, must match the name of an existing DBSubnetGroup.
Example: mySubnetGroup
dBSubnetGroupName
- The new DB subnet group for the DB instance. You can use this parameter to move your DB instance to a
different VPC. If your DB instance is not in a VPC, you can also use this parameter to move your DB
instance into a VPC. For more information, see Updating the VPC for a DB Instance.
Changing the subnet group causes an outage during the change. The change is applied during the next
maintenance window, unless you specify true
for the ApplyImmediately
parameter.
Constraints: If supplied, must match the name of an existing DBSubnetGroup.
Example: mySubnetGroup
public String getDBSubnetGroupName()
The new DB subnet group for the DB instance. You can use this parameter to move your DB instance to a different VPC. If your DB instance is not in a VPC, you can also use this parameter to move your DB instance into a VPC. For more information, see Updating the VPC for a DB Instance.
Changing the subnet group causes an outage during the change. The change is applied during the next maintenance
window, unless you specify true
for the ApplyImmediately
parameter.
Constraints: If supplied, must match the name of an existing DBSubnetGroup.
Example: mySubnetGroup
Changing the subnet group causes an outage during the change. The change is applied during the next
maintenance window, unless you specify true
for the ApplyImmediately
parameter.
Constraints: If supplied, must match the name of an existing DBSubnetGroup.
Example: mySubnetGroup
public ModifyDBInstanceRequest withDBSubnetGroupName(String dBSubnetGroupName)
The new DB subnet group for the DB instance. You can use this parameter to move your DB instance to a different VPC. If your DB instance is not in a VPC, you can also use this parameter to move your DB instance into a VPC. For more information, see Updating the VPC for a DB Instance.
Changing the subnet group causes an outage during the change. The change is applied during the next maintenance
window, unless you specify true
for the ApplyImmediately
parameter.
Constraints: If supplied, must match the name of an existing DBSubnetGroup.
Example: mySubnetGroup
dBSubnetGroupName
- The new DB subnet group for the DB instance. You can use this parameter to move your DB instance to a
different VPC. If your DB instance is not in a VPC, you can also use this parameter to move your DB
instance into a VPC. For more information, see Updating the VPC for a DB Instance.
Changing the subnet group causes an outage during the change. The change is applied during the next
maintenance window, unless you specify true
for the ApplyImmediately
parameter.
Constraints: If supplied, must match the name of an existing DBSubnetGroup.
Example: mySubnetGroup
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:
If supplied, must match existing DBSecurityGroups.
Constraints:
If supplied, must match existing DBSecurityGroups.
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:
If supplied, must match existing DBSecurityGroups.
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:
If supplied, must match existing DBSecurityGroups.
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:
If supplied, must match existing DBSecurityGroups.
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:
If supplied, must match existing DBSecurityGroups.
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:
If supplied, must match existing DBSecurityGroups.
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:
If supplied, must match existing DBSecurityGroups.
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.
Amazon Aurora
Not applicable. The associated list of EC2 VPC security groups is managed by the DB cluster. For more information, see ModifyDBCluster.
Constraints:
If supplied, must match existing VpcSecurityGroupIds.
Amazon Aurora
Not applicable. The associated list of EC2 VPC security groups is managed by the DB cluster. For more information, see ModifyDBCluster.
Constraints:
If supplied, must match existing VpcSecurityGroupIds.
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.
Amazon Aurora
Not applicable. The associated list of EC2 VPC security groups is managed by the DB cluster. For more information, see ModifyDBCluster.
Constraints:
If supplied, must match existing VpcSecurityGroupIds.
vpcSecurityGroupIds
- A list of EC2 VPC security groups to authorize on this DB instance. This change is asynchronously applied
as soon as possible.
Amazon Aurora
Not applicable. The associated list of EC2 VPC security groups is managed by the DB cluster. For more information, see ModifyDBCluster.
Constraints:
If supplied, must match existing VpcSecurityGroupIds.
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.
Amazon Aurora
Not applicable. The associated list of EC2 VPC security groups is managed by the DB cluster. For more information, see ModifyDBCluster.
Constraints:
If supplied, must match existing VpcSecurityGroupIds.
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.
Amazon Aurora
Not applicable. The associated list of EC2 VPC security groups is managed by the DB cluster. For more information, see ModifyDBCluster.
Constraints:
If supplied, must match existing VpcSecurityGroupIds.
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.
Amazon Aurora
Not applicable. The associated list of EC2 VPC security groups is managed by the DB cluster. For more information, see ModifyDBCluster.
Constraints:
If supplied, must match existing VpcSecurityGroupIds.
vpcSecurityGroupIds
- A list of EC2 VPC security groups to authorize on this DB instance. This change is asynchronously applied
as soon as possible.
Amazon Aurora
Not applicable. The associated list of EC2 VPC security groups is managed by the DB cluster. For more information, see ModifyDBCluster.
Constraints:
If supplied, must match existing VpcSecurityGroupIds.
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 are 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 are 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 are 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 are 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 are 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 are 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 are 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 are 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 are 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 are 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 are 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 are 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 are 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 are 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 are 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 are applied.
Default: false
public void setMasterUserPassword(String masterUserPassword)
The new password for the 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.
Amazon Aurora
Not applicable. The password for the master user is managed by the DB cluster. For more information, see ModifyDBCluster.
Default: Uses existing setting
MariaDB
Constraints: Must contain from 8 to 41 characters.
Microsoft SQL Server
Constraints: Must contain from 8 to 128 characters.
MySQL
Constraints: Must contain from 8 to 41 characters.
Oracle
Constraints: Must contain from 8 to 30 characters.
PostgreSQL
Constraints: Must contain from 8 to 128 characters.
Amazon RDS API actions never return the password, so this action provides a way to regain access to a primary instance user if the password is lost. This includes restoring privileges that might have been accidentally revoked.
masterUserPassword
- The new password for the 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.
Amazon Aurora
Not applicable. The password for the master user is managed by the DB cluster. For more information, see ModifyDBCluster.
Default: Uses existing setting
MariaDB
Constraints: Must contain from 8 to 41 characters.
Microsoft SQL Server
Constraints: Must contain from 8 to 128 characters.
MySQL
Constraints: Must contain from 8 to 41 characters.
Oracle
Constraints: Must contain from 8 to 30 characters.
PostgreSQL
Constraints: Must contain from 8 to 128 characters.
Amazon RDS API actions never return the password, so this action provides a way to regain access to a primary instance user if the password is lost. This includes restoring privileges that might have been accidentally revoked.
public String getMasterUserPassword()
The new password for the 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.
Amazon Aurora
Not applicable. The password for the master user is managed by the DB cluster. For more information, see ModifyDBCluster.
Default: Uses existing setting
MariaDB
Constraints: Must contain from 8 to 41 characters.
Microsoft SQL Server
Constraints: Must contain from 8 to 128 characters.
MySQL
Constraints: Must contain from 8 to 41 characters.
Oracle
Constraints: Must contain from 8 to 30 characters.
PostgreSQL
Constraints: Must contain from 8 to 128 characters.
Amazon RDS API actions never return the password, so this action provides a way to regain access to a primary instance user if the password is lost. This includes restoring privileges that might have been accidentally revoked.
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.
Amazon Aurora
Not applicable. The password for the master user is managed by the DB cluster. For more information, see ModifyDBCluster.
Default: Uses existing setting
MariaDB
Constraints: Must contain from 8 to 41 characters.
Microsoft SQL Server
Constraints: Must contain from 8 to 128 characters.
MySQL
Constraints: Must contain from 8 to 41 characters.
Oracle
Constraints: Must contain from 8 to 30 characters.
PostgreSQL
Constraints: Must contain from 8 to 128 characters.
Amazon RDS API actions never return the password, so this action provides a way to regain access to a primary instance user if the password is lost. This includes restoring privileges that might have been accidentally revoked.
public ModifyDBInstanceRequest withMasterUserPassword(String masterUserPassword)
The new password for the 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.
Amazon Aurora
Not applicable. The password for the master user is managed by the DB cluster. For more information, see ModifyDBCluster.
Default: Uses existing setting
MariaDB
Constraints: Must contain from 8 to 41 characters.
Microsoft SQL Server
Constraints: Must contain from 8 to 128 characters.
MySQL
Constraints: Must contain from 8 to 41 characters.
Oracle
Constraints: Must contain from 8 to 30 characters.
PostgreSQL
Constraints: Must contain from 8 to 128 characters.
Amazon RDS API actions never return the password, so this action provides a way to regain access to a primary instance user if the password is lost. This includes restoring privileges that might have been accidentally revoked.
masterUserPassword
- The new password for the 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.
Amazon Aurora
Not applicable. The password for the master user is managed by the DB cluster. For more information, see ModifyDBCluster.
Default: Uses existing setting
MariaDB
Constraints: Must contain from 8 to 41 characters.
Microsoft SQL Server
Constraints: Must contain from 8 to 128 characters.
MySQL
Constraints: Must contain from 8 to 41 characters.
Oracle
Constraints: Must contain from 8 to 30 characters.
PostgreSQL
Constraints: Must contain from 8 to 128 characters.
Amazon RDS API actions never return the password, so this action provides a way to regain access to a primary instance user if the password is lost. This includes restoring privileges that might have been accidentally revoked.
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.
Amazon Aurora
Not applicable. The retention period for automated backups is managed by the DB cluster. For more information, see ModifyDBCluster.
Default: Uses existing setting
Constraints:
Must be a value from 0 to 35
Can be specified for a MySQL Read Replica only if the source is running MySQL 5.6
Can be specified for a PostgreSQL Read Replica only if the source is running PostgreSQL 9.3.5
Cannot be set to 0 if the DB instance is a source to Read Replicas
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.
Amazon Aurora
Not applicable. The retention period for automated backups is managed by the DB cluster. For more information, see ModifyDBCluster.
Default: Uses existing setting
Constraints:
Must be a value from 0 to 35
Can be specified for a MySQL Read Replica only if the source is running MySQL 5.6
Can be specified for a PostgreSQL Read Replica only if the source is running PostgreSQL 9.3.5
Cannot be set to 0 if the DB instance is a source to Read Replicas
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.
Amazon Aurora
Not applicable. The retention period for automated backups is managed by the DB cluster. For more information, see ModifyDBCluster.
Default: Uses existing setting
Constraints:
Must be a value from 0 to 35
Can be specified for a MySQL Read Replica only if the source is running MySQL 5.6
Can be specified for a PostgreSQL Read Replica only if the source is running PostgreSQL 9.3.5
Cannot be set to 0 if the DB instance is a source to Read Replicas
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.
Amazon Aurora
Not applicable. The retention period for automated backups is managed by the DB cluster. For more information, see ModifyDBCluster.
Default: Uses existing setting
Constraints:
Must be a value from 0 to 35
Can be specified for a MySQL Read Replica only if the source is running MySQL 5.6
Can be specified for a PostgreSQL Read Replica only if the source is running PostgreSQL 9.3.5
Cannot be set to 0 if the DB instance is a source to Read Replicas
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.
Amazon Aurora
Not applicable. The retention period for automated backups is managed by the DB cluster. For more information, see ModifyDBCluster.
Default: Uses existing setting
Constraints:
Must be a value from 0 to 35
Can be specified for a MySQL Read Replica only if the source is running MySQL 5.6
Can be specified for a PostgreSQL Read Replica only if the source is running PostgreSQL 9.3.5
Cannot be set to 0 if the DB instance is a source to Read Replicas
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.
Amazon Aurora
Not applicable. The retention period for automated backups is managed by the DB cluster. For more information, see ModifyDBCluster.
Default: Uses existing setting
Constraints:
Must be a value from 0 to 35
Can be specified for a MySQL Read Replica only if the source is running MySQL 5.6
Can be specified for a PostgreSQL Read Replica only if the source is running PostgreSQL 9.3.5
Cannot be set to 0 if the DB instance is a source to Read Replicas
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.
Amazon Aurora
Not applicable. The daily time range for creating automated backups is managed by the DB cluster. For more information, see ModifyDBCluster.
Constraints:
Must be in the format hh24:mi-hh24:mi
Times should be in Universal Time Coordinated (UTC)
Must not conflict with the preferred maintenance window
Must be at least 30 minutes
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.
Amazon Aurora
Not applicable. The daily time range for creating automated backups is managed by the DB cluster. For more information, see ModifyDBCluster.
Constraints:
Must be in the format hh24:mi-hh24:mi
Times should be in Universal Time Coordinated (UTC)
Must not conflict with the preferred maintenance window
Must be at least 30 minutes
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.
Amazon Aurora
Not applicable. The daily time range for creating automated backups is managed by the DB cluster. For more information, see ModifyDBCluster.
Constraints:
Must be in the format hh24:mi-hh24:mi
Times should be in Universal Time Coordinated (UTC)
Must not conflict with the preferred maintenance window
Must be at least 30 minutes
BackupRetentionPeriod
parameter. Changing this parameter does not result
in an outage and the change is asynchronously applied as soon as possible.
Amazon Aurora
Not applicable. The daily time range for creating automated backups is managed by the DB cluster. For more information, see ModifyDBCluster.
Constraints:
Must be in the format hh24:mi-hh24:mi
Times should be in Universal Time Coordinated (UTC)
Must not conflict with the preferred maintenance window
Must be at least 30 minutes
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.
Amazon Aurora
Not applicable. The daily time range for creating automated backups is managed by the DB cluster. For more information, see ModifyDBCluster.
Constraints:
Must be in the format hh24:mi-hh24:mi
Times should be in Universal Time Coordinated (UTC)
Must not conflict with the preferred maintenance window
Must be at least 30 minutes
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.
Amazon Aurora
Not applicable. The daily time range for creating automated backups is managed by the DB cluster. For more information, see ModifyDBCluster.
Constraints:
Must be in the format hh24:mi-hh24:mi
Times should be in Universal Time Coordinated (UTC)
Must not conflict with the preferred maintenance window
Must be at least 30 minutes
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.
multiAZ
- Specifies if the DB instance is a Multi-AZ deployment. Changing this parameter does not result in an
outage and the change is applied during the next maintenance window unless the
ApplyImmediately
parameter is set to true
for this request.
Constraints: Cannot be specified if the DB instance is a Read Replica.
public 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.
ApplyImmediately
parameter is set to true
for this request.
Constraints: Cannot be specified if the DB instance is a Read Replica.
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.
multiAZ
- Specifies if the DB instance is a Multi-AZ deployment. Changing this parameter does not result in an
outage and the change is applied during the next maintenance window unless the
ApplyImmediately
parameter is set to true
for this request.
Constraints: Cannot be specified if the DB instance is a Read Replica.
public 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.
ApplyImmediately
parameter is set to true
for this request.
Constraints: Cannot be specified if the DB instance is a Read Replica.
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 nondefault DB parameter group is currently in use, a new DB parameter group in the DB parameter group family for the new engine version must be specified. The new DB parameter group can be the default for that DB parameter group family.
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 nondefault DB parameter group is currently in use, a new DB parameter group in the DB parameter group family for the new engine version must be specified. The new DB parameter group can be the default for that DB parameter group family.
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 nondefault DB parameter group is currently in use, a new DB parameter group in the DB parameter group family for the new engine version must be specified. The new DB parameter group can be the default for that DB parameter group family.
For a list of valid engine versions, see CreateDBInstance.
ApplyImmediately
parameter is set to true
for this request.
For major version upgrades, if a nondefault DB parameter group is currently in use, a new DB parameter group in the DB parameter group family for the new engine version must be specified. The new DB parameter group can be the default for that DB parameter group family.
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 nondefault DB parameter group is currently in use, a new DB parameter group in the DB parameter group family for the new engine version must be specified. The new DB parameter group can be the default for that DB parameter group family.
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 nondefault DB parameter group is currently in use, a new DB parameter group in the DB parameter group family for the new engine version must be specified. The new DB parameter group can be the default for that DB parameter group family.
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 are 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 are 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 are 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 are 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 are 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 are 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 setLicenseModel(String licenseModel)
The license model for the DB instance.
Valid values: license-included
| bring-your-own-license
|
general-public-license
licenseModel
- The license model for the DB instance.
Valid values: license-included
| bring-your-own-license
|
general-public-license
public String getLicenseModel()
The license model for the DB instance.
Valid values: license-included
| bring-your-own-license
|
general-public-license
Valid values: license-included
| bring-your-own-license
|
general-public-license
public ModifyDBInstanceRequest withLicenseModel(String licenseModel)
The license model for the DB instance.
Valid values: license-included
| bring-your-own-license
|
general-public-license
licenseModel
- The license model for the DB instance.
Valid values: license-included
| bring-your-own-license
|
general-public-license
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 is available for use, but might experience performance degradation. While the migration takes place, nightly backups for the instance are 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 is available for use, but might experience performance degradation. While the migration takes place, nightly backups for the instance are 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 is available for use, but might experience performance degradation. While the migration takes place, nightly backups for the instance are 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 is available for use, but might experience performance degradation. While the migration takes place, nightly backups for the instance are 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 is available for use, but might experience performance degradation. While the migration takes place, nightly backups for the instance are 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 is available for use, but might experience performance degradation. While the migration takes place, nightly backups for the instance are 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:
Must contain from 1 to 63 letters, numbers, or hyphens.
The first character must be a letter.
Cannot end with a hyphen or contain two consecutive hyphens.
Example: mydbinstance
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:
Must contain from 1 to 63 letters, numbers, or hyphens.
The first character must be a letter.
Cannot end with a hyphen or contain two consecutive hyphens.
Example: mydbinstance
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:
Must contain from 1 to 63 letters, numbers, or hyphens.
The first character must be a letter.
Cannot end with a hyphen or contain two consecutive hyphens.
Example: mydbinstance
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:
Must contain from 1 to 63 letters, numbers, or hyphens.
The first character must be a letter.
Cannot end with a hyphen or contain two consecutive hyphens.
Example: mydbinstance
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:
Must contain from 1 to 63 letters, numbers, or hyphens.
The first character must be a letter.
Cannot end with a hyphen or contain two consecutive hyphens.
Example: mydbinstance
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:
Must contain from 1 to 63 letters, numbers, or hyphens.
The first character must be a letter.
Cannot end with a hyphen or contain two consecutive hyphens.
Example: mydbinstance
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)
The Active Directory Domain to move the instance to. Specify none
to remove the instance from its
current domain. The domain must be created prior to this operation. Currently only a Microsoft SQL Server
instance can be created in a Active Directory Domain.
domain
- The Active Directory Domain to move the instance to. Specify none
to remove the instance from
its current domain. The domain must be created prior to this operation. Currently only a Microsoft SQL
Server instance can be created in a Active Directory Domain.public String getDomain()
The Active Directory Domain to move the instance to. Specify none
to remove the instance from its
current domain. The domain must be created prior to this operation. Currently only a Microsoft SQL Server
instance can be created in a Active Directory Domain.
none
to remove the instance
from its current domain. The domain must be created prior to this operation. Currently only a Microsoft
SQL Server instance can be created in a Active Directory Domain.public ModifyDBInstanceRequest withDomain(String domain)
The Active Directory Domain to move the instance to. Specify none
to remove the instance from its
current domain. The domain must be created prior to this operation. Currently only a Microsoft SQL Server
instance can be created in a Active Directory Domain.
domain
- The Active Directory Domain to move the instance to. Specify none
to remove the instance from
its current domain. The domain must be created prior to this operation. Currently only a Microsoft 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 0.
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 0.
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 0.
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 0.
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 0.
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)
The name of the IAM role to use when making API calls to the Directory Service.
domainIAMRoleName
- The name of the IAM role to use when making API calls to the Directory Service.public String getDomainIAMRoleName()
The name of the IAM role to use when making API calls to the Directory Service.
public ModifyDBInstanceRequest withDomainIAMRoleName(String domainIAMRoleName)
The name of the IAM role to use when making API calls to the Directory Service.
domainIAMRoleName
- The name of the IAM role to use 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 void setEnableIAMDatabaseAuthentication(Boolean enableIAMDatabaseAuthentication)
True to enable mapping of AWS Identity and Access Management (IAM) accounts to database accounts; otherwise false.
You can enable IAM database authentication for the following database engines
Amazon Aurora
Not applicable. Mapping AWS IAM accounts to database accounts is managed by the DB cluster. For more information, see ModifyDBCluster.
MySQL
For MySQL 5.6, minor version 5.6.34 or higher
For MySQL 5.7, minor version 5.7.16 or higher
Default: false
enableIAMDatabaseAuthentication
- True to enable mapping of AWS Identity and Access Management (IAM) accounts to database accounts;
otherwise false.
You can enable IAM database authentication for the following database engines
Amazon Aurora
Not applicable. Mapping AWS IAM accounts to database accounts is managed by the DB cluster. For more information, see ModifyDBCluster.
MySQL
For MySQL 5.6, minor version 5.6.34 or higher
For MySQL 5.7, minor version 5.7.16 or higher
Default: false
public Boolean getEnableIAMDatabaseAuthentication()
True to enable mapping of AWS Identity and Access Management (IAM) accounts to database accounts; otherwise false.
You can enable IAM database authentication for the following database engines
Amazon Aurora
Not applicable. Mapping AWS IAM accounts to database accounts is managed by the DB cluster. For more information, see ModifyDBCluster.
MySQL
For MySQL 5.6, minor version 5.6.34 or higher
For MySQL 5.7, minor version 5.7.16 or higher
Default: false
You can enable IAM database authentication for the following database engines
Amazon Aurora
Not applicable. Mapping AWS IAM accounts to database accounts is managed by the DB cluster. For more information, see ModifyDBCluster.
MySQL
For MySQL 5.6, minor version 5.6.34 or higher
For MySQL 5.7, minor version 5.7.16 or higher
Default: false
public ModifyDBInstanceRequest withEnableIAMDatabaseAuthentication(Boolean enableIAMDatabaseAuthentication)
True to enable mapping of AWS Identity and Access Management (IAM) accounts to database accounts; otherwise false.
You can enable IAM database authentication for the following database engines
Amazon Aurora
Not applicable. Mapping AWS IAM accounts to database accounts is managed by the DB cluster. For more information, see ModifyDBCluster.
MySQL
For MySQL 5.6, minor version 5.6.34 or higher
For MySQL 5.7, minor version 5.7.16 or higher
Default: false
enableIAMDatabaseAuthentication
- True to enable mapping of AWS Identity and Access Management (IAM) accounts to database accounts;
otherwise false.
You can enable IAM database authentication for the following database engines
Amazon Aurora
Not applicable. Mapping AWS IAM accounts to database accounts is managed by the DB cluster. For more information, see ModifyDBCluster.
MySQL
For MySQL 5.6, minor version 5.6.34 or higher
For MySQL 5.7, minor version 5.7.16 or higher
Default: false
public Boolean isEnableIAMDatabaseAuthentication()
True to enable mapping of AWS Identity and Access Management (IAM) accounts to database accounts; otherwise false.
You can enable IAM database authentication for the following database engines
Amazon Aurora
Not applicable. Mapping AWS IAM accounts to database accounts is managed by the DB cluster. For more information, see ModifyDBCluster.
MySQL
For MySQL 5.6, minor version 5.6.34 or higher
For MySQL 5.7, minor version 5.7.16 or higher
Default: false
You can enable IAM database authentication for the following database engines
Amazon Aurora
Not applicable. Mapping AWS IAM accounts to database accounts is managed by the DB cluster. For more information, see ModifyDBCluster.
MySQL
For MySQL 5.6, minor version 5.6.34 or higher
For MySQL 5.7, minor version 5.7.16 or higher
Default: false
public void setEnablePerformanceInsights(Boolean enablePerformanceInsights)
True to enable Performance Insights for the DB instance; otherwise false.
enablePerformanceInsights
- True to enable Performance Insights for the DB instance; otherwise false.public Boolean getEnablePerformanceInsights()
True to enable Performance Insights for the DB instance; otherwise false.
public ModifyDBInstanceRequest withEnablePerformanceInsights(Boolean enablePerformanceInsights)
True to enable Performance Insights for the DB instance; otherwise false.
enablePerformanceInsights
- True to enable Performance Insights for the DB instance; otherwise false.public Boolean isEnablePerformanceInsights()
True to enable Performance Insights for the DB instance; otherwise false.
public void setPerformanceInsightsKMSKeyId(String performanceInsightsKMSKeyId)
The KMS key identifier for encryption of Performance Insights data. The KMS key ID is the Amazon Resource Name (ARN), KMS key identifier, or the KMS key alias for the KMS encryption key.
performanceInsightsKMSKeyId
- The KMS key identifier for encryption of Performance Insights data. The KMS key ID is the Amazon Resource
Name (ARN), KMS key identifier, or the KMS key alias for the KMS encryption key.public String getPerformanceInsightsKMSKeyId()
The KMS key identifier for encryption of Performance Insights data. The KMS key ID is the Amazon Resource Name (ARN), KMS key identifier, or the KMS key alias for the KMS encryption key.
public ModifyDBInstanceRequest withPerformanceInsightsKMSKeyId(String performanceInsightsKMSKeyId)
The KMS key identifier for encryption of Performance Insights data. The KMS key ID is the Amazon Resource Name (ARN), KMS key identifier, or the KMS key alias for the KMS encryption key.
performanceInsightsKMSKeyId
- The KMS key identifier for encryption of Performance Insights data. The KMS key ID is the Amazon Resource
Name (ARN), KMS key identifier, or the KMS key alias for the KMS encryption key.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.