AWS Fundamentals Logo
AWS Fundamentals
AWS::ApiGatewayV2::IntegrationResponse

ApiGatewayV2 IntegrationResponse

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*.

Properties

7 configurable properties. 3 required. Click a row to see details.

Filter:
PropertyTypeFlags
ApiId
string
RequiredCreate-only
IntegrationId
string
RequiredCreate-only
IntegrationResponseKey
string
Required
ContentHandlingStrategy
string
ResponseParameters
object
ResponseTemplates
object
TemplateSelectionExpression
string

Return Values

Values returned after the resource is created. Access these with Fn::GetAtt.

AttributeTypeDescription
IntegrationResponseIdstring-

Sample CloudFormation Template

A minimal template with required properties and common optional ones.

template.yaml
AWSTemplateFormatVersion: "2010-09-09"
Description: Sample template for AWS::ApiGatewayV2::IntegrationResponse

Resources:
  MyResource:
    Type: AWS::ApiGatewayV2::IntegrationResponse
    Properties:
      ApiId: "my-apiid"
      IntegrationId: "my-integrationid"
      IntegrationResponseKey: "value"

Required IAM Permissions

Permissions CloudFormation needs in your IAM role to manage this resource.

create

apigateway:POST

read

apigateway:GET

update

apigateway:PATCHapigateway:PUTapigateway:GET

delete

apigateway:GETapigateway:DELETE

list

apigateway:GET

Learn AWS the Practical Way

Our bi-weekly newsletter teaches hands-on AWS fundamentals. No certification fluff - just practical knowledge.

Subscribe to Newsletter

Quick Facts

ServiceApiGatewayV2
Properties8
Required3
TaggingNot supported
Primary IDApiId

Supported Operations

CreateReadUpdateDeleteList

Immutable After Creation

These properties cannot be changed after the resource is created. Updating them triggers a replacement.

ApiIdIntegrationId

Related Resources

External Links