feat(apigatewayv2): add disableSchemaValidation for websocket api

Author: aki-kii

packages/@aws-cdk-testing/framework-integ/test/aws-apigatewayv2/test/websocket/integ.api.ts

@@ -8,6 +8,10 @@ const stack = new cdk.Stack(app, 'aws-cdk-aws-apigatewayv2');
 
 new apigw.WebSocketApi(stack, 'WebSocketApi');
 
+new apigw.WebSocketApi(stack, 'WebSocketApiWithProps', {
+  disableSchemaValidation: true,
+});
+
 new IntegTest(app, 'web-socket-api', {
   testCases: [stack],
 });

packages/aws-cdk-lib/aws-apigatewayv2/README.md

@@ -522,6 +522,14 @@ const api = new apigwv2.WebSocketApi(this, 'mywsapi');
 const arn = api.arnForExecuteApiV2('$connect', 'dev');
 ```
 
+To disable schema validation, set `disableSchemaValidation` to true.
+
+```ts
+new apigwv2.WebSocketApi(this, 'api', {
+  disableSchemaValidation: true,
+});
+```
+
 For a detailed explanation of this function, including usage and examples, please refer to the [Generating ARN for Execute API](#generating-arn-for-execute-api) section under HTTP API.
 
 You can configure IP address type for the API endpoint using `ipAddressType` property.

packages/aws-cdk-lib/aws-apigatewayv2/lib/websocket/api.ts

@@ -94,6 +94,14 @@ export interface WebSocketApiProps {
    * @default undefined - AWS default is IPV4
    */
   readonly ipAddressType?: IpAddressType;
+
+  /**
+   * Avoid validating models when creating a deployment.
+   * @see https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/aws-resource-apigatewayv2-api.html
+   *
+   * @default false
+   */
+  readonly disableSchemaValidation?: boolean;
 }
 
 /**
@@ -162,6 +170,7 @@ export class WebSocketApi extends ApiBase implements IWebSocketApi {
       description: props?.description,
       routeSelectionExpression: props?.routeSelectionExpression ?? '$request.body.action',
       ipAddressType: props?.ipAddressType,
+      disableSchemaValidation: props?.disableSchemaValidation,
     });
     this.apiId = resource.ref;
     this.apiEndpoint = resource.attrApiEndpoint;

packages/aws-cdk-lib/aws-apigatewayv2/test/websocket/api.test.ts

@@ -307,6 +307,21 @@ describe('WebSocketApi', () => {
       IpAddressType: ipAddressType,
     });
   });
+
+  test.each([true, false, undefined])('disableSchemaValidation is set to %s', (disableSchemaValidation) => {
+    const stack = new Stack();
+    new WebSocketApi(stack, 'api', {
+      disableSchemaValidation,
+    });
+
+    const value = disableSchemaValidation !== undefined ? disableSchemaValidation : Match.absent();
+
+    Template.fromStack(stack).hasResourceProperties('AWS::ApiGatewayV2::Api', {
+      Name: 'api',
+      ProtocolType: 'WEBSOCKET',
+      DisableSchemaValidation: value,
+    });
+  })
 });
 
 class DummyIntegration extends WebSocketRouteIntegration {