AWS SDK for C++  1.8.51
AWS SDK for C++
Public Member Functions | Protected Member Functions | List of all members
Aws::ElastiCache::Model::DescribeReservedCacheNodesRequest Class Reference

#include <DescribeReservedCacheNodesRequest.h>

+ Inheritance diagram for Aws::ElastiCache::Model::DescribeReservedCacheNodesRequest:

Public Member Functions

 DescribeReservedCacheNodesRequest ()
 
virtual const char * GetServiceRequestName () const override
 
Aws::String SerializePayload () const override
 
const Aws::StringGetReservedCacheNodeId () const
 
bool ReservedCacheNodeIdHasBeenSet () const
 
void SetReservedCacheNodeId (const Aws::String &value)
 
void SetReservedCacheNodeId (Aws::String &&value)
 
void SetReservedCacheNodeId (const char *value)
 
DescribeReservedCacheNodesRequestWithReservedCacheNodeId (const Aws::String &value)
 
DescribeReservedCacheNodesRequestWithReservedCacheNodeId (Aws::String &&value)
 
DescribeReservedCacheNodesRequestWithReservedCacheNodeId (const char *value)
 
const Aws::StringGetReservedCacheNodesOfferingId () const
 
bool ReservedCacheNodesOfferingIdHasBeenSet () const
 
void SetReservedCacheNodesOfferingId (const Aws::String &value)
 
void SetReservedCacheNodesOfferingId (Aws::String &&value)
 
void SetReservedCacheNodesOfferingId (const char *value)
 
DescribeReservedCacheNodesRequestWithReservedCacheNodesOfferingId (const Aws::String &value)
 
DescribeReservedCacheNodesRequestWithReservedCacheNodesOfferingId (Aws::String &&value)
 
DescribeReservedCacheNodesRequestWithReservedCacheNodesOfferingId (const char *value)
 
const Aws::StringGetCacheNodeType () const
 
bool CacheNodeTypeHasBeenSet () const
 
void SetCacheNodeType (const Aws::String &value)
 
void SetCacheNodeType (Aws::String &&value)
 
void SetCacheNodeType (const char *value)
 
DescribeReservedCacheNodesRequestWithCacheNodeType (const Aws::String &value)
 
DescribeReservedCacheNodesRequestWithCacheNodeType (Aws::String &&value)
 
DescribeReservedCacheNodesRequestWithCacheNodeType (const char *value)
 
const Aws::StringGetDuration () const
 
bool DurationHasBeenSet () const
 
void SetDuration (const Aws::String &value)
 
void SetDuration (Aws::String &&value)
 
void SetDuration (const char *value)
 
DescribeReservedCacheNodesRequestWithDuration (const Aws::String &value)
 
DescribeReservedCacheNodesRequestWithDuration (Aws::String &&value)
 
DescribeReservedCacheNodesRequestWithDuration (const char *value)
 
const Aws::StringGetProductDescription () const
 
bool ProductDescriptionHasBeenSet () const
 
void SetProductDescription (const Aws::String &value)
 
void SetProductDescription (Aws::String &&value)
 
void SetProductDescription (const char *value)
 
DescribeReservedCacheNodesRequestWithProductDescription (const Aws::String &value)
 
DescribeReservedCacheNodesRequestWithProductDescription (Aws::String &&value)
 
DescribeReservedCacheNodesRequestWithProductDescription (const char *value)
 
const Aws::StringGetOfferingType () const
 
bool OfferingTypeHasBeenSet () const
 
void SetOfferingType (const Aws::String &value)
 
void SetOfferingType (Aws::String &&value)
 
void SetOfferingType (const char *value)
 
DescribeReservedCacheNodesRequestWithOfferingType (const Aws::String &value)
 
DescribeReservedCacheNodesRequestWithOfferingType (Aws::String &&value)
 
DescribeReservedCacheNodesRequestWithOfferingType (const char *value)
 
int GetMaxRecords () const
 
bool MaxRecordsHasBeenSet () const
 
void SetMaxRecords (int value)
 
DescribeReservedCacheNodesRequestWithMaxRecords (int value)
 
const Aws::StringGetMarker () const
 
bool MarkerHasBeenSet () const
 
void SetMarker (const Aws::String &value)
 
void SetMarker (Aws::String &&value)
 
void SetMarker (const char *value)
 
DescribeReservedCacheNodesRequestWithMarker (const Aws::String &value)
 
DescribeReservedCacheNodesRequestWithMarker (Aws::String &&value)
 
DescribeReservedCacheNodesRequestWithMarker (const char *value)
 
- Public Member Functions inherited from Aws::ElastiCache::ElastiCacheRequest
virtual ~ElastiCacheRequest ()
 
void AddParametersToRequest (Aws::Http::HttpRequest &httpRequest) const
 
Aws::Http::HeaderValueCollection GetHeaders () const override
 
- Public Member Functions inherited from Aws::AmazonSerializableWebServiceRequest
 AmazonSerializableWebServiceRequest ()
 
virtual ~AmazonSerializableWebServiceRequest ()
 
std::shared_ptr< Aws::IOStreamGetBody () const override
 
- Public Member Functions inherited from Aws::AmazonWebServiceRequest
 AmazonWebServiceRequest ()
 
virtual ~AmazonWebServiceRequest ()=default
 
virtual void AddQueryStringParameters (Aws::Http::URI &uri) const
 
virtual void PutToPresignedUrl (Aws::Http::URI &uri) const
 
virtual bool IsStreaming () const
 
virtual bool IsEventStreamRequest () const
 
virtual bool SignBody () const
 
virtual bool IsChunked () const
 
virtual void SetRequestSignedHandler (const RequestSignedHandler &handler)
 
virtual const RequestSignedHandlerGetRequestSignedHandler () const
 
const Aws::IOStreamFactoryGetResponseStreamFactory () const
 
