AWS SDK for C++  1.8.94
AWS SDK for C++
Public Member Functions | List of all members
Aws::AppSync::Model::CreateApiCacheRequest Class Reference

#include <CreateApiCacheRequest.h>

+ Inheritance diagram for Aws::AppSync::Model::CreateApiCacheRequest:

Public Member Functions

 CreateApiCacheRequest ()
 
virtual const char * GetServiceRequestName () const override
 
Aws::String SerializePayload () const override
 
const Aws::StringGetApiId () const
 
bool ApiIdHasBeenSet () const
 
void SetApiId (const Aws::String &value)
 
void SetApiId (Aws::String &&value)
 
void SetApiId (const char *value)
 
CreateApiCacheRequestWithApiId (const Aws::String &value)
 
CreateApiCacheRequestWithApiId (Aws::String &&value)
 
CreateApiCacheRequestWithApiId (const char *value)
 
long long GetTtl () const
 
bool TtlHasBeenSet () const
 
void SetTtl (long long value)
 
CreateApiCacheRequestWithTtl (long long value)
 
bool GetTransitEncryptionEnabled () const
 
bool TransitEncryptionEnabledHasBeenSet () const
 
void SetTransitEncryptionEnabled (bool value)
 
CreateApiCacheRequestWithTransitEncryptionEnabled (bool value)
 
bool GetAtRestEncryptionEnabled () const
 
bool AtRestEncryptionEnabledHasBeenSet () const
 
void SetAtRestEncryptionEnabled (bool value)
 
CreateApiCacheRequestWithAtRestEncryptionEnabled (bool value)
 
const ApiCachingBehaviorGetApiCachingBehavior () const
 
bool ApiCachingBehaviorHasBeenSet () const
 
void SetApiCachingBehavior (const ApiCachingBehavior &value)
 
void SetApiCachingBehavior (ApiCachingBehavior &&value)
 
CreateApiCacheRequestWithApiCachingBehavior (const ApiCachingBehavior &value)
 
CreateApiCacheRequestWithApiCachingBehavior (ApiCachingBehavior &&value)
 
const ApiCacheTypeGetType () const
 
bool TypeHasBeenSet () const
 
void SetType (const ApiCacheType &value)
 
void SetType (ApiCacheType &&value)
 
CreateApiCacheRequestWithType (const ApiCacheType &value)
 
CreateApiCacheRequestWithType (ApiCacheType &&value)
 
- Public Member Functions inherited from Aws::AppSync::AppSyncRequest
virtual ~AppSyncRequest ()
 
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
 

Additional Inherited Members

- Protected Member Functions inherited from Aws::AppSync::AppSyncRequest
virtual Aws::Http::HeaderValueCollection GetRequestSpecificHeaders () const
 
- Protected Member Functions inherited from Aws::AmazonWebServiceRequest
virtual void DumpBodyToUrl (Aws::Http::URI &uri) const
 

Detailed Description

Represents the input of a CreateApiCache operation.

See Also:

AWS API Reference

Definition at line 27 of file CreateApiCacheRequest.h.

Constructor & Destructor Documentation

◆ CreateApiCacheRequest()

Aws::AppSync::Model::CreateApiCacheRequest::CreateApiCacheRequest ( )

Member Function Documentation

◆ ApiCachingBehaviorHasBeenSet()

bool Aws::AppSync::Model::CreateApiCacheRequest::ApiCachingBehaviorHasBeenSet ( ) const
inline

Caching behavior.

  • FULL_REQUEST_CACHING: All requests are fully cached.

  • PER_RESOLVER_CACHING: Individual resolvers that you specify are cached.

Definition at line 169 of file CreateApiCacheRequest.h.

◆ ApiIdHasBeenSet()

bool Aws::AppSync::Model::CreateApiCacheRequest::ApiIdHasBeenSet ( ) const
inline

The GraphQL API Id.

Definition at line 49 of file CreateApiCacheRequest.h.

◆ AtRestEncryptionEnabledHasBeenSet()

bool Aws::AppSync::Model::CreateApiCacheRequest::AtRestEncryptionEnabledHasBeenSet ( ) const
inline

At rest encryption flag for cache. This setting cannot be updated after creation.

Definition at line 142 of file CreateApiCacheRequest.h.

◆ GetApiCachingBehavior()

const ApiCachingBehavior& Aws::AppSync::Model::CreateApiCacheRequest::GetApiCachingBehavior ( ) const
inline

Caching behavior.

  • FULL_REQUEST_CACHING: All requests are fully cached.

  • PER_RESOLVER_CACHING: Individual resolvers that you specify are cached.

