AWS CloudFormation
User Guide (Version )

AWS::CloudFront::Distribution ForwardedValues

A complex type that specifies how CloudFront handles query strings and cookies.

Syntax

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

JSON

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

YAML

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

Properties

Cookies

A complex type that specifies whether you want CloudFront to forward cookies to the origin and, if so, which ones. For more information about forwarding cookies to the origin, see How CloudFront Forwards, Caches, and Logs Cookies in the Amazon CloudFront Developer Guide.

Required: No

Type: Cookies

Update requires: No interruption

Headers

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

For more information, see Caching Content Based on Request Headers in the Amazon CloudFront Developer Guide.

Required: No

Type: List of String

Update requires: No interruption

QueryString

Indicates whether you want CloudFront to forward query strings to the origin that is associated with this cache behavior and cache based on the query string parameters. CloudFront behavior depends on the value of QueryString and on the values that you specify for QueryStringCacheKeys, if any:

If you specify true for QueryString and you don't specify any values for QueryStringCacheKeys, CloudFront forwards all query string parameters to the origin and caches based on all query string parameters. Depending on how many query string parameters and values you have, this can adversely affect performance because CloudFront must forward more requests to the origin.

If you specify true for QueryString and you specify one or more values for QueryStringCacheKeys, CloudFront forwards all query string parameters to the origin, but it only caches based on the query string parameters that you specify.

If you specify false for QueryString, CloudFront doesn't forward any query string parameters to the origin, and doesn't cache based on query string parameters.

For more information, see Configuring CloudFront to Cache Based on Query String Parameters in the Amazon CloudFront Developer Guide.

Required: Yes

Type: Boolean

Update requires: No interruption

QueryStringCacheKeys

A complex type that contains information about the query string parameters that you want CloudFront to use for caching for this cache behavior.

Required: No

Type: List of String

Update requires: No interruption

See Also

On this page: