CacheHeaderBehavior

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

Bases: object

Determines whether any HTTP headers 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: If no headers will be passed, or an allow list of headers.

headers: The headers for the allow/deny list, if applicable.

Static Methods

classmethod allow_list(*headers)

Listed headers are included in the cache key and are automatically included in requests that CloudFront sends to the origin.

Parameters:: headers (str)
Return type:: CacheHeaderBehavior

classmethod none()

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

Return type:: CacheHeaderBehavior