Interface FailoverState.Builder

All Superinterfaces:

Buildable, CopyableBuilder<FailoverState.Builder,FailoverState>, SdkBuilder<FailoverState.Builder,FailoverState>, SdkPojo

Enclosing class:

FailoverState

@Mutable
@NotThreadSafe
public static interface FailoverState.Builder
extends SdkPojo, CopyableBuilder<FailoverState.Builder,FailoverState>

Method Summary

Modifier and Type	Method	Description
FailoverState.Builder	fromDbClusterArn(String fromDbClusterArn)	The Amazon Resource Name (ARN) of the Amazon DocumentDB cluster that is currently being demoted, and which is associated with this state.
FailoverState.Builder	isDataLossAllowed(Boolean isDataLossAllowed)	Indicates whether the operation is a global switchover or a global failover.
FailoverState.Builder	status(String status)	The current status of the global cluster.
FailoverState.Builder	status(FailoverStatus status)	The current status of the global cluster.
FailoverState.Builder	toDbClusterArn(String toDbClusterArn)	The Amazon Resource Name (ARN) of the Amazon DocumentDB cluster that is currently being promoted, and which is associated with this state.

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

copy

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

applyMutation, build

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

equalsBySdkFields, sdkFieldNameToField, sdkFields

Method Details

status

FailoverState.Builder status(String status)

The current status of the global cluster. Possible values are as follows:

• pending – The service received a request to switch over or fail over the global cluster. The global cluster's primary cluster and the specified secondary cluster are being verified before the operation starts.

• failing-over – The chosen secondary cluster is being promoted to become the new primary cluster to fail over the global cluster.

• cancelling – The request to switch over or fail over the global cluster was cancelled and the primary cluster and the selected secondary cluster are returning to their previous states.

Parameters:

status - The current status of the global cluster. Possible values are as follows:

• pending – The service received a request to switch over or fail over the global cluster. The global cluster's primary cluster and the specified secondary cluster are being verified before the operation starts.

• failing-over – The chosen secondary cluster is being promoted to become the new primary cluster to fail over the global cluster.

• cancelling – The request to switch over or fail over the global cluster was cancelled and the primary cluster and the selected secondary cluster are returning to their previous states.

Returns:

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

See Also:

• FailoverStatus
• FailoverStatus

status

FailoverState.Builder status(FailoverStatus status)

The current status of the global cluster. Possible values are as follows:

• pending – The service received a request to switch over or fail over the global cluster. The global cluster's primary cluster and the specified secondary cluster are being verified before the operation starts.

• failing-over – The chosen secondary cluster is being promoted to become the new primary cluster to fail over the global cluster.

• cancelling – The request to switch over or fail over the global cluster was cancelled and the primary cluster and the selected secondary cluster are returning to their previous states.

Parameters:

status - The current status of the global cluster. Possible values are as follows:

• pending – The service received a request to switch over or fail over the global cluster. The global cluster's primary cluster and the specified secondary cluster are being verified before the operation starts.

• failing-over – The chosen secondary cluster is being promoted to become the new primary cluster to fail over the global cluster.

• cancelling – The request to switch over or fail over the global cluster was cancelled and the primary cluster and the selected secondary cluster are returning to their previous states.

Returns:

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

See Also:

• FailoverStatus
• FailoverStatus

fromDbClusterArn

FailoverState.Builder fromDbClusterArn(String fromDbClusterArn)

The Amazon Resource Name (ARN) of the Amazon DocumentDB cluster that is currently being demoted, and which is associated with this state.

Parameters:

fromDbClusterArn - The Amazon Resource Name (ARN) of the Amazon DocumentDB cluster that is currently being demoted, and which is associated with this state.

Returns:

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

toDbClusterArn

FailoverState.Builder toDbClusterArn(String toDbClusterArn)

The Amazon Resource Name (ARN) of the Amazon DocumentDB cluster that is currently being promoted, and which is associated with this state.

Parameters:

toDbClusterArn - The Amazon Resource Name (ARN) of the Amazon DocumentDB cluster that is currently being promoted, and which is associated with this state.

Returns:

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

isDataLossAllowed

FailoverState.Builder isDataLossAllowed(Boolean isDataLossAllowed)

Indicates whether the operation is a global switchover or a global failover. If data loss is allowed, then the operation is a global failover. Otherwise, it's a switchover.

Parameters:

isDataLossAllowed - Indicates whether the operation is a global switchover or a global failover. If data loss is allowed, then the operation is a global failover. Otherwise, it's a switchover.

Returns:

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