Package software.amazon.awscdk.services.appsync

Interface CfnApiCacheProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnApiCacheProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.119.0 (build 1634eac)",
           date="2025-11-17T14:40:45.390Z")
@Stability(Stable)
public interface CfnApiCacheProps
extends software.amazon.jsii.JsiiSerializable

Properties for defining a CfnApiCache.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.appsync.*;
 CfnApiCacheProps cfnApiCacheProps = CfnApiCacheProps.builder()
         .apiCachingBehavior("apiCachingBehavior")
         .apiId("apiId")
         .ttl(123)
         .type("type")
         // the properties below are optional
         .atRestEncryptionEnabled(false)
         .healthMetricsConfig("healthMetricsConfig")
         .transitEncryptionEnabled(false)
         .build();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appsync-apicache.html

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnApiCacheProps.Builder	A builder for CfnApiCacheProps
static final class	CfnApiCacheProps.Jsii$Proxy	An implementation for CfnApiCacheProps

Method Summary

Modifier and Type	Method	Description
static CfnApiCacheProps.Builder	builder()
String	getApiCachingBehavior()	Caching behavior.
String	getApiId()	The GraphQL API ID.
default Object	getAtRestEncryptionEnabled()	This parameter has been deprecated .
default String	getHealthMetricsConfig()	Controls how cache health metrics will be emitted to CloudWatch.
default Object	getTransitEncryptionEnabled()	This parameter has been deprecated .
Number	getTtl()	TTL in seconds for cache entries.
String	getType()	The cache instance type.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getApiCachingBehavior

@Stability(Stable)
@NotNull
String getApiCachingBehavior()

Caching behavior.

• FULL_REQUEST_CACHING : 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_RESOLVER_CACHING : Individual resolvers that you specify are cached.
• OPERATION_LEVEL_CACHING : Full requests are cached together and returned without executing resolvers.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appsync-apicache.html#cfn-appsync-apicache-apicachingbehavior

getApiId

@Stability(Stable)
@NotNull
String getApiId()

The GraphQL API ID.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appsync-apicache.html#cfn-appsync-apicache-apiid

getTtl

@Stability(Stable)
@NotNull
Number getTtl()

TTL in seconds for cache entries.

Valid values are 1–3,600 seconds.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appsync-apicache.html#cfn-appsync-apicache-ttl

getType

@Stability(Stable)
@NotNull
String getType()

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.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appsync-apicache.html#cfn-appsync-apicache-type

getAtRestEncryptionEnabled

@Stability(Stable)
@Nullable
default Object getAtRestEncryptionEnabled()

This parameter has been deprecated .

At-rest encryption flag for cache. You cannot update this setting after creation.

Returns union: either Boolean or IResolvable

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appsync-apicache.html#cfn-appsync-apicache-atrestencryptionenabled

getHealthMetricsConfig

@Stability(Stable)
@Nullable
default String getHealthMetricsConfig()

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 .

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appsync-apicache.html#cfn-appsync-apicache-healthmetricsconfig

getTransitEncryptionEnabled

@Stability(Stable)
@Nullable
default Object getTransitEncryptionEnabled()

This parameter has been deprecated .

Transit encryption flag when connecting to cache. You cannot update this setting after creation.

Returns union: either Boolean or IResolvable

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appsync-apicache.html#cfn-appsync-apicache-transitencryptionenabled

builder

@Stability(Stable)
static CfnApiCacheProps.Builder builder()

Returns:

a CfnApiCacheProps.Builder of CfnApiCacheProps