Table Of Contents

Feedback

User Guide

First time using the AWS CLI? See the User Guide for help getting started.

[ aws . elasticache ]

describe-reserved-cache-nodes-offerings

Description

Lists available reserved cache node offerings.

See also: AWS API Documentation

See 'aws help' for descriptions of global parameters.

describe-reserved-cache-nodes-offerings is a paginated operation. Multiple API calls may be issued in order to retrieve the entire data set of results. You can disable pagination by providing the --no-paginate argument. When using --output text and the --query argument on a paginated response, the --query argument must extract data from the results of the following query expressions: ReservedCacheNodesOfferings

Synopsis

  describe-reserved-cache-nodes-offerings
[--reserved-cache-nodes-offering-id <value>]
[--cache-node-type <value>]
[--duration <value>]
[--product-description <value>]
[--offering-type <value>]
[--cli-input-json <value>]
[--starting-token <value>]
[--page-size <value>]
[--max-items <value>]
[--generate-cli-skeleton <value>]

Options

--reserved-cache-nodes-offering-id (string)

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

--cache-node-type (string)

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:

--duration (string)

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

--product-description (string)

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

--offering-type (string)

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"

--cli-input-json (string) Performs service operation based on the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, the CLI values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally.

--starting-token (string)

A token to specify where to start paginating. This is the NextToken from a previously truncated response.

For usage examples, see Pagination in the AWS Command Line Interface User Guide .

--page-size (integer)

The size of each page to get in the AWS service call. This does not affect the number of items returned in the command's output. Setting a smaller page size results in more calls to the AWS service, retrieving fewer items in each call. This can help prevent the AWS service calls from timing out.

For usage examples, see Pagination in the AWS Command Line Interface User Guide .

--max-items (integer)

The total number of items to return in the command's output. If the total number of items available is more than the value specified, a NextToken is provided in the command's output. To resume pagination, provide the NextToken value in the starting-token argument of a subsequent command. Do not use the NextToken response element directly outside of the AWS CLI.

For usage examples, see Pagination in the AWS Command Line Interface User Guide .

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

See 'aws help' for descriptions of global parameters.

Output

Marker -> (string)

Provides an identifier to allow retrieval of paginated results.

ReservedCacheNodesOfferings -> (list)

A list of reserved cache node offerings. Each element in the list contains detailed information about one offering.

(structure)

Describes all of the attributes of a reserved cache node offering.

ReservedCacheNodesOfferingId -> (string)

A unique identifier for the reserved cache node offering.

CacheNodeType -> (string)

The cache node type for the reserved cache node.

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:

Duration -> (integer)

The duration of the offering. in seconds.

FixedPrice -> (double)

The fixed price charged for this offering.

UsagePrice -> (double)

The hourly price charged for this offering.

ProductDescription -> (string)

The cache engine used by the offering.

OfferingType -> (string)

The offering type.

RecurringCharges -> (list)

The recurring price charged to run this reserved cache node.

(structure)

Contains the specific price and frequency of a recurring charges for a reserved cache node, or for a reserved cache node offering.

RecurringChargeAmount -> (double)

The monetary amount of the recurring charge.

RecurringChargeFrequency -> (string)

The frequency of the recurring charge.