Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

feat(cloudfront): support for cache policies #10656

Merged
merged 11 commits into from
Oct 7, 2020
Merged

feat(cloudfront): support for cache policies #10656

Show file tree
Hide file tree
Changes from 8 commits
Commits
Show all changes
11 commits
Select commit Hold shift + click to select a range
141494f
feat(cloudfront): support for cache policies
njlynch Sep 30, 2020
a861270
PR feedback updates
njlynch Oct 6, 2020
0c3b27c
Merge remote-tracking branch 'origin/master' into njlynch/cf-cache-po…
njlynch Oct 6, 2020
de84250
Origins integ tests
njlynch Oct 6, 2020
f55aa23
Updated cache policy name regex, removed attributes
njlynch Oct 7, 2020
c65fa14
More PR feedback
njlynch Oct 7, 2020
8c0591c
Merge remote-tracking branch 'origin/master' into njlynch/cf-cache-po…
njlynch Oct 7, 2020
97648fd
Updating README with optional params note
njlynch Oct 7, 2020
cd05f7c
Merge branch 'master' into njlynch/cf-cache-policy
mergify[bot] Oct 7, 2020
b032060
Updated integ test
njlynch Oct 7, 2020
d1c62a5
Handled if cachePolicyName is a token
njlynch Oct 7, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 1 addition & 3 deletions packages/@aws-cdk/aws-cloudfront-origins/test/integ.http-origin.expected.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,9 +5,7 @@
"Properties": {
"DistributionConfig": {
"DefaultCacheBehavior": {
"ForwardedValues": {
"QueryString": false
},
"CachePolicyId": "658327ea-f89d-4fab-a63d-7e88639e58f6",
"TargetOriginId": "cloudfronthttporiginDistributionOrigin162B02709",
"ViewerProtocolPolicy": "allow-all"
},
Expand Down
4 changes: 1 addition & 3 deletions packages/@aws-cdk/aws-cloudfront-origins/test/integ.load-balancer-origin.expected.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -411,9 +411,7 @@
"Properties": {
"DistributionConfig": {
"DefaultCacheBehavior": {
"ForwardedValues": {
"QueryString": false
},
"CachePolicyId": "658327ea-f89d-4fab-a63d-7e88639e58f6",
"TargetOriginId": "cloudfrontloadbalanceroriginDistributionOrigin1BCC75186",
"ViewerProtocolPolicy": "allow-all"
},
Expand Down
10 changes: 3 additions & 7 deletions packages/@aws-cdk/aws-cloudfront-origins/test/integ.origin-group.expected.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -70,18 +70,14 @@
"DistributionConfig": {
"CacheBehaviors": [
{
"ForwardedValues": {
"QueryString": false
},
"CachePolicyId": "658327ea-f89d-4fab-a63d-7e88639e58f6",
"PathPattern": "/api",
"TargetOriginId": "cloudfrontorigingroupDistributionOriginGroup10B57F1D1",
"ViewerProtocolPolicy": "allow-all"
}
],
"DefaultCacheBehavior": {
"ForwardedValues": {
"QueryString": false
},
"CachePolicyId": "658327ea-f89d-4fab-a63d-7e88639e58f6",
"TargetOriginId": "cloudfrontorigingroupDistributionOriginGroup10B57F1D1",
"ViewerProtocolPolicy": "allow-all"
},
Expand Down Expand Up @@ -153,4 +149,4 @@
}
}
}
}
}
6 changes: 2 additions & 4 deletions packages/@aws-cdk/aws-cloudfront-origins/test/integ.s3-origin.expected.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -69,9 +69,7 @@
"Properties": {
"DistributionConfig": {
"DefaultCacheBehavior": {
"ForwardedValues": {
"QueryString": false
},
"CachePolicyId": "658327ea-f89d-4fab-a63d-7e88639e58f6",
"TargetOriginId": "cloudfronts3originDistributionOrigin1741C4E95",
"ViewerProtocolPolicy": "allow-all"
},
Expand Down Expand Up @@ -106,4 +104,4 @@
}
}
}
}
}
37 changes: 37 additions & 0 deletions packages/@aws-cdk/aws-cloudfront/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -163,6 +163,43 @@ new cloudfront.Distribution(this, 'myDist', {
});
```

### Customizing Cache Keys and TTLs with Cache Policies

You can use a cache policy to improve your cache hit ratio by controlling the values (URL query strings, HTTP headers, and cookies)
that are included in the cache key, and/or adjusting how long items remain in the cache via the time-to-live (TTL) settings.
CloudFront provides some predefined cache policies, known as managed policies, for common use cases. You can use these managed policies,
or you can create your own cache policy that’s specific to your needs.
See https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/controlling-the-cache-key.html for more details.

```ts
// Using an existing cache policy
new cloudfront.Distribution(this, 'myDistManagedPolicy', {
defaultBehavior: {
origin: bucketOrigin,
cachePolicy: cloudfront.CachePolicy.CACHING_OPTIMIZED,
},
});

// Creating a custom cache policy -- all parameters optional
const myCachePolicy = new cloudfront.CachePolicy(this, 'myCachePolicy', {
cachePolicyName: 'MyPolicy',
comment: 'A default policy',
defaultTtl: Duration.days(2),
minTtl: Duration.minutes(1),
maxTtl: Duration.days(10),
cookieBehavior: cloudfront.CacheCookieBehavior.all(),
headerBehavior: cloudfront.CacheHeaderBehavior.allowList('X-CustomHeader'),
queryStringBehavior: cloudfront.CacheQueryStringBehavior.denyList('username'),
enableAcceptEncodingGzip: true,
});
new cloudfront.Distribution(this, 'myDistCustomPolicy', {
defaultBehavior: {
origin: bucketOrigin,
cachePolicy: myCachePolicy,
},
});
```

### Lambda@Edge

Lambda@Edge is an extension of AWS Lambda, a compute service that lets you execute functions that customize the content that CloudFront delivers.
Expand Down
Loading