integration_responses

Creates, updates, deletes or gets an integration_response resource or lists integration_responses in a region

Overview

Name	integration_responses
Type	Resource
Description	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 in the API Gateway Developer Guide.
Id	awscc.apigatewayv2.integration_responses

Fields

get (all properties)

Name	Datatype	Description
integration_response_id	string
response_templates	object	The 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.
template_selection_expression	string	The template selection expression for the integration response. Supported only for WebSocket APIs.
response_parameters	object	A 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.
content_handling_strategy	string	Supported 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.
integration_id	string	The integration ID.
integration_response_key	string	The integration response key.
api_id	string	The API identifier.
region	string	AWS region.

list (identifiers only)

Name	Datatype	Description
integration_response_id	string
integration_id	string	The integration ID.
api_id	string	The API identifier.
region	string	AWS region.

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

Methods

Name	Resource	Accessible by	Required Params
create_resource	integration_responses	INSERT	ApiId, IntegrationId, IntegrationResponseKey, region
delete_resource	integration_responses	DELETE	Identifier, region
update_resource	integration_responses	UPDATE	Identifier, PatchDocument, region
list_resources	integration_responses_list_only	SELECT	region
get_resource	integration_responses	SELECT	Identifier, region

SELECT examples

get (all properties)

Gets all properties from an individual integration_response.

SELECT
  region,
  integration_response_id,
  response_templates,
  template_selection_expression,
  response_parameters,
  content_handling_strategy,
  integration_id,
  integration_response_key,
  api_id
FROM awscc.apigatewayv2.integration_responses
WHERE
  region = '{{ region }}' AND
  Identifier = '{{ api_id }}|{{ integration_id }}|{{ integration_response_id }}';

list (identifiers only)

Lists all integration_responses in a region.

SELECT
  region,
  api_id,
  integration_id,
  integration_response_id
FROM awscc.apigatewayv2.integration_responses_list_only
WHERE
  region = '{{ region }}';

INSERT example

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

Required Properties

/*+ create */
INSERT INTO awscc.apigatewayv2.integration_responses (
  IntegrationId,
  IntegrationResponseKey,
  ApiId,
  region
)
SELECT
  '{{ integration_id }}',
  '{{ integration_response_key }}',
  '{{ api_id }}',
  '{{ region }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

All Properties

/*+ create */
INSERT INTO awscc.apigatewayv2.integration_responses (
  ResponseTemplates,
  TemplateSelectionExpression,
  ResponseParameters,
  ContentHandlingStrategy,
  IntegrationId,
  IntegrationResponseKey,
  ApiId,
  region
)
SELECT
  '{{ response_templates }}',
  '{{ template_selection_expression }}',
  '{{ response_parameters }}',
  '{{ content_handling_strategy }}',
  '{{ integration_id }}',
  '{{ integration_response_key }}',
  '{{ api_id }}',
  '{{ region }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

Manifest

version: 1
name: stack name
description: stack description
providers:
- aws
globals:
- name: region
  value: '{{ vars.AWS_REGION }}'
resources:
- name: integration_response
  props:
    - name: response_templates
      value: {}
    - name: template_selection_expression
      value: '{{ template_selection_expression }}'
    - name: response_parameters
      value: {}
    - name: content_handling_strategy
      value: '{{ content_handling_strategy }}'
    - name: integration_id
      value: '{{ integration_id }}'
    - name: integration_response_key
      value: '{{ integration_response_key }}'
    - name: api_id
      value: '{{ api_id }}'

UPDATE example

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

/*+ update */
UPDATE awscc.apigatewayv2.integration_responses
SET PatchDocument = string('{{ {
    "ResponseTemplates": response_templates,
    "TemplateSelectionExpression": template_selection_expression,
    "ResponseParameters": response_parameters,
    "ContentHandlingStrategy": content_handling_strategy,
    "IntegrationResponseKey": integration_response_key
} | generate_patch_document }}')
WHERE
  region = '{{ region }}' AND
  Identifier = '{{ api_id }}|{{ integration_id }}|{{ integration_response_id }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

DELETE example

/*+ delete */
DELETE FROM awscc.apigatewayv2.integration_responses
WHERE
  Identifier = '{{ api_id }}|{{ integration_id }}|{{ integration_response_id }}' AND
  region = '{{ region }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

Additional Parameters

Mutable resources in the Cloud Control provider support additional optional parameters which can be supplied with INSERT, UPDATE, or DELETE operations. These include:

Parameter	Description
ClientToken	A unique identifier to ensure the idempotency of the resource request. This allows the provider to accurately distinguish between retries and new requests. A client token is valid for 36 hours once used. After that, a resource request with the same client token is treated as a new request. If you do not specify a client token, one is generated for inclusion in the request.
RoleArn	The ARN of the IAM role used to perform this resource operation. The role specified must have the permissions required for this operation. If you do not specify a role, a temporary session is created using your AWS user credentials.
TypeVersionId	For private resource types, the type version to use in this resource operation. If you do not specify a resource version, the default version is used.

Permissions

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

Create

apigateway:POST

Read

apigateway:GET

Update

apigateway:PATCH,
apigateway:PUT,
apigateway:GET

Delete

apigateway:GET,
apigateway:DELETE

List

apigateway:GET