AWS::ApiGatewayV2::IntegrationResponseCfnIntegrationResponse
The `AWS::ApiGatewayV2::IntegrationResponse` resource updates an integration response for an WebSocket API. For more information, see [Set up WebSocket API Integration Responses in API Gateway](https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-websocket-api-integration-responses.html) in the *API Gateway Developer Guide* .
Import
import { CfnIntegrationResponse } from 'aws-cdk-lib/aws-apigatewayv2';Or use the module namespace:
import * as apigatewayv2 from 'aws-cdk-lib/aws-apigatewayv2';
// apigatewayv2.CfnIntegrationResponseProperties
Configuration passed to the constructor as CfnIntegrationResponseProps.
apiIdRequiredstring | IApiRefThe API identifier.
integrationIdRequiredstring | IIntegrationRefThe integration ID.
integrationResponseKeyRequiredstringThe integration response key.
contentHandlingStrategyOptionalstringSupported only for WebSocket APIs. Specifies how to handle response payload content type conversions. Supported values are `CONVERT_TO_BINARY` and `CONVERT_TO_TEXT` , with the following behaviors: `CONVERT_TO_BINARY` : Converts a response payload from a Base64-encoded string to the corresponding binary blob. `CONVERT_TO_TEXT` : Converts a response payload from a binary blob to a Base64-encoded string. If this property is not defined, the response payload will be passed through from the integration response to the route response or method response without modification.
responseParametersOptionalanyA key-value map specifying response parameters that are passed to the method response from the backend. The key is a method response header parameter name and the mapped value is an integration response header value, a static value enclosed within a pair of single quotes, or a JSON expression from the integration response body. The mapping key must match the pattern of `method.response.header. *{name}*` , where name is a valid and unique header name. The mapped non-static value must match the pattern of `integration.response.header. *{name}*` or `integration.response.body. *{JSON-expression}*` , where `*{name}*` is a valid and unique response header name and `*{JSON-expression}*` is a valid JSON expression without the `$` prefix.
responseTemplatesOptionalanyThe collection of response templates for the integration response as a string-to-string map of key-value pairs. Response templates are represented as a key/value map, with a content-type as the key and a template as the value.
templateSelectionExpressionOptionalstringThe template selection expression for the integration response. Supported only for WebSocket APIs.
CloudFormation Resource
This L1 construct maps directly to the following CloudFormation resource type.
Learn AWS the Practical Way
Our bi-weekly newsletter teaches hands-on AWS fundamentals. No certification fluff - just practical knowledge.
Subscribe to NewsletterQuick Facts
aws-apigatewayv2AWS::ApiGatewayV2::IntegrationResponse