class Aws::DocDB::Types::DescribeDBClusterSnapshotsMessage
Represents the input to DescribeDBClusterSnapshots.
@note When making an API call, you may pass DescribeDBClusterSnapshotsMessage
data as a hash: { db_cluster_identifier: "String", db_cluster_snapshot_identifier: "String", snapshot_type: "String", filters: [ { name: "String", # required values: ["String"], # required }, ], max_records: 1, marker: "String", include_shared: false, include_public: false, }
@!attribute [rw] db_cluster_identifier
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`. ^ @return [String]
@!attribute [rw] db_cluster_snapshot_identifier
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. @return [String]
@!attribute [rw] snapshot_type
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 account. * `manual` - Return all cluster snapshots that you have manually created for your account. * `shared` - Return all manual cluster snapshots that have been shared to your 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 the`IncludePublic` 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`. @return [String]
@!attribute [rw] filters
This parameter is not currently supported. @return [Array<Types::Filter>]
@!attribute [rw] max_records
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. @return [Integer]
@!attribute [rw] 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`. @return [String]
@!attribute [rw] include_shared
Set to `true` to include shared manual cluster snapshots from other accounts that this account has been given permission to copy or restore, and otherwise `false`. The default is `false`. @return [Boolean]
@!attribute [rw] include_public
Set to `true` to include manual cluster snapshots that are public and can be copied or restored by any account, and otherwise `false`. The default is `false`. @return [Boolean]
@see docs.aws.amazon.com/goto/WebAPI/docdb-2014-10-31/DescribeDBClusterSnapshotsMessage AWS API Documentation
Constants
- SENSITIVE