Class PromoteReadReplicaRequest

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

public class PromoteReadReplicaRequest extends AmazonWebServiceRequest implements Serializable, Cloneable

See Also:
  • Constructor Details

    • PromoteReadReplicaRequest

      public PromoteReadReplicaRequest()
  • 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 Read Replica 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

      Example: mydbinstance

      Parameters:
      dBInstanceIdentifier - The DB instance identifier. This value is stored as a lowercase string.

      Constraints:

      • Must be the identifier for an existing Read Replica 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

      Example: mydbinstance

    • getDBInstanceIdentifier

      public String getDBInstanceIdentifier()

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

      Constraints:

      • Must be the identifier for an existing Read Replica 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

      Example: mydbinstance

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

      Constraints:

      • Must be the identifier for an existing Read Replica 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

      Example: mydbinstance

    • withDBInstanceIdentifier

      public PromoteReadReplicaRequest withDBInstanceIdentifier(String dBInstanceIdentifier)

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

      Constraints:

      • Must be the identifier for an existing Read Replica 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

      Example: mydbinstance

      Parameters:
      dBInstanceIdentifier - The DB instance identifier. This value is stored as a lowercase string.

      Constraints:

      • Must be the identifier for an existing Read Replica 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

      Example: mydbinstance

      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.

      Default: 1

      Constraints:

      • Must be a value from 0 to 8
      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.

      Default: 1

      Constraints:

      • Must be a value from 0 to 8
    • 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.

      Default: 1

      Constraints:

      • Must be a value from 0 to 8
      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.

      Default: 1

      Constraints:

      • Must be a value from 0 to 8
    • withBackupRetentionPeriod

      public PromoteReadReplicaRequest 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.

      Default: 1

      Constraints:

      • Must be a value from 0 to 8
      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.

      Default: 1

      Constraints:

      • Must be a value from 0 to 8
      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, using the BackupRetentionPeriod parameter.

      Default: A 30-minute window selected at random from an 8-hour block of time per region. To see the time blocks available, see Adjusting the Preferred Maintenance Window in the Amazon RDS User Guide.

      Constraints:

      • Must be in the format hh24:mi-hh24:mi.
      • Times should be in Universal Coordinated Time (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, using the BackupRetentionPeriod parameter.

      Default: A 30-minute window selected at random from an 8-hour block of time per region. To see the time blocks available, see Adjusting the Preferred Maintenance Window in the Amazon RDS User Guide.

      Constraints:

      • Must be in the format hh24:mi-hh24:mi.
      • Times should be in Universal Coordinated Time (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, using the BackupRetentionPeriod parameter.

      Default: A 30-minute window selected at random from an 8-hour block of time per region. To see the time blocks available, see Adjusting the Preferred Maintenance Window in the Amazon RDS User Guide.

      Constraints:

      • Must be in the format hh24:mi-hh24:mi.
      • Times should be in Universal Coordinated Time (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, using the BackupRetentionPeriod parameter.

      Default: A 30-minute window selected at random from an 8-hour block of time per region. To see the time blocks available, see Adjusting the Preferred Maintenance Window in the Amazon RDS User Guide.

      Constraints:

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

      public PromoteReadReplicaRequest withPreferredBackupWindow(String preferredBackupWindow)

      The daily time range during which automated backups are created if automated backups are enabled, using the BackupRetentionPeriod parameter.

      Default: A 30-minute window selected at random from an 8-hour block of time per region. To see the time blocks available, see Adjusting the Preferred Maintenance Window in the Amazon RDS User Guide.

      Constraints:

      • Must be in the format hh24:mi-hh24:mi.
      • Times should be in Universal Coordinated Time (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, using the BackupRetentionPeriod parameter.

      Default: A 30-minute window selected at random from an 8-hour block of time per region. To see the time blocks available, see Adjusting the Preferred Maintenance Window in the Amazon RDS User Guide.

      Constraints:

      • Must be in the format hh24:mi-hh24:mi.
      • Times should be in Universal Coordinated Time (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.
    • 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 PromoteReadReplicaRequest 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: