AWS::ApiGateway::Method Integration
Integration
is a property of the AWS::ApiGateway::Method resource that specifies information about the target backend that a method calls.
Syntax
To declare this entity in your AWS CloudFormation template, use the following syntax:
JSON
{ "CacheKeyParameters" :
[ String, ... ]
, "CacheNamespace" :String
, "ConnectionId" :String
, "ConnectionType" :String
, "ContentHandling" :String
, "Credentials" :String
, "IntegrationHttpMethod" :String
, "IntegrationResponses" :[ IntegrationResponse, ... ]
, "PassthroughBehavior" :String
, "RequestParameters" :{
, "RequestTemplates" :Key
:Value
, ...}{
, "TimeoutInMillis" :Key
:Value
, ...}Integer
, "Type" :String
, "Uri" :String
}
YAML
CacheKeyParameters:
- String
CacheNamespace:String
ConnectionId:String
ConnectionType:String
ContentHandling:String
Credentials:String
IntegrationHttpMethod:String
IntegrationResponses:- IntegrationResponse
PassthroughBehavior:String
RequestParameters:RequestTemplates:
Key
:Value
TimeoutInMillis:
Key
:Value
Integer
Type:String
Uri:String
Properties
CacheKeyParameters
-
A list of request parameters whose values API Gateway caches. For cases where the integration type allows for RequestParameters to be set, these parameters must also be specified in RequestParameters to be supported in
CacheKeyParameters
.Required: No
Type: List of String
Update requires: No interruption
CacheNamespace
-
An API-specific tag group of related cached parameters.
Required: No
Type: String
Update requires: No interruption
ConnectionId
-
The ID of the
VpcLink
used for the integration whenconnectionType=VPC_LINK
, otherwise undefined.Required: No
Type: String
Update requires: No interruption
ConnectionType
-
The type of the network connection to the integration endpoint. The valid value is
INTERNET
for connections through the public routable internet orVPC_LINK
for private connections between API Gateway and a network load balancer in a VPC. The default value isINTERNET
.Required: No
Type: String
Update requires: No interruption
ContentHandling
-
Specifies how to handle request payload content type conversions. Valid values are:
-
CONVERT_TO_BINARY
: Converts a request payload from a base64-encoded string to a binary blob. -
CONVERT_TO_TEXT
: Converts a request payload from a binary blob to a base64-encoded string.
If this property isn't defined, the request payload is passed through from the method request to the integration request without modification, provided that the
PassthroughBehaviors
property is configured to support payload pass-through.Required: No
Type: String
Update requires: No interruption
-
Credentials
-
The credentials that are required for the integration. To specify an AWS Identity and Access Management (IAM) role that API Gateway assumes, specify the role's Amazon Resource Name (ARN). To require that the caller's identity be passed through from the request, specify arn:aws:iam::*:user/*.
To use resource-based permissions on the AWS Lambda (Lambda) function, don't specify this property. Use the AWS::Lambda::Permission resource to permit API Gateway to call the function. For more information, see Allow Amazon API Gateway to Invoke a Lambda Function in the AWS Lambda Developer Guide.
Required: No
Type: String
Update requires: No interruption
IntegrationHttpMethod
-
The integration's HTTP method type.
For the
Type
property, if you specifyMOCK
, this property is optional. For all other types, you must specify this property.Required: Conditional
Type: String
Update requires: No interruption
IntegrationResponses
-
The response that API Gateway provides after a method's backend completes processing a request. API Gateway intercepts the response from the backend so that you can control how API Gateway surfaces backend responses. For example, you can map the backend status codes to codes that you define.
Required: No
Type: List of IntegrationResponse
Update requires: No interruption
PassthroughBehavior
-
Indicates when API Gateway passes requests to the targeted backend. This behavior depends on the request's
Content-Type
header and whether you defined a mapping template for it.For more information and valid values, see the passthroughBehavior field in the API Gateway API Reference.
Required: No
Type: String
Update requires: No interruption
RequestParameters
-
The request parameters that API Gateway sends with the backend request. Specify request parameters as key-value pairs (string-to-string mappings), with a destination as the key and a source as the value.
Specify the destination by using the following pattern
integration.request.location.name
, where location is query string, path, or header, and name is a valid, unique parameter name.The source must be an existing method request parameter or a static value. You must enclose static values in single quotation marks and pre-encode these values based on their destination in the request.
Required: No
Type: Map of String
Update requires: No interruption
RequestTemplates
-
A map of Apache Velocity templates that are applied on the request payload. The template that API Gateway uses is based on the value of the
Content-Type
header that's sent by the client. The content type value is the key, and the template is the value (specified as a string), such as the following snippet:"application/json": "{\n \"statusCode\": 200\n}"
For more information about templates, see API Gateway Mapping Template and Access Logging Variable Reference in the API Gateway Developer Guide.
Required: No
Type: Map of 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
Type
-
The type of backend that your method is running, such as
HTTP
orMOCK
. For all of the valid values, see the type property for theIntegration
resource in the Amazon API Gateway REST API Reference.Required: No
Type: String
Update requires: No interruption
Uri
-
The Uniform Resource Identifier (URI) for the integration.
If you specify
HTTP
for theType
property, specify the API endpoint URL.If you specify
MOCK
for theType
property, don't specify this property.If you specify
AWS
for theType
property, specify an AWS service that follows this form: arn:aws:apigateway:region:subdomain.service|service:path|action/service_api. For example, a Lambda function URI follows this form: arn:aws:apigateway:region:lambda:path/path. The path is usually in the form /2015-03-31/functions/LambdaFunctionARN/invocations. For more information, see theuri
property of the Integration resource in the Amazon API Gateway REST API Reference.If you specified
HTTP
orAWS
for theType
property, you must specify this property.Required: Conditional
Type: String
Update requires: No interruption
See also
-
Method in the Amazon API Gateway REST API Reference