Struct aws_sdk_elasticache::input::DescribeCacheClustersInput

#[non_exhaustive]
pub struct DescribeCacheClustersInput {
    pub cache_cluster_id: Option<String>,
    pub max_records: Option<i32>,
    pub marker: Option<String>,
    pub show_cache_node_info: Option<bool>,
    pub show_cache_clusters_not_in_replication_groups: Option<bool>,
}

Represents the input of a DescribeCacheClusters 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.

cache_cluster_id: Option<String>

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

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

Constraints: minimum 20; maximum 100.

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.

show_cache_node_info: Option<bool>

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

show_cache_clusters_not_in_replication_groups: Option<bool>

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.

Implementations

impl DescribeCacheClustersInput

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

Consumes the builder and constructs an Operation<DescribeCacheClusters>

pub fn builder() -> Builder

Creates a new builder-style object to manufacture DescribeCacheClustersInput

impl DescribeCacheClustersInput

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

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

Constraints: minimum 20; maximum 100.

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 show_cache_node_info(&self) -> Option<bool>

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) -> Option<bool>

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 DescribeCacheClustersInput

fn clone(&self) -> DescribeCacheClustersInput

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for DescribeCacheClustersInput

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

Formats the value using the given formatter.

impl PartialEq<DescribeCacheClustersInput> for DescribeCacheClustersInput

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

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

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

This method tests for !=.

impl StructuralPartialEq for DescribeCacheClustersInput