void SetResponseStreamFactory (const Aws::IOStreamFactory &factory)
 
virtual void SetDataReceivedEventHandler (const Aws::Http::DataReceivedEventHandler &dataReceivedEventHandler)
 
virtual void SetDataSentEventHandler (const Aws::Http::DataSentEventHandler &dataSentEventHandler)
 
virtual void SetContinueRequestHandler (const Aws::Http::ContinueRequestHandler &continueRequestHandler)
 
virtual void SetDataReceivedEventHandler (Aws::Http::DataReceivedEventHandler &&dataReceivedEventHandler)
 
virtual void SetDataSentEventHandler (Aws::Http::DataSentEventHandler &&dataSentEventHandler)
 
virtual void SetContinueRequestHandler (Aws::Http::ContinueRequestHandler &&continueRequestHandler)
 
virtual void SetRequestRetryHandler (const RequestRetryHandler &handler)
 
virtual void SetRequestRetryHandler (RequestRetryHandler &&handler)
 
virtual const Aws::Http::DataReceivedEventHandlerGetDataReceivedEventHandler () const
 
virtual const Aws::Http::DataSentEventHandlerGetDataSentEventHandler () const
 
virtual const Aws::Http::ContinueRequestHandlerGetContinueRequestHandler () const
 
virtual const RequestRetryHandlerGetRequestRetryHandler () const
 
virtual bool ShouldComputeContentMd5 () const
 

Protected Member Functions

void DumpBodyToUrl (Aws::Http::URI &uri) const override
 
- Protected Member Functions inherited from Aws::ElastiCache::ElastiCacheRequest
virtual Aws::Http::HeaderValueCollection GetRequestSpecificHeaders () const
 

Detailed Description

Represents the input of a DescribeReservedCacheNodes operation.

See Also:

AWS API Reference

Definition at line 25 of file DescribeReservedCacheNodesRequest.h.

Constructor & Destructor Documentation

◆ DescribeReservedCacheNodesRequest()

Aws::ElastiCache::Model::DescribeReservedCacheNodesRequest::DescribeReservedCacheNodesRequest ( )

Member Function Documentation

◆ CacheNodeTypeHasBeenSet()

bool Aws::ElastiCache::Model::DescribeReservedCacheNodesRequest::CacheNodeTypeHasBeenSet ( ) const
inline

The cache node type filter value. Use this parameter to show only those reservations matching the specified cache node type.

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.

  • General purpose:

    • Current generation:

      M5 node types: cache.m5.large, cache.m5.xlarge, cache.m5.2xlarge, cache.m5.4xlarge, cache.m5.12xlarge, cache.m5.24xlarge

      M4 node types: cache.m4.large, cache.m4.xlarge, cache.m4.2xlarge, cache.m4.4xlarge, cache.m4.10xlarge

      T3 node types: cache.t3.micro, cache.t3.small, cache.t3.medium

      T2 node types: cache.t2.micro, cache.t2.small, cache.t2.medium

    • Previous generation: (not recommended)

      T1 node types: cache.t1.micro

      M1 node types: cache.m1.small, cache.m1.medium, cache.m1.large, cache.m1.xlarge

      M3 node types: cache.m3.medium, cache.m3.large, cache.m3.xlarge, cache.m3.2xlarge

  • Compute optimized:

    • Previous generation: (not recommended)

      C1 node types: cache.c1.xlarge

  • Memory optimized:

    • Current generation:

      R5 node types: cache.r5.large, cache.r5.xlarge, cache.r5.2xlarge, cache.r5.4xlarge, cache.r5.12xlarge, cache.r5.24xlarge

      R4 node types: cache.r4.large, cache.r4.xlarge, cache.r4.2xlarge, cache.r4.4xlarge, cache.r4.8xlarge, cache.r4.16xlarge

    • Previous generation: (not recommended)

      M2 node types: cache.m2.xlarge, cache.m2.2xlarge, cache.m2.4xlarge

      R3 node types: cache.r3.large, cache.r3.xlarge, cache.r3.2xlarge, cache.r3.4xlarge, cache.r3.8xlarge

Additional node type info

  • All current generation instance types are created in Amazon VPC by default.

  • Redis append-only files (AOF) are not supported for T1 or T2 instances.

  • Redis Multi-AZ with automatic failover is not supported on T1 instances.

  • Redis configuration variables appendonly and appendfsync are not supported on Redis version 2.8.22 and later.

Definition at line 235 of file DescribeReservedCacheNodesRequest.h.

◆ DumpBodyToUrl()

void Aws::ElastiCache::Model::DescribeReservedCacheNodesRequest::DumpBodyToUrl ( Aws::Http::URI uri) const
overrideprotectedvirtual

Default does nothing. Override this to convert what would otherwise be the payload of the request to a query string format.

Reimplemented from Aws::AmazonWebServiceRequest.

◆ DurationHasBeenSet()

bool Aws::ElastiCache::Model::DescribeReservedCacheNodesRequest::DurationHasBeenSet ( ) const
inline

The duration filter value, specified in years or seconds. Use this parameter to show only reservations for this duration.

Valid Values: 1 | 3 | 31536000 | 94608000

Definition at line 538 of file DescribeReservedCacheNodesRequest.h.

◆ GetCacheNodeType()

const Aws::String& Aws::ElastiCache::Model::DescribeReservedCacheNodesRequest::GetCacheNodeType ( ) const
inline

