Class GlobalCluster

java.lang.Object
software.amazon.awssdk.services.rds.model.GlobalCluster
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<GlobalCluster.Builder,GlobalCluster>
@Generated("software.amazon.awssdk:codegen") public final class GlobalCluster extends Object implements SdkPojo, Serializable, ToCopyableBuilder<GlobalCluster.Builder,GlobalCluster>

A data type representing an Aurora global database.

See Also:

  • Method Details

    • globalClusterIdentifier

      public final String globalClusterIdentifier()

      Contains a user-supplied global database cluster identifier. This identifier is the unique key that identifies a global database cluster.

      Returns:
      Contains a user-supplied global database cluster identifier. This identifier is the unique key that identifies a global database cluster.

    • globalClusterResourceId

      public final String globalClusterResourceId()

      The Amazon Web Services Region-unique, immutable identifier for the global database cluster. This identifier is found in Amazon Web Services CloudTrail log entries whenever the Amazon Web Services KMS key for the DB cluster is accessed.

      Returns:
      The Amazon Web Services Region-unique, immutable identifier for the global database cluster. This identifier is found in Amazon Web Services CloudTrail log entries whenever the Amazon Web Services KMS key for the DB cluster is accessed.

    • globalClusterArn

      public final String globalClusterArn()

      The Amazon Resource Name (ARN) for the global database cluster.

      Returns:
      The Amazon Resource Name (ARN) for the global database cluster.

    • status

      public final String status()

      Specifies the current state of this global database cluster.

      Returns:
      Specifies the current state of this global database cluster.

    • engine

      public final String engine()

      The Aurora database engine used by the global database cluster.

      Returns:
      The Aurora database engine used by the global database cluster.

    • engineVersion

      public final String engineVersion()

      Indicates the database engine version.

      Returns:
      Indicates the database engine version.

    • engineLifecycleSupport

      public final String engineLifecycleSupport()

      The lifecycle type for the global cluster.

      For more information, see CreateGlobalCluster.

      Returns:
      The lifecycle type for the global cluster.

      For more information, see CreateGlobalCluster.

    • databaseName

      public final String databaseName()

      The default database name within the new global database cluster.

      Returns:
      The default database name within the new global database cluster.

    • storageEncrypted

      public final Boolean storageEncrypted()

      The storage encryption setting for the global database cluster.

      Returns:
      The storage encryption setting for the global database cluster.

    • deletionProtection

      public final Boolean deletionProtection()

      The deletion protection setting for the new global database cluster.

      Returns:
      The deletion protection setting for the new global database cluster.

    • hasGlobalClusterMembers

      public final boolean hasGlobalClusterMembers()
      For responses, this returns true if the service returned a value for the GlobalClusterMembers property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

    • globalClusterMembers

      public final List<GlobalClusterMember> globalClusterMembers()

      The list of primary and secondary clusters within the global database cluster.

      Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

      This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasGlobalClusterMembers() method.

      Returns:
      The list of primary and secondary clusters within the global database cluster.

    • endpoint

      public final String endpoint()

      The writer endpoint for the new global database cluster. This endpoint always points to the writer DB instance in the current primary cluster.

      Returns:
      The writer endpoint for the new global database cluster. This endpoint always points to the writer DB instance in the current primary cluster.

    • failoverState

      public final FailoverState failoverState()

      A data object containing all properties for the current state of an in-process or pending switchover or failover process for this global cluster (Aurora global database). This object is empty unless the SwitchoverGlobalCluster or FailoverGlobalCluster operation was called on this global cluster.

      Returns:
      A data object containing all properties for the current state of an in-process or pending switchover or failover process for this global cluster (Aurora global database). This object is empty unless the SwitchoverGlobalCluster or FailoverGlobalCluster operation was called on this global cluster.

    • hasTagList

      public final boolean hasTagList()
      For responses, this returns true if the service returned a value for the TagList property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

    • tagList

      public final List<Tag> tagList()
      Returns the value of the TagList property for this object.

      Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

      This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasTagList() method.

      Returns:
      The value of the TagList property for this object.

    • toBuilder

      public GlobalCluster.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<GlobalCluster.Builder,GlobalCluster>
      Returns:
      a builder for type T

    • builder

      public static GlobalCluster.Builder builder()

    • serializableBuilderClass

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

    • hashCode

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

    • equals

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

    • 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)

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

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.