ParametersInCacheKeyAndForwardedToOriginProperty Struct
This object determines the values that CloudFront includes in the cache key.
These values can include HTTP headers, cookies, and URL query strings. CloudFront uses the cache key to find an object in its cache that it can return to the viewer.
The headers, cookies, and query strings that are included in the cache key are also included in requests that CloudFront sends to the origin. CloudFront sends a request when it can't find an object in its cache that matches the request's cache key. If you want to send values to the origin but not include them in the cache key, use OriginRequestPolicy .
| Source | |
|---|---|
| Type last changed |
Example
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_cloudfront as cloudfront } from 'aws-cdk-lib';
const parametersInCacheKeyAndForwardedToOriginProperty: cloudfront.CfnCachePolicy.ParametersInCacheKeyAndForwardedToOriginProperty = {
cookiesConfig: {
cookieBehavior: 'cookieBehavior',
// the properties below are optional
cookies: ['cookies'],
},
enableAcceptEncodingGzip: false,
headersConfig: {
headerBehavior: 'headerBehavior',
// the properties below are optional
headers: ['headers'],
},
queryStringsConfig: {
queryStringBehavior: 'queryStringBehavior',
// the properties below are optional
queryStrings: ['queryStrings'],
},
// the properties below are optional
enableAcceptEncodingBrotli: false,
};
# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_cloudfront as cloudfront
parameters_in_cache_key_and_forwarded_to_origin_property = cloudfront.CfnCachePolicy.ParametersInCacheKeyAndForwardedToOriginProperty(
cookies_config=cloudfront.CfnCachePolicy.CookiesConfigProperty(
cookie_behavior="cookieBehavior",
# the properties below are optional
cookies=["cookies"]
),
enable_accept_encoding_gzip=False,
headers_config=cloudfront.CfnCachePolicy.HeadersConfigProperty(
header_behavior="headerBehavior",
# the properties below are optional
headers=["headers"]
),
query_strings_config=cloudfront.CfnCachePolicy.QueryStringsConfigProperty(
query_string_behavior="queryStringBehavior",
# the properties below are optional
query_strings=["queryStrings"]
),
# the properties below are optional
enable_accept_encoding_brotli=False
)
// 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.*;
ParametersInCacheKeyAndForwardedToOriginProperty parametersInCacheKeyAndForwardedToOriginProperty = ParametersInCacheKeyAndForwardedToOriginProperty.builder()
.cookiesConfig(CookiesConfigProperty.builder()
.cookieBehavior("cookieBehavior")
// the properties below are optional
.cookies(List.of("cookies"))
.build())
.enableAcceptEncodingGzip(false)
.headersConfig(HeadersConfigProperty.builder()
.headerBehavior("headerBehavior")
// the properties below are optional
.headers(List.of("headers"))
.build())
.queryStringsConfig(QueryStringsConfigProperty.builder()
.queryStringBehavior("queryStringBehavior")
// the properties below are optional
.queryStrings(List.of("queryStrings"))
.build())
// the properties below are optional
.enableAcceptEncodingBrotli(false)
.build();
// Install: dotnet add package Amazon.CDK.Lib
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.CloudFront;
var parametersInCacheKeyAndForwardedToOriginProperty = new ParametersInCacheKeyAndForwardedToOriginProperty {
CookiesConfig = new CookiesConfigProperty {
CookieBehavior = "cookieBehavior",
// the properties below are optional
Cookies = new [] { "cookies" }
},
EnableAcceptEncodingGzip = false,
HeadersConfig = new HeadersConfigProperty {
HeaderBehavior = "headerBehavior",
// the properties below are optional
Headers = new [] { "headers" }
},
QueryStringsConfig = new QueryStringsConfigProperty {
QueryStringBehavior = "queryStringBehavior",
// the properties below are optional
QueryStrings = new [] { "queryStrings" }
},
// the properties below are optional
EnableAcceptEncodingBrotli = false
};
// Install: go get github.com/aws/aws-cdk-go/awscdk/v2
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"
parametersInCacheKeyAndForwardedToOriginProperty := &ParametersInCacheKeyAndForwardedToOriginProperty{
CookiesConfig: &CookiesConfigProperty{
CookieBehavior: jsii.String("cookieBehavior"),
// the properties below are optional
Cookies: []*string{
jsii.String("cookies"),
},
},
EnableAcceptEncodingGzip: jsii.Boolean(false),
HeadersConfig: &HeadersConfigProperty{
HeaderBehavior: jsii.String("headerBehavior"),
// the properties below are optional
Headers: []*string{
jsii.String("headers"),
},
},
QueryStringsConfig: &QueryStringsConfigProperty{
QueryStringBehavior: jsii.String("queryStringBehavior"),
// the properties below are optional
QueryStrings: []*string{
jsii.String("queryStrings"),
},
},
// the properties below are optional
EnableAcceptEncodingBrotli: jsii.Boolean(false),
}
Properties
cookiesConfigIResolvable | CfnCachePolicy.cookies_configtyping.Union[IResolvable, CookiesConfigProperty]cookiesConfigIResolvableCookiesConfigIResolvableCookiesConfiginterface{} required #enableAcceptEncodingBrotlioptionalboolean | IResolvableenable_accept_encoding_brotlioptionaltyping.Union[bool, IResolvable]enableAcceptEncodingBrotlioptionalBooleanEnableAcceptEncodingBrotlioptionalboolEnableAcceptEncodingBrotlioptionalinterface{} #notes
This field is related to the EnableAcceptEncodingGzip field. If one or both of these fields is true and the viewer request includes the Accept-Encoding header, then CloudFront does the following:
- Normalizes the value of the viewer's
Accept-Encodingheader - Includes the normalized header in the cache key
- Includes the normalized header in the request to the origin, if a request is necessary
For more information, see Compression support in the Amazon CloudFront Developer Guide .
If you set this value to true , and this cache behavior also has an origin request policy attached, do not include the Accept-Encoding header in the origin request policy. CloudFront always includes the Accept-Encoding header in origin requests when the value of this field is true , so including this header in an origin request policy has no effect.
If both of these fields are false , then CloudFront treats the Accept-Encoding header the same as any other HTTP header in the viewer request. By default, it's not included in the cache key and it's not included in origin requests. In this case, you can manually add Accept-Encoding to the headers whitelist like any other HTTP header.
enableAcceptEncodingGzipboolean | IResolvableenable_accept_encoding_gziptyping.Union[bool, IResolvable]enableAcceptEncodingGzipBooleanEnableAcceptEncodingGzipboolEnableAcceptEncodingGzipinterface{} required #notes
This field is related to the EnableAcceptEncodingBrotli field. If one or both of these fields is true and the viewer request includes the Accept-Encoding header, then CloudFront does the following:
- Normalizes the value of the viewer's
Accept-Encodingheader - Includes the normalized header in the cache key
- Includes the normalized header in the request to the origin, if a request is necessary
For more information, see Compression support in the Amazon CloudFront Developer Guide .
If you set this value to true , and this cache behavior also has an origin request policy attached, do not include the Accept-Encoding header in the origin request policy. CloudFront always includes the Accept-Encoding header in origin requests when the value of this field is true , so including this header in an origin request policy has no effect.
If both of these fields are false , then CloudFront treats the Accept-Encoding header the same as any other HTTP header in the viewer request. By default, it's not included in the cache key and it's not included in origin requests. In this case, you can manually add Accept-Encoding to the headers whitelist like any other HTTP header.
headersConfigIResolvable | CfnCachePolicy.headers_configtyping.Union[IResolvable, HeadersConfigProperty]headersConfigIResolvableHeadersConfigIResolvableHeadersConfiginterface{} required #queryStringsConfigIResolvable | CfnCachePolicy.query_strings_configtyping.Union[IResolvable, QueryStringsConfigProperty]queryStringsConfigIResolvableQueryStringsConfigIResolvableQueryStringsConfiginterface{} required #