com.amazonaws.services.rds.model.ModifyDBInstanceRequest Maven / Gradle / Ivy
Show all versions of aws-java-sdk-rds Show documentation
/*
* Copyright 2019-2024 Amazon.com, Inc. or its affiliates. All Rights Reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License"). You may not use this file except in compliance with
* the License. A copy of the License is located at
*
* http://aws.amazon.com/apache2.0
*
* or in the "license" file accompanying this file. This file is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR
* CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions
* and limitations under the License.
*/
package com.amazonaws.services.rds.model;
import java.io.Serializable;
import javax.annotation.Generated;
import com.amazonaws.AmazonWebServiceRequest;
/**
*
*
* @see AWS API
* Documentation
*/
@Generated("com.amazonaws:aws-java-sdk-code-generator")
public class ModifyDBInstanceRequest extends com.amazonaws.AmazonWebServiceRequest implements Serializable, Cloneable {
/**
*
* 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.
*
*
*
*/
private String dBInstanceIdentifier;
/**
*
* 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
.
*
*
*
*/
private Integer allocatedStorage;
/**
*
* 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.
*
*
*
*/
private String dBInstanceClass;
/**
*
* 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
*
*/
private String dBSubnetGroupName;
/**
*
* 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.
*
*
*
*/
private com.amazonaws.internal.SdkInternalList dBSecurityGroups;
/**
*
* 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.
*
*
*
*/
private com.amazonaws.internal.SdkInternalList vpcSecurityGroupIds;
/**
*
* 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.
*
*/
private Boolean applyImmediately;
/**
*
* 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.
*
*
*
*/
private String masterUserPassword;
/**
*
* 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.
*
*
*
*/
private String dBParameterGroupName;
/**
*
* 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.
*
*
*
*/
private Integer backupRetentionPeriod;
/**
*
* 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.
*
*
*
*/
private String preferredBackupWindow;
/**
*
* 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.
*
*
*
*/
private String preferredMaintenanceWindow;
/**
*
* 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.
*
*/
private Boolean multiAZ;
/**
*
* 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.
*
*
*
*/
private String engineVersion;
/**
*
* 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.
*
*
*
*/
private Boolean allowMajorVersionUpgrade;
/**
*
* 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.
*
*/
private Boolean autoMinorVersionUpgrade;
/**
*
* 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
*
*
*
*/
private String licenseModel;
/**
*
* 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
*
*/
private Integer iops;
/**
*
* 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.
*
*/
private String optionGroupName;
/**
*
* 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
*
*/
private String newDBInstanceIdentifier;
/**
*
* 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
.
*
*/
private String storageType;
/**
*
* 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.
*
*/
private String tdeCredentialArn;
/**
*
* 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.
*
*/
private String tdeCredentialPassword;
/**
*
* 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.
*
*/
private String cACertificateIdentifier;
/**
*
* 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.
*
*/
private String domain;
/**
*
* The fully qualified domain name (FQDN) of an Active Directory domain.
*
*
* Constraints:
*
*
* -
*
* Can't be longer than 64 characters.
*
*
*
*
* Example: mymanagedADtest.mymanagedAD.mydomain
*
*/
private String domainFqdn;
/**
*
* 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
*
*/
private String domainOu;
/**
*
* 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
*
*/
private String domainAuthSecretArn;
/**
*
* 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
*
*/
private com.amazonaws.internal.SdkInternalList domainDnsIps;
/**
*
* 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
.
*
*/
private Boolean copyTagsToSnapshot;
/**
*
* 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
*
*/
private Integer monitoringInterval;
/**
*
* 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
.
*
*
*
*/
private Integer dBPortNumber;
/**
*
* 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.
*
*/
private Boolean publiclyAccessible;
/**
*
* 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.
*
*/
private String monitoringRoleArn;
/**
*
* 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.
*
*/
private String domainIAMRoleName;
/**
*
* Specifies whether to remove the DB instance from the Active Directory domain.
*
*/
private Boolean disableDomain;
/**
*
* 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
*
*/
private Integer promotionTier;
/**
*
* 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.
*
*/
private Boolean enableIAMDatabaseAuthentication;
/**
*
* 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.
*
*/
private Boolean enablePerformanceInsights;
/**
*
* 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.
*
*/
private String performanceInsightsKMSKeyId;
/**
*
* 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.
*
*/
private Integer performanceInsightsRetentionPeriod;
/**
*
* 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.
*
*/
private CloudwatchLogsExportConfiguration cloudwatchLogsExportConfiguration;
/**
*
* 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.
*
*/
private com.amazonaws.internal.SdkInternalList processorFeatures;
/**
*
* 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.
*
*/
private Boolean useDefaultProcessorFeatures;
/**
*
* 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.
*
*/
private Boolean deletionProtection;
/**
*
* 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.
*
*/
private Integer maxAllocatedStorage;
/**
*
* 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.
*
*/
private Boolean certificateRotationRestart;
/**
*
* 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.
*
*/
private String replicaMode;
/**
*
* 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.
*
*/
private Boolean enableCustomerOwnedIp;
/**
*
* The Amazon Resource Name (ARN) of the recovery point in Amazon Web Services Backup.
*
*
* This setting doesn't apply to RDS Custom DB instances.
*
*/
private String awsBackupRecoveryPointArn;
/**
*
* 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
.
*
*/
private String automationMode;
/**
*
* 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.
*
*
*
*/
private Integer resumeFullAutomationModeMinutes;
/**
*
* 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
*
*/
private String networkType;
/**
*
* 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.
*
*/
private Integer storageThroughput;
/**
*
* 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.
*
*
*
*/
private Boolean manageMasterUserPassword;
/**
*
* 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.
*
*
*
*/
private Boolean rotateMasterUserPassword;
/**
*
* 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.
*
*/
private String masterUserSecretKmsKeyId;
/**
*
* 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
.
*
*
*
*/
private String engine;
/**
*
* Indicates whether the DB instance has a dedicated log volume (DLV) enabled.
*
*/
private Boolean dedicatedLogVolume;
/**
*
* 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
.
*
*
*/
private Boolean multiTenant;
/**
* Default constructor for ModifyDBInstanceRequest object. Callers should use the setter or fluent setter (with...)
* methods to initialize the object after creating it.
*/
public ModifyDBInstanceRequest() {
}
/**
* Constructs a new ModifyDBInstanceRequest object. Callers should use the setter or fluent setter (with...) methods
* to initialize any additional object members.
*
* @param 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 ModifyDBInstanceRequest(String dBInstanceIdentifier) {
setDBInstanceIdentifier(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.
*
*
*
*
* @param 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) {
this.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.
*
*
*
*
* @return 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() {
return this.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.
*
*
*
*
* @param 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.
*
*
* @return Returns a reference to this object so that method calls can be chained together.
*/
public ModifyDBInstanceRequest withDBInstanceIdentifier(String dBInstanceIdentifier) {
setDBInstanceIdentifier(dBInstanceIdentifier);
return this;
}
/**
*
* 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
.
*
*
*
*
* @param 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 setAllocatedStorage(Integer allocatedStorage) {
this.allocatedStorage = 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
.
*
*
*
*
* @return 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() {
return this.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
.
*
*
*
*
* @param 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
.
*
*
* @return Returns a reference to this object so that method calls can be chained together.
*/
public ModifyDBInstanceRequest withAllocatedStorage(Integer allocatedStorage) {
setAllocatedStorage(allocatedStorage);
return this;
}
/**
*
* 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.
*
*
*
*
* @param 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 setDBInstanceClass(String dBInstanceClass) {
this.dBInstanceClass = 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.
*
*
*
*
* @return 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() {
return this.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.
*
*
*
*
* @param 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.
*
*
* @return Returns a reference to this object so that method calls can be chained together.
*/
public ModifyDBInstanceRequest withDBInstanceClass(String dBInstanceClass) {
setDBInstanceClass(dBInstanceClass);
return this;
}
/**
*
* 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
*
*
* @param 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 void setDBSubnetGroupName(String dBSubnetGroupName) {
this.dBSubnetGroupName = 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
*
*
* @return 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() {
return this.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
*
*
* @param 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
* @return Returns a reference to this object so that method calls can be chained together.
*/
public ModifyDBInstanceRequest withDBSubnetGroupName(String dBSubnetGroupName) {
setDBSubnetGroupName(dBSubnetGroupName);
return this;
}
/**
*
* 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.
*
*
*
*
* @return 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 java.util.List getDBSecurityGroups() {
if (dBSecurityGroups == null) {
dBSecurityGroups = new com.amazonaws.internal.SdkInternalList();
}
return 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.
*
*
*
*
* @param 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 void setDBSecurityGroups(java.util.Collection dBSecurityGroups) {
if (dBSecurityGroups == null) {
this.dBSecurityGroups = null;
return;
}
this.dBSecurityGroups = new com.amazonaws.internal.SdkInternalList(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
* {@link #setDBSecurityGroups(java.util.Collection)} or {@link #withDBSecurityGroups(java.util.Collection)} if you
* want to override the existing values.
*
*
* @param 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.
*
*
* @return Returns a reference to this object so that method calls can be chained together.
*/
public ModifyDBInstanceRequest withDBSecurityGroups(String... dBSecurityGroups) {
if (this.dBSecurityGroups == null) {
setDBSecurityGroups(new com.amazonaws.internal.SdkInternalList(dBSecurityGroups.length));
}
for (String ele : dBSecurityGroups) {
this.dBSecurityGroups.add(ele);
}
return this;
}
/**
*
* 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.
*
*
*
*
* @param 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.
*
*
* @return Returns a reference to this object so that method calls can be chained together.
*/
public ModifyDBInstanceRequest withDBSecurityGroups(java.util.Collection dBSecurityGroups) {
setDBSecurityGroups(dBSecurityGroups);
return this;
}
/**
*
* 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.
*
*
*
*
* @return 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 java.util.List getVpcSecurityGroupIds() {
if (vpcSecurityGroupIds == null) {
vpcSecurityGroupIds = new com.amazonaws.internal.SdkInternalList();
}
return 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.
*
*
*
*
* @param 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 setVpcSecurityGroupIds(java.util.Collection vpcSecurityGroupIds) {
if (vpcSecurityGroupIds == null) {
this.vpcSecurityGroupIds = null;
return;
}
this.vpcSecurityGroupIds = new com.amazonaws.internal.SdkInternalList(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
* {@link #setVpcSecurityGroupIds(java.util.Collection)} or {@link #withVpcSecurityGroupIds(java.util.Collection)}
* if you want to override the existing values.
*
*
* @param 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.
*
*
* @return Returns a reference to this object so that method calls can be chained together.
*/
public ModifyDBInstanceRequest withVpcSecurityGroupIds(String... vpcSecurityGroupIds) {
if (this.vpcSecurityGroupIds == null) {
setVpcSecurityGroupIds(new com.amazonaws.internal.SdkInternalList(vpcSecurityGroupIds.length));
}
for (String ele : vpcSecurityGroupIds) {
this.vpcSecurityGroupIds.add(ele);
}
return this;
}
/**
*
* 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.
*
*
*
*
* @param 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.
*
*
* @return Returns a reference to this object so that method calls can be chained together.
*/
public ModifyDBInstanceRequest withVpcSecurityGroupIds(java.util.Collection vpcSecurityGroupIds) {
setVpcSecurityGroupIds(vpcSecurityGroupIds);
return this;
}
/**
*
* 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.
*
*
* @param 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 void setApplyImmediately(Boolean applyImmediately) {
this.applyImmediately = 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.
*
*
* @return 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() {
return this.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.
*
*
* @param 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.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public ModifyDBInstanceRequest withApplyImmediately(Boolean applyImmediately) {
setApplyImmediately(applyImmediately);
return this;
}
/**
*
* 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.
*
*
* @return 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() {
return this.applyImmediately;
}
/**
*
* 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.
*
*
*
*
* @param 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 setMasterUserPassword(String masterUserPassword) {
this.masterUserPassword = 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.
*
*
*
*
* @return 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() {
return this.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.
*
*
*
*
* @param 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.
*
*
* @return Returns a reference to this object so that method calls can be chained together.
*/
public ModifyDBInstanceRequest withMasterUserPassword(String masterUserPassword) {
setMasterUserPassword(masterUserPassword);
return this;
}
/**
*
* 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.
*
*
*
*
* @param 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 setDBParameterGroupName(String dBParameterGroupName) {
this.dBParameterGroupName = 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.
*
*
*
*
* @return 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() {
return this.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.
*
*
*
*
* @param 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.
*
*
* @return Returns a reference to this object so that method calls can be chained together.
*/
public ModifyDBInstanceRequest withDBParameterGroupName(String dBParameterGroupName) {
setDBParameterGroupName(dBParameterGroupName);
return this;
}
/**
*
* 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.
*
*
*
*
* @param 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 setBackupRetentionPeriod(Integer backupRetentionPeriod) {
this.backupRetentionPeriod = 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.
*
*
*
*
* @return 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() {
return this.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.
*
*
*
*
* @param 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.
*
*
* @return Returns a reference to this object so that method calls can be chained together.
*/
public ModifyDBInstanceRequest withBackupRetentionPeriod(Integer backupRetentionPeriod) {
setBackupRetentionPeriod(backupRetentionPeriod);
return this;
}
/**
*
* 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.
*
*
*
*
* @param 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 setPreferredBackupWindow(String preferredBackupWindow) {
this.preferredBackupWindow = 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.
*
*
*
*
* @return 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() {
return this.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.
*
*
*
*
* @param 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.
*
*
* @return Returns a reference to this object so that method calls can be chained together.
*/
public ModifyDBInstanceRequest withPreferredBackupWindow(String preferredBackupWindow) {
setPreferredBackupWindow(preferredBackupWindow);
return this;
}
/**
*
* 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.
*
*
*
*
* @param 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 setPreferredMaintenanceWindow(String preferredMaintenanceWindow) {
this.preferredMaintenanceWindow = 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.
*
*
*
*
* @return 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() {
return this.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.
*
*
*
*
* @param 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.
*
*
* @return Returns a reference to this object so that method calls can be chained together.
*/
public ModifyDBInstanceRequest withPreferredMaintenanceWindow(String preferredMaintenanceWindow) {
setPreferredMaintenanceWindow(preferredMaintenanceWindow);
return this;
}
/**
*
* 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.
*
*
* @param 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 void setMultiAZ(Boolean multiAZ) {
this.multiAZ = 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.
*
*
* @return 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() {
return this.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.
*
*
* @param 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.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public ModifyDBInstanceRequest withMultiAZ(Boolean multiAZ) {
setMultiAZ(multiAZ);
return this;
}
/**
*
* 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.
*
*
* @return 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() {
return this.multiAZ;
}
/**
*
* 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.
*
*
*
*
* @param 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 setEngineVersion(String engineVersion) {
this.engineVersion = 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.
*
*
*
*
* @return 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() {
return this.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.
*
*
*
*
* @param 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.
*
*
* @return Returns a reference to this object so that method calls can be chained together.
*/
public ModifyDBInstanceRequest withEngineVersion(String engineVersion) {
setEngineVersion(engineVersion);
return this;
}
/**
*
* 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.
*
*
*
*
* @param 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 void setAllowMajorVersionUpgrade(Boolean allowMajorVersionUpgrade) {
this.allowMajorVersionUpgrade = 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.
*
*
*
*
* @return 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() {
return this.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.
*
*
*
*
* @param 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.
*
*
* @return Returns a reference to this object so that method calls can be chained together.
*/
public ModifyDBInstanceRequest withAllowMajorVersionUpgrade(Boolean allowMajorVersionUpgrade) {
setAllowMajorVersionUpgrade(allowMajorVersionUpgrade);
return this;
}
/**
*
* 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.
*
*
*
*
* @return 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() {
return this.allowMajorVersionUpgrade;
}
/**
*
* 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.
*
*
* @param 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 void setAutoMinorVersionUpgrade(Boolean autoMinorVersionUpgrade) {
this.autoMinorVersionUpgrade = 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.
*
*
* @return 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() {
return this.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.
*
*
* @param 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.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public ModifyDBInstanceRequest withAutoMinorVersionUpgrade(Boolean autoMinorVersionUpgrade) {
setAutoMinorVersionUpgrade(autoMinorVersionUpgrade);
return this;
}
/**
*
* 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.
*
*
* @return 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() {
return this.autoMinorVersionUpgrade;
}
/**
*
* 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
*
*
*
*
* @param 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 setLicenseModel(String licenseModel) {
this.licenseModel = 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
*
*
*
*
* @return 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() {
return this.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
*
*
*
*
* @param 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
*
*
* @return Returns a reference to this object so that method calls can be chained together.
*/
public ModifyDBInstanceRequest withLicenseModel(String licenseModel) {
setLicenseModel(licenseModel);
return this;
}
/**
*
* 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
*
*
* @param 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 setIops(Integer iops) {
this.iops = 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
*
*
* @return 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() {
return this.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
*
*
* @param 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
* @return Returns a reference to this object so that method calls can be chained together.
*/
public ModifyDBInstanceRequest withIops(Integer iops) {
setIops(iops);
return this;
}
/**
*
* 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.
*
*
* @param 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 setOptionGroupName(String optionGroupName) {
this.optionGroupName = 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.
*
*
* @return 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() {
return this.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.
*
*
* @param 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.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public ModifyDBInstanceRequest withOptionGroupName(String optionGroupName) {
setOptionGroupName(optionGroupName);
return this;
}
/**
*
* 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
*
*
* @param 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 setNewDBInstanceIdentifier(String newDBInstanceIdentifier) {
this.newDBInstanceIdentifier = 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
*
*
* @return 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() {
return this.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
*
*
* @param 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
* @return Returns a reference to this object so that method calls can be chained together.
*/
public ModifyDBInstanceRequest withNewDBInstanceIdentifier(String newDBInstanceIdentifier) {
setNewDBInstanceIdentifier(newDBInstanceIdentifier);
return this;
}
/**
*
* 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
.
*
*
* @param 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 setStorageType(String storageType) {
this.storageType = 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
.
*
*
* @return 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() {
return this.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
.
*
*
* @param 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
.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public ModifyDBInstanceRequest withStorageType(String storageType) {
setStorageType(storageType);
return this;
}
/**
*
* 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.
*
*
* @param 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 setTdeCredentialArn(String tdeCredentialArn) {
this.tdeCredentialArn = 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.
*
*
* @return 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() {
return this.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.
*
*
* @param 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.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public ModifyDBInstanceRequest withTdeCredentialArn(String tdeCredentialArn) {
setTdeCredentialArn(tdeCredentialArn);
return this;
}
/**
*
* 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.
*
*
* @param 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 setTdeCredentialPassword(String tdeCredentialPassword) {
this.tdeCredentialPassword = 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.
*
*
* @return 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() {
return this.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.
*
*
* @param 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.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public ModifyDBInstanceRequest withTdeCredentialPassword(String tdeCredentialPassword) {
setTdeCredentialPassword(tdeCredentialPassword);
return this;
}
/**
*
* 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.
*
*
* @param 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 setCACertificateIdentifier(String cACertificateIdentifier) {
this.cACertificateIdentifier = 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.
*
*
* @return 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() {
return this.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.
*
*
* @param 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.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public ModifyDBInstanceRequest withCACertificateIdentifier(String cACertificateIdentifier) {
setCACertificateIdentifier(cACertificateIdentifier);
return this;
}
/**
*
* 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.
*
*
* @param 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 setDomain(String domain) {
this.domain = 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.
*
*
* @return 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() {
return this.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.
*
*
* @param 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.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public ModifyDBInstanceRequest withDomain(String domain) {
setDomain(domain);
return this;
}
/**
*
* The fully qualified domain name (FQDN) of an Active Directory domain.
*
*
* Constraints:
*
*
* -
*
* Can't be longer than 64 characters.
*
*
*
*
* Example: mymanagedADtest.mymanagedAD.mydomain
*
*
* @param 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 setDomainFqdn(String domainFqdn) {
this.domainFqdn = domainFqdn;
}
/**
*
* The fully qualified domain name (FQDN) of an Active Directory domain.
*
*
* Constraints:
*
*
* -
*
* Can't be longer than 64 characters.
*
*
*
*
* Example: mymanagedADtest.mymanagedAD.mydomain
*
*
* @return 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() {
return this.domainFqdn;
}
/**
*
* The fully qualified domain name (FQDN) of an Active Directory domain.
*
*
* Constraints:
*
*
* -
*
* Can't be longer than 64 characters.
*
*
*
*
* Example: mymanagedADtest.mymanagedAD.mydomain
*
*
* @param domainFqdn
* The fully qualified domain name (FQDN) of an Active Directory domain.
*
* Constraints:
*
*
* -
*
* Can't be longer than 64 characters.
*
*
*
*
* Example: mymanagedADtest.mymanagedAD.mydomain
* @return Returns a reference to this object so that method calls can be chained together.
*/
public ModifyDBInstanceRequest withDomainFqdn(String domainFqdn) {
setDomainFqdn(domainFqdn);
return this;
}
/**
*
* 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
*
*
* @param 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 setDomainOu(String domainOu) {
this.domainOu = 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
*
*
* @return 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() {
return this.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
*
*
* @param 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
* @return Returns a reference to this object so that method calls can be chained together.
*/
public ModifyDBInstanceRequest withDomainOu(String domainOu) {
setDomainOu(domainOu);
return this;
}
/**
*
* 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
*
*
* @param 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 void setDomainAuthSecretArn(String domainAuthSecretArn) {
this.domainAuthSecretArn = 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
*
*
* @return 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() {
return this.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
*
*
* @param 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
* @return Returns a reference to this object so that method calls can be chained together.
*/
public ModifyDBInstanceRequest withDomainAuthSecretArn(String domainAuthSecretArn) {
setDomainAuthSecretArn(domainAuthSecretArn);
return this;
}
/**
*
* 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
*
*
* @return 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 java.util.List getDomainDnsIps() {
if (domainDnsIps == null) {
domainDnsIps = new com.amazonaws.internal.SdkInternalList();
}
return 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
*
*
* @param 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 setDomainDnsIps(java.util.Collection domainDnsIps) {
if (domainDnsIps == null) {
this.domainDnsIps = null;
return;
}
this.domainDnsIps = new com.amazonaws.internal.SdkInternalList(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
* {@link #setDomainDnsIps(java.util.Collection)} or {@link #withDomainDnsIps(java.util.Collection)} if you want to
* override the existing values.
*
*
* @param 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
* @return Returns a reference to this object so that method calls can be chained together.
*/
public ModifyDBInstanceRequest withDomainDnsIps(String... domainDnsIps) {
if (this.domainDnsIps == null) {
setDomainDnsIps(new com.amazonaws.internal.SdkInternalList(domainDnsIps.length));
}
for (String ele : domainDnsIps) {
this.domainDnsIps.add(ele);
}
return this;
}
/**
*
* 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
*
*
* @param 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
* @return Returns a reference to this object so that method calls can be chained together.
*/
public ModifyDBInstanceRequest withDomainDnsIps(java.util.Collection domainDnsIps) {
setDomainDnsIps(domainDnsIps);
return this;
}
/**
*
* 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
.
*
*
* @param 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 void setCopyTagsToSnapshot(Boolean copyTagsToSnapshot) {
this.copyTagsToSnapshot = 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
.
*
*
* @return 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() {
return this.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
.
*
*
* @param 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
.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public ModifyDBInstanceRequest withCopyTagsToSnapshot(Boolean copyTagsToSnapshot) {
setCopyTagsToSnapshot(copyTagsToSnapshot);
return this;
}
/**
*
* 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
.
*
*
* @return 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() {
return this.copyTagsToSnapshot;
}
/**
*
* 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
*
*
* @param 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 setMonitoringInterval(Integer monitoringInterval) {
this.monitoringInterval = 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
*
*
* @return 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() {
return this.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
*
*
* @param 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
* @return Returns a reference to this object so that method calls can be chained together.
*/
public ModifyDBInstanceRequest withMonitoringInterval(Integer monitoringInterval) {
setMonitoringInterval(monitoringInterval);
return this;
}
/**
*
* 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
.
*
*
*
*
* @param 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 setDBPortNumber(Integer dBPortNumber) {
this.dBPortNumber = 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
.
*
*
*
*
* @return 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() {
return this.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
.
*
*
*
*
* @param 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
.
*
*
* @return Returns a reference to this object so that method calls can be chained together.
*/
public ModifyDBInstanceRequest withDBPortNumber(Integer dBPortNumber) {
setDBPortNumber(dBPortNumber);
return this;
}
/**
*
* 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.
*
*
* @param 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 void setPubliclyAccessible(Boolean publiclyAccessible) {
this.publiclyAccessible = 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.
*
*
* @return 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() {
return this.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.
*
*
* @param 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.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public ModifyDBInstanceRequest withPubliclyAccessible(Boolean publiclyAccessible) {
setPubliclyAccessible(publiclyAccessible);
return this;
}
/**
*
* 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.
*
*
* @return 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() {
return this.publiclyAccessible;
}
/**
*
* 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.
*
*
* @param 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 setMonitoringRoleArn(String monitoringRoleArn) {
this.monitoringRoleArn = 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.
*
*
* @return 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() {
return this.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.
*
*
* @param 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.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public ModifyDBInstanceRequest withMonitoringRoleArn(String monitoringRoleArn) {
setMonitoringRoleArn(monitoringRoleArn);
return this;
}
/**
*
* 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.
*
*
* @param 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 setDomainIAMRoleName(String domainIAMRoleName) {
this.domainIAMRoleName = 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.
*
*
* @return 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() {
return this.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.
*
*
* @param 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.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public ModifyDBInstanceRequest withDomainIAMRoleName(String domainIAMRoleName) {
setDomainIAMRoleName(domainIAMRoleName);
return this;
}
/**
*
* Specifies whether to remove the DB instance from the Active Directory domain.
*
*
* @param disableDomain
* Specifies whether to remove the DB instance from the Active Directory domain.
*/
public void setDisableDomain(Boolean disableDomain) {
this.disableDomain = disableDomain;
}
/**
*
* Specifies whether to remove the DB instance from the Active Directory domain.
*
*
* @return Specifies whether to remove the DB instance from the Active Directory domain.
*/
public Boolean getDisableDomain() {
return this.disableDomain;
}
/**
*
* Specifies whether to remove the DB instance from the Active Directory domain.
*
*
* @param disableDomain
* Specifies whether to remove the DB instance from the Active Directory domain.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public ModifyDBInstanceRequest withDisableDomain(Boolean disableDomain) {
setDisableDomain(disableDomain);
return this;
}
/**
*
* Specifies whether to remove the DB instance from the Active Directory domain.
*
*
* @return Specifies whether to remove the DB instance from the Active Directory domain.
*/
public Boolean isDisableDomain() {
return this.disableDomain;
}
/**
*
* 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
*
*
* @param 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 setPromotionTier(Integer promotionTier) {
this.promotionTier = 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
*
*
* @return 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() {
return this.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
*
*
* @param 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
* @return Returns a reference to this object so that method calls can be chained together.
*/
public ModifyDBInstanceRequest withPromotionTier(Integer promotionTier) {
setPromotionTier(promotionTier);
return this;
}
/**
*
* 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.
*
*
* @param 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 void setEnableIAMDatabaseAuthentication(Boolean enableIAMDatabaseAuthentication) {
this.enableIAMDatabaseAuthentication = 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.
*
*
* @return 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() {
return this.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.
*
*
* @param 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.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public ModifyDBInstanceRequest withEnableIAMDatabaseAuthentication(Boolean enableIAMDatabaseAuthentication) {
setEnableIAMDatabaseAuthentication(enableIAMDatabaseAuthentication);
return this;
}
/**
*
* 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.
*
*
* @return 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() {
return this.enableIAMDatabaseAuthentication;
}
/**
*
* 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.
*
*
* @param 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 void setEnablePerformanceInsights(Boolean enablePerformanceInsights) {
this.enablePerformanceInsights = 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.
*
*
* @return 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() {
return this.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.
*
*
* @param 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.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public ModifyDBInstanceRequest withEnablePerformanceInsights(Boolean enablePerformanceInsights) {
setEnablePerformanceInsights(enablePerformanceInsights);
return this;
}
/**
*
* 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.
*
*
* @return 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() {
return this.enablePerformanceInsights;
}
/**
*
* 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.
*
*
* @param 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 setPerformanceInsightsKMSKeyId(String performanceInsightsKMSKeyId) {
this.performanceInsightsKMSKeyId = 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.
*
*
* @return 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() {
return this.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.
*
*
* @param 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.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public ModifyDBInstanceRequest withPerformanceInsightsKMSKeyId(String performanceInsightsKMSKeyId) {
setPerformanceInsightsKMSKeyId(performanceInsightsKMSKeyId);
return this;
}
/**
*
* 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.
*
*
* @param 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 setPerformanceInsightsRetentionPeriod(Integer performanceInsightsRetentionPeriod) {
this.performanceInsightsRetentionPeriod = 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.
*
*
* @return 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() {
return this.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.
*
*
* @param 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.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public ModifyDBInstanceRequest withPerformanceInsightsRetentionPeriod(Integer performanceInsightsRetentionPeriod) {
setPerformanceInsightsRetentionPeriod(performanceInsightsRetentionPeriod);
return this;
}
/**
*
* 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.
*
*
* @param 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 void setCloudwatchLogsExportConfiguration(CloudwatchLogsExportConfiguration cloudwatchLogsExportConfiguration) {
this.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.
*
*
* @return 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() {
return this.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.
*
*
* @param 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.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public ModifyDBInstanceRequest withCloudwatchLogsExportConfiguration(CloudwatchLogsExportConfiguration cloudwatchLogsExportConfiguration) {
setCloudwatchLogsExportConfiguration(cloudwatchLogsExportConfiguration);
return this;
}
/**
*
* 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.
*
*
* @return 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 java.util.List getProcessorFeatures() {
if (processorFeatures == null) {
processorFeatures = new com.amazonaws.internal.SdkInternalList();
}
return 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.
*
*
* @param 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 setProcessorFeatures(java.util.Collection processorFeatures) {
if (processorFeatures == null) {
this.processorFeatures = null;
return;
}
this.processorFeatures = new com.amazonaws.internal.SdkInternalList(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
* {@link #setProcessorFeatures(java.util.Collection)} or {@link #withProcessorFeatures(java.util.Collection)} if
* you want to override the existing values.
*
*
* @param 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.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public ModifyDBInstanceRequest withProcessorFeatures(ProcessorFeature... processorFeatures) {
if (this.processorFeatures == null) {
setProcessorFeatures(new com.amazonaws.internal.SdkInternalList(processorFeatures.length));
}
for (ProcessorFeature ele : processorFeatures) {
this.processorFeatures.add(ele);
}
return this;
}
/**
*
* 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.
*
*
* @param 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.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public ModifyDBInstanceRequest withProcessorFeatures(java.util.Collection processorFeatures) {
setProcessorFeatures(processorFeatures);
return this;
}
/**
*
* 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.
*
*
* @param 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 void setUseDefaultProcessorFeatures(Boolean useDefaultProcessorFeatures) {
this.useDefaultProcessorFeatures = 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.
*
*
* @return 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() {
return this.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.
*
*
* @param 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.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public ModifyDBInstanceRequest withUseDefaultProcessorFeatures(Boolean useDefaultProcessorFeatures) {
setUseDefaultProcessorFeatures(useDefaultProcessorFeatures);
return this;
}
/**
*
* 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.
*
*
* @return 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() {
return this.useDefaultProcessorFeatures;
}
/**
*
* 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.
*
*
* @param 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 void setDeletionProtection(Boolean deletionProtection) {
this.deletionProtection = 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.
*
*
* @return 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() {
return this.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.
*
*
* @param 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.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public ModifyDBInstanceRequest withDeletionProtection(Boolean deletionProtection) {
setDeletionProtection(deletionProtection);
return this;
}
/**
*
* 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.
*
*
* @return 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() {
return this.deletionProtection;
}
/**
*
* 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.
*
*
* @param 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 setMaxAllocatedStorage(Integer maxAllocatedStorage) {
this.maxAllocatedStorage = 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.
*
*
* @return 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() {
return this.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.
*
*
* @param 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.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public ModifyDBInstanceRequest withMaxAllocatedStorage(Integer maxAllocatedStorage) {
setMaxAllocatedStorage(maxAllocatedStorage);
return this;
}
/**
*
* 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.
*
*
* @param 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 void setCertificateRotationRestart(Boolean certificateRotationRestart) {
this.certificateRotationRestart = 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.
*
*
* @return 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() {
return this.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.
*
*
* @param 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.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public ModifyDBInstanceRequest withCertificateRotationRestart(Boolean certificateRotationRestart) {
setCertificateRotationRestart(certificateRotationRestart);
return this;
}
/**
*
* 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.
*
*
* @return 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() {
return this.certificateRotationRestart;
}
/**
*
* 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.
*
*
* @param 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.
* @see ReplicaMode
*/
public void setReplicaMode(String replicaMode) {
this.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.
*
*
* @return 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.
* @see ReplicaMode
*/
public String getReplicaMode() {
return this.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.
*
*
* @param 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.
* @return Returns a reference to this object so that method calls can be chained together.
* @see ReplicaMode
*/
public ModifyDBInstanceRequest withReplicaMode(String replicaMode) {
setReplicaMode(replicaMode);
return this;
}
/**
*
* 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.
*
*
* @param 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.
* @return Returns a reference to this object so that method calls can be chained together.
* @see ReplicaMode
*/
public ModifyDBInstanceRequest withReplicaMode(ReplicaMode replicaMode) {
this.replicaMode = replicaMode.toString();
return this;
}
/**
*
* 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.
*
*
* @param 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 void setEnableCustomerOwnedIp(Boolean enableCustomerOwnedIp) {
this.enableCustomerOwnedIp = 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.
*
*
* @return 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() {
return this.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.
*
*
* @param 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.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public ModifyDBInstanceRequest withEnableCustomerOwnedIp(Boolean enableCustomerOwnedIp) {
setEnableCustomerOwnedIp(enableCustomerOwnedIp);
return this;
}
/**
*
* 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.
*
*
* @return 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() {
return this.enableCustomerOwnedIp;
}
/**
*
* The Amazon Resource Name (ARN) of the recovery point in Amazon Web Services Backup.
*
*
* This setting doesn't apply to RDS Custom DB instances.
*
*
* @param 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 setAwsBackupRecoveryPointArn(String awsBackupRecoveryPointArn) {
this.awsBackupRecoveryPointArn = 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.
*
*
* @return 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() {
return this.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.
*
*
* @param 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.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public ModifyDBInstanceRequest withAwsBackupRecoveryPointArn(String awsBackupRecoveryPointArn) {
setAwsBackupRecoveryPointArn(awsBackupRecoveryPointArn);
return this;
}
/**
*
* 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
.
*
*
* @param 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
.
* @see AutomationMode
*/
public void setAutomationMode(String automationMode) {
this.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
.
*
*
* @return 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
.
* @see AutomationMode
*/
public String getAutomationMode() {
return this.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
.
*
*
* @param 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
.
* @return Returns a reference to this object so that method calls can be chained together.
* @see AutomationMode
*/
public ModifyDBInstanceRequest withAutomationMode(String automationMode) {
setAutomationMode(automationMode);
return this;
}
/**
*
* 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
.
*
*
* @param 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
.
* @return Returns a reference to this object so that method calls can be chained together.
* @see AutomationMode
*/
public ModifyDBInstanceRequest withAutomationMode(AutomationMode automationMode) {
this.automationMode = automationMode.toString();
return this;
}
/**
*
* 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.
*
*
*
*
* @param 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 setResumeFullAutomationModeMinutes(Integer resumeFullAutomationModeMinutes) {
this.resumeFullAutomationModeMinutes = 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.
*
*
*
*
* @return 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() {
return this.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.
*
*
*
*
* @param 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.
*
*
* @return Returns a reference to this object so that method calls can be chained together.
*/
public ModifyDBInstanceRequest withResumeFullAutomationModeMinutes(Integer resumeFullAutomationModeMinutes) {
setResumeFullAutomationModeMinutes(resumeFullAutomationModeMinutes);
return this;
}
/**
*
* 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
*
*
* @param 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 setNetworkType(String networkType) {
this.networkType = 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
*
*
* @return 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() {
return this.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
*
*
* @param 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
* @return Returns a reference to this object so that method calls can be chained together.
*/
public ModifyDBInstanceRequest withNetworkType(String networkType) {
setNetworkType(networkType);
return this;
}
/**
*
* 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.
*
*
* @param 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 setStorageThroughput(Integer storageThroughput) {
this.storageThroughput = 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.
*
*
* @return 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() {
return this.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.
*
*
* @param 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.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public ModifyDBInstanceRequest withStorageThroughput(Integer storageThroughput) {
setStorageThroughput(storageThroughput);
return this;
}
/**
*
* 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.
*
*
*
*
* @param 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 void setManageMasterUserPassword(Boolean manageMasterUserPassword) {
this.manageMasterUserPassword = 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.
*
*
*
*
* @return 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() {
return this.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.
*
*
*
*
* @param 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.
*
*
* @return Returns a reference to this object so that method calls can be chained together.
*/
public ModifyDBInstanceRequest withManageMasterUserPassword(Boolean manageMasterUserPassword) {
setManageMasterUserPassword(manageMasterUserPassword);
return this;
}
/**
*
* 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.
*
*
*
*
* @return 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() {
return this.manageMasterUserPassword;
}
/**
*
* 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.
*
*
*
*
* @param 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 void setRotateMasterUserPassword(Boolean rotateMasterUserPassword) {
this.rotateMasterUserPassword = 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.
*
*
*
*
* @return 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() {
return this.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.
*
*
*
*
* @param 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.
*
*
* @return Returns a reference to this object so that method calls can be chained together.
*/
public ModifyDBInstanceRequest withRotateMasterUserPassword(Boolean rotateMasterUserPassword) {
setRotateMasterUserPassword(rotateMasterUserPassword);
return this;
}
/**
*
* 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.
*
*
*
*
* @return 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() {
return this.rotateMasterUserPassword;
}
/**
*
* 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.
*
*
* @param 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 setMasterUserSecretKmsKeyId(String masterUserSecretKmsKeyId) {
this.masterUserSecretKmsKeyId = 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.
*
*
* @return 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() {
return this.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.
*
*
* @param 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.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public ModifyDBInstanceRequest withMasterUserSecretKmsKeyId(String masterUserSecretKmsKeyId) {
setMasterUserSecretKmsKeyId(masterUserSecretKmsKeyId);
return this;
}
/**
*
* 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
.
*
*
*
*
* @param 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 setEngine(String engine) {
this.engine = 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
.
*
*
*
*
* @return 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() {
return this.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
.
*
*
*
*
* @param 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
.
*
*
* @return Returns a reference to this object so that method calls can be chained together.
*/
public ModifyDBInstanceRequest withEngine(String engine) {
setEngine(engine);
return this;
}
/**
*
* Indicates whether the DB instance has a dedicated log volume (DLV) enabled.
*
*
* @param dedicatedLogVolume
* Indicates whether the DB instance has a dedicated log volume (DLV) enabled.
*/
public void setDedicatedLogVolume(Boolean dedicatedLogVolume) {
this.dedicatedLogVolume = dedicatedLogVolume;
}
/**
*
* Indicates whether the DB instance has a dedicated log volume (DLV) enabled.
*
*
* @return Indicates whether the DB instance has a dedicated log volume (DLV) enabled.
*/
public Boolean getDedicatedLogVolume() {
return this.dedicatedLogVolume;
}
/**
*
* Indicates whether the DB instance has a dedicated log volume (DLV) enabled.
*
*
* @param dedicatedLogVolume
* Indicates whether the DB instance has a dedicated log volume (DLV) enabled.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public ModifyDBInstanceRequest withDedicatedLogVolume(Boolean dedicatedLogVolume) {
setDedicatedLogVolume(dedicatedLogVolume);
return this;
}
/**
*
* Indicates whether the DB instance has a dedicated log volume (DLV) enabled.
*
*
* @return Indicates whether the DB instance has a dedicated log volume (DLV) enabled.
*/
public Boolean isDedicatedLogVolume() {
return this.dedicatedLogVolume;
}
/**
*
* 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
.
*
*
*
* @param 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 void setMultiTenant(Boolean multiTenant) {
this.multiTenant = 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
.
*
*
*
* @return 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() {
return this.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
.
*
*
*
* @param 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
.
*
* @return Returns a reference to this object so that method calls can be chained together.
*/
public ModifyDBInstanceRequest withMultiTenant(Boolean multiTenant) {
setMultiTenant(multiTenant);
return this;
}
/**
*
* 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
.
*
*
*
* @return 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() {
return this.multiTenant;
}
/**
* Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be
* redacted from this string using a placeholder value.
*
* @return A string representation of this object.
*
* @see java.lang.Object#toString()
*/
@Override
public String toString() {
StringBuilder sb = new StringBuilder();
sb.append("{");
if (getDBInstanceIdentifier() != null)
sb.append("DBInstanceIdentifier: ").append(getDBInstanceIdentifier()).append(",");
if (getAllocatedStorage() != null)
sb.append("AllocatedStorage: ").append(getAllocatedStorage()).append(",");
if (getDBInstanceClass() != null)
sb.append("DBInstanceClass: ").append(getDBInstanceClass()).append(",");
if (getDBSubnetGroupName() != null)
sb.append("DBSubnetGroupName: ").append(getDBSubnetGroupName()).append(",");
if (getDBSecurityGroups() != null)
sb.append("DBSecurityGroups: ").append(getDBSecurityGroups()).append(",");
if (getVpcSecurityGroupIds() != null)
sb.append("VpcSecurityGroupIds: ").append(getVpcSecurityGroupIds()).append(",");
if (getApplyImmediately() != null)
sb.append("ApplyImmediately: ").append(getApplyImmediately()).append(",");
if (getMasterUserPassword() != null)
sb.append("MasterUserPassword: ").append(getMasterUserPassword()).append(",");
if (getDBParameterGroupName() != null)
sb.append("DBParameterGroupName: ").append(getDBParameterGroupName()).append(",");
if (getBackupRetentionPeriod() != null)
sb.append("BackupRetentionPeriod: ").append(getBackupRetentionPeriod()).append(",");
if (getPreferredBackupWindow() != null)
sb.append("PreferredBackupWindow: ").append(getPreferredBackupWindow()).append(",");
if (getPreferredMaintenanceWindow() != null)
sb.append("PreferredMaintenanceWindow: ").append(getPreferredMaintenanceWindow()).append(",");
if (getMultiAZ() != null)
sb.append("MultiAZ: ").append(getMultiAZ()).append(",");
if (getEngineVersion() != null)
sb.append("EngineVersion: ").append(getEngineVersion()).append(",");
if (getAllowMajorVersionUpgrade() != null)
sb.append("AllowMajorVersionUpgrade: ").append(getAllowMajorVersionUpgrade()).append(",");
if (getAutoMinorVersionUpgrade() != null)
sb.append("AutoMinorVersionUpgrade: ").append(getAutoMinorVersionUpgrade()).append(",");
if (getLicenseModel() != null)
sb.append("LicenseModel: ").append(getLicenseModel()).append(",");
if (getIops() != null)
sb.append("Iops: ").append(getIops()).append(",");
if (getOptionGroupName() != null)
sb.append("OptionGroupName: ").append(getOptionGroupName()).append(",");
if (getNewDBInstanceIdentifier() != null)
sb.append("NewDBInstanceIdentifier: ").append(getNewDBInstanceIdentifier()).append(",");
if (getStorageType() != null)
sb.append("StorageType: ").append(getStorageType()).append(",");
if (getTdeCredentialArn() != null)
sb.append("TdeCredentialArn: ").append(getTdeCredentialArn()).append(",");
if (getTdeCredentialPassword() != null)
sb.append("TdeCredentialPassword: ").append(getTdeCredentialPassword()).append(",");
if (getCACertificateIdentifier() != null)
sb.append("CACertificateIdentifier: ").append(getCACertificateIdentifier()).append(",");
if (getDomain() != null)
sb.append("Domain: ").append(getDomain()).append(",");
if (getDomainFqdn() != null)
sb.append("DomainFqdn: ").append(getDomainFqdn()).append(",");
if (getDomainOu() != null)
sb.append("DomainOu: ").append(getDomainOu()).append(",");
if (getDomainAuthSecretArn() != null)
sb.append("DomainAuthSecretArn: ").append(getDomainAuthSecretArn()).append(",");
if (getDomainDnsIps() != null)
sb.append("DomainDnsIps: ").append(getDomainDnsIps()).append(",");
if (getCopyTagsToSnapshot() != null)
sb.append("CopyTagsToSnapshot: ").append(getCopyTagsToSnapshot()).append(",");
if (getMonitoringInterval() != null)
sb.append("MonitoringInterval: ").append(getMonitoringInterval()).append(",");
if (getDBPortNumber() != null)
sb.append("DBPortNumber: ").append(getDBPortNumber()).append(",");
if (getPubliclyAccessible() != null)
sb.append("PubliclyAccessible: ").append(getPubliclyAccessible()).append(",");
if (getMonitoringRoleArn() != null)
sb.append("MonitoringRoleArn: ").append(getMonitoringRoleArn()).append(",");
if (getDomainIAMRoleName() != null)
sb.append("DomainIAMRoleName: ").append(getDomainIAMRoleName()).append(",");
if (getDisableDomain() != null)
sb.append("DisableDomain: ").append(getDisableDomain()).append(",");
if (getPromotionTier() != null)
sb.append("PromotionTier: ").append(getPromotionTier()).append(",");
if (getEnableIAMDatabaseAuthentication() != null)
sb.append("EnableIAMDatabaseAuthentication: ").append(getEnableIAMDatabaseAuthentication()).append(",");
if (getEnablePerformanceInsights() != null)
sb.append("EnablePerformanceInsights: ").append(getEnablePerformanceInsights()).append(",");
if (getPerformanceInsightsKMSKeyId() != null)
sb.append("PerformanceInsightsKMSKeyId: ").append(getPerformanceInsightsKMSKeyId()).append(",");
if (getPerformanceInsightsRetentionPeriod() != null)
sb.append("PerformanceInsightsRetentionPeriod: ").append(getPerformanceInsightsRetentionPeriod()).append(",");
if (getCloudwatchLogsExportConfiguration() != null)
sb.append("CloudwatchLogsExportConfiguration: ").append(getCloudwatchLogsExportConfiguration()).append(",");
if (getProcessorFeatures() != null)
sb.append("ProcessorFeatures: ").append(getProcessorFeatures()).append(",");
if (getUseDefaultProcessorFeatures() != null)
sb.append("UseDefaultProcessorFeatures: ").append(getUseDefaultProcessorFeatures()).append(",");
if (getDeletionProtection() != null)
sb.append("DeletionProtection: ").append(getDeletionProtection()).append(",");
if (getMaxAllocatedStorage() != null)
sb.append("MaxAllocatedStorage: ").append(getMaxAllocatedStorage()).append(",");
if (getCertificateRotationRestart() != null)
sb.append("CertificateRotationRestart: ").append(getCertificateRotationRestart()).append(",");
if (getReplicaMode() != null)
sb.append("ReplicaMode: ").append(getReplicaMode()).append(",");
if (getEnableCustomerOwnedIp() != null)
sb.append("EnableCustomerOwnedIp: ").append(getEnableCustomerOwnedIp()).append(",");
if (getAwsBackupRecoveryPointArn() != null)
sb.append("AwsBackupRecoveryPointArn: ").append(getAwsBackupRecoveryPointArn()).append(",");
if (getAutomationMode() != null)
sb.append("AutomationMode: ").append(getAutomationMode()).append(",");
if (getResumeFullAutomationModeMinutes() != null)
sb.append("ResumeFullAutomationModeMinutes: ").append(getResumeFullAutomationModeMinutes()).append(",");
if (getNetworkType() != null)
sb.append("NetworkType: ").append(getNetworkType()).append(",");
if (getStorageThroughput() != null)
sb.append("StorageThroughput: ").append(getStorageThroughput()).append(",");
if (getManageMasterUserPassword() != null)
sb.append("ManageMasterUserPassword: ").append(getManageMasterUserPassword()).append(",");
if (getRotateMasterUserPassword() != null)
sb.append("RotateMasterUserPassword: ").append(getRotateMasterUserPassword()).append(",");
if (getMasterUserSecretKmsKeyId() != null)
sb.append("MasterUserSecretKmsKeyId: ").append(getMasterUserSecretKmsKeyId()).append(",");
if (getEngine() != null)
sb.append("Engine: ").append(getEngine()).append(",");
if (getDedicatedLogVolume() != null)
sb.append("DedicatedLogVolume: ").append(getDedicatedLogVolume()).append(",");
if (getMultiTenant() != null)
sb.append("MultiTenant: ").append(getMultiTenant());
sb.append("}");
return sb.toString();
}
@Override
public boolean equals(Object obj) {
if (this == obj)
return true;
if (obj == null)
return false;
if (obj instanceof ModifyDBInstanceRequest == false)
return false;
ModifyDBInstanceRequest other = (ModifyDBInstanceRequest) obj;
if (other.getDBInstanceIdentifier() == null ^ this.getDBInstanceIdentifier() == null)
return false;
if (other.getDBInstanceIdentifier() != null && other.getDBInstanceIdentifier().equals(this.getDBInstanceIdentifier()) == false)
return false;
if (other.getAllocatedStorage() == null ^ this.getAllocatedStorage() == null)
return false;
if (other.getAllocatedStorage() != null && other.getAllocatedStorage().equals(this.getAllocatedStorage()) == false)
return false;
if (other.getDBInstanceClass() == null ^ this.getDBInstanceClass() == null)
return false;
if (other.getDBInstanceClass() != null && other.getDBInstanceClass().equals(this.getDBInstanceClass()) == false)
return false;
if (other.getDBSubnetGroupName() == null ^ this.getDBSubnetGroupName() == null)
return false;
if (other.getDBSubnetGroupName() != null && other.getDBSubnetGroupName().equals(this.getDBSubnetGroupName()) == false)
return false;
if (other.getDBSecurityGroups() == null ^ this.getDBSecurityGroups() == null)
return false;
if (other.getDBSecurityGroups() != null && other.getDBSecurityGroups().equals(this.getDBSecurityGroups()) == false)
return false;
if (other.getVpcSecurityGroupIds() == null ^ this.getVpcSecurityGroupIds() == null)
return false;
if (other.getVpcSecurityGroupIds() != null && other.getVpcSecurityGroupIds().equals(this.getVpcSecurityGroupIds()) == false)
return false;
if (other.getApplyImmediately() == null ^ this.getApplyImmediately() == null)
return false;
if (other.getApplyImmediately() != null && other.getApplyImmediately().equals(this.getApplyImmediately()) == false)
return false;
if (other.getMasterUserPassword() == null ^ this.getMasterUserPassword() == null)
return false;
if (other.getMasterUserPassword() != null && other.getMasterUserPassword().equals(this.getMasterUserPassword()) == false)
return false;
if (other.getDBParameterGroupName() == null ^ this.getDBParameterGroupName() == null)
return false;
if (other.getDBParameterGroupName() != null && other.getDBParameterGroupName().equals(this.getDBParameterGroupName()) == false)
return false;
if (other.getBackupRetentionPeriod() == null ^ this.getBackupRetentionPeriod() == null)
return false;
if (other.getBackupRetentionPeriod() != null && other.getBackupRetentionPeriod().equals(this.getBackupRetentionPeriod()) == false)
return false;
if (other.getPreferredBackupWindow() == null ^ this.getPreferredBackupWindow() == null)
return false;
if (other.getPreferredBackupWindow() != null && other.getPreferredBackupWindow().equals(this.getPreferredBackupWindow()) == false)
return false;
if (other.getPreferredMaintenanceWindow() == null ^ this.getPreferredMaintenanceWindow() == null)
return false;
if (other.getPreferredMaintenanceWindow() != null && other.getPreferredMaintenanceWindow().equals(this.getPreferredMaintenanceWindow()) == false)
return false;
if (other.getMultiAZ() == null ^ this.getMultiAZ() == null)
return false;
if (other.getMultiAZ() != null && other.getMultiAZ().equals(this.getMultiAZ()) == false)
return false;
if (other.getEngineVersion() == null ^ this.getEngineVersion() == null)
return false;
if (other.getEngineVersion() != null && other.getEngineVersion().equals(this.getEngineVersion()) == false)
return false;
if (other.getAllowMajorVersionUpgrade() == null ^ this.getAllowMajorVersionUpgrade() == null)
return false;
if (other.getAllowMajorVersionUpgrade() != null && other.getAllowMajorVersionUpgrade().equals(this.getAllowMajorVersionUpgrade()) == false)
return false;
if (other.getAutoMinorVersionUpgrade() == null ^ this.getAutoMinorVersionUpgrade() == null)
return false;
if (other.getAutoMinorVersionUpgrade() != null && other.getAutoMinorVersionUpgrade().equals(this.getAutoMinorVersionUpgrade()) == false)
return false;
if (other.getLicenseModel() == null ^ this.getLicenseModel() == null)
return false;
if (other.getLicenseModel() != null && other.getLicenseModel().equals(this.getLicenseModel()) == false)
return false;
if (other.getIops() == null ^ this.getIops() == null)
return false;
if (other.getIops() != null && other.getIops().equals(this.getIops()) == false)
return false;
if (other.getOptionGroupName() == null ^ this.getOptionGroupName() == null)
return false;
if (other.getOptionGroupName() != null && other.getOptionGroupName().equals(this.getOptionGroupName()) == false)
return false;
if (other.getNewDBInstanceIdentifier() == null ^ this.getNewDBInstanceIdentifier() == null)
return false;
if (other.getNewDBInstanceIdentifier() != null && other.getNewDBInstanceIdentifier().equals(this.getNewDBInstanceIdentifier()) == false)
return false;
if (other.getStorageType() == null ^ this.getStorageType() == null)
return false;
if (other.getStorageType() != null && other.getStorageType().equals(this.getStorageType()) == false)
return false;
if (other.getTdeCredentialArn() == null ^ this.getTdeCredentialArn() == null)
return false;
if (other.getTdeCredentialArn() != null && other.getTdeCredentialArn().equals(this.getTdeCredentialArn()) == false)
return false;
if (other.getTdeCredentialPassword() == null ^ this.getTdeCredentialPassword() == null)
return false;
if (other.getTdeCredentialPassword() != null && other.getTdeCredentialPassword().equals(this.getTdeCredentialPassword()) == false)
return false;
if (other.getCACertificateIdentifier() == null ^ this.getCACertificateIdentifier() == null)
return false;
if (other.getCACertificateIdentifier() != null && other.getCACertificateIdentifier().equals(this.getCACertificateIdentifier()) == false)
return false;
if (other.getDomain() == null ^ this.getDomain() == null)
return false;
if (other.getDomain() != null && other.getDomain().equals(this.getDomain()) == false)
return false;
if (other.getDomainFqdn() == null ^ this.getDomainFqdn() == null)
return false;
if (other.getDomainFqdn() != null && other.getDomainFqdn().equals(this.getDomainFqdn()) == false)
return false;
if (other.getDomainOu() == null ^ this.getDomainOu() == null)
return false;
if (other.getDomainOu() != null && other.getDomainOu().equals(this.getDomainOu()) == false)
return false;
if (other.getDomainAuthSecretArn() == null ^ this.getDomainAuthSecretArn() == null)
return false;
if (other.getDomainAuthSecretArn() != null && other.getDomainAuthSecretArn().equals(this.getDomainAuthSecretArn()) == false)
return false;
if (other.getDomainDnsIps() == null ^ this.getDomainDnsIps() == null)
return false;
if (other.getDomainDnsIps() != null && other.getDomainDnsIps().equals(this.getDomainDnsIps()) == false)
return false;
if (other.getCopyTagsToSnapshot() == null ^ this.getCopyTagsToSnapshot() == null)
return false;
if (other.getCopyTagsToSnapshot() != null && other.getCopyTagsToSnapshot().equals(this.getCopyTagsToSnapshot()) == false)
return false;
if (other.getMonitoringInterval() == null ^ this.getMonitoringInterval() == null)
return false;
if (other.getMonitoringInterval() != null && other.getMonitoringInterval().equals(this.getMonitoringInterval()) == false)
return false;
if (other.getDBPortNumber() == null ^ this.getDBPortNumber() == null)
return false;
if (other.getDBPortNumber() != null && other.getDBPortNumber().equals(this.getDBPortNumber()) == false)
return false;
if (other.getPubliclyAccessible() == null ^ this.getPubliclyAccessible() == null)
return false;
if (other.getPubliclyAccessible() != null && other.getPubliclyAccessible().equals(this.getPubliclyAccessible()) == false)
return false;
if (other.getMonitoringRoleArn() == null ^ this.getMonitoringRoleArn() == null)
return false;
if (other.getMonitoringRoleArn() != null && other.getMonitoringRoleArn().equals(this.getMonitoringRoleArn()) == false)
return false;
if (other.getDomainIAMRoleName() == null ^ this.getDomainIAMRoleName() == null)
return false;
if (other.getDomainIAMRoleName() != null && other.getDomainIAMRoleName().equals(this.getDomainIAMRoleName()) == false)
return false;
if (other.getDisableDomain() == null ^ this.getDisableDomain() == null)
return false;
if (other.getDisableDomain() != null && other.getDisableDomain().equals(this.getDisableDomain()) == false)
return false;
if (other.getPromotionTier() == null ^ this.getPromotionTier() == null)
return false;
if (other.getPromotionTier() != null && other.getPromotionTier().equals(this.getPromotionTier()) == false)
return false;
if (other.getEnableIAMDatabaseAuthentication() == null ^ this.getEnableIAMDatabaseAuthentication() == null)
return false;
if (other.getEnableIAMDatabaseAuthentication() != null
&& other.getEnableIAMDatabaseAuthentication().equals(this.getEnableIAMDatabaseAuthentication()) == false)
return false;
if (other.getEnablePerformanceInsights() == null ^ this.getEnablePerformanceInsights() == null)
return false;
if (other.getEnablePerformanceInsights() != null && other.getEnablePerformanceInsights().equals(this.getEnablePerformanceInsights()) == false)
return false;
if (other.getPerformanceInsightsKMSKeyId() == null ^ this.getPerformanceInsightsKMSKeyId() == null)
return false;
if (other.getPerformanceInsightsKMSKeyId() != null && other.getPerformanceInsightsKMSKeyId().equals(this.getPerformanceInsightsKMSKeyId()) == false)
return false;
if (other.getPerformanceInsightsRetentionPeriod() == null ^ this.getPerformanceInsightsRetentionPeriod() == null)
return false;
if (other.getPerformanceInsightsRetentionPeriod() != null
&& other.getPerformanceInsightsRetentionPeriod().equals(this.getPerformanceInsightsRetentionPeriod()) == false)
return false;
if (other.getCloudwatchLogsExportConfiguration() == null ^ this.getCloudwatchLogsExportConfiguration() == null)
return false;
if (other.getCloudwatchLogsExportConfiguration() != null
&& other.getCloudwatchLogsExportConfiguration().equals(this.getCloudwatchLogsExportConfiguration()) == false)
return false;
if (other.getProcessorFeatures() == null ^ this.getProcessorFeatures() == null)
return false;
if (other.getProcessorFeatures() != null && other.getProcessorFeatures().equals(this.getProcessorFeatures()) == false)
return false;
if (other.getUseDefaultProcessorFeatures() == null ^ this.getUseDefaultProcessorFeatures() == null)
return false;
if (other.getUseDefaultProcessorFeatures() != null && other.getUseDefaultProcessorFeatures().equals(this.getUseDefaultProcessorFeatures()) == false)
return false;
if (other.getDeletionProtection() == null ^ this.getDeletionProtection() == null)
return false;
if (other.getDeletionProtection() != null && other.getDeletionProtection().equals(this.getDeletionProtection()) == false)
return false;
if (other.getMaxAllocatedStorage() == null ^ this.getMaxAllocatedStorage() == null)
return false;
if (other.getMaxAllocatedStorage() != null && other.getMaxAllocatedStorage().equals(this.getMaxAllocatedStorage()) == false)
return false;
if (other.getCertificateRotationRestart() == null ^ this.getCertificateRotationRestart() == null)
return false;
if (other.getCertificateRotationRestart() != null && other.getCertificateRotationRestart().equals(this.getCertificateRotationRestart()) == false)
return false;
if (other.getReplicaMode() == null ^ this.getReplicaMode() == null)
return false;
if (other.getReplicaMode() != null && other.getReplicaMode().equals(this.getReplicaMode()) == false)
return false;
if (other.getEnableCustomerOwnedIp() == null ^ this.getEnableCustomerOwnedIp() == null)
return false;
if (other.getEnableCustomerOwnedIp() != null && other.getEnableCustomerOwnedIp().equals(this.getEnableCustomerOwnedIp()) == false)
return false;
if (other.getAwsBackupRecoveryPointArn() == null ^ this.getAwsBackupRecoveryPointArn() == null)
return false;
if (other.getAwsBackupRecoveryPointArn() != null && other.getAwsBackupRecoveryPointArn().equals(this.getAwsBackupRecoveryPointArn()) == false)
return false;
if (other.getAutomationMode() == null ^ this.getAutomationMode() == null)
return false;
if (other.getAutomationMode() != null && other.getAutomationMode().equals(this.getAutomationMode()) == false)
return false;
if (other.getResumeFullAutomationModeMinutes() == null ^ this.getResumeFullAutomationModeMinutes() == null)
return false;
if (other.getResumeFullAutomationModeMinutes() != null
&& other.getResumeFullAutomationModeMinutes().equals(this.getResumeFullAutomationModeMinutes()) == false)
return false;
if (other.getNetworkType() == null ^ this.getNetworkType() == null)
return false;
if (other.getNetworkType() != null && other.getNetworkType().equals(this.getNetworkType()) == false)
return false;
if (other.getStorageThroughput() == null ^ this.getStorageThroughput() == null)
return false;
if (other.getStorageThroughput() != null && other.getStorageThroughput().equals(this.getStorageThroughput()) == false)
return false;
if (other.getManageMasterUserPassword() == null ^ this.getManageMasterUserPassword() == null)
return false;
if (other.getManageMasterUserPassword() != null && other.getManageMasterUserPassword().equals(this.getManageMasterUserPassword()) == false)
return false;
if (other.getRotateMasterUserPassword() == null ^ this.getRotateMasterUserPassword() == null)
return false;
if (other.getRotateMasterUserPassword() != null && other.getRotateMasterUserPassword().equals(this.getRotateMasterUserPassword()) == false)
return false;
if (other.getMasterUserSecretKmsKeyId() == null ^ this.getMasterUserSecretKmsKeyId() == null)
return false;
if (other.getMasterUserSecretKmsKeyId() != null && other.getMasterUserSecretKmsKeyId().equals(this.getMasterUserSecretKmsKeyId()) == false)
return false;
if (other.getEngine() == null ^ this.getEngine() == null)
return false;
if (other.getEngine() != null && other.getEngine().equals(this.getEngine()) == false)
return false;
if (other.getDedicatedLogVolume() == null ^ this.getDedicatedLogVolume() == null)
return false;
if (other.getDedicatedLogVolume() != null && other.getDedicatedLogVolume().equals(this.getDedicatedLogVolume()) == false)
return false;
if (other.getMultiTenant() == null ^ this.getMultiTenant() == null)
return false;
if (other.getMultiTenant() != null && other.getMultiTenant().equals(this.getMultiTenant()) == false)
return false;
return true;
}
@Override
public int hashCode() {
final int prime = 31;
int hashCode = 1;
hashCode = prime * hashCode + ((getDBInstanceIdentifier() == null) ? 0 : getDBInstanceIdentifier().hashCode());
hashCode = prime * hashCode + ((getAllocatedStorage() == null) ? 0 : getAllocatedStorage().hashCode());
hashCode = prime * hashCode + ((getDBInstanceClass() == null) ? 0 : getDBInstanceClass().hashCode());
hashCode = prime * hashCode + ((getDBSubnetGroupName() == null) ? 0 : getDBSubnetGroupName().hashCode());
hashCode = prime * hashCode + ((getDBSecurityGroups() == null) ? 0 : getDBSecurityGroups().hashCode());
hashCode = prime * hashCode + ((getVpcSecurityGroupIds() == null) ? 0 : getVpcSecurityGroupIds().hashCode());
hashCode = prime * hashCode + ((getApplyImmediately() == null) ? 0 : getApplyImmediately().hashCode());
hashCode = prime * hashCode + ((getMasterUserPassword() == null) ? 0 : getMasterUserPassword().hashCode());
hashCode = prime * hashCode + ((getDBParameterGroupName() == null) ? 0 : getDBParameterGroupName().hashCode());
hashCode = prime * hashCode + ((getBackupRetentionPeriod() == null) ? 0 : getBackupRetentionPeriod().hashCode());
hashCode = prime * hashCode + ((getPreferredBackupWindow() == null) ? 0 : getPreferredBackupWindow().hashCode());
hashCode = prime * hashCode + ((getPreferredMaintenanceWindow() == null) ? 0 : getPreferredMaintenanceWindow().hashCode());
hashCode = prime * hashCode + ((getMultiAZ() == null) ? 0 : getMultiAZ().hashCode());
hashCode = prime * hashCode + ((getEngineVersion() == null) ? 0 : getEngineVersion().hashCode());
hashCode = prime * hashCode + ((getAllowMajorVersionUpgrade() == null) ? 0 : getAllowMajorVersionUpgrade().hashCode());
hashCode = prime * hashCode + ((getAutoMinorVersionUpgrade() == null) ? 0 : getAutoMinorVersionUpgrade().hashCode());
hashCode = prime * hashCode + ((getLicenseModel() == null) ? 0 : getLicenseModel().hashCode());
hashCode = prime * hashCode + ((getIops() == null) ? 0 : getIops().hashCode());
hashCode = prime * hashCode + ((getOptionGroupName() == null) ? 0 : getOptionGroupName().hashCode());
hashCode = prime * hashCode + ((getNewDBInstanceIdentifier() == null) ? 0 : getNewDBInstanceIdentifier().hashCode());
hashCode = prime * hashCode + ((getStorageType() == null) ? 0 : getStorageType().hashCode());
hashCode = prime * hashCode + ((getTdeCredentialArn() == null) ? 0 : getTdeCredentialArn().hashCode());
hashCode = prime * hashCode + ((getTdeCredentialPassword() == null) ? 0 : getTdeCredentialPassword().hashCode());
hashCode = prime * hashCode + ((getCACertificateIdentifier() == null) ? 0 : getCACertificateIdentifier().hashCode());
hashCode = prime * hashCode + ((getDomain() == null) ? 0 : getDomain().hashCode());
hashCode = prime * hashCode + ((getDomainFqdn() == null) ? 0 : getDomainFqdn().hashCode());
hashCode = prime * hashCode + ((getDomainOu() == null) ? 0 : getDomainOu().hashCode());
hashCode = prime * hashCode + ((getDomainAuthSecretArn() == null) ? 0 : getDomainAuthSecretArn().hashCode());
hashCode = prime * hashCode + ((getDomainDnsIps() == null) ? 0 : getDomainDnsIps().hashCode());
hashCode = prime * hashCode + ((getCopyTagsToSnapshot() == null) ? 0 : getCopyTagsToSnapshot().hashCode());
hashCode = prime * hashCode + ((getMonitoringInterval() == null) ? 0 : getMonitoringInterval().hashCode());
hashCode = prime * hashCode + ((getDBPortNumber() == null) ? 0 : getDBPortNumber().hashCode());
hashCode = prime * hashCode + ((getPubliclyAccessible() == null) ? 0 : getPubliclyAccessible().hashCode());
hashCode = prime * hashCode + ((getMonitoringRoleArn() == null) ? 0 : getMonitoringRoleArn().hashCode());
hashCode = prime * hashCode + ((getDomainIAMRoleName() == null) ? 0 : getDomainIAMRoleName().hashCode());
hashCode = prime * hashCode + ((getDisableDomain() == null) ? 0 : getDisableDomain().hashCode());
hashCode = prime * hashCode + ((getPromotionTier() == null) ? 0 : getPromotionTier().hashCode());
hashCode = prime * hashCode + ((getEnableIAMDatabaseAuthentication() == null) ? 0 : getEnableIAMDatabaseAuthentication().hashCode());
hashCode = prime * hashCode + ((getEnablePerformanceInsights() == null) ? 0 : getEnablePerformanceInsights().hashCode());
hashCode = prime * hashCode + ((getPerformanceInsightsKMSKeyId() == null) ? 0 : getPerformanceInsightsKMSKeyId().hashCode());
hashCode = prime * hashCode + ((getPerformanceInsightsRetentionPeriod() == null) ? 0 : getPerformanceInsightsRetentionPeriod().hashCode());
hashCode = prime * hashCode + ((getCloudwatchLogsExportConfiguration() == null) ? 0 : getCloudwatchLogsExportConfiguration().hashCode());
hashCode = prime * hashCode + ((getProcessorFeatures() == null) ? 0 : getProcessorFeatures().hashCode());
hashCode = prime * hashCode + ((getUseDefaultProcessorFeatures() == null) ? 0 : getUseDefaultProcessorFeatures().hashCode());
hashCode = prime * hashCode + ((getDeletionProtection() == null) ? 0 : getDeletionProtection().hashCode());
hashCode = prime * hashCode + ((getMaxAllocatedStorage() == null) ? 0 : getMaxAllocatedStorage().hashCode());
hashCode = prime * hashCode + ((getCertificateRotationRestart() == null) ? 0 : getCertificateRotationRestart().hashCode());
hashCode = prime * hashCode + ((getReplicaMode() == null) ? 0 : getReplicaMode().hashCode());
hashCode = prime * hashCode + ((getEnableCustomerOwnedIp() == null) ? 0 : getEnableCustomerOwnedIp().hashCode());
hashCode = prime * hashCode + ((getAwsBackupRecoveryPointArn() == null) ? 0 : getAwsBackupRecoveryPointArn().hashCode());
hashCode = prime * hashCode + ((getAutomationMode() == null) ? 0 : getAutomationMode().hashCode());
hashCode = prime * hashCode + ((getResumeFullAutomationModeMinutes() == null) ? 0 : getResumeFullAutomationModeMinutes().hashCode());
hashCode = prime * hashCode + ((getNetworkType() == null) ? 0 : getNetworkType().hashCode());
hashCode = prime * hashCode + ((getStorageThroughput() == null) ? 0 : getStorageThroughput().hashCode());
hashCode = prime * hashCode + ((getManageMasterUserPassword() == null) ? 0 : getManageMasterUserPassword().hashCode());
hashCode = prime * hashCode + ((getRotateMasterUserPassword() == null) ? 0 : getRotateMasterUserPassword().hashCode());
hashCode = prime * hashCode + ((getMasterUserSecretKmsKeyId() == null) ? 0 : getMasterUserSecretKmsKeyId().hashCode());
hashCode = prime * hashCode + ((getEngine() == null) ? 0 : getEngine().hashCode());
hashCode = prime * hashCode + ((getDedicatedLogVolume() == null) ? 0 : getDedicatedLogVolume().hashCode());
hashCode = prime * hashCode + ((getMultiTenant() == null) ? 0 : getMultiTenant().hashCode());
return hashCode;
}
@Override
public ModifyDBInstanceRequest clone() {
return (ModifyDBInstanceRequest) super.clone();
}
}