The cache node type filter value. Use this parameter to show only those reservations matching the specified cache node type.

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.

  • General purpose:

    • Current generation:

      M5 node types: cache.m5.large, cache.m5.xlarge, cache.m5.2xlarge, cache.m5.4xlarge, cache.m5.12xlarge, cache.m5.24xlarge

      M4 node types: cache.m4.large, cache.m4.xlarge, cache.m4.2xlarge, cache.m4.4xlarge, cache.m4.10xlarge

      T3 node types: cache.t3.micro, cache.t3.small, cache.t3.medium

      T2 node types: cache.t2.micro, cache.t2.small, cache.t2.medium

    • Previous generation: (not recommended)

      T1 node types: cache.t1.micro

      M1 node types: cache.m1.small, cache.m1.medium, cache.m1.large, cache.m1.xlarge

      M3 node types: cache.m3.medium, cache.m3.large, cache.m3.xlarge, cache.m3.2xlarge

  • Compute optimized:

    • Previous generation: (not recommended)

      C1 node types: cache.c1.xlarge

  • Memory optimized:

    • Current generation:

      R5 node types: cache.r5.large, cache.r5.xlarge, cache.r5.2xlarge, cache.r5.4xlarge, cache.r5.12xlarge, cache.r5.24xlarge

      R4 node types: cache.r4.large, cache.r4.xlarge, cache.r4.2xlarge, cache.r4.4xlarge, cache.r4.8xlarge, cache.r4.16xlarge

    • Previous generation: (not recommended)

      M2 node types: cache.m2.xlarge, cache.m2.2xlarge, cache.m2.4xlarge

      R3 node types: cache.r3.large, cache.r3.xlarge, cache.r3.2xlarge, cache.r3.4xlarge, cache.r3.8xlarge

Additional node type info

  • All current generation instance types are created in Amazon VPC by default.

  • Redis append-only files (AOF) are not supported for T1 or T2 instances.

  • Redis Multi-AZ with automatic failover is not supported on T1 instances.

  • Redis configuration variables appendonly and appendfsync are not supported on Redis version 2.8.22 and later.

Definition at line 187 of file DescribeReservedCacheNodesRequest.h.

◆ GetDuration()

const Aws::String& Aws::ElastiCache::Model::DescribeReservedCacheNodesRequest::GetDuration ( ) const
inline

The duration filter value, specified in years or seconds. Use this parameter to show only reservations for this duration.

Valid Values: 1 | 3 | 31536000 | 94608000

Definition at line 531 of file DescribeReservedCacheNodesRequest.h.

◆ GetMarker()

const Aws::String& Aws::ElastiCache::Model::DescribeReservedCacheNodesRequest::GetMarker ( ) const
inline

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.

Definition at line 728 of file DescribeReservedCacheNodesRequest.h.

◆ GetMaxRecords()

int Aws::ElastiCache::Model::DescribeReservedCacheNodesRequest::GetMaxRecords ( ) const
inline

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.

Definition at line 695 of file DescribeReservedCacheNodesRequest.h.

◆ GetOfferingType()

const Aws::String& Aws::ElastiCache::Model::DescribeReservedCacheNodesRequest::GetOfferingType ( ) const
inline

The offering type filter value. Use this parameter to show only the available offerings matching the specified offering type.

Valid values: "Light Utilization"|"Medium Utilization"|"Heavy Utilization"

Definition at line 637 of file DescribeReservedCacheNodesRequest.h.

◆ GetProductDescription()

const Aws::String& Aws::ElastiCache::Model::DescribeReservedCacheNodesRequest::GetProductDescription ( ) const
inline

The product description filter value. Use this parameter to show only those reservations matching the specified product description.

Definition at line 587 of file DescribeReservedCacheNodesRequest.h.

◆ GetReservedCacheNodeId()

const Aws::String& Aws::ElastiCache::Model::DescribeReservedCacheNodesRequest::GetReservedCacheNodeId ( ) const
inline

The reserved cache node identifier filter value. Use this parameter to show only the reservation that matches the specified reservation ID.

Definition at line 47 of file DescribeReservedCacheNodesRequest.h.

◆ GetReservedCacheNodesOfferingId()

const Aws::String& Aws::ElastiCache::Model::DescribeReservedCacheNodesRequest::GetReservedCacheNodesOfferingId ( ) const
inline

The offering identifier filter value. Use this parameter to show only purchased reservations matching the specified offering identifier.

Definition at line 96 of file DescribeReservedCacheNodesRequest.h.

◆ GetServiceRequestName()

virtual const char* Aws::ElastiCache::Model::DescribeReservedCacheNodesRequest::GetServiceRequestName ( ) const
inlineoverridevirtual

Implements Aws::AmazonWebServiceRequest.

Definition at line 34 of file DescribeReservedCacheNodesRequest.h.

◆ MarkerHasBeenSet()

bool Aws::ElastiCache::Model::DescribeReservedCacheNodesRequest::MarkerHasBeenSet ( ) const
inline

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.

Definition at line 736 of file DescribeReservedCacheNodesRequest.h.

◆ MaxRecordsHasBeenSet()

bool Aws::ElastiCache::Model::DescribeReservedCacheNodesRequest::MaxRecordsHasBeenSet ( ) const
inline

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.

Definition at line 703 of file DescribeReservedCacheNodesRequest.h.

◆ OfferingTypeHasBeenSet()

bool Aws::ElastiCache::Model::DescribeReservedCacheNodesRequest::OfferingTypeHasBeenSet ( ) const
inline

The offering type filter value. Use this parameter to show only the available offerings matching the specified offering type.

Valid values: "Light Utilization"|"Medium Utilization"|"Heavy Utilization"

Definition at line 644 of file DescribeReservedCacheNodesRequest.h.

◆ ProductDescriptionHasBeenSet()

bool Aws::ElastiCache::Model::DescribeReservedCacheNodesRequest::ProductDescriptionHasBeenSet ( ) const
inline

The product description filter value. Use this parameter to show only those reservations matching the specified product description.

Definition at line 593 of file DescribeReservedCacheNodesRequest.h.

◆ ReservedCacheNodeIdHasBeenSet()

bool Aws::ElastiCache::Model::DescribeReservedCacheNodesRequest::ReservedCacheNodeIdHasBeenSet ( ) const
inline

