@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 (GiB) 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. |
String |
getAutomationMode()
The automation mode of the RDS Custom DB instance:
full or all paused . |
Boolean |
getAutoMinorVersionUpgrade()
A value that indicates whether minor version upgrades are applied automatically to the DB instance during the
maintenance window.
|
String |
getAwsBackupRecoveryPointArn()
The Amazon Resource Name (ARN) of the recovery point in Amazon Web Services Backup.
|
Integer |
getBackupRetentionPeriod()
The number of days to retain automated backups.
|
String |
getCACertificateIdentifier()
Specifies the CA certificate identifier to use for the DB instance’s server certificate.
|
Boolean |
getCertificateRotationRestart()
A value that indicates whether the DB instance is restarted when you rotate your SSL/TLS certificate.
|
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 |
getEnableCustomerOwnedIp()
A value that indicates whether to enable a customer-owned IP address (CoIP) for an RDS on Outposts DB instance.
|
Boolean |
getEnableIAMDatabaseAuthentication()
A value that indicates whether to enable mapping of Amazon Web Services 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 |
getEngine()
The target Oracle DB engine when you convert a non-CDB to a CDB.
|
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.
|
Boolean |
getManageMasterUserPassword()
A value that indicates whether to manage the master user password with Amazon Web Services Secrets Manager.
|
String |
getMasterUserPassword()
The new password for the master user.
|
String |
getMasterUserSecretKmsKeyId()
The Amazon Web Services KMS key identifier to encrypt a secret that is automatically generated and managed in
Amazon Web Services Secrets Manager.
|
Integer |
getMaxAllocatedStorage()
The upper limit in gibibytes (GiB) 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 |
getNetworkType()
The network type of the DB instance.
|
String |
getNewDBInstanceIdentifier()
The new DB instance identifier for the DB instance when renaming a DB instance.
|
String |
getOptionGroupName()
A value that indicates the DB instance should be associated with the specified option group.
|
String |
getPerformanceInsightsKMSKeyId()
The Amazon Web Services KMS key identifier for encryption of Performance Insights data.
|
Integer |
getPerformanceInsightsRetentionPeriod()
The number of 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 |
getReplicaMode()
A value that sets the open mode of a replica database to either mounted or read-only.
|
Integer |
getResumeFullAutomationModeMinutes()
The number of minutes to pause the automation.
|
Boolean |
getRotateMasterUserPassword()
A value that indicates whether to rotate the secret managed by Amazon Web Services Secrets Manager for the master
user password.
|
Integer |
getStorageThroughput()
Specifies the storage throughput value for the DB instance.
|
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 Amazon 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 |
isCertificateRotationRestart()
A value that indicates whether the DB instance is restarted when you rotate your SSL/TLS certificate.
|
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 |
isEnableCustomerOwnedIp()
A value that indicates whether to enable a customer-owned IP address (CoIP) for an RDS on Outposts DB instance.
|
Boolean |
isEnableIAMDatabaseAuthentication()
A value that indicates whether to enable mapping of Amazon Web Services 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 |
isManageMasterUserPassword()
A value that indicates whether to manage the master user password with Amazon Web Services Secrets Manager.
|
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 |
isRotateMasterUserPassword()
A value that indicates whether to rotate the secret managed by Amazon Web Services Secrets Manager for the master
user password.
|
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 (GiB) 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 |
setAutomationMode(String automationMode)
The automation mode of the RDS Custom DB instance:
full or all paused . |
void |
setAutoMinorVersionUpgrade(Boolean autoMinorVersionUpgrade)
A value that indicates whether minor version upgrades are applied automatically to the DB instance during the
maintenance window.
|
void |
setAwsBackupRecoveryPointArn(String awsBackupRecoveryPointArn)
The Amazon Resource Name (ARN) of the recovery point in Amazon Web Services Backup.
|
void |
setBackupRetentionPeriod(Integer backupRetentionPeriod)
The number of days to retain automated backups.
|
void |
setCACertificateIdentifier(String cACertificateIdentifier)
Specifies the CA certificate identifier to use for the DB instance’s server certificate.
|
void |
setCertificateRotationRestart(Boolean certificateRotationRestart)
A value that indicates whether the DB instance is restarted when you rotate your SSL/TLS certificate.
|
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 |
setEnableCustomerOwnedIp(Boolean enableCustomerOwnedIp)
A value that indicates whether to enable a customer-owned IP address (CoIP) for an RDS on Outposts DB instance.
|
void |
setEnableIAMDatabaseAuthentication(Boolean enableIAMDatabaseAuthentication)
A value that indicates whether to enable mapping of Amazon Web Services 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 |
setEngine(String engine)
The target Oracle DB engine when you convert a non-CDB to a CDB.
|
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 |
setManageMasterUserPassword(Boolean manageMasterUserPassword)
A value that indicates whether to manage the master user password with Amazon Web Services Secrets Manager.
|
void |
setMasterUserPassword(String masterUserPassword)
The new password for the master user.
|
void |
setMasterUserSecretKmsKeyId(String masterUserSecretKmsKeyId)
The Amazon Web Services KMS key identifier to encrypt a secret that is automatically generated and managed in
Amazon Web Services Secrets Manager.
|
void |
setMaxAllocatedStorage(Integer maxAllocatedStorage)
The upper limit in gibibytes (GiB) 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 |
setNetworkType(String networkType)
The network type of the DB instance.
|
void |
setNewDBInstanceIdentifier(String newDBInstanceIdentifier)
The new DB instance identifier for the DB instance when renaming a DB instance.
|
void |
setOptionGroupName(String optionGroupName)
A value that indicates the DB instance should be associated with the specified option group.
|
void |
setPerformanceInsightsKMSKeyId(String performanceInsightsKMSKeyId)
The Amazon Web Services KMS key identifier for encryption of Performance Insights data.
|
void |
setPerformanceInsightsRetentionPeriod(Integer performanceInsightsRetentionPeriod)
The number of 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 |
setReplicaMode(String replicaMode)
A value that sets the open mode of a replica database to either mounted or read-only.
|
void |
setResumeFullAutomationModeMinutes(Integer resumeFullAutomationModeMinutes)
The number of minutes to pause the automation.
|
void |
setRotateMasterUserPassword(Boolean rotateMasterUserPassword)
A value that indicates whether to rotate the secret managed by Amazon Web Services Secrets Manager for the master
user password.
|
void |
setStorageThroughput(Integer storageThroughput)
Specifies the storage throughput value for the DB instance.
|
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 Amazon 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 (GiB) 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 |
withAutomationMode(AutomationMode automationMode)
The automation mode of the RDS Custom DB instance:
full or all paused . |
ModifyDBInstanceRequest |
withAutomationMode(String automationMode)
The automation mode of the RDS Custom DB instance:
full or all paused . |
ModifyDBInstanceRequest |
withAutoMinorVersionUpgrade(Boolean autoMinorVersionUpgrade)
A value that indicates whether minor version upgrades are applied automatically to the DB instance during the
maintenance window.
|
ModifyDBInstanceRequest |
withAwsBackupRecoveryPointArn(String awsBackupRecoveryPointArn)
The Amazon Resource Name (ARN) of the recovery point in Amazon Web Services Backup.
|
ModifyDBInstanceRequest |
withBackupRetentionPeriod(Integer backupRetentionPeriod)
The number of days to retain automated backups.
|
ModifyDBInstanceRequest |
withCACertificateIdentifier(String cACertificateIdentifier)
Specifies the CA certificate identifier to use for the DB instance’s server certificate.
|
ModifyDBInstanceRequest |
withCertificateRotationRestart(Boolean certificateRotationRestart)
A value that indicates whether the DB instance is restarted when you rotate your SSL/TLS certificate.
|
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 |
withEnableCustomerOwnedIp(Boolean enableCustomerOwnedIp)
A value that indicates whether to enable a customer-owned IP address (CoIP) for an RDS on Outposts DB instance.
|
ModifyDBInstanceRequest |
withEnableIAMDatabaseAuthentication(Boolean enableIAMDatabaseAuthentication)
A value that indicates whether to enable mapping of Amazon Web Services 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 |
withEngine(String engine)
The target Oracle DB engine when you convert a non-CDB to a CDB.
|
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 |
withManageMasterUserPassword(Boolean manageMasterUserPassword)
A value that indicates whether to manage the master user password with Amazon Web Services Secrets Manager.
|
ModifyDBInstanceRequest |
withMasterUserPassword(String masterUserPassword)
The new password for the master user.
|
ModifyDBInstanceRequest |
withMasterUserSecretKmsKeyId(String masterUserSecretKmsKeyId)
The Amazon Web Services KMS key identifier to encrypt a secret that is automatically generated and managed in
Amazon Web Services Secrets Manager.
|
ModifyDBInstanceRequest |
withMaxAllocatedStorage(Integer maxAllocatedStorage)
The upper limit in gibibytes (GiB) 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 |
withNetworkType(String networkType)
The network type of the DB instance.
|
ModifyDBInstanceRequest |
withNewDBInstanceIdentifier(String newDBInstanceIdentifier)
The new DB instance identifier for the DB instance when renaming a DB instance.
|
ModifyDBInstanceRequest |
withOptionGroupName(String optionGroupName)
A value that indicates the DB instance should be associated with the specified option group.
|
ModifyDBInstanceRequest |
withPerformanceInsightsKMSKeyId(String performanceInsightsKMSKeyId)
The Amazon Web Services KMS key identifier for encryption of Performance Insights data.
|
ModifyDBInstanceRequest |
withPerformanceInsightsRetentionPeriod(Integer performanceInsightsRetentionPeriod)
The number of 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 |
withReplicaMode(ReplicaMode replicaMode)
A value that sets the open mode of a replica database to either mounted or read-only.
|
ModifyDBInstanceRequest |
withReplicaMode(String replicaMode)
A value that sets the open mode of a replica database to either mounted or read-only.
|
ModifyDBInstanceRequest |
withResumeFullAutomationModeMinutes(Integer resumeFullAutomationModeMinutes)
The number of minutes to pause the automation.
|
ModifyDBInstanceRequest |
withRotateMasterUserPassword(Boolean rotateMasterUserPassword)
A value that indicates whether to rotate the secret managed by Amazon Web Services Secrets Manager for the master
user password.
|
ModifyDBInstanceRequest |
withStorageThroughput(Integer storageThroughput)
Specifies the storage throughput value for the DB instance.
|
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 Amazon EC2 VPC security groups to authorize on this DB instance.
|
ModifyDBInstanceRequest |
withVpcSecurityGroupIds(String... vpcSecurityGroupIds)
A list of Amazon 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 (GiB) 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 (GiB) 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 (GiB) 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 (GiB) 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 (GiB) 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 Amazon Web Services 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 or Aurora DB instance classes in the Amazon Aurora User Guide. For RDS Custom, see DB instance class support for RDS Custom for Oracle and DB instance class support for RDS Custom for SQL Server.
If you modify the DB instance class, an outage occurs during the change. The change is applied during the next
maintenance window, unless you specify ApplyImmediately
in your 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 Amazon Web Services 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 or Aurora
DB instance classes in the Amazon Aurora User Guide. For RDS Custom, see DB instance class support for RDS Custom for Oracle and DB instance class support for RDS Custom for SQL Server.
If you modify the DB instance class, an outage occurs during the change. The change is applied during the
next maintenance window, unless you specify ApplyImmediately
in your 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 Amazon Web Services 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 or Aurora DB instance classes in the Amazon Aurora User Guide. For RDS Custom, see DB instance class support for RDS Custom for Oracle and DB instance class support for RDS Custom for SQL Server.
If you modify the DB instance class, an outage occurs during the change. The change is applied during the next
maintenance window, unless you specify ApplyImmediately
in your request.
Default: Uses existing setting
If you modify the DB instance class, an outage occurs during the change. The change is applied during the
next maintenance window, unless you specify ApplyImmediately
in your 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 Amazon Web Services 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 or Aurora DB instance classes in the Amazon Aurora User Guide. For RDS Custom, see DB instance class support for RDS Custom for Oracle and DB instance class support for RDS Custom for SQL Server.
If you modify the DB instance class, an outage occurs during the change. The change is applied during the next
maintenance window, unless you specify ApplyImmediately
in your 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 Amazon Web Services 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 or Aurora
DB instance classes in the Amazon Aurora User Guide. For RDS Custom, see DB instance class support for RDS Custom for Oracle and DB instance class support for RDS Custom for SQL Server.
If you modify the DB instance class, an outage occurs during the change. The change is applied during the
next maintenance window, unless you specify ApplyImmediately
in your 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 Working with a DB instance in a VPC 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
.
This parameter doesn't apply to RDS Custom.
Constraints: If supplied, must match the name of an existing DBSubnetGroup.
Example: mydbsubnetgroup
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 Working with a DB instance in a VPC 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
.
This parameter doesn't apply to RDS Custom.
Constraints: If supplied, must match the name of an existing DBSubnetGroup.
Example: mydbsubnetgroup
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 Working with a DB instance in a VPC 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
.
This parameter doesn't apply to RDS Custom.
Constraints: If supplied, must match the name of an existing DBSubnetGroup.
Example: mydbsubnetgroup
Changing the subnet group causes an outage during the change. The change is applied during the next
maintenance window, unless you enable ApplyImmediately
.
This parameter doesn't apply to RDS Custom.
Constraints: If supplied, must match the name of an existing DBSubnetGroup.
Example: mydbsubnetgroup
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 Working with a DB instance in a VPC 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
.
This parameter doesn't apply to RDS Custom.
Constraints: If supplied, must match the name of an existing DBSubnetGroup.
Example: mydbsubnetgroup
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 Working with a DB instance in a VPC 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
.
This parameter doesn't apply to RDS Custom.
Constraints: If supplied, must match the name of an existing DBSubnetGroup.
Example: mydbsubnetgroup
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.
This setting doesn't apply to RDS Custom.
Constraints:
If supplied, must match existing DBSecurityGroups.
This setting doesn't apply to RDS Custom.
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.
This setting doesn't apply to RDS Custom.
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.
This setting doesn't apply to RDS Custom.
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.
This setting doesn't apply to RDS Custom.
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.
This setting doesn't apply to RDS Custom.
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.
This setting doesn't apply to RDS Custom.
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.
This setting doesn't apply to RDS Custom.
Constraints:
If supplied, must match existing DBSecurityGroups.
public List<String> getVpcSecurityGroupIds()
A list of Amazon EC2 VPC security groups to authorize on this DB instance. This change is asynchronously applied as soon as possible.
This setting doesn't apply to RDS Custom.
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.
This setting doesn't apply to RDS Custom.
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 Amazon EC2 VPC security groups to authorize on this DB instance. This change is asynchronously applied as soon as possible.
This setting doesn't apply to RDS Custom.
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 Amazon EC2 VPC security groups to authorize on this DB instance. This change is asynchronously
applied as soon as possible.
This setting doesn't apply to RDS Custom.
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 Amazon EC2 VPC security groups to authorize on this DB instance. This change is asynchronously applied as soon as possible.
This setting doesn't apply to RDS Custom.
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 Amazon EC2 VPC security groups to authorize on this DB instance. This change is asynchronously
applied as soon as possible.
This setting doesn't apply to RDS Custom.
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 Amazon EC2 VPC security groups to authorize on this DB instance. This change is asynchronously applied as soon as possible.
This setting doesn't apply to RDS Custom.
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 Amazon EC2 VPC security groups to authorize on this DB instance. This change is asynchronously
applied as soon as possible.
This setting doesn't apply to RDS Custom.
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.
This setting doesn't apply to RDS Custom.
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
Constraints: Can't be specified if ManageMasterUserPassword
is turned on.
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 operations 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.
This setting doesn't apply to RDS Custom.
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
Constraints: Can't be specified if ManageMasterUserPassword
is turned on.
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 operations 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.
This setting doesn't apply to RDS Custom.
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
Constraints: Can't be specified if ManageMasterUserPassword
is turned on.
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 operations 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.
This setting doesn't apply to RDS Custom.
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
Constraints: Can't be specified if ManageMasterUserPassword
is turned on.
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 operations 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.
This setting doesn't apply to RDS Custom.
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
Constraints: Can't be specified if ManageMasterUserPassword
is turned on.
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 operations 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.
This setting doesn't apply to RDS Custom.
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
Constraints: Can't be specified if ManageMasterUserPassword
is turned on.
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 operations 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 aren't applied during the next maintenance window. However, if you modify dynamic parameters in the newly associated DB parameter group, these changes are applied immediately without a reboot.
This setting doesn't apply to RDS Custom.
Default: Uses existing setting
Constraints: The DB parameter group must be in the same DB parameter group family as the 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 aren't applied during the next maintenance window. However, if you modify dynamic parameters in the newly associated DB parameter group, these changes are applied immediately without a reboot.
This setting doesn't apply to RDS Custom.
Default: Uses existing setting
Constraints: The DB parameter group must be in the same DB parameter group family as the 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 aren't applied during the next maintenance window. However, if you modify dynamic parameters in the newly associated DB parameter group, these changes are applied immediately without a reboot.
This setting doesn't apply to RDS Custom.
Default: Uses existing setting
Constraints: The DB parameter group must be in the same DB parameter group family as 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 aren't applied during the next maintenance window. However, if you modify dynamic parameters in the newly associated DB parameter group, these changes are applied immediately without a reboot.
This setting doesn't apply to RDS Custom.
Default: Uses existing setting
Constraints: The DB parameter group must be in the same DB parameter group family as the 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 aren't applied during the next maintenance window. However, if you modify dynamic parameters in the newly associated DB parameter group, these changes are applied immediately without a reboot.
This setting doesn't apply to RDS Custom.
Default: Uses existing setting
Constraints: The DB parameter group must be in the same DB parameter group family as the 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 aren't applied during the next maintenance window. However, if you modify dynamic parameters in the newly associated DB parameter group, these changes are applied immediately without a reboot.
This setting doesn't apply to RDS Custom.
Default: Uses existing setting
Constraints: The DB parameter group must be in the same DB parameter group family as the 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.
Enabling and disabling backups can result in a brief I/O suspension that lasts from a few seconds to a few minutes, depending on the size and class of your DB instance.
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:
It must be a value from 0 to 35. It can't be set to 0 if the DB instance is a source to read replicas. It can't be set to 0 for an RDS Custom for Oracle DB instance.
It can be specified for a MySQL read replica only if the source is running MySQL 5.6 or later.
It can be specified for a PostgreSQL read replica only if the source is running PostgreSQL 9.3.5.
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. Enabling and disabling backups can result in a brief I/O suspension that lasts from a few seconds to a few minutes, depending on the size and class of your DB instance.
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:
It must be a value from 0 to 35. It can't be set to 0 if the DB instance is a source to read replicas. It can't be set to 0 for an RDS Custom for Oracle DB instance.
It can be specified for a MySQL read replica only if the source is running MySQL 5.6 or later.
It can be specified for a PostgreSQL read replica only if the source is running PostgreSQL 9.3.5.
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.
Enabling and disabling backups can result in a brief I/O suspension that lasts from a few seconds to a few minutes, depending on the size and class of your DB instance.
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:
It must be a value from 0 to 35. It can't be set to 0 if the DB instance is a source to read replicas. It can't be set to 0 for an RDS Custom for Oracle DB instance.
It can be specified for a MySQL read replica only if the source is running MySQL 5.6 or later.
It can be specified for a PostgreSQL read replica only if the source is running PostgreSQL 9.3.5.
Enabling and disabling backups can result in a brief I/O suspension that lasts from a few seconds to a few minutes, depending on the size and class of your DB instance.
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:
It must be a value from 0 to 35. It can't be set to 0 if the DB instance is a source to read replicas. It can't be set to 0 for an RDS Custom for Oracle DB instance.
It can be specified for a MySQL read replica only if the source is running MySQL 5.6 or later.
It can be specified for a PostgreSQL read replica only if the source is running PostgreSQL 9.3.5.
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.
Enabling and disabling backups can result in a brief I/O suspension that lasts from a few seconds to a few minutes, depending on the size and class of your DB instance.
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:
It must be a value from 0 to 35. It can't be set to 0 if the DB instance is a source to read replicas. It can't be set to 0 for an RDS Custom for Oracle DB instance.
It can be specified for a MySQL read replica only if the source is running MySQL 5.6 or later.
It can be specified for a PostgreSQL read replica only if the source is running PostgreSQL 9.3.5.
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. Enabling and disabling backups can result in a brief I/O suspension that lasts from a few seconds to a few minutes, depending on the size and class of your DB instance.
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:
It must be a value from 0 to 35. It can't be set to 0 if the DB instance is a source to read replicas. It can't be set to 0 for an RDS Custom for Oracle DB instance.
It can be specified for a MySQL read replica only if the source is running MySQL 5.6 or later.
It can be specified for a PostgreSQL read replica only if the source is running PostgreSQL 9.3.5.
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. The default is a 30-minute window selected at random from
an 8-hour block of time for each Amazon Web Services Region. For more information, see Backup window in the Amazon RDS User Guide.
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. The default is a 30-minute window
selected at random from an 8-hour block of time for each Amazon Web Services Region. For more information,
see Backup window in the Amazon RDS User Guide.
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. The default is a 30-minute window selected at random from
an 8-hour block of time for each Amazon Web Services Region. For more information, see Backup window in the Amazon RDS User Guide.
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. The default is a 30-minute window
selected at random from an 8-hour block of time for each Amazon Web Services Region. For more
information, see Backup window in the Amazon RDS User Guide.
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. The default is a 30-minute window selected at random from
an 8-hour block of time for each Amazon Web Services Region. For more information, see Backup window in the Amazon RDS User Guide.
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. The default is a 30-minute window
selected at random from an 8-hour block of time for each Amazon Web Services Region. For more information,
see Backup window in the Amazon RDS User Guide.
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.
For more information, see Amazon RDS Maintenance Window in the Amazon RDS User Guide.
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.
For more information, see Amazon RDS Maintenance Window in the Amazon RDS User Guide.
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.
For more information, see Amazon RDS Maintenance Window in the Amazon RDS User Guide.
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
For more information, see Amazon RDS Maintenance Window in the Amazon RDS User Guide.
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.
For more information, see Amazon RDS Maintenance Window in the Amazon RDS User Guide.
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.
For more information, see Amazon RDS Maintenance Window in the Amazon RDS User Guide.
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. The change is applied during the next maintenance window unless the ApplyImmediately
parameter is enabled for this request.
This setting doesn't apply to RDS Custom.
multiAZ
- A value that indicates whether the DB instance is a Multi-AZ deployment. Changing this parameter doesn't
result in an outage. The change is applied during the next maintenance window unless the
ApplyImmediately
parameter is enabled for this request.
This setting doesn't apply to RDS Custom.
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. The change is applied during the next maintenance window unless the ApplyImmediately
parameter is enabled for this request.
This setting doesn't apply to RDS Custom.
ApplyImmediately
parameter is enabled for this request.
This setting doesn't apply to RDS Custom.
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. The change is applied during the next maintenance window unless the ApplyImmediately
parameter is enabled for this request.
This setting doesn't apply to RDS Custom.
multiAZ
- A value that indicates whether the DB instance is a Multi-AZ deployment. Changing this parameter doesn't
result in an outage. The change is applied during the next maintenance window unless the
ApplyImmediately
parameter is enabled for this request.
This setting doesn't apply to RDS Custom.
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. The change is applied during the next maintenance window unless the ApplyImmediately
parameter is enabled for this request.
This setting doesn't apply to RDS Custom.
ApplyImmediately
parameter is enabled for this request.
This setting doesn't apply to RDS Custom.
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
enabled 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.
If you specify only a major version, Amazon RDS will update the DB instance to the default minor version if the
current minor version is lower. For information about valid engine versions, see CreateDBInstance
,
or call DescribeDBEngineVersions
.
If the instance that you're modifying is acting as a read replica, the engine version that you specify must be the same or later than the version that the source DB instance or cluster is running.
In RDS Custom for Oracle, this parameter is supported for read replicas only if they are in the
PATCH_DB_FAILURE
lifecycle.
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 enabled 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.
If you specify only a major version, Amazon RDS will update the DB instance to the default minor version
if the current minor version is lower. For information about valid engine versions, see
CreateDBInstance
, or call DescribeDBEngineVersions
.
If the instance that you're modifying is acting as a read replica, the engine version that you specify must be the same or later than the version that the source DB instance or cluster is running.
In RDS Custom for Oracle, this parameter is supported for read replicas only if they are in the
PATCH_DB_FAILURE
lifecycle.
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
enabled 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.
If you specify only a major version, Amazon RDS will update the DB instance to the default minor version if the
current minor version is lower. For information about valid engine versions, see CreateDBInstance
,
or call DescribeDBEngineVersions
.
If the instance that you're modifying is acting as a read replica, the engine version that you specify must be the same or later than the version that the source DB instance or cluster is running.
In RDS Custom for Oracle, this parameter is supported for read replicas only if they are in the
PATCH_DB_FAILURE
lifecycle.
ApplyImmediately
parameter is enabled 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.
If you specify only a major version, Amazon RDS will update the DB instance to the default minor version
if the current minor version is lower. For information about valid engine versions, see
CreateDBInstance
, or call DescribeDBEngineVersions
.
If the instance that you're modifying is acting as a read replica, the engine version that you specify must be the same or later than the version that the source DB instance or cluster is running.
In RDS Custom for Oracle, this parameter is supported for read replicas only if they are in the
PATCH_DB_FAILURE
lifecycle.
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
enabled 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.
If you specify only a major version, Amazon RDS will update the DB instance to the default minor version if the
current minor version is lower. For information about valid engine versions, see CreateDBInstance
,
or call DescribeDBEngineVersions
.
If the instance that you're modifying is acting as a read replica, the engine version that you specify must be the same or later than the version that the source DB instance or cluster is running.
In RDS Custom for Oracle, this parameter is supported for read replicas only if they are in the
PATCH_DB_FAILURE
lifecycle.
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 enabled 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.
If you specify only a major version, Amazon RDS will update the DB instance to the default minor version
if the current minor version is lower. For information about valid engine versions, see
CreateDBInstance
, or call DescribeDBEngineVersions
.
If the instance that you're modifying is acting as a read replica, the engine version that you specify must be the same or later than the version that the source DB instance or cluster is running.
In RDS Custom for Oracle, this parameter is supported for read replicas only if they are in the
PATCH_DB_FAILURE
lifecycle.
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.
This setting doesn't apply to RDS Custom.
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.
This setting doesn't apply to RDS Custom.
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.
This setting doesn't apply to RDS Custom.
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.
This setting doesn't apply to RDS Custom.
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.
This setting doesn't apply to RDS Custom.
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.
This setting doesn't apply to RDS Custom.
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.
This setting doesn't apply to RDS Custom.
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.
This setting doesn't apply to RDS Custom.
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. An outage occurs when all the following conditions are met:
The automatic upgrade is enabled for the maintenance window.
A newer minor version is available.
RDS has enabled automatic patching for the engine version.
If any of the preceding conditions isn't met, RDS applies the change as soon as possible and doesn't cause an outage.
For an RDS Custom DB instance, set AutoMinorVersionUpgrade
to false
. Otherwise, the
operation returns an error.
autoMinorVersionUpgrade
- A value that indicates whether minor version upgrades are applied automatically to the DB instance during
the maintenance window. An outage occurs when all the following conditions are met:
The automatic upgrade is enabled for the maintenance window.
A newer minor version is available.
RDS has enabled automatic patching for the engine version.
If any of the preceding conditions isn't met, RDS applies the change as soon as possible and doesn't cause an outage.
For an RDS Custom DB instance, set AutoMinorVersionUpgrade
to false
. Otherwise,
the operation returns an error.
public Boolean getAutoMinorVersionUpgrade()
A value that indicates whether minor version upgrades are applied automatically to the DB instance during the maintenance window. An outage occurs when all the following conditions are met:
The automatic upgrade is enabled for the maintenance window.
A newer minor version is available.
RDS has enabled automatic patching for the engine version.
If any of the preceding conditions isn't met, RDS applies the change as soon as possible and doesn't cause an outage.
For an RDS Custom DB instance, set AutoMinorVersionUpgrade
to false
. Otherwise, the
operation returns an error.
The automatic upgrade is enabled for the maintenance window.
A newer minor version is available.
RDS has enabled automatic patching for the engine version.
If any of the preceding conditions isn't met, RDS applies the change as soon as possible and doesn't cause an outage.
For an RDS Custom DB instance, set AutoMinorVersionUpgrade
to false
. Otherwise,
the operation returns an error.
public ModifyDBInstanceRequest withAutoMinorVersionUpgrade(Boolean autoMinorVersionUpgrade)
A value that indicates whether minor version upgrades are applied automatically to the DB instance during the maintenance window. An outage occurs when all the following conditions are met:
The automatic upgrade is enabled for the maintenance window.
A newer minor version is available.
RDS has enabled automatic patching for the engine version.
If any of the preceding conditions isn't met, RDS applies the change as soon as possible and doesn't cause an outage.
For an RDS Custom DB instance, set AutoMinorVersionUpgrade
to false
. Otherwise, the
operation returns an error.
autoMinorVersionUpgrade
- A value that indicates whether minor version upgrades are applied automatically to the DB instance during
the maintenance window. An outage occurs when all the following conditions are met:
The automatic upgrade is enabled for the maintenance window.
A newer minor version is available.
RDS has enabled automatic patching for the engine version.
If any of the preceding conditions isn't met, RDS applies the change as soon as possible and doesn't cause an outage.
For an RDS Custom DB instance, set AutoMinorVersionUpgrade
to false
. Otherwise,
the operation returns an error.
public Boolean isAutoMinorVersionUpgrade()
A value that indicates whether minor version upgrades are applied automatically to the DB instance during the maintenance window. An outage occurs when all the following conditions are met:
The automatic upgrade is enabled for the maintenance window.
A newer minor version is available.
RDS has enabled automatic patching for the engine version.
If any of the preceding conditions isn't met, RDS applies the change as soon as possible and doesn't cause an outage.
For an RDS Custom DB instance, set AutoMinorVersionUpgrade
to false
. Otherwise, the
operation returns an error.
The automatic upgrade is enabled for the maintenance window.
A newer minor version is available.
RDS has enabled automatic patching for the engine version.
If any of the preceding conditions isn't met, RDS applies the change as soon as possible and doesn't cause an outage.
For an RDS Custom DB instance, set AutoMinorVersionUpgrade
to false
. Otherwise,
the operation returns an error.
public void setLicenseModel(String licenseModel)
The license model for the DB instance.
This setting doesn't apply to RDS Custom.
Valid values: license-included
| bring-your-own-license
|
general-public-license
licenseModel
- The license model for the DB instance.
This setting doesn't apply to RDS Custom.
Valid values: license-included
| bring-your-own-license
|
general-public-license
public String getLicenseModel()
The license model for the DB instance.
This setting doesn't apply to RDS Custom.
Valid values: license-included
| bring-your-own-license
|
general-public-license
This setting doesn't apply to RDS Custom.
Valid values: license-included
| bring-your-own-license
|
general-public-license
public ModifyDBInstanceRequest withLicenseModel(String licenseModel)
The license model for the DB instance.
This setting doesn't apply to RDS Custom.
Valid values: license-included
| bring-your-own-license
|
general-public-license
licenseModel
- The license model for the DB instance.
This setting doesn't apply to RDS Custom.
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)
A value that indicates the DB instance should be associated with the specified option group.
Changing this parameter doesn't result in an outage, with one exception. If the parameter change results in an option group that enables OEM, it can cause a brief period, lasting less than a second, during which new connections are rejected but existing connections aren't interrupted.
The change is applied during the next maintenance window unless the ApplyImmediately
parameter is
enabled for this request.
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 after it is associated with a DB instance.
This setting doesn't apply to RDS Custom.
optionGroupName
- A value that indicates the DB instance should be associated with the specified option group.
Changing this parameter doesn't result in an outage, with one exception. If the parameter change results in an option group that enables OEM, it can cause a brief period, lasting less than a second, during which new connections are rejected but existing connections aren't interrupted.
The change is applied during the next maintenance window unless the ApplyImmediately
parameter is enabled for this request.
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 after it is associated with a DB instance.
This setting doesn't apply to RDS Custom.
public String getOptionGroupName()
A value that indicates the DB instance should be associated with the specified option group.
Changing this parameter doesn't result in an outage, with one exception. If the parameter change results in an option group that enables OEM, it can cause a brief period, lasting less than a second, during which new connections are rejected but existing connections aren't interrupted.
The change is applied during the next maintenance window unless the ApplyImmediately
parameter is
enabled for this request.
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 after it is associated with a DB instance.
This setting doesn't apply to RDS Custom.
Changing this parameter doesn't result in an outage, with one exception. If the parameter change results in an option group that enables OEM, it can cause a brief period, lasting less than a second, during which new connections are rejected but existing connections aren't interrupted.
The change is applied during the next maintenance window unless the ApplyImmediately
parameter is enabled for this request.
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 after it is associated with a DB instance.
This setting doesn't apply to RDS Custom.
public ModifyDBInstanceRequest withOptionGroupName(String optionGroupName)
A value that indicates the DB instance should be associated with the specified option group.
Changing this parameter doesn't result in an outage, with one exception. If the parameter change results in an option group that enables OEM, it can cause a brief period, lasting less than a second, during which new connections are rejected but existing connections aren't interrupted.
The change is applied during the next maintenance window unless the ApplyImmediately
parameter is
enabled for this request.
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 after it is associated with a DB instance.
This setting doesn't apply to RDS Custom.
optionGroupName
- A value that indicates the DB instance should be associated with the specified option group.
Changing this parameter doesn't result in an outage, with one exception. If the parameter change results in an option group that enables OEM, it can cause a brief period, lasting less than a second, during which new connections are rejected but existing connections aren't interrupted.
The change is applied during the next maintenance window unless the ApplyImmediately
parameter is enabled for this request.
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 after it is associated with a DB instance.
This setting doesn't apply to RDS Custom.
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.
This setting doesn't apply to RDS Custom.
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.
This setting doesn't apply to RDS Custom.
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.
This setting doesn't apply to RDS Custom.
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.
This setting doesn't apply to RDS Custom.
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.
This setting doesn't apply to RDS Custom.
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.
This setting doesn't apply to RDS Custom.
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: gp2 | gp3 | io1 | standard
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: gp2 | gp3 | io1 | standard
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: gp2 | gp3 | io1 | standard
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: gp2 | gp3 | io1 | standard
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: gp2 | gp3 | io1 | standard
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: gp2 | gp3 | io1 | standard
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.
This setting doesn't apply to RDS Custom.
tdeCredentialArn
- The ARN from the key store with which to associate the instance for TDE encryption.
This setting doesn't apply to RDS Custom.
public String getTdeCredentialArn()
The ARN from the key store with which to associate the instance for TDE encryption.
This setting doesn't apply to RDS Custom.
This setting doesn't apply to RDS Custom.
public ModifyDBInstanceRequest withTdeCredentialArn(String tdeCredentialArn)
The ARN from the key store with which to associate the instance for TDE encryption.
This setting doesn't apply to RDS Custom.
tdeCredentialArn
- The ARN from the key store with which to associate the instance for TDE encryption.
This setting doesn't apply to RDS Custom.
public void setTdeCredentialPassword(String tdeCredentialPassword)
The password for the given ARN from the key store in order to access the device.
This setting doesn't apply to RDS Custom.
tdeCredentialPassword
- The password for the given ARN from the key store in order to access the device.
This setting doesn't apply to RDS Custom.
public String getTdeCredentialPassword()
The password for the given ARN from the key store in order to access the device.
This setting doesn't apply to RDS Custom.
This setting doesn't apply to RDS Custom.
public ModifyDBInstanceRequest withTdeCredentialPassword(String tdeCredentialPassword)
The password for the given ARN from the key store in order to access the device.
This setting doesn't apply to RDS Custom.
tdeCredentialPassword
- The password for the given ARN from the key store in order to access the device.
This setting doesn't apply to RDS Custom.
public void setCACertificateIdentifier(String cACertificateIdentifier)
Specifies the CA certificate identifier to use for the DB instance’s server certificate.
This setting doesn't apply to RDS Custom.
For more information, see Using SSL/TLS to encrypt a connection to a DB instance in the Amazon RDS User Guide and Using SSL/TLS to encrypt a connection to a DB cluster in the Amazon Aurora User Guide.
cACertificateIdentifier
- Specifies the CA certificate identifier to use for the DB instance’s server certificate.
This setting doesn't apply to RDS Custom.
For more information, see Using SSL/TLS to encrypt a connection to a DB instance in the Amazon RDS User Guide and Using SSL/TLS to encrypt a connection to a DB cluster in the Amazon Aurora User Guide.
public String getCACertificateIdentifier()
Specifies the CA certificate identifier to use for the DB instance’s server certificate.
This setting doesn't apply to RDS Custom.
For more information, see Using SSL/TLS to encrypt a connection to a DB instance in the Amazon RDS User Guide and Using SSL/TLS to encrypt a connection to a DB cluster in the Amazon Aurora User Guide.
This setting doesn't apply to RDS Custom.
For more information, see Using SSL/TLS to encrypt a connection to a DB instance in the Amazon RDS User Guide and Using SSL/TLS to encrypt a connection to a DB cluster in the Amazon Aurora User Guide.
public ModifyDBInstanceRequest withCACertificateIdentifier(String cACertificateIdentifier)
Specifies the CA certificate identifier to use for the DB instance’s server certificate.
This setting doesn't apply to RDS Custom.
For more information, see Using SSL/TLS to encrypt a connection to a DB instance in the Amazon RDS User Guide and Using SSL/TLS to encrypt a connection to a DB cluster in the Amazon Aurora User Guide.
cACertificateIdentifier
- Specifies the CA certificate identifier to use for the DB instance’s server certificate.
This setting doesn't apply to RDS Custom.
For more information, see Using SSL/TLS to encrypt a connection to a DB instance in the Amazon RDS User Guide and Using SSL/TLS to encrypt a connection to a DB cluster in the Amazon Aurora User Guide.
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. You must create the domain before this operation. Currently, you can create only MySQL,
Microsoft SQL Server, Oracle, and PostgreSQL DB instances in an Active Directory Domain.
For more information, see Kerberos Authentication in the Amazon RDS User Guide.
This setting doesn't apply to RDS Custom.
domain
- The Active Directory directory ID to move the DB instance to. Specify none
to remove the
instance from its current domain. You must create the domain before this operation. Currently, you can
create only MySQL, Microsoft SQL Server, Oracle, and PostgreSQL DB instances in an Active Directory
Domain.
For more information, see Kerberos Authentication in the Amazon RDS User Guide.
This setting doesn't apply to RDS Custom.
public String getDomain()
The Active Directory directory ID to move the DB instance to. Specify none
to remove the instance
from its current domain. You must create the domain before this operation. Currently, you can create only MySQL,
Microsoft SQL Server, Oracle, and PostgreSQL DB instances in an Active Directory Domain.
For more information, see Kerberos Authentication in the Amazon RDS User Guide.
This setting doesn't apply to RDS Custom.
none
to remove the
instance from its current domain. You must create the domain before this operation. Currently, you can
create only MySQL, Microsoft SQL Server, Oracle, and PostgreSQL DB instances in an Active Directory
Domain.
For more information, see Kerberos Authentication in the Amazon RDS User Guide.
This setting doesn't apply to RDS Custom.
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. You must create the domain before this operation. Currently, you can create only MySQL,
Microsoft SQL Server, Oracle, and PostgreSQL DB instances in an Active Directory Domain.
For more information, see Kerberos Authentication in the Amazon RDS User Guide.
This setting doesn't apply to RDS Custom.
domain
- The Active Directory directory ID to move the DB instance to. Specify none
to remove the
instance from its current domain. You must create the domain before this operation. Currently, you can
create only MySQL, Microsoft SQL Server, Oracle, and PostgreSQL DB instances in an Active Directory
Domain.
For more information, see Kerberos Authentication in the Amazon RDS User Guide.
This setting doesn't apply to RDS Custom.
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, which is the default.
If MonitoringRoleArn
is specified, set MonitoringInterval
to a value other than 0.
This setting doesn't apply to RDS Custom.
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, which is the default.
If MonitoringRoleArn
is specified, set MonitoringInterval
to a value other than
0.
This setting doesn't apply to RDS Custom.
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, which is the default.
If MonitoringRoleArn
is specified, set MonitoringInterval
to a value other than 0.
This setting doesn't apply to RDS Custom.
Valid Values: 0, 1, 5, 10, 15, 30, 60
If MonitoringRoleArn
is specified, set MonitoringInterval
to a value other than
0.
This setting doesn't apply to RDS Custom.
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, which is the default.
If MonitoringRoleArn
is specified, set MonitoringInterval
to a value other than 0.
This setting doesn't apply to RDS Custom.
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, which is the default.
If MonitoringRoleArn
is specified, set MonitoringInterval
to a value other than
0.
This setting doesn't apply to RDS Custom.
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.
If you change the DBPortNumber
value, your database restarts regardless of the value of the
ApplyImmediately
parameter.
This setting doesn't apply to RDS Custom.
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 1234
, 1434
, 3260
,
3343
, 3389
, 47001
, and 49152-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.
If you change the DBPortNumber
value, your database restarts regardless of the value of the
ApplyImmediately
parameter.
This setting doesn't apply to RDS Custom.
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 1234
, 1434
, 3260
,
3343
, 3389
, 47001
, and 49152-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.
If you change the DBPortNumber
value, your database restarts regardless of the value of the
ApplyImmediately
parameter.
This setting doesn't apply to RDS Custom.
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 1234
, 1434
, 3260
,
3343
, 3389
, 47001
, and 49152-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.
If you change the DBPortNumber
value, your database restarts regardless of the value of the
ApplyImmediately
parameter.
This setting doesn't apply to RDS Custom.
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 1234
, 1434
, 3260
,
3343
, 3389
, 47001
, and 49152-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.
If you change the DBPortNumber
value, your database restarts regardless of the value of the
ApplyImmediately
parameter.
This setting doesn't apply to RDS Custom.
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 1234
, 1434
, 3260
,
3343
, 3389
, 47001
, and 49152-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.
If you change the DBPortNumber
value, your database restarts regardless of the value of the
ApplyImmediately
parameter.
This setting doesn't apply to RDS Custom.
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 1234
, 1434
, 3260
,
3343
, 3389
, 47001
, and 49152-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 cluster is publicly accessible, its Domain Name System (DNS) endpoint resolves to the private IP address from within the DB cluster's virtual private cloud (VPC). It resolves to the public IP address from outside of the DB cluster's VPC. Access to the DB cluster is ultimately controlled by the security group it uses. That public access isn't permitted if the security group assigned to the DB cluster doesn't permit it.
When the DB instance isn't publicly accessible, it is an internal DB 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 cluster is publicly accessible, its Domain Name System (DNS) endpoint resolves to the private IP address from within the DB cluster's virtual private cloud (VPC). It resolves to the public IP address from outside of the DB cluster's VPC. Access to the DB cluster is ultimately controlled by the security group it uses. That public access isn't permitted if the security group assigned to the DB cluster doesn't permit it.
When the DB instance isn't publicly accessible, it is an internal DB 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 cluster is publicly accessible, its Domain Name System (DNS) endpoint resolves to the private IP address from within the DB cluster's virtual private cloud (VPC). It resolves to the public IP address from outside of the DB cluster's VPC. Access to the DB cluster is ultimately controlled by the security group it uses. That public access isn't permitted if the security group assigned to the DB cluster doesn't permit it.
When the DB instance isn't publicly accessible, it is an internal DB 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.
When the DB cluster is publicly accessible, its Domain Name System (DNS) endpoint resolves to the private IP address from within the DB cluster's virtual private cloud (VPC). It resolves to the public IP address from outside of the DB cluster's VPC. Access to the DB cluster is ultimately controlled by the security group it uses. That public access isn't permitted if the security group assigned to the DB cluster doesn't permit it.
When the DB instance isn't publicly accessible, it is an internal DB 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 ModifyDBInstanceRequest withPubliclyAccessible(Boolean publiclyAccessible)
A value that indicates whether the DB instance is publicly accessible.
When the DB cluster is publicly accessible, its Domain Name System (DNS) endpoint resolves to the private IP address from within the DB cluster's virtual private cloud (VPC). It resolves to the public IP address from outside of the DB cluster's VPC. Access to the DB cluster is ultimately controlled by the security group it uses. That public access isn't permitted if the security group assigned to the DB cluster doesn't permit it.
When the DB instance isn't publicly accessible, it is an internal DB 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 cluster is publicly accessible, its Domain Name System (DNS) endpoint resolves to the private IP address from within the DB cluster's virtual private cloud (VPC). It resolves to the public IP address from outside of the DB cluster's VPC. Access to the DB cluster is ultimately controlled by the security group it uses. That public access isn't permitted if the security group assigned to the DB cluster doesn't permit it.
When the DB instance isn't publicly accessible, it is an internal DB 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 cluster is publicly accessible, its Domain Name System (DNS) endpoint resolves to the private IP address from within the DB cluster's virtual private cloud (VPC). It resolves to the public IP address from outside of the DB cluster's VPC. Access to the DB cluster is ultimately controlled by the security group it uses. That public access isn't permitted if the security group assigned to the DB cluster doesn't permit it.
When the DB instance isn't publicly accessible, it is an internal DB 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.
When the DB cluster is publicly accessible, its Domain Name System (DNS) endpoint resolves to the private IP address from within the DB cluster's virtual private cloud (VPC). It resolves to the public IP address from outside of the DB cluster's VPC. Access to the DB cluster is ultimately controlled by the security group it uses. That public access isn't permitted if the security group assigned to the DB cluster doesn't permit it.
When the DB instance isn't publicly accessible, it is an internal DB 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 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, see
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, supply a MonitoringRoleArn
value.
This setting doesn't apply to RDS Custom.
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, see 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, supply a MonitoringRoleArn
value.
This setting doesn't apply to RDS Custom.
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, see
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, supply a MonitoringRoleArn
value.
This setting doesn't apply to RDS Custom.
arn:aws:iam:123456789012:role/emaccess
. For information on creating a
monitoring role, see 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, supply a
MonitoringRoleArn
value.
This setting doesn't apply to RDS Custom.
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, see
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, supply a MonitoringRoleArn
value.
This setting doesn't apply to RDS Custom.
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, see 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, supply a MonitoringRoleArn
value.
This setting doesn't apply to RDS Custom.
public void setDomainIAMRoleName(String domainIAMRoleName)
The name of the IAM role to use when making API calls to the Directory Service.
This setting doesn't apply to RDS Custom.
domainIAMRoleName
- The name of the IAM role to use when making API calls to the Directory Service.
This setting doesn't apply to RDS Custom.
public String getDomainIAMRoleName()
The name of the IAM role to use when making API calls to the Directory Service.
This setting doesn't apply to RDS Custom.
This setting doesn't apply to RDS Custom.
public ModifyDBInstanceRequest withDomainIAMRoleName(String domainIAMRoleName)
The name of the IAM role to use when making API calls to the Directory Service.
This setting doesn't apply to RDS Custom.
domainIAMRoleName
- The name of the IAM role to use when making API calls to the Directory Service.
This setting doesn't apply to RDS Custom.
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.
This setting doesn't apply to RDS Custom.
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.
This setting doesn't apply to RDS Custom.
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.
This setting doesn't apply to RDS Custom.
Default: 1
Valid Values: 0 - 15
This setting doesn't apply to RDS Custom.
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.
This setting doesn't apply to RDS Custom.
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.
This setting doesn't apply to RDS Custom.
Default: 1
Valid Values: 0 - 15
public void setEnableIAMDatabaseAuthentication(Boolean enableIAMDatabaseAuthentication)
A value that indicates whether to enable mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts. By default, mapping isn't enabled.
This setting doesn't apply to Amazon Aurora. Mapping Amazon Web Services IAM accounts to database accounts is managed by the DB cluster.
For more information about IAM database authentication, see IAM Database Authentication for MySQL and PostgreSQL in the Amazon RDS User Guide.
This setting doesn't apply to RDS Custom.
enableIAMDatabaseAuthentication
- A value that indicates whether to enable mapping of Amazon Web Services Identity and Access Management
(IAM) accounts to database accounts. By default, mapping isn't enabled.
This setting doesn't apply to Amazon Aurora. Mapping Amazon Web Services IAM accounts to database accounts is managed by the DB cluster.
For more information about IAM database authentication, see IAM Database Authentication for MySQL and PostgreSQL in the Amazon RDS User Guide.
This setting doesn't apply to RDS Custom.
public Boolean getEnableIAMDatabaseAuthentication()
A value that indicates whether to enable mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts. By default, mapping isn't enabled.
This setting doesn't apply to Amazon Aurora. Mapping Amazon Web Services IAM accounts to database accounts is managed by the DB cluster.
For more information about IAM database authentication, see IAM Database Authentication for MySQL and PostgreSQL in the Amazon RDS User Guide.
This setting doesn't apply to RDS Custom.
This setting doesn't apply to Amazon Aurora. Mapping Amazon Web Services IAM accounts to database accounts is managed by the DB cluster.
For more information about IAM database authentication, see IAM Database Authentication for MySQL and PostgreSQL in the Amazon RDS User Guide.
This setting doesn't apply to RDS Custom.
public ModifyDBInstanceRequest withEnableIAMDatabaseAuthentication(Boolean enableIAMDatabaseAuthentication)
A value that indicates whether to enable mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts. By default, mapping isn't enabled.
This setting doesn't apply to Amazon Aurora. Mapping Amazon Web Services IAM accounts to database accounts is managed by the DB cluster.
For more information about IAM database authentication, see IAM Database Authentication for MySQL and PostgreSQL in the Amazon RDS User Guide.
This setting doesn't apply to RDS Custom.
enableIAMDatabaseAuthentication
- A value that indicates whether to enable mapping of Amazon Web Services Identity and Access Management
(IAM) accounts to database accounts. By default, mapping isn't enabled.
This setting doesn't apply to Amazon Aurora. Mapping Amazon Web Services IAM accounts to database accounts is managed by the DB cluster.
For more information about IAM database authentication, see IAM Database Authentication for MySQL and PostgreSQL in the Amazon RDS User Guide.
This setting doesn't apply to RDS Custom.
public Boolean isEnableIAMDatabaseAuthentication()
A value that indicates whether to enable mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts. By default, mapping isn't enabled.
This setting doesn't apply to Amazon Aurora. Mapping Amazon Web Services IAM accounts to database accounts is managed by the DB cluster.
For more information about IAM database authentication, see IAM Database Authentication for MySQL and PostgreSQL in the Amazon RDS User Guide.
This setting doesn't apply to RDS Custom.
This setting doesn't apply to Amazon Aurora. Mapping Amazon Web Services IAM accounts to database accounts is managed by the DB cluster.
For more information about IAM database authentication, see IAM Database Authentication for MySQL and PostgreSQL in the Amazon RDS User Guide.
This setting doesn't apply to RDS Custom.
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 RDS User Guide.
This setting doesn't apply to RDS Custom.
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 RDS User Guide.
This setting doesn't apply to RDS Custom.
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 RDS User Guide.
This setting doesn't apply to RDS Custom.
For more information, see Using Amazon Performance Insights in the Amazon RDS User Guide.
This setting doesn't apply to RDS Custom.
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 RDS User Guide.
This setting doesn't apply to RDS Custom.
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 RDS User Guide.
This setting doesn't apply to RDS Custom.
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 RDS User Guide.
This setting doesn't apply to RDS Custom.
For more information, see Using Amazon Performance Insights in the Amazon RDS User Guide.
This setting doesn't apply to RDS Custom.
public void setPerformanceInsightsKMSKeyId(String performanceInsightsKMSKeyId)
The Amazon Web Services KMS key identifier for encryption of Performance Insights data.
The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.
If you do not specify a value for PerformanceInsightsKMSKeyId
, then Amazon RDS uses your default KMS
key. There is a default KMS key for your Amazon Web Services account. Your Amazon Web Services account has a
different default KMS key for each Amazon Web Services Region.
This setting doesn't apply to RDS Custom.
performanceInsightsKMSKeyId
- The Amazon Web Services KMS key identifier for encryption of Performance Insights data.
The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.
If you do not specify a value for PerformanceInsightsKMSKeyId
, then Amazon RDS uses your
default KMS key. There is a default KMS key for your Amazon Web Services account. Your Amazon Web Services
account has a different default KMS key for each Amazon Web Services Region.
This setting doesn't apply to RDS Custom.
public String getPerformanceInsightsKMSKeyId()
The Amazon Web Services KMS key identifier for encryption of Performance Insights data.
The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.
If you do not specify a value for PerformanceInsightsKMSKeyId
, then Amazon RDS uses your default KMS
key. There is a default KMS key for your Amazon Web Services account. Your Amazon Web Services account has a
different default KMS key for each Amazon Web Services Region.
This setting doesn't apply to RDS Custom.
The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.
If you do not specify a value for PerformanceInsightsKMSKeyId
, then Amazon RDS uses your
default KMS key. There is a default KMS key for your Amazon Web Services account. Your Amazon Web
Services account has a different default KMS key for each Amazon Web Services Region.
This setting doesn't apply to RDS Custom.
public ModifyDBInstanceRequest withPerformanceInsightsKMSKeyId(String performanceInsightsKMSKeyId)
The Amazon Web Services KMS key identifier for encryption of Performance Insights data.
The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.
If you do not specify a value for PerformanceInsightsKMSKeyId
, then Amazon RDS uses your default KMS
key. There is a default KMS key for your Amazon Web Services account. Your Amazon Web Services account has a
different default KMS key for each Amazon Web Services Region.
This setting doesn't apply to RDS Custom.
performanceInsightsKMSKeyId
- The Amazon Web Services KMS key identifier for encryption of Performance Insights data.
The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.
If you do not specify a value for PerformanceInsightsKMSKeyId
, then Amazon RDS uses your
default KMS key. There is a default KMS key for your Amazon Web Services account. Your Amazon Web Services
account has a different default KMS key for each Amazon Web Services Region.
This setting doesn't apply to RDS Custom.
public void setPerformanceInsightsRetentionPeriod(Integer performanceInsightsRetentionPeriod)
The number of days to retain Performance Insights data. The default is 7 days. The following values are valid:
7
month * 31, where month is a number of months from 1-23
731
For example, the following values are valid:
93 (3 months * 31)
341 (11 months * 31)
589 (19 months * 31)
731
If you specify a retention period such as 94, which isn't a valid value, RDS issues an error.
This setting doesn't apply to RDS Custom.
performanceInsightsRetentionPeriod
- The number of days to retain Performance Insights data. The default is 7 days. The following values are
valid:
7
month * 31, where month is a number of months from 1-23
731
For example, the following values are valid:
93 (3 months * 31)
341 (11 months * 31)
589 (19 months * 31)
731
If you specify a retention period such as 94, which isn't a valid value, RDS issues an error.
This setting doesn't apply to RDS Custom.
public Integer getPerformanceInsightsRetentionPeriod()
The number of days to retain Performance Insights data. The default is 7 days. The following values are valid:
7
month * 31, where month is a number of months from 1-23
731
For example, the following values are valid:
93 (3 months * 31)
341 (11 months * 31)
589 (19 months * 31)
731
If you specify a retention period such as 94, which isn't a valid value, RDS issues an error.
This setting doesn't apply to RDS Custom.
7
month * 31, where month is a number of months from 1-23
731
For example, the following values are valid:
93 (3 months * 31)
341 (11 months * 31)
589 (19 months * 31)
731
If you specify a retention period such as 94, which isn't a valid value, RDS issues an error.
This setting doesn't apply to RDS Custom.
public ModifyDBInstanceRequest withPerformanceInsightsRetentionPeriod(Integer performanceInsightsRetentionPeriod)
The number of days to retain Performance Insights data. The default is 7 days. The following values are valid:
7
month * 31, where month is a number of months from 1-23
731
For example, the following values are valid:
93 (3 months * 31)
341 (11 months * 31)
589 (19 months * 31)
731
If you specify a retention period such as 94, which isn't a valid value, RDS issues an error.
This setting doesn't apply to RDS Custom.
performanceInsightsRetentionPeriod
- The number of days to retain Performance Insights data. The default is 7 days. The following values are
valid:
7
month * 31, where month is a number of months from 1-23
731
For example, the following values are valid:
93 (3 months * 31)
341 (11 months * 31)
589 (19 months * 31)
731
If you specify a retention period such as 94, which isn't a valid value, RDS issues an error.
This setting doesn't apply to RDS Custom.
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.
This setting doesn't apply to RDS Custom.
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.
This setting doesn't apply to RDS Custom.
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.
This setting doesn't apply to RDS Custom.
A change to the CloudwatchLogsExportConfiguration
parameter is always applied to the DB
instance immediately. Therefore, the ApplyImmediately
parameter has no effect.
This setting doesn't apply to RDS Custom.
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.
This setting doesn't apply to RDS Custom.
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.
This setting doesn't apply to RDS Custom.
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.
This setting doesn't apply to RDS Custom.
This setting doesn't apply to RDS Custom.
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.
This setting doesn't apply to RDS Custom.
processorFeatures
- The number of CPU cores and the number of threads per core for the DB instance class of the DB
instance.
This setting doesn't apply to RDS Custom.
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.
This setting doesn't apply to RDS Custom.
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.
This setting doesn't apply to RDS Custom.
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.
This setting doesn't apply to RDS Custom.
processorFeatures
- The number of CPU cores and the number of threads per core for the DB instance class of the DB
instance.
This setting doesn't apply to RDS Custom.
public void setUseDefaultProcessorFeatures(Boolean useDefaultProcessorFeatures)
A value that indicates whether the DB instance class of the DB instance uses its default processor features.
This setting doesn't apply to RDS Custom.
useDefaultProcessorFeatures
- A value that indicates whether the DB instance class of the DB instance uses its default processor
features.
This setting doesn't apply to RDS Custom.
public Boolean getUseDefaultProcessorFeatures()
A value that indicates whether the DB instance class of the DB instance uses its default processor features.
This setting doesn't apply to RDS Custom.
This setting doesn't apply to RDS Custom.
public ModifyDBInstanceRequest withUseDefaultProcessorFeatures(Boolean useDefaultProcessorFeatures)
A value that indicates whether the DB instance class of the DB instance uses its default processor features.
This setting doesn't apply to RDS Custom.
useDefaultProcessorFeatures
- A value that indicates whether the DB instance class of the DB instance uses its default processor
features.
This setting doesn't apply to RDS Custom.
public Boolean isUseDefaultProcessorFeatures()
A value that indicates whether the DB instance class of the DB instance uses its default processor features.
This setting doesn't apply to RDS Custom.
This setting doesn't apply to RDS Custom.
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 isn't enabled. 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 isn't enabled. 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 isn't enabled. 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 isn't enabled. 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 isn't enabled. 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 isn't enabled. For more information, see Deleting a DB Instance.
public void setMaxAllocatedStorage(Integer maxAllocatedStorage)
The upper limit in gibibytes (GiB) to which Amazon RDS can automatically scale the storage of the DB instance.
For more information about this setting, including limitations that apply to it, see Managing capacity automatically with Amazon RDS storage autoscaling in the Amazon RDS User Guide.
This setting doesn't apply to RDS Custom.
maxAllocatedStorage
- The upper limit in gibibytes (GiB) to which Amazon RDS can automatically scale the storage of the DB
instance.
For more information about this setting, including limitations that apply to it, see Managing capacity automatically with Amazon RDS storage autoscaling in the Amazon RDS User Guide.
This setting doesn't apply to RDS Custom.
public Integer getMaxAllocatedStorage()
The upper limit in gibibytes (GiB) to which Amazon RDS can automatically scale the storage of the DB instance.
For more information about this setting, including limitations that apply to it, see Managing capacity automatically with Amazon RDS storage autoscaling in the Amazon RDS User Guide.
This setting doesn't apply to RDS Custom.
For more information about this setting, including limitations that apply to it, see Managing capacity automatically with Amazon RDS storage autoscaling in the Amazon RDS User Guide.
This setting doesn't apply to RDS Custom.
public ModifyDBInstanceRequest withMaxAllocatedStorage(Integer maxAllocatedStorage)
The upper limit in gibibytes (GiB) to which Amazon RDS can automatically scale the storage of the DB instance.
For more information about this setting, including limitations that apply to it, see Managing capacity automatically with Amazon RDS storage autoscaling in the Amazon RDS User Guide.
This setting doesn't apply to RDS Custom.
maxAllocatedStorage
- The upper limit in gibibytes (GiB) to which Amazon RDS can automatically scale the storage of the DB
instance.
For more information about this setting, including limitations that apply to it, see Managing capacity automatically with Amazon RDS storage autoscaling in the Amazon RDS User Guide.
This setting doesn't apply to RDS Custom.
public void setCertificateRotationRestart(Boolean certificateRotationRestart)
A value that indicates whether the DB instance is restarted when you rotate your SSL/TLS certificate.
By default, the DB instance is restarted when you rotate your SSL/TLS certificate. The certificate is not updated until the DB instance is restarted.
Set this parameter only if you are not using SSL/TLS to connect to the DB instance.
If you are using SSL/TLS to connect to the DB instance, follow the appropriate instructions for your DB engine to rotate your SSL/TLS certificate:
For more information about rotating your SSL/TLS certificate for RDS DB engines, see Rotating Your SSL/TLS Certificate. in the Amazon RDS User Guide.
For more information about rotating your SSL/TLS certificate for Aurora DB engines, see Rotating Your SSL/TLS Certificate in the Amazon Aurora User Guide.
This setting doesn't apply to RDS Custom.
certificateRotationRestart
- A value that indicates whether the DB instance is restarted when you rotate your SSL/TLS certificate.
By default, the DB instance is restarted when you rotate your SSL/TLS certificate. The certificate is not updated until the DB instance is restarted.
Set this parameter only if you are not using SSL/TLS to connect to the DB instance.
If you are using SSL/TLS to connect to the DB instance, follow the appropriate instructions for your DB engine to rotate your SSL/TLS certificate:
For more information about rotating your SSL/TLS certificate for RDS DB engines, see Rotating Your SSL/TLS Certificate. in the Amazon RDS User Guide.
For more information about rotating your SSL/TLS certificate for Aurora DB engines, see Rotating Your SSL/TLS Certificate in the Amazon Aurora User Guide.
This setting doesn't apply to RDS Custom.
public Boolean getCertificateRotationRestart()
A value that indicates whether the DB instance is restarted when you rotate your SSL/TLS certificate.
By default, the DB instance is restarted when you rotate your SSL/TLS certificate. The certificate is not updated until the DB instance is restarted.
Set this parameter only if you are not using SSL/TLS to connect to the DB instance.
If you are using SSL/TLS to connect to the DB instance, follow the appropriate instructions for your DB engine to rotate your SSL/TLS certificate:
For more information about rotating your SSL/TLS certificate for RDS DB engines, see Rotating Your SSL/TLS Certificate. in the Amazon RDS User Guide.
For more information about rotating your SSL/TLS certificate for Aurora DB engines, see Rotating Your SSL/TLS Certificate in the Amazon Aurora User Guide.
This setting doesn't apply to RDS Custom.
By default, the DB instance is restarted when you rotate your SSL/TLS certificate. The certificate is not updated until the DB instance is restarted.
Set this parameter only if you are not using SSL/TLS to connect to the DB instance.
If you are using SSL/TLS to connect to the DB instance, follow the appropriate instructions for your DB engine to rotate your SSL/TLS certificate:
For more information about rotating your SSL/TLS certificate for RDS DB engines, see Rotating Your SSL/TLS Certificate. in the Amazon RDS User Guide.
For more information about rotating your SSL/TLS certificate for Aurora DB engines, see Rotating Your SSL/TLS Certificate in the Amazon Aurora User Guide.
This setting doesn't apply to RDS Custom.
public ModifyDBInstanceRequest withCertificateRotationRestart(Boolean certificateRotationRestart)
A value that indicates whether the DB instance is restarted when you rotate your SSL/TLS certificate.
By default, the DB instance is restarted when you rotate your SSL/TLS certificate. The certificate is not updated until the DB instance is restarted.
Set this parameter only if you are not using SSL/TLS to connect to the DB instance.
If you are using SSL/TLS to connect to the DB instance, follow the appropriate instructions for your DB engine to rotate your SSL/TLS certificate:
For more information about rotating your SSL/TLS certificate for RDS DB engines, see Rotating Your SSL/TLS Certificate. in the Amazon RDS User Guide.
For more information about rotating your SSL/TLS certificate for Aurora DB engines, see Rotating Your SSL/TLS Certificate in the Amazon Aurora User Guide.
This setting doesn't apply to RDS Custom.
certificateRotationRestart
- A value that indicates whether the DB instance is restarted when you rotate your SSL/TLS certificate.
By default, the DB instance is restarted when you rotate your SSL/TLS certificate. The certificate is not updated until the DB instance is restarted.
Set this parameter only if you are not using SSL/TLS to connect to the DB instance.
If you are using SSL/TLS to connect to the DB instance, follow the appropriate instructions for your DB engine to rotate your SSL/TLS certificate:
For more information about rotating your SSL/TLS certificate for RDS DB engines, see Rotating Your SSL/TLS Certificate. in the Amazon RDS User Guide.
For more information about rotating your SSL/TLS certificate for Aurora DB engines, see Rotating Your SSL/TLS Certificate in the Amazon Aurora User Guide.
This setting doesn't apply to RDS Custom.
public Boolean isCertificateRotationRestart()
A value that indicates whether the DB instance is restarted when you rotate your SSL/TLS certificate.
By default, the DB instance is restarted when you rotate your SSL/TLS certificate. The certificate is not updated until the DB instance is restarted.
Set this parameter only if you are not using SSL/TLS to connect to the DB instance.
If you are using SSL/TLS to connect to the DB instance, follow the appropriate instructions for your DB engine to rotate your SSL/TLS certificate:
For more information about rotating your SSL/TLS certificate for RDS DB engines, see Rotating Your SSL/TLS Certificate. in the Amazon RDS User Guide.
For more information about rotating your SSL/TLS certificate for Aurora DB engines, see Rotating Your SSL/TLS Certificate in the Amazon Aurora User Guide.
This setting doesn't apply to RDS Custom.
By default, the DB instance is restarted when you rotate your SSL/TLS certificate. The certificate is not updated until the DB instance is restarted.
Set this parameter only if you are not using SSL/TLS to connect to the DB instance.
If you are using SSL/TLS to connect to the DB instance, follow the appropriate instructions for your DB engine to rotate your SSL/TLS certificate:
For more information about rotating your SSL/TLS certificate for RDS DB engines, see Rotating Your SSL/TLS Certificate. in the Amazon RDS User Guide.
For more information about rotating your SSL/TLS certificate for Aurora DB engines, see Rotating Your SSL/TLS Certificate in the Amazon Aurora User Guide.
This setting doesn't apply to RDS Custom.
public void setReplicaMode(String replicaMode)
A value that sets the open mode of a replica database to either mounted or read-only.
Currently, this parameter is only supported for Oracle DB instances.
Mounted DB replicas are included in Oracle Enterprise Edition. The main use case for mounted replicas is cross-Region disaster recovery. The primary database doesn't use Active Data Guard to transmit information to the mounted replica. Because it doesn't accept user connections, a mounted replica can't serve a read-only workload. For more information, see Working with Oracle Read Replicas for Amazon RDS in the Amazon RDS User Guide.
This setting doesn't apply to RDS Custom.
replicaMode
- A value that sets the open mode of a replica database to either mounted or read-only. Currently, this parameter is only supported for Oracle DB instances.
Mounted DB replicas are included in Oracle Enterprise Edition. The main use case for mounted replicas is cross-Region disaster recovery. The primary database doesn't use Active Data Guard to transmit information to the mounted replica. Because it doesn't accept user connections, a mounted replica can't serve a read-only workload. For more information, see Working with Oracle Read Replicas for Amazon RDS in the Amazon RDS User Guide.
This setting doesn't apply to RDS Custom.
ReplicaMode
public String getReplicaMode()
A value that sets the open mode of a replica database to either mounted or read-only.
Currently, this parameter is only supported for Oracle DB instances.
Mounted DB replicas are included in Oracle Enterprise Edition. The main use case for mounted replicas is cross-Region disaster recovery. The primary database doesn't use Active Data Guard to transmit information to the mounted replica. Because it doesn't accept user connections, a mounted replica can't serve a read-only workload. For more information, see Working with Oracle Read Replicas for Amazon RDS in the Amazon RDS User Guide.
This setting doesn't apply to RDS Custom.
Currently, this parameter is only supported for Oracle DB instances.
Mounted DB replicas are included in Oracle Enterprise Edition. The main use case for mounted replicas is cross-Region disaster recovery. The primary database doesn't use Active Data Guard to transmit information to the mounted replica. Because it doesn't accept user connections, a mounted replica can't serve a read-only workload. For more information, see Working with Oracle Read Replicas for Amazon RDS in the Amazon RDS User Guide.
This setting doesn't apply to RDS Custom.
ReplicaMode
public ModifyDBInstanceRequest withReplicaMode(String replicaMode)
A value that sets the open mode of a replica database to either mounted or read-only.
Currently, this parameter is only supported for Oracle DB instances.
Mounted DB replicas are included in Oracle Enterprise Edition. The main use case for mounted replicas is cross-Region disaster recovery. The primary database doesn't use Active Data Guard to transmit information to the mounted replica. Because it doesn't accept user connections, a mounted replica can't serve a read-only workload. For more information, see Working with Oracle Read Replicas for Amazon RDS in the Amazon RDS User Guide.
This setting doesn't apply to RDS Custom.
replicaMode
- A value that sets the open mode of a replica database to either mounted or read-only. Currently, this parameter is only supported for Oracle DB instances.
Mounted DB replicas are included in Oracle Enterprise Edition. The main use case for mounted replicas is cross-Region disaster recovery. The primary database doesn't use Active Data Guard to transmit information to the mounted replica. Because it doesn't accept user connections, a mounted replica can't serve a read-only workload. For more information, see Working with Oracle Read Replicas for Amazon RDS in the Amazon RDS User Guide.
This setting doesn't apply to RDS Custom.
ReplicaMode
public ModifyDBInstanceRequest withReplicaMode(ReplicaMode replicaMode)
A value that sets the open mode of a replica database to either mounted or read-only.
Currently, this parameter is only supported for Oracle DB instances.
Mounted DB replicas are included in Oracle Enterprise Edition. The main use case for mounted replicas is cross-Region disaster recovery. The primary database doesn't use Active Data Guard to transmit information to the mounted replica. Because it doesn't accept user connections, a mounted replica can't serve a read-only workload. For more information, see Working with Oracle Read Replicas for Amazon RDS in the Amazon RDS User Guide.
This setting doesn't apply to RDS Custom.
replicaMode
- A value that sets the open mode of a replica database to either mounted or read-only. Currently, this parameter is only supported for Oracle DB instances.
Mounted DB replicas are included in Oracle Enterprise Edition. The main use case for mounted replicas is cross-Region disaster recovery. The primary database doesn't use Active Data Guard to transmit information to the mounted replica. Because it doesn't accept user connections, a mounted replica can't serve a read-only workload. For more information, see Working with Oracle Read Replicas for Amazon RDS in the Amazon RDS User Guide.
This setting doesn't apply to RDS Custom.
ReplicaMode
public void setEnableCustomerOwnedIp(Boolean enableCustomerOwnedIp)
A value that indicates whether to enable a customer-owned IP address (CoIP) for an RDS on Outposts DB instance.
A CoIP provides local or external connectivity to resources in your Outpost subnets through your on-premises network. For some use cases, a CoIP can provide lower latency for connections to the DB instance from outside of its virtual private cloud (VPC) on your local network.
For more information about RDS on Outposts, see Working with Amazon RDS on Amazon Web Services Outposts in the Amazon RDS User Guide.
For more information about CoIPs, see Customer-owned IP addresses in the Amazon Web Services Outposts User Guide.
enableCustomerOwnedIp
- A value that indicates whether to enable a customer-owned IP address (CoIP) for an RDS on Outposts DB
instance.
A CoIP provides local or external connectivity to resources in your Outpost subnets through your on-premises network. For some use cases, a CoIP can provide lower latency for connections to the DB instance from outside of its virtual private cloud (VPC) on your local network.
For more information about RDS on Outposts, see Working with Amazon RDS on Amazon Web Services Outposts in the Amazon RDS User Guide.
For more information about CoIPs, see Customer-owned IP addresses in the Amazon Web Services Outposts User Guide.
public Boolean getEnableCustomerOwnedIp()
A value that indicates whether to enable a customer-owned IP address (CoIP) for an RDS on Outposts DB instance.
A CoIP provides local or external connectivity to resources in your Outpost subnets through your on-premises network. For some use cases, a CoIP can provide lower latency for connections to the DB instance from outside of its virtual private cloud (VPC) on your local network.
For more information about RDS on Outposts, see Working with Amazon RDS on Amazon Web Services Outposts in the Amazon RDS User Guide.
For more information about CoIPs, see Customer-owned IP addresses in the Amazon Web Services Outposts User Guide.
A CoIP provides local or external connectivity to resources in your Outpost subnets through your on-premises network. For some use cases, a CoIP can provide lower latency for connections to the DB instance from outside of its virtual private cloud (VPC) on your local network.
For more information about RDS on Outposts, see Working with Amazon RDS on Amazon Web Services Outposts in the Amazon RDS User Guide.
For more information about CoIPs, see Customer-owned IP addresses in the Amazon Web Services Outposts User Guide.
public ModifyDBInstanceRequest withEnableCustomerOwnedIp(Boolean enableCustomerOwnedIp)
A value that indicates whether to enable a customer-owned IP address (CoIP) for an RDS on Outposts DB instance.
A CoIP provides local or external connectivity to resources in your Outpost subnets through your on-premises network. For some use cases, a CoIP can provide lower latency for connections to the DB instance from outside of its virtual private cloud (VPC) on your local network.
For more information about RDS on Outposts, see Working with Amazon RDS on Amazon Web Services Outposts in the Amazon RDS User Guide.
For more information about CoIPs, see Customer-owned IP addresses in the Amazon Web Services Outposts User Guide.
enableCustomerOwnedIp
- A value that indicates whether to enable a customer-owned IP address (CoIP) for an RDS on Outposts DB
instance.
A CoIP provides local or external connectivity to resources in your Outpost subnets through your on-premises network. For some use cases, a CoIP can provide lower latency for connections to the DB instance from outside of its virtual private cloud (VPC) on your local network.
For more information about RDS on Outposts, see Working with Amazon RDS on Amazon Web Services Outposts in the Amazon RDS User Guide.
For more information about CoIPs, see Customer-owned IP addresses in the Amazon Web Services Outposts User Guide.
public Boolean isEnableCustomerOwnedIp()
A value that indicates whether to enable a customer-owned IP address (CoIP) for an RDS on Outposts DB instance.
A CoIP provides local or external connectivity to resources in your Outpost subnets through your on-premises network. For some use cases, a CoIP can provide lower latency for connections to the DB instance from outside of its virtual private cloud (VPC) on your local network.
For more information about RDS on Outposts, see Working with Amazon RDS on Amazon Web Services Outposts in the Amazon RDS User Guide.
For more information about CoIPs, see Customer-owned IP addresses in the Amazon Web Services Outposts User Guide.
A CoIP provides local or external connectivity to resources in your Outpost subnets through your on-premises network. For some use cases, a CoIP can provide lower latency for connections to the DB instance from outside of its virtual private cloud (VPC) on your local network.
For more information about RDS on Outposts, see Working with Amazon RDS on Amazon Web Services Outposts in the Amazon RDS User Guide.
For more information about CoIPs, see Customer-owned IP addresses in the Amazon Web Services Outposts User Guide.
public void setAwsBackupRecoveryPointArn(String awsBackupRecoveryPointArn)
The Amazon Resource Name (ARN) of the recovery point in Amazon Web Services Backup.
This setting doesn't apply to RDS Custom.
awsBackupRecoveryPointArn
- The Amazon Resource Name (ARN) of the recovery point in Amazon Web Services Backup.
This setting doesn't apply to RDS Custom.
public String getAwsBackupRecoveryPointArn()
The Amazon Resource Name (ARN) of the recovery point in Amazon Web Services Backup.
This setting doesn't apply to RDS Custom.
This setting doesn't apply to RDS Custom.
public ModifyDBInstanceRequest withAwsBackupRecoveryPointArn(String awsBackupRecoveryPointArn)
The Amazon Resource Name (ARN) of the recovery point in Amazon Web Services Backup.
This setting doesn't apply to RDS Custom.
awsBackupRecoveryPointArn
- The Amazon Resource Name (ARN) of the recovery point in Amazon Web Services Backup.
This setting doesn't apply to RDS Custom.
public void setAutomationMode(String automationMode)
The automation mode of the RDS Custom DB instance: full
or all paused
. If
full
, the DB instance automates monitoring and instance recovery. If all paused
, the
instance pauses automation for the duration set by ResumeFullAutomationModeMinutes
.
automationMode
- The automation mode of the RDS Custom DB instance: full
or all paused
. If
full
, the DB instance automates monitoring and instance recovery. If all paused
,
the instance pauses automation for the duration set by ResumeFullAutomationModeMinutes
.AutomationMode
public String getAutomationMode()
The automation mode of the RDS Custom DB instance: full
or all paused
. If
full
, the DB instance automates monitoring and instance recovery. If all paused
, the
instance pauses automation for the duration set by ResumeFullAutomationModeMinutes
.
full
or all paused
. If
full
, the DB instance automates monitoring and instance recovery. If all paused
, the instance pauses automation for the duration set by ResumeFullAutomationModeMinutes
.AutomationMode
public ModifyDBInstanceRequest withAutomationMode(String automationMode)
The automation mode of the RDS Custom DB instance: full
or all paused
. If
full
, the DB instance automates monitoring and instance recovery. If all paused
, the
instance pauses automation for the duration set by ResumeFullAutomationModeMinutes
.
automationMode
- The automation mode of the RDS Custom DB instance: full
or all paused
. If
full
, the DB instance automates monitoring and instance recovery. If all paused
,
the instance pauses automation for the duration set by ResumeFullAutomationModeMinutes
.AutomationMode
public ModifyDBInstanceRequest withAutomationMode(AutomationMode automationMode)
The automation mode of the RDS Custom DB instance: full
or all paused
. If
full
, the DB instance automates monitoring and instance recovery. If all paused
, the
instance pauses automation for the duration set by ResumeFullAutomationModeMinutes
.
automationMode
- The automation mode of the RDS Custom DB instance: full
or all paused
. If
full
, the DB instance automates monitoring and instance recovery. If all paused
,
the instance pauses automation for the duration set by ResumeFullAutomationModeMinutes
.AutomationMode
public void setResumeFullAutomationModeMinutes(Integer resumeFullAutomationModeMinutes)
The number of minutes to pause the automation. When the time period ends, RDS Custom resumes full automation. The
minimum value is 60
(default). The maximum value is 1,440
.
resumeFullAutomationModeMinutes
- The number of minutes to pause the automation. When the time period ends, RDS Custom resumes full
automation. The minimum value is 60
(default). The maximum value is 1,440
.public Integer getResumeFullAutomationModeMinutes()
The number of minutes to pause the automation. When the time period ends, RDS Custom resumes full automation. The
minimum value is 60
(default). The maximum value is 1,440
.
60
(default). The maximum value is 1,440
.public ModifyDBInstanceRequest withResumeFullAutomationModeMinutes(Integer resumeFullAutomationModeMinutes)
The number of minutes to pause the automation. When the time period ends, RDS Custom resumes full automation. The
minimum value is 60
(default). The maximum value is 1,440
.
resumeFullAutomationModeMinutes
- The number of minutes to pause the automation. When the time period ends, RDS Custom resumes full
automation. The minimum value is 60
(default). The maximum value is 1,440
.public void setNetworkType(String networkType)
The network type of the DB instance.
Valid values:
IPV4
DUAL
The network type is determined by the DBSubnetGroup
specified for the DB instance. A
DBSubnetGroup
can support only the IPv4 protocol or the IPv4 and the IPv6 protocols (
DUAL
).
For more information, see Working with a DB instance in a VPC in the Amazon RDS User Guide.
networkType
- The network type of the DB instance.
Valid values:
IPV4
DUAL
The network type is determined by the DBSubnetGroup
specified for the DB instance. A
DBSubnetGroup
can support only the IPv4 protocol or the IPv4 and the IPv6 protocols (
DUAL
).
For more information, see Working with a DB instance in a VPC in the Amazon RDS User Guide.
public String getNetworkType()
The network type of the DB instance.
Valid values:
IPV4
DUAL
The network type is determined by the DBSubnetGroup
specified for the DB instance. A
DBSubnetGroup
can support only the IPv4 protocol or the IPv4 and the IPv6 protocols (
DUAL
).
For more information, see Working with a DB instance in a VPC in the Amazon RDS User Guide.
Valid values:
IPV4
DUAL
The network type is determined by the DBSubnetGroup
specified for the DB instance. A
DBSubnetGroup
can support only the IPv4 protocol or the IPv4 and the IPv6 protocols (
DUAL
).
For more information, see Working with a DB instance in a VPC in the Amazon RDS User Guide.
public ModifyDBInstanceRequest withNetworkType(String networkType)
The network type of the DB instance.
Valid values:
IPV4
DUAL
The network type is determined by the DBSubnetGroup
specified for the DB instance. A
DBSubnetGroup
can support only the IPv4 protocol or the IPv4 and the IPv6 protocols (
DUAL
).
For more information, see Working with a DB instance in a VPC in the Amazon RDS User Guide.
networkType
- The network type of the DB instance.
Valid values:
IPV4
DUAL
The network type is determined by the DBSubnetGroup
specified for the DB instance. A
DBSubnetGroup
can support only the IPv4 protocol or the IPv4 and the IPv6 protocols (
DUAL
).
For more information, see Working with a DB instance in a VPC in the Amazon RDS User Guide.
public void setStorageThroughput(Integer storageThroughput)
Specifies the storage throughput value for the DB instance.
This setting applies only to the gp3
storage type.
This setting doesn't apply to RDS Custom or Amazon Aurora.
storageThroughput
- Specifies the storage throughput value for the DB instance.
This setting applies only to the gp3
storage type.
This setting doesn't apply to RDS Custom or Amazon Aurora.
public Integer getStorageThroughput()
Specifies the storage throughput value for the DB instance.
This setting applies only to the gp3
storage type.
This setting doesn't apply to RDS Custom or Amazon Aurora.
This setting applies only to the gp3
storage type.
This setting doesn't apply to RDS Custom or Amazon Aurora.
public ModifyDBInstanceRequest withStorageThroughput(Integer storageThroughput)
Specifies the storage throughput value for the DB instance.
This setting applies only to the gp3
storage type.
This setting doesn't apply to RDS Custom or Amazon Aurora.
storageThroughput
- Specifies the storage throughput value for the DB instance.
This setting applies only to the gp3
storage type.
This setting doesn't apply to RDS Custom or Amazon Aurora.
public void setManageMasterUserPassword(Boolean manageMasterUserPassword)
A value that indicates whether to manage the master user password with Amazon Web Services Secrets Manager.
If the DB instance doesn't manage the master user password with Amazon Web Services Secrets Manager, you can turn
on this management. In this case, you can't specify MasterUserPassword
.
If the DB instance already manages the master user password with Amazon Web Services Secrets Manager, and you
specify that the master user password is not managed with Amazon Web Services Secrets Manager, then you must
specify MasterUserPassword
. In this case, RDS deletes the secret and uses the new password for the
master user specified by MasterUserPassword
.
For more information, see Password management with Amazon Web Services Secrets Manager in the Amazon RDS User Guide.
Constraints:
Can't manage the master user password with Amazon Web Services Secrets Manager if MasterUserPassword
is specified.
manageMasterUserPassword
- A value that indicates whether to manage the master user password with Amazon Web Services Secrets
Manager.
If the DB instance doesn't manage the master user password with Amazon Web Services Secrets Manager, you
can turn on this management. In this case, you can't specify MasterUserPassword
.
If the DB instance already manages the master user password with Amazon Web Services Secrets Manager, and
you specify that the master user password is not managed with Amazon Web Services Secrets Manager, then
you must specify MasterUserPassword
. In this case, RDS deletes the secret and uses the new
password for the master user specified by MasterUserPassword
.
For more information, see Password management with Amazon Web Services Secrets Manager in the Amazon RDS User Guide.
Constraints:
Can't manage the master user password with Amazon Web Services Secrets Manager if
MasterUserPassword
is specified.
public Boolean getManageMasterUserPassword()
A value that indicates whether to manage the master user password with Amazon Web Services Secrets Manager.
If the DB instance doesn't manage the master user password with Amazon Web Services Secrets Manager, you can turn
on this management. In this case, you can't specify MasterUserPassword
.
If the DB instance already manages the master user password with Amazon Web Services Secrets Manager, and you
specify that the master user password is not managed with Amazon Web Services Secrets Manager, then you must
specify MasterUserPassword
. In this case, RDS deletes the secret and uses the new password for the
master user specified by MasterUserPassword
.
For more information, see Password management with Amazon Web Services Secrets Manager in the Amazon RDS User Guide.
Constraints:
Can't manage the master user password with Amazon Web Services Secrets Manager if MasterUserPassword
is specified.
If the DB instance doesn't manage the master user password with Amazon Web Services Secrets Manager, you
can turn on this management. In this case, you can't specify MasterUserPassword
.
If the DB instance already manages the master user password with Amazon Web Services Secrets Manager, and
you specify that the master user password is not managed with Amazon Web Services Secrets Manager, then
you must specify MasterUserPassword
. In this case, RDS deletes the secret and uses the new
password for the master user specified by MasterUserPassword
.
For more information, see Password management with Amazon Web Services Secrets Manager in the Amazon RDS User Guide.
Constraints:
Can't manage the master user password with Amazon Web Services Secrets Manager if
MasterUserPassword
is specified.
public ModifyDBInstanceRequest withManageMasterUserPassword(Boolean manageMasterUserPassword)
A value that indicates whether to manage the master user password with Amazon Web Services Secrets Manager.
If the DB instance doesn't manage the master user password with Amazon Web Services Secrets Manager, you can turn
on this management. In this case, you can't specify MasterUserPassword
.
If the DB instance already manages the master user password with Amazon Web Services Secrets Manager, and you
specify that the master user password is not managed with Amazon Web Services Secrets Manager, then you must
specify MasterUserPassword
. In this case, RDS deletes the secret and uses the new password for the
master user specified by MasterUserPassword
.
For more information, see Password management with Amazon Web Services Secrets Manager in the Amazon RDS User Guide.
Constraints:
Can't manage the master user password with Amazon Web Services Secrets Manager if MasterUserPassword
is specified.
manageMasterUserPassword
- A value that indicates whether to manage the master user password with Amazon Web Services Secrets
Manager.
If the DB instance doesn't manage the master user password with Amazon Web Services Secrets Manager, you
can turn on this management. In this case, you can't specify MasterUserPassword
.
If the DB instance already manages the master user password with Amazon Web Services Secrets Manager, and
you specify that the master user password is not managed with Amazon Web Services Secrets Manager, then
you must specify MasterUserPassword
. In this case, RDS deletes the secret and uses the new
password for the master user specified by MasterUserPassword
.
For more information, see Password management with Amazon Web Services Secrets Manager in the Amazon RDS User Guide.
Constraints:
Can't manage the master user password with Amazon Web Services Secrets Manager if
MasterUserPassword
is specified.
public Boolean isManageMasterUserPassword()
A value that indicates whether to manage the master user password with Amazon Web Services Secrets Manager.
If the DB instance doesn't manage the master user password with Amazon Web Services Secrets Manager, you can turn
on this management. In this case, you can't specify MasterUserPassword
.
If the DB instance already manages the master user password with Amazon Web Services Secrets Manager, and you
specify that the master user password is not managed with Amazon Web Services Secrets Manager, then you must
specify MasterUserPassword
. In this case, RDS deletes the secret and uses the new password for the
master user specified by MasterUserPassword
.
For more information, see Password management with Amazon Web Services Secrets Manager in the Amazon RDS User Guide.
Constraints:
Can't manage the master user password with Amazon Web Services Secrets Manager if MasterUserPassword
is specified.
If the DB instance doesn't manage the master user password with Amazon Web Services Secrets Manager, you
can turn on this management. In this case, you can't specify MasterUserPassword
.
If the DB instance already manages the master user password with Amazon Web Services Secrets Manager, and
you specify that the master user password is not managed with Amazon Web Services Secrets Manager, then
you must specify MasterUserPassword
. In this case, RDS deletes the secret and uses the new
password for the master user specified by MasterUserPassword
.
For more information, see Password management with Amazon Web Services Secrets Manager in the Amazon RDS User Guide.
Constraints:
Can't manage the master user password with Amazon Web Services Secrets Manager if
MasterUserPassword
is specified.
public void setRotateMasterUserPassword(Boolean rotateMasterUserPassword)
A value that indicates whether to rotate the secret managed by Amazon Web Services Secrets Manager for the master user password.
This setting is valid only if the master user password is managed by RDS in Amazon Web Services Secrets Manager for the DB cluster. The secret value contains the updated password.
For more information, see Password management with Amazon Web Services Secrets Manager in the Amazon RDS User Guide.
Constraints:
You must apply the change immediately when rotating the master user password.
rotateMasterUserPassword
- A value that indicates whether to rotate the secret managed by Amazon Web Services Secrets Manager for the
master user password.
This setting is valid only if the master user password is managed by RDS in Amazon Web Services Secrets Manager for the DB cluster. The secret value contains the updated password.
For more information, see Password management with Amazon Web Services Secrets Manager in the Amazon RDS User Guide.
Constraints:
You must apply the change immediately when rotating the master user password.
public Boolean getRotateMasterUserPassword()
A value that indicates whether to rotate the secret managed by Amazon Web Services Secrets Manager for the master user password.
This setting is valid only if the master user password is managed by RDS in Amazon Web Services Secrets Manager for the DB cluster. The secret value contains the updated password.
For more information, see Password management with Amazon Web Services Secrets Manager in the Amazon RDS User Guide.
Constraints:
You must apply the change immediately when rotating the master user password.
This setting is valid only if the master user password is managed by RDS in Amazon Web Services Secrets Manager for the DB cluster. The secret value contains the updated password.
For more information, see Password management with Amazon Web Services Secrets Manager in the Amazon RDS User Guide.
Constraints:
You must apply the change immediately when rotating the master user password.
public ModifyDBInstanceRequest withRotateMasterUserPassword(Boolean rotateMasterUserPassword)
A value that indicates whether to rotate the secret managed by Amazon Web Services Secrets Manager for the master user password.
This setting is valid only if the master user password is managed by RDS in Amazon Web Services Secrets Manager for the DB cluster. The secret value contains the updated password.
For more information, see Password management with Amazon Web Services Secrets Manager in the Amazon RDS User Guide.
Constraints:
You must apply the change immediately when rotating the master user password.
rotateMasterUserPassword
- A value that indicates whether to rotate the secret managed by Amazon Web Services Secrets Manager for the
master user password.
This setting is valid only if the master user password is managed by RDS in Amazon Web Services Secrets Manager for the DB cluster. The secret value contains the updated password.
For more information, see Password management with Amazon Web Services Secrets Manager in the Amazon RDS User Guide.
Constraints:
You must apply the change immediately when rotating the master user password.
public Boolean isRotateMasterUserPassword()
A value that indicates whether to rotate the secret managed by Amazon Web Services Secrets Manager for the master user password.
This setting is valid only if the master user password is managed by RDS in Amazon Web Services Secrets Manager for the DB cluster. The secret value contains the updated password.
For more information, see Password management with Amazon Web Services Secrets Manager in the Amazon RDS User Guide.
Constraints:
You must apply the change immediately when rotating the master user password.
This setting is valid only if the master user password is managed by RDS in Amazon Web Services Secrets Manager for the DB cluster. The secret value contains the updated password.
For more information, see Password management with Amazon Web Services Secrets Manager in the Amazon RDS User Guide.
Constraints:
You must apply the change immediately when rotating the master user password.
public void setMasterUserSecretKmsKeyId(String masterUserSecretKmsKeyId)
The Amazon Web Services KMS key identifier to encrypt a secret that is automatically generated and managed in Amazon Web Services Secrets Manager.
This setting is valid only if both of the following conditions are met:
The DB instance doesn't manage the master user password in Amazon Web Services Secrets Manager.
If the DB instance already manages the master user password in Amazon Web Services Secrets Manager, you can't change the KMS key used to encrypt the secret.
You are turning on ManageMasterUserPassword
to manage the master user password in Amazon Web
Services Secrets Manager.
If you are turning on ManageMasterUserPassword
and don't specify
MasterUserSecretKmsKeyId
, then the aws/secretsmanager
KMS key is used to encrypt the
secret. If the secret is in a different Amazon Web Services account, then you can't use the
aws/secretsmanager
KMS key to encrypt the secret, and you must use a customer managed KMS key.
The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key. To use a KMS key in a different Amazon Web Services account, specify the key ARN or alias ARN.
There is a default KMS key for your Amazon Web Services account. Your Amazon Web Services account has a different default KMS key for each Amazon Web Services Region.
masterUserSecretKmsKeyId
- The Amazon Web Services KMS key identifier to encrypt a secret that is automatically generated and managed
in Amazon Web Services Secrets Manager.
This setting is valid only if both of the following conditions are met:
The DB instance doesn't manage the master user password in Amazon Web Services Secrets Manager.
If the DB instance already manages the master user password in Amazon Web Services Secrets Manager, you can't change the KMS key used to encrypt the secret.
You are turning on ManageMasterUserPassword
to manage the master user password in Amazon Web
Services Secrets Manager.
If you are turning on ManageMasterUserPassword
and don't specify
MasterUserSecretKmsKeyId
, then the aws/secretsmanager
KMS key is used to encrypt
the secret. If the secret is in a different Amazon Web Services account, then you can't use the
aws/secretsmanager
KMS key to encrypt the secret, and you must use a customer managed KMS
key.
The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key. To use a KMS key in a different Amazon Web Services account, specify the key ARN or alias ARN.
There is a default KMS key for your Amazon Web Services account. Your Amazon Web Services account has a different default KMS key for each Amazon Web Services Region.
public String getMasterUserSecretKmsKeyId()
The Amazon Web Services KMS key identifier to encrypt a secret that is automatically generated and managed in Amazon Web Services Secrets Manager.
This setting is valid only if both of the following conditions are met:
The DB instance doesn't manage the master user password in Amazon Web Services Secrets Manager.
If the DB instance already manages the master user password in Amazon Web Services Secrets Manager, you can't change the KMS key used to encrypt the secret.
You are turning on ManageMasterUserPassword
to manage the master user password in Amazon Web
Services Secrets Manager.
If you are turning on ManageMasterUserPassword
and don't specify
MasterUserSecretKmsKeyId
, then the aws/secretsmanager
KMS key is used to encrypt the
secret. If the secret is in a different Amazon Web Services account, then you can't use the
aws/secretsmanager
KMS key to encrypt the secret, and you must use a customer managed KMS key.
The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key. To use a KMS key in a different Amazon Web Services account, specify the key ARN or alias ARN.
There is a default KMS key for your Amazon Web Services account. Your Amazon Web Services account has a different default KMS key for each Amazon Web Services Region.
This setting is valid only if both of the following conditions are met:
The DB instance doesn't manage the master user password in Amazon Web Services Secrets Manager.
If the DB instance already manages the master user password in Amazon Web Services Secrets Manager, you can't change the KMS key used to encrypt the secret.
You are turning on ManageMasterUserPassword
to manage the master user password in Amazon Web
Services Secrets Manager.
If you are turning on ManageMasterUserPassword
and don't specify
MasterUserSecretKmsKeyId
, then the aws/secretsmanager
KMS key is used to
encrypt the secret. If the secret is in a different Amazon Web Services account, then you can't use the
aws/secretsmanager
KMS key to encrypt the secret, and you must use a customer managed KMS
key.
The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key. To use a KMS key in a different Amazon Web Services account, specify the key ARN or alias ARN.
There is a default KMS key for your Amazon Web Services account. Your Amazon Web Services account has a different default KMS key for each Amazon Web Services Region.
public ModifyDBInstanceRequest withMasterUserSecretKmsKeyId(String masterUserSecretKmsKeyId)
The Amazon Web Services KMS key identifier to encrypt a secret that is automatically generated and managed in Amazon Web Services Secrets Manager.
This setting is valid only if both of the following conditions are met:
The DB instance doesn't manage the master user password in Amazon Web Services Secrets Manager.
If the DB instance already manages the master user password in Amazon Web Services Secrets Manager, you can't change the KMS key used to encrypt the secret.
You are turning on ManageMasterUserPassword
to manage the master user password in Amazon Web
Services Secrets Manager.
If you are turning on ManageMasterUserPassword
and don't specify
MasterUserSecretKmsKeyId
, then the aws/secretsmanager
KMS key is used to encrypt the
secret. If the secret is in a different Amazon Web Services account, then you can't use the
aws/secretsmanager
KMS key to encrypt the secret, and you must use a customer managed KMS key.
The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key. To use a KMS key in a different Amazon Web Services account, specify the key ARN or alias ARN.
There is a default KMS key for your Amazon Web Services account. Your Amazon Web Services account has a different default KMS key for each Amazon Web Services Region.
masterUserSecretKmsKeyId
- The Amazon Web Services KMS key identifier to encrypt a secret that is automatically generated and managed
in Amazon Web Services Secrets Manager.
This setting is valid only if both of the following conditions are met:
The DB instance doesn't manage the master user password in Amazon Web Services Secrets Manager.
If the DB instance already manages the master user password in Amazon Web Services Secrets Manager, you can't change the KMS key used to encrypt the secret.
You are turning on ManageMasterUserPassword
to manage the master user password in Amazon Web
Services Secrets Manager.
If you are turning on ManageMasterUserPassword
and don't specify
MasterUserSecretKmsKeyId
, then the aws/secretsmanager
KMS key is used to encrypt
the secret. If the secret is in a different Amazon Web Services account, then you can't use the
aws/secretsmanager
KMS key to encrypt the secret, and you must use a customer managed KMS
key.
The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key. To use a KMS key in a different Amazon Web Services account, specify the key ARN or alias ARN.
There is a default KMS key for your Amazon Web Services account. Your Amazon Web Services account has a different default KMS key for each Amazon Web Services Region.
public void setEngine(String engine)
The target Oracle DB engine when you convert a non-CDB to a CDB. This intermediate step is necessary to upgrade an Oracle Database 19c non-CDB to an Oracle Database 21c CDB.
Note the following requirements:
Make sure that you specify oracle-ee-cdb
or oracle-se2-cdb
.
Make sure that your DB engine runs Oracle Database 19c with an April 2021 or later RU.
Note the following limitations:
You can't convert a CDB to a non-CDB.
You can't convert a replica database.
You can't convert a non-CDB to a CDB and upgrade the engine version in the same command.
You can't convert the existing custom parameter or option group when it has options or parameters that are
permanent or persistent. In this situation, the DB instance reverts to the default option and parameter group. To
avoid reverting to the default, specify a new parameter group with --db-parameter-group-name
and a
new option group with --option-group-name
.
engine
- The target Oracle DB engine when you convert a non-CDB to a CDB. This intermediate step is necessary to
upgrade an Oracle Database 19c non-CDB to an Oracle Database 21c CDB.
Note the following requirements:
Make sure that you specify oracle-ee-cdb
or oracle-se2-cdb
.
Make sure that your DB engine runs Oracle Database 19c with an April 2021 or later RU.
Note the following limitations:
You can't convert a CDB to a non-CDB.
You can't convert a replica database.
You can't convert a non-CDB to a CDB and upgrade the engine version in the same command.
You can't convert the existing custom parameter or option group when it has options or parameters that are
permanent or persistent. In this situation, the DB instance reverts to the default option and parameter
group. To avoid reverting to the default, specify a new parameter group with
--db-parameter-group-name
and a new option group with --option-group-name
.
public String getEngine()
The target Oracle DB engine when you convert a non-CDB to a CDB. This intermediate step is necessary to upgrade an Oracle Database 19c non-CDB to an Oracle Database 21c CDB.
Note the following requirements:
Make sure that you specify oracle-ee-cdb
or oracle-se2-cdb
.
Make sure that your DB engine runs Oracle Database 19c with an April 2021 or later RU.
Note the following limitations:
You can't convert a CDB to a non-CDB.
You can't convert a replica database.
You can't convert a non-CDB to a CDB and upgrade the engine version in the same command.
You can't convert the existing custom parameter or option group when it has options or parameters that are
permanent or persistent. In this situation, the DB instance reverts to the default option and parameter group. To
avoid reverting to the default, specify a new parameter group with --db-parameter-group-name
and a
new option group with --option-group-name
.
Note the following requirements:
Make sure that you specify oracle-ee-cdb
or oracle-se2-cdb
.
Make sure that your DB engine runs Oracle Database 19c with an April 2021 or later RU.
Note the following limitations:
You can't convert a CDB to a non-CDB.
You can't convert a replica database.
You can't convert a non-CDB to a CDB and upgrade the engine version in the same command.
You can't convert the existing custom parameter or option group when it has options or parameters that
are permanent or persistent. In this situation, the DB instance reverts to the default option and
parameter group. To avoid reverting to the default, specify a new parameter group with
--db-parameter-group-name
and a new option group with --option-group-name
.
public ModifyDBInstanceRequest withEngine(String engine)
The target Oracle DB engine when you convert a non-CDB to a CDB. This intermediate step is necessary to upgrade an Oracle Database 19c non-CDB to an Oracle Database 21c CDB.
Note the following requirements:
Make sure that you specify oracle-ee-cdb
or oracle-se2-cdb
.
Make sure that your DB engine runs Oracle Database 19c with an April 2021 or later RU.
Note the following limitations:
You can't convert a CDB to a non-CDB.
You can't convert a replica database.
You can't convert a non-CDB to a CDB and upgrade the engine version in the same command.
You can't convert the existing custom parameter or option group when it has options or parameters that are
permanent or persistent. In this situation, the DB instance reverts to the default option and parameter group. To
avoid reverting to the default, specify a new parameter group with --db-parameter-group-name
and a
new option group with --option-group-name
.
engine
- The target Oracle DB engine when you convert a non-CDB to a CDB. This intermediate step is necessary to
upgrade an Oracle Database 19c non-CDB to an Oracle Database 21c CDB.
Note the following requirements:
Make sure that you specify oracle-ee-cdb
or oracle-se2-cdb
.
Make sure that your DB engine runs Oracle Database 19c with an April 2021 or later RU.
Note the following limitations:
You can't convert a CDB to a non-CDB.
You can't convert a replica database.
You can't convert a non-CDB to a CDB and upgrade the engine version in the same command.
You can't convert the existing custom parameter or option group when it has options or parameters that are
permanent or persistent. In this situation, the DB instance reverts to the default option and parameter
group. To avoid reverting to the default, specify a new parameter group with
--db-parameter-group-name
and a new option group with --option-group-name
.
public String toString()
toString
in class Object
Object.toString()
public ModifyDBInstanceRequest clone()
AmazonWebServiceRequest
clone
in class AmazonWebServiceRequest
Object.clone()