Package software.amazon.awscdk.services.cloudfront

Interface CfnCachePolicy.QueryStringsConfigProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnCachePolicy.QueryStringsConfigProperty.Jsii$Proxy

Enclosing class:

CfnCachePolicy

@Stability(Stable)
public static interface CfnCachePolicy.QueryStringsConfigProperty
extends software.amazon.jsii.JsiiSerializable

An object that determines whether any URL query strings in viewer requests (and if so, which query strings) are included in the cache key and in requests that CloudFront sends to the origin.

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.cloudfront.*;
 QueryStringsConfigProperty queryStringsConfigProperty = QueryStringsConfigProperty.builder()
         .queryStringBehavior("queryStringBehavior")
         // the properties below are optional
         .queryStrings(List.of("queryStrings"))
         .build();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-cachepolicy-querystringsconfig.html

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static CfnCachePolicy.QueryStringsConfigProperty.Builder	builder()
String	getQueryStringBehavior()	Determines whether any URL query strings in viewer requests are included in the cache key and in requests that CloudFront sends to the origin.
default List<String>	getQueryStrings()	Contains a list of query string names.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getQueryStringBehavior

@Stability(Stable)
@NotNull
String getQueryStringBehavior()

Determines whether any URL query strings in viewer requests are included in the cache key and in requests that CloudFront sends to the origin.

Valid values are:

• none – No query strings in viewer requests are included in the cache key or in requests that CloudFront sends to the origin. Even when this field is set to none , any query strings that are listed in an OriginRequestPolicy are included in origin requests.
• whitelist – Only the query strings in viewer requests that are listed in the QueryStringNames type are included in the cache key and in requests that CloudFront sends to the origin.
• allExcept – All query strings in viewer requests are included in the cache key and in requests that CloudFront sends to the origin, except those that are listed in the QueryStringNames type, which are not included.
• all – All query strings in viewer requests are included in the cache key and in requests that CloudFront sends to the origin.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-cachepolicy-querystringsconfig.html#cfn-cloudfront-cachepolicy-querystringsconfig-querystringbehavior

getQueryStrings

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

Contains a list of query string names.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-cachepolicy-querystringsconfig.html#cfn-cloudfront-cachepolicy-querystringsconfig-querystrings

builder

@Stability(Stable)
static CfnCachePolicy.QueryStringsConfigProperty.Builder builder()

Returns:

a CfnCachePolicy.QueryStringsConfigProperty.Builder of CfnCachePolicy.QueryStringsConfigProperty