feat(apigateway): minCompressionSize on SpecRestApi (#24067)

This PR adds minCompressionSize to SpecRestApi, which allows compression on api's payload. Within SpecRestApi ``` minComppresssionSize: Size``` is the additional prop added to SpecRestApiProps to support minCompressionSize which takes class Size, the value of how much the payload needs to be compressed. This PR also adds minCompressionSize to RestApi which supports Size class e.g ``` minComppresssionSize: Size``` and deprecates minimumCompressionSize which has number as a type. For example, ```ts const api = new apigw.RestApi(stack, 'RestApi', { minCompressionSize: Size.bytes(1024), }); ``` compression for the payload would be 1024 bytes which is equivalent to 1 kibibyte. Closes #22926. ---- *By submitting this pull request, I confirm that my contribution is made under the terms of the Apache-2.0 license*
aws · Mar 1, 2023 · 2a81f0f · 2a81f0f
1 parent 52aa03c
commit 2a81f0f
Show file tree

Hide file tree

Showing 18 changed files with 429 additions and 202 deletions.
diff --git a/packages/@aws-cdk/aws-apigateway/lib/restapi.ts b/packages/@aws-cdk/aws-apigateway/lib/restapi.ts
@@ -1,7 +1,7 @@
 import * as cloudwatch from '@aws-cdk/aws-cloudwatch';
 import { IVpcEndpoint } from '@aws-cdk/aws-ec2';
 import * as iam from '@aws-cdk/aws-iam';
-import { ArnFormat, CfnOutput, IResource as IResourceBase, Resource, Stack, Token, FeatureFlags, RemovalPolicy } from '@aws-cdk/core';
+import { ArnFormat, CfnOutput, IResource as IResourceBase, Resource, Stack, Token, FeatureFlags, RemovalPolicy, Size } from '@aws-cdk/core';
 import { APIGATEWAY_DISABLE_CLOUDWATCH_ROLE } from '@aws-cdk/cx-api';
 import { Construct } from 'constructs';
 import { ApiDefinition } from './api-definition';
@@ -225,9 +225,22 @@ export interface RestApiProps extends RestApiOptions {
  * payload size.
  *
  * @default - Compression is disabled.
+ * @deprecated - superseded by `minCompressionSize`
  */
  readonly minimumCompressionSize?: number;
 
+ /**
+ * A Size(in bytes, kibibytes, mebibytes etc) that is used to enable compression (with non-negative
+ * between 0 and 10485760 (10M) bytes, inclusive) or disable compression
+ * (when undefined) on an API. When compression is enabled, compression or
+ * decompression is not applied on the payload if the payload size is
+ * smaller than this value. Setting it to zero allows compression for any
+ * payload size.
+ *
+ * @default - Compression is disabled.
+ */
+ readonly minCompressionSize?: Size;
+
  /**
  * The ID of the API Gateway RestApi resource that you want to clone.
  *
@@ -261,6 +274,18 @@ export interface SpecRestApiProps extends RestApiBaseProps {
  * @see https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-import-api.html
  */
  readonly apiDefinition: ApiDefinition;
+
+ /**
+ * A Size(in bytes, kibibytes, mebibytes etc) that is used to enable compression (with non-negative
+ * between 0 and 10485760 (10M) bytes, inclusive) or disable compression
+ * (when undefined) on an API. When compression is enabled, compression or
+ * decompression is not applied on the payload if the payload size is
+ * smaller than this value. Setting it to zero allows compression for any
+ * payload size.
+ *
+ * @default - Compression is disabled.
+ */
+ readonly minCompressionSize?: Size;
 }
 
 /**
@@ -648,6 +673,7 @@ export class SpecRestApi extends RestApiBase {
  name: this.restApiName,
  policy: props.policy,
  failOnWarnings: props.failOnWarnings,
+ minimumCompressionSize: props.minCompressionSize?.toBytes(),
  body: apiDefConfig.inlineDefinition ?? undefined,
  bodyS3Location: apiDefConfig.inlineDefinition ? undefined : apiDefConfig.s3Location,
  endpointConfiguration: this._configureEndpoints(props),
@@ -758,12 +784,16 @@ export class RestApi extends RestApiBase {
  constructor(scope: Construct, id: string, props: RestApiProps = { }) {
  super(scope, id, props);
 
+ if (props.minCompressionSize !== undefined && props.minimumCompressionSize !== undefined) {
+ throw new Error('both properties minCompressionSize and minimumCompressionSize cannot be set at once.');
+ }
+
  const resource = new CfnRestApi(this, 'Resource', {
  name: this.physicalName,
  description: props.description,
  policy: props.policy,
  failOnWarnings: props.failOnWarnings,
- minimumCompressionSize: props.minimumCompressionSize,
+ minimumCompressionSize: props.minCompressionSize?.toBytes() ?? props.minimumCompressionSize,
  binaryMediaTypes: props.binaryMediaTypes,
  endpointConfiguration: this._configureEndpoints(props),
  apiKeySourceType: props.apiKeySourceType,

diff --git a/...st/integ.restapi.js.snapshot/apigatewayrestapiDefaultTestDeployAssert6A9696A7.assets.json b/...st/integ.restapi.js.snapshot/apigatewayrestapiDefaultTestDeployAssert6A9696A7.assets.json
@@ -1,5 +1,5 @@
 {
- "version": "21.0.0",
+ "version": "30.0.0",
  "files": {
  "21fbb51d7b23f6a6c262b46a9caee79d744a3ac019fd45422d988b96d44b2a22": {
  "source": {

diff --git a/packages/@aws-cdk/aws-apigateway/test/integ.restapi.js.snapshot/cdk.out b/packages/@aws-cdk/aws-apigateway/test/integ.restapi.js.snapshot/cdk.out
@@ -1 +1 @@
-{"version":"21.0.0"}
+{"version":"30.0.0"}
diff --git a/packages/@aws-cdk/aws-apigateway/test/integ.restapi.js.snapshot/integ.json b/packages/@aws-cdk/aws-apigateway/test/integ.restapi.js.snapshot/integ.json
@@ -1,5 +1,5 @@
 {
- "version": "21.0.0",
+ "version": "30.0.0",
  "testCases": {
  "apigateway-restapi/DefaultTest": {
  "stacks": [

diff --git a/packages/@aws-cdk/aws-apigateway/test/integ.restapi.js.snapshot/manifest.json b/packages/@aws-cdk/aws-apigateway/test/integ.restapi.js.snapshot/manifest.json
@@ -1,12 +1,6 @@
 {
- "version": "21.0.0",
+ "version": "30.0.0",
  "artifacts": {
- "Tree": {
- "type": "cdk:tree",
- "properties": {
- "file": "tree.json"
- }
- },
  "test-apigateway-restapi.assets": {
  "type": "cdk:asset-manifest",
  "properties": {
@@ -23,7 +17,7 @@
  "validateOnSynth": false,
  "assumeRoleArn": "arn:${AWS::Partition}:iam::${AWS::AccountId}:role/cdk-hnb659fds-deploy-role-${AWS::AccountId}-${AWS::Region}",
  "cloudFormationExecutionRoleArn": "arn:${AWS::Partition}:iam::${AWS::AccountId}:role/cdk-hnb659fds-cfn-exec-role-${AWS::AccountId}-${AWS::Region}",
- "stackTemplateAssetObjectUrl": "s3://cdk-hnb659fds-assets-${AWS::AccountId}-${AWS::Region}/527feb6f65d1f41404abb6acfb6504a918e1d7489665b74acb9fa0ca23f34049.json",
+ "stackTemplateAssetObjectUrl": "s3://cdk-hnb659fds-assets-${AWS::AccountId}-${AWS::Region}/94f416193221135915e06201345d08e3db001c8bbf22b073f16ec02d3b8fba4b.json",
  "requiresBootstrapStackVersion": 6,
  "bootstrapStackVersionSsmParameter": "/cdk-bootstrap/hnb659fds/version",
  "additionalDependencies": [
@@ -60,7 +54,7 @@
  "/test-apigateway-restapi/my-api/Deployment/Resource": [
  {
  "type": "aws:cdk:logicalId",
- "data": "myapiDeployment92F2CB4996088bac04ec19d9db88f146f3d88bca"
+ "data": "myapiDeployment92F2CB496a6dee9579dae89ab3a0b094b4d193eb"
  }
  ],
  "/test-apigateway-restapi/my-api/DeploymentStage.beta/Resource": [
@@ -204,7 +198,7 @@
  "/test-apigateway-restapi/TestDeployment/Resource": [
  {
  "type": "aws:cdk:logicalId",
- "data": "TestDeploymentD77B56866f3141cef1e8fea8ab3b3b8bc90df36d"
+ "data": "TestDeploymentD77B56860a9c34c1bc306bfbc7d318827eacd1e1"
  }
  ],
  "/test-apigateway-restapi/TestStage/Resource": [
@@ -231,28 +225,19 @@
  "data": "CheckBootstrapVersion"
  }
  ],
- "myapiDeployment92F2CB4963d40685c54c6f8da21d80a83f16d3d5": [
+ "myapiDeployment92F2CB4996088bac04ec19d9db88f146f3d88bca": [
  {
  "type": "aws:cdk:logicalId",
- "data": "myapiDeployment92F2CB4963d40685c54c6f8da21d80a83f16d3d5",
+ "data": "myapiDeployment92F2CB4996088bac04ec19d9db88f146f3d88bca",
  "trace": [
  "!!DESTRUCTIVE_CHANGES: WILL_DESTROY"
  ]
  }
  ],
- "myapiv1appliances507FEFF4": [
+ "TestDeploymentD77B56866f3141cef1e8fea8ab3b3b8bc90df36d": [
  {
  "type": "aws:cdk:logicalId",
- "data": "myapiv1appliances507FEFF4",
- "trace": [
- "!!DESTRUCTIVE_CHANGES: WILL_DESTROY"
- ]
- }
- ],
- "myapiv1appliancesGET8FE872EC": [
- {
- "type": "aws:cdk:logicalId",
- "data": "myapiv1appliancesGET8FE872EC",
+ "data": "TestDeploymentD77B56866f3141cef1e8fea8ab3b3b8bc90df36d",
  "trace": [
  "!!DESTRUCTIVE_CHANGES: WILL_DESTROY"
  ]
@@ -307,6 +292,12 @@
  ]
  },
  "displayName": "apigateway-restapi/DefaultTest/DeployAssert"
+ },
+ "Tree": {
+ "type": "cdk:tree",
+ "properties": {
+ "file": "tree.json"
+ }
  }
  }
 }
diff --git a/...aws-cdk/aws-apigateway/test/integ.restapi.js.snapshot/test-apigateway-restapi.assets.json b/...aws-cdk/aws-apigateway/test/integ.restapi.js.snapshot/test-apigateway-restapi.assets.json
@@ -1,15 +1,15 @@
 {
- "version": "21.0.0",
+ "version": "30.0.0",
  "files": {
- "527feb6f65d1f41404abb6acfb6504a918e1d7489665b74acb9fa0ca23f34049": {
+ "94f416193221135915e06201345d08e3db001c8bbf22b073f16ec02d3b8fba4b": {
  "source": {
  "path": "test-apigateway-restapi.template.json",
  "packaging": "file"
  },
  "destinations": {
  "current_account-current_region": {
  "bucketName": "cdk-hnb659fds-assets-${AWS::AccountId}-${AWS::Region}",
- "objectKey": "527feb6f65d1f41404abb6acfb6504a918e1d7489665b74acb9fa0ca23f34049.json",
+ "objectKey": "94f416193221135915e06201345d08e3db001c8bbf22b073f16ec02d3b8fba4b.json",
  "assumeRoleArn": "arn:${AWS::Partition}:iam::${AWS::AccountId}:role/cdk-hnb659fds-file-publishing-role-${AWS::AccountId}-${AWS::Region}"
  }
  }

diff --git a/...s-cdk/aws-apigateway/test/integ.restapi.js.snapshot/test-apigateway-restapi.template.json b/...s-cdk/aws-apigateway/test/integ.restapi.js.snapshot/test-apigateway-restapi.template.json
@@ -3,6 +3,7 @@
  "myapi4C7BF186": {
  "Type": "AWS::ApiGateway::RestApi",
  "Properties": {
+ "MinimumCompressionSize": 1024,
  "Name": "my-api"
  }
  },
@@ -55,7 +56,7 @@
  "UpdateReplacePolicy": "Retain",
  "DeletionPolicy": "Retain"
  },
- "myapiDeployment92F2CB4996088bac04ec19d9db88f146f3d88bca": {
+ "myapiDeployment92F2CB496a6dee9579dae89ab3a0b094b4d193eb": {
  "Type": "AWS::ApiGateway::Deployment",
  "Properties": {
  "RestApiId": {
@@ -87,7 +88,7 @@
  "CacheClusterEnabled": true,
  "CacheClusterSize": "0.5",
  "DeploymentId": {
- "Ref": "myapiDeployment92F2CB4996088bac04ec19d9db88f146f3d88bca"
+ "Ref": "myapiDeployment92F2CB496a6dee9579dae89ab3a0b094b4d193eb"
  },
  "Description": "beta stage",
  "MethodSettings": [
@@ -672,7 +673,7 @@
  "MyHandlerServiceRoleFFA06653"
  ]
  },
- "TestDeploymentD77B56866f3141cef1e8fea8ab3b3b8bc90df36d": {
+ "TestDeploymentD77B56860a9c34c1bc306bfbc7d318827eacd1e1": {
  "Type": "AWS::ApiGateway::Deployment",
  "Properties": {
  "RestApiId": {
@@ -695,7 +696,7 @@
  "Ref": "myapi4C7BF186"
  },
  "DeploymentId": {
- "Ref": "TestDeploymentD77B56866f3141cef1e8fea8ab3b3b8bc90df36d"
+ "Ref": "TestDeploymentD77B56860a9c34c1bc306bfbc7d318827eacd1e1"
  },
  "StageName": "prod"
  },

diff --git a/packages/@aws-cdk/aws-apigateway/test/integ.restapi.js.snapshot/tree.json b/packages/@aws-cdk/aws-apigateway/test/integ.restapi.js.snapshot/tree.json
@@ -4,14 +4,6 @@
  "id": "App",
  "path": "",
  "children": {
- "Tree": {
- "id": "Tree",
- "path": "Tree",
- "constructInfo": {
- "fqn": "constructs.Construct",
- "version": "10.1.129"
- }
- },
  "test-apigateway-restapi": {
  "id": "test-apigateway-restapi",
  "path": "test-apigateway-restapi",
@@ -26,6 +18,7 @@
  "attributes": {
  "aws:cdk:cloudformation:type": "AWS::ApiGateway::RestApi",
  "aws:cdk:cloudformation:props": {
+ "minimumCompressionSize": 1024,
  "name": "my-api"
  }
  },
@@ -38,6 +31,14 @@
  "id": "CloudWatchRole",
  "path": "test-apigateway-restapi/my-api/CloudWatchRole",
  "children": {
+ "ImportCloudWatchRole": {
+ "id": "ImportCloudWatchRole",
+ "path": "test-apigateway-restapi/my-api/CloudWatchRole/ImportCloudWatchRole",
+ "constructInfo": {
+ "fqn": "@aws-cdk/core.Resource",
+ "version": "0.0.0"
+ }
+ },
  "Resource": {
  "id": "Resource",
  "path": "test-apigateway-restapi/my-api/CloudWatchRole/Resource",
@@ -145,7 +146,7 @@
  "cacheClusterEnabled": true,
  "cacheClusterSize": "0.5",
  "deploymentId": {
- "Ref": "myapiDeployment92F2CB4996088bac04ec19d9db88f146f3d88bca"
+ "Ref": "myapiDeployment92F2CB496a6dee9579dae89ab3a0b094b4d193eb"
  },
  "description": "beta stage",
  "methodSettings": [
@@ -992,6 +993,14 @@
  "id": "ServiceRole",
  "path": "test-apigateway-restapi/MyHandler/ServiceRole",
  "children": {
+ "ImportServiceRole": {
+ "id": "ImportServiceRole",
+ "path": "test-apigateway-restapi/MyHandler/ServiceRole/ImportServiceRole",
+ "constructInfo": {
+ "fqn": "@aws-cdk/core.Resource",
+ "version": "0.0.0"
+ }
+ },
  "Resource": {
  "id": "Resource",
  "path": "test-apigateway-restapi/MyHandler/ServiceRole/Resource",
@@ -1107,7 +1116,7 @@
  "Ref": "myapi4C7BF186"
  },
  "deploymentId": {
- "Ref": "TestDeploymentD77B56866f3141cef1e8fea8ab3b3b8bc90df36d"
+ "Ref": "TestDeploymentD77B56860a9c34c1bc306bfbc7d318827eacd1e1"
  },
  "stageName": "prod"
  }
@@ -1156,6 +1165,22 @@
  "fqn": "@aws-cdk/aws-apigateway.Stage",
  "version": "0.0.0"
  }
+ },
+ "BootstrapVersion": {
+ "id": "BootstrapVersion",
+ "path": "test-apigateway-restapi/BootstrapVersion",
+ "constructInfo": {
+ "fqn": "@aws-cdk/core.CfnParameter",
+ "version": "0.0.0"
+ }
+ },
+ "CheckBootstrapVersion": {
+ "id": "CheckBootstrapVersion",
+ "path": "test-apigateway-restapi/CheckBootstrapVersion",
+ "constructInfo": {
+ "fqn": "@aws-cdk/core.CfnRule",
+ "version": "0.0.0"
+ }
  }
  },
  "constructInfo": {
@@ -1176,12 +1201,30 @@
  "path": "apigateway-restapi/DefaultTest/Default",
  "constructInfo": {
  "fqn": "constructs.Construct",
- "version": "10.1.129"
+ "version": "10.1.249"
  }
  },
  "DeployAssert": {
  "id": "DeployAssert",
  "path": "apigateway-restapi/DefaultTest/DeployAssert",
+ "children": {
+ "BootstrapVersion": {
+ "id": "BootstrapVersion",
+ "path": "apigateway-restapi/DefaultTest/DeployAssert/BootstrapVersion",
+ "constructInfo": {
+ "fqn": "@aws-cdk/core.CfnParameter",
+ "version": "0.0.0"
+ }
+ },
+ "CheckBootstrapVersion": {
+ "id": "CheckBootstrapVersion",
+ "path": "apigateway-restapi/DefaultTest/DeployAssert/CheckBootstrapVersion",
+ "constructInfo": {
+ "fqn": "@aws-cdk/core.CfnRule",
+ "version": "0.0.0"
+ }
+ }
+ },
  "constructInfo": {
  "fqn": "@aws-cdk/core.Stack",
  "version": "0.0.0"
@@ -1198,6 +1241,14 @@
  "fqn": "@aws-cdk/integ-tests.IntegTest",
  "version": "0.0.0"
  }
+ },
+ "Tree": {
+ "id": "Tree",
+ "path": "Tree",
+ "constructInfo": {
+ "fqn": "constructs.Construct",
+ "version": "10.1.249"
+ }
  }
  },
  "constructInfo": {