# ApiCache
<a name="API_ApiCache"></a>

The `ApiCache` object.

## Contents
<a name="API_ApiCache_Contents"></a>

 ** apiCachingBehavior **   <a name="appsync-Type-ApiCache-apiCachingBehavior"></a>
Caching behavior.  
+  **FULL\$1REQUEST\$1CACHING**: All requests from the same user are cached. Individual resolvers are automatically cached. All API calls will try to return responses from the cache.
+  **PER\$1RESOLVER\$1CACHING**: Individual resolvers that you specify are cached.
+  **OPERATION\$1LEVEL\$1CACHING**: Full requests are cached together and returned without executing resolvers.
Type: String  
Valid Values: `FULL_REQUEST_CACHING | PER_RESOLVER_CACHING | OPERATION_LEVEL_CACHING`   
Required: No

 ** atRestEncryptionEnabled **   <a name="appsync-Type-ApiCache-atRestEncryptionEnabled"></a>
At-rest encryption flag for cache. You cannot update this setting after creation.  
Type: Boolean  
Required: No

 ** healthMetricsConfig **   <a name="appsync-Type-ApiCache-healthMetricsConfig"></a>
Controls how cache health metrics will be emitted to CloudWatch. Cache health metrics include:  
+ NetworkBandwidthOutAllowanceExceeded: The network packets dropped because the throughput exceeded the aggregated bandwidth limit. This is useful for diagnosing bottlenecks in a cache configuration.
+ EngineCPUUtilization: The CPU utilization (percentage) allocated to the Redis process. This is useful for diagnosing bottlenecks in a cache configuration.
Metrics will be recorded by API ID. You can set the value to `ENABLED` or `DISABLED`.  
Type: String  
Valid Values: `ENABLED | DISABLED`   
Required: No

 ** status **   <a name="appsync-Type-ApiCache-status"></a>
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.
Type: String  
Valid Values: `AVAILABLE | CREATING | DELETING | MODIFYING | FAILED`   
Required: No

 ** transitEncryptionEnabled **   <a name="appsync-Type-ApiCache-transitEncryptionEnabled"></a>
Transit encryption flag when connecting to cache. You cannot update this setting after creation.  
Type: Boolean  
Required: No

 ** ttl **   <a name="appsync-Type-ApiCache-ttl"></a>
TTL in seconds for cache entries.  
Valid values are 1–3,600 seconds.  
Type: Long  
Required: No

 ** type **   <a name="appsync-Type-ApiCache-type"></a>
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\$1SMALL**: A t2.small instance type.
+  **T2\$1MEDIUM**: A t2.medium instance type.
+  **R4\$1LARGE**: A r4.large instance type.
+  **R4\$1XLARGE**: A r4.xlarge instance type.
+  **R4\$12XLARGE**: A r4.2xlarge instance type.
+  **R4\$14XLARGE**: A r4.4xlarge instance type.
+  **R4\$18XLARGE**: A r4.8xlarge instance type.
Type: String  
Valid Values: `T2_SMALL | T2_MEDIUM | R4_LARGE | R4_XLARGE | R4_2XLARGE | R4_4XLARGE | R4_8XLARGE | SMALL | MEDIUM | LARGE | XLARGE | LARGE_2X | LARGE_4X | LARGE_8X | LARGE_12X`   
Required: No

## See Also
<a name="API_ApiCache_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/appsync-2017-07-25/ApiCache) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/appsync-2017-07-25/ApiCache) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/appsync-2017-07-25/ApiCache)