Package software.amazon.awscdk.services.lightsail

Interface CfnDistribution.QueryStringObjectProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnDistribution.QueryStringObjectProperty.Jsii$Proxy

Enclosing class:

CfnDistribution

@Stability(Stable)
public static interface CfnDistribution.QueryStringObjectProperty
extends software.amazon.jsii.JsiiSerializable

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.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.lightsail.*;
 QueryStringObjectProperty queryStringObjectProperty = QueryStringObjectProperty.builder()
         .option(false)
         .queryStringsAllowList(List.of("queryStringsAllowList"))
         .build();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lightsail-distribution-querystringobject.html

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnDistribution.QueryStringObjectProperty.Builder	A builder for CfnDistribution.QueryStringObjectProperty
static final class	CfnDistribution.QueryStringObjectProperty.Jsii$Proxy	An implementation for CfnDistribution.QueryStringObjectProperty

Method Summary

Modifier and Type	Method	Description
static CfnDistribution.QueryStringObjectProperty.Builder	builder()
default Object	getOption()	Indicates whether the distribution forwards and caches based on query strings.
default List<String>	getQueryStringsAllowList()	The specific query strings that the distribution forwards to the origin.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getOption

@Stability(Stable)
@Nullable
default Object getOption()

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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lightsail-distribution-querystringobject.html#cfn-lightsail-distribution-querystringobject-option

getQueryStringsAllowList

@Stability(Stable)
@Nullable
default List<String> getQueryStringsAllowList()

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.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lightsail-distribution-querystringobject.html#cfn-lightsail-distribution-querystringobject-querystringsallowlist

builder

@Stability(Stable)
static CfnDistribution.QueryStringObjectProperty.Builder builder()

Returns:

a CfnDistribution.QueryStringObjectProperty.Builder of CfnDistribution.QueryStringObjectProperty