The reserved cache node identifier filter value. Use this parameter to show only the reservation that matches the specified reservation ID.

Definition at line 53 of file DescribeReservedCacheNodesRequest.h.

◆ ReservedCacheNodesOfferingIdHasBeenSet()

bool Aws::ElastiCache::Model::DescribeReservedCacheNodesRequest::ReservedCacheNodesOfferingIdHasBeenSet ( ) const
inline

The offering identifier filter value. Use this parameter to show only purchased reservations matching the specified offering identifier.

Definition at line 102 of file DescribeReservedCacheNodesRequest.h.

◆ SerializePayload()

Aws::String Aws::ElastiCache::Model::DescribeReservedCacheNodesRequest::SerializePayload ( ) const
overridevirtual

Convert payload into String.

Implements Aws::AmazonSerializableWebServiceRequest.

◆ SetCacheNodeType() [1/3]

void Aws::ElastiCache::Model::DescribeReservedCacheNodesRequest::SetCacheNodeType ( const Aws::String value)
inline

The cache node type filter value. Use this parameter to show only those reservations matching the specified cache node type.

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.

  • General purpose:

    • Current generation:

      M5 node types: cache.m5.large, cache.m5.xlarge, cache.m5.2xlarge, cache.m5.4xlarge, cache.m5.12xlarge, cache.m5.24xlarge

      M4 node types: cache.m4.large, cache.m4.xlarge, cache.m4.2xlarge, cache.m4.4xlarge, cache.m4.10xlarge

      T3 node types: cache.t3.micro, cache.t3.small, cache.t3.medium

      T2 node types: cache.t2.micro, cache.t2.small, cache.t2.medium

    • Previous generation: (not recommended)

      T1 node types: cache.t1.micro

      M1 node types: cache.m1.small, cache.m1.medium, cache.m1.large, cache.m1.xlarge

      M3 node types: cache.m3.medium, cache.m3.large, cache.m3.xlarge, cache.m3.2xlarge

  • Compute optimized:

    • Previous generation: (not recommended)

      C1 node types: cache.c1.xlarge

  • Memory optimized:

    • Current generation:

      R5 node types: cache.r5.large, cache.r5.xlarge, cache.r5.2xlarge, cache.r5.4xlarge, cache.r5.12xlarge, cache.r5.24xlarge

      R4 node types: cache.r4.large, cache.r4.xlarge, cache.r4.2xlarge, cache.r4.4xlarge, cache.r4.8xlarge, cache.r4.16xlarge

    • Previous generation: (not recommended)

      M2 node types: cache.m2.xlarge, cache.m2.2xlarge, cache.m2.4xlarge

      R3 node types: cache.r3.large, cache.r3.xlarge, cache.r3.2xlarge, cache.r3.4xlarge, cache.r3.8xlarge

Additional node type info

  • All current generation instance types are created in Amazon VPC by default.

  • Redis append-only files (AOF) are not supported for T1 or T2 instances.

  • Redis Multi-AZ with automatic failover is not supported on T1 instances.

  • Redis configuration variables appendonly and appendfsync are not supported on Redis version 2.8.22 and later.

Definition at line 283 of file DescribeReservedCacheNodesRequest.h.

◆ SetCacheNodeType() [2/3]

void Aws::ElastiCache::Model::DescribeReservedCacheNodesRequest::SetCacheNodeType ( Aws::String &&  value)
inline

The cache node type filter value. Use this parameter to show only those reservations matching the specified cache node type.

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.

  • General purpose:

    • Current generation:

      M5 node types: cache.m5.large, cache.m5.xlarge, cache.m5.2xlarge, cache.m5.4xlarge, cache.m5.12xlarge, cache.m5.24xlarge

      M4 node types: cache.m4.large, cache.m4.xlarge, cache.m4.2xlarge, cache.m4.4xlarge, cache.m4.10xlarge

      T3 node types: cache.t3.micro, cache.t3.small, cache.t3.medium

      T2 node types: cache.t2.micro, cache.t2.small, cache.t2.medium

    • Previous generation: (not recommended)

      T1 node types: cache.t1.micro

      M1 node types: cache.m1.small, cache.m1.medium, cache.m1.large, cache.m1.xlarge

      M3 node types: cache.m3.medium, cache.m3.large, cache.m3.xlarge, cache.m3.2xlarge

  • Compute optimized:

    • Previous generation: (not recommended)

      C1 node types: cache.c1.xlarge

  • Memory optimized:

    • Current generation:

      R5 node types: cache.r5.large, cache.r5.xlarge, cache.r5.2xlarge, cache.r5.4xlarge, cache.r5.12xlarge, cache.r5.24xlarge

      R4 node types: cache.r4.large, cache.r4.xlarge, cache.r4.2xlarge, cache.r4.4xlarge, cache.r4.8xlarge, cache.r4.16xlarge

    • Previous generation: (not recommended)

      M2 node types: cache.m2.xlarge, cache.m2.2xlarge, cache.m2.4xlarge

      R3 node types: cache.r3.large, cache.r3.xlarge, cache.r3.2xlarge, cache.r3.4xlarge, cache.r3.8xlarge

Additional node type info

  • All current generation instance types are created in Amazon VPC by default.

  • Redis append-only files (AOF) are not supported for T1 or T2 instances.

  • Redis Multi-AZ with automatic failover is not supported on T1 instances.

  • Redis configuration variables appendonly and appendfsync are not supported on Redis version 2.8.22 and later.

Definition at line 331 of file DescribeReservedCacheNodesRequest.h.

◆ SetCacheNodeType() [3/3]

void Aws::ElastiCache::Model::DescribeReservedCacheNodesRequest::SetCacheNodeType ( const char *  value)
inline

