AWS::CloudFront::CachePolicy - AWS CloudFormation

AWS::CloudFront::CachePolicy

A cache policy.

When it’s attached to a cache behavior, the cache policy determines the following:

  • The values that CloudFront includes in the cache key. These values can include HTTP headers, cookies, and URL query strings. CloudFront uses the cache key to find an object in its cache that it can return to the viewer.

  • The default, minimum, and maximum time to live (TTL) values that you want objects to stay in the CloudFront cache.

The headers, cookies, and query strings that are included in the cache key are automatically included in requests that CloudFront sends to the origin. CloudFront sends a request when it can’t find a valid object in its cache that matches the request’s cache key. If you want to send values to the origin but not include them in the cache key, use OriginRequestPolicy.

Syntax

To declare this entity in your AWS CloudFormation template, use the following syntax:

JSON

{ "Type" : "AWS::CloudFront::CachePolicy", "Properties" : { "CachePolicyConfig" : CachePolicyConfig } }

YAML

Type: AWS::CloudFront::CachePolicy Properties: CachePolicyConfig: CachePolicyConfig

Properties

CachePolicyConfig

The cache policy configuration.

Required: Yes

Type: CachePolicyConfig

Update requires: No interruption

Return values

Ref

When you pass the logical ID of this resource to the intrinsic Ref function, Ref returns the cache policy ID. For example: 2766f7b2-75c5-41c6-8f06-bf4303a2f2f5.

For more information about using the Ref function, see Ref.

Fn::GetAtt

The Fn::GetAtt intrinsic function returns a value for a specified attribute of this type. The following are the available attributes and sample return values.

For more information about using the Fn::GetAtt intrinsic function, see Fn::GetAtt.

Id

The unique identifier for the cache policy. For example: 2766f7b2-75c5-41c6-8f06-bf4303a2f2f5.

LastModifiedTime

The date and time when the cache policy was last modified.