pub struct DescribeSnapshots { /* private fields */ }
Expand description
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§
source§impl DescribeSnapshots
impl DescribeSnapshots
sourcepub async fn customize(
self
) -> Result<CustomizableOperation<DescribeSnapshots, AwsResponseRetryClassifier>, SdkError<DescribeSnapshotsError>>
pub async fn customize(
self
) -> Result<CustomizableOperation<DescribeSnapshots, AwsResponseRetryClassifier>, SdkError<DescribeSnapshotsError>>
Consume this builder, creating a customizable operation that can be modified before being sent. The operation’s inner http::Request can be modified as well.
sourcepub async fn send(
self
) -> Result<DescribeSnapshotsOutput, SdkError<DescribeSnapshotsError>>
pub async fn send(
self
) -> Result<DescribeSnapshotsOutput, SdkError<DescribeSnapshotsError>>
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.
sourcepub fn into_paginator(self) -> DescribeSnapshotsPaginator
pub fn into_paginator(self) -> DescribeSnapshotsPaginator
Create a paginator for this request
Paginators are used by calling send().await
which returns a Stream
.
sourcepub fn replication_group_id(self, input: impl Into<String>) -> Self
pub fn replication_group_id(self, input: 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.
sourcepub fn set_replication_group_id(self, input: Option<String>) -> Self
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.
sourcepub fn cache_cluster_id(self, input: impl Into<String>) -> Self
pub fn cache_cluster_id(self, input: impl Into<String>) -> Self
A user-supplied cluster identifier. If this parameter is specified, only snapshots associated with that specific cluster are described.
sourcepub fn set_cache_cluster_id(self, input: Option<String>) -> Self
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.
sourcepub fn snapshot_name(self, input: impl Into<String>) -> Self
pub fn snapshot_name(self, input: impl Into<String>) -> Self
A user-supplied name of the snapshot. If this parameter is specified, only this snapshot are described.
sourcepub fn set_snapshot_name(self, input: Option<String>) -> Self
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.
sourcepub fn snapshot_source(self, input: impl Into<String>) -> Self
pub fn snapshot_source(self, input: 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.
sourcepub fn set_snapshot_source(self, input: Option<String>) -> Self
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.
sourcepub fn marker(self, input: impl Into<String>) -> Self
pub fn marker(self, input: 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
.
sourcepub fn set_marker(self, input: Option<String>) -> Self
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
.
sourcepub fn max_records(self, input: i32) -> Self
pub fn max_records(self, input: 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.
sourcepub fn set_max_records(self, input: Option<i32>) -> Self
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.
sourcepub fn show_node_group_config(self, input: bool) -> Self
pub fn show_node_group_config(self, input: bool) -> Self
A Boolean value which if true, the node group (shard) configuration is included in the snapshot description.
sourcepub fn set_show_node_group_config(self, input: Option<bool>) -> Self
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§
source§impl Clone for DescribeSnapshots
impl Clone for DescribeSnapshots
source§fn clone(&self) -> DescribeSnapshots
fn clone(&self) -> DescribeSnapshots
1.0.0 · source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read more