The cache node type filter value. Use this parameter to show only those reservations matching the specified cache node type.

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.

  • General purpose:

    • Current generation:

      M5 node types: cache.m5.large, cache.m5.xlarge, cache.m5.2xlarge, cache.m5.4xlarge, cache.m5.12xlarge, cache.m5.24xlarge

      M4 node types: cache.m4.large, cache.m4.xlarge, cache.m4.2xlarge, cache.m4.4xlarge, cache.m4.10xlarge

      T3 node types: cache.t3.micro, cache.t3.small, cache.t3.medium

      T2 node types: cache.t2.micro, cache.t2.small, cache.t2.medium

    • Previous generation: (not recommended)

      T1 node types: cache.t1.micro

      M1 node types: cache.m1.small, cache.m1.medium, cache.m1.large, cache.m1.xlarge

      M3 node types: cache.m3.medium, cache.m3.large, cache.m3.xlarge, cache.m3.2xlarge

  • Compute optimized:

    • Previous generation: (not recommended)

      C1 node types: cache.c1.xlarge

  • Memory optimized:

    • Current generation:

      R5 node types: cache.r5.large, cache.r5.xlarge, cache.r5.2xlarge, cache.r5.4xlarge, cache.r5.12xlarge, cache.r5.24xlarge

      R4 node types: cache.r4.large, cache.r4.xlarge, cache.r4.2xlarge, cache.r4.4xlarge, cache.r4.8xlarge, cache.r4.16xlarge

    • Previous generation: (not recommended)

      M2 node types: cache.m2.xlarge, cache.m2.2xlarge, cache.m2.4xlarge

      R3 node types: cache.r3.large, cache.r3.xlarge, cache.r3.2xlarge, cache.r3.4xlarge, cache.r3.8xlarge

Additional node type info

  • All current generation instance types are created in Amazon VPC by default.

  • Redis append-only files (AOF) are not supported for T1 or T2 instances.

  • Redis Multi-AZ with automatic failover is not supported on T1 instances.

  • Redis configuration variables appendonly and appendfsync are not supported on Redis version 2.8.22 and later.

Definition at line 379 of file DescribeReservedCacheNodesRequest.h.

◆ SetDuration() [1/3]

void Aws::ElastiCache::Model::DescribeReservedCacheNodesRequest::SetDuration ( const Aws::String value)
inline

The duration filter value, specified in years or seconds. Use this parameter to show only reservations for this duration.

Valid Values: 1 | 3 | 31536000 | 94608000

Definition at line 545 of file DescribeReservedCacheNodesRequest.h.

◆ SetDuration() [2/3]

void Aws::ElastiCache::Model::DescribeReservedCacheNodesRequest::SetDuration ( Aws::String &&  value)
inline

The duration filter value, specified in years or seconds. Use this parameter to show only reservations for this duration.

Valid Values: 1 | 3 | 31536000 | 94608000

Definition at line 552 of file DescribeReservedCacheNodesRequest.h.

◆ SetDuration() [3/3]

void Aws::ElastiCache::Model::DescribeReservedCacheNodesRequest::SetDuration ( const char *  value)
inline

The duration filter value, specified in years or seconds. Use this parameter to show only reservations for this duration.

Valid Values: 1 | 3 | 31536000 | 94608000

Definition at line 559 of file DescribeReservedCacheNodesRequest.h.

◆ SetMarker() [1/3]

void Aws::ElastiCache::Model::DescribeReservedCacheNodesRequest::SetMarker ( const Aws::String value)
inline

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.

Definition at line 744 of file DescribeReservedCacheNodesRequest.h.

◆ SetMarker() [2/3]

void Aws::ElastiCache::Model::DescribeReservedCacheNodesRequest::SetMarker ( Aws::String &&  value)
inline

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.

Definition at line 752 of file DescribeReservedCacheNodesRequest.h.

◆ SetMarker() [3/3]

void Aws::ElastiCache::Model::DescribeReservedCacheNodesRequest::SetMarker ( const char *  value)
inline

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.

Definition at line 760 of file DescribeReservedCacheNodesRequest.h.

◆ SetMaxRecords()

void Aws::ElastiCache::Model::DescribeReservedCacheNodesRequest::SetMaxRecords ( int  value)
inline

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.

Definition at line 711 of file DescribeReservedCacheNodesRequest.h.

◆ SetOfferingType() [1/3]

void Aws::ElastiCache::Model::DescribeReservedCacheNodesRequest::SetOfferingType ( const Aws::String value)
inline

The offering type filter value. Use this parameter to show only the available offerings matching the specified offering type.

Valid values: "Light Utilization"|"Medium Utilization"|"Heavy Utilization"

Definition at line 651 of file DescribeReservedCacheNodesRequest.h.

◆ SetOfferingType() [2/3]

void Aws::ElastiCache::Model::DescribeReservedCacheNodesRequest::SetOfferingType ( Aws::String &&  value)
inline

The offering type filter value. Use this parameter to show only the available offerings matching the specified offering type.

Valid values: "Light Utilization"|"Medium Utilization"|"Heavy Utilization"

Definition at line 658 of file DescribeReservedCacheNodesRequest.h.

◆ SetOfferingType() [3/3]

void Aws::ElastiCache::Model::DescribeReservedCacheNodesRequest::SetOfferingType ( const char *  value)
inline

The offering type filter value. Use this parameter to show only the available offerings matching the specified offering type.

Valid values: "Light Utilization"|"Medium Utilization"|"Heavy Utilization"

Definition at line 665 of file DescribeReservedCacheNodesRequest.h.

◆ SetProductDescription() [1/3]

void Aws::ElastiCache::Model::DescribeReservedCacheNodesRequest::SetProductDescription ( const Aws::String value)
inline

The product description filter value. Use this parameter to show only those reservations matching the specified product description.

Definition at line 599 of file DescribeReservedCacheNodesRequest.h.

◆ SetProductDescription() [2/3]

