amazonka-elasticache-1.6.0: Amazon ElastiCache SDK.

Copyright(c) 2013-2018 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay+amazonka@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone
LanguageHaskell2010

Network.AWS.ElastiCache.DescribeReservedCacheNodes

Contents

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

describeReservedCacheNodes :: DescribeReservedCacheNodes Source #

Creates a value of DescribeReservedCacheNodes with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

  • drcnCacheNodeType - 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: 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 * 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 backuprestore is not supported on T1 and T2 instances. * Redis (cluster mode enabled): Backuprestore 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 and either Cache Node Type-Specific Parameters for Memcached or Cache Node Type-Specific Parameters for Redis .
  • drcnProductDescription - The product description filter value. Use this parameter to show only those reservations matching the specified product description.
  • drcnMarker - 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 .
  • drcnMaxRecords - 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.
  • drcnReservedCacheNodeId - The reserved cache node identifier filter value. Use this parameter to show only the reservation that matches the specified reservation ID.
  • drcnOfferingType - 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"
  • drcnDuration - 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
  • drcnReservedCacheNodesOfferingId - The offering identifier filter value. Use this parameter to show only purchased reservations matching the specified offering identifier.

data DescribeReservedCacheNodes Source #

Represents the input of a DescribeReservedCacheNodes operation.

See: describeReservedCacheNodes smart constructor.

Instances

Eq DescribeReservedCacheNodes Source # 
Data DescribeReservedCacheNodes Source # 

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> DescribeReservedCacheNodes -> c DescribeReservedCacheNodes #

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c DescribeReservedCacheNodes #

toConstr :: DescribeReservedCacheNodes -> Constr #

dataTypeOf :: DescribeReservedCacheNodes -> DataType #

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c DescribeReservedCacheNodes) #

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c DescribeReservedCacheNodes) #

gmapT :: (forall b. Data b => b -> b) -> DescribeReservedCacheNodes -> DescribeReservedCacheNodes #

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> DescribeReservedCacheNodes -> r #

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> DescribeReservedCacheNodes -> r #

gmapQ :: (forall d. Data d => d -> u) -> DescribeReservedCacheNodes -> [u] #

gmapQi :: Int -> (forall d. Data d => d -> u) -> DescribeReservedCacheNodes -> u #

gmapM :: Monad m => (forall d. Data d => d -> m d) -> DescribeReservedCacheNodes -> m DescribeReservedCacheNodes #

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> DescribeReservedCacheNodes -> m DescribeReservedCacheNodes #

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> DescribeReservedCacheNodes -> m DescribeReservedCacheNodes #

Read DescribeReservedCacheNodes Source # 
Show DescribeReservedCacheNodes Source # 
Generic DescribeReservedCacheNodes Source # 
Hashable DescribeReservedCacheNodes Source # 
NFData DescribeReservedCacheNodes Source # 
AWSPager DescribeReservedCacheNodes Source # 
AWSRequest DescribeReservedCacheNodes Source # 
ToHeaders DescribeReservedCacheNodes Source # 
ToPath DescribeReservedCacheNodes Source # 
ToQuery DescribeReservedCacheNodes Source # 
type Rep DescribeReservedCacheNodes Source # 
type Rep DescribeReservedCacheNodes = D1 * (MetaData "DescribeReservedCacheNodes" "Network.AWS.ElastiCache.DescribeReservedCacheNodes" "amazonka-elasticache-1.6.0-4uuZWL7zhxxEXFvtkJRku9" False) (C1 * (MetaCons "DescribeReservedCacheNodes'" PrefixI True) ((:*:) * ((:*:) * ((:*:) * (S1 * (MetaSel (Just Symbol "_drcnCacheNodeType") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text))) (S1 * (MetaSel (Just Symbol "_drcnProductDescription") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text)))) ((:*:) * (S1 * (MetaSel (Just Symbol "_drcnMarker") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text))) (S1 * (MetaSel (Just Symbol "_drcnMaxRecords") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Int))))) ((:*:) * ((:*:) * (S1 * (MetaSel (Just Symbol "_drcnReservedCacheNodeId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text))) (S1 * (MetaSel (Just Symbol "_drcnOfferingType") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text)))) ((:*:) * (S1 * (MetaSel (Just Symbol "_drcnDuration") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text))) (S1 * (MetaSel (Just Symbol "_drcnReservedCacheNodesOfferingId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text)))))))
type Rs DescribeReservedCacheNodes Source # 

