You are viewing documentation for version 3 of the AWS SDK for Ruby. Version 2 documentation can be found here.

Class: Aws::ElastiCache::Types::DescribeReservedCacheNodesMessage

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

Overview

Note:

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

{
  reserved_cache_node_id: "String",
  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 DescribeReservedCacheNodes operation.

Instance Attribute Summary collapse

Instance Attribute Details

#cache_node_typeString

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

Valid node types are as follows:

  • General purpose:

    • Current generation: cache.t2.micro, cache.t2.small, cache.t2.medium, cache.m3.medium, cache.m3.large, cache.m3.xlarge, cache.m3.2xlarge, cache.m4.large, cache.m4.xlarge, cache.m4.2xlarge, cache.m4.4xlarge, cache.m4.10xlarge

    • Previous generation: cache.t1.micro, cache.m1.small, cache.m1.medium, cache.m1.large, cache.m1.xlarge

  • Compute optimized: cache.c1.xlarge

  • Memory optimized:

    • Current generation: cache.r3.large, cache.r3.xlarge, cache.r3.2xlarge, cache.r3.4xlarge, cache.r3.8xlarge

    • Previous generation: cache.m2.xlarge, cache.m2.2xlarge, cache.m2.4xlarge

Notes:

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

  • Redis backup/restore is not supported for Redis (cluster mode disabled) T1 and T2 instances. Backup/restore is supported on Redis (cluster mode enabled) T2 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 and either Cache Node Type-Specific Parameters for Memcached or Cache Node Type-Specific Parameters for Redis.

Returns:

  • (String)


2761
2762
2763
2764
2765
2766
2767
2768
2769
2770
2771
# File 'gems/aws-sdk-elasticache/lib/aws-sdk-elasticache/types.rb', line 2761

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

#durationString

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

Valid Values: 1 | 3 | 31536000 | 94608000

Returns:

  • (String)


2761
2762
2763
2764
2765
2766
2767
2768
2769
2770
2771
# File 'gems/aws-sdk-elasticache/lib/aws-sdk-elasticache/types.rb', line 2761

class DescribeReservedCacheNodesMessage < Struct.new(
  :reserved_cache_node_id,
  :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)


2761
2762
2763
2764
2765
2766
2767
2768
2769
2770
2771
# File 'gems/aws-sdk-elasticache/lib/aws-sdk-elasticache/types.rb', line 2761

class DescribeReservedCacheNodesMessage < Struct.new(
  :reserved_cache_node_id,
  :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)


2761
2762
2763
2764
2765
2766
2767
2768
2769
2770
2771
# File 'gems/aws-sdk-elasticache/lib/aws-sdk-elasticache/types.rb', line 2761

class DescribeReservedCacheNodesMessage < Struct.new(
  :reserved_cache_node_id,
  :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)


2761
2762
2763
2764
2765
2766
2767
2768
2769
2770
2771
# File 'gems/aws-sdk-elasticache/lib/aws-sdk-elasticache/types.rb', line 2761

class DescribeReservedCacheNodesMessage < Struct.new(
  :reserved_cache_node_id,
  :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 those reservations matching the specified product description.

Returns:

  • (String)


2761
2762
2763
2764
2765
2766
2767
2768
2769
2770
2771
# File 'gems/aws-sdk-elasticache/lib/aws-sdk-elasticache/types.rb', line 2761

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

#reserved_cache_node_idString

The reserved cache node identifier filter value. Use this parameter to show only the reservation that matches the specified reservation ID.

Returns:

  • (String)


2761
2762
2763
2764
2765
2766
2767
2768
2769
2770
2771
# File 'gems/aws-sdk-elasticache/lib/aws-sdk-elasticache/types.rb', line 2761

class DescribeReservedCacheNodesMessage < Struct.new(
  :reserved_cache_node_id,
  :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 purchased reservations matching the specified offering identifier.

Returns:

  • (String)


2761
2762
2763
2764
2765
2766
2767
2768
2769
2770
2771
# File 'gems/aws-sdk-elasticache/lib/aws-sdk-elasticache/types.rb', line 2761

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