feat(cloudfront): brotli compression support (#10950)

Enable brotli compression support in `CachePolicy` Closes #10947 ---- *By submitting this pull request, I confirm that my contribution is made under the terms of the Apache-2.0 license*
aws · Oct 20, 2020 · dd81e77 · dd81e77
1 parent 37dc9d8
commit dd81e77
Show file tree

Hide file tree

Showing 4 changed files with 12 additions and 0 deletions.
diff --git a/packages/@aws-cdk/aws-cloudfront/README.md b/packages/@aws-cdk/aws-cloudfront/README.md
@@ -194,6 +194,7 @@ const myCachePolicy = new cloudfront.CachePolicy(this, 'myCachePolicy', {
   headerBehavior: cloudfront.CacheHeaderBehavior.allowList('X-CustomHeader'),
   queryStringBehavior: cloudfront.CacheQueryStringBehavior.denyList('username'),
   enableAcceptEncodingGzip: true,
+  enableAcceptEncodingBrotli: true,
 });
 new cloudfront.Distribution(this, 'myDistCustomPolicy', {
   defaultBehavior: {

diff --git a/packages/@aws-cdk/aws-cloudfront/lib/cache-policy.ts b/packages/@aws-cdk/aws-cloudfront/lib/cache-policy.ts
@@ -75,6 +75,12 @@ export interface CachePolicyProps {
    * @default false
    */
   readonly enableAcceptEncodingGzip?: boolean;
+
+  /**
+   * Whether to normalize and include the `Accept-Encoding` header in the cache key when the `Accept-Encoding` header is 'br'.
+   * @default false
+   */
+  readonly enableAcceptEncodingBrotli?: boolean;
 }
 
 /**
@@ -160,6 +166,7 @@ export class CachePolicy extends Resource implements ICachePolicy {
         headers: headers.headers,
       },
       enableAcceptEncodingGzip: props.enableAcceptEncodingGzip ?? false,
+      enableAcceptEncodingBrotli: props.enableAcceptEncodingBrotli ?? false,
       queryStringsConfig: {
         queryStringBehavior: queryStrings.behavior,
         queryStrings: queryStrings.queryStrings,

diff --git a/packages/@aws-cdk/aws-cloudfront/test/cache-policy.test.ts b/packages/@aws-cdk/aws-cloudfront/test/cache-policy.test.ts
@@ -33,6 +33,7 @@ describe('CachePolicy', () => {
             CookieBehavior: 'none',
           },
           EnableAcceptEncodingGzip: false,
+          EnableAcceptEncodingBrotli: false,
           HeadersConfig: {
             HeaderBehavior: 'none',
           },
@@ -55,6 +56,7 @@ describe('CachePolicy', () => {
       headerBehavior: CacheHeaderBehavior.allowList('X-CustomHeader'),
       queryStringBehavior: CacheQueryStringBehavior.denyList('username'),
       enableAcceptEncodingGzip: true,
+      enableAcceptEncodingBrotli: true,
     });
 
     expect(stack).toHaveResource('AWS::CloudFront::CachePolicy', {
@@ -77,6 +79,7 @@ describe('CachePolicy', () => {
             QueryStrings: ['username'],
           },
           EnableAcceptEncodingGzip: true,
+          EnableAcceptEncodingBrotli: true,
         },
       },
     });

diff --git a/packages/@aws-cdk/aws-cloudfront/test/integ.distribution-policies.expected.json b/packages/@aws-cdk/aws-cloudfront/test/integ.distribution-policies.expected.json
@@ -13,6 +13,7 @@
               "CookieBehavior": "none"
             },
             "EnableAcceptEncodingGzip": false,
+            "EnableAcceptEncodingBrotli": false,
             "HeadersConfig": {
               "HeaderBehavior": "none"
             },