route_responses

Creates, updates, deletes or gets a route_response resource or lists route_responses in a region

Overview

Name	route_responses
Type	Resource
Description	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*.
Id	awscc.apigatewayv2.route_responses

Fields

get (all properties)

Name	Datatype	Description
route_response_key	string	The route response key.
response_parameters	object	The route response parameters.
route_id	string	The route ID.
model_selection_expression	string	The model selection expression for the route response. Supported only for WebSocket APIs.
api_id	string	The API identifier.
response_models	object	The response models for the route response.
route_response_id	string
region	string	AWS region.

list (identifiers only)

Name	Datatype	Description
route_id	string	The route ID.
api_id	string	The API identifier.
route_response_id	string
region	string	AWS region.

For more information, see AWS::ApiGatewayV2::RouteResponse.

Methods

Name	Resource	Accessible by	Required Params
create_resource	route_responses	INSERT	RouteResponseKey, RouteId, ApiId, region
delete_resource	route_responses	DELETE	Identifier, region
update_resource	route_responses	UPDATE	Identifier, PatchDocument, region
list_resources	route_responses_list_only	SELECT	region
get_resource	route_responses	SELECT	Identifier, region

SELECT examples

get (all properties)

Gets all properties from an individual route_response.

SELECT
  region,
  route_response_key,
  response_parameters,
  route_id,
  model_selection_expression,
  api_id,
  response_models,
  route_response_id
FROM awscc.apigatewayv2.route_responses
WHERE
  region = 'us-east-1' AND
  Identifier = '{{ api_id }}|{{ route_id }}|{{ route_response_id }}';

list (identifiers only)

Lists all route_responses in a region.

SELECT
  region,
  api_id,
  route_id,
  route_response_id
FROM awscc.apigatewayv2.route_responses_list_only
WHERE
  region = 'us-east-1';

INSERT example

Use the following StackQL query and manifest file to create a new route_response resource, using stack-deploy.

Required Properties

/*+ create */
INSERT INTO awscc.apigatewayv2.route_responses (
  RouteResponseKey,
  RouteId,
  ApiId,
  region
)
SELECT
  '{{ route_response_key }}',
  '{{ route_id }}',
  '{{ api_id }}',
  '{{ region }}';

All Properties

/*+ create */
INSERT INTO awscc.apigatewayv2.route_responses (
  RouteResponseKey,
  ResponseParameters,
  RouteId,
  ModelSelectionExpression,
  ApiId,
  ResponseModels,
  region
)
SELECT
  '{{ route_response_key }}',
  '{{ response_parameters }}',
  '{{ route_id }}',
  '{{ model_selection_expression }}',
  '{{ api_id }}',
  '{{ response_models }}',
  '{{ region }}';

Manifest

version: 1
name: stack name
description: stack description
providers:
  - aws
globals:
  - name: region
    value: '{{ vars.AWS_REGION }}'
resources:
  - name: route_response
    props:
      - name: route_response_key
        value: '{{ route_response_key }}'
      - name: response_parameters
        value: null
      - name: route_id
        value: '{{ route_id }}'
      - name: model_selection_expression
        value: '{{ model_selection_expression }}'
      - name: api_id
        value: '{{ api_id }}'
      - name: response_models
        value: {}

UPDATE example

Use the following StackQL query and manifest file to update a route_response resource, using stack-deploy.

/*+ update */
UPDATE awscc.apigatewayv2.route_responses
SET PatchDocument = string('{{ {
    "RouteResponseKey": route_response_key,
    "ResponseParameters": response_parameters,
    "ModelSelectionExpression": model_selection_expression,
    "ResponseModels": response_models
} | generate_patch_document }}')
WHERE
  region = '{{ region }}' AND
  Identifier = '{{ api_id }}|{{ route_id }}|{{ route_response_id }}';

DELETE example

/*+ delete */
DELETE FROM awscc.apigatewayv2.route_responses
WHERE
  Identifier = '{{ api_id }}|{{ route_id }}|{{ route_response_id }}' AND
  region = 'us-east-1';

Permissions

To operate on the route_responses resource, the following permissions are required:

Create

apigateway:POST

Update

apigateway:PATCH,
apigateway:GET,
apigateway:PUT

Read

apigateway:GET

Delete

apigateway:GET,
apigateway:DELETE

List

apigateway:GET