Package 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 Details

    • 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)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      overrideConfiguration - The override configuration.
      Returns:
      This object for method chaining.

    • overrideConfiguration

      FailoverDbClusterRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      builderConsumer - A Consumer to which an empty AwsRequestOverrideConfiguration.Builder will be given.
      Returns:
      This object for method chaining.