Definition at line 162 of file CreateApiCacheRequest.h.

◆ GetApiId()

const Aws::String& Aws::AppSync::Model::CreateApiCacheRequest::GetApiId ( ) const
inline

The GraphQL API Id.

Definition at line 44 of file CreateApiCacheRequest.h.

◆ GetAtRestEncryptionEnabled()

bool Aws::AppSync::Model::CreateApiCacheRequest::GetAtRestEncryptionEnabled ( ) const
inline

At rest encryption flag for cache. This setting cannot be updated after creation.

Definition at line 136 of file CreateApiCacheRequest.h.

◆ GetServiceRequestName()

virtual const char* Aws::AppSync::Model::CreateApiCacheRequest::GetServiceRequestName ( ) const
inlineoverridevirtual

Implements Aws::AmazonWebServiceRequest.

Definition at line 36 of file CreateApiCacheRequest.h.

◆ GetTransitEncryptionEnabled()

bool Aws::AppSync::Model::CreateApiCacheRequest::GetTransitEncryptionEnabled ( ) const
inline

Transit encryption flag when connecting to cache. This setting cannot be updated after creation.

Definition at line 111 of file CreateApiCacheRequest.h.

◆ GetTtl()

long long Aws::AppSync::Model::CreateApiCacheRequest::GetTtl ( ) const
inline

TTL in seconds for cache entries.

Valid values are between 1 and 3600 seconds.

Definition at line 86 of file CreateApiCacheRequest.h.

◆ GetType()

const ApiCacheType& Aws::AppSync::Model::CreateApiCacheRequest::GetType ( ) const
inline

The cache instance type. Valid values are

  • SMALL

  • MEDIUM

  • LARGE

  • XLARGE

  • LARGE_2X

  • LARGE_4X

  • LARGE_8X (not available in all regions)

  • LARGE_12X

Historically, instance types were identified by an EC2-style value. As of July 2020, this is deprecated, and the generic identifiers above should be used.

The following legacy instance types are available, but their use is discouraged:

  • T2_SMALL: A t2.small instance type.

  • T2_MEDIUM: A t2.medium instance type.

  • R4_LARGE: A r4.large instance type.

  • R4_XLARGE: A r4.xlarge instance type.

  • R4_2XLARGE: A r4.2xlarge instance type.

  • R4_4XLARGE: A r4.4xlarge instance type.

  • R4_8XLARGE: A r4.8xlarge instance type.

Definition at line 217 of file CreateApiCacheRequest.h.

◆ SerializePayload()

Aws::String Aws::AppSync::Model::CreateApiCacheRequest::SerializePayload ( ) const
overridevirtual

Convert payload into String.

Implements Aws::AmazonSerializableWebServiceRequest.

◆ SetApiCachingBehavior() [1/2]

void Aws::AppSync::Model::CreateApiCacheRequest::SetApiCachingBehavior ( const ApiCachingBehavior value)
inline

Caching behavior.

  • FULL_REQUEST_CACHING: All requests are fully cached.

  • PER_RESOLVER_CACHING: Individual resolvers that you specify are cached.

Definition at line 176 of file CreateApiCacheRequest.h.

◆ SetApiCachingBehavior() [2/2]

void Aws::AppSync::Model::CreateApiCacheRequest::SetApiCachingBehavior ( ApiCachingBehavior &&  value)
inline

Caching behavior.

  • FULL_REQUEST_CACHING: All requests are fully cached.

  • PER_RESOLVER_CACHING: Individual resolvers that you specify are cached.

Definition at line 183 of file CreateApiCacheRequest.h.

◆ SetApiId() [1/3]

void Aws::AppSync::Model::CreateApiCacheRequest::SetApiId ( const Aws::String value)
inline

The GraphQL API Id.

Definition at line 54 of file CreateApiCacheRequest.h.

◆ SetApiId() [2/3]

void Aws::AppSync::Model::CreateApiCacheRequest::SetApiId ( Aws::String &&  value)
inline

The GraphQL API Id.

Definition at line 59 of file CreateApiCacheRequest.h.

◆ SetApiId() [3/3]

void Aws::AppSync::Model::CreateApiCacheRequest::SetApiId ( const char *  value)
inline

The GraphQL API Id.

Definition at line 64 of file CreateApiCacheRequest.h.

◆ SetAtRestEncryptionEnabled()

void Aws::AppSync::Model::CreateApiCacheRequest::SetAtRestEncryptionEnabled ( bool  value)
inline

At rest encryption flag for cache. This setting cannot be updated after creation.

