com.amazonaws.services.rds.model

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

Container for the parameters to the PromoteReadReplica operation.

Promotes a Read Replica DB instance to a standalone DB instance.

NOTE: We recommend that you enable automated backups on your Read Replica before promoting the Read Replica. This ensures that no backup is taken during the promotion process. Once the instance is promoted to a primary instance, backups are taken based on your backup settings.

See Also:

AmazonRDS.promoteReadReplica(PromoteReadReplicaRequest), Serialized Form

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

NOOP

Constructor Summary

Constructors

Constructor and Description
PromoteReadReplicaRequest()

Method Summary

Methods

Modifier and Type	Method and Description
PromoteReadReplicaRequest	clone() Creates a shallow clone of this request.
boolean	equals(Object obj)
Integer	getBackupRetentionPeriod() The number of days to retain automated backups.
String	getDBInstanceIdentifier() The DB instance identifier.
String	getPreferredBackupWindow() The daily time range during which automated backups are created if automated backups are enabled, using the BackupRetentionPeriod parameter.
int	hashCode()
void	setBackupRetentionPeriod(Integer backupRetentionPeriod) The number of days to retain automated backups.
void	setDBInstanceIdentifier(String dBInstanceIdentifier) The DB instance identifier.
void	setPreferredBackupWindow(String preferredBackupWindow) The daily time range during which automated backups are created if automated backups are enabled, using the BackupRetentionPeriod parameter.
String	toString() Returns a string representation of this object; useful for testing and debugging.
PromoteReadReplicaRequest	withBackupRetentionPeriod(Integer backupRetentionPeriod) The number of days to retain automated backups.
PromoteReadReplicaRequest	withDBInstanceIdentifier(String dBInstanceIdentifier) The DB instance identifier.
PromoteReadReplicaRequest	withPreferredBackupWindow(String preferredBackupWindow) The daily time range during which automated backups are created if automated backups are enabled, using the BackupRetentionPeriod parameter.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

copyBaseTo, getCustomRequestHeaders, getGeneralProgressListener, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestMetricCollector, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestMetricCollector, withGeneralProgressListener, withRequestMetricCollector

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

PromoteReadReplicaRequest

public PromoteReadReplicaRequest()

Method Detail

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

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

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

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

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:

A reference to this updated object so that method calls can be chained together.

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

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

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

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

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:

A reference to this updated object so that method calls can be chained together.

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. See the Amazon RDS User Guide for the time blocks for each region from which the default backup windows are assigned.

Constraints: Must be in the format hh24:mi-hh24:mi. Times should be 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, using the BackupRetentionPeriod parameter.

Default: A 30-minute window selected at random from an 8-hour block of time per region. See the Amazon RDS User Guide for the time blocks for each region from which the default backup windows are assigned.

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

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. See the Amazon RDS User Guide for the time blocks for each region from which the default backup windows are assigned.

Constraints: Must be in the format hh24:mi-hh24:mi. Times should be 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, using the BackupRetentionPeriod parameter.

Default: A 30-minute window selected at random from an 8-hour block of time per region. See the Amazon RDS User Guide for the time blocks for each region from which the default backup windows are assigned.

Constraints: Must be in the format hh24:mi-hh24:mi. Times should be Universal Time Coordinated (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. See the Amazon RDS User Guide for the time blocks for each region from which the default backup windows are assigned.

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

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

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. See the Amazon RDS User Guide for the time blocks for each region from which the default backup windows are assigned.

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

Returns:

A reference to this updated 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:

Object.toString()

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals 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:

Object.clone()