Package software.amazon.awssdk.services.elasticache.model

Class GlobalReplicationGroup

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

Consists of a primary cluster that accepts writes and an associated secondary cluster that resides in a different Amazon region. The secondary cluster accepts only reads. The primary cluster automatically replicates updates to the secondary cluster.

  • The GlobalReplicationGroupIdSuffix represents the name of the Global datastore, which is what you use to associate a secondary cluster.

See Also:

  • Method Details

    • globalReplicationGroupId

      public final String globalReplicationGroupId()

      The name of the Global datastore

      Returns:
      The name of the Global datastore

    • globalReplicationGroupDescription

      public final String globalReplicationGroupDescription()

      The optional description of the Global datastore

      Returns:
      The optional description of the Global datastore

    • status

      public final String status()

      The status of the Global datastore

      Returns:
      The status of the Global datastore

    • cacheNodeType

      public final String cacheNodeType()

      The cache node type of the Global datastore

      Returns:
      The cache node type of the Global datastore

    • engine

      public final String engine()

      The Elasticache engine. For Redis only.

      Returns:
      The Elasticache engine. For Redis only.

    • engineVersion

      public final String engineVersion()

      The Elasticache Redis engine version.

      Returns:
      The Elasticache Redis engine version.

    • hasMembers

      public final boolean hasMembers()
      For responses, this returns true if the service returned a value for the Members 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.

    • members

      public final List<GlobalReplicationGroupMember> members()

      The replication groups that comprise the Global datastore.

      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 hasMembers() method.

      Returns:
      The replication groups that comprise the Global datastore.

    • clusterEnabled

      public final Boolean clusterEnabled()

      A flag that indicates whether the Global datastore is cluster enabled.

      Returns:
      A flag that indicates whether the Global datastore is cluster enabled.

    • hasGlobalNodeGroups

      public final boolean hasGlobalNodeGroups()
      For responses, this returns true if the service returned a value for the GlobalNodeGroups 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.

    • globalNodeGroups

      public final List<GlobalNodeGroup> globalNodeGroups()

      Indicates the slot configuration and global identifier for each slice group.

      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 hasGlobalNodeGroups() method.

      Returns:
      Indicates the slot configuration and global identifier for each slice group.

    • authTokenEnabled

      public final Boolean authTokenEnabled()

      A flag that enables using an AuthToken (password) when issuing Redis commands.

      Default: false

      Returns:
      A flag that enables using an AuthToken (password) when issuing Redis commands.

      Default: false

    • transitEncryptionEnabled

      public final Boolean transitEncryptionEnabled()

      A flag that enables in-transit encryption when set to true.

      Required: Only available when creating a replication group in an Amazon VPC using redis version 3.2.6, 4.x or later.

      Returns:
      A flag that enables in-transit encryption when set to true.

      Required: Only available when creating a replication group in an Amazon VPC using redis version 3.2.6, 4.x or later.

    • atRestEncryptionEnabled

      public final Boolean atRestEncryptionEnabled()

      A flag that enables encryption at rest when set to true.

      You cannot modify the value of AtRestEncryptionEnabled after the replication group is created. To enable encryption at rest on a replication group you must set AtRestEncryptionEnabled to true when you create the replication group.

      Required: Only available when creating a replication group in an Amazon VPC using redis version 3.2.6, 4.x or later.

      Returns:
      A flag that enables encryption at rest when set to true.

      You cannot modify the value of AtRestEncryptionEnabled after the replication group is created. To enable encryption at rest on a replication group you must set AtRestEncryptionEnabled to true when you create the replication group.

      Required: Only available when creating a replication group in an Amazon VPC using redis version 3.2.6, 4.x or later.

    • arn

      public final String arn()

      The ARN (Amazon Resource Name) of the global replication group.

      Returns:
      The ARN (Amazon Resource Name) of the global replication group.

    • toBuilder

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

    • builder

      public static GlobalReplicationGroup.Builder builder()

    • serializableBuilderClass

      public static Class<? extends GlobalReplicationGroup.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.