Network.AWS.RDS.DescribeDBClusters

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.

Creating a Request

describeDBClusters :: DescribeDBClusters

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:

• ddcDBClusterIdentifier
• ddcFilters
• ddcMaxRecords
• ddcMarker

data DescribeDBClusters

See: describeDBClusters smart constructor.

Instances

Eq DescribeDBClusters

Data DescribeDBClusters

Read DescribeDBClusters

Show DescribeDBClusters

Generic DescribeDBClusters

AWSRequest DescribeDBClusters

ToPath DescribeDBClusters

ToHeaders DescribeDBClusters

ToQuery DescribeDBClusters

type Rep DescribeDBClusters

type Sv DescribeDBClusters = RDS

type Rs DescribeDBClusters = DescribeDBClustersResponse

Request Lenses

ddcDBClusterIdentifier :: Lens' DescribeDBClusters (Maybe Text)

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]

This parameter is not currently supported.

ddcMaxRecords :: Lens' DescribeDBClusters (Maybe Int)

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.

ddcMarker :: Lens' DescribeDBClusters (Maybe Text)

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.

Destructuring the Response

describeDBClustersResponse

Arguments

:: Int

ddcrsStatus

-> DescribeDBClustersResponse

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:

• ddcrsDBClusters
• ddcrsMarker
• ddcrsStatus

data DescribeDBClustersResponse

Contains the result of a successful invocation of the DescribeDBClusters action.

See: describeDBClustersResponse smart constructor.

Instances

Eq DescribeDBClustersResponse

Data DescribeDBClustersResponse

Read DescribeDBClustersResponse

Show DescribeDBClustersResponse

Generic DescribeDBClustersResponse

type Rep DescribeDBClustersResponse

Response Lenses

ddcrsDBClusters :: Lens' DescribeDBClustersResponse [DBCluster]

Contains a list of DB clusters for the user.

ddcrsMarker :: Lens' DescribeDBClustersResponse (Maybe Text)

A pagination token that can be used in a subsequent DescribeDBClusters request.

ddcrsStatus :: Lens' DescribeDBClustersResponse Int

The response status code.