amazonka-rds-1.2.0.1: Amazon Relational Database Service SDK.

Copyright(c) 2013-2015 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone
LanguageHaskell2010

Network.AWS.RDS.DescribeDBClusterSnapshots

Contents

Description

Returns information about DB cluster snapshots. 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 DescribeDBClusterSnapshots.

Synopsis

Creating a Request

describeDBClusterSnapshots :: DescribeDBClusterSnapshots Source

Creates a value of DescribeDBClusterSnapshots with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

Request Lenses

ddbcsDBClusterIdentifier :: Lens' DescribeDBClusterSnapshots (Maybe Text) Source

A DB cluster identifier to retrieve the list of DB cluster snapshots for. This parameter cannot be used in conjunction with the DBClusterSnapshotIdentifier parameter. This parameter is not 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

ddbcsDBClusterSnapshotIdentifier :: Lens' DescribeDBClusterSnapshots (Maybe Text) Source

A specific DB cluster snapshot identifier to describe. This parameter cannot be used in conjunction with the DBClusterIdentifier parameter. This value is stored as a lowercase string.

Constraints:

  • Must be 1 to 255 alphanumeric characters
  • First character must be a letter
  • Cannot end with a hyphen or contain two consecutive hyphens
  • If this is the identifier of an automated snapshot, the SnapshotType parameter must also be specified.

ddbcsFilters :: Lens' DescribeDBClusterSnapshots [Filter] Source

This parameter is not currently supported.

ddbcsSnapshotType :: Lens' DescribeDBClusterSnapshots (Maybe Text) Source

The type of DB cluster snapshots that will be returned. Values can be automated or manual. If this parameter is not specified, the returned results will include all snapshot types.

ddbcsMaxRecords :: Lens' DescribeDBClusterSnapshots (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.

ddbcsMarker :: Lens' DescribeDBClusterSnapshots (Maybe Text) Source

An optional pagination token provided by a previous DescribeDBClusterSnapshots request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

Destructuring the Response

describeDBClusterSnapshotsResponse Source

Creates a value of DescribeDBClusterSnapshotsResponse with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

Response Lenses

ddbcsrsMarker :: Lens' DescribeDBClusterSnapshotsResponse (Maybe Text) Source

An optional pagination token provided by a previous DescribeDBClusterSnapshots request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

ddbcsrsDBClusterSnapshots :: Lens' DescribeDBClusterSnapshotsResponse [DBClusterSnapshot] Source

Provides a list of DB cluster snapshots for the user.