Package software.amazon.awssdk.services.docdb.model

Class FailoverDbClusterRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.docdb.model.DocDbRequest

software.amazon.awssdk.services.docdb.model.FailoverDbClusterRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<FailoverDbClusterRequest.Builder,FailoverDbClusterRequest>

@Generated("software.amazon.awssdk:codegen")
public final class FailoverDbClusterRequest
extends DocDbRequest
implements ToCopyableBuilder<FailoverDbClusterRequest.Builder,FailoverDbClusterRequest>

Represents the input to FailoverDBCluster.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	FailoverDbClusterRequest.Builder

Method Summary

Modifier and Type	Method	Description
static FailoverDbClusterRequest.Builder	builder()
String	dbClusterIdentifier()	A cluster identifier to force a failover for.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
List<SdkField<?>>	sdkFields()
static Class<? extends FailoverDbClusterRequest.Builder>	serializableBuilderClass()
String	targetDBInstanceIdentifier()	The name of the instance to promote to the primary instance.
FailoverDbClusterRequest.Builder	toBuilder()
String	toString()	Returns a string representation of this object.

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

overrideConfiguration

Methods inherited from class java.lang.Object

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

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

dbClusterIdentifier

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

Returns:

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

Constraints:

• Must match the identifier of an existing DBCluster.

targetDBInstanceIdentifier

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

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.

toBuilder

public FailoverDbClusterRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<FailoverDbClusterRequest.Builder,FailoverDbClusterRequest>

Specified by:

toBuilder in class DocDbRequest

builder

public static FailoverDbClusterRequest.Builder builder()

serializableBuilderClass

public static Class<? extends FailoverDbClusterRequest.Builder> serializableBuilderClass()

hashCode

public final int hashCode()

Overrides:

hashCode in class AwsRequest

equals

public final boolean equals(Object obj)

Overrides:

equals in class AwsRequest

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

toString

public final 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

getValueForField

public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)

Overrides:

getValueForField in class SdkRequest

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo