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

Class FailoverGlobalClusterRequest

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

  • Method Details

    • globalClusterIdentifier

      public final String globalClusterIdentifier()

      The identifier of the global database cluster (Aurora global database) this operation should apply to. The identifier is the unique key assigned by the user when the Aurora global database is created. In other words, it's the name of the Aurora global database.

      Constraints:

      • Must match the identifier of an existing global database cluster.

      Returns:
      The identifier of the global database cluster (Aurora global database) this operation should apply to. The identifier is the unique key assigned by the user when the Aurora global database is created. In other words, it's the name of the Aurora global database.

      Constraints:

      • Must match the identifier of an existing global database cluster.

    • targetDbClusterIdentifier

      public final String targetDbClusterIdentifier()

      The identifier of the secondary Aurora DB cluster that you want to promote to the primary for the global database cluster. Use the Amazon Resource Name (ARN) for the identifier so that Aurora can locate the cluster in its Amazon Web Services Region.

      Returns:
      The identifier of the secondary Aurora DB cluster that you want to promote to the primary for the global database cluster. Use the Amazon Resource Name (ARN) for the identifier so that Aurora can locate the cluster in its Amazon Web Services Region.

    • allowDataLoss

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

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

    • 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()
      Specified by:
      toBuilder in interface ToCopyableBuilder<FailoverGlobalClusterRequest.Builder,FailoverGlobalClusterRequest>
      Specified by:
      toBuilder in class RdsRequest

    • 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)
      Specified by:
      equalsBySdkFields in interface SdkPojo

    • 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)
      Overrides:
      getValueForField in class SdkRequest

    • sdkFields

      public final List<SdkField<?>> sdkFields()
      Specified by:
      sdkFields in interface SdkPojo

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo