Sign In to the Console
AWS CloudFormation
User Guide (API Version 2010-05-15)

AWS Documentation » AWS CloudFormation » User Guide » Template Reference » AWS Resource and Property Types Reference » Amazon CloudFront Resource Types Reference » AWS::CloudFront::Distribution » CloudFront Distribution ForwardedValues

CloudFront Distribution ForwardedValues

ForwardedValues is a property of the DefaultCacheBehavior and CacheBehavior properties that indicates whether Amazon CloudFront forwards query strings or cookies.

Syntax

JSON

{
  "Cookies" : Cookies,
  "Headers" : [ String, ... ],
  "QueryString" : Boolean,
  "QueryStringCacheKeys" : [ String, ... ]
}

YAML

Cookies:
  Cookies
Headers:
  - String
QueryString: Boolean
QueryStringCacheKeys:
  - String

Properties

Note

For more information about the constraints and valid values of each property, see the ForwardedValues data type in the Amazon CloudFront API Reference.

Cookies

Forwards specified cookies to the origin of the cache behavior. For more information, see Configuring CloudFront to Cache Based on Cookies in the Amazon CloudFront Developer Guide.

Required: No

Type: CloudFront Distribution Cookies

Headers

Specifies the headers that you want Amazon CloudFront to forward to the origin for this cache behavior (whitelisted headers). For the headers that you specify, Amazon CloudFront also caches separate versions of a specified object that is based on the header values in viewer requests.

For custom origins, if you specify a single asterisk (["*"]), all headers are forwarded. If you don't specify a value, only the default headers are forwarded. For Amazon S3 origins, you can forward only selected headers; specifying * is not supported. For more information, see Configuring CloudFront to Cache Objects Based on Request Headers in the Amazon CloudFront Developer Guide.

Required: No

Type: List of String values

QueryString

Indicates whether you want CloudFront to forward query strings to the origin that is associated with this cache behavior. If so, specify true; if not, specify false. For more information about forwarding query strings, see the QueryString parameter for the ForwardedValues type in the Amazon CloudFront API Reference.

Required: Yes

Type: Boolean

QueryStringCacheKeys

If you forward query strings to the origin, specifies the query string parameters that CloudFront uses to determine which content to cache. For more information, see Configuring CloudFront to Cache Based on Query String Parameters in the Amazon CloudFront Developer Guide.

Required: No

Type: List of String values

On this page: