aws_api_gateway_v2_integration_response resource

[edit on GitHub]

Use the aws_api_gateway_v2_integration_response InSpec audit resource to test the properties of a specific AWS API Gateway V2 integration response.

For additional information, including parameters and properties, see the AWS documentation on AWS APIGatewayV2 IntegrationResponse.

Installation

This resource is available in the Chef InSpec AWS resource pack.

See the Chef InSpec documentation on cloud platforms for information on configuring your AWS environment for InSpec and creating an InSpec profile that uses the InSpec AWS resource pack.

Syntax

Ensure that the integration response exists.

describe aws_api_gateway_v2_integration_response(api_id: 'APP_ID', integration_id: 'INTEGRATION_ID', integration_response_id: 'INTEGRATION_RESPONSE_ID') do
  it { should exist }
end

Parameters

api_id (required)

The API identifier.

integration_id (required)

The integration ID.

integration_response_id (required)

The integration response ID.

Properties

content_handling_strategy

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_response_id

The integration response ID.

integration_response_key

The integration response key.

response_parameters

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. 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 the name is a valid and unique response header name and JSON-expression is a valid JSON expression without the $ prefix.

response_templates

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 or value map, with a content type as the key and a template as the value.

template_selection_expression

The template selection expressions for the integration response. Supported only for WebSocket APIs.

Examples

Test to ensure that an integration response ID is available

describe aws_api_gateway_v2_integration_response(api_id: 'APP_ID', integration_id: 'INTEGRATION_ID', integration_response_id: 'INTEGRATION_RESPONSE_ID') do
  its('integration_response_id') { should eq 'INTEGRATION_RESPONSE_ID' }
end

Test to verify the integration response key

describe aws_api_gateway_v2_integration_response(api_id: 'APP_ID', integration_id: 'INTEGRATION_ID', integration_response_id: 'INTEGRATION_RESPONSE_ID') do
  its('integration_response_key') { should eq 'INTEGRATION_RESPONSE_KEY' }
end

Test to verify the content handling strategy

describe aws_api_gateway_v2_integration_response(api_id: 'APP_ID', integration_id: 'INTEGRATION_ID', integration_response_id: 'INTEGRATION_RESPONSE_ID') do
  its('content_handling_strategy') { should eq 'CONVERT_TO_BINARY' }
end

Matchers

This InSpec audit resource has the following special matchers. For a full list of available matchers, please visit our Universal Matchers page.

The control passes if the get method returns at least a result.

exist

Use should to test that the entity exists.

describe aws_api_gateway_v2_integration_response(api_id: 'APP_ID', integration_id: 'INTEGRATION_ID', integration_response_id: 'INTEGRATION_RESPONSE_ID') do
  it { should exist }
end

not exist

Use should_not to test that the entity does not exist.

describe aws_api_gateway_v2_integration_response(api_id: 'APP_ID', integration_id: 'INTEGRATION_ID', integration_response_id: 'INTEGRATION_RESPONSE_ID') do
  it { should_not exist }
end

AWS Permissions

Your Principal will need the APIGatewayv2:Client:GetIntegrationResponseResponse action with Effect set to Allow.