Class ModifyDBInstanceRequest

java.lang.Object
com.amazonaws.AmazonWebServiceRequest
com.amazonaws.services.rds.model.ModifyDBInstanceRequest
All Implemented Interfaces:
ReadLimitInfo, Serializable, Cloneable

public class ModifyDBInstanceRequest extends AmazonWebServiceRequest implements Serializable, Cloneable

See Also:
  • Constructor Details

    • ModifyDBInstanceRequest

      public ModifyDBInstanceRequest()
      Default constructor for ModifyDBInstanceRequest object. Callers should use the setter or fluent setter (with...) methods to initialize the object after creating it.
    • ModifyDBInstanceRequest

      public ModifyDBInstanceRequest(String dBInstanceIdentifier)
      Constructs a new ModifyDBInstanceRequest object. Callers should use the setter or fluent setter (with...) methods to initialize any additional object members.
      Parameters:
      dBInstanceIdentifier - The DB instance identifier. This value is stored as a lowercase string.

      Constraints:

      • Must be the identifier for an existing DB instance
      • Must contain from 1 to 63 alphanumeric characters or hyphens
      • First character must be a letter
      • Cannot end with a hyphen or contain two consecutive hyphens
  • Method Details

    • setDBInstanceIdentifier

      public void setDBInstanceIdentifier(String dBInstanceIdentifier)

      The DB instance identifier. This value is stored as a lowercase string.

      Constraints:

      • Must be the identifier for an existing DB instance
      • Must contain from 1 to 63 alphanumeric characters or hyphens
      • First character must be a letter
      • Cannot end with a hyphen or contain two consecutive hyphens
      Parameters:
      dBInstanceIdentifier - The DB instance identifier. This value is stored as a lowercase string.

      Constraints:

      • Must be the identifier for an existing DB instance
      • Must contain from 1 to 63 alphanumeric characters or hyphens
      • First character must be a letter
      • Cannot end with a hyphen or contain two consecutive hyphens
    • getDBInstanceIdentifier

      public String getDBInstanceIdentifier()

      The DB instance identifier. This value is stored as a lowercase string.

      Constraints:

      • Must be the identifier for an existing DB instance
      • Must contain from 1 to 63 alphanumeric characters or hyphens
      • First character must be a letter
      • Cannot end with a hyphen or contain two consecutive hyphens
      Returns:
      The DB instance identifier. This value is stored as a lowercase string.

      Constraints:

      • Must be the identifier for an existing DB instance
      • Must contain from 1 to 63 alphanumeric characters or hyphens
      • First character must be a letter
      • Cannot end with a hyphen or contain two consecutive hyphens
    • withDBInstanceIdentifier

      public ModifyDBInstanceRequest withDBInstanceIdentifier(String dBInstanceIdentifier)

      The DB instance identifier. This value is stored as a lowercase string.

      Constraints:

      • Must be the identifier for an existing DB instance
      • Must contain from 1 to 63 alphanumeric characters or hyphens
      • First character must be a letter
      • Cannot end with a hyphen or contain two consecutive hyphens
      Parameters:
      dBInstanceIdentifier - The DB instance identifier. This value is stored as a lowercase string.

      Constraints:

      • Must be the identifier for an existing DB instance
      • Must contain from 1 to 63 alphanumeric characters or hyphens
      • First character must be a letter
      • Cannot end with a hyphen or contain two consecutive hyphens
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • setAllocatedStorage

      public void setAllocatedStorage(Integer allocatedStorage)

      The new storage capacity of the RDS instance. Changing this setting does not result in an outage and the change is applied during the next maintenance window unless ApplyImmediately is set to true for this request.

      MySQL

      Default: Uses existing setting

      Valid Values: 5-6144

      Constraints: Value supplied must be at least 10% greater than the current value. Values that are not at least 10% greater than the existing value are rounded up so that they are 10% greater than the current value.

      Type: Integer

      MariaDB

      Default: Uses existing setting

      Valid Values: 5-6144

      Constraints: Value supplied must be at least 10% greater than the current value. Values that are not at least 10% greater than the existing value are rounded up so that they are 10% greater than the current value.

      Type: Integer

      PostgreSQL

      Default: Uses existing setting

      Valid Values: 5-6144

      Constraints: Value supplied must be at least 10% greater than the current value. Values that are not at least 10% greater than the existing value are rounded up so that they are 10% greater than the current value.

      Type: Integer

      Oracle

      Default: Uses existing setting

      Valid Values: 10-6144

      Constraints: Value supplied must be at least 10% greater than the current value. Values that are not at least 10% greater than the existing value are rounded up so that they are 10% greater than the current value.

      SQL Server

      Cannot be modified.

      If you choose to migrate your DB instance from using standard storage to using Provisioned IOPS, or from using Provisioned IOPS to using standard storage, the process can take time. The duration of the migration depends on several factors such as database load, storage size, storage type (standard or Provisioned IOPS), amount of IOPS provisioned (if any), and the number of prior scale storage operations. Typical migration times are under 24 hours, but the process can take up to several days in some cases. During the migration, the DB instance will be available for use, but might experience performance degradation. While the migration takes place, nightly backups for the instance will be 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.

      Parameters:
      allocatedStorage - The new storage capacity of the RDS instance. Changing this setting does not result in an outage and the change is applied during the next maintenance window unless ApplyImmediately is set to true for this request.

      MySQL

      Default: Uses existing setting

      Valid Values: 5-6144

      Constraints: Value supplied must be at least 10% greater than the current value. Values that are not at least 10% greater than the existing value are rounded up so that they are 10% greater than the current value.

      Type: Integer

      MariaDB

      Default: Uses existing setting

      Valid Values: 5-6144

      Constraints: Value supplied must be at least 10% greater than the current value. Values that are not at least 10% greater than the existing value are rounded up so that they are 10% greater than the current value.

      Type: Integer

      PostgreSQL

      Default: Uses existing setting

      Valid Values: 5-6144

      Constraints: Value supplied must be at least 10% greater than the current value. Values that are not at least 10% greater than the existing value are rounded up so that they are 10% greater than the current value.

      Type: Integer

      Oracle

      Default: Uses existing setting

      Valid Values: 10-6144

      Constraints: Value supplied must be at least 10% greater than the current value. Values that are not at least 10% greater than the existing value are rounded up so that they are 10% greater than the current value.

      SQL Server

      Cannot be modified.

      If you choose to migrate your DB instance from using standard storage to using Provisioned IOPS, or from using Provisioned IOPS to using standard storage, the process can take time. The duration of the migration depends on several factors such as database load, storage size, storage type (standard or Provisioned IOPS), amount of IOPS provisioned (if any), and the number of prior scale storage operations. Typical migration times are under 24 hours, but the process can take up to several days in some cases. During the migration, the DB instance will be available for use, but might experience performance degradation. While the migration takes place, nightly backups for the instance will be 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.

    • getAllocatedStorage

      public Integer getAllocatedStorage()

      The new storage capacity of the RDS instance. Changing this setting does not result in an outage and the change is applied during the next maintenance window unless ApplyImmediately is set to true for this request.

      MySQL

      Default: Uses existing setting

      Valid Values: 5-6144

      Constraints: Value supplied must be at least 10% greater than the current value. Values that are not at least 10% greater than the existing value are rounded up so that they are 10% greater than the current value.

      Type: Integer

      MariaDB

      Default: Uses existing setting

      Valid Values: 5-6144

      Constraints: Value supplied must be at least 10% greater than the current value. Values that are not at least 10% greater than the existing value are rounded up so that they are 10% greater than the current value.

      Type: Integer

      PostgreSQL

      Default: Uses existing setting

      Valid Values: 5-6144

      Constraints: Value supplied must be at least 10% greater than the current value. Values that are not at least 10% greater than the existing value are rounded up so that they are 10% greater than the current value.

      Type: Integer

      Oracle

      Default: Uses existing setting

      Valid Values: 10-6144

      Constraints: Value supplied must be at least 10% greater than the current value. Values that are not at least 10% greater than the existing value are rounded up so that they are 10% greater than the current value.

      SQL Server

      Cannot be modified.

      If you choose to migrate your DB instance from using standard storage to using Provisioned IOPS, or from using Provisioned IOPS to using standard storage, the process can take time. The duration of the migration depends on several factors such as database load, storage size, storage type (standard or Provisioned IOPS), amount of IOPS provisioned (if any), and the number of prior scale storage operations. Typical migration times are under 24 hours, but the process can take up to several days in some cases. During the migration, the DB instance will be available for use, but might experience performance degradation. While the migration takes place, nightly backups for the instance will be 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.

      Returns:
      The new storage capacity of the RDS instance. Changing this setting does not result in an outage and the change is applied during the next maintenance window unless ApplyImmediately is set to true for this request.

      MySQL

      Default: Uses existing setting

      Valid Values: 5-6144

      Constraints: Value supplied must be at least 10% greater than the current value. Values that are not at least 10% greater than the existing value are rounded up so that they are 10% greater than the current value.

      Type: Integer

      MariaDB

      Default: Uses existing setting

      Valid Values: 5-6144

      Constraints: Value supplied must be at least 10% greater than the current value. Values that are not at least 10% greater than the existing value are rounded up so that they are 10% greater than the current value.

      Type: Integer

      PostgreSQL

      Default: Uses existing setting

      Valid Values: 5-6144

      Constraints: Value supplied must be at least 10% greater than the current value. Values that are not at least 10% greater than the existing value are rounded up so that they are 10% greater than the current value.

      Type: Integer

      Oracle

      Default: Uses existing setting

      Valid Values: 10-6144

      Constraints: Value supplied must be at least 10% greater than the current value. Values that are not at least 10% greater than the existing value are rounded up so that they are 10% greater than the current value.

      SQL Server

      Cannot be modified.

      If you choose to migrate your DB instance from using standard storage to using Provisioned IOPS, or from using Provisioned IOPS to using standard storage, the process can take time. The duration of the migration depends on several factors such as database load, storage size, storage type (standard or Provisioned IOPS), amount of IOPS provisioned (if any), and the number of prior scale storage operations. Typical migration times are under 24 hours, but the process can take up to several days in some cases. During the migration, the DB instance will be available for use, but might experience performance degradation. While the migration takes place, nightly backups for the instance will be 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.

    • withAllocatedStorage

      public ModifyDBInstanceRequest withAllocatedStorage(Integer allocatedStorage)

      The new storage capacity of the RDS instance. Changing this setting does not result in an outage and the change is applied during the next maintenance window unless ApplyImmediately is set to true for this request.

      MySQL

      Default: Uses existing setting

      Valid Values: 5-6144

      Constraints: Value supplied must be at least 10% greater than the current value. Values that are not at least 10% greater than the existing value are rounded up so that they are 10% greater than the current value.

      Type: Integer

      MariaDB

      Default: Uses existing setting

      Valid Values: 5-6144

      Constraints: Value supplied must be at least 10% greater than the current value. Values that are not at least 10% greater than the existing value are rounded up so that they are 10% greater than the current value.

      Type: Integer

      PostgreSQL

      Default: Uses existing setting

      Valid Values: 5-6144

      Constraints: Value supplied must be at least 10% greater than the current value. Values that are not at least 10% greater than the existing value are rounded up so that they are 10% greater than the current value.

      Type: Integer

      Oracle

      Default: Uses existing setting

      Valid Values: 10-6144

      Constraints: Value supplied must be at least 10% greater than the current value. Values that are not at least 10% greater than the existing value are rounded up so that they are 10% greater than the current value.

      SQL Server

      Cannot be modified.

      If you choose to migrate your DB instance from using standard storage to using Provisioned IOPS, or from using Provisioned IOPS to using standard storage, the process can take time. The duration of the migration depends on several factors such as database load, storage size, storage type (standard or Provisioned IOPS), amount of IOPS provisioned (if any), and the number of prior scale storage operations. Typical migration times are under 24 hours, but the process can take up to several days in some cases. During the migration, the DB instance will be available for use, but might experience performance degradation. While the migration takes place, nightly backups for the instance will be 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.

      Parameters:
      allocatedStorage - The new storage capacity of the RDS instance. Changing this setting does not result in an outage and the change is applied during the next maintenance window unless ApplyImmediately is set to true for this request.

      MySQL

      Default: Uses existing setting

      Valid Values: 5-6144

      Constraints: Value supplied must be at least 10% greater than the current value. Values that are not at least 10% greater than the existing value are rounded up so that they are 10% greater than the current value.

      Type: Integer

      MariaDB

      Default: Uses existing setting

      Valid Values: 5-6144

      Constraints: Value supplied must be at least 10% greater than the current value. Values that are not at least 10% greater than the existing value are rounded up so that they are 10% greater than the current value.

      Type: Integer

      PostgreSQL

      Default: Uses existing setting

      Valid Values: 5-6144

      Constraints: Value supplied must be at least 10% greater than the current value. Values that are not at least 10% greater than the existing value are rounded up so that they are 10% greater than the current value.

      Type: Integer

      Oracle

      Default: Uses existing setting

      Valid Values: 10-6144

      Constraints: Value supplied must be at least 10% greater than the current value. Values that are not at least 10% greater than the existing value are rounded up so that they are 10% greater than the current value.

      SQL Server

      Cannot be modified.

      If you choose to migrate your DB instance from using standard storage to using Provisioned IOPS, or from using Provisioned IOPS to using standard storage, the process can take time. The duration of the migration depends on several factors such as database load, storage size, storage type (standard or Provisioned IOPS), amount of IOPS provisioned (if any), and the number of prior scale storage operations. Typical migration times are under 24 hours, but the process can take up to several days in some cases. During the migration, the DB instance will be available for use, but might experience performance degradation. While the migration takes place, nightly backups for the instance will be 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.

      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • setDBInstanceClass

      public void setDBInstanceClass(String dBInstanceClass)

      The new compute and memory capacity of the DB instance. To determine the instance classes that are available for a particular DB engine, use the DescribeOrderableDBInstanceOptions action.

      Passing a value for this setting causes an outage during the change and is applied during the next maintenance window, unless ApplyImmediately is specified as true for this request.

      Default: Uses existing setting

      Valid Values: db.t1.micro | db.m1.small | db.m1.medium | db.m1.large | db.m1.xlarge | db.m2.xlarge | db.m2.2xlarge | db.m2.4xlarge | db.m3.medium | db.m3.large | db.m3.xlarge | db.m3.2xlarge | db.m4.large | db.m4.xlarge | db.m4.2xlarge | db.m4.4xlarge | db.m4.10xlarge | db.r3.large | db.r3.xlarge | db.r3.2xlarge | db.r3.4xlarge | db.r3.8xlarge | db.t2.micro | db.t2.small | db.t2.medium | db.t2.large

      Parameters:
      dBInstanceClass - The new compute and memory capacity of the DB instance. To determine the instance classes that are available for a particular DB engine, use the DescribeOrderableDBInstanceOptions action.

      Passing a value for this setting causes an outage during the change and is applied during the next maintenance window, unless ApplyImmediately is specified as true for this request.

      Default: Uses existing setting

      Valid Values: db.t1.micro | db.m1.small | db.m1.medium | db.m1.large | db.m1.xlarge | db.m2.xlarge | db.m2.2xlarge | db.m2.4xlarge | db.m3.medium | db.m3.large | db.m3.xlarge | db.m3.2xlarge | db.m4.large | db.m4.xlarge | db.m4.2xlarge | db.m4.4xlarge | db.m4.10xlarge | db.r3.large | db.r3.xlarge | db.r3.2xlarge | db.r3.4xlarge | db.r3.8xlarge | db.t2.micro | db.t2.small | db.t2.medium | db.t2.large

    • getDBInstanceClass

      public String getDBInstanceClass()

      The new compute and memory capacity of the DB instance. To determine the instance classes that are available for a particular DB engine, use the DescribeOrderableDBInstanceOptions action.

      Passing a value for this setting causes an outage during the change and is applied during the next maintenance window, unless ApplyImmediately is specified as true for this request.

      Default: Uses existing setting

      Valid Values: db.t1.micro | db.m1.small | db.m1.medium | db.m1.large | db.m1.xlarge | db.m2.xlarge | db.m2.2xlarge | db.m2.4xlarge | db.m3.medium | db.m3.large | db.m3.xlarge | db.m3.2xlarge | db.m4.large | db.m4.xlarge | db.m4.2xlarge | db.m4.4xlarge | db.m4.10xlarge | db.r3.large | db.r3.xlarge | db.r3.2xlarge | db.r3.4xlarge | db.r3.8xlarge | db.t2.micro | db.t2.small | db.t2.medium | db.t2.large

      Returns:
      The new compute and memory capacity of the DB instance. To determine the instance classes that are available for a particular DB engine, use the DescribeOrderableDBInstanceOptions action.

      Passing a value for this setting causes an outage during the change and is applied during the next maintenance window, unless ApplyImmediately is specified as true for this request.

      Default: Uses existing setting

      Valid Values: db.t1.micro | db.m1.small | db.m1.medium | db.m1.large | db.m1.xlarge | db.m2.xlarge | db.m2.2xlarge | db.m2.4xlarge | db.m3.medium | db.m3.large | db.m3.xlarge | db.m3.2xlarge | db.m4.large | db.m4.xlarge | db.m4.2xlarge | db.m4.4xlarge | db.m4.10xlarge | db.r3.large | db.r3.xlarge | db.r3.2xlarge | db.r3.4xlarge | db.r3.8xlarge | db.t2.micro | db.t2.small | db.t2.medium | db.t2.large

    • withDBInstanceClass

      public ModifyDBInstanceRequest withDBInstanceClass(String dBInstanceClass)

      The new compute and memory capacity of the DB instance. To determine the instance classes that are available for a particular DB engine, use the DescribeOrderableDBInstanceOptions action.

      Passing a value for this setting causes an outage during the change and is applied during the next maintenance window, unless ApplyImmediately is specified as true for this request.

      Default: Uses existing setting

      Valid Values: db.t1.micro | db.m1.small | db.m1.medium | db.m1.large | db.m1.xlarge | db.m2.xlarge | db.m2.2xlarge | db.m2.4xlarge | db.m3.medium | db.m3.large | db.m3.xlarge | db.m3.2xlarge | db.m4.large | db.m4.xlarge | db.m4.2xlarge | db.m4.4xlarge | db.m4.10xlarge | db.r3.large | db.r3.xlarge | db.r3.2xlarge | db.r3.4xlarge | db.r3.8xlarge | db.t2.micro | db.t2.small | db.t2.medium | db.t2.large

      Parameters:
      dBInstanceClass - The new compute and memory capacity of the DB instance. To determine the instance classes that are available for a particular DB engine, use the DescribeOrderableDBInstanceOptions action.

      Passing a value for this setting causes an outage during the change and is applied during the next maintenance window, unless ApplyImmediately is specified as true for this request.

      Default: Uses existing setting

      Valid Values: db.t1.micro | db.m1.small | db.m1.medium | db.m1.large | db.m1.xlarge | db.m2.xlarge | db.m2.2xlarge | db.m2.4xlarge | db.m3.medium | db.m3.large | db.m3.xlarge | db.m3.2xlarge | db.m4.large | db.m4.xlarge | db.m4.2xlarge | db.m4.4xlarge | db.m4.10xlarge | db.r3.large | db.r3.xlarge | db.r3.2xlarge | db.r3.4xlarge | db.r3.8xlarge | db.t2.micro | db.t2.small | db.t2.medium | db.t2.large

      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • getDBSecurityGroups

      public List<String> getDBSecurityGroups()

      A list of DB security groups to authorize on this DB instance. Changing this setting does not result in an outage and the change is asynchronously applied as soon as possible.

      Constraints:

      • Must be 1 to 255 alphanumeric characters
      • First character must be a letter
      • Cannot end with a hyphen or contain two consecutive hyphens
      Returns:
      A list of DB security groups to authorize on this DB instance. Changing this setting does not result in an outage and the change is asynchronously applied as soon as possible.

      Constraints:

      • Must be 1 to 255 alphanumeric characters
      • First character must be a letter
      • Cannot end with a hyphen or contain two consecutive hyphens
    • setDBSecurityGroups

      public void setDBSecurityGroups(Collection<String> dBSecurityGroups)

      A list of DB security groups to authorize on this DB instance. Changing this setting does not result in an outage and the change is asynchronously applied as soon as possible.

      Constraints:

      • Must be 1 to 255 alphanumeric characters
      • First character must be a letter
      • Cannot end with a hyphen or contain two consecutive hyphens
      Parameters:
      dBSecurityGroups - A list of DB security groups to authorize on this DB instance. Changing this setting does not result in an outage and the change is asynchronously applied as soon as possible.

      Constraints:

      • Must be 1 to 255 alphanumeric characters
      • First character must be a letter
      • Cannot end with a hyphen or contain two consecutive hyphens
    • withDBSecurityGroups

      public ModifyDBInstanceRequest withDBSecurityGroups(String... dBSecurityGroups)

      A list of DB security groups to authorize on this DB instance. Changing this setting does not result in an outage and the change is asynchronously applied as soon as possible.

      Constraints:

      • Must be 1 to 255 alphanumeric characters
      • First character must be a letter
      • Cannot end with a hyphen or contain two consecutive hyphens

      NOTE: This method appends the values to the existing list (if any). Use setDBSecurityGroups(java.util.Collection) or withDBSecurityGroups(java.util.Collection) if you want to override the existing values.

      Parameters:
      dBSecurityGroups - A list of DB security groups to authorize on this DB instance. Changing this setting does not result in an outage and the change is asynchronously applied as soon as possible.

      Constraints:

      • Must be 1 to 255 alphanumeric characters
      • First character must be a letter
      • Cannot end with a hyphen or contain two consecutive hyphens
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • withDBSecurityGroups

      public ModifyDBInstanceRequest withDBSecurityGroups(Collection<String> dBSecurityGroups)

      A list of DB security groups to authorize on this DB instance. Changing this setting does not result in an outage and the change is asynchronously applied as soon as possible.

      Constraints:

      • Must be 1 to 255 alphanumeric characters
      • First character must be a letter
      • Cannot end with a hyphen or contain two consecutive hyphens
      Parameters:
      dBSecurityGroups - A list of DB security groups to authorize on this DB instance. Changing this setting does not result in an outage and the change is asynchronously applied as soon as possible.

      Constraints:

      • Must be 1 to 255 alphanumeric characters
      • First character must be a letter
      • Cannot end with a hyphen or contain two consecutive hyphens
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • getVpcSecurityGroupIds

      public List<String> getVpcSecurityGroupIds()

      A list of EC2 VPC security groups to authorize on this DB instance. This change is asynchronously applied as soon as possible.

      Constraints:

      • Must be 1 to 255 alphanumeric characters
      • First character must be a letter
      • Cannot end with a hyphen or contain two consecutive hyphens
      Returns:
      A list of EC2 VPC security groups to authorize on this DB instance. This change is asynchronously applied as soon as possible.

      Constraints:

      • Must be 1 to 255 alphanumeric characters
      • First character must be a letter
      • Cannot end with a hyphen or contain two consecutive hyphens
    • setVpcSecurityGroupIds

      public void setVpcSecurityGroupIds(Collection<String> vpcSecurityGroupIds)

      A list of EC2 VPC security groups to authorize on this DB instance. This change is asynchronously applied as soon as possible.

      Constraints:

      • Must be 1 to 255 alphanumeric characters
      • First character must be a letter
      • Cannot end with a hyphen or contain two consecutive hyphens
      Parameters:
      vpcSecurityGroupIds - A list of EC2 VPC security groups to authorize on this DB instance. This change is asynchronously applied as soon as possible.

      Constraints:

      • Must be 1 to 255 alphanumeric characters
      • First character must be a letter
      • Cannot end with a hyphen or contain two consecutive hyphens
    • withVpcSecurityGroupIds

      public ModifyDBInstanceRequest withVpcSecurityGroupIds(String... vpcSecurityGroupIds)

      A list of EC2 VPC security groups to authorize on this DB instance. This change is asynchronously applied as soon as possible.

      Constraints:

      • Must be 1 to 255 alphanumeric characters
      • First character must be a letter
      • Cannot end with a hyphen or contain two consecutive hyphens

      NOTE: This method appends the values to the existing list (if any). Use setVpcSecurityGroupIds(java.util.Collection) or withVpcSecurityGroupIds(java.util.Collection) if you want to override the existing values.

      Parameters:
      vpcSecurityGroupIds - A list of EC2 VPC security groups to authorize on this DB instance. This change is asynchronously applied as soon as possible.

      Constraints:

      • Must be 1 to 255 alphanumeric characters
      • First character must be a letter
      • Cannot end with a hyphen or contain two consecutive hyphens
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • withVpcSecurityGroupIds

      public ModifyDBInstanceRequest withVpcSecurityGroupIds(Collection<String> vpcSecurityGroupIds)

      A list of EC2 VPC security groups to authorize on this DB instance. This change is asynchronously applied as soon as possible.

      Constraints:

      • Must be 1 to 255 alphanumeric characters
      • First character must be a letter
      • Cannot end with a hyphen or contain two consecutive hyphens
      Parameters:
      vpcSecurityGroupIds - A list of EC2 VPC security groups to authorize on this DB instance. This change is asynchronously applied as soon as possible.

      Constraints:

      • Must be 1 to 255 alphanumeric characters
      • First character must be a letter
      • Cannot end with a hyphen or contain two consecutive hyphens
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • setApplyImmediately

      public void setApplyImmediately(Boolean applyImmediately)

      Specifies whether the modifications in this request and any pending modifications are asynchronously applied as soon as possible, regardless of the PreferredMaintenanceWindow setting for the DB instance.

      If this parameter is set to false, changes to the DB instance are applied during the next maintenance window. Some parameter changes can cause an outage and will be applied on the next call to RebootDBInstance, or the next failure reboot. Review the table of parameters in Modifying a DB Instance and Using the Apply Immediately Parameter to see the impact that setting ApplyImmediately to true or false has for each modified parameter and to determine when the changes will be applied.

      Default: false

      Parameters:
      applyImmediately - Specifies whether the modifications in this request and any pending modifications are asynchronously applied as soon as possible, regardless of the PreferredMaintenanceWindow setting for the DB instance.

      If this parameter is set to false, changes to the DB instance are applied during the next maintenance window. Some parameter changes can cause an outage and will be applied on the next call to RebootDBInstance, or the next failure reboot. Review the table of parameters in Modifying a DB Instance and Using the Apply Immediately Parameter to see the impact that setting ApplyImmediately to true or false has for each modified parameter and to determine when the changes will be applied.

      Default: false

    • getApplyImmediately

      public Boolean getApplyImmediately()

      Specifies whether the modifications in this request and any pending modifications are asynchronously applied as soon as possible, regardless of the PreferredMaintenanceWindow setting for the DB instance.

      If this parameter is set to false, changes to the DB instance are applied during the next maintenance window. Some parameter changes can cause an outage and will be applied on the next call to RebootDBInstance, or the next failure reboot. Review the table of parameters in Modifying a DB Instance and Using the Apply Immediately Parameter to see the impact that setting ApplyImmediately to true or false has for each modified parameter and to determine when the changes will be applied.

      Default: false

      Returns:
      Specifies whether the modifications in this request and any pending modifications are asynchronously applied as soon as possible, regardless of the PreferredMaintenanceWindow setting for the DB instance.

      If this parameter is set to false, changes to the DB instance are applied during the next maintenance window. Some parameter changes can cause an outage and will be applied on the next call to RebootDBInstance, or the next failure reboot. Review the table of parameters in Modifying a DB Instance and Using the Apply Immediately Parameter to see the impact that setting ApplyImmediately to true or false has for each modified parameter and to determine when the changes will be applied.

      Default: false

    • withApplyImmediately

      public ModifyDBInstanceRequest withApplyImmediately(Boolean applyImmediately)

      Specifies whether the modifications in this request and any pending modifications are asynchronously applied as soon as possible, regardless of the PreferredMaintenanceWindow setting for the DB instance.

      If this parameter is set to false, changes to the DB instance are applied during the next maintenance window. Some parameter changes can cause an outage and will be applied on the next call to RebootDBInstance, or the next failure reboot. Review the table of parameters in Modifying a DB Instance and Using the Apply Immediately Parameter to see the impact that setting ApplyImmediately to true or false has for each modified parameter and to determine when the changes will be applied.

      Default: false

      Parameters:
      applyImmediately - Specifies whether the modifications in this request and any pending modifications are asynchronously applied as soon as possible, regardless of the PreferredMaintenanceWindow setting for the DB instance.

      If this parameter is set to false, changes to the DB instance are applied during the next maintenance window. Some parameter changes can cause an outage and will be applied on the next call to RebootDBInstance, or the next failure reboot. Review the table of parameters in Modifying a DB Instance and Using the Apply Immediately Parameter to see the impact that setting ApplyImmediately to true or false has for each modified parameter and to determine when the changes will be applied.

      Default: false

      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • isApplyImmediately

      public Boolean isApplyImmediately()

      Specifies whether the modifications in this request and any pending modifications are asynchronously applied as soon as possible, regardless of the PreferredMaintenanceWindow setting for the DB instance.

      If this parameter is set to false, changes to the DB instance are applied during the next maintenance window. Some parameter changes can cause an outage and will be applied on the next call to RebootDBInstance, or the next failure reboot. Review the table of parameters in Modifying a DB Instance and Using the Apply Immediately Parameter to see the impact that setting ApplyImmediately to true or false has for each modified parameter and to determine when the changes will be applied.

      Default: false

      Returns:
      Specifies whether the modifications in this request and any pending modifications are asynchronously applied as soon as possible, regardless of the PreferredMaintenanceWindow setting for the DB instance.

      If this parameter is set to false, changes to the DB instance are applied during the next maintenance window. Some parameter changes can cause an outage and will be applied on the next call to RebootDBInstance, or the next failure reboot. Review the table of parameters in Modifying a DB Instance and Using the Apply Immediately Parameter to see the impact that setting ApplyImmediately to true or false has for each modified parameter and to determine when the changes will be applied.

      Default: false

    • setMasterUserPassword

      public void setMasterUserPassword(String masterUserPassword)

      The new password for the DB instance master user. Can be any printable ASCII character except "/", """, or "@".

      Changing this parameter does not result in an outage and the change is asynchronously applied as soon as possible. Between the time of the request and the completion of the request, the MasterUserPassword element exists in the PendingModifiedValues element of the operation response.

      Default: Uses existing setting

      Constraints: Must be 8 to 41 alphanumeric characters (MySQL, MariaDB, and Amazon Aurora), 8 to 30 alphanumeric characters (Oracle), or 8 to 128 alphanumeric characters (SQL Server).

      Amazon RDS API actions never return the password, so this action provides a way to regain access to a primary instance user if the password is lost. This includes restoring privileges that might have been accidentally revoked.
      Parameters:
      masterUserPassword - The new password for the DB instance master user. Can be any printable ASCII character except "/", """, or "@".

      Changing this parameter does not result in an outage and the change is asynchronously applied as soon as possible. Between the time of the request and the completion of the request, the MasterUserPassword element exists in the PendingModifiedValues element of the operation response.

      Default: Uses existing setting

      Constraints: Must be 8 to 41 alphanumeric characters (MySQL, MariaDB, and Amazon Aurora), 8 to 30 alphanumeric characters (Oracle), or 8 to 128 alphanumeric characters (SQL Server).

      Amazon RDS API actions never return the password, so this action provides a way to regain access to a primary instance user if the password is lost. This includes restoring privileges that might have been accidentally revoked.
    • getMasterUserPassword

      public String getMasterUserPassword()

      The new password for the DB instance master user. Can be any printable ASCII character except "/", """, or "@".

      Changing this parameter does not result in an outage and the change is asynchronously applied as soon as possible. Between the time of the request and the completion of the request, the MasterUserPassword element exists in the PendingModifiedValues element of the operation response.

      Default: Uses existing setting

      Constraints: Must be 8 to 41 alphanumeric characters (MySQL, MariaDB, and Amazon Aurora), 8 to 30 alphanumeric characters (Oracle), or 8 to 128 alphanumeric characters (SQL Server).

      Amazon RDS API actions never return the password, so this action provides a way to regain access to a primary instance user if the password is lost. This includes restoring privileges that might have been accidentally revoked.
      Returns:
      The new password for the DB instance master user. Can be any printable ASCII character except "/", """, or "@".

      Changing this parameter does not result in an outage and the change is asynchronously applied as soon as possible. Between the time of the request and the completion of the request, the MasterUserPassword element exists in the PendingModifiedValues element of the operation response.

      Default: Uses existing setting

      Constraints: Must be 8 to 41 alphanumeric characters (MySQL, MariaDB, and Amazon Aurora), 8 to 30 alphanumeric characters (Oracle), or 8 to 128 alphanumeric characters (SQL Server).

      Amazon RDS API actions never return the password, so this action provides a way to regain access to a primary instance user if the password is lost. This includes restoring privileges that might have been accidentally revoked.
    • withMasterUserPassword

      public ModifyDBInstanceRequest withMasterUserPassword(String masterUserPassword)

      The new password for the DB instance master user. Can be any printable ASCII character except "/", """, or "@".

      Changing this parameter does not result in an outage and the change is asynchronously applied as soon as possible. Between the time of the request and the completion of the request, the MasterUserPassword element exists in the PendingModifiedValues element of the operation response.

      Default: Uses existing setting

      Constraints: Must be 8 to 41 alphanumeric characters (MySQL, MariaDB, and Amazon Aurora), 8 to 30 alphanumeric characters (Oracle), or 8 to 128 alphanumeric characters (SQL Server).

      Amazon RDS API actions never return the password, so this action provides a way to regain access to a primary instance user if the password is lost. This includes restoring privileges that might have been accidentally revoked.
      Parameters:
      masterUserPassword - The new password for the DB instance master user. Can be any printable ASCII character except "/", """, or "@".

      Changing this parameter does not result in an outage and the change is asynchronously applied as soon as possible. Between the time of the request and the completion of the request, the MasterUserPassword element exists in the PendingModifiedValues element of the operation response.

      Default: Uses existing setting

      Constraints: Must be 8 to 41 alphanumeric characters (MySQL, MariaDB, and Amazon Aurora), 8 to 30 alphanumeric characters (Oracle), or 8 to 128 alphanumeric characters (SQL Server).

      Amazon RDS API actions never return the password, so this action provides a way to regain access to a primary instance user if the password is lost. This includes restoring privileges that might have been accidentally revoked.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • setDBParameterGroupName

      public void setDBParameterGroupName(String dBParameterGroupName)

      The name of the DB parameter group to apply to the DB instance. Changing this setting does not result in an outage. The parameter group name itself is changed immediately, but the actual parameter changes are not applied until you reboot the instance without failover. The db instance will NOT be rebooted automatically and the parameter changes will NOT be applied during the next maintenance window.

      Default: Uses existing setting

      Constraints: The DB parameter group must be in the same DB parameter group family as this DB instance.

      Parameters:
      dBParameterGroupName - The name of the DB parameter group to apply to the DB instance. Changing this setting does not result in an outage. The parameter group name itself is changed immediately, but the actual parameter changes are not applied until you reboot the instance without failover. The db instance will NOT be rebooted automatically and the parameter changes will NOT be applied during the next maintenance window.

      Default: Uses existing setting

      Constraints: The DB parameter group must be in the same DB parameter group family as this DB instance.

    • getDBParameterGroupName

      public String getDBParameterGroupName()

      The name of the DB parameter group to apply to the DB instance. Changing this setting does not result in an outage. The parameter group name itself is changed immediately, but the actual parameter changes are not applied until you reboot the instance without failover. The db instance will NOT be rebooted automatically and the parameter changes will NOT be applied during the next maintenance window.

      Default: Uses existing setting

      Constraints: The DB parameter group must be in the same DB parameter group family as this DB instance.

      Returns:
      The name of the DB parameter group to apply to the DB instance. Changing this setting does not result in an outage. The parameter group name itself is changed immediately, but the actual parameter changes are not applied until you reboot the instance without failover. The db instance will NOT be rebooted automatically and the parameter changes will NOT be applied during the next maintenance window.

      Default: Uses existing setting

      Constraints: The DB parameter group must be in the same DB parameter group family as this DB instance.

    • withDBParameterGroupName

      public ModifyDBInstanceRequest withDBParameterGroupName(String dBParameterGroupName)

      The name of the DB parameter group to apply to the DB instance. Changing this setting does not result in an outage. The parameter group name itself is changed immediately, but the actual parameter changes are not applied until you reboot the instance without failover. The db instance will NOT be rebooted automatically and the parameter changes will NOT be applied during the next maintenance window.

      Default: Uses existing setting

      Constraints: The DB parameter group must be in the same DB parameter group family as this DB instance.

      Parameters:
      dBParameterGroupName - The name of the DB parameter group to apply to the DB instance. Changing this setting does not result in an outage. The parameter group name itself is changed immediately, but the actual parameter changes are not applied until you reboot the instance without failover. The db instance will NOT be rebooted automatically and the parameter changes will NOT be applied during the next maintenance window.

      Default: Uses existing setting

      Constraints: The DB parameter group must be in the same DB parameter group family as this DB instance.

      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • setBackupRetentionPeriod

      public void setBackupRetentionPeriod(Integer backupRetentionPeriod)

      The number of days to retain automated backups. Setting this parameter to a positive number enables backups. Setting this parameter to 0 disables automated backups.

      Changing this parameter can result in an outage if you change from 0 to a non-zero value or from a non-zero value to 0. These changes are applied during the next maintenance window unless the ApplyImmediately parameter is set to true for this request. If you change the parameter from one non-zero value to another non-zero value, the change is asynchronously applied as soon as possible.

      Default: Uses existing setting

      Constraints:

      • Must be a value from 0 to 35
      • Can be specified for a MySQL Read Replica only if the source is running MySQL 5.6
      • Can be specified for a PostgreSQL Read Replica only if the source is running PostgreSQL 9.3.5
      • Cannot be set to 0 if the DB instance is a source to Read Replicas
      Parameters:
      backupRetentionPeriod - The number of days to retain automated backups. Setting this parameter to a positive number enables backups. Setting this parameter to 0 disables automated backups.

      Changing this parameter can result in an outage if you change from 0 to a non-zero value or from a non-zero value to 0. These changes are applied during the next maintenance window unless the ApplyImmediately parameter is set to true for this request. If you change the parameter from one non-zero value to another non-zero value, the change is asynchronously applied as soon as possible.

      Default: Uses existing setting

      Constraints:

      • Must be a value from 0 to 35
      • Can be specified for a MySQL Read Replica only if the source is running MySQL 5.6
      • Can be specified for a PostgreSQL Read Replica only if the source is running PostgreSQL 9.3.5
      • Cannot be set to 0 if the DB instance is a source to Read Replicas
    • getBackupRetentionPeriod

      public Integer getBackupRetentionPeriod()

      The number of days to retain automated backups. Setting this parameter to a positive number enables backups. Setting this parameter to 0 disables automated backups.

      Changing this parameter can result in an outage if you change from 0 to a non-zero value or from a non-zero value to 0. These changes are applied during the next maintenance window unless the ApplyImmediately parameter is set to true for this request. If you change the parameter from one non-zero value to another non-zero value, the change is asynchronously applied as soon as possible.

      Default: Uses existing setting

      Constraints:

      • Must be a value from 0 to 35
      • Can be specified for a MySQL Read Replica only if the source is running MySQL 5.6
      • Can be specified for a PostgreSQL Read Replica only if the source is running PostgreSQL 9.3.5
      • Cannot be set to 0 if the DB instance is a source to Read Replicas
      Returns:
      The number of days to retain automated backups. Setting this parameter to a positive number enables backups. Setting this parameter to 0 disables automated backups.

      Changing this parameter can result in an outage if you change from 0 to a non-zero value or from a non-zero value to 0. These changes are applied during the next maintenance window unless the ApplyImmediately parameter is set to true for this request. If you change the parameter from one non-zero value to another non-zero value, the change is asynchronously applied as soon as possible.

      Default: Uses existing setting

      Constraints:

      • Must be a value from 0 to 35
      • Can be specified for a MySQL Read Replica only if the source is running MySQL 5.6
      • Can be specified for a PostgreSQL Read Replica only if the source is running PostgreSQL 9.3.5
      • Cannot be set to 0 if the DB instance is a source to Read Replicas
    • withBackupRetentionPeriod

      public ModifyDBInstanceRequest withBackupRetentionPeriod(Integer backupRetentionPeriod)

      The number of days to retain automated backups. Setting this parameter to a positive number enables backups. Setting this parameter to 0 disables automated backups.

      Changing this parameter can result in an outage if you change from 0 to a non-zero value or from a non-zero value to 0. These changes are applied during the next maintenance window unless the ApplyImmediately parameter is set to true for this request. If you change the parameter from one non-zero value to another non-zero value, the change is asynchronously applied as soon as possible.

      Default: Uses existing setting

      Constraints:

      • Must be a value from 0 to 35
      • Can be specified for a MySQL Read Replica only if the source is running MySQL 5.6
      • Can be specified for a PostgreSQL Read Replica only if the source is running PostgreSQL 9.3.5
      • Cannot be set to 0 if the DB instance is a source to Read Replicas
      Parameters:
      backupRetentionPeriod - The number of days to retain automated backups. Setting this parameter to a positive number enables backups. Setting this parameter to 0 disables automated backups.

      Changing this parameter can result in an outage if you change from 0 to a non-zero value or from a non-zero value to 0. These changes are applied during the next maintenance window unless the ApplyImmediately parameter is set to true for this request. If you change the parameter from one non-zero value to another non-zero value, the change is asynchronously applied as soon as possible.

      Default: Uses existing setting

      Constraints:

      • Must be a value from 0 to 35
      • Can be specified for a MySQL Read Replica only if the source is running MySQL 5.6
      • Can be specified for a PostgreSQL Read Replica only if the source is running PostgreSQL 9.3.5
      • Cannot be set to 0 if the DB instance is a source to Read Replicas
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • setPreferredBackupWindow

      public void setPreferredBackupWindow(String preferredBackupWindow)

      The daily time range during which automated backups are created if automated backups are enabled, as determined by the BackupRetentionPeriod parameter. Changing this parameter does not result in an outage and the change is asynchronously applied as soon as possible.

      Constraints:

      • Must be in the format hh24:mi-hh24:mi
      • Times should be in Universal Time Coordinated (UTC)
      • Must not conflict with the preferred maintenance window
      • Must be at least 30 minutes
      Parameters:
      preferredBackupWindow - The daily time range during which automated backups are created if automated backups are enabled, as determined by the BackupRetentionPeriod parameter. Changing this parameter does not result in an outage and the change is asynchronously applied as soon as possible.

      Constraints:

      • Must be in the format hh24:mi-hh24:mi
      • Times should be in Universal Time Coordinated (UTC)
      • Must not conflict with the preferred maintenance window
      • Must be at least 30 minutes
    • getPreferredBackupWindow

      public String getPreferredBackupWindow()

      The daily time range during which automated backups are created if automated backups are enabled, as determined by the BackupRetentionPeriod parameter. Changing this parameter does not result in an outage and the change is asynchronously applied as soon as possible.

      Constraints:

      • Must be in the format hh24:mi-hh24:mi
      • Times should be in Universal Time Coordinated (UTC)
      • Must not conflict with the preferred maintenance window
      • Must be at least 30 minutes
      Returns:
      The daily time range during which automated backups are created if automated backups are enabled, as determined by the BackupRetentionPeriod parameter. Changing this parameter does not result in an outage and the change is asynchronously applied as soon as possible.

      Constraints:

      • Must be in the format hh24:mi-hh24:mi
      • Times should be in Universal Time Coordinated (UTC)
      • Must not conflict with the preferred maintenance window
      • Must be at least 30 minutes
    • withPreferredBackupWindow

      public ModifyDBInstanceRequest withPreferredBackupWindow(String preferredBackupWindow)

      The daily time range during which automated backups are created if automated backups are enabled, as determined by the BackupRetentionPeriod parameter. Changing this parameter does not result in an outage and the change is asynchronously applied as soon as possible.

      Constraints:

      • Must be in the format hh24:mi-hh24:mi
      • Times should be in Universal Time Coordinated (UTC)
      • Must not conflict with the preferred maintenance window
      • Must be at least 30 minutes
      Parameters:
      preferredBackupWindow - The daily time range during which automated backups are created if automated backups are enabled, as determined by the BackupRetentionPeriod parameter. Changing this parameter does not result in an outage and the change is asynchronously applied as soon as possible.

      Constraints:

      • Must be in the format hh24:mi-hh24:mi
      • Times should be in Universal Time Coordinated (UTC)
      • Must not conflict with the preferred maintenance window
      • Must be at least 30 minutes
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • setPreferredMaintenanceWindow

      public void setPreferredMaintenanceWindow(String preferredMaintenanceWindow)

      The weekly time range (in UTC) during which system maintenance can occur, which might result in an outage. Changing this parameter does not result in an outage, except in the following situation, and the change is asynchronously applied as soon as possible. If there are pending actions that cause a reboot, and the maintenance window is changed to include the current time, then changing this parameter will cause a reboot of the DB instance. If moving this window to the current time, there must be at least 30 minutes between the current time and end of the window to ensure pending changes are applied.

      Default: Uses existing setting

      Format: ddd:hh24:mi-ddd:hh24:mi

      Valid Days: Mon | Tue | Wed | Thu | Fri | Sat | Sun

      Constraints: Must be at least 30 minutes

      Parameters:
      preferredMaintenanceWindow - The weekly time range (in UTC) during which system maintenance can occur, which might result in an outage. Changing this parameter does not result in an outage, except in the following situation, and the change is asynchronously applied as soon as possible. If there are pending actions that cause a reboot, and the maintenance window is changed to include the current time, then changing this parameter will cause a reboot of the DB instance. If moving this window to the current time, there must be at least 30 minutes between the current time and end of the window to ensure pending changes are applied.

      Default: Uses existing setting

      Format: ddd:hh24:mi-ddd:hh24:mi

      Valid Days: Mon | Tue | Wed | Thu | Fri | Sat | Sun

      Constraints: Must be at least 30 minutes

    • getPreferredMaintenanceWindow

      public String getPreferredMaintenanceWindow()

      The weekly time range (in UTC) during which system maintenance can occur, which might result in an outage. Changing this parameter does not result in an outage, except in the following situation, and the change is asynchronously applied as soon as possible. If there are pending actions that cause a reboot, and the maintenance window is changed to include the current time, then changing this parameter will cause a reboot of the DB instance. If moving this window to the current time, there must be at least 30 minutes between the current time and end of the window to ensure pending changes are applied.

      Default: Uses existing setting

      Format: ddd:hh24:mi-ddd:hh24:mi

      Valid Days: Mon | Tue | Wed | Thu | Fri | Sat | Sun

      Constraints: Must be at least 30 minutes

      Returns:
      The weekly time range (in UTC) during which system maintenance can occur, which might result in an outage. Changing this parameter does not result in an outage, except in the following situation, and the change is asynchronously applied as soon as possible. If there are pending actions that cause a reboot, and the maintenance window is changed to include the current time, then changing this parameter will cause a reboot of the DB instance. If moving this window to the current time, there must be at least 30 minutes between the current time and end of the window to ensure pending changes are applied.

      Default: Uses existing setting

      Format: ddd:hh24:mi-ddd:hh24:mi

      Valid Days: Mon | Tue | Wed | Thu | Fri | Sat | Sun

      Constraints: Must be at least 30 minutes

    • withPreferredMaintenanceWindow

      public ModifyDBInstanceRequest withPreferredMaintenanceWindow(String preferredMaintenanceWindow)

      The weekly time range (in UTC) during which system maintenance can occur, which might result in an outage. Changing this parameter does not result in an outage, except in the following situation, and the change is asynchronously applied as soon as possible. If there are pending actions that cause a reboot, and the maintenance window is changed to include the current time, then changing this parameter will cause a reboot of the DB instance. If moving this window to the current time, there must be at least 30 minutes between the current time and end of the window to ensure pending changes are applied.

      Default: Uses existing setting

      Format: ddd:hh24:mi-ddd:hh24:mi

      Valid Days: Mon | Tue | Wed | Thu | Fri | Sat | Sun

      Constraints: Must be at least 30 minutes

      Parameters:
      preferredMaintenanceWindow - The weekly time range (in UTC) during which system maintenance can occur, which might result in an outage. Changing this parameter does not result in an outage, except in the following situation, and the change is asynchronously applied as soon as possible. If there are pending actions that cause a reboot, and the maintenance window is changed to include the current time, then changing this parameter will cause a reboot of the DB instance. If moving this window to the current time, there must be at least 30 minutes between the current time and end of the window to ensure pending changes are applied.

      Default: Uses existing setting

      Format: ddd:hh24:mi-ddd:hh24:mi

      Valid Days: Mon | Tue | Wed | Thu | Fri | Sat | Sun

      Constraints: Must be at least 30 minutes

      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • setMultiAZ

      public void setMultiAZ(Boolean multiAZ)

      Specifies if the DB instance is a Multi-AZ deployment. Changing this parameter does not result in an outage and the change is applied during the next maintenance window unless the ApplyImmediately parameter is set to true for this request.

      Constraints: Cannot be specified if the DB instance is a Read Replica. This parameter cannot be used with SQL Server DB instances. Multi-AZ for SQL Server DB instances is set using the Mirroring option in an option group associated with the DB instance.

      Parameters:
      multiAZ - Specifies if the DB instance is a Multi-AZ deployment. Changing this parameter does not result in an outage and the change is applied during the next maintenance window unless the ApplyImmediately parameter is set to true for this request.

      Constraints: Cannot be specified if the DB instance is a Read Replica. This parameter cannot be used with SQL Server DB instances. Multi-AZ for SQL Server DB instances is set using the Mirroring option in an option group associated with the DB instance.

    • getMultiAZ

      public Boolean getMultiAZ()

      Specifies if the DB instance is a Multi-AZ deployment. Changing this parameter does not result in an outage and the change is applied during the next maintenance window unless the ApplyImmediately parameter is set to true for this request.

      Constraints: Cannot be specified if the DB instance is a Read Replica. This parameter cannot be used with SQL Server DB instances. Multi-AZ for SQL Server DB instances is set using the Mirroring option in an option group associated with the DB instance.

      Returns:
      Specifies if the DB instance is a Multi-AZ deployment. Changing this parameter does not result in an outage and the change is applied during the next maintenance window unless the ApplyImmediately parameter is set to true for this request.

      Constraints: Cannot be specified if the DB instance is a Read Replica. This parameter cannot be used with SQL Server DB instances. Multi-AZ for SQL Server DB instances is set using the Mirroring option in an option group associated with the DB instance.

    • withMultiAZ

      public ModifyDBInstanceRequest withMultiAZ(Boolean multiAZ)

      Specifies if the DB instance is a Multi-AZ deployment. Changing this parameter does not result in an outage and the change is applied during the next maintenance window unless the ApplyImmediately parameter is set to true for this request.

      Constraints: Cannot be specified if the DB instance is a Read Replica. This parameter cannot be used with SQL Server DB instances. Multi-AZ for SQL Server DB instances is set using the Mirroring option in an option group associated with the DB instance.

      Parameters:
      multiAZ - Specifies if the DB instance is a Multi-AZ deployment. Changing this parameter does not result in an outage and the change is applied during the next maintenance window unless the ApplyImmediately parameter is set to true for this request.

      Constraints: Cannot be specified if the DB instance is a Read Replica. This parameter cannot be used with SQL Server DB instances. Multi-AZ for SQL Server DB instances is set using the Mirroring option in an option group associated with the DB instance.

      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • isMultiAZ

      public Boolean isMultiAZ()

      Specifies if the DB instance is a Multi-AZ deployment. Changing this parameter does not result in an outage and the change is applied during the next maintenance window unless the ApplyImmediately parameter is set to true for this request.

      Constraints: Cannot be specified if the DB instance is a Read Replica. This parameter cannot be used with SQL Server DB instances. Multi-AZ for SQL Server DB instances is set using the Mirroring option in an option group associated with the DB instance.

      Returns:
      Specifies if the DB instance is a Multi-AZ deployment. Changing this parameter does not result in an outage and the change is applied during the next maintenance window unless the ApplyImmediately parameter is set to true for this request.

      Constraints: Cannot be specified if the DB instance is a Read Replica. This parameter cannot be used with SQL Server DB instances. Multi-AZ for SQL Server DB instances is set using the Mirroring option in an option group associated with the DB instance.

    • setEngineVersion

      public void setEngineVersion(String engineVersion)

      The version number of the database engine to upgrade to. Changing this parameter results in an outage and the change is applied during the next maintenance window unless the ApplyImmediately parameter is set to true for this request.

      For major version upgrades, if a non-default DB parameter group is currently in use, a new DB parameter group in the DB parameter group family for the new engine version must be specified. The new DB parameter group can be the default for that DB parameter group family.

      For a list of valid engine versions, see CreateDBInstance.

      Parameters:
      engineVersion - The version number of the database engine to upgrade to. Changing this parameter results in an outage and the change is applied during the next maintenance window unless the ApplyImmediately parameter is set to true for this request.

      For major version upgrades, if a non-default DB parameter group is currently in use, a new DB parameter group in the DB parameter group family for the new engine version must be specified. The new DB parameter group can be the default for that DB parameter group family.

      For a list of valid engine versions, see CreateDBInstance.

    • getEngineVersion

      public String getEngineVersion()

      The version number of the database engine to upgrade to. Changing this parameter results in an outage and the change is applied during the next maintenance window unless the ApplyImmediately parameter is set to true for this request.

      For major version upgrades, if a non-default DB parameter group is currently in use, a new DB parameter group in the DB parameter group family for the new engine version must be specified. The new DB parameter group can be the default for that DB parameter group family.

      For a list of valid engine versions, see CreateDBInstance.

      Returns:
      The version number of the database engine to upgrade to. Changing this parameter results in an outage and the change is applied during the next maintenance window unless the ApplyImmediately parameter is set to true for this request.

      For major version upgrades, if a non-default DB parameter group is currently in use, a new DB parameter group in the DB parameter group family for the new engine version must be specified. The new DB parameter group can be the default for that DB parameter group family.

      For a list of valid engine versions, see CreateDBInstance.

    • withEngineVersion

      public ModifyDBInstanceRequest withEngineVersion(String engineVersion)

      The version number of the database engine to upgrade to. Changing this parameter results in an outage and the change is applied during the next maintenance window unless the ApplyImmediately parameter is set to true for this request.

      For major version upgrades, if a non-default DB parameter group is currently in use, a new DB parameter group in the DB parameter group family for the new engine version must be specified. The new DB parameter group can be the default for that DB parameter group family.

      For a list of valid engine versions, see CreateDBInstance.

      Parameters:
      engineVersion - The version number of the database engine to upgrade to. Changing this parameter results in an outage and the change is applied during the next maintenance window unless the ApplyImmediately parameter is set to true for this request.

      For major version upgrades, if a non-default DB parameter group is currently in use, a new DB parameter group in the DB parameter group family for the new engine version must be specified. The new DB parameter group can be the default for that DB parameter group family.

      For a list of valid engine versions, see CreateDBInstance.

      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • setAllowMajorVersionUpgrade

      public void setAllowMajorVersionUpgrade(Boolean allowMajorVersionUpgrade)

      Indicates that major version upgrades are allowed. Changing this parameter does not result in an outage and the change is asynchronously applied as soon as possible.

      Constraints: This parameter must be set to true when specifying a value for the EngineVersion parameter that is a different major version than the DB instance's current version.

      Parameters:
      allowMajorVersionUpgrade - Indicates that major version upgrades are allowed. Changing this parameter does not result in an outage and the change is asynchronously applied as soon as possible.

      Constraints: This parameter must be set to true when specifying a value for the EngineVersion parameter that is a different major version than the DB instance's current version.

    • getAllowMajorVersionUpgrade

      public Boolean getAllowMajorVersionUpgrade()

      Indicates that major version upgrades are allowed. Changing this parameter does not result in an outage and the change is asynchronously applied as soon as possible.

      Constraints: This parameter must be set to true when specifying a value for the EngineVersion parameter that is a different major version than the DB instance's current version.

      Returns:
      Indicates that major version upgrades are allowed. Changing this parameter does not result in an outage and the change is asynchronously applied as soon as possible.

      Constraints: This parameter must be set to true when specifying a value for the EngineVersion parameter that is a different major version than the DB instance's current version.

    • withAllowMajorVersionUpgrade

      public ModifyDBInstanceRequest withAllowMajorVersionUpgrade(Boolean allowMajorVersionUpgrade)

      Indicates that major version upgrades are allowed. Changing this parameter does not result in an outage and the change is asynchronously applied as soon as possible.

      Constraints: This parameter must be set to true when specifying a value for the EngineVersion parameter that is a different major version than the DB instance's current version.

      Parameters:
      allowMajorVersionUpgrade - Indicates that major version upgrades are allowed. Changing this parameter does not result in an outage and the change is asynchronously applied as soon as possible.

      Constraints: This parameter must be set to true when specifying a value for the EngineVersion parameter that is a different major version than the DB instance's current version.

      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • isAllowMajorVersionUpgrade

      public Boolean isAllowMajorVersionUpgrade()

      Indicates that major version upgrades are allowed. Changing this parameter does not result in an outage and the change is asynchronously applied as soon as possible.

      Constraints: This parameter must be set to true when specifying a value for the EngineVersion parameter that is a different major version than the DB instance's current version.

      Returns:
      Indicates that major version upgrades are allowed. Changing this parameter does not result in an outage and the change is asynchronously applied as soon as possible.

      Constraints: This parameter must be set to true when specifying a value for the EngineVersion parameter that is a different major version than the DB instance's current version.

    • setAutoMinorVersionUpgrade

      public void setAutoMinorVersionUpgrade(Boolean autoMinorVersionUpgrade)

      Indicates that minor version upgrades will be applied automatically to the DB instance during the maintenance window. Changing this parameter does not result in an outage except in the following case and the change is asynchronously applied as soon as possible. An outage will result if this parameter is set to true during the maintenance window, and a newer minor version is available, and RDS has enabled auto patching for that engine version.

      Parameters:
      autoMinorVersionUpgrade - Indicates that minor version upgrades will be applied automatically to the DB instance during the maintenance window. Changing this parameter does not result in an outage except in the following case and the change is asynchronously applied as soon as possible. An outage will result if this parameter is set to true during the maintenance window, and a newer minor version is available, and RDS has enabled auto patching for that engine version.
    • getAutoMinorVersionUpgrade

      public Boolean getAutoMinorVersionUpgrade()

      Indicates that minor version upgrades will be applied automatically to the DB instance during the maintenance window. Changing this parameter does not result in an outage except in the following case and the change is asynchronously applied as soon as possible. An outage will result if this parameter is set to true during the maintenance window, and a newer minor version is available, and RDS has enabled auto patching for that engine version.

      Returns:
      Indicates that minor version upgrades will be applied automatically to the DB instance during the maintenance window. Changing this parameter does not result in an outage except in the following case and the change is asynchronously applied as soon as possible. An outage will result if this parameter is set to true during the maintenance window, and a newer minor version is available, and RDS has enabled auto patching for that engine version.
    • withAutoMinorVersionUpgrade

      public ModifyDBInstanceRequest withAutoMinorVersionUpgrade(Boolean autoMinorVersionUpgrade)

      Indicates that minor version upgrades will be applied automatically to the DB instance during the maintenance window. Changing this parameter does not result in an outage except in the following case and the change is asynchronously applied as soon as possible. An outage will result if this parameter is set to true during the maintenance window, and a newer minor version is available, and RDS has enabled auto patching for that engine version.

      Parameters:
      autoMinorVersionUpgrade - Indicates that minor version upgrades will be applied automatically to the DB instance during the maintenance window. Changing this parameter does not result in an outage except in the following case and the change is asynchronously applied as soon as possible. An outage will result if this parameter is set to true during the maintenance window, and a newer minor version is available, and RDS has enabled auto patching for that engine version.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • isAutoMinorVersionUpgrade

      public Boolean isAutoMinorVersionUpgrade()

      Indicates that minor version upgrades will be applied automatically to the DB instance during the maintenance window. Changing this parameter does not result in an outage except in the following case and the change is asynchronously applied as soon as possible. An outage will result if this parameter is set to true during the maintenance window, and a newer minor version is available, and RDS has enabled auto patching for that engine version.

      Returns:
      Indicates that minor version upgrades will be applied automatically to the DB instance during the maintenance window. Changing this parameter does not result in an outage except in the following case and the change is asynchronously applied as soon as possible. An outage will result if this parameter is set to true during the maintenance window, and a newer minor version is available, and RDS has enabled auto patching for that engine version.
    • setIops

      public void setIops(Integer iops)

      The new Provisioned IOPS (I/O operations per second) value for the RDS instance. Changing this setting does not result in an outage and the change is applied during the next maintenance window unless the ApplyImmediately parameter is set to true for this request.

      Default: Uses existing setting

      Constraints: Value supplied must be at least 10% greater than the current value. Values that are not at least 10% greater than the existing value are rounded up so that they are 10% greater than the current value. If you are migrating from Provisioned IOPS to standard storage, set this value to 0. The DB instance will require a reboot for the change in storage type to take effect.

      SQL Server

      Setting the IOPS value for the SQL Server database engine is not supported.

      Type: Integer

      If you choose to migrate your DB instance from using standard storage to using Provisioned IOPS, or from using Provisioned IOPS to using standard storage, the process can take time. The duration of the migration depends on several factors such as database load, storage size, storage type (standard or Provisioned IOPS), amount of IOPS provisioned (if any), and the number of prior scale storage operations. Typical migration times are under 24 hours, but the process can take up to several days in some cases. During the migration, the DB instance will be available for use, but might experience performance degradation. While the migration takes place, nightly backups for the instance will be 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.

      Parameters:
      iops - The new Provisioned IOPS (I/O operations per second) value for the RDS instance. Changing this setting does not result in an outage and the change is applied during the next maintenance window unless the ApplyImmediately parameter is set to true for this request.

      Default: Uses existing setting

      Constraints: Value supplied must be at least 10% greater than the current value. Values that are not at least 10% greater than the existing value are rounded up so that they are 10% greater than the current value. If you are migrating from Provisioned IOPS to standard storage, set this value to 0. The DB instance will require a reboot for the change in storage type to take effect.

      SQL Server

      Setting the IOPS value for the SQL Server database engine is not supported.

      Type: Integer

      If you choose to migrate your DB instance from using standard storage to using Provisioned IOPS, or from using Provisioned IOPS to using standard storage, the process can take time. The duration of the migration depends on several factors such as database load, storage size, storage type (standard or Provisioned IOPS), amount of IOPS provisioned (if any), and the number of prior scale storage operations. Typical migration times are under 24 hours, but the process can take up to several days in some cases. During the migration, the DB instance will be available for use, but might experience performance degradation. While the migration takes place, nightly backups for the instance will be 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.

    • getIops

      public Integer getIops()

      The new Provisioned IOPS (I/O operations per second) value for the RDS instance. Changing this setting does not result in an outage and the change is applied during the next maintenance window unless the ApplyImmediately parameter is set to true for this request.

      Default: Uses existing setting

      Constraints: Value supplied must be at least 10% greater than the current value. Values that are not at least 10% greater than the existing value are rounded up so that they are 10% greater than the current value. If you are migrating from Provisioned IOPS to standard storage, set this value to 0. The DB instance will require a reboot for the change in storage type to take effect.

      SQL Server

      Setting the IOPS value for the SQL Server database engine is not supported.

      Type: Integer

      If you choose to migrate your DB instance from using standard storage to using Provisioned IOPS, or from using Provisioned IOPS to using standard storage, the process can take time. The duration of the migration depends on several factors such as database load, storage size, storage type (standard or Provisioned IOPS), amount of IOPS provisioned (if any), and the number of prior scale storage operations. Typical migration times are under 24 hours, but the process can take up to several days in some cases. During the migration, the DB instance will be available for use, but might experience performance degradation. While the migration takes place, nightly backups for the instance will be 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.

      Returns:
      The new Provisioned IOPS (I/O operations per second) value for the RDS instance. Changing this setting does not result in an outage and the change is applied during the next maintenance window unless the ApplyImmediately parameter is set to true for this request.

      Default: Uses existing setting

      Constraints: Value supplied must be at least 10% greater than the current value. Values that are not at least 10% greater than the existing value are rounded up so that they are 10% greater than the current value. If you are migrating from Provisioned IOPS to standard storage, set this value to 0. The DB instance will require a reboot for the change in storage type to take effect.

      SQL Server

      Setting the IOPS value for the SQL Server database engine is not supported.

      Type: Integer

      If you choose to migrate your DB instance from using standard storage to using Provisioned IOPS, or from using Provisioned IOPS to using standard storage, the process can take time. The duration of the migration depends on several factors such as database load, storage size, storage type (standard or Provisioned IOPS), amount of IOPS provisioned (if any), and the number of prior scale storage operations. Typical migration times are under 24 hours, but the process can take up to several days in some cases. During the migration, the DB instance will be available for use, but might experience performance degradation. While the migration takes place, nightly backups for the instance will be 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.

    • withIops

      public ModifyDBInstanceRequest withIops(Integer iops)

      The new Provisioned IOPS (I/O operations per second) value for the RDS instance. Changing this setting does not result in an outage and the change is applied during the next maintenance window unless the ApplyImmediately parameter is set to true for this request.

      Default: Uses existing setting

      Constraints: Value supplied must be at least 10% greater than the current value. Values that are not at least 10% greater than the existing value are rounded up so that they are 10% greater than the current value. If you are migrating from Provisioned IOPS to standard storage, set this value to 0. The DB instance will require a reboot for the change in storage type to take effect.

      SQL Server

      Setting the IOPS value for the SQL Server database engine is not supported.

      Type: Integer

      If you choose to migrate your DB instance from using standard storage to using Provisioned IOPS, or from using Provisioned IOPS to using standard storage, the process can take time. The duration of the migration depends on several factors such as database load, storage size, storage type (standard or Provisioned IOPS), amount of IOPS provisioned (if any), and the number of prior scale storage operations. Typical migration times are under 24 hours, but the process can take up to several days in some cases. During the migration, the DB instance will be available for use, but might experience performance degradation. While the migration takes place, nightly backups for the instance will be 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.

      Parameters:
      iops - The new Provisioned IOPS (I/O operations per second) value for the RDS instance. Changing this setting does not result in an outage and the change is applied during the next maintenance window unless the ApplyImmediately parameter is set to true for this request.

      Default: Uses existing setting

      Constraints: Value supplied must be at least 10% greater than the current value. Values that are not at least 10% greater than the existing value are rounded up so that they are 10% greater than the current value. If you are migrating from Provisioned IOPS to standard storage, set this value to 0. The DB instance will require a reboot for the change in storage type to take effect.

      SQL Server

      Setting the IOPS value for the SQL Server database engine is not supported.

      Type: Integer

      If you choose to migrate your DB instance from using standard storage to using Provisioned IOPS, or from using Provisioned IOPS to using standard storage, the process can take time. The duration of the migration depends on several factors such as database load, storage size, storage type (standard or Provisioned IOPS), amount of IOPS provisioned (if any), and the number of prior scale storage operations. Typical migration times are under 24 hours, but the process can take up to several days in some cases. During the migration, the DB instance will be available for use, but might experience performance degradation. While the migration takes place, nightly backups for the instance will be 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.

      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • setOptionGroupName

      public void setOptionGroupName(String optionGroupName)

      Indicates that the DB instance should be associated with the specified option group. Changing this parameter does not result in an outage except in the following case and the change is applied during the next maintenance window unless the ApplyImmediately parameter is set to true for this request. If the parameter change results in an option group that enables OEM, this change can cause a brief (sub-second) period during which new connections are rejected but existing connections are not interrupted.

      Permanent options, such as the TDE option for Oracle Advanced Security TDE, cannot be removed from an option group, and that option group cannot be removed from a DB instance once it is associated with a DB instance

      Parameters:
      optionGroupName - Indicates that the DB instance should be associated with the specified option group. Changing this parameter does not result in an outage except in the following case and the change is applied during the next maintenance window unless the ApplyImmediately parameter is set to true for this request. If the parameter change results in an option group that enables OEM, this change can cause a brief (sub-second) period during which new connections are rejected but existing connections are not interrupted.

      Permanent options, such as the TDE option for Oracle Advanced Security TDE, cannot be removed from an option group, and that option group cannot be removed from a DB instance once it is associated with a DB instance

    • getOptionGroupName

      public String getOptionGroupName()

      Indicates that the DB instance should be associated with the specified option group. Changing this parameter does not result in an outage except in the following case and the change is applied during the next maintenance window unless the ApplyImmediately parameter is set to true for this request. If the parameter change results in an option group that enables OEM, this change can cause a brief (sub-second) period during which new connections are rejected but existing connections are not interrupted.

      Permanent options, such as the TDE option for Oracle Advanced Security TDE, cannot be removed from an option group, and that option group cannot be removed from a DB instance once it is associated with a DB instance

      Returns:
      Indicates that the DB instance should be associated with the specified option group. Changing this parameter does not result in an outage except in the following case and the change is applied during the next maintenance window unless the ApplyImmediately parameter is set to true for this request. If the parameter change results in an option group that enables OEM, this change can cause a brief (sub-second) period during which new connections are rejected but existing connections are not interrupted.

      Permanent options, such as the TDE option for Oracle Advanced Security TDE, cannot be removed from an option group, and that option group cannot be removed from a DB instance once it is associated with a DB instance

    • withOptionGroupName

      public ModifyDBInstanceRequest withOptionGroupName(String optionGroupName)

      Indicates that the DB instance should be associated with the specified option group. Changing this parameter does not result in an outage except in the following case and the change is applied during the next maintenance window unless the ApplyImmediately parameter is set to true for this request. If the parameter change results in an option group that enables OEM, this change can cause a brief (sub-second) period during which new connections are rejected but existing connections are not interrupted.

      Permanent options, such as the TDE option for Oracle Advanced Security TDE, cannot be removed from an option group, and that option group cannot be removed from a DB instance once it is associated with a DB instance

      Parameters:
      optionGroupName - Indicates that the DB instance should be associated with the specified option group. Changing this parameter does not result in an outage except in the following case and the change is applied during the next maintenance window unless the ApplyImmediately parameter is set to true for this request. If the parameter change results in an option group that enables OEM, this change can cause a brief (sub-second) period during which new connections are rejected but existing connections are not interrupted.

      Permanent options, such as the TDE option for Oracle Advanced Security TDE, cannot be removed from an option group, and that option group cannot be removed from a DB instance once it is associated with a DB instance

      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • setNewDBInstanceIdentifier

      public void setNewDBInstanceIdentifier(String newDBInstanceIdentifier)

      The new DB instance identifier for the DB instance when renaming a DB instance. When you change the DB instance identifier, an instance reboot will occur immediately if you set Apply Immediately to true, or will occur during the next maintenance window if Apply Immediately to false. This value is stored as a lowercase string.

      Constraints:

      • Must contain from 1 to 63 alphanumeric characters or hyphens
      • First character must be a letter
      • Cannot end with a hyphen or contain two consecutive hyphens
      Parameters:
      newDBInstanceIdentifier - The new DB instance identifier for the DB instance when renaming a DB instance. When you change the DB instance identifier, an instance reboot will occur immediately if you set Apply Immediately to true, or will occur during the next maintenance window if Apply Immediately to false. This value is stored as a lowercase string.

      Constraints:

      • Must contain from 1 to 63 alphanumeric characters or hyphens
      • First character must be a letter
      • Cannot end with a hyphen or contain two consecutive hyphens
    • getNewDBInstanceIdentifier

      public String getNewDBInstanceIdentifier()

      The new DB instance identifier for the DB instance when renaming a DB instance. When you change the DB instance identifier, an instance reboot will occur immediately if you set Apply Immediately to true, or will occur during the next maintenance window if Apply Immediately to false. This value is stored as a lowercase string.

      Constraints:

      • Must contain from 1 to 63 alphanumeric characters or hyphens
      • First character must be a letter
      • Cannot end with a hyphen or contain two consecutive hyphens
      Returns:
      The new DB instance identifier for the DB instance when renaming a DB instance. When you change the DB instance identifier, an instance reboot will occur immediately if you set Apply Immediately to true, or will occur during the next maintenance window if Apply Immediately to false. This value is stored as a lowercase string.

      Constraints:

      • Must contain from 1 to 63 alphanumeric characters or hyphens
      • First character must be a letter
      • Cannot end with a hyphen or contain two consecutive hyphens
    • withNewDBInstanceIdentifier

      public ModifyDBInstanceRequest withNewDBInstanceIdentifier(String newDBInstanceIdentifier)

      The new DB instance identifier for the DB instance when renaming a DB instance. When you change the DB instance identifier, an instance reboot will occur immediately if you set Apply Immediately to true, or will occur during the next maintenance window if Apply Immediately to false. This value is stored as a lowercase string.

      Constraints:

      • Must contain from 1 to 63 alphanumeric characters or hyphens
      • First character must be a letter
      • Cannot end with a hyphen or contain two consecutive hyphens
      Parameters:
      newDBInstanceIdentifier - The new DB instance identifier for the DB instance when renaming a DB instance. When you change the DB instance identifier, an instance reboot will occur immediately if you set Apply Immediately to true, or will occur during the next maintenance window if Apply Immediately to false. This value is stored as a lowercase string.

      Constraints:

      • Must contain from 1 to 63 alphanumeric characters or hyphens
      • First character must be a letter
      • Cannot end with a hyphen or contain two consecutive hyphens
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • setStorageType

      public void setStorageType(String storageType)

      Specifies the storage type to be associated with the DB instance.

      Valid values: standard | gp2 | io1

      If you specify io1, you must also include a value for the Iops parameter.

      Default: io1 if the Iops parameter is specified; otherwise standard

      Parameters:
      storageType - Specifies the storage type to be associated with the DB instance.

      Valid values: standard | gp2 | io1

      If you specify io1, you must also include a value for the Iops parameter.

      Default: io1 if the Iops parameter is specified; otherwise standard

    • getStorageType

      public String getStorageType()

      Specifies the storage type to be associated with the DB instance.

      Valid values: standard | gp2 | io1

      If you specify io1, you must also include a value for the Iops parameter.

      Default: io1 if the Iops parameter is specified; otherwise standard

      Returns:
      Specifies the storage type to be associated with the DB instance.

      Valid values: standard | gp2 | io1

      If you specify io1, you must also include a value for the Iops parameter.

      Default: io1 if the Iops parameter is specified; otherwise standard

    • withStorageType

      public ModifyDBInstanceRequest withStorageType(String storageType)

      Specifies the storage type to be associated with the DB instance.

      Valid values: standard | gp2 | io1

      If you specify io1, you must also include a value for the Iops parameter.

      Default: io1 if the Iops parameter is specified; otherwise standard

      Parameters:
      storageType - Specifies the storage type to be associated with the DB instance.

      Valid values: standard | gp2 | io1

      If you specify io1, you must also include a value for the Iops parameter.

      Default: io1 if the Iops parameter is specified; otherwise standard

      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • setTdeCredentialArn

      public void setTdeCredentialArn(String tdeCredentialArn)

      The ARN from the Key Store with which to associate the instance for TDE encryption.

      Parameters:
      tdeCredentialArn - The ARN from the Key Store with which to associate the instance for TDE encryption.
    • getTdeCredentialArn

      public String getTdeCredentialArn()

      The ARN from the Key Store with which to associate the instance for TDE encryption.

      Returns:
      The ARN from the Key Store with which to associate the instance for TDE encryption.
    • withTdeCredentialArn

      public ModifyDBInstanceRequest withTdeCredentialArn(String tdeCredentialArn)

      The ARN from the Key Store with which to associate the instance for TDE encryption.

      Parameters:
      tdeCredentialArn - The ARN from the Key Store with which to associate the instance for TDE encryption.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • setTdeCredentialPassword

      public void setTdeCredentialPassword(String tdeCredentialPassword)

      The password for the given ARN from the Key Store in order to access the device.

      Parameters:
      tdeCredentialPassword - The password for the given ARN from the Key Store in order to access the device.
    • getTdeCredentialPassword

      public String getTdeCredentialPassword()

      The password for the given ARN from the Key Store in order to access the device.

      Returns:
      The password for the given ARN from the Key Store in order to access the device.
    • withTdeCredentialPassword

      public ModifyDBInstanceRequest withTdeCredentialPassword(String tdeCredentialPassword)

      The password for the given ARN from the Key Store in order to access the device.

      Parameters:
      tdeCredentialPassword - The password for the given ARN from the Key Store in order to access the device.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • setCACertificateIdentifier

      public void setCACertificateIdentifier(String cACertificateIdentifier)

      Indicates the certificate that needs to be associated with the instance.

      Parameters:
      cACertificateIdentifier - Indicates the certificate that needs to be associated with the instance.
    • getCACertificateIdentifier

      public String getCACertificateIdentifier()

      Indicates the certificate that needs to be associated with the instance.

      Returns:
      Indicates the certificate that needs to be associated with the instance.
    • withCACertificateIdentifier

      public ModifyDBInstanceRequest withCACertificateIdentifier(String cACertificateIdentifier)

      Indicates the certificate that needs to be associated with the instance.

      Parameters:
      cACertificateIdentifier - Indicates the certificate that needs to be associated with the instance.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • setDomain

      public void setDomain(String domain)

      Specify the Active Directory Domain to move the instance to.

      The specified Active Directory Domain must be created prior to this operation. Currently only a SQL Server instance can be created in a Active Directory Domain.

      Parameters:
      domain - Specify the Active Directory Domain to move the instance to.

      The specified Active Directory Domain must be created prior to this operation. Currently only a SQL Server instance can be created in a Active Directory Domain.

    • getDomain

      public String getDomain()

      Specify the Active Directory Domain to move the instance to.

      The specified Active Directory Domain must be created prior to this operation. Currently only a SQL Server instance can be created in a Active Directory Domain.

      Returns:
      Specify the Active Directory Domain to move the instance to.

      The specified Active Directory Domain must be created prior to this operation. Currently only a SQL Server instance can be created in a Active Directory Domain.

    • withDomain

      public ModifyDBInstanceRequest withDomain(String domain)

      Specify the Active Directory Domain to move the instance to.

      The specified Active Directory Domain must be created prior to this operation. Currently only a SQL Server instance can be created in a Active Directory Domain.

      Parameters:
      domain - Specify the Active Directory Domain to move the instance to.

      The specified Active Directory Domain must be created prior to this operation. Currently only a SQL Server instance can be created in a Active Directory Domain.

      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • setCopyTagsToSnapshot

      public void setCopyTagsToSnapshot(Boolean copyTagsToSnapshot)

      True to copy all tags from the DB instance to snapshots of the DB instance; otherwise false. The default is false.

      Parameters:
      copyTagsToSnapshot - True to copy all tags from the DB instance to snapshots of the DB instance; otherwise false. The default is false.
    • getCopyTagsToSnapshot

      public Boolean getCopyTagsToSnapshot()

      True to copy all tags from the DB instance to snapshots of the DB instance; otherwise false. The default is false.

      Returns:
      True to copy all tags from the DB instance to snapshots of the DB instance; otherwise false. The default is false.
    • withCopyTagsToSnapshot

      public ModifyDBInstanceRequest withCopyTagsToSnapshot(Boolean copyTagsToSnapshot)

      True to copy all tags from the DB instance to snapshots of the DB instance; otherwise false. The default is false.

      Parameters:
      copyTagsToSnapshot - True to copy all tags from the DB instance to snapshots of the DB instance; otherwise false. The default is false.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • isCopyTagsToSnapshot

      public Boolean isCopyTagsToSnapshot()

      True to copy all tags from the DB instance to snapshots of the DB instance; otherwise false. The default is false.

      Returns:
      True to copy all tags from the DB instance to snapshots of the DB instance; otherwise false. The default is false.
    • setMonitoringInterval

      public void setMonitoringInterval(Integer monitoringInterval)

      The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB instance. To disable collecting Enhanced Monitoring metrics, specify 0. The default is 60.

      If MonitoringRoleArn is specified, then you must also set MonitoringInterval to a value other than 0.

      Valid Values: 0, 1, 5, 10, 15, 30, 60

      Parameters:
      monitoringInterval - The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB instance. To disable collecting Enhanced Monitoring metrics, specify 0. The default is 60.

      If MonitoringRoleArn is specified, then you must also set MonitoringInterval to a value other than 0.

      Valid Values: 0, 1, 5, 10, 15, 30, 60

    • getMonitoringInterval

      public Integer getMonitoringInterval()

      The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB instance. To disable collecting Enhanced Monitoring metrics, specify 0. The default is 60.

      If MonitoringRoleArn is specified, then you must also set MonitoringInterval to a value other than 0.

      Valid Values: 0, 1, 5, 10, 15, 30, 60

      Returns:
      The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB instance. To disable collecting Enhanced Monitoring metrics, specify 0. The default is 60.

      If MonitoringRoleArn is specified, then you must also set MonitoringInterval to a value other than 0.

      Valid Values: 0, 1, 5, 10, 15, 30, 60

    • withMonitoringInterval

      public ModifyDBInstanceRequest withMonitoringInterval(Integer monitoringInterval)

      The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB instance. To disable collecting Enhanced Monitoring metrics, specify 0. The default is 60.

      If MonitoringRoleArn is specified, then you must also set MonitoringInterval to a value other than 0.

      Valid Values: 0, 1, 5, 10, 15, 30, 60

      Parameters:
      monitoringInterval - The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB instance. To disable collecting Enhanced Monitoring metrics, specify 0. The default is 60.

      If MonitoringRoleArn is specified, then you must also set MonitoringInterval to a value other than 0.

      Valid Values: 0, 1, 5, 10, 15, 30, 60

      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • setDBPortNumber

      public void setDBPortNumber(Integer dBPortNumber)

      The port number on which the database accepts connections.

      The value of the DBPortNumber parameter must not match any of the port values specified for options in the option group for the DB instance.

      Your database will restart when you change the DBPortNumber value regardless of the value of the ApplyImmediately parameter.

      MySQL

      Default: 3306

      Valid Values: 1150-65535

      MariaDB

      Default: 3306

      Valid Values: 1150-65535

      PostgreSQL

      Default: 5432

      Valid Values: 1150-65535

      Type: Integer

      Oracle

      Default: 1521

      Valid Values: 1150-65535

      SQL Server

      Default: 1433

      Valid Values: 1150-65535 except for 1434, 3389, 47001, 49152, and 49152 through 49156.

      Amazon Aurora

      Default: 3306

      Valid Values: 1150-65535

      Parameters:
      dBPortNumber - The port number on which the database accepts connections.

      The value of the DBPortNumber parameter must not match any of the port values specified for options in the option group for the DB instance.

      Your database will restart when you change the DBPortNumber value regardless of the value of the ApplyImmediately parameter.

      MySQL

      Default: 3306

      Valid Values: 1150-65535

      MariaDB

      Default: 3306

      Valid Values: 1150-65535

      PostgreSQL

      Default: 5432

      Valid Values: 1150-65535

      Type: Integer

      Oracle

      Default: 1521

      Valid Values: 1150-65535

      SQL Server

      Default: 1433

      Valid Values: 1150-65535 except for 1434, 3389, 47001, 49152, and 49152 through 49156.

      Amazon Aurora

      Default: 3306

      Valid Values: 1150-65535

    • getDBPortNumber

      public Integer getDBPortNumber()

      The port number on which the database accepts connections.

      The value of the DBPortNumber parameter must not match any of the port values specified for options in the option group for the DB instance.

      Your database will restart when you change the DBPortNumber value regardless of the value of the ApplyImmediately parameter.

      MySQL

      Default: 3306

      Valid Values: 1150-65535

      MariaDB

      Default: 3306

      Valid Values: 1150-65535

      PostgreSQL

      Default: 5432

      Valid Values: 1150-65535

      Type: Integer

      Oracle

      Default: 1521

      Valid Values: 1150-65535

      SQL Server

      Default: 1433

      Valid Values: 1150-65535 except for 1434, 3389, 47001, 49152, and 49152 through 49156.

      Amazon Aurora

      Default: 3306

      Valid Values: 1150-65535

      Returns:
      The port number on which the database accepts connections.

      The value of the DBPortNumber parameter must not match any of the port values specified for options in the option group for the DB instance.

      Your database will restart when you change the DBPortNumber value regardless of the value of the ApplyImmediately parameter.

      MySQL

      Default: 3306

      Valid Values: 1150-65535

      MariaDB

      Default: 3306

      Valid Values: 1150-65535

      PostgreSQL

      Default: 5432

      Valid Values: 1150-65535

      Type: Integer

      Oracle

      Default: 1521

      Valid Values: 1150-65535

      SQL Server

      Default: 1433

      Valid Values: 1150-65535 except for 1434, 3389, 47001, 49152, and 49152 through 49156.

      Amazon Aurora

      Default: 3306

      Valid Values: 1150-65535

    • withDBPortNumber

      public ModifyDBInstanceRequest withDBPortNumber(Integer dBPortNumber)

      The port number on which the database accepts connections.

      The value of the DBPortNumber parameter must not match any of the port values specified for options in the option group for the DB instance.

      Your database will restart when you change the DBPortNumber value regardless of the value of the ApplyImmediately parameter.

      MySQL

      Default: 3306

      Valid Values: 1150-65535

      MariaDB

      Default: 3306

      Valid Values: 1150-65535

      PostgreSQL

      Default: 5432

      Valid Values: 1150-65535

      Type: Integer

      Oracle

      Default: 1521

      Valid Values: 1150-65535

      SQL Server

      Default: 1433

      Valid Values: 1150-65535 except for 1434, 3389, 47001, 49152, and 49152 through 49156.

      Amazon Aurora

      Default: 3306

      Valid Values: 1150-65535

      Parameters:
      dBPortNumber - The port number on which the database accepts connections.

      The value of the DBPortNumber parameter must not match any of the port values specified for options in the option group for the DB instance.

      Your database will restart when you change the DBPortNumber value regardless of the value of the ApplyImmediately parameter.

      MySQL

      Default: 3306

      Valid Values: 1150-65535

      MariaDB

      Default: 3306

      Valid Values: 1150-65535

      PostgreSQL

      Default: 5432

      Valid Values: 1150-65535

      Type: Integer

      Oracle

      Default: 1521

      Valid Values: 1150-65535

      SQL Server

      Default: 1433

      Valid Values: 1150-65535 except for 1434, 3389, 47001, 49152, and 49152 through 49156.

      Amazon Aurora

      Default: 3306

      Valid Values: 1150-65535

      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • setPubliclyAccessible

      public void setPubliclyAccessible(Boolean publiclyAccessible)

      Boolean value that indicates if the DB instance has a publicly resolvable DNS name. Set to True to make the DB instance Internet-facing with a publicly resolvable DNS name, which resolves to a public IP address. Set to False to make the DB instance internal with a DNS name that resolves to a private IP address.

      PubliclyAccessible only applies to DB instances in a VPC. The DB instance must be part of a public subnet and PubliclyAccessible must be true in order for it to be publicly accessible.

      Changes to the PubliclyAccessible parameter are applied immediately regardless of the value of the ApplyImmediately parameter.

      Default: false

      Parameters:
      publiclyAccessible - Boolean value that indicates if the DB instance has a publicly resolvable DNS name. Set to True to make the DB instance Internet-facing with a publicly resolvable DNS name, which resolves to a public IP address. Set to False to make the DB instance internal with a DNS name that resolves to a private IP address.

      PubliclyAccessible only applies to DB instances in a VPC. The DB instance must be part of a public subnet and PubliclyAccessible must be true in order for it to be publicly accessible.

      Changes to the PubliclyAccessible parameter are applied immediately regardless of the value of the ApplyImmediately parameter.

      Default: false

    • getPubliclyAccessible

      public Boolean getPubliclyAccessible()

      Boolean value that indicates if the DB instance has a publicly resolvable DNS name. Set to True to make the DB instance Internet-facing with a publicly resolvable DNS name, which resolves to a public IP address. Set to False to make the DB instance internal with a DNS name that resolves to a private IP address.

      PubliclyAccessible only applies to DB instances in a VPC. The DB instance must be part of a public subnet and PubliclyAccessible must be true in order for it to be publicly accessible.

      Changes to the PubliclyAccessible parameter are applied immediately regardless of the value of the ApplyImmediately parameter.

      Default: false

      Returns:
      Boolean value that indicates if the DB instance has a publicly resolvable DNS name. Set to True to make the DB instance Internet-facing with a publicly resolvable DNS name, which resolves to a public IP address. Set to False to make the DB instance internal with a DNS name that resolves to a private IP address.

      PubliclyAccessible only applies to DB instances in a VPC. The DB instance must be part of a public subnet and PubliclyAccessible must be true in order for it to be publicly accessible.

      Changes to the PubliclyAccessible parameter are applied immediately regardless of the value of the ApplyImmediately parameter.

      Default: false

    • withPubliclyAccessible

      public ModifyDBInstanceRequest withPubliclyAccessible(Boolean publiclyAccessible)

      Boolean value that indicates if the DB instance has a publicly resolvable DNS name. Set to True to make the DB instance Internet-facing with a publicly resolvable DNS name, which resolves to a public IP address. Set to False to make the DB instance internal with a DNS name that resolves to a private IP address.

      PubliclyAccessible only applies to DB instances in a VPC. The DB instance must be part of a public subnet and PubliclyAccessible must be true in order for it to be publicly accessible.

      Changes to the PubliclyAccessible parameter are applied immediately regardless of the value of the ApplyImmediately parameter.

      Default: false

      Parameters:
      publiclyAccessible - Boolean value that indicates if the DB instance has a publicly resolvable DNS name. Set to True to make the DB instance Internet-facing with a publicly resolvable DNS name, which resolves to a public IP address. Set to False to make the DB instance internal with a DNS name that resolves to a private IP address.

      PubliclyAccessible only applies to DB instances in a VPC. The DB instance must be part of a public subnet and PubliclyAccessible must be true in order for it to be publicly accessible.

      Changes to the PubliclyAccessible parameter are applied immediately regardless of the value of the ApplyImmediately parameter.

      Default: false

      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • isPubliclyAccessible

      public Boolean isPubliclyAccessible()

      Boolean value that indicates if the DB instance has a publicly resolvable DNS name. Set to True to make the DB instance Internet-facing with a publicly resolvable DNS name, which resolves to a public IP address. Set to False to make the DB instance internal with a DNS name that resolves to a private IP address.

      PubliclyAccessible only applies to DB instances in a VPC. The DB instance must be part of a public subnet and PubliclyAccessible must be true in order for it to be publicly accessible.

      Changes to the PubliclyAccessible parameter are applied immediately regardless of the value of the ApplyImmediately parameter.

      Default: false

      Returns:
      Boolean value that indicates if the DB instance has a publicly resolvable DNS name. Set to True to make the DB instance Internet-facing with a publicly resolvable DNS name, which resolves to a public IP address. Set to False to make the DB instance internal with a DNS name that resolves to a private IP address.

      PubliclyAccessible only applies to DB instances in a VPC. The DB instance must be part of a public subnet and PubliclyAccessible must be true in order for it to be publicly accessible.

      Changes to the PubliclyAccessible parameter are applied immediately regardless of the value of the ApplyImmediately parameter.

      Default: false

    • setMonitoringRoleArn

      public void setMonitoringRoleArn(String monitoringRoleArn)

      The ARN for the IAM role that permits RDS to send enhanced monitoring metrics to CloudWatch Logs. For example, arn:aws:iam:123456789012:role/emaccess. For information on creating a monitoring role, go to To create an IAM role for Amazon RDS Enhanced Monitoring.

      If MonitoringInterval is set to a value other than 0, then you must supply a MonitoringRoleArn value.

      Parameters:
      monitoringRoleArn - The ARN for the IAM role that permits RDS to send enhanced monitoring metrics to CloudWatch Logs. For example, arn:aws:iam:123456789012:role/emaccess. For information on creating a monitoring role, go to To create an IAM role for Amazon RDS Enhanced Monitoring.

      If MonitoringInterval is set to a value other than 0, then you must supply a MonitoringRoleArn value.

    • getMonitoringRoleArn

      public String getMonitoringRoleArn()

      The ARN for the IAM role that permits RDS to send enhanced monitoring metrics to CloudWatch Logs. For example, arn:aws:iam:123456789012:role/emaccess. For information on creating a monitoring role, go to To create an IAM role for Amazon RDS Enhanced Monitoring.

      If MonitoringInterval is set to a value other than 0, then you must supply a MonitoringRoleArn value.

      Returns:
      The ARN for the IAM role that permits RDS to send enhanced monitoring metrics to CloudWatch Logs. For example, arn:aws:iam:123456789012:role/emaccess. For information on creating a monitoring role, go to To create an IAM role for Amazon RDS Enhanced Monitoring.

      If MonitoringInterval is set to a value other than 0, then you must supply a MonitoringRoleArn value.

    • withMonitoringRoleArn

      public ModifyDBInstanceRequest withMonitoringRoleArn(String monitoringRoleArn)

      The ARN for the IAM role that permits RDS to send enhanced monitoring metrics to CloudWatch Logs. For example, arn:aws:iam:123456789012:role/emaccess. For information on creating a monitoring role, go to To create an IAM role for Amazon RDS Enhanced Monitoring.

      If MonitoringInterval is set to a value other than 0, then you must supply a MonitoringRoleArn value.

      Parameters:
      monitoringRoleArn - The ARN for the IAM role that permits RDS to send enhanced monitoring metrics to CloudWatch Logs. For example, arn:aws:iam:123456789012:role/emaccess. For information on creating a monitoring role, go to To create an IAM role for Amazon RDS Enhanced Monitoring.

      If MonitoringInterval is set to a value other than 0, then you must supply a MonitoringRoleArn value.

      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • setDomainIAMRoleName

      public void setDomainIAMRoleName(String domainIAMRoleName)

      Specify the name of the IAM role to be used when making API calls to the Directory Service.

      Parameters:
      domainIAMRoleName - Specify the name of the IAM role to be used when making API calls to the Directory Service.
    • getDomainIAMRoleName

      public String getDomainIAMRoleName()

      Specify the name of the IAM role to be used when making API calls to the Directory Service.

      Returns:
      Specify the name of the IAM role to be used when making API calls to the Directory Service.
    • withDomainIAMRoleName

      public ModifyDBInstanceRequest withDomainIAMRoleName(String domainIAMRoleName)

      Specify the name of the IAM role to be used when making API calls to the Directory Service.

      Parameters:
      domainIAMRoleName - Specify the name of the IAM role to be used when making API calls to the Directory Service.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • setPromotionTier

      public void setPromotionTier(Integer promotionTier)

      A value that specifies the order in which an Aurora Replica is promoted to the primary instance after a failure of the existing primary instance. For more information, see Fault Tolerance for an Aurora DB Cluster.

      Default: 1

      Valid Values: 0 - 15

      Parameters:
      promotionTier - A value that specifies the order in which an Aurora Replica is promoted to the primary instance after a failure of the existing primary instance. For more information, see Fault Tolerance for an Aurora DB Cluster.

      Default: 1

      Valid Values: 0 - 15

    • getPromotionTier

      public Integer getPromotionTier()

      A value that specifies the order in which an Aurora Replica is promoted to the primary instance after a failure of the existing primary instance. For more information, see Fault Tolerance for an Aurora DB Cluster.

      Default: 1

      Valid Values: 0 - 15

      Returns:
      A value that specifies the order in which an Aurora Replica is promoted to the primary instance after a failure of the existing primary instance. For more information, see Fault Tolerance for an Aurora DB Cluster.

      Default: 1

      Valid Values: 0 - 15

    • withPromotionTier

      public ModifyDBInstanceRequest withPromotionTier(Integer promotionTier)

      A value that specifies the order in which an Aurora Replica is promoted to the primary instance after a failure of the existing primary instance. For more information, see Fault Tolerance for an Aurora DB Cluster.

      Default: 1

      Valid Values: 0 - 15

      Parameters:
      promotionTier - A value that specifies the order in which an Aurora Replica is promoted to the primary instance after a failure of the existing primary instance. For more information, see Fault Tolerance for an Aurora DB Cluster.

      Default: 1

      Valid Values: 0 - 15

      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • toString

      public String toString()
      Returns a string representation of this object; useful for testing and debugging.
      Overrides:
      toString in class Object
      Returns:
      A string representation of this object.
      See Also:
    • equals

      public boolean equals(Object obj)
      Overrides:
      equals in class Object
    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object
    • clone

      public ModifyDBInstanceRequest clone()
      Description copied from class: AmazonWebServiceRequest
      Creates a shallow clone of this request. Explicitly does not clone the deep structure of the request object.
      Overrides:
      clone in class AmazonWebServiceRequest
      See Also: