com.amazonaws.services.docdb.model

Class FailoverDBClusterRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.docdb.model.FailoverDBClusterRequest

All Implemented Interfaces:

HandlerContextAware, ReadLimitInfo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class FailoverDBClusterRequest
extends AmazonWebServiceRequest
implements Serializable, Cloneable

Represents the input to FailoverDBCluster.

See Also:

AWS API Documentation, Serialized Form

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

NOOP

Constructor Summary

Constructors

Constructor and Description
FailoverDBClusterRequest()

Method Summary

Modifier and Type	Method and Description
FailoverDBClusterRequest	clone() Creates a shallow clone of this object for all fields except the handler context.
boolean	equals(Object obj)
String	getDBClusterIdentifier() A cluster identifier to force a failover for.
String	getTargetDBInstanceIdentifier() The name of the instance to promote to the primary instance.
int	hashCode()
void	setDBClusterIdentifier(String dBClusterIdentifier) A cluster identifier to force a failover for.
void	setTargetDBInstanceIdentifier(String targetDBInstanceIdentifier) The name of the instance to promote to the primary instance.
String	toString() Returns a string representation of this object.
FailoverDBClusterRequest	withDBClusterIdentifier(String dBClusterIdentifier) A cluster identifier to force a failover for.
FailoverDBClusterRequest	withTargetDBInstanceIdentifier(String targetDBInstanceIdentifier) The name of the instance to promote to the primary instance.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

addHandlerContext, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getHandlerContext, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestCredentialsProvider, withRequestMetricCollector, withSdkClientExecutionTimeout, withSdkRequestTimeout

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

FailoverDBClusterRequest

public FailoverDBClusterRequest()

Method Detail

setDBClusterIdentifier

public void setDBClusterIdentifier(String dBClusterIdentifier)

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

Constraints:

• Must match the identifier of an existing DBCluster.

Parameters:

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

Constraints:

• Must match the identifier of an existing DBCluster.

getDBClusterIdentifier

public String getDBClusterIdentifier()

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

Constraints:

• Must match the identifier of an existing DBCluster.

Returns:

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

Constraints:

• Must match the identifier of an existing DBCluster.

withDBClusterIdentifier

public FailoverDBClusterRequest withDBClusterIdentifier(String dBClusterIdentifier)

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

Constraints:

• Must match the identifier of an existing DBCluster.

Parameters:

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

Constraints:

• Must match the identifier of an existing DBCluster.

Returns:

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

setTargetDBInstanceIdentifier

public void setTargetDBInstanceIdentifier(String targetDBInstanceIdentifier)

The name of the instance to promote to the primary instance.

You must specify the instance identifier for an Amazon DocumentDB replica in the cluster. For example, mydbcluster-replica1.

Parameters:

targetDBInstanceIdentifier - The name of the instance to promote to the primary instance.

You must specify the instance identifier for an Amazon DocumentDB replica in the cluster. For example, mydbcluster-replica1.

getTargetDBInstanceIdentifier

public String getTargetDBInstanceIdentifier()

The name of the instance to promote to the primary instance.

You must specify the instance identifier for an Amazon DocumentDB replica in the cluster. For example, mydbcluster-replica1.

Returns:

The name of the instance to promote to the primary instance.

You must specify the instance identifier for an Amazon DocumentDB replica in the cluster. For example, mydbcluster-replica1.

withTargetDBInstanceIdentifier

public FailoverDBClusterRequest withTargetDBInstanceIdentifier(String targetDBInstanceIdentifier)

The name of the instance to promote to the primary instance.

You must specify the instance identifier for an Amazon DocumentDB replica in the cluster. For example, mydbcluster-replica1.

Parameters:

targetDBInstanceIdentifier - The name of the instance to promote to the primary instance.

You must specify the instance identifier for an Amazon DocumentDB replica in the cluster. For example, mydbcluster-replica1.

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. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.

Overrides:

toString in class Object

Returns:

A string representation of this object.

See Also:

Object.toString()

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

clone

public FailoverDBClusterRequest clone()

Description copied from class: AmazonWebServiceRequest

Creates a shallow clone of this object for all fields except the handler context. Explicitly does not clone the deep structure of the other fields in the message.

Overrides:

clone in class AmazonWebServiceRequest

See Also:

Object.clone()