Definition at line 148 of file CreateApiCacheRequest.h.

◆ SetTransitEncryptionEnabled()

void Aws::AppSync::Model::CreateApiCacheRequest::SetTransitEncryptionEnabled ( bool  value)
inline

Transit encryption flag when connecting to cache. This setting cannot be updated after creation.

Definition at line 123 of file CreateApiCacheRequest.h.

◆ SetTtl()

void Aws::AppSync::Model::CreateApiCacheRequest::SetTtl ( long long  value)
inline

TTL in seconds for cache entries.

Valid values are between 1 and 3600 seconds.

Definition at line 98 of file CreateApiCacheRequest.h.

◆ SetType() [1/2]

void Aws::AppSync::Model::CreateApiCacheRequest::SetType ( const ApiCacheType value)
inline

The cache instance type. Valid values are

  • SMALL

  • MEDIUM

  • LARGE

  • XLARGE

  • LARGE_2X

  • LARGE_4X

  • LARGE_8X (not available in all regions)

  • LARGE_12X

Historically, instance types were identified by an EC2-style value. As of July 2020, this is deprecated, and the generic identifiers above should be used.

The following legacy instance types are available, but their use is discouraged:

  • T2_SMALL: A t2.small instance type.

  • T2_MEDIUM: A t2.medium instance type.

  • R4_LARGE: A r4.large instance type.

  • R4_XLARGE: A r4.xlarge instance type.

  • R4_2XLARGE: A r4.2xlarge instance type.

  • R4_4XLARGE: A r4.4xlarge instance type.

  • R4_8XLARGE: A r4.8xlarge instance type.

Definition at line 255 of file CreateApiCacheRequest.h.

◆ SetType() [2/2]

void Aws::AppSync::Model::CreateApiCacheRequest::SetType ( ApiCacheType &&  value)
inline

The cache instance type. Valid values are

  • SMALL

  • MEDIUM

  • LARGE

  • XLARGE

  • LARGE_2X

  • LARGE_4X

  • LARGE_8X (not available in all regions)

  • LARGE_12X

Historically, instance types were identified by an EC2-style value. As of July 2020, this is deprecated, and the generic identifiers above should be used.

The following legacy instance types are available, but their use is discouraged:

  • T2_SMALL: A t2.small instance type.

  • T2_MEDIUM: A t2.medium instance type.

  • R4_LARGE: A r4.large instance type.

  • R4_XLARGE: A r4.xlarge instance type.

  • R4_2XLARGE: A r4.2xlarge instance type.

  • R4_4XLARGE: A r4.4xlarge instance type.

  • R4_8XLARGE: A r4.8xlarge instance type.

Definition at line 274 of file CreateApiCacheRequest.h.

◆ TransitEncryptionEnabledHasBeenSet()

bool Aws::AppSync::Model::CreateApiCacheRequest::TransitEncryptionEnabledHasBeenSet ( ) const
inline

Transit encryption flag when connecting to cache. This setting cannot be updated after creation.

Definition at line 117 of file CreateApiCacheRequest.h.

◆ TtlHasBeenSet()

bool Aws::AppSync::Model::CreateApiCacheRequest::TtlHasBeenSet ( ) const
inline

TTL in seconds for cache entries.

Valid values are between 1 and 3600 seconds.

Definition at line 92 of file CreateApiCacheRequest.h.

◆ TypeHasBeenSet()

bool Aws::AppSync::Model::CreateApiCacheRequest::TypeHasBeenSet ( ) const
inline

The cache instance type. Valid values are

  • SMALL

  • MEDIUM

  • LARGE

  • XLARGE

  • LARGE_2X

  • LARGE_4X

  • LARGE_8X (not available in all regions)

  • LARGE_12X

Historically, instance types were identified by an EC2-style value. As of July 2020, this is deprecated, and the generic identifiers above should be used.

The following legacy instance types are available, but their use is discouraged:

  • T2_SMALL: A t2.small instance type.

  • T2_MEDIUM: A t2.medium instance type.

  • R4_LARGE: A r4.large instance type.

  • R4_XLARGE: A r4.xlarge instance type.

  • R4_2XLARGE: A r4.2xlarge instance type.

  • R4_4XLARGE: A r4.4xlarge instance type.

  • R4_8XLARGE: A r4.8xlarge instance type.

Definition at line 236 of file CreateApiCacheRequest.h.

◆ WithApiCachingBehavior() [1/2]

CreateApiCacheRequest& Aws::AppSync::Model::CreateApiCacheRequest::WithApiCachingBehavior ( const ApiCachingBehavior value)
inline

