Package software.amazon.awssdk.services.docdb.model

Interface SwitchoverGlobalClusterRequest.Builder

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

  • Method Details

    • globalClusterIdentifier

      SwitchoverGlobalClusterRequest.Builder globalClusterIdentifier(String globalClusterIdentifier)

      The identifier of the Amazon DocumentDB global database cluster to switch over. 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. This parameter isn’t case-sensitive.

      Constraints:

      • Must match the identifier of an existing global cluster (Amazon DocumentDB global database).

      • 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 database cluster to switch over. 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. This parameter isn’t case-sensitive.

      Constraints:

      • Must match the identifier of an existing global cluster (Amazon DocumentDB global database).

      • 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

      SwitchoverGlobalClusterRequest.Builder targetDbClusterIdentifier(String targetDbClusterIdentifier)

      The identifier of the secondary Amazon DocumentDB cluster to promote to the new primary for the global database 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 to promote to the new primary for the global database 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.

    • overrideConfiguration

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

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