Copyright	(c) 2013-2021 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay <brendan.g.hay+amazonka@gmail.com>
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	None

Amazonka.ElastiCache.DescribeReservedCacheNodes

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Returns information about reserved cache nodes for this account, or about a specified reserved cache node.

This operation returns paginated results.

Synopsis

Creating a Request

data DescribeReservedCacheNodes Source #

Represents the input of a DescribeReservedCacheNodes operation.

See: newDescribeReservedCacheNodes smart constructor.

Constructors

DescribeReservedCacheNodes'

Fields

cacheNodeType :: Maybe Text
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
    For region availability, see Supported Node Types
    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
    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)
    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)
    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
    For region availability, see Supported Node Types
    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)
    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.
productDescription :: Maybe Text
The product description filter value. Use this parameter to show only those reservations matching the specified product description.
marker :: Maybe Text
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.
maxRecords :: Maybe Int
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.
reservedCacheNodeId :: Maybe Text
The reserved cache node identifier filter value. Use this parameter to show only the reservation that matches the specified reservation ID.
offeringType :: Maybe Text
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"
duration :: Maybe Text
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
reservedCacheNodesOfferingId :: Maybe Text
The offering identifier filter value. Use this parameter to show only purchased reservations matching the specified offering identifier.

Instances

Instances details

Eq DescribeReservedCacheNodes Source #
Instance details Defined in Amazonka.ElastiCache.DescribeReservedCacheNodes Methods (==) :: DescribeReservedCacheNodes -> DescribeReservedCacheNodes -> Bool # (/=) :: DescribeReservedCacheNodes -> DescribeReservedCacheNodes -> Bool #
Read DescribeReservedCacheNodes Source #
Instance details Defined in Amazonka.ElastiCache.DescribeReservedCacheNodes Methods readsPrec :: Int -> ReadS DescribeReservedCacheNodes # readList :: ReadS [DescribeReservedCacheNodes] # readPrec :: ReadPrec DescribeReservedCacheNodes # readListPrec :: ReadPrec [DescribeReservedCacheNodes] #
Show DescribeReservedCacheNodes Source #
Instance details Defined in Amazonka.ElastiCache.DescribeReservedCacheNodes Methods showsPrec :: Int -> DescribeReservedCacheNodes -> ShowS # show :: DescribeReservedCacheNodes -> String # showList :: [DescribeReservedCacheNodes] -> ShowS #
Generic DescribeReservedCacheNodes Source #
Instance details Defined in Amazonka.ElastiCache.DescribeReservedCacheNodes Associated Types type Rep DescribeReservedCacheNodes :: Type -> Type # Methods from :: DescribeReservedCacheNodes -> Rep DescribeReservedCacheNodes x # to :: Rep DescribeReservedCacheNodes x -> DescribeReservedCacheNodes #
NFData DescribeReservedCacheNodes Source #
Instance details Defined in Amazonka.ElastiCache.DescribeReservedCacheNodes Methods rnf :: DescribeReservedCacheNodes -> () #
Hashable DescribeReservedCacheNodes Source #
Instance details Defined in Amazonka.ElastiCache.DescribeReservedCacheNodes Methods hashWithSalt :: Int -> DescribeReservedCacheNodes -> Int # hash :: DescribeReservedCacheNodes -> Int #
AWSPager DescribeReservedCacheNodes Source #
Instance details Defined in Amazonka.ElastiCache.DescribeReservedCacheNodes Methods page :: DescribeReservedCacheNodes -> AWSResponse DescribeReservedCacheNodes -> Maybe DescribeReservedCacheNodes #
AWSRequest DescribeReservedCacheNodes Source #
Instance details Defined in Amazonka.ElastiCache.DescribeReservedCacheNodes Associated Types type AWSResponse DescribeReservedCacheNodes # Methods request :: DescribeReservedCacheNodes -> Request DescribeReservedCacheNodes # response :: MonadResource m => Logger -> Service -> Proxy DescribeReservedCacheNodes -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse DescribeReservedCacheNodes))) #
ToHeaders DescribeReservedCacheNodes Source #
Instance details Defined in Amazonka.ElastiCache.DescribeReservedCacheNodes Methods toHeaders :: DescribeReservedCacheNodes -> [Header] #
ToPath DescribeReservedCacheNodes Source #
Instance details Defined in Amazonka.ElastiCache.DescribeReservedCacheNodes Methods toPath :: DescribeReservedCacheNodes -> ByteString #
ToQuery DescribeReservedCacheNodes Source #
Instance details Defined in Amazonka.ElastiCache.DescribeReservedCacheNodes Methods toQuery :: DescribeReservedCacheNodes -> QueryString #
type Rep DescribeReservedCacheNodes Source #
Instance details Defined in Amazonka.ElastiCache.DescribeReservedCacheNodes type Rep DescribeReservedCacheNodes = D1 ('MetaData "DescribeReservedCacheNodes" "Amazonka.ElastiCache.DescribeReservedCacheNodes" "libZSservicesZSamazonka-elasticacheZSamazonka-elasticache" 'False) (C1 ('MetaCons "DescribeReservedCacheNodes'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "cacheNodeType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "productDescription") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "marker") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "maxRecords") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)))) :: ((S1 ('MetaSel ('Just "reservedCacheNodeId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "offeringType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "duration") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "reservedCacheNodesOfferingId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))))
type AWSResponse DescribeReservedCacheNodes Source #
Instance details Defined in Amazonka.ElastiCache.DescribeReservedCacheNodes type AWSResponse DescribeReservedCacheNodes = DescribeReservedCacheNodesResponse

