com.amazonaws.services.rds.model

Class FailoverDBClusterRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.rds.model.FailoverDBClusterRequest

All Implemented Interfaces:

ReadLimitInfo, Serializable, Cloneable

public class FailoverDBClusterRequest
extends AmazonWebServiceRequest
implements Serializable, Cloneable

Container for the parameters to the FailoverDBCluster operation.

Forces a failover for a DB cluster.

A failover for a DB cluster promotes one of the read-only instances in the DB cluster to the master DB instance (the cluster writer) and deletes the current primary instance.

Amazon Aurora will automatically fail over to a read-only instance, if one exists, when the primary instance fails. You can force a failover when you want to simulate a failure of a DB instance for testing. Because each instance in a DB cluster has its own endpoint address, you will need to clean up and re-establish any existing connections that use those endpoint addresses when the failover is complete.

For more information on Amazon Aurora, see Aurora on Amazon RDS in the Amazon RDS User Guide.

See Also:

AmazonRDS.failoverDBCluster(FailoverDBClusterRequest), Serialized Form

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

NOOP

Constructor Summary

Constructors

Constructor and Description
FailoverDBClusterRequest()

Method Summary

Methods

Modifier and Type	Method and Description
FailoverDBClusterRequest	clone() Creates a shallow clone of this request.
boolean	equals(Object obj)
String	getDBClusterIdentifier() A DB cluster identifier to force a failover for.
int	hashCode()
void	setDBClusterIdentifier(String dBClusterIdentifier) A DB cluster identifier to force a failover for.
String	toString() Returns a string representation of this object; useful for testing and debugging.
FailoverDBClusterRequest	withDBClusterIdentifier(String dBClusterIdentifier) A DB cluster identifier to force a failover for.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

copyBaseTo, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestMetricCollector, withSdkClientExecutionTimeout, withSdkRequestTimeout

Methods inherited from class java.lang.Object

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

Constructor Detail

FailoverDBClusterRequest

public FailoverDBClusterRequest()

Method Detail

getDBClusterIdentifier

public String getDBClusterIdentifier()

A DB cluster identifier to force a failover for. This parameter is not case-sensitive.

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:

A DB cluster identifier to force a failover for. This parameter is not case-sensitive.

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

setDBClusterIdentifier

public void setDBClusterIdentifier(String dBClusterIdentifier)

A DB cluster identifier to force a failover for. This parameter is not case-sensitive.

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:

dBClusterIdentifier - A DB cluster identifier to force a failover for. This parameter is not case-sensitive.

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

withDBClusterIdentifier

public FailoverDBClusterRequest withDBClusterIdentifier(String dBClusterIdentifier)

A DB cluster identifier to force a failover for. This parameter is not case-sensitive.

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 a reference to this object so that method calls can be chained together.

Parameters:

dBClusterIdentifier - A DB cluster identifier to force a failover for. This parameter is not case-sensitive.

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:

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 FailoverDBClusterRequest 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()