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

#include <DescribeCacheEngineVersionsRequest.h>

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

Public Member Functions

 DescribeCacheEngineVersionsRequest ()
 
virtual const char * GetServiceRequestName () const override
 
Aws::String SerializePayload () const override
 
const Aws::StringGetEngine () const
 
bool EngineHasBeenSet () const
 
void SetEngine (const Aws::String &value)
 
void SetEngine (Aws::String &&value)
 
void SetEngine (const char *value)
 
DescribeCacheEngineVersionsRequestWithEngine (const Aws::String &value)
 
DescribeCacheEngineVersionsRequestWithEngine (Aws::String &&value)
 
DescribeCacheEngineVersionsRequestWithEngine (const char *value)
 
const Aws::StringGetEngineVersion () const
 
bool EngineVersionHasBeenSet () const
 
void SetEngineVersion (const Aws::String &value)
 
void SetEngineVersion (Aws::String &&value)
 
void SetEngineVersion (const char *value)
 
DescribeCacheEngineVersionsRequestWithEngineVersion (const Aws::String &value)
 
DescribeCacheEngineVersionsRequestWithEngineVersion (Aws::String &&value)
 
DescribeCacheEngineVersionsRequestWithEngineVersion (const char *value)
 
const Aws::StringGetCacheParameterGroupFamily () const
 
bool CacheParameterGroupFamilyHasBeenSet () const
 
void SetCacheParameterGroupFamily (const Aws::String &value)
 
void SetCacheParameterGroupFamily (Aws::String &&value)
 
void SetCacheParameterGroupFamily (const char *value)
 
DescribeCacheEngineVersionsRequestWithCacheParameterGroupFamily (const Aws::String &value)
 
DescribeCacheEngineVersionsRequestWithCacheParameterGroupFamily (Aws::String &&value)
 
DescribeCacheEngineVersionsRequestWithCacheParameterGroupFamily (const char *value)
 
int GetMaxRecords () const
 
bool MaxRecordsHasBeenSet () const
 
void SetMaxRecords (int value)
 
DescribeCacheEngineVersionsRequestWithMaxRecords (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)
 
DescribeCacheEngineVersionsRequestWithMarker (const Aws::String &value)
 
DescribeCacheEngineVersionsRequestWithMarker (Aws::String &&value)
 
DescribeCacheEngineVersionsRequestWithMarker (const char *value)
 
bool GetDefaultOnly () const
 
bool DefaultOnlyHasBeenSet () const
 
void SetDefaultOnly (bool value)
 