Caching behavior.

  • FULL_REQUEST_CACHING: All requests are fully cached.

  • PER_RESOLVER_CACHING: Individual resolvers that you specify are cached.

Definition at line 190 of file CreateApiCacheRequest.h.

◆ WithApiCachingBehavior() [2/2]

CreateApiCacheRequest& Aws::AppSync::Model::CreateApiCacheRequest::WithApiCachingBehavior ( ApiCachingBehavior &&  value)
inline

Caching behavior.

  • FULL_REQUEST_CACHING: All requests are fully cached.

  • PER_RESOLVER_CACHING: Individual resolvers that you specify are cached.

Definition at line 197 of file CreateApiCacheRequest.h.

◆ WithApiId() [1/3]

CreateApiCacheRequest& Aws::AppSync::Model::CreateApiCacheRequest::WithApiId ( const Aws::String value)
inline

The GraphQL API Id.

Definition at line 69 of file CreateApiCacheRequest.h.

◆ WithApiId() [2/3]

CreateApiCacheRequest& Aws::AppSync::Model::CreateApiCacheRequest::WithApiId ( Aws::String &&  value)
inline

The GraphQL API Id.

Definition at line 74 of file CreateApiCacheRequest.h.

◆ WithApiId() [3/3]

CreateApiCacheRequest& Aws::AppSync::Model::CreateApiCacheRequest::WithApiId ( const char *  value)
inline

The GraphQL API Id.

Definition at line 79 of file CreateApiCacheRequest.h.

◆ WithAtRestEncryptionEnabled()

CreateApiCacheRequest& Aws::AppSync::Model::CreateApiCacheRequest::WithAtRestEncryptionEnabled ( bool  value)
inline

At rest encryption flag for cache. This setting cannot be updated after creation.

Definition at line 154 of file CreateApiCacheRequest.h.

◆ WithTransitEncryptionEnabled()

CreateApiCacheRequest& Aws::AppSync::Model::CreateApiCacheRequest::WithTransitEncryptionEnabled ( bool  value)
inline

Transit encryption flag when connecting to cache. This setting cannot be updated after creation.

Definition at line 129 of file CreateApiCacheRequest.h.

◆ WithTtl()

CreateApiCacheRequest& Aws::AppSync::Model::CreateApiCacheRequest::WithTtl ( long long  value)
inline

TTL in seconds for cache entries.

Valid values are between 1 and 3600 seconds.

Definition at line 104 of file CreateApiCacheRequest.h.

◆ WithType() [1/2]

CreateApiCacheRequest& Aws::AppSync::Model::CreateApiCacheRequest::WithType ( const ApiCacheType value)
inline

The cache instance type. Valid values are

  • SMALL

  • MEDIUM

  • LARGE

  • XLARGE

  • LARGE_2X

  • LARGE_4X

  • LARGE_8X (not available in all regions)

  • LARGE_12X

Historically, instance types were identified by an EC2-style value. As of July 2020, this is deprecated, and the generic identifiers above should be used.

The following legacy instance types are available, but their use is discouraged:

  • T2_SMALL: A t2.small instance type.

  • T2_MEDIUM: A t2.medium instance type.

  • R4_LARGE: A r4.large instance type.

  • R4_XLARGE: A r4.xlarge instance type.

  • R4_2XLARGE: A r4.2xlarge instance type.

  • R4_4XLARGE: A r4.4xlarge instance type.

  • R4_8XLARGE: A r4.8xlarge instance type.

Definition at line 293 of file CreateApiCacheRequest.h.

◆ WithType() [2/2]

CreateApiCacheRequest& Aws::AppSync::Model::CreateApiCacheRequest::WithType ( ApiCacheType &&  value)
inline

The cache instance type. Valid values are

  • SMALL

  • MEDIUM

  • LARGE

  • XLARGE

  • LARGE_2X

  • LARGE_4X

  • LARGE_8X (not available in all regions)

  • LARGE_12X

Historically, instance types were identified by an EC2-style value. As of July 2020, this is deprecated, and the generic identifiers above should be used.

The following legacy instance types are available, but their use is discouraged:

  • T2_SMALL: A t2.small instance type.

  • T2_MEDIUM: A t2.medium instance type.

  • R4_LARGE: A r4.large instance type.

  • R4_XLARGE: A r4.xlarge instance type.

  • R4_2XLARGE: A r4.2xlarge instance type.

  • R4_4XLARGE: A r4.4xlarge instance type.

  • R4_8XLARGE: A r4.8xlarge instance type.

Definition at line 312 of file CreateApiCacheRequest.h.


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