amazonka-elasticache-1.4.5: Amazon ElastiCache SDK.

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

Network.AWS.ElastiCache.DescribeCacheClusters

Contents

Description

Returns information about all provisioned cache clusters if no cache cluster identifier is specified, or about a specific cache cluster if a cache cluster identifier is supplied.

By default, abbreviated information about the cache clusters are returned. You can use the optional ShowDetails flag to retrieve detailed information about the cache nodes associated with the cache clusters. These details include the DNS address and port for the cache node endpoint.

If the cluster is in the CREATING state, only cluster-level information is displayed until all of the nodes are successfully provisioned.

If the cluster is in the DELETING state, only cluster-level information is displayed.

If cache nodes are currently being added to the cache cluster, node endpoint information and creation time for the additional nodes are not displayed until they are completely provisioned. When the cache cluster state is available , the cluster is ready for use.

If cache nodes are currently being removed from the cache cluster, no endpoint information for the removed nodes is displayed.

This operation returns paginated results.

Synopsis

Creating a Request

describeCacheClusters :: DescribeCacheClusters #

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

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

  • dCacheClusterId - The user-supplied cluster identifier. If this parameter is specified, only information about that specific cache cluster is returned. This parameter isn't case sensitive.
  • dMarker - 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 .
  • dMaxRecords - 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.
  • dShowCacheNodeInfo - An optional flag that can be included in the DescribeCacheCluster request to retrieve information about the individual cache nodes.

data DescribeCacheClusters #

Represents the input of a DescribeCacheClusters operation.

See: describeCacheClusters smart constructor.

Instances

Eq DescribeCacheClusters # 
Data DescribeCacheClusters # 

Methods

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

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

toConstr :: DescribeCacheClusters -> Constr #

dataTypeOf :: DescribeCacheClusters -> DataType #

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

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

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

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

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

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

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

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

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

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

Read DescribeCacheClusters # 
Show DescribeCacheClusters # 
Generic DescribeCacheClusters # 
Hashable DescribeCacheClusters # 
NFData DescribeCacheClusters # 

Methods

rnf :: DescribeCacheClusters -> () #

AWSPager DescribeCacheClusters # 
AWSRequest DescribeCacheClusters # 
ToQuery DescribeCacheClusters # 
ToPath DescribeCacheClusters # 
ToHeaders DescribeCacheClusters # 
type Rep DescribeCacheClusters # 
type Rep DescribeCacheClusters = D1 (MetaData "DescribeCacheClusters" "Network.AWS.ElastiCache.DescribeCacheClusters" "amazonka-elasticache-1.4.5-Ai9oTU2RTbj2M0sGqfSNp8" False) (C1 (MetaCons "DescribeCacheClusters'" PrefixI True) ((:*:) ((:*:) (S1 (MetaSel (Just Symbol "_dCacheClusterId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) (S1 (MetaSel (Just Symbol "_dMarker") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)))) ((:*:) (S1 (MetaSel (Just Symbol "_dMaxRecords") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Int))) (S1 (MetaSel (Just Symbol "_dShowCacheNodeInfo") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Bool))))))
type Rs DescribeCacheClusters # 

Request Lenses

dCacheClusterId :: Lens' DescribeCacheClusters (Maybe Text) #

The user-supplied cluster identifier. If this parameter is specified, only information about that specific cache cluster is returned. This parameter isn't case sensitive.

dMarker :: Lens' DescribeCacheClusters (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 .

dMaxRecords :: Lens' DescribeCacheClusters (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.

dShowCacheNodeInfo :: Lens' DescribeCacheClusters (Maybe Bool) #

An optional flag that can be included in the DescribeCacheCluster request to retrieve information about the individual cache nodes.

Destructuring the Response

describeCacheClustersResponse #

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

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

  • drsCacheClusters - A list of cache clusters. Each item in the list contains detailed information about one cache cluster.
  • drsMarker - Provides an identifier to allow retrieval of paginated results.
  • drsResponseStatus - -- | The response status code.

data DescribeCacheClustersResponse #

Represents the output of a DescribeCacheClusters operation.

See: describeCacheClustersResponse smart constructor.

Instances

Eq DescribeCacheClustersResponse # 
Data DescribeCacheClustersResponse # 

Methods

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

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

toConstr :: DescribeCacheClustersResponse -> Constr #

dataTypeOf :: DescribeCacheClustersResponse -> DataType #

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

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

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

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

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

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

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

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

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

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

Read DescribeCacheClustersResponse # 
Show DescribeCacheClustersResponse # 
Generic DescribeCacheClustersResponse # 
NFData DescribeCacheClustersResponse # 
type Rep DescribeCacheClustersResponse # 
type Rep DescribeCacheClustersResponse = D1 (MetaData "DescribeCacheClustersResponse" "Network.AWS.ElastiCache.DescribeCacheClusters" "amazonka-elasticache-1.4.5-Ai9oTU2RTbj2M0sGqfSNp8" False) (C1 (MetaCons "DescribeCacheClustersResponse'" PrefixI True) ((:*:) (S1 (MetaSel (Just Symbol "_drsCacheClusters") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe [CacheCluster]))) ((:*:) (S1 (MetaSel (Just Symbol "_drsMarker") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) (S1 (MetaSel (Just Symbol "_drsResponseStatus") NoSourceUnpackedness SourceStrict DecidedUnpack) (Rec0 Int)))))

Response Lenses

drsCacheClusters :: Lens' DescribeCacheClustersResponse [CacheCluster] #

A list of cache clusters. Each item in the list contains detailed information about one cache cluster.

drsMarker :: Lens' DescribeCacheClustersResponse (Maybe Text) #

Provides an identifier to allow retrieval of paginated results.