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

Inherits:

Struct

Object
Struct
Aws::ElastiCache::Types::DescribeReservedCacheNodesMessage

show all

Includes:: Structure

Defined in:: 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.

Constant Summary collapse

SENSITIVE =

[]

Instance Attribute Summary collapse

#cache_node_type ⇒ String

The cache node type filter value.
#duration ⇒ String

The duration filter value, specified in years or seconds.
#marker ⇒ String

An optional marker returned from a prior request.
#max_records ⇒ Integer

The maximum number of records to include in the response.
#offering_type ⇒ String

The offering type filter value.
#product_description ⇒ String

The product description filter value.
#reserved_cache_node_id ⇒ String

The reserved cache node identifier filter value.
#reserved_cache_nodes_offering_id ⇒ String

The offering identifier filter value.

Instance Attribute Details

#cache_node_type ⇒ `String`

The cache node type filter value. Use this parameter to show only those reservations 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:
  
  **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
  
  <note markdown=“1”> For region availability, see [Supported Node Types]
```
</note>
```
  **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:
  
  **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
  
  <note markdown=“1”> For region availability, see [Supported Node Types]
```
</note>
```
  **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.

[1]: docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/CacheNodes.SupportedTypes.html#CacheNodes.SupportedTypesByRegion

Returns:

(String)

# File 'lib/aws-sdk-elasticache/types.rb', line 4451

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

#duration ⇒ `String`

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)

# File 'lib/aws-sdk-elasticache/types.rb', line 4451

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

#marker ⇒ `String`

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)

# File 'lib/aws-sdk-elasticache/types.rb', line 4451

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

#max_records ⇒ `Integer`

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)

# File 'lib/aws-sdk-elasticache/types.rb', line 4451

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

#offering_type ⇒ `String`

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

Returns:

(String)

# File 'lib/aws-sdk-elasticache/types.rb', line 4451

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

#product_description ⇒ `String`

The product description filter value. Use this parameter to show only those reservations matching the specified product description.

Returns:

(String)

# File 'lib/aws-sdk-elasticache/types.rb', line 4451

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

#reserved_cache_node_id ⇒ `String`

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

Returns:

(String)

# File 'lib/aws-sdk-elasticache/types.rb', line 4451

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

#reserved_cache_nodes_offering_id ⇒ `String`

The offering identifier filter value. Use this parameter to show only purchased reservations matching the specified offering identifier.

Returns:

(String)

# File 'lib/aws-sdk-elasticache/types.rb', line 4451

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

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

Overview

Constant Summary collapse

Instance Attribute Summary collapse

Instance Attribute Details

#cache_node_type ⇒ String

#duration ⇒ String

#marker ⇒ String

#max_records ⇒ Integer

#offering_type ⇒ String

#product_description ⇒ String

#reserved_cache_node_id ⇒ String

#reserved_cache_nodes_offering_id ⇒ String

#cache_node_type ⇒ `String`

#duration ⇒ `String`

#marker ⇒ `String`

#max_records ⇒ `Integer`

#offering_type ⇒ `String`

#product_description ⇒ `String`

#reserved_cache_node_id ⇒ `String`

#reserved_cache_nodes_offering_id ⇒ `String`