Package software.amazon.awssdk.services.rds.model

Interface FailoverDbClusterRequest.Builder

All Superinterfaces:
AwsRequest.Builder, Buildable, CopyableBuilder<FailoverDbClusterRequest.Builder,FailoverDbClusterRequest>, RdsRequest.Builder, SdkBuilder<FailoverDbClusterRequest.Builder,FailoverDbClusterRequest>, SdkPojo, SdkRequest.Builder
Enclosing class:
FailoverDbClusterRequest
public static interface FailoverDbClusterRequest.Builder extends RdsRequest.Builder, SdkPojo, CopyableBuilder<FailoverDbClusterRequest.Builder,FailoverDbClusterRequest>

  • Method Details

    • dbClusterIdentifier

      FailoverDbClusterRequest.Builder dbClusterIdentifier(String dbClusterIdentifier)

      The identifier of the DB cluster to force a failover for. This parameter isn't case-sensitive.

      Constraints:

      • Must match the identifier of an existing DB cluster.

      Parameters:
      dbClusterIdentifier - The identifier of the DB cluster to force a failover for. This parameter isn't case-sensitive.

      Constraints:

      • Must match the identifier of an existing DB cluster.

      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 DB instance to promote to the primary DB instance.

      Specify the DB instance identifier for an Aurora Replica or a Multi-AZ readable standby in the DB cluster, for example mydbcluster-replica1.

      This setting isn't supported for RDS for MySQL Multi-AZ DB clusters.

      Parameters:
      targetDBInstanceIdentifier - The name of the DB instance to promote to the primary DB instance.

      Specify the DB instance identifier for an Aurora Replica or a Multi-AZ readable standby in the DB cluster, for example mydbcluster-replica1.

      This setting isn't supported for RDS for MySQL Multi-AZ DB clusters.

      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.