AWS::Lightsail::Distribution QueryStringObject - Amazon CloudFormation
SyntaxProperties
Services or capabilities described in Amazon Web Services documentation might vary by Region. To see the differences applicable to the China Regions, see Getting Started with Amazon Web Services in China (PDF).

This is the new Amazon CloudFormation Template Reference Guide. Please update your bookmarks and links. For help getting started with CloudFormation, see the Amazon CloudFormation User Guide.

AWS::Lightsail::Distribution QueryStringObject

QueryStringObject is a property of the CacheSettings property. It describes the query string parameters that an Amazon Lightsail content delivery network (CDN) distribution to bases caching on.

For the query strings that you specify, your distribution caches separate versions of the specified content based on the query string values in viewer requests.

Syntax

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

JSON

{
  "Option" : Boolean,
  "QueryStringsAllowList" : [ String, ... ]
}

YAML

  Option: Boolean
  QueryStringsAllowList: 
    - String

Properties

Option

Indicates whether the distribution forwards and caches based on query strings.

Required: No

Type: Boolean

Update requires: No interruption

QueryStringsAllowList

The specific query strings that the distribution forwards to the origin.

Your distribution caches content based on the specified query strings.

If the option parameter is true, then your distribution forwards all query strings, regardless of what you specify using the QueryStringsAllowList parameter.

Required: No

Type: Array of String

Update requires: No interruption