CacheCookieBehavior

class aws_cdk.aws_cloudfront.CacheCookieBehavior(*args: Any, **kwargs)

Bases: object

Determines whether any cookies in viewer requests are included in the cache key and automatically included in requests that CloudFront sends to the origin.

ExampleMetadata

infused

Example:

# Creating a custom cache policy for a Distribution -- all parameters optional
# bucket_origin: origins.S3Origin

my_cache_policy = cloudfront.CachePolicy(self, "myCachePolicy",
    cache_policy_name="MyPolicy",
    comment="A default policy",
    default_ttl=Duration.days(2),
    min_ttl=Duration.minutes(1),
    max_ttl=Duration.days(10),
    cookie_behavior=cloudfront.CacheCookieBehavior.all(),
    header_behavior=cloudfront.CacheHeaderBehavior.allow_list("X-CustomHeader"),
    query_string_behavior=cloudfront.CacheQueryStringBehavior.deny_list("username"),
    enable_accept_encoding_gzip=True,
    enable_accept_encoding_brotli=True
)
cloudfront.Distribution(self, "myDistCustomPolicy",
    default_behavior=cloudfront.BehaviorOptions(
        origin=bucket_origin,
        cache_policy=my_cache_policy
    )
)

Attributes

behavior

allow all, none, an allow list, or a deny list.

Type

The behavior of cookies

Return type

str

cookies

The cookies to allow or deny, if the behavior is an allow or deny list.

Return type

Optional[List[str]]

Static Methods

classmethod all()

All cookies in viewer requests are included in the cache key and are automatically included in requests that CloudFront sends to the origin.

Return type

CacheCookieBehavior

classmethod allow_list(*cookies)

Only the provided cookies are included in the cache key and automatically included in requests that CloudFront sends to the origin.

Parameters

cookies (str) –

Return type

CacheCookieBehavior

classmethod deny_list(*cookies)

All cookies except the provided cookies are included in the cache key and automatically included in requests that CloudFront sends to the origin.

Parameters

cookies (str) –

Return type

CacheCookieBehavior

classmethod none()

Cookies in viewer requests are not included in the cache key and are not automatically included in requests that CloudFront sends to the origin.

Return type

CacheCookieBehavior