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.DescribeCacheClusters

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

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.

Synopsis

Creating a Request

data DescribeCacheClusters Source #

Represents the input of a DescribeCacheClusters operation.

See: newDescribeCacheClusters smart constructor.

Constructors

DescribeCacheClusters'

Fields

showCacheClustersNotInReplicationGroups :: 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.
cacheClusterId :: 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.
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.
showCacheNodeInfo :: Maybe Bool
An optional flag that can be included in the DescribeCacheCluster request to retrieve information about the individual cache nodes.

Instances

Instances details

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

newDescribeCacheClusters :: DescribeCacheClusters Source #

Create a value of DescribeCacheClusters 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:showCacheClustersNotInReplicationGroups:DescribeCacheClusters', describeCacheClusters_showCacheClustersNotInReplicationGroups - 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.

$sel:cacheClusterId:DescribeCacheClusters', describeCacheClusters_cacheClusterId - The user-supplied cluster identifier. If this parameter is specified, only information about that specific cluster is returned. This parameter isn't case sensitive.

$sel:marker:DescribeCacheClusters', describeCacheClusters_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:DescribeCacheClusters', describeCacheClusters_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:showCacheNodeInfo:DescribeCacheClusters', describeCacheClusters_showCacheNodeInfo - An optional flag that can be included in the DescribeCacheCluster request to retrieve information about the individual cache nodes.

Request Lenses

describeCacheClusters_showCacheClustersNotInReplicationGroups :: Lens' DescribeCacheClusters (Maybe Bool) Source #

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.

describeCacheClusters_cacheClusterId :: Lens' DescribeCacheClusters (Maybe Text) Source #

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

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

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

describeCacheClusters_showCacheNodeInfo :: Lens' DescribeCacheClusters (Maybe Bool) Source #

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

Destructuring the Response

data DescribeCacheClustersResponse Source #

Represents the output of a DescribeCacheClusters operation.

See: newDescribeCacheClustersResponse smart constructor.

Constructors

DescribeCacheClustersResponse'
Fields cacheClusters :: Maybe [CacheCluster] A list of clusters. Each item in the list contains detailed information about one cluster. marker :: Maybe Text Provides an identifier to allow retrieval of paginated results. httpStatus :: Int The response's http status code.

Instances

Instances details

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

newDescribeCacheClustersResponse Source #

Arguments

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

Create a value of DescribeCacheClustersResponse 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:cacheClusters:DescribeCacheClustersResponse', describeCacheClustersResponse_cacheClusters - A list of clusters. Each item in the list contains detailed information about one cluster.

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

$sel:httpStatus:DescribeCacheClustersResponse', describeCacheClustersResponse_httpStatus - The response's http status code.

Response Lenses

describeCacheClustersResponse_cacheClusters :: Lens' DescribeCacheClustersResponse (Maybe [CacheCluster]) Source #

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

describeCacheClustersResponse_marker :: Lens' DescribeCacheClustersResponse (Maybe Text) Source #

Provides an identifier to allow retrieval of paginated results.

describeCacheClustersResponse_httpStatus :: Lens' DescribeCacheClustersResponse Int Source #

The response's http status code.