@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 amount of storage (in gibibytes) to allocate for the DB instance.
|
Boolean |
getAllowMajorVersionUpgrade()
A value that indicates whether major version upgrades are allowed.
|
Boolean |
getApplyImmediately()
A value that indicates 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()
A value that indicates whether 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.
|
CloudwatchLogsExportConfiguration |
getCloudwatchLogsExportConfiguration()
The configuration setting for the log types to be enabled for export to CloudWatch Logs for a specific DB
instance.
|
Boolean |
getCopyTagsToSnapshot()
A value that indicates whether to copy all tags from the DB instance to snapshots of the DB instance.
|
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.
|
Boolean |
getDeletionProtection()
A value that indicates whether the DB instance has deletion protection enabled.
|
String |
getDomain()
The Active Directory directory ID to move the DB instance to.
|
String |
getDomainIAMRoleName()
The name of the IAM role to use when making API calls to the Directory Service.
|
Boolean |
getEnableIAMDatabaseAuthentication()
A value that indicates whether to enable mapping of AWS Identity and Access Management (IAM) accounts to database
accounts.
|
Boolean |
getEnablePerformanceInsights()
A value that indicates whether to enable Performance Insights for the DB instance.
|
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 |
getMaxAllocatedStorage()
The upper limit to which Amazon RDS can automatically scale the storage of the DB instance.
|
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 Amazon CloudWatch Logs.
|
Boolean |
getMultiAZ()
A value that indicates whether 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 AWS KMS key identifier for encryption of Performance Insights data.
|
Integer |
getPerformanceInsightsRetentionPeriod()
The amount of time, in days, to retain 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.
|
List<ProcessorFeature> |
getProcessorFeatures()
The number of CPU cores and the number of threads per core for the DB instance class of the DB instance.
|
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()
A value that indicates whether the DB instance is publicly accessible.
|
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.
|
Boolean |
getUseDefaultProcessorFeatures()
A value that indicates whether the DB instance class of the DB instance uses its default processor features.
|
List<String> |
getVpcSecurityGroupIds()
A list of EC2 VPC security groups to authorize on this DB instance.
|
int |
hashCode() |
Boolean |
isAllowMajorVersionUpgrade()
A value that indicates whether major version upgrades are allowed.
|
Boolean |
isApplyImmediately()
A value that indicates 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()
A value that indicates whether minor version upgrades are applied automatically to the DB instance during the
maintenance window.
|
Boolean |
isCopyTagsToSnapshot()
A value that indicates whether to copy all tags from the DB instance to snapshots of the DB instance.
|
Boolean |
isDeletionProtection()
A value that indicates whether the DB instance has deletion protection enabled.
|
Boolean |
isEnableIAMDatabaseAuthentication()
A value that indicates whether to enable mapping of AWS Identity and Access Management (IAM) accounts to database
accounts.
|
Boolean |
isEnablePerformanceInsights()
A value that indicates whether to enable Performance Insights for the DB instance.
|
Boolean |
isMultiAZ()
A value that indicates whether the DB instance is a Multi-AZ deployment.
|
Boolean |
isPubliclyAccessible()
A value that indicates whether the DB instance is publicly accessible.
|
Boolean |
isUseDefaultProcessorFeatures()
A value that indicates whether the DB instance class of the DB instance uses its default processor features.
|
void |
setAllocatedStorage(Integer allocatedStorage)
The new amount of storage (in gibibytes) to allocate for the DB instance.
|
void |
setAllowMajorVersionUpgrade(Boolean allowMajorVersionUpgrade)
A value that indicates whether major version upgrades are allowed.
|
void |
setApplyImmediately(Boolean applyImmediately)
A value that indicates 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)
A value that indicates whether 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 |
setCloudwatchLogsExportConfiguration(CloudwatchLogsExportConfiguration cloudwatchLogsExportConfiguration)
The configuration setting for the log types to be enabled for export to CloudWatch Logs for a specific DB
instance.
|
void |
setCopyTagsToSnapshot(Boolean copyTagsToSnapshot)
A value that indicates whether to copy all tags from the DB instance to snapshots of the DB instance.
|
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 |
setDeletionProtection(Boolean deletionProtection)
A value that indicates whether the DB instance has deletion protection enabled.
|
void |
setDomain(String domain)
The Active Directory directory ID to move the DB 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)
A value that indicates whether to enable mapping of AWS Identity and Access Management (IAM) accounts to database
accounts.
|
void |
setEnablePerformanceInsights(Boolean enablePerformanceInsights)
A value that indicates whether to enable Performance Insights for the DB instance.
|
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 |
setMaxAllocatedStorage(Integer maxAllocatedStorage)
The upper limit to which Amazon RDS can automatically scale the storage of the DB instance.
|
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 Amazon CloudWatch Logs.
|
void |
setMultiAZ(Boolean multiAZ)
A value that indicates whether 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 AWS KMS key identifier for encryption of Performance Insights data.
|
void |
setPerformanceInsightsRetentionPeriod(Integer performanceInsightsRetentionPeriod)
The amount of time, in days, to retain 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 |
setProcessorFeatures(Collection<ProcessorFeature> processorFeatures)
The number of CPU cores and the number of threads per core for the DB instance class of the DB instance.
|
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)
A value that indicates whether the DB instance is publicly accessible.
|
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 |
setUseDefaultProcessorFeatures(Boolean useDefaultProcessorFeatures)
A value that indicates whether the DB instance class of the DB instance uses its default processor features.
|
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.
|
ModifyDBInstanceRequest |
withAllocatedStorage(Integer allocatedStorage)
The new amount of storage (in gibibytes) to allocate for the DB instance.
|
ModifyDBInstanceRequest |
withAllowMajorVersionUpgrade(Boolean allowMajorVersionUpgrade)
A value that indicates whether major version upgrades are allowed.
|
ModifyDBInstanceRequest |
withApplyImmediately(Boolean applyImmediately)
A value that indicates 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)
A value that indicates whether 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 |
withCloudwatchLogsExportConfiguration(CloudwatchLogsExportConfiguration cloudwatchLogsExportConfiguration)
The configuration setting for the log types to be enabled for export to CloudWatch Logs for a specific DB
instance.
|
ModifyDBInstanceRequest |
withCopyTagsToSnapshot(Boolean copyTagsToSnapshot)
A value that indicates whether to copy all tags from the DB instance to snapshots of the DB instance.
|
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 |
withDeletionProtection(Boolean deletionProtection)
A value that indicates whether the DB instance has deletion protection enabled.
|
ModifyDBInstanceRequest |
withDomain(String domain)
The Active Directory directory ID to move the DB 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)
A value that indicates whether to enable mapping of AWS Identity and Access Management (IAM) accounts to database
accounts.
|
ModifyDBInstanceRequest |
withEnablePerformanceInsights(Boolean enablePerformanceInsights)
A value that indicates whether to enable Performance Insights for the DB instance.
|
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 |
withMaxAllocatedStorage(Integer maxAllocatedStorage)
The upper limit to which Amazon RDS can automatically scale the storage of the DB instance.
|
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 Amazon CloudWatch Logs.
|
ModifyDBInstanceRequest |
withMultiAZ(Boolean multiAZ)
A value that indicates whether 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 AWS KMS key identifier for encryption of Performance Insights data.
|
ModifyDBInstanceRequest |
withPerformanceInsightsRetentionPeriod(Integer performanceInsightsRetentionPeriod)
The amount of time, in days, to retain 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 |
withProcessorFeatures(Collection<ProcessorFeature> processorFeatures)
The number of CPU cores and the number of threads per core for the DB instance class of the DB instance.
|
ModifyDBInstanceRequest |
withProcessorFeatures(ProcessorFeature... processorFeatures)
The number of CPU cores and the number of threads per core for the DB instance class of the DB instance.
|
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)
A value that indicates whether the DB instance is publicly accessible.
|
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 |
withUseDefaultProcessorFeatures(Boolean useDefaultProcessorFeatures)
A value that indicates whether the DB instance class of the DB instance uses its default processor features.
|
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 amount of storage (in gibibytes) to allocate for the DB instance.
For MariaDB, MySQL, Oracle, and PostgreSQL, the 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.
For the valid values for allocated storage for each engine, see CreateDBInstance
.
allocatedStorage
- The new amount of storage (in gibibytes) to allocate for the DB instance.
For MariaDB, MySQL, Oracle, and PostgreSQL, the 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.
For the valid values for allocated storage for each engine, see CreateDBInstance
.
public Integer getAllocatedStorage()
The new amount of storage (in gibibytes) to allocate for the DB instance.
For MariaDB, MySQL, Oracle, and PostgreSQL, the 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.
For the valid values for allocated storage for each engine, see CreateDBInstance
.
For MariaDB, MySQL, Oracle, and PostgreSQL, the 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.
For the valid values for allocated storage for each engine, see CreateDBInstance
.
public ModifyDBInstanceRequest withAllocatedStorage(Integer allocatedStorage)
The new amount of storage (in gibibytes) to allocate for the DB instance.
For MariaDB, MySQL, Oracle, and PostgreSQL, the 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.
For the valid values for allocated storage for each engine, see CreateDBInstance
.
allocatedStorage
- The new amount of storage (in gibibytes) to allocate for the DB instance.
For MariaDB, MySQL, Oracle, and PostgreSQL, the 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.
For the valid values for allocated storage for each engine, see CreateDBInstance
.
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 AWS 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 enabled 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 AWS 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 enabled 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 AWS 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 enabled for this request.
Default: Uses existing setting
db.m4.large
. Not all DB
instance classes are available in all AWS 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 enabled 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 AWS 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 enabled 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 AWS 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 enabled 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 isn't 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 in the Amazon RDS User Guide.
Changing the subnet group causes an outage during the change. The change is applied during the next maintenance
window, unless you enable ApplyImmediately
.
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 isn't 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 in the Amazon RDS User Guide.
Changing the subnet group causes an outage during the change. The change is applied during the next
maintenance window, unless you enable ApplyImmediately
.
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 isn't 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 in the Amazon RDS User Guide.
Changing the subnet group causes an outage during the change. The change is applied during the next maintenance
window, unless you enable ApplyImmediately
.
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 enable ApplyImmediately
.
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 isn't 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 in the Amazon RDS User Guide.
Changing the subnet group causes an outage during the change. The change is applied during the next maintenance
window, unless you enable ApplyImmediately
.
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 isn't 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 in the Amazon RDS User Guide.
Changing the subnet group causes an outage during the change. The change is applied during the next
maintenance window, unless you enable ApplyImmediately
.
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 doesn't 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 doesn't 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 doesn't 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 doesn't 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 doesn't 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 doesn't 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 doesn't 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)
A value that indicates 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. By default, this parameter is disabled.
If this parameter is disabled, 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 in the Amazon RDS User Guide. to see the impact of enabling or disabling
ApplyImmediately
for each modified parameter and to determine when the changes are applied.
applyImmediately
- A value that indicates 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. By default, this parameter is disabled.
If this parameter is disabled, 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 in the Amazon RDS User Guide. to see the impact of enabling or disabling
ApplyImmediately
for each modified parameter and to determine when the changes are applied.
public Boolean getApplyImmediately()
A value that indicates 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. By default, this parameter is disabled.
If this parameter is disabled, 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 in the Amazon RDS User Guide. to see the impact of enabling or disabling
ApplyImmediately
for each modified parameter and to determine when the changes are applied.
PreferredMaintenanceWindow
setting for the DB instance. By default, this parameter is disabled.
If this parameter is disabled, 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 in the Amazon RDS User Guide. to see the impact of enabling or
disabling ApplyImmediately
for each modified parameter and to determine when the changes are
applied.
public ModifyDBInstanceRequest withApplyImmediately(Boolean applyImmediately)
A value that indicates 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. By default, this parameter is disabled.
If this parameter is disabled, 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 in the Amazon RDS User Guide. to see the impact of enabling or disabling
ApplyImmediately
for each modified parameter and to determine when the changes are applied.
applyImmediately
- A value that indicates 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. By default, this parameter is disabled.
If this parameter is disabled, 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 in the Amazon RDS User Guide. to see the impact of enabling or disabling
ApplyImmediately
for each modified parameter and to determine when the changes are applied.
public Boolean isApplyImmediately()
A value that indicates 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. By default, this parameter is disabled.
If this parameter is disabled, 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 in the Amazon RDS User Guide. to see the impact of enabling or disabling
ApplyImmediately
for each modified parameter and to determine when the changes are applied.
PreferredMaintenanceWindow
setting for the DB instance. By default, this parameter is disabled.
If this parameter is disabled, 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 in the Amazon RDS User Guide. to see the impact of enabling or
disabling ApplyImmediately
for each modified parameter and to determine when the changes are
applied.
public void setMasterUserPassword(String masterUserPassword)
The new password for the master user. The password can include any printable ASCII character except "/", """, or "@".
Changing this parameter doesn't 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. The password can include any printable ASCII character except "/",
""", or "@".
Changing this parameter doesn't 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. The password can include any printable ASCII character except "/", """, or "@".
Changing this parameter doesn't 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 doesn't 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. The password can include any printable ASCII character except "/", """, or "@".
Changing this parameter doesn't 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. The password can include any printable ASCII character except "/",
""", or "@".
Changing this parameter doesn't 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 doesn't 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. In this case, the DB instance isn't rebooted automatically and the parameter changes isn't 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 doesn't 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. In this case, the DB instance isn't rebooted
automatically and the parameter changes isn't 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 doesn't 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. In this case, the DB instance isn't rebooted automatically and the parameter changes isn't 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 doesn't 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. In this case, the DB instance isn't rebooted automatically and the parameter changes isn't 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 doesn't 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. In this case, the DB instance isn't rebooted
automatically and the parameter changes isn't 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 enabled 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 or later
Can be specified for a PostgreSQL Read Replica only if the source is running PostgreSQL 9.3.5
Can't 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 enabled 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 or later
Can be specified for a PostgreSQL Read Replica only if the source is running PostgreSQL 9.3.5
Can't 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 enabled 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 or later
Can be specified for a PostgreSQL Read Replica only if the source is running PostgreSQL 9.3.5
Can't 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 enabled 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 or later
Can be specified for a PostgreSQL Read Replica only if the source is running PostgreSQL 9.3.5
Can't 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 enabled 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 or later
Can be specified for a PostgreSQL Read Replica only if the source is running PostgreSQL 9.3.5
Can't 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 enabled 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 or later
Can be specified for a PostgreSQL Read Replica only if the source is running PostgreSQL 9.3.5
Can't 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 doesn't 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
Must 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 doesn't 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
Must 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 doesn't 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
Must 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 doesn't 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
Must 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 doesn't 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
Must 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 doesn't 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
Must 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 doesn't 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 doesn't 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 doesn't 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 doesn't 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 doesn't 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)
A value that indicates whether the DB instance is a Multi-AZ deployment. Changing this parameter doesn't result
in an outage and the change is applied during the next maintenance window unless the
ApplyImmediately
parameter is enabled for this request.
multiAZ
- A value that indicates whether the DB instance is a Multi-AZ deployment. Changing this parameter doesn't
result in an outage and the change is applied during the next maintenance window unless the
ApplyImmediately
parameter is enabled for this request.public Boolean getMultiAZ()
A value that indicates whether the DB instance is a Multi-AZ deployment. Changing this parameter doesn't result
in an outage and the change is applied during the next maintenance window unless the
ApplyImmediately
parameter is enabled for this request.
ApplyImmediately
parameter is enabled for this request.public ModifyDBInstanceRequest withMultiAZ(Boolean multiAZ)
A value that indicates whether the DB instance is a Multi-AZ deployment. Changing this parameter doesn't result
in an outage and the change is applied during the next maintenance window unless the
ApplyImmediately
parameter is enabled for this request.
multiAZ
- A value that indicates whether the DB instance is a Multi-AZ deployment. Changing this parameter doesn't
result in an outage and the change is applied during the next maintenance window unless the
ApplyImmediately
parameter is enabled for this request.public Boolean isMultiAZ()
A value that indicates whether the DB instance is a Multi-AZ deployment. Changing this parameter doesn't result
in an outage and the change is applied during the next maintenance window unless the
ApplyImmediately
parameter is enabled for this request.
ApplyImmediately
parameter is enabled for this request.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
eanbled 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 information about valid engine versions, see CreateDBInstance
, or call
DescribeDBEngineVersions
.
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 eanbled 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 information about valid engine versions, see CreateDBInstance
, or call
DescribeDBEngineVersions
.
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
eanbled 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 information about valid engine versions, see CreateDBInstance
, or call
DescribeDBEngineVersions
.
ApplyImmediately
parameter is eanbled 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 information about valid engine versions, see CreateDBInstance
, or call
DescribeDBEngineVersions
.
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
eanbled 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 information about valid engine versions, see CreateDBInstance
, or call
DescribeDBEngineVersions
.
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 eanbled 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 information about valid engine versions, see CreateDBInstance
, or call
DescribeDBEngineVersions
.
public void setAllowMajorVersionUpgrade(Boolean allowMajorVersionUpgrade)
A value that indicates whether major version upgrades are allowed. Changing this parameter doesn't result in an outage and the change is asynchronously applied as soon as possible.
Constraints: Major version upgrades must be allowed when specifying a value for the EngineVersion parameter that is a different major version than the DB instance's current version.
allowMajorVersionUpgrade
- A value that indicates whether major version upgrades are allowed. Changing this parameter doesn't result
in an outage and the change is asynchronously applied as soon as possible.
Constraints: Major version upgrades must be allowed when specifying a value for the EngineVersion parameter that is a different major version than the DB instance's current version.
public Boolean getAllowMajorVersionUpgrade()
A value that indicates whether major version upgrades are allowed. Changing this parameter doesn't result in an outage and the change is asynchronously applied as soon as possible.
Constraints: Major version upgrades must be allowed when specifying a value for the EngineVersion parameter that is a different major version than the DB instance's current version.
Constraints: Major version upgrades must be allowed 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)
A value that indicates whether major version upgrades are allowed. Changing this parameter doesn't result in an outage and the change is asynchronously applied as soon as possible.
Constraints: Major version upgrades must be allowed when specifying a value for the EngineVersion parameter that is a different major version than the DB instance's current version.
allowMajorVersionUpgrade
- A value that indicates whether major version upgrades are allowed. Changing this parameter doesn't result
in an outage and the change is asynchronously applied as soon as possible.
Constraints: Major version upgrades must be allowed when specifying a value for the EngineVersion parameter that is a different major version than the DB instance's current version.
public Boolean isAllowMajorVersionUpgrade()
A value that indicates whether major version upgrades are allowed. Changing this parameter doesn't result in an outage and the change is asynchronously applied as soon as possible.
Constraints: Major version upgrades must be allowed when specifying a value for the EngineVersion parameter that is a different major version than the DB instance's current version.
Constraints: Major version upgrades must be allowed 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)
A value that indicates whether minor version upgrades are applied automatically to the DB instance during the maintenance window. Changing this parameter doesn't result in an outage except in the following case and the change is asynchronously applied as soon as possible. An outage results if this parameter is enabled during the maintenance window, and a newer minor version is available, and RDS has enabled auto patching for that engine version.
autoMinorVersionUpgrade
- A value that indicates whether minor version upgrades are applied automatically to the DB instance during
the maintenance window. Changing this parameter doesn't result in an outage except in the following case
and the change is asynchronously applied as soon as possible. An outage results if this parameter is
enabled during the maintenance window, and a newer minor version is available, and RDS has enabled auto
patching for that engine version.public Boolean getAutoMinorVersionUpgrade()
A value that indicates whether minor version upgrades are applied automatically to the DB instance during the maintenance window. Changing this parameter doesn't result in an outage except in the following case and the change is asynchronously applied as soon as possible. An outage results if this parameter is enabled 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)
A value that indicates whether minor version upgrades are applied automatically to the DB instance during the maintenance window. Changing this parameter doesn't result in an outage except in the following case and the change is asynchronously applied as soon as possible. An outage results if this parameter is enabled during the maintenance window, and a newer minor version is available, and RDS has enabled auto patching for that engine version.
autoMinorVersionUpgrade
- A value that indicates whether minor version upgrades are applied automatically to the DB instance during
the maintenance window. Changing this parameter doesn't result in an outage except in the following case
and the change is asynchronously applied as soon as possible. An outage results if this parameter is
enabled during the maintenance window, and a newer minor version is available, and RDS has enabled auto
patching for that engine version.public Boolean isAutoMinorVersionUpgrade()
A value that indicates whether minor version upgrades are applied automatically to the DB instance during the maintenance window. Changing this parameter doesn't result in an outage except in the following case and the change is asynchronously applied as soon as possible. An outage results if this parameter is enabled 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 doesn't result in an outage and the change is applied during the next maintenance window
unless the ApplyImmediately
parameter is enabled for this request. 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.
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.
Constraints: For MariaDB, MySQL, Oracle, and PostgreSQL, the 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.
Default: Uses existing setting
iops
- The new Provisioned IOPS (I/O operations per second) value for the RDS instance.
Changing this setting doesn't result in an outage and the change is applied during the next maintenance
window unless the ApplyImmediately
parameter is enabled for this request. 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.
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.
Constraints: For MariaDB, MySQL, Oracle, and PostgreSQL, the 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.
Default: Uses existing setting
public Integer getIops()
The new Provisioned IOPS (I/O operations per second) value for the RDS instance.
Changing this setting doesn't result in an outage and the change is applied during the next maintenance window
unless the ApplyImmediately
parameter is enabled for this request. 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.
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.
Constraints: For MariaDB, MySQL, Oracle, and PostgreSQL, the 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.
Default: Uses existing setting
Changing this setting doesn't result in an outage and the change is applied during the next maintenance
window unless the ApplyImmediately
parameter is enabled for this request. 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.
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.
Constraints: For MariaDB, MySQL, Oracle, and PostgreSQL, the 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.
Default: Uses existing setting
public ModifyDBInstanceRequest withIops(Integer iops)
The new Provisioned IOPS (I/O operations per second) value for the RDS instance.
Changing this setting doesn't result in an outage and the change is applied during the next maintenance window
unless the ApplyImmediately
parameter is enabled for this request. 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.
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.
Constraints: For MariaDB, MySQL, Oracle, and PostgreSQL, the 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.
Default: Uses existing setting
iops
- The new Provisioned IOPS (I/O operations per second) value for the RDS instance.
Changing this setting doesn't result in an outage and the change is applied during the next maintenance
window unless the ApplyImmediately
parameter is enabled for this request. 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.
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.
Constraints: For MariaDB, MySQL, Oracle, and PostgreSQL, the 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.
Default: Uses existing setting
public void setOptionGroupName(String optionGroupName)
Indicates that the DB instance should be associated with the specified option group. Changing this parameter
doesn't result in an outage except in the following case and the change is applied during the next maintenance
window unless the ApplyImmediately
parameter is enabled 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, can't be removed from an option group, and that option group can't 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 doesn't result in an outage except in the following case and the change is applied during the
next maintenance window unless the ApplyImmediately
parameter is enabled 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, can't be removed from an option group, and that option group can't 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
doesn't result in an outage except in the following case and the change is applied during the next maintenance
window unless the ApplyImmediately
parameter is enabled 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, can't be removed from an option group, and that option group can't be removed from a DB instance once it is associated with a DB instance
ApplyImmediately
parameter is enabled 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, can't be removed from an option group, and that option group can't 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
doesn't result in an outage except in the following case and the change is applied during the next maintenance
window unless the ApplyImmediately
parameter is enabled 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, can't be removed from an option group, and that option group can't 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 doesn't result in an outage except in the following case and the change is applied during the
next maintenance window unless the ApplyImmediately
parameter is enabled 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, can't be removed from an option group, and that option group can't 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 occurs immediately if you enable ApplyImmediately
, or will occur
during the next maintenance window if you disable Apply Immediately. This value is stored as a lowercase string.
Constraints:
Must contain from 1 to 63 letters, numbers, or hyphens.
The first character must be a letter.
Can't end with a hyphen or contain two consecutive hyphens.
Example: 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 occurs immediately if you enable ApplyImmediately
, or
will occur during the next maintenance window if you disable Apply Immediately. This value is stored as a
lowercase string.
Constraints:
Must contain from 1 to 63 letters, numbers, or hyphens.
The first character must be a letter.
Can't end with a hyphen or contain two consecutive hyphens.
Example: 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 occurs immediately if you enable ApplyImmediately
, or will occur
during the next maintenance window if you disable Apply Immediately. This value is stored as a lowercase string.
Constraints:
Must contain from 1 to 63 letters, numbers, or hyphens.
The first character must be a letter.
Can't end with a hyphen or contain two consecutive hyphens.
Example: mydbinstance
ApplyImmediately
,
or will occur during the next maintenance window if you disable Apply Immediately. This value is stored
as a lowercase string.
Constraints:
Must contain from 1 to 63 letters, numbers, or hyphens.
The first character must be a letter.
Can't end with a hyphen or contain two consecutive hyphens.
Example: 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 occurs immediately if you enable ApplyImmediately
, or will occur
during the next maintenance window if you disable Apply Immediately. This value is stored as a lowercase string.
Constraints:
Must contain from 1 to 63 letters, numbers, or hyphens.
The first character must be a letter.
Can't end with a hyphen or contain two consecutive hyphens.
Example: 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 occurs immediately if you enable ApplyImmediately
, or
will occur during the next maintenance window if you disable Apply Immediately. This value is stored as a
lowercase string.
Constraints:
Must contain from 1 to 63 letters, numbers, or hyphens.
The first character must be a letter.
Can't end with a hyphen or contain two consecutive hyphens.
Example: mydbinstance
public void setStorageType(String storageType)
Specifies the storage type to be associated with the DB instance.
If you specify Provisioned IOPS (io1
), you must also include a value for the Iops
parameter.
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.
Valid values: standard | gp2 | io1
Default: io1
if the Iops
parameter is specified, otherwise gp2
storageType
- Specifies the storage type to be associated with the DB instance.
If you specify Provisioned IOPS (io1
), you must also include a value for the
Iops
parameter.
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.
Valid values: standard | gp2 | io1
Default: io1
if the Iops
parameter is specified, otherwise gp2
public String getStorageType()
Specifies the storage type to be associated with the DB instance.
If you specify Provisioned IOPS (io1
), you must also include a value for the Iops
parameter.
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.
Valid values: standard | gp2 | io1
Default: io1
if the Iops
parameter is specified, otherwise gp2
If you specify Provisioned IOPS (io1
), you must also include a value for the
Iops
parameter.
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.
Valid values: standard | gp2 | io1
Default: io1
if the Iops
parameter is specified, otherwise gp2
public ModifyDBInstanceRequest withStorageType(String storageType)
Specifies the storage type to be associated with the DB instance.
If you specify Provisioned IOPS (io1
), you must also include a value for the Iops
parameter.
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.
Valid values: standard | gp2 | io1
Default: io1
if the Iops
parameter is specified, otherwise gp2
storageType
- Specifies the storage type to be associated with the DB instance.
If you specify Provisioned IOPS (io1
), you must also include a value for the
Iops
parameter.
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.
Valid values: standard | gp2 | io1
Default: io1
if the Iops
parameter is specified, otherwise gp2
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 directory ID to move the DB instance to. Specify none
to remove the instance
from its current domain. The domain must be created prior to this operation. Currently, only Microsoft SQL Server
and Oracle DB instances can be created in an Active Directory Domain.
For Microsoft SQL Server DB instances, Amazon RDS can use Windows Authentication to authenticate users that connect to the DB instance. For more information, see Using Windows Authentication with an Amazon RDS DB Instance Running Microsoft SQL Server in the Amazon RDS User Guide.
For Oracle DB instances, Amazon RDS can use Kerberos Authentication to authenticate users that connect to the DB instance. For more information, see Using Kerberos Authentication with Amazon RDS for Oracle in the Amazon RDS User Guide.
domain
- The Active Directory directory ID to move the DB instance to. Specify none
to remove the
instance from its current domain. The domain must be created prior to this operation. Currently, only
Microsoft SQL Server and Oracle DB instances can be created in an Active Directory Domain.
For Microsoft SQL Server DB instances, Amazon RDS can use Windows Authentication to authenticate users that connect to the DB instance. For more information, see Using Windows Authentication with an Amazon RDS DB Instance Running Microsoft SQL Server in the Amazon RDS User Guide.
For Oracle DB instances, Amazon RDS can use Kerberos Authentication to authenticate users that connect to the DB instance. For more information, see Using Kerberos Authentication with Amazon RDS for Oracle in the Amazon RDS User Guide.
public String getDomain()
The Active Directory directory ID to move the DB instance to. Specify none
to remove the instance
from its current domain. The domain must be created prior to this operation. Currently, only Microsoft SQL Server
and Oracle DB instances can be created in an Active Directory Domain.
For Microsoft SQL Server DB instances, Amazon RDS can use Windows Authentication to authenticate users that connect to the DB instance. For more information, see Using Windows Authentication with an Amazon RDS DB Instance Running Microsoft SQL Server in the Amazon RDS User Guide.
For Oracle DB instances, Amazon RDS can use Kerberos Authentication to authenticate users that connect to the DB instance. For more information, see Using Kerberos Authentication with Amazon RDS for Oracle in the Amazon RDS User Guide.
none
to remove the
instance from its current domain. The domain must be created prior to this operation. Currently, only
Microsoft SQL Server and Oracle DB instances can be created in an Active Directory Domain.
For Microsoft SQL Server DB instances, Amazon RDS can use Windows Authentication to authenticate users that connect to the DB instance. For more information, see Using Windows Authentication with an Amazon RDS DB Instance Running Microsoft SQL Server in the Amazon RDS User Guide.
For Oracle DB instances, Amazon RDS can use Kerberos Authentication to authenticate users that connect to the DB instance. For more information, see Using Kerberos Authentication with Amazon RDS for Oracle in the Amazon RDS User Guide.
public ModifyDBInstanceRequest withDomain(String domain)
The Active Directory directory ID to move the DB instance to. Specify none
to remove the instance
from its current domain. The domain must be created prior to this operation. Currently, only Microsoft SQL Server
and Oracle DB instances can be created in an Active Directory Domain.
For Microsoft SQL Server DB instances, Amazon RDS can use Windows Authentication to authenticate users that connect to the DB instance. For more information, see Using Windows Authentication with an Amazon RDS DB Instance Running Microsoft SQL Server in the Amazon RDS User Guide.
For Oracle DB instances, Amazon RDS can use Kerberos Authentication to authenticate users that connect to the DB instance. For more information, see Using Kerberos Authentication with Amazon RDS for Oracle in the Amazon RDS User Guide.
domain
- The Active Directory directory ID to move the DB instance to. Specify none
to remove the
instance from its current domain. The domain must be created prior to this operation. Currently, only
Microsoft SQL Server and Oracle DB instances can be created in an Active Directory Domain.
For Microsoft SQL Server DB instances, Amazon RDS can use Windows Authentication to authenticate users that connect to the DB instance. For more information, see Using Windows Authentication with an Amazon RDS DB Instance Running Microsoft SQL Server in the Amazon RDS User Guide.
For Oracle DB instances, Amazon RDS can use Kerberos Authentication to authenticate users that connect to the DB instance. For more information, see Using Kerberos Authentication with Amazon RDS for Oracle in the Amazon RDS User Guide.
public void setCopyTagsToSnapshot(Boolean copyTagsToSnapshot)
A value that indicates whether to copy all tags from the DB instance to snapshots of the DB instance. By default, tags are not copied.
Amazon Aurora
Not applicable. Copying tags to snapshots is managed by the DB cluster. Setting this value for an Aurora DB
instance has no effect on the DB cluster setting. For more information, see ModifyDBCluster
.
copyTagsToSnapshot
- A value that indicates whether to copy all tags from the DB instance to snapshots of the DB instance. By
default, tags are not copied.
Amazon Aurora
Not applicable. Copying tags to snapshots is managed by the DB cluster. Setting this value for an Aurora
DB instance has no effect on the DB cluster setting. For more information, see
ModifyDBCluster
.
public Boolean getCopyTagsToSnapshot()
A value that indicates whether to copy all tags from the DB instance to snapshots of the DB instance. By default, tags are not copied.
Amazon Aurora
Not applicable. Copying tags to snapshots is managed by the DB cluster. Setting this value for an Aurora DB
instance has no effect on the DB cluster setting. For more information, see ModifyDBCluster
.
Amazon Aurora
Not applicable. Copying tags to snapshots is managed by the DB cluster. Setting this value for an Aurora
DB instance has no effect on the DB cluster setting. For more information, see
ModifyDBCluster
.
public ModifyDBInstanceRequest withCopyTagsToSnapshot(Boolean copyTagsToSnapshot)
A value that indicates whether to copy all tags from the DB instance to snapshots of the DB instance. By default, tags are not copied.
Amazon Aurora
Not applicable. Copying tags to snapshots is managed by the DB cluster. Setting this value for an Aurora DB
instance has no effect on the DB cluster setting. For more information, see ModifyDBCluster
.
copyTagsToSnapshot
- A value that indicates whether to copy all tags from the DB instance to snapshots of the DB instance. By
default, tags are not copied.
Amazon Aurora
Not applicable. Copying tags to snapshots is managed by the DB cluster. Setting this value for an Aurora
DB instance has no effect on the DB cluster setting. For more information, see
ModifyDBCluster
.
public Boolean isCopyTagsToSnapshot()
A value that indicates whether to copy all tags from the DB instance to snapshots of the DB instance. By default, tags are not copied.
Amazon Aurora
Not applicable. Copying tags to snapshots is managed by the DB cluster. Setting this value for an Aurora DB
instance has no effect on the DB cluster setting. For more information, see ModifyDBCluster
.
Amazon Aurora
Not applicable. Copying tags to snapshots is managed by the DB cluster. Setting this value for an Aurora
DB instance has no effect on the DB cluster setting. For more information, see
ModifyDBCluster
.
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)
A value that indicates whether the DB instance is publicly accessible. When the DB instance is publicly accessible, it is an Internet-facing instance with a publicly resolvable DNS name, which resolves to a public IP address. When the DB instance isn't publicly accessible, it is an internal instance 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 enabled for it to be publicly accessible.
Changes to the PubliclyAccessible
parameter are applied immediately regardless of the value of the
ApplyImmediately
parameter.
publiclyAccessible
- A value that indicates whether the DB instance is publicly accessible. When the DB instance is publicly
accessible, it is an Internet-facing instance with a publicly resolvable DNS name, which resolves to a
public IP address. When the DB instance isn't publicly accessible, it is an internal instance 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 enabled for it to be publicly accessible.
Changes to the PubliclyAccessible
parameter are applied immediately regardless of the value
of the ApplyImmediately
parameter.
public Boolean getPubliclyAccessible()
A value that indicates whether the DB instance is publicly accessible. When the DB instance is publicly accessible, it is an Internet-facing instance with a publicly resolvable DNS name, which resolves to a public IP address. When the DB instance isn't publicly accessible, it is an internal instance 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 enabled for it to be publicly accessible.
Changes to the PubliclyAccessible
parameter are applied immediately regardless of the value of the
ApplyImmediately
parameter.
PubliclyAccessible
only applies to DB instances in a VPC. The DB instance must be part of a
public subnet and PubliclyAccessible
must be enabled for it to be publicly accessible.
Changes to the PubliclyAccessible
parameter are applied immediately regardless of the value
of the ApplyImmediately
parameter.
public ModifyDBInstanceRequest withPubliclyAccessible(Boolean publiclyAccessible)
A value that indicates whether the DB instance is publicly accessible. When the DB instance is publicly accessible, it is an Internet-facing instance with a publicly resolvable DNS name, which resolves to a public IP address. When the DB instance isn't publicly accessible, it is an internal instance 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 enabled for it to be publicly accessible.
Changes to the PubliclyAccessible
parameter are applied immediately regardless of the value of the
ApplyImmediately
parameter.
publiclyAccessible
- A value that indicates whether the DB instance is publicly accessible. When the DB instance is publicly
accessible, it is an Internet-facing instance with a publicly resolvable DNS name, which resolves to a
public IP address. When the DB instance isn't publicly accessible, it is an internal instance 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 enabled for it to be publicly accessible.
Changes to the PubliclyAccessible
parameter are applied immediately regardless of the value
of the ApplyImmediately
parameter.
public Boolean isPubliclyAccessible()
A value that indicates whether the DB instance is publicly accessible. When the DB instance is publicly accessible, it is an Internet-facing instance with a publicly resolvable DNS name, which resolves to a public IP address. When the DB instance isn't publicly accessible, it is an internal instance 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 enabled for it to be publicly accessible.
Changes to the PubliclyAccessible
parameter are applied immediately regardless of the value of the
ApplyImmediately
parameter.
PubliclyAccessible
only applies to DB instances in a VPC. The DB instance must be part of a
public subnet and PubliclyAccessible
must be enabled for it to be publicly accessible.
Changes to the PubliclyAccessible
parameter are applied immediately regardless of the value
of the ApplyImmediately
parameter.
public void setMonitoringRoleArn(String monitoringRoleArn)
The ARN for the IAM role that permits RDS to send enhanced monitoring metrics to Amazon 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 in the Amazon RDS User Guide.
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 Amazon 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 in the Amazon RDS User Guide.
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 Amazon 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 in the Amazon RDS User Guide.
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 in the Amazon RDS User Guide.
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 Amazon 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 in the Amazon RDS User Guide.
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 Amazon 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 in the Amazon RDS User Guide.
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 in the Amazon Aurora User Guide.
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 in the Amazon Aurora User Guide.
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 in the Amazon Aurora User Guide.
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 in the Amazon Aurora User Guide.
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 in the Amazon Aurora User Guide.
Default: 1
Valid Values: 0 - 15
public void setEnableIAMDatabaseAuthentication(Boolean enableIAMDatabaseAuthentication)
A value that indicates whether to enable mapping of AWS Identity and Access Management (IAM) accounts to database accounts. By default, mapping is disabled. For information about the supported DB engines, see CreateDBInstance.
For more information about IAM database authentication, see IAM Database Authentication for MySQL and PostgreSQL in the Amazon RDS User Guide.
enableIAMDatabaseAuthentication
- A value that indicates whether to enable mapping of AWS Identity and Access Management (IAM) accounts to
database accounts. By default, mapping is disabled. For information about the supported DB engines, see
CreateDBInstance.
For more information about IAM database authentication, see IAM Database Authentication for MySQL and PostgreSQL in the Amazon RDS User Guide.
public Boolean getEnableIAMDatabaseAuthentication()
A value that indicates whether to enable mapping of AWS Identity and Access Management (IAM) accounts to database accounts. By default, mapping is disabled. For information about the supported DB engines, see CreateDBInstance.
For more information about IAM database authentication, see IAM Database Authentication for MySQL and PostgreSQL in the Amazon RDS User Guide.
For more information about IAM database authentication, see IAM Database Authentication for MySQL and PostgreSQL in the Amazon RDS User Guide.
public ModifyDBInstanceRequest withEnableIAMDatabaseAuthentication(Boolean enableIAMDatabaseAuthentication)
A value that indicates whether to enable mapping of AWS Identity and Access Management (IAM) accounts to database accounts. By default, mapping is disabled. For information about the supported DB engines, see CreateDBInstance.
For more information about IAM database authentication, see IAM Database Authentication for MySQL and PostgreSQL in the Amazon RDS User Guide.
enableIAMDatabaseAuthentication
- A value that indicates whether to enable mapping of AWS Identity and Access Management (IAM) accounts to
database accounts. By default, mapping is disabled. For information about the supported DB engines, see
CreateDBInstance.
For more information about IAM database authentication, see IAM Database Authentication for MySQL and PostgreSQL in the Amazon RDS User Guide.
public Boolean isEnableIAMDatabaseAuthentication()
A value that indicates whether to enable mapping of AWS Identity and Access Management (IAM) accounts to database accounts. By default, mapping is disabled. For information about the supported DB engines, see CreateDBInstance.
For more information about IAM database authentication, see IAM Database Authentication for MySQL and PostgreSQL in the Amazon RDS User Guide.
For more information about IAM database authentication, see IAM Database Authentication for MySQL and PostgreSQL in the Amazon RDS User Guide.
public void setEnablePerformanceInsights(Boolean enablePerformanceInsights)
A value that indicates whether to enable Performance Insights for the DB instance.
For more information, see Using Amazon Performance Insights in the Amazon Relational Database Service User Guide.
enablePerformanceInsights
- A value that indicates whether to enable Performance Insights for the DB instance.
For more information, see Using Amazon Performance Insights in the Amazon Relational Database Service User Guide.
public Boolean getEnablePerformanceInsights()
A value that indicates whether to enable Performance Insights for the DB instance.
For more information, see Using Amazon Performance Insights in the Amazon Relational Database Service User Guide.
For more information, see Using Amazon Performance Insights in the Amazon Relational Database Service User Guide.
public ModifyDBInstanceRequest withEnablePerformanceInsights(Boolean enablePerformanceInsights)
A value that indicates whether to enable Performance Insights for the DB instance.
For more information, see Using Amazon Performance Insights in the Amazon Relational Database Service User Guide.
enablePerformanceInsights
- A value that indicates whether to enable Performance Insights for the DB instance.
For more information, see Using Amazon Performance Insights in the Amazon Relational Database Service User Guide.
public Boolean isEnablePerformanceInsights()
A value that indicates whether to enable Performance Insights for the DB instance.
For more information, see Using Amazon Performance Insights in the Amazon Relational Database Service User Guide.
For more information, see Using Amazon Performance Insights in the Amazon Relational Database Service User Guide.
public void setPerformanceInsightsKMSKeyId(String performanceInsightsKMSKeyId)
The AWS 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.
If you do not specify a value for PerformanceInsightsKMSKeyId
, then Amazon RDS uses your default
encryption key. AWS KMS creates the default encryption key for your AWS account. Your AWS account has a different
default encryption key for each AWS Region.
performanceInsightsKMSKeyId
- The AWS 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.
If you do not specify a value for PerformanceInsightsKMSKeyId
, then Amazon RDS uses your
default encryption key. AWS KMS creates the default encryption key for your AWS account. Your AWS account
has a different default encryption key for each AWS Region.
public String getPerformanceInsightsKMSKeyId()
The AWS 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.
If you do not specify a value for PerformanceInsightsKMSKeyId
, then Amazon RDS uses your default
encryption key. AWS KMS creates the default encryption key for your AWS account. Your AWS account has a different
default encryption key for each AWS Region.
If you do not specify a value for PerformanceInsightsKMSKeyId
, then Amazon RDS uses your
default encryption key. AWS KMS creates the default encryption key for your AWS account. Your AWS account
has a different default encryption key for each AWS Region.
public ModifyDBInstanceRequest withPerformanceInsightsKMSKeyId(String performanceInsightsKMSKeyId)
The AWS 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.
If you do not specify a value for PerformanceInsightsKMSKeyId
, then Amazon RDS uses your default
encryption key. AWS KMS creates the default encryption key for your AWS account. Your AWS account has a different
default encryption key for each AWS Region.
performanceInsightsKMSKeyId
- The AWS 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.
If you do not specify a value for PerformanceInsightsKMSKeyId
, then Amazon RDS uses your
default encryption key. AWS KMS creates the default encryption key for your AWS account. Your AWS account
has a different default encryption key for each AWS Region.
public void setPerformanceInsightsRetentionPeriod(Integer performanceInsightsRetentionPeriod)
The amount of time, in days, to retain Performance Insights data. Valid values are 7 or 731 (2 years).
performanceInsightsRetentionPeriod
- The amount of time, in days, to retain Performance Insights data. Valid values are 7 or 731 (2 years).public Integer getPerformanceInsightsRetentionPeriod()
The amount of time, in days, to retain Performance Insights data. Valid values are 7 or 731 (2 years).
public ModifyDBInstanceRequest withPerformanceInsightsRetentionPeriod(Integer performanceInsightsRetentionPeriod)
The amount of time, in days, to retain Performance Insights data. Valid values are 7 or 731 (2 years).
performanceInsightsRetentionPeriod
- The amount of time, in days, to retain Performance Insights data. Valid values are 7 or 731 (2 years).public void setCloudwatchLogsExportConfiguration(CloudwatchLogsExportConfiguration cloudwatchLogsExportConfiguration)
The configuration setting for the log types to be enabled for export to CloudWatch Logs for a specific DB instance.
A change to the CloudwatchLogsExportConfiguration
parameter is always applied to the DB instance
immediately. Therefore, the ApplyImmediately
parameter has no effect.
cloudwatchLogsExportConfiguration
- The configuration setting for the log types to be enabled for export to CloudWatch Logs for a specific DB
instance.
A change to the CloudwatchLogsExportConfiguration
parameter is always applied to the DB
instance immediately. Therefore, the ApplyImmediately
parameter has no effect.
public CloudwatchLogsExportConfiguration getCloudwatchLogsExportConfiguration()
The configuration setting for the log types to be enabled for export to CloudWatch Logs for a specific DB instance.
A change to the CloudwatchLogsExportConfiguration
parameter is always applied to the DB instance
immediately. Therefore, the ApplyImmediately
parameter has no effect.
A change to the CloudwatchLogsExportConfiguration
parameter is always applied to the DB
instance immediately. Therefore, the ApplyImmediately
parameter has no effect.
public ModifyDBInstanceRequest withCloudwatchLogsExportConfiguration(CloudwatchLogsExportConfiguration cloudwatchLogsExportConfiguration)
The configuration setting for the log types to be enabled for export to CloudWatch Logs for a specific DB instance.
A change to the CloudwatchLogsExportConfiguration
parameter is always applied to the DB instance
immediately. Therefore, the ApplyImmediately
parameter has no effect.
cloudwatchLogsExportConfiguration
- The configuration setting for the log types to be enabled for export to CloudWatch Logs for a specific DB
instance.
A change to the CloudwatchLogsExportConfiguration
parameter is always applied to the DB
instance immediately. Therefore, the ApplyImmediately
parameter has no effect.
public List<ProcessorFeature> getProcessorFeatures()
The number of CPU cores and the number of threads per core for the DB instance class of the DB instance.
public void setProcessorFeatures(Collection<ProcessorFeature> processorFeatures)
The number of CPU cores and the number of threads per core for the DB instance class of the DB instance.
processorFeatures
- The number of CPU cores and the number of threads per core for the DB instance class of the DB instance.public ModifyDBInstanceRequest withProcessorFeatures(ProcessorFeature... processorFeatures)
The number of CPU cores and the number of threads per core for the DB instance class of the DB instance.
NOTE: This method appends the values to the existing list (if any). Use
setProcessorFeatures(java.util.Collection)
or withProcessorFeatures(java.util.Collection)
if
you want to override the existing values.
processorFeatures
- The number of CPU cores and the number of threads per core for the DB instance class of the DB instance.public ModifyDBInstanceRequest withProcessorFeatures(Collection<ProcessorFeature> processorFeatures)
The number of CPU cores and the number of threads per core for the DB instance class of the DB instance.
processorFeatures
- The number of CPU cores and the number of threads per core for the DB instance class of the DB instance.public void setUseDefaultProcessorFeatures(Boolean useDefaultProcessorFeatures)
A value that indicates whether the DB instance class of the DB instance uses its default processor features.
useDefaultProcessorFeatures
- A value that indicates whether the DB instance class of the DB instance uses its default processor
features.public Boolean getUseDefaultProcessorFeatures()
A value that indicates whether the DB instance class of the DB instance uses its default processor features.
public ModifyDBInstanceRequest withUseDefaultProcessorFeatures(Boolean useDefaultProcessorFeatures)
A value that indicates whether the DB instance class of the DB instance uses its default processor features.
useDefaultProcessorFeatures
- A value that indicates whether the DB instance class of the DB instance uses its default processor
features.public Boolean isUseDefaultProcessorFeatures()
A value that indicates whether the DB instance class of the DB instance uses its default processor features.
public void setDeletionProtection(Boolean deletionProtection)
A value that indicates whether the DB instance has deletion protection enabled. The database can't be deleted when deletion protection is enabled. By default, deletion protection is disabled. For more information, see Deleting a DB Instance.
deletionProtection
- A value that indicates whether the DB instance has deletion protection enabled. The database can't be
deleted when deletion protection is enabled. By default, deletion protection is disabled. For more
information, see Deleting a DB
Instance.public Boolean getDeletionProtection()
A value that indicates whether the DB instance has deletion protection enabled. The database can't be deleted when deletion protection is enabled. By default, deletion protection is disabled. For more information, see Deleting a DB Instance.
public ModifyDBInstanceRequest withDeletionProtection(Boolean deletionProtection)
A value that indicates whether the DB instance has deletion protection enabled. The database can't be deleted when deletion protection is enabled. By default, deletion protection is disabled. For more information, see Deleting a DB Instance.
deletionProtection
- A value that indicates whether the DB instance has deletion protection enabled. The database can't be
deleted when deletion protection is enabled. By default, deletion protection is disabled. For more
information, see Deleting a DB
Instance.public Boolean isDeletionProtection()
A value that indicates whether the DB instance has deletion protection enabled. The database can't be deleted when deletion protection is enabled. By default, deletion protection is disabled. For more information, see Deleting a DB Instance.
public void setMaxAllocatedStorage(Integer maxAllocatedStorage)
The upper limit to which Amazon RDS can automatically scale the storage of the DB instance.
maxAllocatedStorage
- The upper limit to which Amazon RDS can automatically scale the storage of the DB instance.public Integer getMaxAllocatedStorage()
The upper limit to which Amazon RDS can automatically scale the storage of the DB instance.
public ModifyDBInstanceRequest withMaxAllocatedStorage(Integer maxAllocatedStorage)
The upper limit to which Amazon RDS can automatically scale the storage of the DB instance.
maxAllocatedStorage
- The upper limit to which Amazon RDS can automatically scale the storage of the DB instance.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.