void Aws::ElastiCache::Model::DescribeReservedCacheNodesRequest::SetProductDescription ( Aws::String &&  value)
inline

The product description filter value. Use this parameter to show only those reservations matching the specified product description.

Definition at line 605 of file DescribeReservedCacheNodesRequest.h.

◆ SetProductDescription() [3/3]

void Aws::ElastiCache::Model::DescribeReservedCacheNodesRequest::SetProductDescription ( const char *  value)
inline

The product description filter value. Use this parameter to show only those reservations matching the specified product description.

Definition at line 611 of file DescribeReservedCacheNodesRequest.h.

◆ SetReservedCacheNodeId() [1/3]

void Aws::ElastiCache::Model::DescribeReservedCacheNodesRequest::SetReservedCacheNodeId ( const Aws::String value)
inline

The reserved cache node identifier filter value. Use this parameter to show only the reservation that matches the specified reservation ID.

Definition at line 59 of file DescribeReservedCacheNodesRequest.h.

◆ SetReservedCacheNodeId() [2/3]

void Aws::ElastiCache::Model::DescribeReservedCacheNodesRequest::SetReservedCacheNodeId ( Aws::String &&  value)
inline

The reserved cache node identifier filter value. Use this parameter to show only the reservation that matches the specified reservation ID.

Definition at line 65 of file DescribeReservedCacheNodesRequest.h.

◆ SetReservedCacheNodeId() [3/3]

void Aws::ElastiCache::Model::DescribeReservedCacheNodesRequest::SetReservedCacheNodeId ( const char *  value)
inline

The reserved cache node identifier filter value. Use this parameter to show only the reservation that matches the specified reservation ID.

Definition at line 71 of file DescribeReservedCacheNodesRequest.h.

◆ SetReservedCacheNodesOfferingId() [1/3]

void Aws::ElastiCache::Model::DescribeReservedCacheNodesRequest::SetReservedCacheNodesOfferingId ( const Aws::String value)
inline

The offering identifier filter value. Use this parameter to show only purchased reservations matching the specified offering identifier.

Definition at line 108 of file DescribeReservedCacheNodesRequest.h.

◆ SetReservedCacheNodesOfferingId() [2/3]

void Aws::ElastiCache::Model::DescribeReservedCacheNodesRequest::SetReservedCacheNodesOfferingId ( Aws::String &&  value)
inline

The offering identifier filter value. Use this parameter to show only purchased reservations matching the specified offering identifier.

Definition at line 114 of file DescribeReservedCacheNodesRequest.h.

◆ SetReservedCacheNodesOfferingId() [3/3]

void Aws::ElastiCache::Model::DescribeReservedCacheNodesRequest::SetReservedCacheNodesOfferingId ( const char *  value)
inline

The offering identifier filter value. Use this parameter to show only purchased reservations matching the specified offering identifier.

Definition at line 120 of file DescribeReservedCacheNodesRequest.h.

◆ WithCacheNodeType() [1/3]

DescribeReservedCacheNodesRequest& Aws::ElastiCache::Model::DescribeReservedCacheNodesRequest::WithCacheNodeType ( const Aws::String value)
inline

The cache node type filter value. Use this parameter to show only those reservations matching the specified cache node type.

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.

  • General purpose:

    • Current generation:

      M5 node types: cache.m5.large, cache.m5.xlarge, cache.m5.2xlarge, cache.m5.4xlarge, cache.m5.12xlarge, cache.m5.24xlarge

      M4 node types: cache.m4.large, cache.m4.xlarge, cache.m4.2xlarge, cache.m4.4xlarge, cache.m4.10xlarge

      T3 node types: cache.t3.micro, cache.t3.small, cache.t3.medium

      T2 node types: cache.t2.micro, cache.t2.small, cache.t2.medium

    • Previous generation: (not recommended)

      T1 node types: cache.t1.micro

      M1 node types: cache.m1.small, cache.m1.medium, cache.m1.large, cache.m1.xlarge

      M3 node types: cache.m3.medium, cache.m3.large, cache.m3.xlarge, cache.m3.2xlarge

  • Compute optimized:

    • Previous generation: (not recommended)

      C1 node types: cache.c1.xlarge

  • Memory optimized:

    • Current generation:

      R5 node types: cache.r5.large, cache.r5.xlarge, cache.r5.2xlarge, cache.r5.4xlarge, cache.r5.12xlarge, cache.r5.24xlarge

      R4 node types: cache.r4.large, cache.r4.xlarge, cache.r4.2xlarge, cache.r4.4xlarge, cache.r4.8xlarge, cache.r4.16xlarge

    • Previous generation: (not recommended)

      M2 node types: cache.m2.xlarge, cache.m2.2xlarge, cache.m2.4xlarge

      R3 node types: cache.r3.large, cache.r3.xlarge, cache.r3.2xlarge, cache.r3.4xlarge, cache.r3.8xlarge

Additional node type info

  • All current generation instance types are created in Amazon VPC by default.

  • Redis append-only files (AOF) are not supported for T1 or T2 instances.

  • Redis Multi-AZ with automatic failover is not supported on T1 instances.

  • Redis configuration variables appendonly and appendfsync are not supported on Redis version 2.8.22 and later.

Definition at line 427 of file DescribeReservedCacheNodesRequest.h.

◆ WithCacheNodeType() [2/3]

DescribeReservedCacheNodesRequest& Aws::ElastiCache::Model::DescribeReservedCacheNodesRequest::WithCacheNodeType ( Aws::String &&  value)
inline

