Struct rusoto_rds::DescribeDBSnapshotsMessage

pub struct DescribeDBSnapshotsMessage {
    pub db_instance_identifier: Option<String>,
    pub db_snapshot_identifier: Option<String>,
    pub filters: Option<FilterList>,
    pub include_public: Option<Boolean>,
    pub include_shared: Option<Boolean>,
    pub marker: Option<String>,
    pub max_records: Option<IntegerOptional>,
    pub snapshot_type: Option<String>,
}

Fields

db_instance_identifier: Option<String>

The ID of the DB instance to retrieve the list of DB snapshots for. This parameter cannot be used in conjunction with DBSnapshotIdentifier. This parameter is not case-sensitive.

Constraints:

• Must contain from 1 to 63 alphanumeric characters or hyphens

• First character must be a letter

• Cannot end with a hyphen or contain two consecutive hyphens

db_snapshot_identifier: Option<String>

A specific DB snapshot identifier to describe. This parameter cannot be used in conjunction with DBInstanceIdentifier. This value is stored as a lowercase string.

Constraints:

• Must be 1 to 255 alphanumeric characters.

• First character must be a letter.

• Cannot end with a hyphen or contain two consecutive hyphens.

• If this identifier is for an automated snapshot, the SnapshotType parameter must also be specified.

filters: Option<FilterList>

This parameter is not currently supported.

include_public: Option<Boolean>

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

You can share a manual DB snapshot as public by using the ModifyDBSnapshotAttribute API.

include_shared: Option<Boolean>

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

You can give an AWS account permission to restore a manual DB snapshot from another AWS account by using the ModifyDBSnapshotAttribute API action.

marker: Option<String>

An optional pagination token provided by a previous DescribeDBSnapshots request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

max_records: Option<IntegerOptional>

The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a 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 snapshots to be returned. You can specify one of the following values:

• automated - Return all DB snapshots that have been automatically taken by Amazon RDS for my AWS account.

• manual - Return all DB snapshots that have been taken by my AWS account.

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

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

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

fn default() -> DescribeDBSnapshotsMessage

Returns the "default value" for a type.

impl Debug for DescribeDBSnapshotsMessage

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

Formats the value using the given formatter.

impl Clone for DescribeDBSnapshotsMessage

fn clone(&self) -> DescribeDBSnapshotsMessage

Returns a copy of the value.

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

Performs copy-assignment from source.