Interface CfnApiCacheProps
- All Superinterfaces:
software.amazon.jsii.JsiiSerializable
- All Known Implementing Classes:
CfnApiCacheProps.Jsii$Proxy
@Generated(value="jsii-pacmak/1.104.0 (build e79254c)",
date="2025-01-15T21:09:14.595Z")
@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:
-
Nested Class Summary
Modifier and TypeInterfaceDescriptionstatic final class
A builder forCfnApiCacheProps
static final class
An implementation forCfnApiCacheProps
-
Method Summary
Modifier and TypeMethodDescriptionstatic CfnApiCacheProps.Builder
builder()
Caching behavior.getApiId()
The GraphQL API ID.default Object
At-rest encryption flag for cache.default String
Controls how cache health metrics will be emitted to CloudWatch.default Object
Transit encryption flag when connecting to cache.getTtl()
TTL in seconds for cache entries.getType()
The cache instance type.Methods inherited from interface software.amazon.jsii.JsiiSerializable
$jsii$toJson
-
Method Details
-
getApiCachingBehavior
Caching behavior.- FULL_REQUEST_CACHING : All requests are fully cached.
- PER_RESOLVER_CACHING : Individual resolvers that you specify are cached.
- See Also:
-
getApiId
The GraphQL API ID.- See Also:
-
getTtl
TTL in seconds for cache entries.Valid values are 1–3,600 seconds.
- See Also:
-
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:
-
getAtRestEncryptionEnabled
At-rest encryption flag for cache.You cannot update this setting after creation.
- See Also:
-
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
orDISABLED
.- See Also:
-
getTransitEncryptionEnabled
Transit encryption flag when connecting to cache.You cannot update this setting after creation.
- See Also:
-
builder
- Returns:
- a
CfnApiCacheProps.Builder
ofCfnApiCacheProps
-