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

Class DescribeReservedCacheNodesOfferingsRequest

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.DescribeReservedCacheNodesOfferingsRequest
All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<DescribeReservedCacheNodesOfferingsRequest.Builder,DescribeReservedCacheNodesOfferingsRequest>
@Generated("software.amazon.awssdk:codegen") public final class DescribeReservedCacheNodesOfferingsRequest extends ElastiCacheRequest implements ToCopyableBuilder<DescribeReservedCacheNodesOfferingsRequest.Builder,DescribeReservedCacheNodesOfferingsRequest>

Represents the input of a DescribeReservedCacheNodesOfferings operation.

  • Method Details

    • reservedCacheNodesOfferingId

      public final String reservedCacheNodesOfferingId()

      The offering identifier filter value. Use this parameter to show only the available offering that matches the specified reservation identifier.

      Example: 438012d3-4052-4cc7-b2e3-8d3372e0e706

      Returns:
      The offering identifier filter value. Use this parameter to show only the available offering that matches the specified reservation identifier.

      Example: 438012d3-4052-4cc7-b2e3-8d3372e0e706

    • cacheNodeType

      public final String cacheNodeType()

      The cache node type filter value. Use this parameter to show only the available offerings matching the specified cache node type.

      The following node types are supported by ElastiCache. Generally speaking, the current generation types provide more memory and computational power at lower cost when compared to their equivalent previous generation counterparts.

      • General purpose:

        • Current generation:

          M7g node types: cache.m7g.large, cache.m7g.xlarge, cache.m7g.2xlarge, cache.m7g.4xlarge, cache.m7g.8xlarge, cache.m7g.12xlarge, cache.m7g.16xlarge

          For region availability, see Supported Node Types

          M6g node types (available only for Redis engine version 5.0.6 onward and for Memcached engine version 1.5.16 onward): cache.m6g.large, cache.m6g.xlarge, cache.m6g.2xlarge, cache.m6g.4xlarge, cache.m6g.8xlarge, cache.m6g.12xlarge, cache.m6g.16xlarge

          M5 node types: cache.m5.large, cache.m5.xlarge, cache.m5.2xlarge, cache.m5.4xlarge, cache.m5.12xlarge, cache.m5.24xlarge

          M4 node types: cache.m4.large, cache.m4.xlarge, cache.m4.2xlarge, cache.m4.4xlarge, cache.m4.10xlarge

          T4g node types (available only for Redis engine version 5.0.6 onward and Memcached engine version 1.5.16 onward): cache.t4g.micro, cache.t4g.small, cache.t4g.medium

          T3 node types: cache.t3.micro, cache.t3.small, cache.t3.medium

          T2 node types: cache.t2.micro, cache.t2.small, cache.t2.medium

        • Previous generation: (not recommended. Existing clusters are still supported but creation of new clusters is not supported for these types.)

          T1 node types: cache.t1.micro

          M1 node types: cache.m1.small, cache.m1.medium, cache.m1.large, cache.m1.xlarge

          M3 node types: cache.m3.medium, cache.m3.large, cache.m3.xlarge, cache.m3.2xlarge

      • Compute optimized:

        • Previous generation: (not recommended. Existing clusters are still supported but creation of new clusters is not supported for these types.)

          C1 node types: cache.c1.xlarge

      • Memory optimized:

        • Current generation:

          R7g node types: cache.r7g.large, cache.r7g.xlarge, cache.r7g.2xlarge, cache.r7g.4xlarge, cache.r7g.8xlarge, cache.r7g.12xlarge, cache.r7g.16xlarge

          For region availability, see Supported Node Types

          R6g node types (available only for Redis engine version 5.0.6 onward and for Memcached engine version 1.5.16 onward): cache.r6g.large, cache.r6g.xlarge, cache.r6g.2xlarge, cache.r6g.4xlarge, cache.r6g.8xlarge, cache.r6g.12xlarge, cache.r6g.16xlarge

          R5 node types: cache.r5.large, cache.r5.xlarge, cache.r5.2xlarge, cache.r5.4xlarge, cache.r5.12xlarge, cache.r5.24xlarge

          R4 node types: cache.r4.large, cache.r4.xlarge, cache.r4.2xlarge, cache.r4.4xlarge, cache.r4.8xlarge, cache.r4.16xlarge

        • Previous generation: (not recommended. Existing clusters are still supported but creation of new clusters is not supported for these types.)

          M2 node types: cache.m2.xlarge, cache.m2.2xlarge, cache.m2.4xlarge

          R3 node types: cache.r3.large, cache.r3.xlarge, cache.r3.2xlarge, cache.r3.4xlarge, cache.r3.8xlarge

      Additional node type info

      • All current generation instance types are created in Amazon VPC by default.

      • Redis append-only files (AOF) are not supported for T1 or T2 instances.

      • Redis Multi-AZ with automatic failover is not supported on T1 instances.

      • Redis configuration variables appendonly and appendfsync are not supported on Redis version 2.8.22 and later.

      Returns:
      The cache node type filter value. Use this parameter to show only the available offerings matching the specified cache node type.

      The following node types are supported by ElastiCache. Generally speaking, the current generation types provide more memory and computational power at lower cost when compared to their equivalent previous generation counterparts.

      • General purpose:

        • Current generation:

          M7g node types: cache.m7g.large, cache.m7g.xlarge, cache.m7g.2xlarge, cache.m7g.4xlarge, cache.m7g.8xlarge, cache.m7g.12xlarge, cache.m7g.16xlarge

          For region availability, see Supported Node Types

          M6g node types (available only for Redis engine version 5.0.6 onward and for Memcached engine version 1.5.16 onward): cache.m6g.large, cache.m6g.xlarge, cache.m6g.2xlarge, cache.m6g.4xlarge, cache.m6g.8xlarge, cache.m6g.12xlarge, cache.m6g.16xlarge

          M5 node types: cache.m5.large, cache.m5.xlarge, cache.m5.2xlarge, cache.m5.4xlarge, cache.m5.12xlarge, cache.m5.24xlarge

          M4 node types: cache.m4.large, cache.m4.xlarge, cache.m4.2xlarge, cache.m4.4xlarge, cache.m4.10xlarge

          T4g node types (available only for Redis engine version 5.0.6 onward and Memcached engine version 1.5.16 onward): cache.t4g.micro, cache.t4g.small, cache.t4g.medium

          T3 node types: cache.t3.micro, cache.t3.small, cache.t3.medium

          T2 node types: cache.t2.micro, cache.t2.small, cache.t2.medium

        • Previous generation: (not recommended. Existing clusters are still supported but creation of new clusters is not supported for these types.)

          T1 node types: cache.t1.micro

          M1 node types: cache.m1.small, cache.m1.medium, cache.m1.large, cache.m1.xlarge

          M3 node types: cache.m3.medium, cache.m3.large, cache.m3.xlarge, cache.m3.2xlarge

      • Compute optimized:

        • Previous generation: (not recommended. Existing clusters are still supported but creation of new clusters is not supported for these types.)

          C1 node types: cache.c1.xlarge

      • Memory optimized:

        • Current generation:

          R7g node types: cache.r7g.large, cache.r7g.xlarge, cache.r7g.2xlarge, cache.r7g.4xlarge, cache.r7g.8xlarge, cache.r7g.12xlarge, cache.r7g.16xlarge

          For region availability, see Supported Node Types

          R6g node types (available only for Redis engine version 5.0.6 onward and for Memcached engine version 1.5.16 onward): cache.r6g.large, cache.r6g.xlarge, cache.r6g.2xlarge, cache.r6g.4xlarge, cache.r6g.8xlarge, cache.r6g.12xlarge, cache.r6g.16xlarge

          R5 node types: cache.r5.large, cache.r5.xlarge, cache.r5.2xlarge, cache.r5.4xlarge, cache.r5.12xlarge, cache.r5.24xlarge

          R4 node types: cache.r4.large, cache.r4.xlarge, cache.r4.2xlarge, cache.r4.4xlarge, cache.r4.8xlarge, cache.r4.16xlarge

        • Previous generation: (not recommended. Existing clusters are still supported but creation of new clusters is not supported for these types.)

          M2 node types: cache.m2.xlarge, cache.m2.2xlarge, cache.m2.4xlarge

          R3 node types: cache.r3.large, cache.r3.xlarge, cache.r3.2xlarge, cache.r3.4xlarge, cache.r3.8xlarge

      Additional node type info

      • All current generation instance types are created in Amazon VPC by default.

      • Redis append-only files (AOF) are not supported for T1 or T2 instances.

      • Redis Multi-AZ with automatic failover is not supported on T1 instances.

      • Redis configuration variables appendonly and appendfsync are not supported on Redis version 2.8.22 and later.

    • duration

      public final String duration()

      Duration filter value, specified in years or seconds. Use this parameter to show only reservations for a given duration.

      Valid Values: 1 | 3 | 31536000 | 94608000

      Returns:
      Duration filter value, specified in years or seconds. Use this parameter to show only reservations for a given duration.

      Valid Values: 1 | 3 | 31536000 | 94608000

    • productDescription

      public final String productDescription()

      The product description filter value. Use this parameter to show only the available offerings matching the specified product description.

      Returns:
      The product description filter value. Use this parameter to show only the available offerings matching the specified product description.

    • offeringType

      public final String offeringType()

      The offering type filter value. Use this parameter to show only the available offerings matching the specified offering type.

      Valid Values: "Light Utilization"|"Medium Utilization"|"Heavy Utilization" |"All Upfront"|"Partial Upfront"| "No Upfront"

      Returns:
      The offering type filter value. Use this parameter to show only the available offerings matching the specified offering type.

      Valid Values: "Light Utilization"|"Medium Utilization"|"Heavy Utilization" |"All Upfront"|"Partial Upfront"| "No Upfront"

    • maxRecords

      public final Integer maxRecords()

      The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a marker is included in the response so that the remaining results can be retrieved.

      Default: 100

      Constraints: minimum 20; maximum 100.

      Returns:
      The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a marker is included in the response so that the remaining results can be retrieved.

      Default: 100

      Constraints: minimum 20; maximum 100.

    • marker

      public final String marker()

      An optional marker returned from a prior request. Use this marker for pagination of results from this operation. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

      Returns:
      An optional marker returned from a prior request. Use this marker for pagination of results from this operation. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

    • toBuilder

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

    • builder

      public static DescribeReservedCacheNodesOfferingsRequest.Builder builder()

    • serializableBuilderClass

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