software.amazon.awssdk.services.docdb.model

Interface FailoverDbClusterRequest.Builder

All Superinterfaces:

AwsRequest.Builder, Buildable, CopyableBuilder<FailoverDbClusterRequest.Builder,FailoverDbClusterRequest>, DocDbRequest.Builder, SdkBuilder<FailoverDbClusterRequest.Builder,FailoverDbClusterRequest>, SdkPojo, SdkRequest.Builder

Enclosing class:

FailoverDbClusterRequest

public static interface FailoverDbClusterRequest.Builder
extends DocDbRequest.Builder, SdkPojo, CopyableBuilder<FailoverDbClusterRequest.Builder,FailoverDbClusterRequest>

Method Summary

Modifier and Type	Method and Description
FailoverDbClusterRequest.Builder	dbClusterIdentifier(String dbClusterIdentifier) A cluster identifier to force a failover for.
FailoverDbClusterRequest.Builder	overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
FailoverDbClusterRequest.Builder	overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
FailoverDbClusterRequest.Builder	targetDBInstanceIdentifier(String targetDBInstanceIdentifier) The name of the instance to promote to the primary instance.

Methods inherited from interface software.amazon.awssdk.services.docdb.model.DocDbRequest.Builder

build

Methods inherited from interface software.amazon.awssdk.awscore.AwsRequest.Builder

overrideConfiguration

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

equalsBySdkFields, sdkFields

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

copy

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

applyMutation, build

Method Detail

dbClusterIdentifier

FailoverDbClusterRequest.Builder dbClusterIdentifier(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.

targetDBInstanceIdentifier

FailoverDbClusterRequest.Builder targetDBInstanceIdentifier(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.

overrideConfiguration

FailoverDbClusterRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)

Specified by:

overrideConfiguration in interface AwsRequest.Builder

overrideConfiguration

FailoverDbClusterRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)

Specified by:

overrideConfiguration in interface AwsRequest.Builder