Copyright | (c) 2013-2015 Brendan Hay |
---|---|
License | Mozilla Public License, v. 2.0. |
Maintainer | Brendan Hay <brendan.g.hay@gmail.com> |
Stability | auto-generated |
Portability | non-portable (GHC extensions) |
Safe Haskell | None |
Language | Haskell2010 |
The DescribeCacheClusters action 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(s) will be 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 will be displayed until all of the nodes are successfully provisioned.
If the cluster is in the DELETING state, only cluster level information will be displayed.
If cache nodes are currently being added to the cache cluster, node endpoint information and creation time for the additional nodes will not be 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.
See: AWS API Reference for DescribeCacheClusters.
This operation returns paginated results.
- describeCacheClusters :: DescribeCacheClusters
- data DescribeCacheClusters
- dCacheClusterId :: Lens' DescribeCacheClusters (Maybe Text)
- dMaxRecords :: Lens' DescribeCacheClusters (Maybe Int)
- dMarker :: Lens' DescribeCacheClusters (Maybe Text)
- dShowCacheNodeInfo :: Lens' DescribeCacheClusters (Maybe Bool)
- describeCacheClustersResponse :: Int -> DescribeCacheClustersResponse
- data DescribeCacheClustersResponse
- drsCacheClusters :: Lens' DescribeCacheClustersResponse [CacheCluster]
- drsMarker :: Lens' DescribeCacheClustersResponse (Maybe Text)
- drsStatus :: Lens' DescribeCacheClustersResponse Int
Creating a Request
describeCacheClusters :: DescribeCacheClusters Source
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:
data DescribeCacheClusters Source
Represents the input of a DescribeCacheClusters action.
See: describeCacheClusters
smart constructor.
Request Lenses
dCacheClusterId :: Lens' DescribeCacheClusters (Maybe Text) Source
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.
dMaxRecords :: 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.
dMarker :: Lens' DescribeCacheClusters (Maybe Text) Source
An optional marker returned from a prior request. Use this marker for pagination of results from this action. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.
dShowCacheNodeInfo :: 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
describeCacheClustersResponse Source
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:
data DescribeCacheClustersResponse Source
Represents the output of a DescribeCacheClusters action.
See: describeCacheClustersResponse
smart constructor.
Response Lenses
drsCacheClusters :: Lens' DescribeCacheClustersResponse [CacheCluster] Source
A list of cache clusters. Each item in the list contains detailed information about one cache cluster.
drsMarker :: Lens' DescribeCacheClustersResponse (Maybe Text) Source
Provides an identifier to allow retrieval of paginated results.
drsStatus :: Lens' DescribeCacheClustersResponse Int Source
The response status code.