AWS CloudFormation
User Guide (Version )

AWS::ApiGatewayV2::Integration

The AWS::ApiGatewayV2::Integration resource creates an integration for an API. For more information, see Set up a WebSocket API Integration Request in API Gateway in the API Gateway Developer Guide.

Syntax

To declare this entity in your AWS CloudFormation template, use the following syntax:

JSON

{ "Type" : "AWS::ApiGatewayV2::Integration", "Properties" : { "ApiId" : String, "ConnectionType" : String, "ContentHandlingStrategy" : String, "CredentialsArn" : String, "Description" : String, "IntegrationMethod" : String, "IntegrationType" : String, "IntegrationUri" : String, "PassthroughBehavior" : String, "RequestParameters" : Json, "RequestTemplates" : Json, "TemplateSelectionExpression" : String, "TimeoutInMillis" : Integer } }

YAML

Type: AWS::ApiGatewayV2::Integration Properties: ApiId: String ConnectionType: String ContentHandlingStrategy: String CredentialsArn: String Description: String IntegrationMethod: String IntegrationType: String IntegrationUri: String PassthroughBehavior: String RequestParameters: Json RequestTemplates: Json TemplateSelectionExpression: String TimeoutInMillis: Integer

Properties

ApiId

The API identifier.

Required: Yes

Type: String

Update requires: Replacement

ConnectionType

The type of the network connection to the integration endpoint. Currently the only valid value is INTERNET, for connections through the public routable internet.

Required: No

Type: String

Update requires: No interruption

ContentHandlingStrategy

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.

Required: No

Type: String

Update requires: No interruption

CredentialsArn

Specifies the credentials required for the integration, if any. For AWS integrations, three options are available. To specify an IAM Role for API Gateway to assume, use the role's Amazon Resource Name (ARN). To require that the caller's identity be passed through from the request, specify the string arn:aws:iam::*:user/*. To use resource-based permissions on supported AWS services, specify null.

Required: No

Type: String

Update requires: No interruption

Description

The description of the integration.

Required: No

Type: String

Update requires: No interruption

IntegrationMethod

Specifies the integration's HTTP method type.

Required: No

Type: String

Update requires: No interruption

IntegrationType

The integration type of an integration. One of the following:

AWS: for integrating the route or method request with an AWS service action, including the Lambda function-invoking action. With the Lambda function-invoking action, this is referred to as the Lambda custom integration. With any other AWS service action, this is known as AWS integration.

AWS_PROXY: for integrating the route or method request with the Lambda function-invoking action with the client request passed through as-is. This integration is also referred to as Lambda proxy integration.

HTTP: for integrating the route or method request with an HTTP endpoint. This integration is also referred to as HTTP custom integration.

HTTP_PROXY: for integrating route or method request with an HTTP endpoint, with the client request passed through as-is. This is also referred to as HTTP proxy integration.

MOCK: for integrating the route or method request with API Gateway as a "loopback" endpoint without invoking any backend.

Required: Yes

Type: String

Update requires: No interruption

IntegrationUri

For a Lambda proxy integration, this is the URI of the Lambda function.

Required: No

Type: String

Update requires: No interruption

PassthroughBehavior

Specifies the pass-through behavior for incoming requests based on the Content-Type header in the request, and the available mapping templates specified as the requestTemplates property on the Integration resource. There are three valid values: WHEN_NO_MATCH, WHEN_NO_TEMPLATES, and NEVER.

WHEN_NO_MATCH passes the request body for unmapped content types through to the integration backend without transformation.

NEVER rejects unmapped content types with an HTTP 415 Unsupported Media Type response.

WHEN_NO_TEMPLATES allows pass-through when the integration has no content types mapped to templates. However, if there is at least one content type defined, unmapped content types will be rejected with the same HTTP 415 Unsupported Media Type response.

Required: No

Type: String

Update requires: No interruption

RequestParameters

A key-value map specifying request parameters that are passed from the method request to the backend. The key is an integration request parameter name and the associated value is a method request parameter value or static value that must be enclosed within single quotes and pre-encoded as required by the backend. The method request parameter value must match the pattern of method.request.{location}.{name} , where {location} is querystring, path, or header; and {name} must be a valid and unique method request parameter name.

Required: No

Type: Json

Update requires: No interruption

RequestTemplates

Represents a map of Velocity templates that are applied on the request payload based on the value of the Content-Type header sent by the client. The content type value is the key in this map, and the template (as a String) is the value.

Required: No

Type: Json

Update requires: No interruption

TemplateSelectionExpression

The template selection expression for the integration.

Required: No

Type: String

Update requires: No interruption

TimeoutInMillis

Custom timeout between 50 and 29,000 milliseconds. The default value is 29,000 milliseconds or 29 seconds.

Required: No

Type: Integer

Update requires: No interruption

Return Values

Ref

When you pass the logical ID of this resource to the intrinsic Ref function, Ref returns the Integration resource ID, such as abcd123.

For more information about using the Ref function, see Ref.

Examples

Integration creation example

The following example creates an integration resource named MyIntegration for the MyApi API, whose credentials are specified by MyCredentialsArn.

JSON

{ "MyIntegration": { "Type": "AWS::ApiGatewayV2::Integration", "Properties": { "ApiId": { "Ref": "MyApi" }, "Description": "Lambda Integration", "IntegrationType": "AWS", "IntegrationUri": { "Fn::Join": [ "", [ "arn:", { "Ref": "AWS::Partition" }, ":apigateway:", { "Ref": "AWS::Region" }, ":lambda:path/2015-03-31/functions/", { "Ref": "MyLambdaFunction" }, "/invocations" ] ] }, "CredentialsArn": "MyCredentialsArn", "IntegrationMethod": "GET", "ConnectionType": "INTERNET" } } }

YAML

MyIntegration: Type: 'AWS::ApiGatewayV2::Integration' Properties: ApiId: !Ref MyApi Description: Lambda Integration IntegrationType: AWS IntegrationUri: !Join - '' - - 'arn:' - !Ref 'AWS::Partition' - ':apigateway:' - !Ref 'AWS::Region' - ':lambda:path/2015-03-31/functions/' - !Ref MyLambdaFunction - /invocations CredentialsArn: MyCredentialsArn IntegrationMethod: GET ConnectionType: INTERNET

See Also