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 |
Returns information about provisioned Aurora DB clusters. This API supports pagination.
For more information on Amazon Aurora, see Aurora on Amazon RDS in the Amazon RDS User Guide.
See: AWS API Reference for DescribeDBClusters.
- describeDBClusters :: DescribeDBClusters
- data DescribeDBClusters
- ddcDBClusterIdentifier :: Lens' DescribeDBClusters (Maybe Text)
- ddcFilters :: Lens' DescribeDBClusters [Filter]
- ddcMarker :: Lens' DescribeDBClusters (Maybe Text)
- ddcMaxRecords :: Lens' DescribeDBClusters (Maybe Int)
- describeDBClustersResponse :: Int -> DescribeDBClustersResponse
- data DescribeDBClustersResponse
- ddcrsDBClusters :: Lens' DescribeDBClustersResponse [DBCluster]
- ddcrsMarker :: Lens' DescribeDBClustersResponse (Maybe Text)
- ddcrsResponseStatus :: Lens' DescribeDBClustersResponse Int
Creating a Request
describeDBClusters :: DescribeDBClusters Source
Creates a value of DescribeDBClusters
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
data DescribeDBClusters Source
See: describeDBClusters
smart constructor.
Request Lenses
ddcDBClusterIdentifier :: Lens' DescribeDBClusters (Maybe Text) Source
The user-supplied DB cluster identifier. If this parameter is specified, information from only the specific DB cluster is returned. This parameter isn't case-sensitive.
Constraints:
- Must contain from 1 to 63 alphanumeric characters or hyphens
- First character must be a letter
- Cannot end with a hyphen or contain two consecutive hyphens
ddcFilters :: Lens' DescribeDBClusters [Filter] Source
This parameter is not currently supported.
ddcMarker :: Lens' DescribeDBClusters (Maybe Text) Source
An optional pagination token provided by a previous DescribeDBClusters
request. If this parameter is specified, the response includes only
records beyond the marker, up to the value specified by MaxRecords
.
ddcMaxRecords :: Lens' DescribeDBClusters (Maybe Int) Source
The maximum number of records to include in the response. If more
records exist than the specified MaxRecords
value, a pagination token
called a marker is included in the response so that the remaining
results can be retrieved.
Default: 100
Constraints: Minimum 20, maximum 100.
Destructuring the Response
describeDBClustersResponse Source
Creates a value of DescribeDBClustersResponse
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
data DescribeDBClustersResponse Source
Contains the result of a successful invocation of the DescribeDBClusters action.
See: describeDBClustersResponse
smart constructor.
Response Lenses
ddcrsDBClusters :: Lens' DescribeDBClustersResponse [DBCluster] Source
Contains a list of DB clusters for the user.
ddcrsMarker :: Lens' DescribeDBClustersResponse (Maybe Text) Source
A pagination token that can be used in a subsequent DescribeDBClusters request.
ddcrsResponseStatus :: Lens' DescribeDBClustersResponse Int Source
The response status code.