Request Lenses

drcnCacheNodeType :: 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: 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 * 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 backuprestore is not supported on T1 and T2 instances. * Redis (cluster mode enabled): Backuprestore 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 and either Cache Node Type-Specific Parameters for Memcached or Cache Node Type-Specific Parameters for Redis .

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

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

drcnMarker :: 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 .

drcnMaxRecords :: 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.

drcnReservedCacheNodeId :: 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.

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

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"

drcnDuration :: 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

drcnReservedCacheNodesOfferingId :: 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

describeReservedCacheNodesResponse Source #

Creates a value of DescribeReservedCacheNodesResponse with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

data DescribeReservedCacheNodesResponse Source #

Represents the output of a DescribeReservedCacheNodes operation.

See: describeReservedCacheNodesResponse smart constructor.

Instances

Eq DescribeReservedCacheNodesResponse Source # 
Data DescribeReservedCacheNodesResponse Source # 

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> DescribeReservedCacheNodesResponse -> c DescribeReservedCacheNodesResponse #

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c DescribeReservedCacheNodesResponse #

toConstr :: DescribeReservedCacheNodesResponse -> Constr #

dataTypeOf :: DescribeReservedCacheNodesResponse -> DataType #

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c DescribeReservedCacheNodesResponse) #

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c DescribeReservedCacheNodesResponse) #

gmapT :: (forall b. Data b => b -> b) -> DescribeReservedCacheNodesResponse -> DescribeReservedCacheNodesResponse #

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> DescribeReservedCacheNodesResponse -> r #

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> DescribeReservedCacheNodesResponse -> r #

gmapQ :: (forall d. Data d => d -> u) -> DescribeReservedCacheNodesResponse -> [u] #

gmapQi :: Int -> (forall d. Data d => d -> u) -> DescribeReservedCacheNodesResponse -> u #

gmapM :: Monad m => (forall d. Data d => d -> m d) -> DescribeReservedCacheNodesResponse -> m DescribeReservedCacheNodesResponse #

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> DescribeReservedCacheNodesResponse -> m DescribeReservedCacheNodesResponse #

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> DescribeReservedCacheNodesResponse -> m DescribeReservedCacheNodesResponse #

Read DescribeReservedCacheNodesResponse Source # 
Show DescribeReservedCacheNodesResponse Source # 
Generic DescribeReservedCacheNodesResponse Source # 
NFData DescribeReservedCacheNodesResponse Source # 
type Rep DescribeReservedCacheNodesResponse Source # 
type Rep DescribeReservedCacheNodesResponse = D1 * (MetaData "DescribeReservedCacheNodesResponse" "Network.AWS.ElastiCache.DescribeReservedCacheNodes" "amazonka-elasticache-1.6.0-4uuZWL7zhxxEXFvtkJRku9" False) (C1 * (MetaCons "DescribeReservedCacheNodesResponse'" PrefixI True) ((:*:) * (S1 * (MetaSel (Just Symbol "_drcnrsMarker") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text))) ((:*:) * (S1 * (MetaSel (Just Symbol "_drcnrsReservedCacheNodes") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe [ReservedCacheNode]))) (S1 * (MetaSel (Just Symbol "_drcnrsResponseStatus") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * Int)))))

Response Lenses

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

Provides an identifier to allow retrieval of paginated results.

drcnrsReservedCacheNodes :: Lens' DescribeReservedCacheNodesResponse [ReservedCacheNode] Source #

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