Setting up a WebSocket API integration request in API Gateway

To add an integration request to a route in a WebSocket API using the API Gateway console

1. Sign in to the API Gateway console, choose the API, and choose Routes.

2. Under Routes, choose the route.

3. Choose the Integration request tab, and then in the Integration request settings section, choose Edit.

4. For Integration type, select one of the following:

   • Choose Lambda function only if your API will be integrated with an Amazon Lambda function that you have already created in this account or in another account.

     To create a new Lambda function in Amazon Lambda, to set a resource permission on the Lambda function, or to perform any other Lambda service actions, choose Amazon Service instead.

   • Choose HTTP if your API will be integrated with an existing HTTP endpoint. For more information, see Set up HTTP integrations in API Gateway.

   • Choose Mock if you want to generate API responses from API Gateway directly, without the need for an integration backend. For more information, see Set up mock integrations in API Gateway.

   • Choose Amazon service if your API will be integrated with an Amazon service.

   • Choose VPC link if your API will use a VpcLink as a private integration endpoint. For more information, see Set up API Gateway private integrations.

5. If you chose Lambda function, do the following:

   1. For Use Lambda proxy integration, choose the check box if you intend to use Lambda proxy integration or cross-account Lambda proxy integration.

   2. For Lambda function, specify the function in one of the following ways:

      • If your Lambda function is in the same account, enter the function name and then select the function from the dropdown list.

        Note

        The function name can optionally include its alias or version specification, as in HelloWorld, HelloWorld:1, or HelloWorld:alpha.

      • If the function is in a different account, enter the ARN for the function.

   3. To use the default timeout value of 29 seconds, keep Default timeout turned on. To set a custom timeout, choose Default timeout and enter a timeout value between 50 and 29000 milliseconds.

6. If you chose HTTP, follow the instructions in step 4 of Set up an API integration request using the API Gateway console.

7. If you chose Mock, proceed to the Request Templates step.

8. If you chose Amazon service, follow the instructions in step 6 of Set up an API integration request using the API Gateway console.

9. If you chose VPC link, do the following:

   1. For VPC proxy integration, choose the check box if you want your requests to be proxied to your VPCLink's endpoint.

   2. For HTTP method, choose the HTTP method type that most closely matches the method in the HTTP backend.

   3. From the VPC link dropdown list, select a VPC link. You can select [Use Stage Variables] and enter ${stageVariables.vpcLinkId} in the text box below the list.

      You can define the vpcLinkId stage variable after deploying the API to a stage and set its value to the ID of the VpcLink.

   4. For Endpoint URL, enter the URL of the HTTP backend you want this integration to use.

   5. To use the default timeout value of 29 seconds, keep Default timeout turned on. To set a custom timeout, choose Default timeout and enter a timeout value between 50 and 29000 milliseconds.

10. Choose Save changes.

11. Under Request templates, do the following:

    1. To enter a Template selection expression, under Request templates, choose Edit.

    2. Enter a Template selection expression. Use an expression that API Gateway looks for in the message payload. If it is found, it is evaluated, and the result is a template key value that is used to select the data mapping template to be applied to the data in the message payload. You create the data mapping template in the next step. Choose Edit to save your changes.

    3. Choose Create template to create the data mapping template. For Template key, enter a template key value that is used to select the data mapping template to be applied to the data in the message payload. Then, enter a mapping template. Choose Create template.

       For information about template selection expressions, see Template selection expressions.

1. Create a file named integration-params.json, with the following contents:

   {"PassthroughBehavior": "WHEN_NO_MATCH", "TimeoutInMillis": 29000, "ConnectionType": "INTERNET", "RequestTemplates": {"application/json": "{\"statusCode\":200}"}, "IntegrationType": "MOCK"}

2. Run the create-integration command as shown in the following example:

   aws apigatewayv2 --region us-east-1 create-integration --api-id aabbccddee --cli-input-json file://integration-params.json

1. Create a Lambda function in the Lambda console and give it a basic Lambda execution role.

2. Execute the create-integration command as in the following example:

   aws apigatewayv2 create-integration --api-id aabbccddee --integration-type AWS_PROXY --integration-method POST --integration-uri arn:aws:apigateway:us-east-1:lambda:path/2015-03-31/functions/arn:aws:lambda:us-east-1:123412341234:function:simpleproxy-echo-e2e/invocations