Interface FailoverGlobalClusterRequest.Builder

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

  • Method Details

    • globalClusterIdentifier

      FailoverGlobalClusterRequest.Builder globalClusterIdentifier(String globalClusterIdentifier)

      Identifier of the Neptune global database that should be failed over. The identifier is the unique key assigned by the user when the Neptune global database was created. In other words, it's the name of the global database that you want to fail over.

      Constraints: Must match the identifier of an existing Neptune global database.

      Parameters:
      globalClusterIdentifier - Identifier of the Neptune global database that should be failed over. The identifier is the unique key assigned by the user when the Neptune global database was created. In other words, it's the name of the global database that you want to fail over.

      Constraints: Must match the identifier of an existing Neptune global database.

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

    • targetDbClusterIdentifier

      FailoverGlobalClusterRequest.Builder targetDbClusterIdentifier(String targetDbClusterIdentifier)

      The Amazon Resource Name (ARN) of the secondary Neptune DB cluster that you want to promote to primary for the global database.

      Parameters:
      targetDbClusterIdentifier - The Amazon Resource Name (ARN) of the secondary Neptune DB cluster that you want to promote to primary for the global database.
      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 database cluster operation. Allowing data loss triggers a global failover operation.

      If you don't specify AllowDataLoss, the global database 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 database cluster operation. Allowing data loss triggers a global failover operation.

      If you don't specify AllowDataLoss, the global database 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.