The cache node type filter value. Use this parameter to show only those reservations matching the specified cache node type.

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.

  • General purpose:

    • Current generation:

      M5 node types: cache.m5.large, cache.m5.xlarge, cache.m5.2xlarge, cache.m5.4xlarge, cache.m5.12xlarge, cache.m5.24xlarge

      M4 node types: cache.m4.large, cache.m4.xlarge, cache.m4.2xlarge, cache.m4.4xlarge, cache.m4.10xlarge

      T3 node types: cache.t3.micro, cache.t3.small, cache.t3.medium

      T2 node types: cache.t2.micro, cache.t2.small, cache.t2.medium

    • Previous generation: (not recommended)

      T1 node types: cache.t1.micro

      M1 node types: cache.m1.small, cache.m1.medium, cache.m1.large, cache.m1.xlarge

      M3 node types: cache.m3.medium, cache.m3.large, cache.m3.xlarge, cache.m3.2xlarge

  • Compute optimized:

    • Previous generation: (not recommended)

      C1 node types: cache.c1.xlarge

  • Memory optimized:

    • Current generation:

      R5 node types: cache.r5.large, cache.r5.xlarge, cache.r5.2xlarge, cache.r5.4xlarge, cache.r5.12xlarge, cache.r5.24xlarge

      R4 node types: cache.r4.large, cache.r4.xlarge, cache.r4.2xlarge, cache.r4.4xlarge, cache.r4.8xlarge, cache.r4.16xlarge

    • Previous generation: (not recommended)

      M2 node types: cache.m2.xlarge, cache.m2.2xlarge, cache.m2.4xlarge

      R3 node types: cache.r3.large, cache.r3.xlarge, cache.r3.2xlarge, cache.r3.4xlarge, cache.r3.8xlarge

Additional node type info

  • All current generation instance types are created in Amazon VPC by default.

  • Redis append-only files (AOF) are not supported for T1 or T2 instances.

  • Redis Multi-AZ with automatic failover is not supported on T1 instances.

  • Redis configuration variables appendonly and appendfsync are not supported on Redis version 2.8.22 and later.

Definition at line 475 of file DescribeReservedCacheNodesRequest.h.

◆ WithCacheNodeType() [3/3]

DescribeReservedCacheNodesRequest& Aws::ElastiCache::Model::DescribeReservedCacheNodesRequest::WithCacheNodeType ( const char *  value)
inline

The cache node type filter value. Use this parameter to show only those reservations matching the specified cache node type.

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.

  • General purpose:

    • Current generation:

      M5 node types: cache.m5.large, cache.m5.xlarge, cache.m5.2xlarge, cache.m5.4xlarge, cache.m5.12xlarge, cache.m5.24xlarge

      M4 node types: cache.m4.large, cache.m4.xlarge, cache.m4.2xlarge, cache.m4.4xlarge, cache.m4.10xlarge

      T3 node types: cache.t3.micro, cache.t3.small, cache.t3.medium

      T2 node types: cache.t2.micro, cache.t2.small, cache.t2.medium

    • Previous generation: (not recommended)

      T1 node types: cache.t1.micro

      M1 node types: cache.m1.small, cache.m1.medium, cache.m1.large, cache.m1.xlarge

      M3 node types: cache.m3.medium, cache.m3.large, cache.m3.xlarge, cache.m3.2xlarge

  • Compute optimized:

    • Previous generation: (not recommended)

      C1 node types: cache.c1.xlarge

  • Memory optimized:

    • Current generation:

      R5 node types: cache.r5.large, cache.r5.xlarge, cache.r5.2xlarge, cache.r5.4xlarge, cache.r5.12xlarge, cache.r5.24xlarge

      R4 node types: cache.r4.large, cache.r4.xlarge, cache.r4.2xlarge, cache.r4.4xlarge, cache.r4.8xlarge, cache.r4.16xlarge

    • Previous generation: (not recommended)

      M2 node types: cache.m2.xlarge, cache.m2.2xlarge, cache.m2.4xlarge

      R3 node types: cache.r3.large, cache.r3.xlarge, cache.r3.2xlarge, cache.r3.4xlarge, cache.r3.8xlarge

Additional node type info

  • All current generation instance types are created in Amazon VPC by default.

  • Redis append-only files (AOF) are not supported for T1 or T2 instances.

  • Redis Multi-AZ with automatic failover is not supported on T1 instances.

  • Redis configuration variables appendonly and appendfsync are not supported on Redis version 2.8.22 and later.

Definition at line 523 of file DescribeReservedCacheNodesRequest.h.

◆ WithDuration() [1/3]

DescribeReservedCacheNodesRequest& Aws::ElastiCache::Model::DescribeReservedCacheNodesRequest::WithDuration ( const Aws::String value)
inline

The duration filter value, specified in years or seconds. Use this parameter to show only reservations for this duration.

Valid Values: 1 | 3 | 31536000 | 94608000

Definition at line 566 of file DescribeReservedCacheNodesRequest.h.

◆ WithDuration() [2/3]

DescribeReservedCacheNodesRequest& Aws::ElastiCache::Model::DescribeReservedCacheNodesRequest::WithDuration ( Aws::String &&  value)
inline

The duration filter value, specified in years or seconds. Use this parameter to show only reservations for this duration.

Valid Values: 1 | 3 | 31536000 | 94608000

Definition at line 573 of file DescribeReservedCacheNodesRequest.h.

◆ WithDuration() [3/3]

DescribeReservedCacheNodesRequest& Aws::ElastiCache::Model::DescribeReservedCacheNodesRequest::WithDuration ( const char *  value)
inline

The duration filter value, specified in years or seconds. Use this parameter to show only reservations for this duration.

Valid Values: 1 | 3 | 31536000 | 94608000

Definition at line 580 of file DescribeReservedCacheNodesRequest.h.

◆ WithMarker() [1/3]

DescribeReservedCacheNodesRequest& Aws::ElastiCache::Model::DescribeReservedCacheNodesRequest::WithMarker ( const Aws::String value)
inline

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.

Definition at line 768 of file DescribeReservedCacheNodesRequest.h.

◆ WithMarker() [2/3]

