Interface CfnDistribution.CacheBehaviorProperty
- All Superinterfaces:
software.amazon.jsii.JsiiSerializable
- All Known Implementing Classes:
CfnDistribution.CacheBehaviorProperty.Jsii$Proxy
- Enclosing class:
CfnDistribution
You must create at least as many cache behaviors (including the default cache behavior) as you have origins if you want CloudFront to serve objects from all of the origins. Each cache behavior specifies the one origin from which you want CloudFront to get objects. If you have two origins and only the default cache behavior, the default cache behavior will cause CloudFront to get objects from one of the origins, but the other origin is never used.
For the current quota (formerly known as limit) on the number of cache behaviors that you can add to a distribution, see Quotas in the Amazon CloudFront Developer Guide .
If you don't want to specify any cache behaviors, include only an empty CacheBehaviors
element. Don't specify an empty individual CacheBehavior
element, because this is invalid. For more information, see CacheBehaviors .
To delete all cache behaviors in an existing distribution, update the distribution configuration and include only an empty CacheBehaviors
element.
To add, change, or remove one or more cache behaviors, update the distribution configuration and specify all of the cache behaviors that you want to include in the updated distribution.
For more information about cache behaviors, see Cache Behavior Settings in the Amazon CloudFront Developer Guide .
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.*; CacheBehaviorProperty cacheBehaviorProperty = CacheBehaviorProperty.builder() .pathPattern("pathPattern") .targetOriginId("targetOriginId") .viewerProtocolPolicy("viewerProtocolPolicy") // the properties below are optional .allowedMethods(List.of("allowedMethods")) .cachedMethods(List.of("cachedMethods")) .cachePolicyId("cachePolicyId") .compress(false) .defaultTtl(123) .fieldLevelEncryptionId("fieldLevelEncryptionId") .forwardedValues(ForwardedValuesProperty.builder() .queryString(false) // the properties below are optional .cookies(CookiesProperty.builder() .forward("forward") // the properties below are optional .whitelistedNames(List.of("whitelistedNames")) .build()) .headers(List.of("headers")) .queryStringCacheKeys(List.of("queryStringCacheKeys")) .build()) .functionAssociations(List.of(FunctionAssociationProperty.builder() .eventType("eventType") .functionArn("functionArn") .build())) .lambdaFunctionAssociations(List.of(LambdaFunctionAssociationProperty.builder() .eventType("eventType") .includeBody(false) .lambdaFunctionArn("lambdaFunctionArn") .build())) .maxTtl(123) .minTtl(123) .originRequestPolicyId("originRequestPolicyId") .realtimeLogConfigArn("realtimeLogConfigArn") .responseHeadersPolicyId("responseHeadersPolicyId") .smoothStreaming(false) .trustedKeyGroups(List.of("trustedKeyGroups")) .trustedSigners(List.of("trustedSigners")) .build();
- See Also:
-
Nested Class Summary
Nested ClassesModifier and TypeInterfaceDescriptionstatic final class
A builder forCfnDistribution.CacheBehaviorProperty
static final class
An implementation forCfnDistribution.CacheBehaviorProperty
-
Method Summary
Modifier and TypeMethodDescriptionbuilder()
A complex type that controls which HTTP methods CloudFront processes and forwards to your Amazon S3 bucket or your custom origin.A complex type that controls whether CloudFront caches the response to requests using the specified HTTP methods.default String
The unique identifier of the cache policy that is attached to this cache behavior.default Object
Whether you want CloudFront to automatically compress certain files for this cache behavior.default Number
This field is deprecated.default String
The value ofID
for the field-level encryption configuration that you want CloudFront to use for encrypting specific fields of data for this cache behavior.default Object
This field is deprecated.default Object
A list of CloudFront functions that are associated with this cache behavior.default Object
A complex type that contains zero or more Lambda@Edge function associations for a cache behavior.default Number
This field is deprecated.default Number
This field is deprecated.default String
The unique identifier of the origin request policy that is attached to this cache behavior.The pattern (for example,images/*.jpg
) that specifies which requests to apply the behavior to.default String
The Amazon Resource Name (ARN) of the real-time log configuration that is attached to this cache behavior.default String
The identifier for a response headers policy.default Object
Indicates whether you want to distribute media files in the Microsoft Smooth Streaming format using the origin that is associated with this cache behavior.The value ofID
for the origin that you want CloudFront to route requests to when they match this cache behavior.A list of key groups that CloudFront can use to validate signed URLs or signed cookies.The protocol that viewers can use to access the files in the origin specified byTargetOriginId
when a request matches the path pattern inPathPattern
.Methods inherited from interface software.amazon.jsii.JsiiSerializable
$jsii$toJson
-
Method Details
-
getPathPattern
The pattern (for example,images/*.jpg
) that specifies which requests to apply the behavior to. When CloudFront receives a viewer request, the requested path is compared with path patterns in the order in which cache behaviors are listed in the distribution.You can optionally include a slash (
/
) at the beginning of the path pattern. For example,/images/*.jpg
. CloudFront behavior is the same with or without the leading/
.The path pattern for the default cache behavior is
*
and cannot be changed. If the request for an object does not match the path pattern for any cache behaviors, CloudFront applies the behavior in the default cache behavior.For more information, see Path Pattern in the Amazon CloudFront Developer Guide .
- See Also:
-
getTargetOriginId
The value ofID
for the origin that you want CloudFront to route requests to when they match this cache behavior.- See Also:
-
getViewerProtocolPolicy
The protocol that viewers can use to access the files in the origin specified byTargetOriginId
when a request matches the path pattern inPathPattern
.You can specify the following options:
allow-all
: Viewers can use HTTP or HTTPS.redirect-to-https
: If a viewer submits an HTTP request, CloudFront returns an HTTP status code of 301 (Moved Permanently) to the viewer along with the HTTPS URL. The viewer then resubmits the request using the new URL.https-only
: If a viewer sends an HTTP request, CloudFront returns an HTTP status code of 403 (Forbidden).
For more information about requiring the HTTPS protocol, see Requiring HTTPS Between Viewers and CloudFront in the Amazon CloudFront Developer Guide .
The only way to guarantee that viewers retrieve an object that was fetched from the origin using HTTPS is never to use any other protocol to fetch the object. If you have recently changed from HTTP to HTTPS, we recommend that you clear your objects' cache because cached objects are protocol agnostic. That means that an edge location will return an object from the cache regardless of whether the current request protocol matches the protocol used previously. For more information, see Managing Cache Expiration in the Amazon CloudFront Developer Guide .
- See Also:
-
getAllowedMethods
A complex type that controls which HTTP methods CloudFront processes and forwards to your Amazon S3 bucket or your custom origin.There are three choices:
- CloudFront forwards only
GET
andHEAD
requests. - CloudFront forwards only
GET
,HEAD
, andOPTIONS
requests. - CloudFront forwards
GET, HEAD, OPTIONS, PUT, PATCH, POST
, andDELETE
requests.
If you pick the third choice, you may need to restrict access to your Amazon S3 bucket or to your custom origin so users can't perform operations that you don't want them to. For example, you might not want users to have permissions to delete objects from your origin.
- See Also:
- CloudFront forwards only
-
getCachedMethods
A complex type that controls whether CloudFront caches the response to requests using the specified HTTP methods.There are two choices:
- CloudFront caches responses to
GET
andHEAD
requests. - CloudFront caches responses to
GET
,HEAD
, andOPTIONS
requests.
If you pick the second choice for your Amazon S3 Origin, you may need to forward Access-Control-Request-Method, Access-Control-Request-Headers, and Origin headers for the responses to be cached correctly.
- See Also:
- CloudFront caches responses to
-
getCachePolicyId
The unique identifier of the cache policy that is attached to this cache behavior.For more information, see Creating cache policies or Using the managed cache policies in the Amazon CloudFront Developer Guide .
A
CacheBehavior
must include either aCachePolicyId
orForwardedValues
. We recommend that you use aCachePolicyId
.- See Also:
-
getCompress
Whether you want CloudFront to automatically compress certain files for this cache behavior.If so, specify true; if not, specify false. For more information, see Serving Compressed Files in the Amazon CloudFront Developer Guide .
Default: - false
- See Also:
-
getDefaultTtl
This field is deprecated.We recommend that you use the
DefaultTTL
field in a cache policy instead of this field. For more information, see Creating cache policies or Using the managed cache policies in the Amazon CloudFront Developer Guide .The default amount of time that you want objects to stay in CloudFront caches before CloudFront forwards another request to your origin to determine whether the object has been updated. The value that you specify applies only when your origin does not add HTTP headers such as
Cache-Control max-age
,Cache-Control s-maxage
, andExpires
to objects. For more information, see Managing How Long Content Stays in an Edge Cache (Expiration) in the Amazon CloudFront Developer Guide .Default: - 86400
- See Also:
-
getFieldLevelEncryptionId
The value ofID
for the field-level encryption configuration that you want CloudFront to use for encrypting specific fields of data for this cache behavior.Default: - ""
- See Also:
-
getForwardedValues
This field is deprecated.We recommend that you use a cache policy or an origin request policy instead of this field. For more information, see Working with policies in the Amazon CloudFront Developer Guide .
If you want to include values in the cache key, use a cache policy. For more information, see Creating cache policies or Using the managed cache policies in the Amazon CloudFront Developer Guide .
If you want to send values to the origin but not include them in the cache key, use an origin request policy. For more information, see Creating origin request policies or Using the managed origin request policies in the Amazon CloudFront Developer Guide .
A
CacheBehavior
must include either aCachePolicyId
orForwardedValues
. We recommend that you use aCachePolicyId
.A complex type that specifies how CloudFront handles query strings, cookies, and HTTP headers.
- See Also:
-
getFunctionAssociations
A list of CloudFront functions that are associated with this cache behavior.CloudFront functions must be published to the
LIVE
stage to associate them with a cache behavior.- See Also:
-
getLambdaFunctionAssociations
A complex type that contains zero or more Lambda@Edge function associations for a cache behavior.- See Also:
-
getMaxTtl
This field is deprecated.We recommend that you use the
MaxTTL
field in a cache policy instead of this field. For more information, see Creating cache policies or Using the managed cache policies in the Amazon CloudFront Developer Guide .The maximum amount of time that you want objects to stay in CloudFront caches before CloudFront forwards another request to your origin to determine whether the object has been updated. The value that you specify applies only when your origin adds HTTP headers such as
Cache-Control max-age
,Cache-Control s-maxage
, andExpires
to objects. For more information, see Managing How Long Content Stays in an Edge Cache (Expiration) in the Amazon CloudFront Developer Guide .Default: - 31536000
- See Also:
-
getMinTtl
This field is deprecated.We recommend that you use the
MinTTL
field in a cache policy instead of this field. For more information, see Creating cache policies or Using the managed cache policies in the Amazon CloudFront Developer Guide .The minimum amount of time that you want objects to stay in CloudFront caches before CloudFront forwards another request to your origin to determine whether the object has been updated. For more information, see Managing How Long Content Stays in an Edge Cache (Expiration) in the Amazon CloudFront Developer Guide .
You must specify
0
forMinTTL
if you configure CloudFront to forward all headers to your origin (underHeaders
, if you specify1
forQuantity
and*
forName
).Default: - 0
- See Also:
-
getOriginRequestPolicyId
The unique identifier of the origin request policy that is attached to this cache behavior.For more information, see Creating origin request policies or Using the managed origin request policies in the Amazon CloudFront Developer Guide .
- See Also:
-
getRealtimeLogConfigArn
The Amazon Resource Name (ARN) of the real-time log configuration that is attached to this cache behavior.For more information, see Real-time logs in the Amazon CloudFront Developer Guide .
- See Also:
-
getResponseHeadersPolicyId
The identifier for a response headers policy.- See Also:
-
getSmoothStreaming
Indicates whether you want to distribute media files in the Microsoft Smooth Streaming format using the origin that is associated with this cache behavior.If so, specify
true
; if not, specifyfalse
. If you specifytrue
forSmoothStreaming
, you can still distribute other content using this cache behavior if the content matches the value ofPathPattern
.Default: - false
- See Also:
-
getTrustedKeyGroups
A list of key groups that CloudFront can use to validate signed URLs or signed cookies.When a cache behavior contains trusted key groups, CloudFront requires signed URLs or signed cookies for all requests that match the cache behavior. The URLs or cookies must be signed with a private key whose corresponding public key is in the key group. The signed URL or cookie contains information about which public key CloudFront should use to verify the signature. For more information, see Serving private content in the Amazon CloudFront Developer Guide .
- See Also:
-
getTrustedSigners
We recommend using
TrustedKeyGroups
instead ofTrustedSigners
.A list of AWS account IDs whose public keys CloudFront can use to validate signed URLs or signed cookies.
When a cache behavior contains trusted signers, CloudFront requires signed URLs or signed cookies for all requests that match the cache behavior. The URLs or cookies must be signed with the private key of a CloudFront key pair in the trusted signer's AWS account . The signed URL or cookie contains information about which public key CloudFront should use to verify the signature. For more information, see Serving private content in the Amazon CloudFront Developer Guide .
- See Also:
-
builder
-