@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()
Specifies whether major version upgrades are allowed.
|
Boolean |
getApplyImmediately()
Specifies whether the modifications in this request and any pending modifications are asynchronously applied as
soon as possible, regardless of the
PreferredMaintenanceWindow setting for the DB instance. |
String |
getAutomationMode()
The automation mode of the RDS Custom DB instance.
|
Boolean |
getAutoMinorVersionUpgrade()
Specifies 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()
The CA certificate identifier to use for the DB instance's server certificate.
|
Boolean |
getCertificateRotationRestart()
Specifies whether the DB instance is restarted when you rotate your SSL/TLS certificate.
|
CloudwatchLogsExportConfiguration |
getCloudwatchLogsExportConfiguration()
The log types to be enabled for export to CloudWatch Logs for a specific DB instance.
|
Boolean |
getCopyTagsToSnapshot()
Specifies 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 identifier of DB instance to modify.
|
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 |
getDedicatedLogVolume()
Indicates whether the DB instance has a dedicated log volume (DLV) enabled.
|
Boolean |
getDeletionProtection()
Specifies whether the DB instance has deletion protection enabled.
|
Boolean |
getDisableDomain()
Specifies whether to remove the DB instance from the Active Directory domain.
|
String |
getDomain()
The Active Directory directory ID to move the DB instance to.
|
String |
getDomainAuthSecretArn()
The ARN for the Secrets Manager secret with the credentials for the user joining the domain.
|
List<String> |
getDomainDnsIps()
The IPv4 DNS IP addresses of your primary and secondary Active Directory domain controllers.
|
String |
getDomainFqdn()
The fully qualified domain name (FQDN) of an Active Directory domain.
|
String |
getDomainIAMRoleName()
The name of the IAM role to use when making API calls to the Directory Service.
|
String |
getDomainOu()
The Active Directory organizational unit for your DB instance to join.
|
Boolean |
getEnableCustomerOwnedIp()
Specifies whether to enable a customer-owned IP address (CoIP) for an RDS on Outposts DB instance.
|
Boolean |
getEnableIAMDatabaseAuthentication()
Specifies whether to enable mapping of Amazon Web Services Identity and Access Management (IAM) accounts to
database accounts.
|
Boolean |
getEnablePerformanceInsights()
Specifies 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()
Specifies 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()
Specifies whether the DB instance is a Multi-AZ deployment.
|
Boolean |
getMultiTenant()
Specifies whether the to convert your DB instance from the single-tenant configuration to the multi-tenant
configuration.
|
String |
getNetworkType()
The network type of the DB instance.
|
String |
getNewDBInstanceIdentifier()
The new identifier for the DB instance when renaming a DB instance.
|
String |
getOptionGroupName()
The option group to associate the DB instance with.
|
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 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()
The order of priority in which an Aurora Replica is promoted to the primary instance after a failure of the
existing primary instance.
|
Boolean |
getPubliclyAccessible()
Specifies 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()
Specifies whether to rotate the secret managed by Amazon Web Services Secrets Manager for the master user
password.
|
Integer |
getStorageThroughput()
The storage throughput value for the DB instance.
|
String |
getStorageType()
The storage type to associate 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()
Specifies 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 associate with this DB instance.
|
int |
hashCode() |
Boolean |
isAllowMajorVersionUpgrade()
Specifies whether major version upgrades are allowed.
|
Boolean |
isApplyImmediately()
Specifies whether the modifications in this request and any pending modifications are asynchronously applied as
soon as possible, regardless of the
PreferredMaintenanceWindow setting for the DB instance. |
Boolean |
isAutoMinorVersionUpgrade()
Specifies whether minor version upgrades are applied automatically to the DB instance during the maintenance
window.
|
Boolean |
isCertificateRotationRestart()
Specifies whether the DB instance is restarted when you rotate your SSL/TLS certificate.
|
Boolean |
isCopyTagsToSnapshot()
Specifies whether to copy all tags from the DB instance to snapshots of the DB instance.
|
Boolean |
isDedicatedLogVolume()
Indicates whether the DB instance has a dedicated log volume (DLV) enabled.
|
Boolean |
isDeletionProtection()
Specifies whether the DB instance has deletion protection enabled.
|
Boolean |
isDisableDomain()
Specifies whether to remove the DB instance from the Active Directory domain.
|
Boolean |
isEnableCustomerOwnedIp()
Specifies whether to enable a customer-owned IP address (CoIP) for an RDS on Outposts DB instance.
|
Boolean |
isEnableIAMDatabaseAuthentication()
Specifies whether to enable mapping of Amazon Web Services Identity and Access Management (IAM) accounts to
database accounts.
|
Boolean |
isEnablePerformanceInsights()
Specifies whether to enable Performance Insights for the DB instance.
|
Boolean |
isManageMasterUserPassword()
Specifies whether to manage the master user password with Amazon Web Services Secrets Manager.
|
Boolean |
isMultiAZ()
Specifies whether the DB instance is a Multi-AZ deployment.
|
Boolean |
isMultiTenant()
Specifies whether the to convert your DB instance from the single-tenant configuration to the multi-tenant
configuration.
|
Boolean |
isPubliclyAccessible()
Specifies whether the DB instance is publicly accessible.
|
Boolean |
isRotateMasterUserPassword()
Specifies whether to rotate the secret managed by Amazon Web Services Secrets Manager for the master user
password.
|
Boolean |
isUseDefaultProcessorFeatures()
Specifies 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)
Specifies whether major version upgrades are allowed.
|
void |
setApplyImmediately(Boolean applyImmediately)
Specifies whether the modifications in this request and any pending modifications are asynchronously applied as
soon as possible, regardless of the
PreferredMaintenanceWindow setting for the DB instance. |
void |
setAutomationMode(String automationMode)
The automation mode of the RDS Custom DB instance.
|
void |
setAutoMinorVersionUpgrade(Boolean autoMinorVersionUpgrade)
Specifies 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)
The CA certificate identifier to use for the DB instance's server certificate.
|
void |
setCertificateRotationRestart(Boolean certificateRotationRestart)
Specifies whether the DB instance is restarted when you rotate your SSL/TLS certificate.
|
void |
setCloudwatchLogsExportConfiguration(CloudwatchLogsExportConfiguration cloudwatchLogsExportConfiguration)
The log types to be enabled for export to CloudWatch Logs for a specific DB instance.
|
void |
setCopyTagsToSnapshot(Boolean copyTagsToSnapshot)
Specifies 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 identifier of DB instance to modify.
|
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 |
setDedicatedLogVolume(Boolean dedicatedLogVolume)
Indicates whether the DB instance has a dedicated log volume (DLV) enabled.
|
void |
setDeletionProtection(Boolean deletionProtection)
Specifies whether the DB instance has deletion protection enabled.
|
void |
setDisableDomain(Boolean disableDomain)
Specifies whether to remove the DB instance from the Active Directory domain.
|
void |
setDomain(String domain)
The Active Directory directory ID to move the DB instance to.
|
void |
setDomainAuthSecretArn(String domainAuthSecretArn)
The ARN for the Secrets Manager secret with the credentials for the user joining the domain.
|
void |
setDomainDnsIps(Collection<String> domainDnsIps)
The IPv4 DNS IP addresses of your primary and secondary Active Directory domain controllers.
|
void |
setDomainFqdn(String domainFqdn)
The fully qualified domain name (FQDN) of an Active Directory domain.
|
void |
setDomainIAMRoleName(String domainIAMRoleName)
The name of the IAM role to use when making API calls to the Directory Service.
|
void |
setDomainOu(String domainOu)
The Active Directory organizational unit for your DB instance to join.
|
void |
setEnableCustomerOwnedIp(Boolean enableCustomerOwnedIp)
Specifies whether to enable a customer-owned IP address (CoIP) for an RDS on Outposts DB instance.
|
void |
setEnableIAMDatabaseAuthentication(Boolean enableIAMDatabaseAuthentication)
Specifies whether to enable mapping of Amazon Web Services Identity and Access Management (IAM) accounts to
database accounts.
|
void |
setEnablePerformanceInsights(Boolean enablePerformanceInsights)
Specifies 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)
Specifies 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)
Specifies whether the DB instance is a Multi-AZ deployment.
|
void |
setMultiTenant(Boolean multiTenant)
Specifies whether the to convert your DB instance from the single-tenant configuration to the multi-tenant
configuration.
|
void |
setNetworkType(String networkType)
The network type of the DB instance.
|
void |
setNewDBInstanceIdentifier(String newDBInstanceIdentifier)
The new identifier for the DB instance when renaming a DB instance.
|
void |
setOptionGroupName(String optionGroupName)
The option group to associate the DB instance with.
|
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 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)
The order of priority in which an Aurora Replica is promoted to the primary instance after a failure of the
existing primary instance.
|
void |
setPubliclyAccessible(Boolean publiclyAccessible)
Specifies 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)
Specifies whether to rotate the secret managed by Amazon Web Services Secrets Manager for the master user
password.
|
void |
setStorageThroughput(Integer storageThroughput)
The storage throughput value for the DB instance.
|
void |
setStorageType(String storageType)
The storage type to associate 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)
Specifies 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 associate with 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)
Specifies whether major version upgrades are allowed.
|
ModifyDBInstanceRequest |
withApplyImmediately(Boolean applyImmediately)
Specifies whether the modifications in this request and any pending modifications are asynchronously applied as
soon as possible, regardless of the
PreferredMaintenanceWindow setting for the DB instance. |
ModifyDBInstanceRequest |
withAutomationMode(AutomationMode automationMode)
The automation mode of the RDS Custom DB instance.
|
ModifyDBInstanceRequest |
withAutomationMode(String automationMode)
The automation mode of the RDS Custom DB instance.
|
ModifyDBInstanceRequest |
withAutoMinorVersionUpgrade(Boolean autoMinorVersionUpgrade)
Specifies 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)
The CA certificate identifier to use for the DB instance's server certificate.
|
ModifyDBInstanceRequest |
withCertificateRotationRestart(Boolean certificateRotationRestart)
Specifies whether the DB instance is restarted when you rotate your SSL/TLS certificate.
|
ModifyDBInstanceRequest |
withCloudwatchLogsExportConfiguration(CloudwatchLogsExportConfiguration cloudwatchLogsExportConfiguration)
The log types to be enabled for export to CloudWatch Logs for a specific DB instance.
|
ModifyDBInstanceRequest |
withCopyTagsToSnapshot(Boolean copyTagsToSnapshot)
Specifies 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 identifier of DB instance to modify.
|
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 |
withDedicatedLogVolume(Boolean dedicatedLogVolume)
Indicates whether the DB instance has a dedicated log volume (DLV) enabled.
|
ModifyDBInstanceRequest |
withDeletionProtection(Boolean deletionProtection)
Specifies whether the DB instance has deletion protection enabled.
|
ModifyDBInstanceRequest |
withDisableDomain(Boolean disableDomain)
Specifies whether to remove the DB instance from the Active Directory domain.
|
ModifyDBInstanceRequest |
withDomain(String domain)
The Active Directory directory ID to move the DB instance to.
|
ModifyDBInstanceRequest |
withDomainAuthSecretArn(String domainAuthSecretArn)
The ARN for the Secrets Manager secret with the credentials for the user joining the domain.
|
ModifyDBInstanceRequest |
withDomainDnsIps(Collection<String> domainDnsIps)
The IPv4 DNS IP addresses of your primary and secondary Active Directory domain controllers.
|
ModifyDBInstanceRequest |
withDomainDnsIps(String... domainDnsIps)
The IPv4 DNS IP addresses of your primary and secondary Active Directory domain controllers.
|
ModifyDBInstanceRequest |
withDomainFqdn(String domainFqdn)
The fully qualified domain name (FQDN) of an Active Directory domain.
|
ModifyDBInstanceRequest |
withDomainIAMRoleName(String domainIAMRoleName)
The name of the IAM role to use when making API calls to the Directory Service.
|
ModifyDBInstanceRequest |
withDomainOu(String domainOu)
The Active Directory organizational unit for your DB instance to join.
|
ModifyDBInstanceRequest |
withEnableCustomerOwnedIp(Boolean enableCustomerOwnedIp)
Specifies whether to enable a customer-owned IP address (CoIP) for an RDS on Outposts DB instance.
|
ModifyDBInstanceRequest |
withEnableIAMDatabaseAuthentication(Boolean enableIAMDatabaseAuthentication)
Specifies whether to enable mapping of Amazon Web Services Identity and Access Management (IAM) accounts to
database accounts.
|
ModifyDBInstanceRequest |
withEnablePerformanceInsights(Boolean enablePerformanceInsights)
Specifies 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)
Specifies 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)
Specifies whether the DB instance is a Multi-AZ deployment.
|
ModifyDBInstanceRequest |
withMultiTenant(Boolean multiTenant)
Specifies whether the to convert your DB instance from the single-tenant configuration to the multi-tenant
configuration.
|
ModifyDBInstanceRequest |
withNetworkType(String networkType)
The network type of the DB instance.
|
ModifyDBInstanceRequest |
withNewDBInstanceIdentifier(String newDBInstanceIdentifier)
The new identifier for the DB instance when renaming a DB instance.
|
ModifyDBInstanceRequest |
withOptionGroupName(String optionGroupName)
The option group to associate the DB instance with.
|
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 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)
The order of priority in which an Aurora Replica is promoted to the primary instance after a failure of the
existing primary instance.
|
ModifyDBInstanceRequest |
withPubliclyAccessible(Boolean publiclyAccessible)
Specifies 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)
Specifies whether to rotate the secret managed by Amazon Web Services Secrets Manager for the master user
password.
|
ModifyDBInstanceRequest |
withStorageThroughput(Integer storageThroughput)
The storage throughput value for the DB instance.
|
ModifyDBInstanceRequest |
withStorageType(String storageType)
The storage type to associate 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)
Specifies 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 associate with this DB instance.
|
ModifyDBInstanceRequest |
withVpcSecurityGroupIds(String... vpcSecurityGroupIds)
A list of Amazon EC2 VPC security groups to associate with 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 identifier of DB instance to modify. This value is stored as a lowercase string.
Constraints:
Must match the identifier of an existing DB instance.
public void setDBInstanceIdentifier(String dBInstanceIdentifier)
The identifier of DB instance to modify. This value is stored as a lowercase string.
Constraints:
Must match the identifier of an existing DB instance.
dBInstanceIdentifier
- The identifier of DB instance to modify. This value is stored as a lowercase string.
Constraints:
Must match the identifier of an existing DB instance.
public String getDBInstanceIdentifier()
The identifier of DB instance to modify. This value is stored as a lowercase string.
Constraints:
Must match the identifier of an existing DB instance.
Constraints:
Must match the identifier of an existing DB instance.
public ModifyDBInstanceRequest withDBInstanceIdentifier(String dBInstanceIdentifier)
The identifier of DB instance to modify. This value is stored as a lowercase string.
Constraints:
Must match the identifier of an existing DB instance.
dBInstanceIdentifier
- The identifier of DB instance to modify. This value is stored as a lowercase string.
Constraints:
Must match the identifier of an existing DB instance.
public void setAllocatedStorage(Integer allocatedStorage)
The new amount of storage in gibibytes (GiB) to allocate for the DB instance.
For RDS for Db2, MariaDB, RDS for MySQL, RDS for Oracle, and RDS for 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
.
Constraints:
When you increase the allocated storage for a DB instance that uses Provisioned IOPS (gp3
,
io1
, or io2
storage type), you must also specify the Iops
parameter. You
can use the current value for Iops
.
allocatedStorage
- The new amount of storage in gibibytes (GiB) to allocate for the DB instance.
For RDS for Db2, MariaDB, RDS for MySQL, RDS for Oracle, and RDS for 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
.
Constraints:
When you increase the allocated storage for a DB instance that uses Provisioned IOPS (gp3
,
io1
, or io2
storage type), you must also specify the Iops
parameter. You can use the current value for Iops
.
public Integer getAllocatedStorage()
The new amount of storage in gibibytes (GiB) to allocate for the DB instance.
For RDS for Db2, MariaDB, RDS for MySQL, RDS for Oracle, and RDS for 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
.
Constraints:
When you increase the allocated storage for a DB instance that uses Provisioned IOPS (gp3
,
io1
, or io2
storage type), you must also specify the Iops
parameter. You
can use the current value for Iops
.
For RDS for Db2, MariaDB, RDS for MySQL, RDS for Oracle, and RDS for 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
.
Constraints:
When you increase the allocated storage for a DB instance that uses Provisioned IOPS (gp3
,
io1
, or io2
storage type), you must also specify the Iops
parameter. You can use the current value for Iops
.
public ModifyDBInstanceRequest withAllocatedStorage(Integer allocatedStorage)
The new amount of storage in gibibytes (GiB) to allocate for the DB instance.
For RDS for Db2, MariaDB, RDS for MySQL, RDS for Oracle, and RDS for 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
.
Constraints:
When you increase the allocated storage for a DB instance that uses Provisioned IOPS (gp3
,
io1
, or io2
storage type), you must also specify the Iops
parameter. You
can use the current value for Iops
.
allocatedStorage
- The new amount of storage in gibibytes (GiB) to allocate for the DB instance.
For RDS for Db2, MariaDB, RDS for MySQL, RDS for Oracle, and RDS for 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
.
Constraints:
When you increase the allocated storage for a DB instance that uses Provisioned IOPS (gp3
,
io1
, or io2
storage type), you must also specify the Iops
parameter. You can use the current value for Iops
.
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
Constraints:
If you are modifying the DB instance class and upgrading the engine version at the same time, the currently running engine version must be supported on the specified DB instance class. Otherwise, the operation returns an error. In this case, first run the operation to upgrade the engine version, and then run it again to modify the DB instance class.
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
Constraints:
If you are modifying the DB instance class and upgrading the engine version at the same time, the currently running engine version must be supported on the specified DB instance class. Otherwise, the operation returns an error. In this case, first run the operation to upgrade the engine version, and then run it again to modify the DB instance class.
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
Constraints:
If you are modifying the DB instance class and upgrading the engine version at the same time, the currently running engine version must be supported on the specified DB instance class. Otherwise, the operation returns an error. In this case, first run the operation to upgrade the engine version, and then run it again to modify the DB instance class.
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
Constraints:
If you are modifying the DB instance class and upgrading the engine version at the same time, the currently running engine version must be supported on the specified DB instance class. Otherwise, the operation returns an error. In this case, first run the operation to upgrade the engine version, and then run it again to modify the DB instance class.
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
Constraints:
If you are modifying the DB instance class and upgrading the engine version at the same time, the currently running engine version must be supported on the specified DB instance class. Otherwise, the operation returns an error. In this case, first run the operation to upgrade the engine version, and then run it again to modify the DB instance class.
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
Constraints:
If you are modifying the DB instance class and upgrading the engine version at the same time, the currently running engine version must be supported on the specified DB instance class. Otherwise, the operation returns an error. In this case, first run the operation to upgrade the engine version, and then run it again to modify the DB instance class.
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 setting doesn't apply to RDS Custom DB instances.
Constraints:
If supplied, must match existing DB subnet group.
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 setting doesn't apply to RDS Custom DB instances.
Constraints:
If supplied, must match existing DB subnet group.
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 setting doesn't apply to RDS Custom DB instances.
Constraints:
If supplied, must match existing DB subnet group.
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 setting doesn't apply to RDS Custom DB instances.
Constraints:
If supplied, must match existing DB subnet group.
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 setting doesn't apply to RDS Custom DB instances.
Constraints:
If supplied, must match existing DB subnet group.
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 setting doesn't apply to RDS Custom DB instances.
Constraints:
If supplied, must match existing DB subnet group.
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 DB instances.
Constraints:
If supplied, must match existing DB security groups.
This setting doesn't apply to RDS Custom DB instances.
Constraints:
If supplied, must match existing DB security groups.
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 DB instances.
Constraints:
If supplied, must match existing DB security groups.
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 DB instances.
Constraints:
If supplied, must match existing DB security groups.
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 DB instances.
Constraints:
If supplied, must match existing DB security groups.
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 DB instances.
Constraints:
If supplied, must match existing DB security groups.
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 DB instances.
Constraints:
If supplied, must match existing DB security groups.
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 DB instances.
Constraints:
If supplied, must match existing DB security groups.
public List<String> getVpcSecurityGroupIds()
A list of Amazon EC2 VPC security groups to associate with this DB instance. This change is asynchronously applied as soon as possible.
This setting doesn't apply to the following DB instances:
Amazon Aurora (The associated list of EC2 VPC security groups is managed by the DB cluster. For more information,
see ModifyDBCluster
.)
RDS Custom
Constraints:
If supplied, must match existing VPC security group IDs.
This setting doesn't apply to the following DB instances:
Amazon Aurora (The associated list of EC2 VPC security groups is managed by the DB cluster. For more
information, see ModifyDBCluster
.)
RDS Custom
Constraints:
If supplied, must match existing VPC security group IDs.
public void setVpcSecurityGroupIds(Collection<String> vpcSecurityGroupIds)
A list of Amazon EC2 VPC security groups to associate with this DB instance. This change is asynchronously applied as soon as possible.
This setting doesn't apply to the following DB instances:
Amazon Aurora (The associated list of EC2 VPC security groups is managed by the DB cluster. For more information,
see ModifyDBCluster
.)
RDS Custom
Constraints:
If supplied, must match existing VPC security group IDs.
vpcSecurityGroupIds
- A list of Amazon EC2 VPC security groups to associate with this DB instance. This change is asynchronously
applied as soon as possible.
This setting doesn't apply to the following DB instances:
Amazon Aurora (The associated list of EC2 VPC security groups is managed by the DB cluster. For more
information, see ModifyDBCluster
.)
RDS Custom
Constraints:
If supplied, must match existing VPC security group IDs.
public ModifyDBInstanceRequest withVpcSecurityGroupIds(String... vpcSecurityGroupIds)
A list of Amazon EC2 VPC security groups to associate with this DB instance. This change is asynchronously applied as soon as possible.
This setting doesn't apply to the following DB instances:
Amazon Aurora (The associated list of EC2 VPC security groups is managed by the DB cluster. For more information,
see ModifyDBCluster
.)
RDS Custom
Constraints:
If supplied, must match existing VPC security group IDs.
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 associate with this DB instance. This change is asynchronously
applied as soon as possible.
This setting doesn't apply to the following DB instances:
Amazon Aurora (The associated list of EC2 VPC security groups is managed by the DB cluster. For more
information, see ModifyDBCluster
.)
RDS Custom
Constraints:
If supplied, must match existing VPC security group IDs.
public ModifyDBInstanceRequest withVpcSecurityGroupIds(Collection<String> vpcSecurityGroupIds)
A list of Amazon EC2 VPC security groups to associate with this DB instance. This change is asynchronously applied as soon as possible.
This setting doesn't apply to the following DB instances:
Amazon Aurora (The associated list of EC2 VPC security groups is managed by the DB cluster. For more information,
see ModifyDBCluster
.)
RDS Custom
Constraints:
If supplied, must match existing VPC security group IDs.
vpcSecurityGroupIds
- A list of Amazon EC2 VPC security groups to associate with this DB instance. This change is asynchronously
applied as soon as possible.
This setting doesn't apply to the following DB instances:
Amazon Aurora (The associated list of EC2 VPC security groups is managed by the DB cluster. For more
information, see ModifyDBCluster
.)
RDS Custom
Constraints:
If supplied, must match existing VPC security group IDs.
public void setApplyImmediately(Boolean applyImmediately)
Specifies whether the modifications in this request and any pending modifications are asynchronously applied as
soon as possible, regardless of the PreferredMaintenanceWindow
setting for the DB instance. 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
- Specifies whether the modifications in this request and any pending modifications are asynchronously
applied as soon as possible, regardless of the PreferredMaintenanceWindow
setting for the DB
instance. 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()
Specifies whether the modifications in this request and any pending modifications are asynchronously applied as
soon as possible, regardless of the PreferredMaintenanceWindow
setting for the DB instance. 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)
Specifies whether the modifications in this request and any pending modifications are asynchronously applied as
soon as possible, regardless of the PreferredMaintenanceWindow
setting for the DB instance. 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
- Specifies whether the modifications in this request and any pending modifications are asynchronously
applied as soon as possible, regardless of the PreferredMaintenanceWindow
setting for the DB
instance. 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()
Specifies whether the modifications in this request and any pending modifications are asynchronously applied as
soon as possible, regardless of the PreferredMaintenanceWindow
setting for the DB instance. 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.
Changing this parameter doesn't result in an outage and the change is asynchronously applied as soon as possible.
Between the time of the request and the completion of the request, the MasterUserPassword
element
exists in the PendingModifiedValues
element of the operation response.
Amazon RDS API operations never return the password, so this operation 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.
This setting doesn't apply to the following DB instances:
Amazon Aurora (The password for the master user is managed by the DB cluster. For more information, see
ModifyDBCluster
.)
RDS Custom
Default: Uses existing setting
Constraints:
Can't be specified if ManageMasterUserPassword
is turned on.
Can include any printable ASCII character except "/", """, or "@". For RDS for Oracle, can't include the "&" (ampersand) or the "'" (single quotes) character.
Length Constraints:
RDS for Db2 - Must contain from 8 to 255 characters.
RDS for MariaDB - Must contain from 8 to 41 characters.
RDS for Microsoft SQL Server - Must contain from 8 to 128 characters.
RDS for MySQL - Must contain from 8 to 41 characters.
RDS for Oracle - Must contain from 8 to 30 characters.
RDS for PostgreSQL - Must contain from 8 to 128 characters.
masterUserPassword
- The new password for the master user.
Changing this parameter doesn't result in an outage and the change is asynchronously applied as soon as
possible. Between the time of the request and the completion of the request, the
MasterUserPassword
element exists in the PendingModifiedValues
element of the
operation response.
Amazon RDS API operations never return the password, so this operation 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.
This setting doesn't apply to the following DB instances:
Amazon Aurora (The password for the master user is managed by the DB cluster. For more information, see
ModifyDBCluster
.)
RDS Custom
Default: Uses existing setting
Constraints:
Can't be specified if ManageMasterUserPassword
is turned on.
Can include any printable ASCII character except "/", """, or "@". For RDS for Oracle, can't include the "&" (ampersand) or the "'" (single quotes) character.
Length Constraints:
RDS for Db2 - Must contain from 8 to 255 characters.
RDS for MariaDB - Must contain from 8 to 41 characters.
RDS for Microsoft SQL Server - Must contain from 8 to 128 characters.
RDS for MySQL - Must contain from 8 to 41 characters.
RDS for Oracle - Must contain from 8 to 30 characters.
RDS for PostgreSQL - Must contain from 8 to 128 characters.
public String getMasterUserPassword()
The new password for the master user.
Changing this parameter doesn't result in an outage and the change is asynchronously applied as soon as possible.
Between the time of the request and the completion of the request, the MasterUserPassword
element
exists in the PendingModifiedValues
element of the operation response.
Amazon RDS API operations never return the password, so this operation 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.
This setting doesn't apply to the following DB instances:
Amazon Aurora (The password for the master user is managed by the DB cluster. For more information, see
ModifyDBCluster
.)
RDS Custom
Default: Uses existing setting
Constraints:
Can't be specified if ManageMasterUserPassword
is turned on.
Can include any printable ASCII character except "/", """, or "@". For RDS for Oracle, can't include the "&" (ampersand) or the "'" (single quotes) character.
Length Constraints:
RDS for Db2 - Must contain from 8 to 255 characters.
RDS for MariaDB - Must contain from 8 to 41 characters.
RDS for Microsoft SQL Server - Must contain from 8 to 128 characters.
RDS for MySQL - Must contain from 8 to 41 characters.
RDS for Oracle - Must contain from 8 to 30 characters.
RDS for PostgreSQL - Must contain from 8 to 128 characters.
Changing this parameter doesn't result in an outage and the change is asynchronously applied as soon as
possible. Between the time of the request and the completion of the request, the
MasterUserPassword
element exists in the PendingModifiedValues
element of the
operation response.
Amazon RDS API operations never return the password, so this operation 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.
This setting doesn't apply to the following DB instances:
Amazon Aurora (The password for the master user is managed by the DB cluster. For more information, see
ModifyDBCluster
.)
RDS Custom
Default: Uses existing setting
Constraints:
Can't be specified if ManageMasterUserPassword
is turned on.
Can include any printable ASCII character except "/", """, or "@". For RDS for Oracle, can't include the "&" (ampersand) or the "'" (single quotes) character.
Length Constraints:
RDS for Db2 - Must contain from 8 to 255 characters.
RDS for MariaDB - Must contain from 8 to 41 characters.
RDS for Microsoft SQL Server - Must contain from 8 to 128 characters.
RDS for MySQL - Must contain from 8 to 41 characters.
RDS for Oracle - Must contain from 8 to 30 characters.
RDS for PostgreSQL - Must contain from 8 to 128 characters.
public ModifyDBInstanceRequest withMasterUserPassword(String masterUserPassword)
The new password for the master user.
Changing this parameter doesn't result in an outage and the change is asynchronously applied as soon as possible.
Between the time of the request and the completion of the request, the MasterUserPassword
element
exists in the PendingModifiedValues
element of the operation response.
Amazon RDS API operations never return the password, so this operation 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.
This setting doesn't apply to the following DB instances:
Amazon Aurora (The password for the master user is managed by the DB cluster. For more information, see
ModifyDBCluster
.)
RDS Custom
Default: Uses existing setting
Constraints:
Can't be specified if ManageMasterUserPassword
is turned on.
Can include any printable ASCII character except "/", """, or "@". For RDS for Oracle, can't include the "&" (ampersand) or the "'" (single quotes) character.
Length Constraints:
RDS for Db2 - Must contain from 8 to 255 characters.
RDS for MariaDB - Must contain from 8 to 41 characters.
RDS for Microsoft SQL Server - Must contain from 8 to 128 characters.
RDS for MySQL - Must contain from 8 to 41 characters.
RDS for Oracle - Must contain from 8 to 30 characters.
RDS for PostgreSQL - Must contain from 8 to 128 characters.
masterUserPassword
- The new password for the master user.
Changing this parameter doesn't result in an outage and the change is asynchronously applied as soon as
possible. Between the time of the request and the completion of the request, the
MasterUserPassword
element exists in the PendingModifiedValues
element of the
operation response.
Amazon RDS API operations never return the password, so this operation 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.
This setting doesn't apply to the following DB instances:
Amazon Aurora (The password for the master user is managed by the DB cluster. For more information, see
ModifyDBCluster
.)
RDS Custom
Default: Uses existing setting
Constraints:
Can't be specified if ManageMasterUserPassword
is turned on.
Can include any printable ASCII character except "/", """, or "@". For RDS for Oracle, can't include the "&" (ampersand) or the "'" (single quotes) character.
Length Constraints:
RDS for Db2 - Must contain from 8 to 255 characters.
RDS for MariaDB - Must contain from 8 to 41 characters.
RDS for Microsoft SQL Server - Must contain from 8 to 128 characters.
RDS for MySQL - Must contain from 8 to 41 characters.
RDS for Oracle - Must contain from 8 to 30 characters.
RDS for PostgreSQL - Must contain from 8 to 128 characters.
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 DB instances.
Default: Uses existing setting
Constraints:
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 DB instances.
Default: Uses existing setting
Constraints:
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 DB instances.
Default: Uses existing setting
Constraints:
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 DB instances.
Default: Uses existing setting
Constraints:
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 DB instances.
Default: Uses existing setting
Constraints:
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 DB instances.
Default: Uses existing setting
Constraints:
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.
This setting doesn't apply to Amazon Aurora DB instances. The retention period for automated backups is managed
by the DB cluster. For more information, see ModifyDBCluster
.
Default: Uses existing setting
Constraints:
Must be a value from 0 to 35.
Can't be set to 0 if the DB instance is a source to read replicas.
Can't be set to 0 for an RDS Custom for Oracle DB instance.
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.
This setting doesn't apply to Amazon Aurora DB instances. The retention period for automated backups is
managed by the DB cluster. For more information, see ModifyDBCluster
.
Default: Uses existing setting
Constraints:
Must be a value from 0 to 35.
Can't be set to 0 if the DB instance is a source to read replicas.
Can't be set to 0 for an RDS Custom for Oracle DB instance.
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.
This setting doesn't apply to Amazon Aurora DB instances. The retention period for automated backups is managed
by the DB cluster. For more information, see ModifyDBCluster
.
Default: Uses existing setting
Constraints:
Must be a value from 0 to 35.
Can't be set to 0 if the DB instance is a source to read replicas.
Can't be set to 0 for an RDS Custom for Oracle DB instance.
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.
This setting doesn't apply to Amazon Aurora DB instances. The retention period for automated backups is
managed by the DB cluster. For more information, see ModifyDBCluster
.
Default: Uses existing setting
Constraints:
Must be a value from 0 to 35.
Can't be set to 0 if the DB instance is a source to read replicas.
Can't be set to 0 for an RDS Custom for Oracle DB instance.
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.
This setting doesn't apply to Amazon Aurora DB instances. The retention period for automated backups is managed
by the DB cluster. For more information, see ModifyDBCluster
.
Default: Uses existing setting
Constraints:
Must be a value from 0 to 35.
Can't be set to 0 if the DB instance is a source to read replicas.
Can't be set to 0 for an RDS Custom for Oracle DB instance.
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.
This setting doesn't apply to Amazon Aurora DB instances. The retention period for automated backups is
managed by the DB cluster. For more information, see ModifyDBCluster
.
Default: Uses existing setting
Constraints:
Must be a value from 0 to 35.
Can't be set to 0 if the DB instance is a source to read replicas.
Can't be set to 0 for an RDS Custom for Oracle DB instance.
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.
This setting doesn't apply to Amazon Aurora DB instances. 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 Coordinated Time (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.
This setting doesn't apply to Amazon Aurora DB instances. 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 Coordinated Time (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.
This setting doesn't apply to Amazon Aurora DB instances. 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 Coordinated Time (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.
This setting doesn't apply to Amazon Aurora DB instances. 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 Coordinated Time (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.
This setting doesn't apply to Amazon Aurora DB instances. 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 Coordinated Time (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.
This setting doesn't apply to Amazon Aurora DB instances. 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 Coordinated Time (UTC).
Must not conflict with the preferred maintenance window.
Must be at least 30 minutes.
public void setPreferredMaintenanceWindow(String preferredMaintenanceWindow)
The weekly time range 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 causes a reboot of the DB instance. If you change 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
Constraints:
Must be in the format ddd:hh24:mi-ddd:hh24:mi
.
The day values must be mon | tue | wed | thu | fri | sat | sun
.
Must be in Universal Coordinated Time (UTC).
Must not conflict with the preferred backup window.
Must be at least 30 minutes.
preferredMaintenanceWindow
- The weekly time range 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 causes a reboot of
the DB instance. If you change 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
Constraints:
Must be in the format ddd:hh24:mi-ddd:hh24:mi
.
The day values must be mon | tue | wed | thu | fri | sat | sun
.
Must be in Universal Coordinated Time (UTC).
Must not conflict with the preferred backup window.
Must be at least 30 minutes.
public String getPreferredMaintenanceWindow()
The weekly time range 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 causes a reboot of the DB instance. If you change 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
Constraints:
Must be in the format ddd:hh24:mi-ddd:hh24:mi
.
The day values must be mon | tue | wed | thu | fri | sat | sun
.
Must be in Universal Coordinated Time (UTC).
Must not conflict with the preferred backup window.
Must be at least 30 minutes.
For more information, see Amazon RDS Maintenance Window in the Amazon RDS User Guide.
Default: Uses existing setting
Constraints:
Must be in the format ddd:hh24:mi-ddd:hh24:mi
.
The day values must be mon | tue | wed | thu | fri | sat | sun
.
Must be in Universal Coordinated Time (UTC).
Must not conflict with the preferred backup window.
Must be at least 30 minutes.
public ModifyDBInstanceRequest withPreferredMaintenanceWindow(String preferredMaintenanceWindow)
The weekly time range 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 causes a reboot of the DB instance. If you change 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
Constraints:
Must be in the format ddd:hh24:mi-ddd:hh24:mi
.
The day values must be mon | tue | wed | thu | fri | sat | sun
.
Must be in Universal Coordinated Time (UTC).
Must not conflict with the preferred backup window.
Must be at least 30 minutes.
preferredMaintenanceWindow
- The weekly time range 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 causes a reboot of
the DB instance. If you change 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
Constraints:
Must be in the format ddd:hh24:mi-ddd:hh24:mi
.
The day values must be mon | tue | wed | thu | fri | sat | sun
.
Must be in Universal Coordinated Time (UTC).
Must not conflict with the preferred backup window.
Must be at least 30 minutes.
public void setMultiAZ(Boolean multiAZ)
Specifies 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 DB instances.
multiAZ
- Specifies 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 DB instances.
public Boolean getMultiAZ()
Specifies 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 DB instances.
ApplyImmediately
parameter is enabled for this request.
This setting doesn't apply to RDS Custom DB instances.
public ModifyDBInstanceRequest withMultiAZ(Boolean multiAZ)
Specifies 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 DB instances.
multiAZ
- Specifies 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 DB instances.
public Boolean isMultiAZ()
Specifies 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 DB instances.
ApplyImmediately
parameter is enabled for this request.
This setting doesn't apply to RDS Custom DB instances.
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 updates 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 higher 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.
Constraints:
If you are upgrading the engine version and modifying the DB instance class at the same time, the currently running engine version must be supported on the specified DB instance class. Otherwise, the operation returns an error. In this case, first run the operation to upgrade the engine version, and then run it again to modify the DB instance class.
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 updates 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 higher 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.
Constraints:
If you are upgrading the engine version and modifying the DB instance class at the same time, the currently running engine version must be supported on the specified DB instance class. Otherwise, the operation returns an error. In this case, first run the operation to upgrade the engine version, and then run it again to modify the DB instance class.
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 updates 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 higher 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.
Constraints:
If you are upgrading the engine version and modifying the DB instance class at the same time, the currently running engine version must be supported on the specified DB instance class. Otherwise, the operation returns an error. In this case, first run the operation to upgrade the engine version, and then run it again to modify the DB instance class.
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 updates 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 higher 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.
Constraints:
If you are upgrading the engine version and modifying the DB instance class at the same time, the currently running engine version must be supported on the specified DB instance class. Otherwise, the operation returns an error. In this case, first run the operation to upgrade the engine version, and then run it again to modify the DB instance class.
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 updates 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 higher 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.
Constraints:
If you are upgrading the engine version and modifying the DB instance class at the same time, the currently running engine version must be supported on the specified DB instance class. Otherwise, the operation returns an error. In this case, first run the operation to upgrade the engine version, and then run it again to modify the DB instance class.
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 updates 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 higher 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.
Constraints:
If you are upgrading the engine version and modifying the DB instance class at the same time, the currently running engine version must be supported on the specified DB instance class. Otherwise, the operation returns an error. In this case, first run the operation to upgrade the engine version, and then run it again to modify the DB instance class.
public void setAllowMajorVersionUpgrade(Boolean allowMajorVersionUpgrade)
Specifies 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 DB instances.
Constraints:
Major version upgrades must be allowed when specifying a value for the EngineVersion
parameter
that's a different major version than the DB instance's current version.
allowMajorVersionUpgrade
- Specifies 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 DB instances.
Constraints:
Major version upgrades must be allowed when specifying a value for the EngineVersion
parameter that's a different major version than the DB instance's current version.
public Boolean getAllowMajorVersionUpgrade()
Specifies 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 DB instances.
Constraints:
Major version upgrades must be allowed when specifying a value for the EngineVersion
parameter
that's a different major version than the DB instance's current version.
This setting doesn't apply to RDS Custom DB instances.
Constraints:
Major version upgrades must be allowed when specifying a value for the EngineVersion
parameter that's a different major version than the DB instance's current version.
public ModifyDBInstanceRequest withAllowMajorVersionUpgrade(Boolean allowMajorVersionUpgrade)
Specifies 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 DB instances.
Constraints:
Major version upgrades must be allowed when specifying a value for the EngineVersion
parameter
that's a different major version than the DB instance's current version.
allowMajorVersionUpgrade
- Specifies 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 DB instances.
Constraints:
Major version upgrades must be allowed when specifying a value for the EngineVersion
parameter that's a different major version than the DB instance's current version.
public Boolean isAllowMajorVersionUpgrade()
Specifies 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 DB instances.
Constraints:
Major version upgrades must be allowed when specifying a value for the EngineVersion
parameter
that's a different major version than the DB instance's current version.
This setting doesn't apply to RDS Custom DB instances.
Constraints:
Major version upgrades must be allowed when specifying a value for the EngineVersion
parameter that's a different major version than the DB instance's current version.
public void setAutoMinorVersionUpgrade(Boolean autoMinorVersionUpgrade)
Specifies 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, Amazon RDS applies the change as soon as possible and doesn't cause an outage.
For an RDS Custom DB instance, don't enable this setting. Otherwise, the operation returns an error.
autoMinorVersionUpgrade
- Specifies 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, Amazon RDS applies the change as soon as possible and doesn't cause an outage.
For an RDS Custom DB instance, don't enable this setting. Otherwise, the operation returns an error.
public Boolean getAutoMinorVersionUpgrade()
Specifies 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, Amazon RDS applies the change as soon as possible and doesn't cause an outage.
For an RDS Custom DB instance, don't enable this setting. 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, Amazon RDS applies the change as soon as possible and doesn't cause an outage.
For an RDS Custom DB instance, don't enable this setting. Otherwise, the operation returns an error.
public ModifyDBInstanceRequest withAutoMinorVersionUpgrade(Boolean autoMinorVersionUpgrade)
Specifies 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, Amazon RDS applies the change as soon as possible and doesn't cause an outage.
For an RDS Custom DB instance, don't enable this setting. Otherwise, the operation returns an error.
autoMinorVersionUpgrade
- Specifies 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, Amazon RDS applies the change as soon as possible and doesn't cause an outage.
For an RDS Custom DB instance, don't enable this setting. Otherwise, the operation returns an error.
public Boolean isAutoMinorVersionUpgrade()
Specifies 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, Amazon RDS applies the change as soon as possible and doesn't cause an outage.
For an RDS Custom DB instance, don't enable this setting. 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, Amazon RDS applies the change as soon as possible and doesn't cause an outage.
For an RDS Custom DB instance, don't enable this setting. Otherwise, the operation returns an error.
public void setLicenseModel(String licenseModel)
The license model for the DB instance.
This setting doesn't apply to Amazon Aurora or RDS Custom DB instances.
Valid Values:
RDS for Db2 - bring-your-own-license
RDS for MariaDB - general-public-license
RDS for Microsoft SQL Server - license-included
RDS for MySQL - general-public-license
RDS for Oracle - bring-your-own-license | license-included
RDS for PostgreSQL - postgresql-license
licenseModel
- The license model for the DB instance.
This setting doesn't apply to Amazon Aurora or RDS Custom DB instances.
Valid Values:
RDS for Db2 - bring-your-own-license
RDS for MariaDB - general-public-license
RDS for Microsoft SQL Server - license-included
RDS for MySQL - general-public-license
RDS for Oracle - bring-your-own-license | license-included
RDS for PostgreSQL - postgresql-license
public String getLicenseModel()
The license model for the DB instance.
This setting doesn't apply to Amazon Aurora or RDS Custom DB instances.
Valid Values:
RDS for Db2 - bring-your-own-license
RDS for MariaDB - general-public-license
RDS for Microsoft SQL Server - license-included
RDS for MySQL - general-public-license
RDS for Oracle - bring-your-own-license | license-included
RDS for PostgreSQL - postgresql-license
This setting doesn't apply to Amazon Aurora or RDS Custom DB instances.
Valid Values:
RDS for Db2 - bring-your-own-license
RDS for MariaDB - general-public-license
RDS for Microsoft SQL Server - license-included
RDS for MySQL - general-public-license
RDS for Oracle - bring-your-own-license | license-included
RDS for PostgreSQL - postgresql-license
public ModifyDBInstanceRequest withLicenseModel(String licenseModel)
The license model for the DB instance.
This setting doesn't apply to Amazon Aurora or RDS Custom DB instances.
Valid Values:
RDS for Db2 - bring-your-own-license
RDS for MariaDB - general-public-license
RDS for Microsoft SQL Server - license-included
RDS for MySQL - general-public-license
RDS for Oracle - bring-your-own-license | license-included
RDS for PostgreSQL - postgresql-license
licenseModel
- The license model for the DB instance.
This setting doesn't apply to Amazon Aurora or RDS Custom DB instances.
Valid Values:
RDS for Db2 - bring-your-own-license
RDS for MariaDB - general-public-license
RDS for Microsoft SQL Server - license-included
RDS for MySQL - general-public-license
RDS for Oracle - bring-your-own-license | license-included
RDS for PostgreSQL - postgresql-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 RDS for MariaDB, RDS for MySQL, RDS for Oracle, and RDS for 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.
When you increase the Provisioned IOPS, you must also specify the AllocatedStorage
parameter. You
can use the current value for AllocatedStorage
.
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 RDS for MariaDB, RDS for MySQL, RDS for Oracle, and RDS for 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.
When you increase the Provisioned IOPS, you must also specify the AllocatedStorage
parameter.
You can use the current value for AllocatedStorage
.
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 RDS for MariaDB, RDS for MySQL, RDS for Oracle, and RDS for 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.
When you increase the Provisioned IOPS, you must also specify the AllocatedStorage
parameter. You
can use the current value for AllocatedStorage
.
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 RDS for MariaDB, RDS for MySQL, RDS for Oracle, and RDS for 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.
When you increase the Provisioned IOPS, you must also specify the AllocatedStorage
parameter. You can use the current value for AllocatedStorage
.
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 RDS for MariaDB, RDS for MySQL, RDS for Oracle, and RDS for 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.
When you increase the Provisioned IOPS, you must also specify the AllocatedStorage
parameter. You
can use the current value for AllocatedStorage
.
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 RDS for MariaDB, RDS for MySQL, RDS for Oracle, and RDS for 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.
When you increase the Provisioned IOPS, you must also specify the AllocatedStorage
parameter.
You can use the current value for AllocatedStorage
.
Default: Uses existing setting
public void setOptionGroupName(String optionGroupName)
The option group to associate the DB instance with.
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 DB instances.
optionGroupName
- The option group to associate the DB instance with.
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 DB instances.
public String getOptionGroupName()
The option group to associate the DB instance with.
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 DB instances.
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 DB instances.
public ModifyDBInstanceRequest withOptionGroupName(String optionGroupName)
The option group to associate the DB instance with.
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 DB instances.
optionGroupName
- The option group to associate the DB instance with.
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 DB instances.
public void setNewDBInstanceIdentifier(String newDBInstanceIdentifier)
The new 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 ApplyImmediately
. This value is stored as a lowercase string.
This setting doesn't apply to RDS Custom DB instances.
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 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 ApplyImmediately
. This value is
stored as a lowercase string.
This setting doesn't apply to RDS Custom DB instances.
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 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 ApplyImmediately
. This value is stored as a lowercase string.
This setting doesn't apply to RDS Custom DB instances.
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 ApplyImmediately
. This value is
stored as a lowercase string.
This setting doesn't apply to RDS Custom DB instances.
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 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 ApplyImmediately
. This value is stored as a lowercase string.
This setting doesn't apply to RDS Custom DB instances.
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 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 ApplyImmediately
. This value is
stored as a lowercase string.
This setting doesn't apply to RDS Custom DB instances.
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)
The storage type to associate with the DB instance.
If you specify io1
, io2
, or gp3
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 | io2 | standard
Default: io1
, if the Iops
parameter is specified. Otherwise, gp2
.
storageType
- The storage type to associate with the DB instance.
If you specify io1
, io2
, or gp3
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 | io2 | standard
Default: io1
, if the Iops
parameter is specified. Otherwise, gp2
.
public String getStorageType()
The storage type to associate with the DB instance.
If you specify io1
, io2
, or gp3
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 | io2 | standard
Default: io1
, if the Iops
parameter is specified. Otherwise, gp2
.
If you specify io1
, io2
, or gp3
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 | io2 | standard
Default: io1
, if the Iops
parameter is specified. Otherwise, gp2
.
public ModifyDBInstanceRequest withStorageType(String storageType)
The storage type to associate with the DB instance.
If you specify io1
, io2
, or gp3
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 | io2 | standard
Default: io1
, if the Iops
parameter is specified. Otherwise, gp2
.
storageType
- The storage type to associate with the DB instance.
If you specify io1
, io2
, or gp3
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 | io2 | 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 DB instances.
tdeCredentialArn
- The ARN from the key store with which to associate the instance for TDE encryption.
This setting doesn't apply to RDS Custom DB instances.
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 DB instances.
This setting doesn't apply to RDS Custom DB instances.
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 DB instances.
tdeCredentialArn
- The ARN from the key store with which to associate the instance for TDE encryption.
This setting doesn't apply to RDS Custom DB instances.
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 DB instances.
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 DB instances.
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 DB instances.
This setting doesn't apply to RDS Custom DB instances.
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 DB instances.
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 DB instances.
public void setCACertificateIdentifier(String cACertificateIdentifier)
The CA certificate identifier to use for the DB instance's server certificate.
This setting doesn't apply to RDS Custom DB instances.
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
- The CA certificate identifier to use for the DB instance's server certificate.
This setting doesn't apply to RDS Custom DB instances.
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()
The CA certificate identifier to use for the DB instance's server certificate.
This setting doesn't apply to RDS Custom DB instances.
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 DB instances.
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)
The CA certificate identifier to use for the DB instance's server certificate.
This setting doesn't apply to RDS Custom DB instances.
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
- The CA certificate identifier to use for the DB instance's server certificate.
This setting doesn't apply to RDS Custom DB instances.
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 Db2,
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 DB instances.
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 Db2, 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 DB instances.
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 Db2,
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 DB instances.
none
to remove the
instance from its current domain. You must create the domain before this operation. Currently, you can
create only Db2, 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 DB instances.
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 Db2,
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 DB instances.
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 Db2, 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 DB instances.
public void setDomainFqdn(String domainFqdn)
The fully qualified domain name (FQDN) of an Active Directory domain.
Constraints:
Can't be longer than 64 characters.
Example: mymanagedADtest.mymanagedAD.mydomain
domainFqdn
- The fully qualified domain name (FQDN) of an Active Directory domain.
Constraints:
Can't be longer than 64 characters.
Example: mymanagedADtest.mymanagedAD.mydomain
public String getDomainFqdn()
The fully qualified domain name (FQDN) of an Active Directory domain.
Constraints:
Can't be longer than 64 characters.
Example: mymanagedADtest.mymanagedAD.mydomain
Constraints:
Can't be longer than 64 characters.
Example: mymanagedADtest.mymanagedAD.mydomain
public ModifyDBInstanceRequest withDomainFqdn(String domainFqdn)
The fully qualified domain name (FQDN) of an Active Directory domain.
Constraints:
Can't be longer than 64 characters.
Example: mymanagedADtest.mymanagedAD.mydomain
domainFqdn
- The fully qualified domain name (FQDN) of an Active Directory domain.
Constraints:
Can't be longer than 64 characters.
Example: mymanagedADtest.mymanagedAD.mydomain
public void setDomainOu(String domainOu)
The Active Directory organizational unit for your DB instance to join.
Constraints:
Must be in the distinguished name format.
Can't be longer than 64 characters.
Example: OU=mymanagedADtestOU,DC=mymanagedADtest,DC=mymanagedAD,DC=mydomain
domainOu
- The Active Directory organizational unit for your DB instance to join.
Constraints:
Must be in the distinguished name format.
Can't be longer than 64 characters.
Example: OU=mymanagedADtestOU,DC=mymanagedADtest,DC=mymanagedAD,DC=mydomain
public String getDomainOu()
The Active Directory organizational unit for your DB instance to join.
Constraints:
Must be in the distinguished name format.
Can't be longer than 64 characters.
Example: OU=mymanagedADtestOU,DC=mymanagedADtest,DC=mymanagedAD,DC=mydomain
Constraints:
Must be in the distinguished name format.
Can't be longer than 64 characters.
Example: OU=mymanagedADtestOU,DC=mymanagedADtest,DC=mymanagedAD,DC=mydomain
public ModifyDBInstanceRequest withDomainOu(String domainOu)
The Active Directory organizational unit for your DB instance to join.
Constraints:
Must be in the distinguished name format.
Can't be longer than 64 characters.
Example: OU=mymanagedADtestOU,DC=mymanagedADtest,DC=mymanagedAD,DC=mydomain
domainOu
- The Active Directory organizational unit for your DB instance to join.
Constraints:
Must be in the distinguished name format.
Can't be longer than 64 characters.
Example: OU=mymanagedADtestOU,DC=mymanagedADtest,DC=mymanagedAD,DC=mydomain
public void setDomainAuthSecretArn(String domainAuthSecretArn)
The ARN for the Secrets Manager secret with the credentials for the user joining the domain.
Example: arn:aws:secretsmanager:region:account-number:secret:myselfmanagedADtestsecret-123456
domainAuthSecretArn
- The ARN for the Secrets Manager secret with the credentials for the user joining the domain.
Example: arn:aws:secretsmanager:region:account-number:secret:myselfmanagedADtestsecret-123456
public String getDomainAuthSecretArn()
The ARN for the Secrets Manager secret with the credentials for the user joining the domain.
Example: arn:aws:secretsmanager:region:account-number:secret:myselfmanagedADtestsecret-123456
Example:
arn:aws:secretsmanager:region:account-number:secret:myselfmanagedADtestsecret-123456
public ModifyDBInstanceRequest withDomainAuthSecretArn(String domainAuthSecretArn)
The ARN for the Secrets Manager secret with the credentials for the user joining the domain.
Example: arn:aws:secretsmanager:region:account-number:secret:myselfmanagedADtestsecret-123456
domainAuthSecretArn
- The ARN for the Secrets Manager secret with the credentials for the user joining the domain.
Example: arn:aws:secretsmanager:region:account-number:secret:myselfmanagedADtestsecret-123456
public List<String> getDomainDnsIps()
The IPv4 DNS IP addresses of your primary and secondary Active Directory domain controllers.
Constraints:
Two IP addresses must be provided. If there isn't a secondary domain controller, use the IP address of the primary domain controller for both entries in the list.
Example: 123.124.125.126,234.235.236.237
Constraints:
Two IP addresses must be provided. If there isn't a secondary domain controller, use the IP address of the primary domain controller for both entries in the list.
Example: 123.124.125.126,234.235.236.237
public void setDomainDnsIps(Collection<String> domainDnsIps)
The IPv4 DNS IP addresses of your primary and secondary Active Directory domain controllers.
Constraints:
Two IP addresses must be provided. If there isn't a secondary domain controller, use the IP address of the primary domain controller for both entries in the list.
Example: 123.124.125.126,234.235.236.237
domainDnsIps
- The IPv4 DNS IP addresses of your primary and secondary Active Directory domain controllers.
Constraints:
Two IP addresses must be provided. If there isn't a secondary domain controller, use the IP address of the primary domain controller for both entries in the list.
Example: 123.124.125.126,234.235.236.237
public ModifyDBInstanceRequest withDomainDnsIps(String... domainDnsIps)
The IPv4 DNS IP addresses of your primary and secondary Active Directory domain controllers.
Constraints:
Two IP addresses must be provided. If there isn't a secondary domain controller, use the IP address of the primary domain controller for both entries in the list.
Example: 123.124.125.126,234.235.236.237
NOTE: This method appends the values to the existing list (if any). Use
setDomainDnsIps(java.util.Collection)
or withDomainDnsIps(java.util.Collection)
if you want to
override the existing values.
domainDnsIps
- The IPv4 DNS IP addresses of your primary and secondary Active Directory domain controllers.
Constraints:
Two IP addresses must be provided. If there isn't a secondary domain controller, use the IP address of the primary domain controller for both entries in the list.
Example: 123.124.125.126,234.235.236.237
public ModifyDBInstanceRequest withDomainDnsIps(Collection<String> domainDnsIps)
The IPv4 DNS IP addresses of your primary and secondary Active Directory domain controllers.
Constraints:
Two IP addresses must be provided. If there isn't a secondary domain controller, use the IP address of the primary domain controller for both entries in the list.
Example: 123.124.125.126,234.235.236.237
domainDnsIps
- The IPv4 DNS IP addresses of your primary and secondary Active Directory domain controllers.
Constraints:
Two IP addresses must be provided. If there isn't a secondary domain controller, use the IP address of the primary domain controller for both entries in the list.
Example: 123.124.125.126,234.235.236.237
public void setCopyTagsToSnapshot(Boolean copyTagsToSnapshot)
Specifies whether to copy all tags from the DB instance to snapshots of the DB instance. By default, tags aren't copied.
This setting doesn't apply to Amazon Aurora DB instances. 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
- Specifies whether to copy all tags from the DB instance to snapshots of the DB instance. By default, tags
aren't copied.
This setting doesn't apply to Amazon Aurora DB instances. 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()
Specifies whether to copy all tags from the DB instance to snapshots of the DB instance. By default, tags aren't copied.
This setting doesn't apply to Amazon Aurora DB instances. 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
.
This setting doesn't apply to Amazon Aurora DB instances. 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)
Specifies whether to copy all tags from the DB instance to snapshots of the DB instance. By default, tags aren't copied.
This setting doesn't apply to Amazon Aurora DB instances. 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
- Specifies whether to copy all tags from the DB instance to snapshots of the DB instance. By default, tags
aren't copied.
This setting doesn't apply to Amazon Aurora DB instances. 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()
Specifies whether to copy all tags from the DB instance to snapshots of the DB instance. By default, tags aren't copied.
This setting doesn't apply to Amazon Aurora DB instances. 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
.
This setting doesn't apply to Amazon Aurora DB instances. 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 collection of Enhanced Monitoring metrics, specify 0
.
If MonitoringRoleArn
is specified, set MonitoringInterval
to a value other than
0
.
This setting doesn't apply to RDS Custom DB instances.
Valid Values: 0 | 1 | 5 | 10 | 15 | 30 | 60
Default: 0
monitoringInterval
- The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB
instance. To disable collection of Enhanced Monitoring metrics, specify 0
.
If MonitoringRoleArn
is specified, set MonitoringInterval
to a value other than
0
.
This setting doesn't apply to RDS Custom DB instances.
Valid Values: 0 | 1 | 5 | 10 | 15 | 30 | 60
Default: 0
public Integer getMonitoringInterval()
The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB instance. To
disable collection of Enhanced Monitoring metrics, specify 0
.
If MonitoringRoleArn
is specified, set MonitoringInterval
to a value other than
0
.
This setting doesn't apply to RDS Custom DB instances.
Valid Values: 0 | 1 | 5 | 10 | 15 | 30 | 60
Default: 0
0
.
If MonitoringRoleArn
is specified, set MonitoringInterval
to a value other than
0
.
This setting doesn't apply to RDS Custom DB instances.
Valid Values: 0 | 1 | 5 | 10 | 15 | 30 | 60
Default: 0
public ModifyDBInstanceRequest withMonitoringInterval(Integer monitoringInterval)
The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB instance. To
disable collection of Enhanced Monitoring metrics, specify 0
.
If MonitoringRoleArn
is specified, set MonitoringInterval
to a value other than
0
.
This setting doesn't apply to RDS Custom DB instances.
Valid Values: 0 | 1 | 5 | 10 | 15 | 30 | 60
Default: 0
monitoringInterval
- The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB
instance. To disable collection of Enhanced Monitoring metrics, specify 0
.
If MonitoringRoleArn
is specified, set MonitoringInterval
to a value other than
0
.
This setting doesn't apply to RDS Custom DB instances.
Valid Values: 0 | 1 | 5 | 10 | 15 | 30 | 60
Default: 0
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 DB instances.
Valid Values: 1150-65535
Default:
Amazon Aurora - 3306
RDS for Db2 - 50000
RDS for MariaDB - 3306
RDS for Microsoft SQL Server - 1433
RDS for MySQL - 3306
RDS for Oracle - 1521
RDS for PostgreSQL - 5432
Constraints:
For RDS for Microsoft SQL Server, the value can't be 1234
, 1434
, 3260
,
3343
, 3389
, 47001
, or 49152-49156
.
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 DB instances.
Valid Values: 1150-65535
Default:
Amazon Aurora - 3306
RDS for Db2 - 50000
RDS for MariaDB - 3306
RDS for Microsoft SQL Server - 1433
RDS for MySQL - 3306
RDS for Oracle - 1521
RDS for PostgreSQL - 5432
Constraints:
For RDS for Microsoft SQL Server, the value can't be 1234
, 1434
,
3260
, 3343
, 3389
, 47001
, or 49152-49156
.
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 DB instances.
Valid Values: 1150-65535
Default:
Amazon Aurora - 3306
RDS for Db2 - 50000
RDS for MariaDB - 3306
RDS for Microsoft SQL Server - 1433
RDS for MySQL - 3306
RDS for Oracle - 1521
RDS for PostgreSQL - 5432
Constraints:
For RDS for Microsoft SQL Server, the value can't be 1234
, 1434
, 3260
,
3343
, 3389
, 47001
, or 49152-49156
.
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 DB instances.
Valid Values: 1150-65535
Default:
Amazon Aurora - 3306
RDS for Db2 - 50000
RDS for MariaDB - 3306
RDS for Microsoft SQL Server - 1433
RDS for MySQL - 3306
RDS for Oracle - 1521
RDS for PostgreSQL - 5432
Constraints:
For RDS for Microsoft SQL Server, the value can't be 1234
, 1434
,
3260
, 3343
, 3389
, 47001
, or 49152-49156
.
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 DB instances.
Valid Values: 1150-65535
Default:
Amazon Aurora - 3306
RDS for Db2 - 50000
RDS for MariaDB - 3306
RDS for Microsoft SQL Server - 1433
RDS for MySQL - 3306
RDS for Oracle - 1521
RDS for PostgreSQL - 5432
Constraints:
For RDS for Microsoft SQL Server, the value can't be 1234
, 1434
, 3260
,
3343
, 3389
, 47001
, or 49152-49156
.
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 DB instances.
Valid Values: 1150-65535
Default:
Amazon Aurora - 3306
RDS for Db2 - 50000
RDS for MariaDB - 3306
RDS for Microsoft SQL Server - 1433
RDS for MySQL - 3306
RDS for Oracle - 1521
RDS for PostgreSQL - 5432
Constraints:
For RDS for Microsoft SQL Server, the value can't be 1234
, 1434
,
3260
, 3343
, 3389
, 47001
, or 49152-49156
.
public void setPubliclyAccessible(Boolean publiclyAccessible)
Specifies whether the DB instance is publicly accessible.
When the DB instance is publicly accessible and you connect from outside of the DB instance's virtual private cloud (VPC), its Domain Name System (DNS) endpoint resolves to the public IP address. When you connect from within the same VPC as the DB instance, the endpoint resolves to the private IP address. Access to the DB instance is ultimately controlled by the security group it uses. That public access isn't permitted if the security group assigned to the DB instance 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
- Specifies whether the DB instance is publicly accessible.
When the DB instance is publicly accessible and you connect from outside of the DB instance's virtual private cloud (VPC), its Domain Name System (DNS) endpoint resolves to the public IP address. When you connect from within the same VPC as the DB instance, the endpoint resolves to the private IP address. Access to the DB instance is ultimately controlled by the security group it uses. That public access isn't permitted if the security group assigned to the DB instance 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()
Specifies whether the DB instance is publicly accessible.
When the DB instance is publicly accessible and you connect from outside of the DB instance's virtual private cloud (VPC), its Domain Name System (DNS) endpoint resolves to the public IP address. When you connect from within the same VPC as the DB instance, the endpoint resolves to the private IP address. Access to the DB instance is ultimately controlled by the security group it uses. That public access isn't permitted if the security group assigned to the DB instance 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 instance is publicly accessible and you connect from outside of the DB instance's virtual private cloud (VPC), its Domain Name System (DNS) endpoint resolves to the public IP address. When you connect from within the same VPC as the DB instance, the endpoint resolves to the private IP address. Access to the DB instance is ultimately controlled by the security group it uses. That public access isn't permitted if the security group assigned to the DB instance 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)
Specifies whether the DB instance is publicly accessible.
When the DB instance is publicly accessible and you connect from outside of the DB instance's virtual private cloud (VPC), its Domain Name System (DNS) endpoint resolves to the public IP address. When you connect from within the same VPC as the DB instance, the endpoint resolves to the private IP address. Access to the DB instance is ultimately controlled by the security group it uses. That public access isn't permitted if the security group assigned to the DB instance 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
- Specifies whether the DB instance is publicly accessible.
When the DB instance is publicly accessible and you connect from outside of the DB instance's virtual private cloud (VPC), its Domain Name System (DNS) endpoint resolves to the public IP address. When you connect from within the same VPC as the DB instance, the endpoint resolves to the private IP address. Access to the DB instance is ultimately controlled by the security group it uses. That public access isn't permitted if the security group assigned to the DB instance 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()
Specifies whether the DB instance is publicly accessible.
When the DB instance is publicly accessible and you connect from outside of the DB instance's virtual private cloud (VPC), its Domain Name System (DNS) endpoint resolves to the public IP address. When you connect from within the same VPC as the DB instance, the endpoint resolves to the private IP address. Access to the DB instance is ultimately controlled by the security group it uses. That public access isn't permitted if the security group assigned to the DB instance 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 instance is publicly accessible and you connect from outside of the DB instance's virtual private cloud (VPC), its Domain Name System (DNS) endpoint resolves to the public IP address. When you connect from within the same VPC as the DB instance, the endpoint resolves to the private IP address. Access to the DB instance is ultimately controlled by the security group it uses. That public access isn't permitted if the security group assigned to the DB instance 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 DB instances.
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 DB instances.
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 DB instances.
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 DB instances.
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 DB instances.
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 DB instances.
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 DB instances.
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 DB instances.
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 DB instances.
This setting doesn't apply to RDS Custom DB instances.
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 DB instances.
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 DB instances.
public void setDisableDomain(Boolean disableDomain)
Specifies whether to remove the DB instance from the Active Directory domain.
disableDomain
- Specifies whether to remove the DB instance from the Active Directory domain.public Boolean getDisableDomain()
Specifies whether to remove the DB instance from the Active Directory domain.
public ModifyDBInstanceRequest withDisableDomain(Boolean disableDomain)
Specifies whether to remove the DB instance from the Active Directory domain.
disableDomain
- Specifies whether to remove the DB instance from the Active Directory domain.public Boolean isDisableDomain()
Specifies whether to remove the DB instance from the Active Directory domain.
public void setPromotionTier(Integer promotionTier)
The order of priority 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 DB instances.
Default: 1
Valid Values: 0 - 15
promotionTier
- The order of priority 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 DB instances.
Default: 1
Valid Values: 0 - 15
public Integer getPromotionTier()
The order of priority 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 DB instances.
Default: 1
Valid Values: 0 - 15
This setting doesn't apply to RDS Custom DB instances.
Default: 1
Valid Values: 0 - 15
public ModifyDBInstanceRequest withPromotionTier(Integer promotionTier)
The order of priority 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 DB instances.
Default: 1
Valid Values: 0 - 15
promotionTier
- The order of priority 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 DB instances.
Default: 1
Valid Values: 0 - 15
public void setEnableIAMDatabaseAuthentication(Boolean enableIAMDatabaseAuthentication)
Specifies 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 DB instances.
enableIAMDatabaseAuthentication
- Specifies 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 DB instances.
public Boolean getEnableIAMDatabaseAuthentication()
Specifies 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 DB instances.
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 DB instances.
public ModifyDBInstanceRequest withEnableIAMDatabaseAuthentication(Boolean enableIAMDatabaseAuthentication)
Specifies 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 DB instances.
enableIAMDatabaseAuthentication
- Specifies 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 DB instances.
public Boolean isEnableIAMDatabaseAuthentication()
Specifies 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 DB instances.
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 DB instances.
public void setEnablePerformanceInsights(Boolean enablePerformanceInsights)
Specifies 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 DB instances.
enablePerformanceInsights
- Specifies 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 DB instances.
public Boolean getEnablePerformanceInsights()
Specifies 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 DB instances.
For more information, see Using Amazon Performance Insights in the Amazon RDS User Guide.
This setting doesn't apply to RDS Custom DB instances.
public ModifyDBInstanceRequest withEnablePerformanceInsights(Boolean enablePerformanceInsights)
Specifies 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 DB instances.
enablePerformanceInsights
- Specifies 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 DB instances.
public Boolean isEnablePerformanceInsights()
Specifies 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 DB instances.
For more information, see Using Amazon Performance Insights in the Amazon RDS User Guide.
This setting doesn't apply to RDS Custom DB instances.
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 don't 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 DB instances.
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 don't 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 DB instances.
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 don't 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 DB instances.
The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.
If you don't 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 DB instances.
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 don't 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 DB instances.
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 don't 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 DB instances.
public void setPerformanceInsightsRetentionPeriod(Integer performanceInsightsRetentionPeriod)
The number of days to retain Performance Insights data.
This setting doesn't apply to RDS Custom DB instances.
Valid Values:
7
month * 31, where month is a number of months from 1-23. Examples: 93
(3 months * 31),
341
(11 months * 31), 589
(19 months * 31)
731
Default: 7
days
If you specify a retention period that isn't valid, such as 94
, Amazon RDS returns an error.
performanceInsightsRetentionPeriod
- The number of days to retain Performance Insights data.
This setting doesn't apply to RDS Custom DB instances.
Valid Values:
7
month * 31, where month is a number of months from 1-23. Examples: 93
(3 months
* 31), 341
(11 months * 31), 589
(19 months * 31)
731
Default: 7
days
If you specify a retention period that isn't valid, such as 94
, Amazon RDS returns an error.
public Integer getPerformanceInsightsRetentionPeriod()
The number of days to retain Performance Insights data.
This setting doesn't apply to RDS Custom DB instances.
Valid Values:
7
month * 31, where month is a number of months from 1-23. Examples: 93
(3 months * 31),
341
(11 months * 31), 589
(19 months * 31)
731
Default: 7
days
If you specify a retention period that isn't valid, such as 94
, Amazon RDS returns an error.
This setting doesn't apply to RDS Custom DB instances.
Valid Values:
7
month * 31, where month is a number of months from 1-23. Examples: 93
(3
months * 31), 341
(11 months * 31), 589
(19 months * 31)
731
Default: 7
days
If you specify a retention period that isn't valid, such as 94
, Amazon RDS returns an error.
public ModifyDBInstanceRequest withPerformanceInsightsRetentionPeriod(Integer performanceInsightsRetentionPeriod)
The number of days to retain Performance Insights data.
This setting doesn't apply to RDS Custom DB instances.
Valid Values:
7
month * 31, where month is a number of months from 1-23. Examples: 93
(3 months * 31),
341
(11 months * 31), 589
(19 months * 31)
731
Default: 7
days
If you specify a retention period that isn't valid, such as 94
, Amazon RDS returns an error.
performanceInsightsRetentionPeriod
- The number of days to retain Performance Insights data.
This setting doesn't apply to RDS Custom DB instances.
Valid Values:
7
month * 31, where month is a number of months from 1-23. Examples: 93
(3 months
* 31), 341
(11 months * 31), 589
(19 months * 31)
731
Default: 7
days
If you specify a retention period that isn't valid, such as 94
, Amazon RDS returns an error.
public void setCloudwatchLogsExportConfiguration(CloudwatchLogsExportConfiguration cloudwatchLogsExportConfiguration)
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 DB instances.
cloudwatchLogsExportConfiguration
- 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 DB instances.
public CloudwatchLogsExportConfiguration getCloudwatchLogsExportConfiguration()
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 DB instances.
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 DB instances.
public ModifyDBInstanceRequest withCloudwatchLogsExportConfiguration(CloudwatchLogsExportConfiguration cloudwatchLogsExportConfiguration)
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 DB instances.
cloudwatchLogsExportConfiguration
- 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 DB instances.
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 DB instances.
This setting doesn't apply to RDS Custom DB instances.
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 DB instances.
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 DB instances.
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 DB instances.
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 DB instances.
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 DB instances.
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 DB instances.
public void setUseDefaultProcessorFeatures(Boolean useDefaultProcessorFeatures)
Specifies whether the DB instance class of the DB instance uses its default processor features.
This setting doesn't apply to RDS Custom DB instances.
useDefaultProcessorFeatures
- Specifies whether the DB instance class of the DB instance uses its default processor features.
This setting doesn't apply to RDS Custom DB instances.
public Boolean getUseDefaultProcessorFeatures()
Specifies whether the DB instance class of the DB instance uses its default processor features.
This setting doesn't apply to RDS Custom DB instances.
This setting doesn't apply to RDS Custom DB instances.
public ModifyDBInstanceRequest withUseDefaultProcessorFeatures(Boolean useDefaultProcessorFeatures)
Specifies whether the DB instance class of the DB instance uses its default processor features.
This setting doesn't apply to RDS Custom DB instances.
useDefaultProcessorFeatures
- Specifies whether the DB instance class of the DB instance uses its default processor features.
This setting doesn't apply to RDS Custom DB instances.
public Boolean isUseDefaultProcessorFeatures()
Specifies whether the DB instance class of the DB instance uses its default processor features.
This setting doesn't apply to RDS Custom DB instances.
This setting doesn't apply to RDS Custom DB instances.
public void setDeletionProtection(Boolean deletionProtection)
Specifies 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.
This setting doesn't apply to Amazon Aurora DB instances. You can enable or disable deletion protection for the
DB cluster. For more information, see ModifyDBCluster
. DB instances in a DB cluster can be deleted
even when deletion protection is enabled for the DB cluster.
deletionProtection
- Specifies 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.
This setting doesn't apply to Amazon Aurora DB instances. You can enable or disable deletion protection
for the DB cluster. For more information, see ModifyDBCluster
. DB instances in a DB cluster
can be deleted even when deletion protection is enabled for the DB cluster.
public Boolean getDeletionProtection()
Specifies 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.
This setting doesn't apply to Amazon Aurora DB instances. You can enable or disable deletion protection for the
DB cluster. For more information, see ModifyDBCluster
. DB instances in a DB cluster can be deleted
even when deletion protection is enabled for the DB cluster.
This setting doesn't apply to Amazon Aurora DB instances. You can enable or disable deletion protection
for the DB cluster. For more information, see ModifyDBCluster
. DB instances in a DB cluster
can be deleted even when deletion protection is enabled for the DB cluster.
public ModifyDBInstanceRequest withDeletionProtection(Boolean deletionProtection)
Specifies 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.
This setting doesn't apply to Amazon Aurora DB instances. You can enable or disable deletion protection for the
DB cluster. For more information, see ModifyDBCluster
. DB instances in a DB cluster can be deleted
even when deletion protection is enabled for the DB cluster.
deletionProtection
- Specifies 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.
This setting doesn't apply to Amazon Aurora DB instances. You can enable or disable deletion protection
for the DB cluster. For more information, see ModifyDBCluster
. DB instances in a DB cluster
can be deleted even when deletion protection is enabled for the DB cluster.
public Boolean isDeletionProtection()
Specifies 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.
This setting doesn't apply to Amazon Aurora DB instances. You can enable or disable deletion protection for the
DB cluster. For more information, see ModifyDBCluster
. DB instances in a DB cluster can be deleted
even when deletion protection is enabled for the DB cluster.
This setting doesn't apply to Amazon Aurora DB instances. You can enable or disable deletion protection
for the DB cluster. For more information, see ModifyDBCluster
. DB instances in a DB cluster
can be deleted even when deletion protection is enabled for the DB cluster.
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 DB instances.
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 DB instances.
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 DB instances.
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 DB instances.
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 DB instances.
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 DB instances.
public void setCertificateRotationRestart(Boolean certificateRotationRestart)
Specifies 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 DB instances.
certificateRotationRestart
- Specifies 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 DB instances.
public Boolean getCertificateRotationRestart()
Specifies 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 DB instances.
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 DB instances.
public ModifyDBInstanceRequest withCertificateRotationRestart(Boolean certificateRotationRestart)
Specifies 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 DB instances.
certificateRotationRestart
- Specifies 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 DB instances.
public Boolean isCertificateRotationRestart()
Specifies 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 DB instances.
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 DB instances.
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 DB instances.
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 DB instances.
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 DB instances.
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 DB instances.
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 DB instances.
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 DB instances.
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 DB instances.
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 DB instances.
ReplicaMode
public void setEnableCustomerOwnedIp(Boolean enableCustomerOwnedIp)
Specifies 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
- Specifies 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()
Specifies 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)
Specifies 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
- Specifies 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()
Specifies 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 DB instances.
awsBackupRecoveryPointArn
- The Amazon Resource Name (ARN) of the recovery point in Amazon Web Services Backup.
This setting doesn't apply to RDS Custom DB instances.
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 DB instances.
This setting doesn't apply to RDS Custom DB instances.
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 DB instances.
awsBackupRecoveryPointArn
- The Amazon Resource Name (ARN) of the recovery point in Amazon Web Services Backup.
This setting doesn't apply to RDS Custom DB instances.
public void setAutomationMode(String automationMode)
The automation mode of the RDS Custom DB instance. 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. 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. If full
, the DB instance automates monitoring and
instance recovery. If all paused
, the instance pauses automation for the duration set by
ResumeFullAutomationModeMinutes
.
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. 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. 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. 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. 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.
Default: 60
Constraints:
Must be at least 60.
Must be no more than 1,440.
resumeFullAutomationModeMinutes
- The number of minutes to pause the automation. When the time period ends, RDS Custom resumes full
automation.
Default: 60
Constraints:
Must be at least 60.
Must be no more than 1,440.
public Integer getResumeFullAutomationModeMinutes()
The number of minutes to pause the automation. When the time period ends, RDS Custom resumes full automation.
Default: 60
Constraints:
Must be at least 60.
Must be no more than 1,440.
Default: 60
Constraints:
Must be at least 60.
Must be no more than 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.
Default: 60
Constraints:
Must be at least 60.
Must be no more than 1,440.
resumeFullAutomationModeMinutes
- The number of minutes to pause the automation. When the time period ends, RDS Custom resumes full
automation.
Default: 60
Constraints:
Must be at least 60.
Must be no more than 1,440.
public void setNetworkType(String networkType)
The network type of the DB instance.
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
networkType
- The network type of the DB instance.
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
public String getNetworkType()
The network type of the DB instance.
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.
Valid Values: IPV4 | DUAL
public ModifyDBInstanceRequest withNetworkType(String networkType)
The network type of the DB instance.
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
networkType
- The network type of the DB instance.
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
public void setStorageThroughput(Integer storageThroughput)
The storage throughput value for the DB instance.
This setting applies only to the gp3
storage type.
This setting doesn't apply to Amazon Aurora or RDS Custom DB instances.
storageThroughput
- The storage throughput value for the DB instance.
This setting applies only to the gp3
storage type.
This setting doesn't apply to Amazon Aurora or RDS Custom DB instances.
public Integer getStorageThroughput()
The storage throughput value for the DB instance.
This setting applies only to the gp3
storage type.
This setting doesn't apply to Amazon Aurora or RDS Custom DB instances.
This setting applies only to the gp3
storage type.
This setting doesn't apply to Amazon Aurora or RDS Custom DB instances.
public ModifyDBInstanceRequest withStorageThroughput(Integer storageThroughput)
The storage throughput value for the DB instance.
This setting applies only to the gp3
storage type.
This setting doesn't apply to Amazon Aurora or RDS Custom DB instances.
storageThroughput
- The storage throughput value for the DB instance.
This setting applies only to the gp3
storage type.
This setting doesn't apply to Amazon Aurora or RDS Custom DB instances.
public void setManageMasterUserPassword(Boolean manageMasterUserPassword)
Specifies 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, Amazon 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
- Specifies 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, Amazon 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()
Specifies 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, Amazon 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, Amazon 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)
Specifies 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, Amazon 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
- Specifies 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, Amazon 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()
Specifies 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, Amazon 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, Amazon 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)
Specifies 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
- Specifies 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()
Specifies 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)
Specifies 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
- Specifies 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()
Specifies 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 void setDedicatedLogVolume(Boolean dedicatedLogVolume)
Indicates whether the DB instance has a dedicated log volume (DLV) enabled.
dedicatedLogVolume
- Indicates whether the DB instance has a dedicated log volume (DLV) enabled.public Boolean getDedicatedLogVolume()
Indicates whether the DB instance has a dedicated log volume (DLV) enabled.
public ModifyDBInstanceRequest withDedicatedLogVolume(Boolean dedicatedLogVolume)
Indicates whether the DB instance has a dedicated log volume (DLV) enabled.
dedicatedLogVolume
- Indicates whether the DB instance has a dedicated log volume (DLV) enabled.public Boolean isDedicatedLogVolume()
Indicates whether the DB instance has a dedicated log volume (DLV) enabled.
public void setMultiTenant(Boolean multiTenant)
Specifies whether the to convert your DB instance from the single-tenant configuration to the multi-tenant configuration. This parameter is supported only for RDS for Oracle CDB instances.
During the conversion, RDS creates an initial tenant database and associates the DB name, master user name,
character set, and national character set metadata with this database. The tags associated with the instance also
propagate to the initial tenant database. You can add more tenant databases to your DB instance by using the
CreateTenantDatabase
operation.
The conversion to the multi-tenant configuration is permanent and irreversible, so you can't later convert back
to the single-tenant configuration. When you specify this parameter, you must also specify
ApplyImmediately
.
multiTenant
- Specifies whether the to convert your DB instance from the single-tenant configuration to the multi-tenant
configuration. This parameter is supported only for RDS for Oracle CDB instances.
During the conversion, RDS creates an initial tenant database and associates the DB name, master user
name, character set, and national character set metadata with this database. The tags associated with the
instance also propagate to the initial tenant database. You can add more tenant databases to your DB
instance by using the CreateTenantDatabase
operation.
The conversion to the multi-tenant configuration is permanent and irreversible, so you can't later convert
back to the single-tenant configuration. When you specify this parameter, you must also specify
ApplyImmediately
.
public Boolean getMultiTenant()
Specifies whether the to convert your DB instance from the single-tenant configuration to the multi-tenant configuration. This parameter is supported only for RDS for Oracle CDB instances.
During the conversion, RDS creates an initial tenant database and associates the DB name, master user name,
character set, and national character set metadata with this database. The tags associated with the instance also
propagate to the initial tenant database. You can add more tenant databases to your DB instance by using the
CreateTenantDatabase
operation.
The conversion to the multi-tenant configuration is permanent and irreversible, so you can't later convert back
to the single-tenant configuration. When you specify this parameter, you must also specify
ApplyImmediately
.
During the conversion, RDS creates an initial tenant database and associates the DB name, master user
name, character set, and national character set metadata with this database. The tags associated with the
instance also propagate to the initial tenant database. You can add more tenant databases to your DB
instance by using the CreateTenantDatabase
operation.
The conversion to the multi-tenant configuration is permanent and irreversible, so you can't later
convert back to the single-tenant configuration. When you specify this parameter, you must also specify
ApplyImmediately
.
public ModifyDBInstanceRequest withMultiTenant(Boolean multiTenant)
Specifies whether the to convert your DB instance from the single-tenant configuration to the multi-tenant configuration. This parameter is supported only for RDS for Oracle CDB instances.
During the conversion, RDS creates an initial tenant database and associates the DB name, master user name,
character set, and national character set metadata with this database. The tags associated with the instance also
propagate to the initial tenant database. You can add more tenant databases to your DB instance by using the
CreateTenantDatabase
operation.
The conversion to the multi-tenant configuration is permanent and irreversible, so you can't later convert back
to the single-tenant configuration. When you specify this parameter, you must also specify
ApplyImmediately
.
multiTenant
- Specifies whether the to convert your DB instance from the single-tenant configuration to the multi-tenant
configuration. This parameter is supported only for RDS for Oracle CDB instances.
During the conversion, RDS creates an initial tenant database and associates the DB name, master user
name, character set, and national character set metadata with this database. The tags associated with the
instance also propagate to the initial tenant database. You can add more tenant databases to your DB
instance by using the CreateTenantDatabase
operation.
The conversion to the multi-tenant configuration is permanent and irreversible, so you can't later convert
back to the single-tenant configuration. When you specify this parameter, you must also specify
ApplyImmediately
.
public Boolean isMultiTenant()
Specifies whether the to convert your DB instance from the single-tenant configuration to the multi-tenant configuration. This parameter is supported only for RDS for Oracle CDB instances.
During the conversion, RDS creates an initial tenant database and associates the DB name, master user name,
character set, and national character set metadata with this database. The tags associated with the instance also
propagate to the initial tenant database. You can add more tenant databases to your DB instance by using the
CreateTenantDatabase
operation.
The conversion to the multi-tenant configuration is permanent and irreversible, so you can't later convert back
to the single-tenant configuration. When you specify this parameter, you must also specify
ApplyImmediately
.
During the conversion, RDS creates an initial tenant database and associates the DB name, master user
name, character set, and national character set metadata with this database. The tags associated with the
instance also propagate to the initial tenant database. You can add more tenant databases to your DB
instance by using the CreateTenantDatabase
operation.
The conversion to the multi-tenant configuration is permanent and irreversible, so you can't later
convert back to the single-tenant configuration. When you specify this parameter, you must also specify
ApplyImmediately
.
public String toString()
toString
in class Object
Object.toString()
public ModifyDBInstanceRequest clone()
AmazonWebServiceRequest
clone
in class AmazonWebServiceRequest
Object.clone()