CachePolicyProps

class aws_cdk.aws_cloudfront.CachePolicyProps(*, 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: object

(experimental) Properties for creating a Cache Policy.

Parameters
  • cache_policy_name (Optional[str]) – (experimental) A unique name to identify the cache policy. The name must only include ‘-‘, ‘_’, or alphanumeric characters. Default: - generated from the id

  • comment (Optional[str]) – (experimental) A comment to describe the cache policy. Default: - no comment

  • cookie_behavior (Optional[CacheCookieBehavior]) – (experimental) 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]) – (experimental) 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 and minTtl

  • enable_accept_encoding_brotli (Optional[bool]) – (experimental) Whether to normalize and include the Accept-Encoding header in the cache key when the Accept-Encoding header is ‘br’. Default: false

  • enable_accept_encoding_gzip (Optional[bool]) – (experimental) Whether to normalize and include the Accept-Encoding header in the cache key when the Accept-Encoding header is ‘gzip’. Default: false

  • header_behavior (Optional[CacheHeaderBehavior]) – (experimental) 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]) – (experimental) 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 and defaultTtl

  • min_ttl (Optional[Duration]) – (experimental) The minimum amount of time for objects to stay in the CloudFront cache. Default: Duration.seconds(0)

  • query_string_behavior (Optional[CacheQueryStringBehavior]) – (experimental) 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()

Stability

experimental

Attributes

cache_policy_name

(experimental) A unique name to identify the cache policy.

The name must only include ‘-‘, ‘_’, or alphanumeric characters.

Default
  • generated from the id

Stability

experimental

Return type

Optional[str]

comment

(experimental) A comment to describe the cache policy.

Default
  • no comment

Stability

experimental

Return type

Optional[str]

cookie_behavior

(experimental) 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()

Stability

experimental

Return type

Optional[CacheCookieBehavior]

default_ttl

(experimental) 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 and minTtl

Stability

experimental

Return type

Optional[Duration]

enable_accept_encoding_brotli

(experimental) Whether to normalize and include the Accept-Encoding header in the cache key when the Accept-Encoding header is ‘br’.

Default

false

Stability

experimental

Return type

Optional[bool]

enable_accept_encoding_gzip

(experimental) Whether to normalize and include the Accept-Encoding header in the cache key when the Accept-Encoding header is ‘gzip’.

Default

false

Stability

experimental

Return type

Optional[bool]

header_behavior

(experimental) 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()

Stability

experimental

Return type

Optional[CacheHeaderBehavior]

max_ttl

(experimental) 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 and defaultTtl

Stability

experimental

Return type

Optional[Duration]

min_ttl

(experimental) The minimum amount of time for objects to stay in the CloudFront cache.

Default

Duration.seconds(0)

Stability

experimental

Return type

Optional[Duration]

query_string_behavior

(experimental) 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()

Stability

experimental

Return type

Optional[CacheQueryStringBehavior]