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

Class FailoverGlobalClusterRequest

java.lang.Object
software.amazon.awssdk.core.SdkRequest
software.amazon.awssdk.awscore.AwsRequest
software.amazon.awssdk.services.docdb.model.DocDbRequest
software.amazon.awssdk.services.docdb.model.FailoverGlobalClusterRequest
All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<FailoverGlobalClusterRequest.Builder,FailoverGlobalClusterRequest>
@Generated("software.amazon.awssdk:codegen") public final class FailoverGlobalClusterRequest extends DocDbRequest implements ToCopyableBuilder<FailoverGlobalClusterRequest.Builder,FailoverGlobalClusterRequest>

  • Method Details

    • globalClusterIdentifier

      public final 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-:._]*

      Returns:
      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-:._]*

    • targetDbClusterIdentifier

      public final 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-:._]*

      Returns:
      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-:._]*

    • allowDataLoss

      public final 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.

      Returns:
      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.

    • switchover

      public final Boolean switchover()

      Specifies whether to switch over this global database cluster.

      Constraints:

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

      Returns:
      Specifies whether to switch over this global database cluster.

      Constraints:

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

    • toBuilder

      public FailoverGlobalClusterRequest.Builder toBuilder()
      Description copied from interface: ToCopyableBuilder
      Take this object and create a builder that contains all of the current property values of this object.
      Specified by:
      toBuilder in interface ToCopyableBuilder<FailoverGlobalClusterRequest.Builder,FailoverGlobalClusterRequest>
      Specified by:
      toBuilder in class DocDbRequest
      Returns:
      a builder for type T

    • builder

      public static FailoverGlobalClusterRequest.Builder builder()

    • serializableBuilderClass

      public static Class<? extends FailoverGlobalClusterRequest.Builder> serializableBuilderClass()

    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class AwsRequest

    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class AwsRequest

    • equalsBySdkFields

      public final boolean equalsBySdkFields(Object obj)
      Description copied from interface: SdkPojo
      Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • toString

      public final String toString()
      Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
      Overrides:
      toString in class Object

    • getValueForField

      public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
      Description copied from class: SdkRequest
      Used to retrieve the value of a field from any class that extends SdkRequest. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, the SdkRequest.getValueForField(String, Class) method will again be available.
      Overrides:
      getValueForField in class SdkRequest
      Parameters:
      fieldName - The name of the member to be retrieved.
      clazz - The class to cast the returned object to.
      Returns:
      Optional containing the casted return value

    • sdkFields

      public final List<SdkField<?>> sdkFields()
      Specified by:
      sdkFields in interface SdkPojo
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.