Class: Aws::ElastiCache::Types::DescribeReservedCacheNodesOfferingsMessage

Inherits:
Struct
  • Object
show all
Includes:
Structure
Defined in:
lib/aws-sdk-elasticache/types.rb

Overview

Note:

When making an API call, you may pass DescribeReservedCacheNodesOfferingsMessage data as a hash:

{
  reserved_cache_nodes_offering_id: "String",
  cache_node_type: "String",
  duration: "String",
  product_description: "String",
  offering_type: "String",
  max_records: 1,
  marker: "String",
}

Represents the input of a ‘DescribeReservedCacheNodesOfferings` operation.

Instance Attribute Summary collapse

Instance Attribute Details

#cache_node_typeString

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:

      **T2 node types:** ‘cache.t2.micro`, `cache.t2.small`, `cache.t2.medium`

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

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

    • Previous generation: (not recommended)

      **T1 node types:** ‘cache.t1.micro`

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

  • Compute optimized:

    • Previous generation: (not recommended)

      **C1 node types:** ‘cache.c1.xlarge`

  • Memory optimized:

    • Current generation:

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

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

      **M2 node types:** ‘cache.m2.xlarge`, `cache.m2.2xlarge`, `cache.m2.4xlarge`

Notes:

  • All T2 instances are created in an Amazon Virtual Private Cloud (Amazon VPC).

  • Redis (cluster mode disabled): Redis backup/restore is not supported on T1 and T2 instances.

  • Redis (cluster mode enabled): Backup/restore is not supported on T1 instances.

  • Redis Append-only files (AOF) functionality is not supported for T1 or T2 instances.

For a complete listing of node types and specifications, see:

  • Amazon ElastiCache Product Features and Details][1
  • Cache Node Type-Specific Parameters for Memcached][2
  • Cache Node Type-Specific Parameters for Redis][3

[1]: aws.amazon.com/elasticache/details [2]: docs.aws.amazon.com/AmazonElastiCache/latest/mem-ug/ParameterGroups.Memcached.html#ParameterGroups.Memcached.NodeSpecific [3]: docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/ParameterGroups.Redis.html#ParameterGroups.Redis.NodeSpecific

Returns:

  • (String)


3271
3272
3273
3274
3275
3276
3277
3278
3279
3280
# File 'lib/aws-sdk-elasticache/types.rb', line 3271

class DescribeReservedCacheNodesOfferingsMessage < Struct.new(
  :reserved_cache_nodes_offering_id,
  :cache_node_type,
  :duration,
  :product_description,
  :offering_type,
  :max_records,
  :marker)
  include Aws::Structure
end

#durationString

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:

  • (String)


3271
3272
3273
3274
3275
3276
3277
3278
3279
3280
# File 'lib/aws-sdk-elasticache/types.rb', line 3271

class DescribeReservedCacheNodesOfferingsMessage < Struct.new(
  :reserved_cache_nodes_offering_id,
  :cache_node_type,
  :duration,
  :product_description,
  :offering_type,
  :max_records,
  :marker)
  include Aws::Structure
end

#markerString

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:

  • (String)


3271
3272
3273
3274
3275
3276
3277
3278
3279
3280
# File 'lib/aws-sdk-elasticache/types.rb', line 3271

class DescribeReservedCacheNodesOfferingsMessage < Struct.new(
  :reserved_cache_nodes_offering_id,
  :cache_node_type,
  :duration,
  :product_description,
  :offering_type,
  :max_records,
  :marker)
  include Aws::Structure
end

#max_recordsInteger

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:

  • (Integer)


3271
3272
3273
3274
3275
3276
3277
3278
3279
3280
# File 'lib/aws-sdk-elasticache/types.rb', line 3271

class DescribeReservedCacheNodesOfferingsMessage < Struct.new(
  :reserved_cache_nodes_offering_id,
  :cache_node_type,
  :duration,
  :product_description,
  :offering_type,
  :max_records,
  :marker)
  include Aws::Structure
end

#offering_typeString

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”`

Returns:

  • (String)


3271
3272
3273
3274
3275
3276
3277
3278
3279
3280
# File 'lib/aws-sdk-elasticache/types.rb', line 3271

class DescribeReservedCacheNodesOfferingsMessage < Struct.new(
  :reserved_cache_nodes_offering_id,
  :cache_node_type,
  :duration,
  :product_description,
  :offering_type,
  :max_records,
  :marker)
  include Aws::Structure
end

#product_descriptionString

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

Returns:

  • (String)


3271
3272
3273
3274
3275
3276
3277
3278
3279
3280
# File 'lib/aws-sdk-elasticache/types.rb', line 3271

class DescribeReservedCacheNodesOfferingsMessage < Struct.new(
  :reserved_cache_nodes_offering_id,
  :cache_node_type,
  :duration,
  :product_description,
  :offering_type,
  :max_records,
  :marker)
  include Aws::Structure
end

#reserved_cache_nodes_offering_idString

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:

  • (String)


3271
3272
3273
3274
3275
3276
3277
3278
3279
3280
# File 'lib/aws-sdk-elasticache/types.rb', line 3271

class DescribeReservedCacheNodesOfferingsMessage < Struct.new(
  :reserved_cache_nodes_offering_id,
  :cache_node_type,
  :duration,
  :product_description,
  :offering_type,
  :max_records,
  :marker)
  include Aws::Structure
end