newDescribeReservedCacheNodes :: DescribeReservedCacheNodes Source #

Create a value of DescribeReservedCacheNodes with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:cacheNodeType:DescribeReservedCacheNodes', describeReservedCacheNodes_cacheNodeType - 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
  For region availability, see Supported Node Types
  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
  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)
  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)
  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
  For region availability, see Supported Node Types
  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)
  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.

$sel:productDescription:DescribeReservedCacheNodes', describeReservedCacheNodes_productDescription - The product description filter value. Use this parameter to show only those reservations matching the specified product description.

$sel:marker:DescribeReservedCacheNodes', describeReservedCacheNodes_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.

$sel:maxRecords:DescribeReservedCacheNodes', describeReservedCacheNodes_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.

$sel:reservedCacheNodeId:DescribeReservedCacheNodes', describeReservedCacheNodes_reservedCacheNodeId - The reserved cache node identifier filter value. Use this parameter to show only the reservation that matches the specified reservation ID.

$sel:offeringType:DescribeReservedCacheNodes', describeReservedCacheNodes_offeringType - The offering type filter value. Use this parameter to show only the available offerings matching the specified offering type.

$sel:duration:DescribeReservedCacheNodes', describeReservedCacheNodes_duration - 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

$sel:reservedCacheNodesOfferingId:DescribeReservedCacheNodes', describeReservedCacheNodes_reservedCacheNodesOfferingId - The offering identifier filter value. Use this parameter to show only purchased reservations matching the specified offering identifier.

Request Lenses

describeReservedCacheNodes_cacheNodeType :: Lens' DescribeReservedCacheNodes (Maybe Text) Source #

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
  For region availability, see Supported Node Types
  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
  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)
  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)
  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
  For region availability, see Supported Node Types
  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)
  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.

describeReservedCacheNodes_productDescription :: Lens' DescribeReservedCacheNodes (Maybe Text) Source #

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

describeReservedCacheNodes_marker :: Lens' DescribeReservedCacheNodes (Maybe Text) Source #

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.

describeReservedCacheNodes_maxRecords :: Lens' DescribeReservedCacheNodes (Maybe Int) Source #

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.

describeReservedCacheNodes_reservedCacheNodeId :: Lens' DescribeReservedCacheNodes (Maybe Text) Source #

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

describeReservedCacheNodes_offeringType :: Lens' DescribeReservedCacheNodes (Maybe Text) Source #

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

describeReservedCacheNodes_duration :: Lens' DescribeReservedCacheNodes (Maybe Text) Source #

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

describeReservedCacheNodes_reservedCacheNodesOfferingId :: Lens' DescribeReservedCacheNodes (Maybe Text) Source #

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

Destructuring the Response

data DescribeReservedCacheNodesResponse Source #

