class Aws::DocDB::Types::DescribeDBClusterSnapshotsMessage


@see docs.aws.amazon.com/goto/WebAPI/docdb-2014-10-31/DescribeDBClusterSnapshotsMessage AWS API Documentation
@return [Boolean]
‘false`. The default is `false`.
and can be copied or restored by any AWS account, and otherwise
Set to `true` to include manual DB cluster snapshots that are public
@!attribute [rw] include_public
@return [Boolean]
to copy or restore, and otherwise `false`. The default is `false`.
other AWS accounts that this AWS account has been given permission
Set to `true` to include shared manual DB cluster snapshots from
@!attribute [rw] include_shared
@return [String]
the marker, up to the value specified by `MaxRecords`.
parameter is specified, the response includes only records beyond
An optional pagination token provided by a previous request. If this
@!attribute [rw] marker
@return [Integer]
Constraints: Minimum 20, maximum 100.
Default: 100
results can be retrieved.
token (marker) is included in the response so that the remaining
records exist than the specified `MaxRecords` value, a pagination
The maximum number of records to include in the response. If more
@!attribute [rw] max_records
@return [Array<Types::Filter>]
This parameter is not currently supported.
@!attribute [rw] filters
@return [String]
`SnapshotType` is set to `public`.
to `shared`. The `IncludeShared` parameter doesn’t apply when
`IncludePublic` parameter doesn’t apply when ‘SnapshotType` is set
`SnapshotType` values of `manual` or `automated`. The
The `IncludeShared` and `IncludePublic` parameters don’t apply for
parameter to ‘true`.
cluster snapshots with these results by setting the `IncludePublic`
`IncludeShared` parameter to `true`. You can include public DB
DB cluster snapshots with these results by setting the
and manual DB cluster snapshots are returned. You can include shared
If you don’t specify a ‘SnapshotType` value, then both automated
as public.
* `public` - Return all DB cluster snapshots that have been marked
shared to your AWS account.
* `shared` - Return all manual DB cluster snapshots that have been
created for your AWS account.
* `manual` - Return all DB cluster snapshots that you have manually
DocumentDB has automatically created for your AWS account.
* `automated` - Return all DB cluster snapshots that Amazon
of the following values:
The type of DB cluster snapshots to be returned. You can specify one
@!attribute [rw] snapshot_type
@return [String]
`SnapshotType` parameter must also be specified.
* If this identifier is for an automated snapshot, the
`DBClusterSnapshot`.
* If provided, must match the identifier of an existing
Constraints:
This value is stored as a lowercase string.
parameter can’t be used with the ‘DBClusterIdentifier` parameter.
A specific DB cluster snapshot identifier to describe. This
@!attribute [rw] db_cluster_snapshot_identifier
@return [String]
^
* If provided, must match the identifier of an existing `DBCluster`.
Constraints:
sensitive.
`DBClusterSnapshotIdentifier` parameter. This parameter is not case
snapshots for. This parameter can’t be used with the
The ID of the DB cluster to retrieve the list of DB cluster
@!attribute [rw] db_cluster_identifier
}
include_public: false,
include_shared: false,
marker: “String”,
max_records: 1,
],
},
values: [“String”], # required
name: “String”, # required
{
filters: [
snapshot_type: “String”,
db_cluster_snapshot_identifier: “String”,
db_cluster_identifier: “String”,
{
data as a hash:
@note When making an API call, you may pass DescribeDBClusterSnapshotsMessage
Represents the input to DescribeDBClusterSnapshots.