Struct rusoto_docdb::DescribeDBClusterSnapshotsMessage

pub struct DescribeDBClusterSnapshotsMessage {
    pub db_cluster_identifier: Option<String>,
    pub db_cluster_snapshot_identifier: Option<String>,
    pub filters: Option<Vec<Filter>>,
    pub include_public: Option<bool>,
    pub include_shared: Option<bool>,
    pub marker: Option<String>,
    pub max_records: Option<i64>,
    pub snapshot_type: Option<String>,
}

Represents the input to DescribeDBClusterSnapshots.

Fields

db_cluster_identifier: Option<String>

The ID of the DB cluster to retrieve the list of DB 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.

db_cluster_snapshot_identifier: Option<String>

A specific DB 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.

filters: Option<Vec<Filter>>

This parameter is not currently supported.

include_public: Option<bool>

Set to true to include manual DB cluster snapshots that are public and can be copied or restored by any AWS account, and otherwise false. The default is false.

include_shared: Option<bool>

Set to true to include shared manual DB cluster snapshots from other AWS accounts that this AWS account has been given permission to copy or restore, and otherwise false. The default is false.

marker: Option<String>

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.

max_records: Option<i64>

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.

snapshot_type: Option<String>

The type of DB cluster snapshots to be returned. You can specify one of the following values:

• automated - Return all DB cluster snapshots that Amazon DocumentDB has automatically created for your AWS account.

• manual - Return all DB cluster snapshots that you have manually created for your AWS account.

• shared - Return all manual DB cluster snapshots that have been shared to your AWS account.

• public - Return all DB cluster snapshots that have been marked as public.

If you don't specify a SnapshotType value, then both automated and manual DB cluster snapshots are returned. You can include shared DB cluster snapshots with these results by setting the IncludeShared parameter to true. You can include public DB 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.

Trait Implementations

impl PartialEq<DescribeDBClusterSnapshotsMessage> for DescribeDBClusterSnapshotsMessage

fn eq(&self, other: &DescribeDBClusterSnapshotsMessage) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &DescribeDBClusterSnapshotsMessage) -> bool

This method tests for !=.

impl Default for DescribeDBClusterSnapshotsMessage

fn default() -> DescribeDBClusterSnapshotsMessage

Returns the "default value" for a type.

impl Clone for DescribeDBClusterSnapshotsMessage

fn clone(&self) -> DescribeDBClusterSnapshotsMessage

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for DescribeDBClusterSnapshotsMessage

fn fmt(&self, f: &mut Formatter) -> Result

Formats the value using the given formatter.