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

#include <ApiCache.h>

Public Member Functions

 ApiCache ()
 
 ApiCache (Aws::Utils::Json::JsonView jsonValue)
 
ApiCacheoperator= (Aws::Utils::Json::JsonView jsonValue)
 
Aws::Utils::Json::JsonValue Jsonize () const
 
long long GetTtl () const
 
bool TtlHasBeenSet () const
 
void SetTtl (long long value)
 
ApiCacheWithTtl (long long value)
 
const ApiCachingBehaviorGetApiCachingBehavior () const
 
bool ApiCachingBehaviorHasBeenSet () const
 
void SetApiCachingBehavior (const ApiCachingBehavior &value)
 
void SetApiCachingBehavior (ApiCachingBehavior &&value)
 
ApiCacheWithApiCachingBehavior (const ApiCachingBehavior &value)
 
ApiCacheWithApiCachingBehavior (ApiCachingBehavior &&value)
 
bool GetTransitEncryptionEnabled () const
 
bool TransitEncryptionEnabledHasBeenSet () const
 
void SetTransitEncryptionEnabled (bool value)
 
ApiCacheWithTransitEncryptionEnabled (bool value)
 
bool GetAtRestEncryptionEnabled () const
 
bool AtRestEncryptionEnabledHasBeenSet () const
 
void SetAtRestEncryptionEnabled (bool value)
 
ApiCacheWithAtRestEncryptionEnabled (bool value)
 
const ApiCacheTypeGetType () const
 
bool TypeHasBeenSet () const
 
void SetType (const ApiCacheType &value)
 
void SetType (ApiCacheType &&value)
 
ApiCacheWithType (const ApiCacheType &value)
 
ApiCacheWithType (ApiCacheType &&value)
 
const ApiCacheStatusGetStatus () const
 
bool StatusHasBeenSet () const
 
void SetStatus (const ApiCacheStatus &value)
 
void SetStatus (ApiCacheStatus &&value)
 
ApiCacheWithStatus (const ApiCacheStatus &value)
 
ApiCacheWithStatus (ApiCacheStatus &&value)
 

Detailed Description

The ApiCache object.

See Also:

AWS API Reference

Definition at line 33 of file ApiCache.h.

Constructor & Destructor Documentation

◆ ApiCache() [1/2]

Aws::AppSync::Model::ApiCache::ApiCache ( )

◆ ApiCache() [2/2]

Aws::AppSync::Model::ApiCache::ApiCache ( Aws::Utils::Json::JsonView  jsonValue)

Member Function Documentation

◆ ApiCachingBehaviorHasBeenSet()

bool Aws::AppSync::Model::ApiCache::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 79 of file ApiCache.h.

◆ AtRestEncryptionEnabledHasBeenSet()

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

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

Definition at line 145 of file ApiCache.h.

◆ GetApiCachingBehavior()

const ApiCachingBehavior& Aws::AppSync::Model::ApiCache::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 72 of file ApiCache.h.

◆ GetAtRestEncryptionEnabled()

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

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

Definition at line 139 of file ApiCache.h.

◆ GetStatus()

const ApiCacheStatus& Aws::AppSync::Model::ApiCache::GetStatus ( ) const
inline

The cache instance status.

  • AVAILABLE: The instance is available for use.

  • CREATING: The instance is currently creating.

  • DELETING: The instance is currently deleting.

  • MODIFYING: The instance is currently modifying.

  • FAILED: The instance has failed creation.

Definition at line 283 of file ApiCache.h.

◆ GetTransitEncryptionEnabled()

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

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

Definition at line 114 of file ApiCache.h.

◆ GetTtl()

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

TTL in seconds for cache entries.

Valid values are between 1 and 3600 seconds.

Definition at line 46 of file ApiCache.h.

◆ GetType()

const ApiCacheType& Aws::AppSync::Model::ApiCache::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 177 of file ApiCache.h.

◆ Jsonize()

Aws::Utils::Json::JsonValue Aws::AppSync::Model::ApiCache::Jsonize ( ) const

◆ operator=()

ApiCache& Aws::AppSync::Model::ApiCache::operator= ( Aws::Utils::Json::JsonView  jsonValue)

◆ SetApiCachingBehavior() [1/2]

void Aws::AppSync::Model::ApiCache::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 86 of file ApiCache.h.

