Struct aws_sdk_elasticache::input::DescribeSnapshotsInput

#[non_exhaustive]
pub struct DescribeSnapshotsInput {
    pub replication_group_id: Option<String>,
    pub cache_cluster_id: Option<String>,
    pub snapshot_name: Option<String>,
    pub snapshot_source: Option<String>,
    pub marker: Option<String>,
    pub max_records: Option<i32>,
    pub show_node_group_config: Option<bool>,
}

Represents the input of a DescribeSnapshotsMessage operation.

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.

replication_group_id: Option<String>

A user-supplied replication group identifier. If this parameter is specified, only snapshots associated with that specific replication group are described.

cache_cluster_id: Option<String>

A user-supplied cluster identifier. If this parameter is specified, only snapshots associated with that specific cluster are described.

snapshot_name: Option<String>

A user-supplied name of the snapshot. If this parameter is specified, only this snapshot are described.

snapshot_source: Option<String>

If set to system, the output shows snapshots that were automatically created by ElastiCache. If set to user the output shows snapshots that were manually created. If omitted, the output shows both automatically and manually created snapshots.

marker: Option<String>

An optional marker returned from a prior request. Use this marker for pagination of results from this operation. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

max_records: Option<i32>

The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a marker is included in the response so that the remaining results can be retrieved.

Default: 50

Constraints: minimum 20; maximum 50.

show_node_group_config: Option<bool>

A Boolean value which if true, the node group (shard) configuration is included in the snapshot description.

Implementations

impl DescribeSnapshotsInput

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

Consumes the builder and constructs an Operation<DescribeSnapshots>

pub fn builder() -> Builder

Creates a new builder-style object to manufacture DescribeSnapshotsInput

impl DescribeSnapshotsInput

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

A user-supplied replication group identifier. If this parameter is specified, only snapshots associated with that specific replication group are described.

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

A user-supplied cluster identifier. If this parameter is specified, only snapshots associated with that specific cluster are described.

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

A user-supplied name of the snapshot. If this parameter is specified, only this snapshot are described.

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

If set to system, the output shows snapshots that were automatically created by ElastiCache. If set to user the output shows snapshots that were manually created. If omitted, the output shows both automatically and manually created snapshots.

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

An optional marker returned from a prior request. Use this marker for pagination of results from this operation. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

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 marker is included in the response so that the remaining results can be retrieved.

Default: 50

Constraints: minimum 20; maximum 50.

pub fn show_node_group_config(&self) -> Option<bool>

A Boolean value which if true, the node group (shard) configuration is included in the snapshot description.

Trait Implementations

impl Clone for DescribeSnapshotsInput

fn clone(&self) -> DescribeSnapshotsInput

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for DescribeSnapshotsInput

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

Formats the value using the given formatter.

impl PartialEq<DescribeSnapshotsInput> for DescribeSnapshotsInput

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

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

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

This method tests for !=.

impl StructuralPartialEq for DescribeSnapshotsInput