Struct aws_sdk_elasticache::client::fluent_builders::DescribeCacheClusters [−][src]
pub struct DescribeCacheClusters<C = DynConnector, M = AwsMiddleware, R = Standard> { /* fields omitted */ }
Expand description
Fluent builder constructing a request to DescribeCacheClusters
.
Returns information about all provisioned clusters if no cluster identifier is specified, or about a specific cache cluster if a cluster identifier is supplied.
By default, abbreviated information about the clusters is returned. You can use the optional ShowCacheNodeInfo flag to retrieve detailed information about the cache nodes associated with the clusters. These details include the DNS address and port for the cache node endpoint.
If the cluster is in the creating state, only cluster-level information is displayed until all of the nodes are successfully provisioned.
If the cluster is in the deleting state, only cluster-level information is displayed.
If cache nodes are currently being added to the cluster, node endpoint information and creation time for the additional nodes are not displayed until they are completely provisioned. When the cluster state is available, the cluster is ready for use.
If cache nodes are currently being removed from the cluster, no endpoint information for the removed nodes is displayed.
Implementations
impl<C, M, R> DescribeCacheClusters<C, M, R> where
C: SmithyConnector,
M: SmithyMiddleware<C>,
R: NewRequestPolicy,
impl<C, M, R> DescribeCacheClusters<C, M, R> where
C: SmithyConnector,
M: SmithyMiddleware<C>,
R: NewRequestPolicy,
pub async fn send(
self
) -> Result<DescribeCacheClustersOutput, SdkError<DescribeCacheClustersError>> where
R::Policy: SmithyRetryPolicy<DescribeCacheClustersInputOperationOutputAlias, DescribeCacheClustersOutput, DescribeCacheClustersError, DescribeCacheClustersInputOperationRetryAlias>,
pub async fn send(
self
) -> Result<DescribeCacheClustersOutput, SdkError<DescribeCacheClustersError>> where
R::Policy: SmithyRetryPolicy<DescribeCacheClustersInputOperationOutputAlias, DescribeCacheClustersOutput, DescribeCacheClustersError, DescribeCacheClustersInputOperationRetryAlias>,
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.
The user-supplied cluster identifier. If this parameter is specified, only information about that specific cluster is returned. This parameter isn't case sensitive.
The user-supplied cluster identifier. If this parameter is specified, only information about that specific cluster is returned. This parameter isn't case sensitive.
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: 100
Constraints: minimum 20; maximum 100.
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: 100
Constraints: minimum 20; maximum 100.
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
.
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
.
An optional flag that can be included in the DescribeCacheCluster
request
to retrieve information about the individual cache nodes.
An optional flag that can be included in the DescribeCacheCluster
request
to retrieve information about the individual cache nodes.
An optional flag that can be included in the DescribeCacheCluster
request
to show only nodes (API/CLI: clusters) that are not members of a replication group.
In practice, this mean Memcached and single node Redis clusters.
An optional flag that can be included in the DescribeCacheCluster
request
to show only nodes (API/CLI: clusters) that are not members of a replication group.
In practice, this mean Memcached and single node Redis clusters.
Trait Implementations
Auto Trait Implementations
impl<C = DynConnector, M = AwsMiddleware, R = Standard> !RefUnwindSafe for DescribeCacheClusters<C, M, R>
impl<C, M, R> Send for DescribeCacheClusters<C, M, R> where
C: Send + Sync,
M: Send + Sync,
R: Send + Sync,
impl<C, M, R> Sync for DescribeCacheClusters<C, M, R> where
C: Send + Sync,
M: Send + Sync,
R: Send + Sync,
impl<C, M, R> Unpin for DescribeCacheClusters<C, M, R>
impl<C = DynConnector, M = AwsMiddleware, R = Standard> !UnwindSafe for DescribeCacheClusters<C, M, R>
Blanket Implementations
Mutably borrows from an owned value. Read more
Attaches the provided Subscriber
to this type, returning a
WithDispatch
wrapper. Read more
Attaches the current default Subscriber
to this type, returning a
WithDispatch
wrapper. Read more