AWS Fundamentals Logo
AWS Fundamentals
AWS::ApiGatewayV2::RouteResponse

ApiGatewayV2 RouteResponse

The AWS::ApiGatewayV2::RouteResponse resource creates a route response for a WebSocket API. For more information, see [Set up Route Responses for a WebSocket API in API Gateway](https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-websocket-api-route-response.html) in the *API Gateway Developer Guide*.

Properties

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

Filter:
PropertyTypeFlags
ApiId
string
RequiredCreate-only
RouteId
string
RequiredCreate-only
RouteResponseKey
string
Required
ModelSelectionExpression
string
ResponseModels
object
ResponseParameters
RouteParameters

Return Values

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

AttributeTypeDescription
RouteResponseIdstring-

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::RouteResponse

Resources:
  MyResource:
    Type: AWS::ApiGatewayV2::RouteResponse
    Properties:
      RouteResponseKey: "value"
      RouteId: "my-routeid"
      ApiId: "my-apiid"

Required IAM Permissions

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

create

apigateway:POST

update

apigateway:PATCHapigateway:GETapigateway:PUT

read

apigateway: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
Properties7
Required3
TaggingNot supported
Primary IDApiId

Supported Operations

CreateUpdateReadDeleteList

Immutable After Creation

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

ApiIdRouteId

Related Resources

External Links