CachePolicy¶
-
class
aws_cdk.aws_cloudfront.
CachePolicy
(scope, id, *, cache_policy_name=None, comment=None, cookie_behavior=None, default_ttl=None, enable_accept_encoding_brotli=None, enable_accept_encoding_gzip=None, header_behavior=None, max_ttl=None, min_ttl=None, query_string_behavior=None)¶ Bases:
aws_cdk.core.Resource
A Cache Policy configuration.
- Resource
AWS::CloudFront::CachePolicy
- Parameters
scope (
Construct
) –id (
str
) –cache_policy_name (
Optional
[str
]) – A unique name to identify the cache policy. The name must only include ‘-‘, ‘_’, or alphanumeric characters. Default: - generated from theid
comment (
Optional
[str
]) – A comment to describe the cache policy. Default: - no commentcookie_behavior (
Optional
[CacheCookieBehavior
]) – Determines whether any cookies in viewer requests are included in the cache key and automatically included in requests that CloudFront sends to the origin. Default: CacheCookieBehavior.none()default_ttl (
Optional
[Duration
]) – The default amount of time for objects to stay in the CloudFront cache. Only used when the origin does not send Cache-Control or Expires headers with the object. Default: - The greater of 1 day andminTtl
enable_accept_encoding_brotli (
Optional
[bool
]) – Whether to normalize and include theAccept-Encoding
header in the cache key when theAccept-Encoding
header is ‘br’. Default: falseenable_accept_encoding_gzip (
Optional
[bool
]) – Whether to normalize and include theAccept-Encoding
header in the cache key when theAccept-Encoding
header is ‘gzip’. Default: falseheader_behavior (
Optional
[CacheHeaderBehavior
]) – Determines whether any HTTP headers are included in the cache key and automatically included in requests that CloudFront sends to the origin. Default: CacheHeaderBehavior.none()max_ttl (
Optional
[Duration
]) – The maximum amount of time for objects to stay in the CloudFront cache. CloudFront uses this value only when the origin sends Cache-Control or Expires headers with the object. Default: - The greater of 1 year anddefaultTtl
min_ttl (
Optional
[Duration
]) – The minimum amount of time for objects to stay in the CloudFront cache. Default: Duration.seconds(0)query_string_behavior (
Optional
[CacheQueryStringBehavior
]) – Determines whether any query strings are included in the cache key and automatically included in requests that CloudFront sends to the origin. Default: CacheQueryStringBehavior.none()
Methods
-
apply_removal_policy
(policy)¶ Apply the given removal policy to this resource.
The Removal Policy controls what happens to this resource when it stops being managed by CloudFormation, either because you’ve removed it from the CDK application or because you’ve made a change that requires the resource to be replaced.
The resource can be deleted (
RemovalPolicy.DELETE
), or left in your AWS account for data recovery and cleanup later (RemovalPolicy.RETAIN
).- Parameters
policy (
RemovalPolicy
) –- Return type
None
-
to_string
()¶ Returns a string representation of this construct.
- Return type
str
Attributes
-
CACHING_DISABLED
= <jsii._reference_map.InterfaceDynamicProxy object>¶
-
CACHING_OPTIMIZED
= <jsii._reference_map.InterfaceDynamicProxy object>¶
-
CACHING_OPTIMIZED_FOR_UNCOMPRESSED_OBJECTS
= <jsii._reference_map.InterfaceDynamicProxy object>¶
-
ELEMENTAL_MEDIA_PACKAGE
= <jsii._reference_map.InterfaceDynamicProxy object>¶
-
cache_policy_id
¶ The ID of the cache policy.
- Return type
str
-
env
¶ The environment this resource belongs to.
For resources that are created and managed by the CDK (generally, those created by creating new class instances like Role, Bucket, etc.), this is always the same as the environment of the stack they belong to; however, for imported resources (those obtained from static methods like fromRoleArn, fromBucketName, etc.), that might be different than the stack they were imported into.
- Return type
-
node
¶ The construct tree node associated with this construct.
- Return type
Static Methods
-
classmethod
from_cache_policy_id
(scope, id, cache_policy_id)¶ Imports a Cache Policy from its id.
- Parameters
scope (
Construct
) –id (
str
) –cache_policy_id (
str
) –
- Return type
-
classmethod
is_construct
(x)¶ Return whether the given object is a Construct.
- Parameters
x (
Any
) –- Return type
bool
-
classmethod
is_resource
(construct)¶ Check whether the given construct is a Resource.
- Parameters
construct (
IConstruct
) –- Return type
bool