CfnApiCacheProps¶
-
class
aws_cdk.aws_appsync.
CfnApiCacheProps
(*, api_caching_behavior, api_id, ttl, type, at_rest_encryption_enabled=None, transit_encryption_enabled=None)¶ Bases:
object
Properties for defining a
CfnApiCache
.- Parameters
api_caching_behavior (
str
) – Caching behavior. - FULL_REQUEST_CACHING : All requests are fully cached. - PER_RESOLVER_CACHING : Individual resolvers that you specify are cached.api_id (
str
) – The GraphQL API ID.ttl (
Union
[int
,float
]) – TTL in seconds for cache entries. Valid values are 1–3,600 seconds.type (
str
) – 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.at_rest_encryption_enabled (
Union
[bool
,IResolvable
,None
]) – At-rest encryption flag for cache. You cannot update this setting after creation.transit_encryption_enabled (
Union
[bool
,IResolvable
,None
]) – Transit encryption flag when connecting to cache. You cannot update this setting after creation.
- Link
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appsync-apicache.html
- ExampleMetadata
fixture=_generated
Example:
# The code below shows an example of how to instantiate this type. # The values are placeholders you should change. import aws_cdk.aws_appsync as appsync cfn_api_cache_props = appsync.CfnApiCacheProps( api_caching_behavior="apiCachingBehavior", api_id="apiId", ttl=123, type="type", # the properties below are optional at_rest_encryption_enabled=False, transit_encryption_enabled=False )
Attributes
-
api_caching_behavior
¶ Caching behavior.
FULL_REQUEST_CACHING : All requests are fully cached.
PER_RESOLVER_CACHING : Individual resolvers that you specify are cached.
-
api_id
¶ The GraphQL API ID.
-
at_rest_encryption_enabled
¶ At-rest encryption flag for cache.
You cannot update this setting after creation.
-
transit_encryption_enabled
¶ Transit encryption flag when connecting to cache.
You cannot update this setting after creation.
-
ttl
¶ TTL in seconds for cache entries.
Valid values are 1–3,600 seconds.
- Link
- Return type
Union
[int
,float
]
-
type
¶ 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.