DescribeCacheEngineVersionsRequestWithDefaultOnly (bool 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 DescribeCacheEngineVersions operation.

See Also:

AWS API Reference

Definition at line 25 of file DescribeCacheEngineVersionsRequest.h.

Constructor & Destructor Documentation

◆ DescribeCacheEngineVersionsRequest()

Aws::ElastiCache::Model::DescribeCacheEngineVersionsRequest::DescribeCacheEngineVersionsRequest ( )

Member Function Documentation

◆ CacheParameterGroupFamilyHasBeenSet()

bool Aws::ElastiCache::Model::DescribeCacheEngineVersionsRequest::CacheParameterGroupFamilyHasBeenSet ( ) const
inline

The name of a specific cache parameter group family to return details for.

Valid values are: memcached1.4 | memcached1.5 | redis2.6 | redis2.8 | redis3.2 | redis4.0 | redis5.0 |

Constraints:

  • Must be 1 to 255 alphanumeric characters

  • First character must be a letter

  • Cannot end with a hyphen or contain two consecutive hyphens

Definition at line 153 of file DescribeCacheEngineVersionsRequest.h.

◆ DefaultOnlyHasBeenSet()

bool Aws::ElastiCache::Model::DescribeCacheEngineVersionsRequest::DefaultOnlyHasBeenSet ( ) const
inline

If true, specifies that only the default version of the specified engine or engine and major version combination is to be returned.

Definition at line 330 of file DescribeCacheEngineVersionsRequest.h.

◆ DumpBodyToUrl()

void Aws::ElastiCache::Model::DescribeCacheEngineVersionsRequest::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.

◆ EngineHasBeenSet()

bool Aws::ElastiCache::Model::DescribeCacheEngineVersionsRequest::EngineHasBeenSet ( ) const
inline

The cache engine to return. Valid values: memcached | redis

Definition at line 53 of file DescribeCacheEngineVersionsRequest.h.

◆ EngineVersionHasBeenSet()

bool Aws::ElastiCache::Model::DescribeCacheEngineVersionsRequest::EngineVersionHasBeenSet ( ) const
inline

The cache engine version to return.

Example: 1.4.14

Definition at line 100 of file DescribeCacheEngineVersionsRequest.h.

◆ GetCacheParameterGroupFamily()

const Aws::String& Aws::ElastiCache::Model::DescribeCacheEngineVersionsRequest::GetCacheParameterGroupFamily ( ) const
inline

The name of a specific cache parameter group family to return details for.

Valid values are: memcached1.4 | memcached1.5 | redis2.6 | redis2.8 | redis3.2 | redis4.0 | redis5.0 |

Constraints:

  • Must be 1 to 255 alphanumeric characters

  • First character must be a letter

  • Cannot end with a hyphen or contain two consecutive hyphens

Definition at line 142 of file DescribeCacheEngineVersionsRequest.h.

◆ GetDefaultOnly()

bool Aws::ElastiCache::Model::DescribeCacheEngineVersionsRequest::GetDefaultOnly ( ) const
inline

If true, specifies that only the default version of the specified engine or engine and major version combination is to be returned.

Definition at line 324 of file DescribeCacheEngineVersionsRequest.h.

◆ GetEngine()

const Aws::String& Aws::ElastiCache::Model::DescribeCacheEngineVersionsRequest::GetEngine ( ) const
inline

The cache engine to return. Valid values: memcached | redis

Definition at line 47 of file DescribeCacheEngineVersionsRequest.h.

◆ GetEngineVersion()

const Aws::String& Aws::ElastiCache::Model::DescribeCacheEngineVersionsRequest::GetEngineVersion ( ) const
inline

The cache engine version to return.

Example: 1.4.14

Definition at line 95 of file DescribeCacheEngineVersionsRequest.h.

◆ GetMarker()

const Aws::String& Aws::ElastiCache::Model::DescribeCacheEngineVersionsRequest::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 261 of file DescribeCacheEngineVersionsRequest.h.

◆ GetMaxRecords()

int Aws::ElastiCache::Model::DescribeCacheEngineVersionsRequest::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 228 of file DescribeCacheEngineVersionsRequest.h.

◆ GetServiceRequestName()

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

Implements Aws::AmazonWebServiceRequest.

Definition at line 34 of file DescribeCacheEngineVersionsRequest.h.

◆ MarkerHasBeenSet()

bool Aws::ElastiCache::Model::DescribeCacheEngineVersionsRequest::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 269 of file DescribeCacheEngineVersionsRequest.h.

◆ MaxRecordsHasBeenSet()

bool Aws::ElastiCache::Model::DescribeCacheEngineVersionsRequest::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 236 of file DescribeCacheEngineVersionsRequest.h.

◆ SerializePayload()

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

Convert payload into String.

Implements Aws::AmazonSerializableWebServiceRequest.

◆ SetCacheParameterGroupFamily() [1/3]

void Aws::ElastiCache::Model::DescribeCacheEngineVersionsRequest::SetCacheParameterGroupFamily ( const Aws::String value)
inline

The name of a specific cache parameter group family to return details for.

Valid values are: memcached1.4 | memcached1.5 | redis2.6 | redis2.8 | redis3.2 | redis4.0 | redis5.0 |

Constraints:

  • Must be 1 to 255 alphanumeric characters

  • First character must be a letter

  • Cannot end with a hyphen or contain two consecutive hyphens

Definition at line 164 of file DescribeCacheEngineVersionsRequest.h.

◆ SetCacheParameterGroupFamily() [2/3]

void Aws::ElastiCache::Model::DescribeCacheEngineVersionsRequest::SetCacheParameterGroupFamily ( Aws::String &&  value)
inline

The name of a specific cache parameter group family to return details for.

Valid values are: memcached1.4 | memcached1.5 | redis2.6 | redis2.8 | redis3.2 | redis4.0 | redis5.0 |

Constraints:

  • Must be 1 to 255 alphanumeric characters

  • First character must be a letter

  • Cannot end with a hyphen or contain two consecutive hyphens

Definition at line 175 of file DescribeCacheEngineVersionsRequest.h.

◆ SetCacheParameterGroupFamily() [3/3]

void Aws::ElastiCache::Model::DescribeCacheEngineVersionsRequest::SetCacheParameterGroupFamily ( const char *  value)
inline

The name of a specific cache parameter group family to return details for.

Valid values are: memcached1.4 | memcached1.5 | redis2.6 | redis2.8 | redis3.2 | redis4.0 | redis5.0 |

Constraints:

  • Must be 1 to 255 alphanumeric characters

  • First character must be a letter

  • Cannot end with a hyphen or contain two consecutive hyphens

Definition at line 186 of file DescribeCacheEngineVersionsRequest.h.

◆ SetDefaultOnly()

void Aws::ElastiCache::Model::DescribeCacheEngineVersionsRequest::SetDefaultOnly ( bool  value)
inline

If true, specifies that only the default version of the specified engine or engine and major version combination is to be returned.

Definition at line 336 of file DescribeCacheEngineVersionsRequest.h.

◆ SetEngine() [1/3]

void Aws::ElastiCache::Model::DescribeCacheEngineVersionsRequest::SetEngine ( const Aws::String value)
inline

The cache engine to return. Valid values: memcached | redis

Definition at line 59 of file DescribeCacheEngineVersionsRequest.h.

◆ SetEngine() [2/3]

void Aws::ElastiCache::Model::DescribeCacheEngineVersionsRequest::SetEngine ( Aws::String &&  value)
inline

The cache engine to return. Valid values: memcached | redis

Definition at line 65 of file DescribeCacheEngineVersionsRequest.h.

◆ SetEngine() [3/3]

void Aws::ElastiCache::Model::DescribeCacheEngineVersionsRequest::SetEngine ( const char *  value)
inline

The cache engine to return. Valid values: memcached | redis

Definition at line 71 of file DescribeCacheEngineVersionsRequest.h.

◆ SetEngineVersion() [1/3]

void Aws::ElastiCache::Model::DescribeCacheEngineVersionsRequest::SetEngineVersion ( const Aws::String value)
inline

The cache engine version to return.

Example: 1.4.14

Definition at line 105 of file DescribeCacheEngineVersionsRequest.h.

◆ SetEngineVersion() [2/3]

void Aws::ElastiCache::Model::DescribeCacheEngineVersionsRequest::SetEngineVersion ( Aws::String &&  value)
inline

The cache engine version to return.

Example: 1.4.14

Definition at line 110 of file DescribeCacheEngineVersionsRequest.h.

◆ SetEngineVersion() [3/3]

void Aws::ElastiCache::Model::DescribeCacheEngineVersionsRequest::SetEngineVersion ( const char *  value)
inline

The cache engine version to return.

Example: 1.4.14

Definition at line 115 of file DescribeCacheEngineVersionsRequest.h.

◆ SetMarker() [1/3]

void Aws::ElastiCache::Model::DescribeCacheEngineVersionsRequest::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 277 of file DescribeCacheEngineVersionsRequest.h.

◆ SetMarker() [2/3]

void Aws::ElastiCache::Model::DescribeCacheEngineVersionsRequest::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 285 of file DescribeCacheEngineVersionsRequest.h.

◆ SetMarker() [3/3]

void Aws::ElastiCache::Model::DescribeCacheEngineVersionsRequest::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 293 of file DescribeCacheEngineVersionsRequest.h.

◆ SetMaxRecords()

void Aws::ElastiCache::Model::DescribeCacheEngineVersionsRequest::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 244 of file DescribeCacheEngineVersionsRequest.h.

◆ WithCacheParameterGroupFamily() [1/3]

DescribeCacheEngineVersionsRequest& Aws::ElastiCache::Model::DescribeCacheEngineVersionsRequest::WithCacheParameterGroupFamily ( const Aws::String value)
inline

The name of a specific cache parameter group family to return details for.

Valid values are: memcached1.4 | memcached1.5 | redis2.6 | redis2.8 | redis3.2 | redis4.0 | redis5.0 |

Constraints:

  • Must be 1 to 255 alphanumeric characters

  • First character must be a letter

  • Cannot end with a hyphen or contain two consecutive hyphens

Definition at line 197 of file DescribeCacheEngineVersionsRequest.h.

◆ WithCacheParameterGroupFamily() [2/3]

DescribeCacheEngineVersionsRequest& Aws::ElastiCache::Model::DescribeCacheEngineVersionsRequest::WithCacheParameterGroupFamily ( Aws::String &&  value)
inline

The name of a specific cache parameter group family to return details for.

Valid values are: memcached1.4 | memcached1.5 | redis2.6 | redis2.8 | redis3.2 | redis4.0 | redis5.0 |

Constraints:

  • Must be 1 to 255 alphanumeric characters

  • First character must be a letter

  • Cannot end with a hyphen or contain two consecutive hyphens

Definition at line 208 of file DescribeCacheEngineVersionsRequest.h.

◆ WithCacheParameterGroupFamily() [3/3]

DescribeCacheEngineVersionsRequest& Aws::ElastiCache::Model::DescribeCacheEngineVersionsRequest::WithCacheParameterGroupFamily ( const char *  value)
inline

The name of a specific cache parameter group family to return details for.

Valid values are: memcached1.4 | memcached1.5 | redis2.6 | redis2.8 | redis3.2 | redis4.0 | redis5.0 |

Constraints:

  • Must be 1 to 255 alphanumeric characters

  • First character must be a letter

  • Cannot end with a hyphen or contain two consecutive hyphens

Definition at line 219 of file DescribeCacheEngineVersionsRequest.h.

◆ WithDefaultOnly()

DescribeCacheEngineVersionsRequest& Aws::ElastiCache::Model::DescribeCacheEngineVersionsRequest::WithDefaultOnly ( bool  value)
inline

If true, specifies that only the default version of the specified engine or engine and major version combination is to be returned.

Definition at line 342 of file DescribeCacheEngineVersionsRequest.h.

◆ WithEngine() [1/3]

DescribeCacheEngineVersionsRequest& Aws::ElastiCache::Model::DescribeCacheEngineVersionsRequest::WithEngine ( const Aws::String value)
inline

The cache engine to return. Valid values: memcached | redis

Definition at line 77 of file DescribeCacheEngineVersionsRequest.h.

◆ WithEngine() [2/3]

DescribeCacheEngineVersionsRequest& Aws::ElastiCache::Model::DescribeCacheEngineVersionsRequest::WithEngine ( Aws::String &&  value)
inline

The cache engine to return. Valid values: memcached | redis

Definition at line 83 of file DescribeCacheEngineVersionsRequest.h.

◆ WithEngine() [3/3]

DescribeCacheEngineVersionsRequest& Aws::ElastiCache::Model::DescribeCacheEngineVersionsRequest::WithEngine ( const char *  value)
inline

The cache engine to return. Valid values: memcached | redis

Definition at line 89 of file DescribeCacheEngineVersionsRequest.h.

◆ WithEngineVersion() [1/3]

DescribeCacheEngineVersionsRequest& Aws::ElastiCache::Model::DescribeCacheEngineVersionsRequest::WithEngineVersion ( const Aws::String value)
inline

The cache engine version to return.

Example: 1.4.14

Definition at line 120 of file DescribeCacheEngineVersionsRequest.h.

◆ WithEngineVersion() [2/3]

DescribeCacheEngineVersionsRequest& Aws::ElastiCache::Model::DescribeCacheEngineVersionsRequest::WithEngineVersion ( Aws::String &&  value)
inline

The cache engine version to return.

Example: 1.4.14

Definition at line 125 of file DescribeCacheEngineVersionsRequest.h.

◆ WithEngineVersion() [3/3]

DescribeCacheEngineVersionsRequest& Aws::ElastiCache::Model::DescribeCacheEngineVersionsRequest::WithEngineVersion ( const char *  value)
inline

The cache engine version to return.

Example: 1.4.14

Definition at line 130 of file DescribeCacheEngineVersionsRequest.h.

◆ WithMarker() [1/3]

DescribeCacheEngineVersionsRequest& Aws::ElastiCache::Model::DescribeCacheEngineVersionsRequest::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 301 of file DescribeCacheEngineVersionsRequest.h.

◆ WithMarker() [2/3]

DescribeCacheEngineVersionsRequest& Aws::ElastiCache::Model::DescribeCacheEngineVersionsRequest::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 309 of file DescribeCacheEngineVersionsRequest.h.

◆ WithMarker() [3/3]

DescribeCacheEngineVersionsRequest& Aws::ElastiCache::Model::DescribeCacheEngineVersionsRequest::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 317 of file DescribeCacheEngineVersionsRequest.h.

◆ WithMaxRecords()

DescribeCacheEngineVersionsRequest& Aws::ElastiCache::Model::DescribeCacheEngineVersionsRequest::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 252 of file DescribeCacheEngineVersionsRequest.h.


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