aws_sdk_elasticache/client/

describe_reserved_cache_nodes.rs

// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
impl super::Client {
    /// Constructs a fluent builder for the [`DescribeReservedCacheNodes`](crate::operation::describe_reserved_cache_nodes::builders::DescribeReservedCacheNodesFluentBuilder) operation.
    /// This operation supports pagination; See [`into_paginator()`](crate::operation::describe_reserved_cache_nodes::builders::DescribeReservedCacheNodesFluentBuilder::into_paginator).
    ///
    /// - The fluent builder is configurable:
    ///   - [`reserved_cache_node_id(impl Into<String>)`](crate::operation::describe_reserved_cache_nodes::builders::DescribeReservedCacheNodesFluentBuilder::reserved_cache_node_id) / [`set_reserved_cache_node_id(Option<String>)`](crate::operation::describe_reserved_cache_nodes::builders::DescribeReservedCacheNodesFluentBuilder::set_reserved_cache_node_id):<br>required: **false**<br><p>The reserved cache node identifier filter value. Use this parameter to show only the reservation that matches the specified reservation ID.</p><br>
    ///   - [`reserved_cache_nodes_offering_id(impl Into<String>)`](crate::operation::describe_reserved_cache_nodes::builders::DescribeReservedCacheNodesFluentBuilder::reserved_cache_nodes_offering_id) / [`set_reserved_cache_nodes_offering_id(Option<String>)`](crate::operation::describe_reserved_cache_nodes::builders::DescribeReservedCacheNodesFluentBuilder::set_reserved_cache_nodes_offering_id):<br>required: **false**<br><p>The offering identifier filter value. Use this parameter to show only purchased reservations matching the specified offering identifier.</p><br>
    ///   - [`cache_node_type(impl Into<String>)`](crate::operation::describe_reserved_cache_nodes::builders::DescribeReservedCacheNodesFluentBuilder::cache_node_type) / [`set_cache_node_type(Option<String>)`](crate::operation::describe_reserved_cache_nodes::builders::DescribeReservedCacheNodesFluentBuilder::set_cache_node_type):<br>required: **false**<br><p>The cache node type filter value. Use this parameter to show only those reservations matching the specified cache node type.</p> <p>The following node types are supported by ElastiCache. Generally speaking, the current generation types provide more memory and computational power at lower cost when compared to their equivalent previous generation counterparts.</p> <ul>  <li>   <p>General purpose:</p>   <ul>    <li>     <p>Current generation:</p>     <p><b>M7g node types</b>: <code>cache.m7g.large</code>, <code>cache.m7g.xlarge</code>, <code>cache.m7g.2xlarge</code>, <code>cache.m7g.4xlarge</code>, <code>cache.m7g.8xlarge</code>, <code>cache.m7g.12xlarge</code>, <code>cache.m7g.16xlarge</code></p><note>      <p>For region availability, see <a href="https://docs.aws.amazon.com/AmazonElastiCache/latest/dg/CacheNodes.SupportedTypes.html#CacheNodes.SupportedTypesByRegion">Supported Node Types</a></p>     </note>     <p><b>M6g node types</b> (available only for Redis OSS engine version 5.0.6 onward and for Memcached engine version 1.5.16 onward): <code>cache.m6g.large</code>, <code>cache.m6g.xlarge</code>, <code>cache.m6g.2xlarge</code>, <code>cache.m6g.4xlarge</code>, <code>cache.m6g.8xlarge</code>, <code>cache.m6g.12xlarge</code>, <code>cache.m6g.16xlarge</code></p>     <p><b>M5 node types:</b> <code>cache.m5.large</code>, <code>cache.m5.xlarge</code>, <code>cache.m5.2xlarge</code>, <code>cache.m5.4xlarge</code>, <code>cache.m5.12xlarge</code>, <code>cache.m5.24xlarge</code></p>     <p><b>M4 node types:</b> <code>cache.m4.large</code>, <code>cache.m4.xlarge</code>, <code>cache.m4.2xlarge</code>, <code>cache.m4.4xlarge</code>, <code>cache.m4.10xlarge</code></p>     <p><b>T4g node types</b> (available only for Redis OSS engine version 5.0.6 onward and Memcached engine version 1.5.16 onward): <code>cache.t4g.micro</code>, <code>cache.t4g.small</code>, <code>cache.t4g.medium</code></p>     <p><b>T3 node types:</b> <code>cache.t3.micro</code>, <code>cache.t3.small</code>, <code>cache.t3.medium</code></p>     <p><b>T2 node types:</b> <code>cache.t2.micro</code>, <code>cache.t2.small</code>, <code>cache.t2.medium</code></p></li>    <li>     <p>Previous generation: (not recommended. Existing clusters are still supported but creation of new clusters is not supported for these types.)</p>     <p><b>T1 node types:</b> <code>cache.t1.micro</code></p>     <p><b>M1 node types:</b> <code>cache.m1.small</code>, <code>cache.m1.medium</code>, <code>cache.m1.large</code>, <code>cache.m1.xlarge</code></p>     <p><b>M3 node types:</b> <code>cache.m3.medium</code>, <code>cache.m3.large</code>, <code>cache.m3.xlarge</code>, <code>cache.m3.2xlarge</code></p></li>   </ul></li>  <li>   <p>Compute optimized:</p>   <ul>    <li>     <p>Previous generation: (not recommended. Existing clusters are still supported but creation of new clusters is not supported for these types.)</p>     <p><b>C1 node types:</b> <code>cache.c1.xlarge</code></p></li>   </ul></li>  <li>   <p>Memory optimized:</p>   <ul>    <li>     <p>Current generation:</p>     <p><b>R7g node types</b>: <code>cache.r7g.large</code>, <code>cache.r7g.xlarge</code>, <code>cache.r7g.2xlarge</code>, <code>cache.r7g.4xlarge</code>, <code>cache.r7g.8xlarge</code>, <code>cache.r7g.12xlarge</code>, <code>cache.r7g.16xlarge</code></p><note>      <p>For region availability, see <a href="https://docs.aws.amazon.com/AmazonElastiCache/latest/dg/CacheNodes.SupportedTypes.html#CacheNodes.SupportedTypesByRegion">Supported Node Types</a></p>     </note>     <p><b>R6g node types</b> (available only for Redis OSS engine version 5.0.6 onward and for Memcached engine version 1.5.16 onward): <code>cache.r6g.large</code>, <code>cache.r6g.xlarge</code>, <code>cache.r6g.2xlarge</code>, <code>cache.r6g.4xlarge</code>, <code>cache.r6g.8xlarge</code>, <code>cache.r6g.12xlarge</code>, <code>cache.r6g.16xlarge</code></p>     <p><b>R5 node types:</b> <code>cache.r5.large</code>, <code>cache.r5.xlarge</code>, <code>cache.r5.2xlarge</code>, <code>cache.r5.4xlarge</code>, <code>cache.r5.12xlarge</code>, <code>cache.r5.24xlarge</code></p>     <p><b>R4 node types:</b> <code>cache.r4.large</code>, <code>cache.r4.xlarge</code>, <code>cache.r4.2xlarge</code>, <code>cache.r4.4xlarge</code>, <code>cache.r4.8xlarge</code>, <code>cache.r4.16xlarge</code></p></li>    <li>     <p>Previous generation: (not recommended. Existing clusters are still supported but creation of new clusters is not supported for these types.)</p>     <p><b>M2 node types:</b> <code>cache.m2.xlarge</code>, <code>cache.m2.2xlarge</code>, <code>cache.m2.4xlarge</code></p>     <p><b>R3 node types:</b> <code>cache.r3.large</code>, <code>cache.r3.xlarge</code>, <code>cache.r3.2xlarge</code>, <code>cache.r3.4xlarge</code>, <code>cache.r3.8xlarge</code></p></li>   </ul></li> </ul> <p><b>Additional node type info</b></p> <ul>  <li>   <p>All current generation instance types are created in Amazon VPC by default.</p></li>  <li>   <p>Valkey or Redis OSS append-only files (AOF) are not supported for T1 or T2 instances.</p></li>  <li>   <p>Valkey or Redis OSS Multi-AZ with automatic failover is not supported on T1 instances.</p></li>  <li>   <p>The configuration variables <code>appendonly</code> and <code>appendfsync</code> are not supported on Valkey, or on Redis OSS version 2.8.22 and later.</p></li> </ul><br>
    ///   - [`duration(impl Into<String>)`](crate::operation::describe_reserved_cache_nodes::builders::DescribeReservedCacheNodesFluentBuilder::duration) / [`set_duration(Option<String>)`](crate::operation::describe_reserved_cache_nodes::builders::DescribeReservedCacheNodesFluentBuilder::set_duration):<br>required: **false**<br><p>The duration filter value, specified in years or seconds. Use this parameter to show only reservations for this duration.</p> <p>Valid Values: <code>1 | 3 | 31536000 | 94608000</code></p><br>
    ///   - [`product_description(impl Into<String>)`](crate::operation::describe_reserved_cache_nodes::builders::DescribeReservedCacheNodesFluentBuilder::product_description) / [`set_product_description(Option<String>)`](crate::operation::describe_reserved_cache_nodes::builders::DescribeReservedCacheNodesFluentBuilder::set_product_description):<br>required: **false**<br><p>The product description filter value. Use this parameter to show only those reservations matching the specified product description.</p><br>
    ///   - [`offering_type(impl Into<String>)`](crate::operation::describe_reserved_cache_nodes::builders::DescribeReservedCacheNodesFluentBuilder::offering_type) / [`set_offering_type(Option<String>)`](crate::operation::describe_reserved_cache_nodes::builders::DescribeReservedCacheNodesFluentBuilder::set_offering_type):<br>required: **false**<br><p>The offering type filter value. Use this parameter to show only the available offerings matching the specified offering type.</p> <p>Valid values: <code>"Light Utilization"|"Medium Utilization"|"Heavy Utilization"|"All Upfront"|"Partial Upfront"| "No Upfront"</code></p><br>
    ///   - [`max_records(i32)`](crate::operation::describe_reserved_cache_nodes::builders::DescribeReservedCacheNodesFluentBuilder::max_records) / [`set_max_records(Option<i32>)`](crate::operation::describe_reserved_cache_nodes::builders::DescribeReservedCacheNodesFluentBuilder::set_max_records):<br>required: **false**<br><p>The maximum number of records to include in the response. If more records exist than the specified <code>MaxRecords</code> value, a marker is included in the response so that the remaining results can be retrieved.</p> <p>Default: 100</p> <p>Constraints: minimum 20; maximum 100.</p><br>
    ///   - [`marker(impl Into<String>)`](crate::operation::describe_reserved_cache_nodes::builders::DescribeReservedCacheNodesFluentBuilder::marker) / [`set_marker(Option<String>)`](crate::operation::describe_reserved_cache_nodes::builders::DescribeReservedCacheNodesFluentBuilder::set_marker):<br>required: **false**<br><p>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 <code>MaxRecords</code>.</p><br>
    /// - On success, responds with [`DescribeReservedCacheNodesOutput`](crate::operation::describe_reserved_cache_nodes::DescribeReservedCacheNodesOutput) with field(s):
    ///   - [`marker(Option<String>)`](crate::operation::describe_reserved_cache_nodes::DescribeReservedCacheNodesOutput::marker): <p>Provides an identifier to allow retrieval of paginated results.</p>
    ///   - [`reserved_cache_nodes(Option<Vec::<ReservedCacheNode>>)`](crate::operation::describe_reserved_cache_nodes::DescribeReservedCacheNodesOutput::reserved_cache_nodes): <p>A list of reserved cache nodes. Each element in the list contains detailed information about one node.</p>
    /// - On failure, responds with [`SdkError<DescribeReservedCacheNodesError>`](crate::operation::describe_reserved_cache_nodes::DescribeReservedCacheNodesError)
    pub fn describe_reserved_cache_nodes(
        &self,
    ) -> crate::operation::describe_reserved_cache_nodes::builders::DescribeReservedCacheNodesFluentBuilder {
        crate::operation::describe_reserved_cache_nodes::builders::DescribeReservedCacheNodesFluentBuilder::new(self.handle.clone())
    }
}