Interface FailoverGlobalClusterRequest.Builder

All Superinterfaces:
AwsRequest.Builder, Buildable, CopyableBuilder<FailoverGlobalClusterRequest.Builder,FailoverGlobalClusterRequest>, DocDbRequest.Builder, SdkBuilder<FailoverGlobalClusterRequest.Builder,FailoverGlobalClusterRequest>, SdkPojo, SdkRequest.Builder
Enclosing class:
FailoverGlobalClusterRequest
@Mutable @NotThreadSafe public static interface FailoverGlobalClusterRequest.Builder extends DocDbRequest.Builder, SdkPojo, CopyableBuilder<FailoverGlobalClusterRequest.Builder,FailoverGlobalClusterRequest>

  • Method Details

    • globalClusterIdentifier

      FailoverGlobalClusterRequest.Builder globalClusterIdentifier(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-:._]*

      Parameters:
      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:
      Returns a reference to this object so that method calls can be chained together.

    • targetDbClusterIdentifier

      FailoverGlobalClusterRequest.Builder targetDbClusterIdentifier(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-:._]*

      Parameters:
      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:
      Returns a reference to this object so that method calls can be chained together.

    • allowDataLoss

      FailoverGlobalClusterRequest.Builder allowDataLoss(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.

      Parameters:
      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:
      Returns a reference to this object so that method calls can be chained together.

    • switchover

      FailoverGlobalClusterRequest.Builder switchover(Boolean switchover)

      Specifies whether to switch over this global database cluster.

      Constraints:

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

      Parameters:
      switchover - Specifies whether to switch over this global database cluster.

      Constraints:

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

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

    • overrideConfiguration

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

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