Copyright | (c) 2013-2023 Brendan Hay |
---|---|
License | Mozilla Public License, v. 2.0. |
Maintainer | Brendan Hay |
Stability | auto-generated |
Portability | non-portable (GHC extensions) |
Safe Haskell | Safe-Inferred |
Language | Haskell2010 |
Returns information about cluster snapshots. This API operation supports pagination.
This operation returns paginated results.
Synopsis
- data DescribeDBClusterSnapshots = DescribeDBClusterSnapshots' {}
- newDescribeDBClusterSnapshots :: DescribeDBClusterSnapshots
- describeDBClusterSnapshots_dbClusterIdentifier :: Lens' DescribeDBClusterSnapshots (Maybe Text)
- describeDBClusterSnapshots_dbClusterSnapshotIdentifier :: Lens' DescribeDBClusterSnapshots (Maybe Text)
- describeDBClusterSnapshots_filters :: Lens' DescribeDBClusterSnapshots (Maybe [Filter])
- describeDBClusterSnapshots_includePublic :: Lens' DescribeDBClusterSnapshots (Maybe Bool)
- describeDBClusterSnapshots_includeShared :: Lens' DescribeDBClusterSnapshots (Maybe Bool)
- describeDBClusterSnapshots_marker :: Lens' DescribeDBClusterSnapshots (Maybe Text)
- describeDBClusterSnapshots_maxRecords :: Lens' DescribeDBClusterSnapshots (Maybe Int)
- describeDBClusterSnapshots_snapshotType :: Lens' DescribeDBClusterSnapshots (Maybe Text)
- data DescribeDBClusterSnapshotsResponse = DescribeDBClusterSnapshotsResponse' {}
- newDescribeDBClusterSnapshotsResponse :: Int -> DescribeDBClusterSnapshotsResponse
- describeDBClusterSnapshotsResponse_dbClusterSnapshots :: Lens' DescribeDBClusterSnapshotsResponse (Maybe [DBClusterSnapshot])
- describeDBClusterSnapshotsResponse_marker :: Lens' DescribeDBClusterSnapshotsResponse (Maybe Text)
- describeDBClusterSnapshotsResponse_httpStatus :: Lens' DescribeDBClusterSnapshotsResponse Int
Creating a Request
data DescribeDBClusterSnapshots Source #
Represents the input to DescribeDBClusterSnapshots.
See: newDescribeDBClusterSnapshots
smart constructor.
DescribeDBClusterSnapshots' | |
|
Instances
newDescribeDBClusterSnapshots :: DescribeDBClusterSnapshots Source #
Create a value of DescribeDBClusterSnapshots
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:
DescribeDBClusterSnapshots
, describeDBClusterSnapshots_dbClusterIdentifier
- The ID of the cluster to retrieve the list of cluster snapshots for.
This parameter can't be used with the DBClusterSnapshotIdentifier
parameter. This parameter is not case sensitive.
Constraints:
- If provided, must match the identifier of an existing
DBCluster
.
DescribeDBClusterSnapshots
, describeDBClusterSnapshots_dbClusterSnapshotIdentifier
- A specific cluster snapshot identifier to describe. This parameter
can't be used with the DBClusterIdentifier
parameter. This value is
stored as a lowercase string.
Constraints:
- If provided, must match the identifier of an existing
DBClusterSnapshot
. - If this identifier is for an automated snapshot, the
SnapshotType
parameter must also be specified.
$sel:filters:DescribeDBClusterSnapshots'
, describeDBClusterSnapshots_filters
- This parameter is not currently supported.
$sel:includePublic:DescribeDBClusterSnapshots'
, describeDBClusterSnapshots_includePublic
- Set to true
to include manual cluster snapshots that are public and
can be copied or restored by any Amazon Web Services account, and
otherwise false
. The default is false
.
$sel:includeShared:DescribeDBClusterSnapshots'
, describeDBClusterSnapshots_includeShared
- Set to true
to include shared manual cluster snapshots from other
Amazon Web Services accounts that this Amazon Web Services account has
been given permission to copy or restore, and otherwise false
. The
default is false
.
DescribeDBClusterSnapshots
, describeDBClusterSnapshots_marker
- An optional pagination token provided by a previous request. If this
parameter is specified, the response includes only records beyond the
marker, up to the value specified by MaxRecords
.
$sel:maxRecords:DescribeDBClusterSnapshots'
, describeDBClusterSnapshots_maxRecords
- The maximum number of records to include in the response. If more
records exist than the specified MaxRecords
value, a pagination token
(marker) is included in the response so that the remaining results can
be retrieved.
Default: 100
Constraints: Minimum 20, maximum 100.
DescribeDBClusterSnapshots
, describeDBClusterSnapshots_snapshotType
- The type of cluster snapshots to be returned. You can specify one of the
following values:
automated
- Return all cluster snapshots that Amazon DocumentDB has automatically created for your Amazon Web Services account.manual
- Return all cluster snapshots that you have manually created for your Amazon Web Services account.shared
- Return all manual cluster snapshots that have been shared to your Amazon Web Services account.public
- Return all cluster snapshots that have been marked as public.
If you don't specify a SnapshotType
value, then both automated and
manual cluster snapshots are returned. You can include shared cluster
snapshots with these results by setting the IncludeShared
parameter to
true
. You can include public cluster snapshots with these results by
setting theIncludePublic
parameter to true
.
The IncludeShared
and IncludePublic
parameters don't apply for
SnapshotType
values of manual
or automated
. The IncludePublic
parameter doesn't apply when SnapshotType
is set to shared
. The
IncludeShared
parameter doesn't apply when SnapshotType
is set to
public
.
Request Lenses
describeDBClusterSnapshots_dbClusterIdentifier :: Lens' DescribeDBClusterSnapshots (Maybe Text) Source #
The ID of the cluster to retrieve the list of cluster snapshots for.
This parameter can't be used with the DBClusterSnapshotIdentifier
parameter. This parameter is not case sensitive.
Constraints:
- If provided, must match the identifier of an existing
DBCluster
.
describeDBClusterSnapshots_dbClusterSnapshotIdentifier :: Lens' DescribeDBClusterSnapshots (Maybe Text) Source #
A specific cluster snapshot identifier to describe. This parameter
can't be used with the DBClusterIdentifier
parameter. This value is
stored as a lowercase string.
Constraints:
- If provided, must match the identifier of an existing
DBClusterSnapshot
. - If this identifier is for an automated snapshot, the
SnapshotType
parameter must also be specified.
describeDBClusterSnapshots_filters :: Lens' DescribeDBClusterSnapshots (Maybe [Filter]) Source #
This parameter is not currently supported.
describeDBClusterSnapshots_includePublic :: Lens' DescribeDBClusterSnapshots (Maybe Bool) Source #
Set to true
to include manual cluster snapshots that are public and
can be copied or restored by any Amazon Web Services account, and
otherwise false
. The default is false
.
describeDBClusterSnapshots_includeShared :: Lens' DescribeDBClusterSnapshots (Maybe Bool) Source #
Set to true
to include shared manual cluster snapshots from other
Amazon Web Services accounts that this Amazon Web Services account has
been given permission to copy or restore, and otherwise false
. The
default is false
.
describeDBClusterSnapshots_marker :: Lens' DescribeDBClusterSnapshots (Maybe Text) Source #
An optional pagination token provided by a previous request. If this
parameter is specified, the response includes only records beyond the
marker, up to the value specified by MaxRecords
.
describeDBClusterSnapshots_maxRecords :: 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
(marker) is included in the response so that the remaining results can
be retrieved.
Default: 100
Constraints: Minimum 20, maximum 100.
describeDBClusterSnapshots_snapshotType :: Lens' DescribeDBClusterSnapshots (Maybe Text) Source #
The type of cluster snapshots to be returned. You can specify one of the following values:
automated
- Return all cluster snapshots that Amazon DocumentDB has automatically created for your Amazon Web Services account.manual
- Return all cluster snapshots that you have manually created for your Amazon Web Services account.shared
- Return all manual cluster snapshots that have been shared to your Amazon Web Services account.public
- Return all cluster snapshots that have been marked as public.
If you don't specify a SnapshotType
value, then both automated and
manual cluster snapshots are returned. You can include shared cluster
snapshots with these results by setting the IncludeShared
parameter to
true
. You can include public cluster snapshots with these results by
setting theIncludePublic
parameter to true
.
The IncludeShared
and IncludePublic
parameters don't apply for
SnapshotType
values of manual
or automated
. The IncludePublic
parameter doesn't apply when SnapshotType
is set to shared
. The
IncludeShared
parameter doesn't apply when SnapshotType
is set to
public
.
Destructuring the Response
data DescribeDBClusterSnapshotsResponse Source #
Represents the output of DescribeDBClusterSnapshots.
See: newDescribeDBClusterSnapshotsResponse
smart constructor.
DescribeDBClusterSnapshotsResponse' | |
|
Instances
newDescribeDBClusterSnapshotsResponse Source #
Create a value of DescribeDBClusterSnapshotsResponse
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:dbClusterSnapshots:DescribeDBClusterSnapshotsResponse'
, describeDBClusterSnapshotsResponse_dbClusterSnapshots
- Provides a list of cluster snapshots.
DescribeDBClusterSnapshots
, describeDBClusterSnapshotsResponse_marker
- An optional pagination token provided by a previous request. If this
parameter is specified, the response includes only records beyond the
marker, up to the value specified by MaxRecords
.
$sel:httpStatus:DescribeDBClusterSnapshotsResponse'
, describeDBClusterSnapshotsResponse_httpStatus
- The response's http status code.
Response Lenses
describeDBClusterSnapshotsResponse_dbClusterSnapshots :: Lens' DescribeDBClusterSnapshotsResponse (Maybe [DBClusterSnapshot]) Source #
Provides a list of cluster snapshots.
describeDBClusterSnapshotsResponse_marker :: Lens' DescribeDBClusterSnapshotsResponse (Maybe Text) Source #
An optional pagination token provided by a previous request. If this
parameter is specified, the response includes only records beyond the
marker, up to the value specified by MaxRecords
.
describeDBClusterSnapshotsResponse_httpStatus :: Lens' DescribeDBClusterSnapshotsResponse Int Source #
The response's http status code.