Network.AWS.ElastiCache.DescribeCacheClusters

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

By default, abbreviated information about the clusters is returned. You can use the optional ShowCacheNodeInfo flag to retrieve detailed information about the cache nodes associated with the 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 cluster, node endpoint information and creation time for the additional nodes are not displayed until they are completely provisioned. When the cluster state is available , the cluster is ready for use.

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

This operation returns paginated results.

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:

• dShowCacheClustersNotInReplicationGroups - An optional flag that can be included in the DescribeCacheCluster request to show only nodes (API/CLI: clusters) that are not members of a replication group. In practice, this mean Memcached and single node Redis clusters.
• dCacheClusterId - The user-supplied cluster identifier. If this parameter is specified, only information about that specific 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

Methods

(==) :: DescribeCacheClusters -> DescribeCacheClusters -> Bool

(/=) :: DescribeCacheClusters -> DescribeCacheClusters -> Bool

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

Methods

readsPrec :: Int -> ReadS DescribeCacheClusters

readList :: ReadS [DescribeCacheClusters]

readPrec :: ReadPrec DescribeCacheClusters

readListPrec :: ReadPrec [DescribeCacheClusters]

Show DescribeCacheClusters

Methods

showsPrec :: Int -> DescribeCacheClusters -> ShowS

show :: DescribeCacheClusters -> String

showList :: [DescribeCacheClusters] -> ShowS

Generic DescribeCacheClusters

Associated Types

type Rep DescribeCacheClusters :: * -> *

Methods

from :: DescribeCacheClusters -> Rep DescribeCacheClusters x

to :: Rep DescribeCacheClusters x -> DescribeCacheClusters

Hashable DescribeCacheClusters

Methods

hashWithSalt :: Int -> DescribeCacheClusters -> Int

hash :: DescribeCacheClusters -> Int

NFData DescribeCacheClusters

Methods

rnf :: DescribeCacheClusters -> ()

AWSPager DescribeCacheClusters

Methods

page :: DescribeCacheClusters -> Rs DescribeCacheClusters -> Maybe DescribeCacheClusters

AWSRequest DescribeCacheClusters

Associated Types

type Rs DescribeCacheClusters :: *

Methods

request :: DescribeCacheClusters -> Request DescribeCacheClusters

response :: (MonadResource m, MonadThrow m) => Logger -> Service -> Proxy * DescribeCacheClusters -> ClientResponse -> m (Response DescribeCacheClusters)

ToHeaders DescribeCacheClusters

Methods

toHeaders :: DescribeCacheClusters -> [Header]

ToPath DescribeCacheClusters

Methods

toPath :: DescribeCacheClusters -> ByteString

ToQuery DescribeCacheClusters

Methods

toQuery :: DescribeCacheClusters -> QueryString

type Rep DescribeCacheClusters

type Rep DescribeCacheClusters = D1 * (MetaData "DescribeCacheClusters" "Network.AWS.ElastiCache.DescribeCacheClusters" "amazonka-elasticache-1.6.0-4uuZWL7zhxxEXFvtkJRku9" False) (C1 * (MetaCons "DescribeCacheClusters'" PrefixI True) ((:*:) * ((:*:) * (S1 * (MetaSel (Just Symbol "_dShowCacheClustersNotInReplicationGroups") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Bool))) (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

type Rs DescribeCacheClusters = DescribeCacheClustersResponse

Request Lenses

dShowCacheClustersNotInReplicationGroups :: Lens' DescribeCacheClusters (Maybe Bool)

An optional flag that can be included in the DescribeCacheCluster request to show only nodes (API/CLI: clusters) that are not members of a replication group. In practice, this mean Memcached and single node Redis clusters.

dCacheClusterId :: Lens' DescribeCacheClusters (Maybe Text)

The user-supplied cluster identifier. If this parameter is specified, only information about that specific 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

Arguments

:: Int

drsResponseStatus

-> 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 clusters. Each item in the list contains detailed information about one 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

Methods

(==) :: DescribeCacheClustersResponse -> DescribeCacheClustersResponse -> Bool

(/=) :: DescribeCacheClustersResponse -> DescribeCacheClustersResponse -> Bool

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

Methods

readsPrec :: Int -> ReadS DescribeCacheClustersResponse

readList :: ReadS [DescribeCacheClustersResponse]

readPrec :: ReadPrec DescribeCacheClustersResponse

readListPrec :: ReadPrec [DescribeCacheClustersResponse]

Show DescribeCacheClustersResponse

Methods

showsPrec :: Int -> DescribeCacheClustersResponse -> ShowS

show :: DescribeCacheClustersResponse -> String

showList :: [DescribeCacheClustersResponse] -> ShowS

Generic DescribeCacheClustersResponse

Associated Types

type Rep DescribeCacheClustersResponse :: * -> *

Methods

from :: DescribeCacheClustersResponse -> Rep DescribeCacheClustersResponse x

to :: Rep DescribeCacheClustersResponse x -> DescribeCacheClustersResponse

NFData DescribeCacheClustersResponse

Methods

rnf :: DescribeCacheClustersResponse -> ()

type Rep DescribeCacheClustersResponse

type Rep DescribeCacheClustersResponse = D1 * (MetaData "DescribeCacheClustersResponse" "Network.AWS.ElastiCache.DescribeCacheClusters" "amazonka-elasticache-1.6.0-4uuZWL7zhxxEXFvtkJRku9" 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 DecidedStrict) (Rec0 * Int)))))

Response Lenses

drsCacheClusters :: Lens' DescribeCacheClustersResponse [CacheCluster]

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

drsMarker :: Lens' DescribeCacheClustersResponse (Maybe Text)

Provides an identifier to allow retrieval of paginated results.

drsResponseStatus :: Lens' DescribeCacheClustersResponse Int

• - | The response status code.