Struct aws_sdk_docdb::input::DescribeDbClusterSnapshotsInput

#[non_exhaustive]
pub struct DescribeDbClusterSnapshotsInput {
    pub db_cluster_identifier: Option<String>,
    pub db_cluster_snapshot_identifier: Option<String>,
    pub snapshot_type: Option<String>,
    pub filters: Option<Vec<Filter>>,
    pub max_records: Option<i32>,
    pub marker: Option<String>,
    pub include_shared: bool,
    pub include_public: bool,
}

Represents the input to DescribeDBClusterSnapshots.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

db_cluster_identifier: Option<String>

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.

db_cluster_snapshot_identifier: Option<String>

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.

snapshot_type: Option<String>

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.

filters: Option<Vec<Filter>>

This parameter is not currently supported.

max_records: Option<i32>

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.

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.

include_shared: bool

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.

include_public: bool

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.

Implementations

impl DescribeDbClusterSnapshotsInput

pub async fn make_operation(
    &self,
    _config: &Config
) -> Result<Operation<DescribeDBClusterSnapshots, AwsErrorRetryPolicy>, BuildError>

Consumes the builder and constructs an Operation<DescribeDBClusterSnapshots>

pub fn builder() -> Builder

Creates a new builder-style object to manufacture DescribeDbClusterSnapshotsInput

impl DescribeDbClusterSnapshotsInput

pub fn db_cluster_identifier(&self) -> Option<&str>

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.

pub fn db_cluster_snapshot_identifier(&self) -> Option<&str>

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.

pub fn snapshot_type(&self) -> Option<&str>

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.

pub fn filters(&self) -> Option<&[Filter]>

This parameter is not currently supported.

pub fn max_records(&self) -> Option<i32>

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.

pub fn marker(&self) -> Option<&str>

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.

pub fn include_shared(&self) -> bool

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.

pub fn include_public(&self) -> bool

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.

Trait Implementations

impl Clone for DescribeDbClusterSnapshotsInput

fn clone(&self) -> DescribeDbClusterSnapshotsInput

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for DescribeDbClusterSnapshotsInput

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

Formats the value using the given formatter.

impl PartialEq<DescribeDbClusterSnapshotsInput> for DescribeDbClusterSnapshotsInput

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

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

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

This method tests for !=.

impl StructuralPartialEq for DescribeDbClusterSnapshotsInput