Represents the output of a DescribeReservedCacheNodes operation.

See: newDescribeReservedCacheNodesResponse smart constructor.

Constructors

DescribeReservedCacheNodesResponse'
Fields marker :: Maybe Text Provides an identifier to allow retrieval of paginated results. reservedCacheNodes :: Maybe [ReservedCacheNode] A list of reserved cache nodes. Each element in the list contains detailed information about one node. httpStatus :: Int The response's http status code.

Instances

Instances details

Eq DescribeReservedCacheNodesResponse Source #
Instance details Defined in Amazonka.ElastiCache.DescribeReservedCacheNodes Methods (==) :: DescribeReservedCacheNodesResponse -> DescribeReservedCacheNodesResponse -> Bool # (/=) :: DescribeReservedCacheNodesResponse -> DescribeReservedCacheNodesResponse -> Bool #
Read DescribeReservedCacheNodesResponse Source #
Instance details Defined in Amazonka.ElastiCache.DescribeReservedCacheNodes Methods readsPrec :: Int -> ReadS DescribeReservedCacheNodesResponse # readList :: ReadS [DescribeReservedCacheNodesResponse] # readPrec :: ReadPrec DescribeReservedCacheNodesResponse # readListPrec :: ReadPrec [DescribeReservedCacheNodesResponse] #
Show DescribeReservedCacheNodesResponse Source #
Instance details Defined in Amazonka.ElastiCache.DescribeReservedCacheNodes Methods showsPrec :: Int -> DescribeReservedCacheNodesResponse -> ShowS # show :: DescribeReservedCacheNodesResponse -> String # showList :: [DescribeReservedCacheNodesResponse] -> ShowS #
Generic DescribeReservedCacheNodesResponse Source #
Instance details Defined in Amazonka.ElastiCache.DescribeReservedCacheNodes Associated Types type Rep DescribeReservedCacheNodesResponse :: Type -> Type # Methods from :: DescribeReservedCacheNodesResponse -> Rep DescribeReservedCacheNodesResponse x # to :: Rep DescribeReservedCacheNodesResponse x -> DescribeReservedCacheNodesResponse #
NFData DescribeReservedCacheNodesResponse Source #
Instance details Defined in Amazonka.ElastiCache.DescribeReservedCacheNodes Methods rnf :: DescribeReservedCacheNodesResponse -> () #
type Rep DescribeReservedCacheNodesResponse Source #
Instance details Defined in Amazonka.ElastiCache.DescribeReservedCacheNodes type Rep DescribeReservedCacheNodesResponse = D1 ('MetaData "DescribeReservedCacheNodesResponse" "Amazonka.ElastiCache.DescribeReservedCacheNodes" "libZSservicesZSamazonka-elasticacheZSamazonka-elasticache" 'False) (C1 ('MetaCons "DescribeReservedCacheNodesResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "marker") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "reservedCacheNodes") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [ReservedCacheNode])) :: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newDescribeReservedCacheNodesResponse Source #

Arguments

:: Int	`$sel:httpStatus:DescribeReservedCacheNodesResponse'`
-> DescribeReservedCacheNodesResponse

Create a value of DescribeReservedCacheNodesResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:marker:DescribeReservedCacheNodes', describeReservedCacheNodesResponse_marker - Provides an identifier to allow retrieval of paginated results.

$sel:reservedCacheNodes:DescribeReservedCacheNodesResponse', describeReservedCacheNodesResponse_reservedCacheNodes - A list of reserved cache nodes. Each element in the list contains detailed information about one node.

$sel:httpStatus:DescribeReservedCacheNodesResponse', describeReservedCacheNodesResponse_httpStatus - The response's http status code.

Response Lenses

describeReservedCacheNodesResponse_marker :: Lens' DescribeReservedCacheNodesResponse (Maybe Text) Source #

Provides an identifier to allow retrieval of paginated results.

describeReservedCacheNodesResponse_reservedCacheNodes :: Lens' DescribeReservedCacheNodesResponse (Maybe [ReservedCacheNode]) Source #

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

describeReservedCacheNodesResponse_httpStatus :: Lens' DescribeReservedCacheNodesResponse Int Source #

The response's http status code.