Struct aws_sdk_elasticache::client::fluent_builders::DescribeCacheClusters

pub struct DescribeCacheClusters { /* private fields */ }

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 DescribeCacheClusters

pub async fn send(
    self
) -> Result<DescribeCacheClustersOutput, SdkError<DescribeCacheClustersError>>

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 into_paginator(self) -> DescribeCacheClustersPaginator

Create a paginator for this request

Paginators are used by calling send().await which returns a Stream.

pub fn cache_cluster_id(self, input: impl Into<String>) -> Self

The user-supplied cluster identifier. If this parameter is specified, only information about that specific cluster is returned. This parameter isn't case sensitive.

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

The user-supplied cluster identifier. If this parameter is specified, only information about that specific cluster is returned. This parameter isn't case sensitive.

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: 100

Constraints: minimum 20; maximum 100.

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: 100

Constraints: minimum 20; maximum 100.

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.

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 show_cache_node_info(self, input: bool) -> Self

An optional flag that can be included in the DescribeCacheCluster request to retrieve information about the individual cache nodes.

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

An optional flag that can be included in the DescribeCacheCluster request to retrieve information about the individual cache nodes.

pub fn show_cache_clusters_not_in_replication_groups(self, input: bool) -> Self

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.

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

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

impl Clone for DescribeCacheClusters

fn clone(&self) -> DescribeCacheClusters

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for DescribeCacheClusters

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

Formats the value using the given formatter.