Class ModifyGlobalReplicationGroupRequest

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

  • Method Details

    • globalReplicationGroupId

      public final String globalReplicationGroupId()

      The name of the Global datastore

      Returns:
      The name of the Global datastore

    • applyImmediately

      public final Boolean applyImmediately()

      This parameter causes the modifications in this request and any pending modifications to be applied, asynchronously and as soon as possible. Modifications to Global Replication Groups cannot be requested to be applied in PreferredMaintenceWindow.

      Returns:
      This parameter causes the modifications in this request and any pending modifications to be applied, asynchronously and as soon as possible. Modifications to Global Replication Groups cannot be requested to be applied in PreferredMaintenceWindow.

    • cacheNodeType

      public final String cacheNodeType()

      A valid cache node type that you want to scale this Global datastore to.

      Returns:
      A valid cache node type that you want to scale this Global datastore to.

    • engine

      public final String engine()

      Modifies the engine listed in a global replication group message. The options are redis, memcached or valkey.

      Returns:
      Modifies the engine listed in a global replication group message. The options are redis, memcached or valkey.

    • engineVersion

      public final String engineVersion()

      The upgraded version of the cache engine to be run on the clusters in the Global datastore.

      Returns:
      The upgraded version of the cache engine to be run on the clusters in the Global datastore.

    • cacheParameterGroupName

      public final String cacheParameterGroupName()

      The name of the cache parameter group to use with the Global datastore. It must be compatible with the major engine version used by the Global datastore.

      Returns:
      The name of the cache parameter group to use with the Global datastore. It must be compatible with the major engine version used by the Global datastore.

    • globalReplicationGroupDescription

      public final String globalReplicationGroupDescription()

      A description of the Global datastore

      Returns:
      A description of the Global datastore

    • automaticFailoverEnabled

      public final Boolean automaticFailoverEnabled()

      Determines whether a read replica is automatically promoted to read/write primary if the existing primary encounters a failure.

      Returns:
      Determines whether a read replica is automatically promoted to read/write primary if the existing primary encounters a failure.

    • toBuilder

      public ModifyGlobalReplicationGroupRequest.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<ModifyGlobalReplicationGroupRequest.Builder,ModifyGlobalReplicationGroupRequest>
      Specified by:
      toBuilder in class ElastiCacheRequest
      Returns:
      a builder for type T

    • builder

      public static ModifyGlobalReplicationGroupRequest.Builder builder()

    • serializableBuilderClass

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