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

Class FailoverGlobalClusterRequest

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.FailoverGlobalClusterRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<FailoverGlobalClusterRequest.Builder,FailoverGlobalClusterRequest>

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

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	FailoverGlobalClusterRequest.Builder

Method Summary

Modifier and Type	Method	Description
Boolean	allowDataLoss()	Specifies whether to allow data loss for this global cluster operation.
static FailoverGlobalClusterRequest.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
String	globalClusterIdentifier()	The identifier of the Amazon DocumentDB global cluster to apply this operation.
int	hashCode()
Map<String,SdkField<?>>	sdkFieldNameToField()
List<SdkField<?>>	sdkFields()
static Class<? extends FailoverGlobalClusterRequest.Builder>	serializableBuilderClass()
Boolean	switchover()	Specifies whether to switch over this global database cluster.
String	targetDbClusterIdentifier()	The identifier of the secondary Amazon DocumentDB cluster that you want to promote to the primary for the global cluster.
FailoverGlobalClusterRequest.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

globalClusterIdentifier

public final String globalClusterIdentifier()

The identifier of the Amazon DocumentDB global cluster to apply this operation. The identifier is the unique key assigned by the user when the cluster is created. In other words, it's the name of the global cluster.

Constraints:

• Must match the identifier of an existing global cluster.

• Minimum length of 1. Maximum length of 255.

Pattern: [A-Za-z][0-9A-Za-z-:._]*

Returns:

The identifier of the Amazon DocumentDB global cluster to apply this operation. The identifier is the unique key assigned by the user when the cluster is created. In other words, it's the name of the global cluster.

Constraints:

• Must match the identifier of an existing global cluster.

• Minimum length of 1. Maximum length of 255.

Pattern: [A-Za-z][0-9A-Za-z-:._]*

targetDbClusterIdentifier

public final String targetDbClusterIdentifier()

The identifier of the secondary Amazon DocumentDB cluster that you want to promote to the primary for the global cluster. Use the Amazon Resource Name (ARN) for the identifier so that Amazon DocumentDB can locate the cluster in its Amazon Web Services region.

Constraints:

• Must match the identifier of an existing secondary cluster.

• Minimum length of 1. Maximum length of 255.

Pattern: [A-Za-z][0-9A-Za-z-:._]*

Returns:

The identifier of the secondary Amazon DocumentDB cluster that you want to promote to the primary for the global cluster. Use the Amazon Resource Name (ARN) for the identifier so that Amazon DocumentDB can locate the cluster in its Amazon Web Services region.

Constraints:

• Must match the identifier of an existing secondary cluster.

• Minimum length of 1. Maximum length of 255.

Pattern: [A-Za-z][0-9A-Za-z-:._]*

allowDataLoss

public final Boolean allowDataLoss()

Specifies whether to allow data loss for this global cluster operation. Allowing data loss triggers a global failover operation.

If you don't specify AllowDataLoss, the global cluster operation defaults to a switchover.

Constraints:

• Can't be specified together with the Switchover parameter.

Returns:

Specifies whether to allow data loss for this global cluster operation. Allowing data loss triggers a global failover operation.

If you don't specify AllowDataLoss, the global cluster operation defaults to a switchover.

Constraints:

• Can't be specified together with the Switchover parameter.

switchover

public final Boolean switchover()

Specifies whether to switch over this global database cluster.

Constraints:

• Can't be specified together with the AllowDataLoss parameter.

Returns:

Specifies whether to switch over this global database cluster.

Constraints:

• Can't be specified together with the AllowDataLoss parameter.

toBuilder

public FailoverGlobalClusterRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<FailoverGlobalClusterRequest.Builder,FailoverGlobalClusterRequest>

Specified by:

toBuilder in class DocDbRequest

builder

public static FailoverGlobalClusterRequest.Builder builder()

serializableBuilderClass

public static Class<? extends FailoverGlobalClusterRequest.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

sdkFieldNameToField

public final Map<String,SdkField<?>> sdkFieldNameToField()

Specified by:

sdkFieldNameToField in interface SdkPojo