aws-cdk-lib.aws_apigatewayv2_integrations.WebSocketMockIntegrationProps

WebSocketMockIntegrationProps Struct

Props for Mock type integration for a WebSocket Api.

WebSocketMockIntegrationProps

used as props by

• WebSocketMockIntegration

Source

aws-apigatewayv2-integrations/lib/websocket/mock.ts

Type last changed

v2.176.0 · 15 Jan 2025

Example

import { WebSocketMockIntegration } from 'aws-cdk-lib/aws-apigatewayv2-integrations';

const webSocketApi = new apigwv2.WebSocketApi(this, 'mywsapi');
new apigwv2.WebSocketStage(this, 'mystage', {
  webSocketApi,
  stageName: 'dev',
  autoDeploy: true,
});


webSocketApi.addRoute('sendMessage', {
  integration: new WebSocketMockIntegration('DefaultIntegration', {
    requestTemplates: { 'application/json': JSON.stringify({ statusCode: 200 }) },
    templateSelectionExpression: '\\$default',
  }),
  returnResponse: true,
});

Properties

requestTemplates?optional{ [key: string]: string }request_templates?optionaltyping.Mapping[str, str]requestTemplates?optionalMap<String, String>RequestTemplates?optionalIDictionary<string, string>RequestTemplates?optional*map[string]*string#

A map of Apache Velocity templates that are applied on the request payload.

Default: No request template provided to the integration.

  { "application/json": "{ \"statusCode\": 200 }" }

templateSelectionExpression?optionalstringtemplate_selection_expression?optionalstrtemplateSelectionExpression?optionalStringTemplateSelectionExpression?optionalstringTemplateSelectionExpression?optional*string#

The template selection expression for the integration.

Default: No template selection expression provided.