Struct aws_sdk_elasticache::client::fluent_builders::DescribeSnapshots

pub struct DescribeSnapshots<C = DynConnector, M = AwsMiddleware, R = Standard> { /* fields omitted */ }

Fluent builder constructing a request to DescribeSnapshots.

Returns information about cluster or replication group snapshots. By default, DescribeSnapshots lists all of your snapshots; it can optionally describe a single snapshot, or just the snapshots associated with a particular cache cluster.

This operation is valid for Redis only.

Implementations

impl<C, M, R> DescribeSnapshots<C, M, R> where
    C: SmithyConnector,
    M: SmithyMiddleware<C>,
    R: NewRequestPolicy, 

pub async fn send(
    self
) -> Result<DescribeSnapshotsOutput, SdkError<DescribeSnapshotsError>> where
    R::Policy: SmithyRetryPolicy<DescribeSnapshotsInputOperationOutputAlias, DescribeSnapshotsOutput, DescribeSnapshotsError, DescribeSnapshotsInputOperationRetryAlias>, 

Sends the request and returns the response.

If an error occurs, an SdkError will be returned with additional details that can be matched against.

By default, any retryable failures will be retried twice. Retry behavior is configurable with the RetryConfig, which can be set when configuring the client.

pub fn replication_group_id(self, inp: impl Into<String>) -> Self

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

pub fn set_replication_group_id(self, input: Option<String>) -> Self

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, inp: impl Into<String>) -> Self

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

pub fn set_cache_cluster_id(self, input: Option<String>) -> Self

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

pub fn snapshot_name(self, inp: impl Into<String>) -> Self

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

pub fn set_snapshot_name(self, input: Option<String>) -> Self

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

pub fn snapshot_source(self, inp: impl Into<String>) -> Self

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 set_snapshot_source(self, input: Option<String>) -> Self

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, inp: impl Into<String>) -> Self

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 set_marker(self, input: Option<String>) -> Self

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, inp: i32) -> Self

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 set_max_records(self, input: Option<i32>) -> Self

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, inp: bool) -> Self

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

pub fn set_show_node_group_config(self, input: Option<bool>) -> Self

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

Trait Implementations

impl<C: Debug, M: Debug, R: Debug> Debug for DescribeSnapshots<C, M, R>

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

Formats the value using the given formatter.