◆ SetApiCachingBehavior() [2/2]

void Aws::AppSync::Model::ApiCache::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 93 of file ApiCache.h.

◆ SetAtRestEncryptionEnabled()

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

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

Definition at line 151 of file ApiCache.h.

◆ SetStatus() [1/2]

void Aws::AppSync::Model::ApiCache::SetStatus ( const ApiCacheStatus value)
inline

The cache instance status.

  • AVAILABLE: The instance is available for use.

  • CREATING: The instance is currently creating.

  • DELETING: The instance is currently deleting.

  • MODIFYING: The instance is currently modifying.

  • FAILED: The instance has failed creation.

Definition at line 303 of file ApiCache.h.

◆ SetStatus() [2/2]

void Aws::AppSync::Model::ApiCache::SetStatus ( ApiCacheStatus &&  value)
inline

The cache instance status.

  • AVAILABLE: The instance is available for use.

  • CREATING: The instance is currently creating.

  • DELETING: The instance is currently deleting.

  • MODIFYING: The instance is currently modifying.

  • FAILED: The instance has failed creation.

Definition at line 313 of file ApiCache.h.

◆ SetTransitEncryptionEnabled()

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

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

Definition at line 126 of file ApiCache.h.

◆ SetTtl()

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

TTL in seconds for cache entries.

Valid values are between 1 and 3600 seconds.

Definition at line 58 of file ApiCache.h.

◆ SetType() [1/2]

void Aws::AppSync::Model::ApiCache::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 215 of file ApiCache.h.

◆ SetType() [2/2]

void Aws::AppSync::Model::ApiCache::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 234 of file ApiCache.h.

◆ StatusHasBeenSet()

bool Aws::AppSync::Model::ApiCache::StatusHasBeenSet ( ) const
inline

The cache instance status.

  • AVAILABLE: The instance is available for use.

  • CREATING: The instance is currently creating.

  • DELETING: The instance is currently deleting.

  • MODIFYING: The instance is currently modifying.

  • FAILED: The instance has failed creation.

Definition at line 293 of file ApiCache.h.

◆ TransitEncryptionEnabledHasBeenSet()

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

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

Definition at line 120 of file ApiCache.h.

◆ TtlHasBeenSet()

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

TTL in seconds for cache entries.

Valid values are between 1 and 3600 seconds.

Definition at line 52 of file ApiCache.h.

◆ TypeHasBeenSet()

bool Aws::AppSync::Model::ApiCache::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 196 of file ApiCache.h.

◆ WithApiCachingBehavior() [1/2]

ApiCache& Aws::AppSync::Model::ApiCache::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 100 of file ApiCache.h.

◆ WithApiCachingBehavior() [2/2]

ApiCache& Aws::AppSync::Model::ApiCache::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 107 of file ApiCache.h.

◆ WithAtRestEncryptionEnabled()

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

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

Definition at line 157 of file ApiCache.h.

◆ WithStatus() [1/2]

ApiCache& Aws::AppSync::Model::ApiCache::WithStatus ( const ApiCacheStatus value)
inline

The cache instance status.

  • AVAILABLE: The instance is available for use.

  • CREATING: The instance is currently creating.

  • DELETING: The instance is currently deleting.

  • MODIFYING: The instance is currently modifying.

  • FAILED: The instance has failed creation.

Definition at line 323 of file ApiCache.h.

◆ WithStatus() [2/2]

ApiCache& Aws::AppSync::Model::ApiCache::WithStatus ( ApiCacheStatus &&  value)
inline

The cache instance status.

  • AVAILABLE: The instance is available for use.

  • CREATING: The instance is currently creating.

  • DELETING: The instance is currently deleting.

  • MODIFYING: The instance is currently modifying.

  • FAILED: The instance has failed creation.

Definition at line 333 of file ApiCache.h.

◆ WithTransitEncryptionEnabled()

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

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

Definition at line 132 of file ApiCache.h.

◆ WithTtl()

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

TTL in seconds for cache entries.

Valid values are between 1 and 3600 seconds.

Definition at line 64 of file ApiCache.h.

◆ WithType() [1/2]

ApiCache& Aws::AppSync::Model::ApiCache::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 253 of file ApiCache.h.

◆ WithType() [2/2]

ApiCache& Aws::AppSync::Model::ApiCache::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 272 of file ApiCache.h.


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