DescribeReservedCacheNodesRequest& Aws::ElastiCache::Model::DescribeReservedCacheNodesRequest::WithMarker ( Aws::String &&  value)
inline

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.

Definition at line 776 of file DescribeReservedCacheNodesRequest.h.

◆ WithMarker() [3/3]

DescribeReservedCacheNodesRequest& Aws::ElastiCache::Model::DescribeReservedCacheNodesRequest::WithMarker ( const char *  value)
inline

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.

Definition at line 784 of file DescribeReservedCacheNodesRequest.h.

◆ WithMaxRecords()

DescribeReservedCacheNodesRequest& Aws::ElastiCache::Model::DescribeReservedCacheNodesRequest::WithMaxRecords ( int  value)
inline

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.

Definition at line 719 of file DescribeReservedCacheNodesRequest.h.

◆ WithOfferingType() [1/3]

DescribeReservedCacheNodesRequest& Aws::ElastiCache::Model::DescribeReservedCacheNodesRequest::WithOfferingType ( const Aws::String value)
inline

The offering type filter value. Use this parameter to show only the available offerings matching the specified offering type.

Valid values: "Light Utilization"|"Medium Utilization"|"Heavy Utilization"

Definition at line 672 of file DescribeReservedCacheNodesRequest.h.

◆ WithOfferingType() [2/3]

DescribeReservedCacheNodesRequest& Aws::ElastiCache::Model::DescribeReservedCacheNodesRequest::WithOfferingType ( Aws::String &&  value)
inline

The offering type filter value. Use this parameter to show only the available offerings matching the specified offering type.

Valid values: "Light Utilization"|"Medium Utilization"|"Heavy Utilization"

Definition at line 679 of file DescribeReservedCacheNodesRequest.h.

◆ WithOfferingType() [3/3]

DescribeReservedCacheNodesRequest& Aws::ElastiCache::Model::DescribeReservedCacheNodesRequest::WithOfferingType ( const char *  value)
inline

The offering type filter value. Use this parameter to show only the available offerings matching the specified offering type.

Valid values: "Light Utilization"|"Medium Utilization"|"Heavy Utilization"

Definition at line 686 of file DescribeReservedCacheNodesRequest.h.

◆ WithProductDescription() [1/3]

DescribeReservedCacheNodesRequest& Aws::ElastiCache::Model::DescribeReservedCacheNodesRequest::WithProductDescription ( const Aws::String value)
inline

The product description filter value. Use this parameter to show only those reservations matching the specified product description.

Definition at line 617 of file DescribeReservedCacheNodesRequest.h.

◆ WithProductDescription() [2/3]

DescribeReservedCacheNodesRequest& Aws::ElastiCache::Model::DescribeReservedCacheNodesRequest::WithProductDescription ( Aws::String &&  value)
inline

The product description filter value. Use this parameter to show only those reservations matching the specified product description.

Definition at line 623 of file DescribeReservedCacheNodesRequest.h.

◆ WithProductDescription() [3/3]

DescribeReservedCacheNodesRequest& Aws::ElastiCache::Model::DescribeReservedCacheNodesRequest::WithProductDescription ( const char *  value)
inline

The product description filter value. Use this parameter to show only those reservations matching the specified product description.

Definition at line 629 of file DescribeReservedCacheNodesRequest.h.

◆ WithReservedCacheNodeId() [1/3]

DescribeReservedCacheNodesRequest& Aws::ElastiCache::Model::DescribeReservedCacheNodesRequest::WithReservedCacheNodeId ( const Aws::String value)
inline

The reserved cache node identifier filter value. Use this parameter to show only the reservation that matches the specified reservation ID.

Definition at line 77 of file DescribeReservedCacheNodesRequest.h.

◆ WithReservedCacheNodeId() [2/3]

DescribeReservedCacheNodesRequest& Aws::ElastiCache::Model::DescribeReservedCacheNodesRequest::WithReservedCacheNodeId ( Aws::String &&  value)
inline

The reserved cache node identifier filter value. Use this parameter to show only the reservation that matches the specified reservation ID.

Definition at line 83 of file DescribeReservedCacheNodesRequest.h.

◆ WithReservedCacheNodeId() [3/3]

DescribeReservedCacheNodesRequest& Aws::ElastiCache::Model::DescribeReservedCacheNodesRequest::WithReservedCacheNodeId ( const char *  value)
inline

The reserved cache node identifier filter value. Use this parameter to show only the reservation that matches the specified reservation ID.

Definition at line 89 of file DescribeReservedCacheNodesRequest.h.

◆ WithReservedCacheNodesOfferingId() [1/3]

DescribeReservedCacheNodesRequest& Aws::ElastiCache::Model::DescribeReservedCacheNodesRequest::WithReservedCacheNodesOfferingId ( const Aws::String value)
inline

The offering identifier filter value. Use this parameter to show only purchased reservations matching the specified offering identifier.

Definition at line 126 of file DescribeReservedCacheNodesRequest.h.

◆ WithReservedCacheNodesOfferingId() [2/3]

DescribeReservedCacheNodesRequest& Aws::ElastiCache::Model::DescribeReservedCacheNodesRequest::WithReservedCacheNodesOfferingId ( Aws::String &&  value)
inline

The offering identifier filter value. Use this parameter to show only purchased reservations matching the specified offering identifier.

Definition at line 132 of file DescribeReservedCacheNodesRequest.h.

◆ WithReservedCacheNodesOfferingId() [3/3]

DescribeReservedCacheNodesRequest& Aws::ElastiCache::Model::DescribeReservedCacheNodesRequest::WithReservedCacheNodesOfferingId ( const char *  value)
inline

The offering identifier filter value. Use this parameter to show only purchased reservations matching the specified offering identifier.

Definition at line 138 of file DescribeReservedCacheNodesRequest.h.


The documentation for this class was generated from the following file: