Class UpdateClusterRequest

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

  • Method Details

    • clusterName

      public final String clusterName()

      The name of the cluster to update

      Returns:
      The name of the cluster to update

    • description

      public final String description()

      The description of the cluster to update

      Returns:
      The description of the cluster to update

    • hasSecurityGroupIds

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

    • securityGroupIds

      public final List<String> securityGroupIds()

      The SecurityGroupIds to update

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

      Returns:
      The SecurityGroupIds to update

    • maintenanceWindow

      public final String maintenanceWindow()

      Specifies the weekly time range during which maintenance on the cluster is performed. It is specified as a range in the format ddd:hh24:mi-ddd:hh24:mi (24H Clock UTC). The minimum maintenance window is a 60 minute period.

      Valid values for ddd are:

      • sun

      • mon

      • tue

      • wed

      • thu

      • fri

      • sat

      Example: sun:23:00-mon:01:30

      Returns:
      Specifies the weekly time range during which maintenance on the cluster is performed. It is specified as a range in the format ddd:hh24:mi-ddd:hh24:mi (24H Clock UTC). The minimum maintenance window is a 60 minute period.

      Valid values for ddd are:

      • sun

      • mon

      • tue

      • wed

      • thu

      • fri

      • sat

      Example: sun:23:00-mon:01:30

    • snsTopicArn

      public final String snsTopicArn()

      The SNS topic ARN to update

      Returns:
      The SNS topic ARN to update

    • snsTopicStatus

      public final String snsTopicStatus()

      The status of the Amazon SNS notification topic. Notifications are sent only if the status is active.

      Returns:
      The status of the Amazon SNS notification topic. Notifications are sent only if the status is active.

    • parameterGroupName

      public final String parameterGroupName()

      The name of the parameter group to update

      Returns:
      The name of the parameter group to update

    • snapshotWindow

      public final String snapshotWindow()

      The daily time range (in UTC) during which MemoryDB begins taking a daily snapshot of your cluster.

      Returns:
      The daily time range (in UTC) during which MemoryDB begins taking a daily snapshot of your cluster.

    • snapshotRetentionLimit

      public final Integer snapshotRetentionLimit()

      The number of days for which MemoryDB retains automatic cluster snapshots before deleting them. For example, if you set SnapshotRetentionLimit to 5, a snapshot that was taken today is retained for 5 days before being deleted.

      Returns:
      The number of days for which MemoryDB retains automatic cluster snapshots before deleting them. For example, if you set SnapshotRetentionLimit to 5, a snapshot that was taken today is retained for 5 days before being deleted.

    • nodeType

      public final String nodeType()

      A valid node type that you want to scale this cluster up or down to.

      Returns:
      A valid node type that you want to scale this cluster up or down to.

    • engine

      public final String engine()

      The name of the engine to be used for the nodes in this cluster. The value must be set to either Redis or Valkey.

      Returns:
      The name of the engine to be used for the nodes in this cluster. The value must be set to either Redis or Valkey.

    • engineVersion

      public final String engineVersion()

      The upgraded version of the engine to be run on the nodes. You can upgrade to a newer engine version, but you cannot downgrade to an earlier engine version. If you want to use an earlier engine version, you must delete the existing cluster and create it anew with the earlier engine version.

      Returns:
      The upgraded version of the engine to be run on the nodes. You can upgrade to a newer engine version, but you cannot downgrade to an earlier engine version. If you want to use an earlier engine version, you must delete the existing cluster and create it anew with the earlier engine version.

    • replicaConfiguration

      public final ReplicaConfigurationRequest replicaConfiguration()

      The number of replicas that will reside in each shard

      Returns:
      The number of replicas that will reside in each shard

    • shardConfiguration

      public final ShardConfigurationRequest shardConfiguration()

      The number of shards in the cluster

      Returns:
      The number of shards in the cluster

    • aclName

      public final String aclName()

      The Access Control List that is associated with the cluster

      Returns:
      The Access Control List that is associated with the cluster

    • toBuilder

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

    • builder

      public static UpdateClusterRequest.Builder builder()

    • serializableBuilderClass

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