This is the new *CloudFormation Template Reference Guide*. Please update your bookmarks and links. For help getting started with CloudFormation, see the [AWS CloudFormation User Guide](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/Welcome.html).
# AWS::ApiGateway::Method Integration
`Integration` is a property of the [AWS::ApiGateway::Method](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-method.html) resource that specifies information about the target backend that a method calls.
## Syntax
To declare this entity in your CloudFormation template, use the following syntax:
### JSON
```
{
"[CacheKeyParameters](#cfn-apigateway-method-integration-cachekeyparameters)" : [ String, ... ],
"[CacheNamespace](#cfn-apigateway-method-integration-cachenamespace)" : String,
"[ConnectionId](#cfn-apigateway-method-integration-connectionid)" : String,
"[ConnectionType](#cfn-apigateway-method-integration-connectiontype)" : String,
"[ContentHandling](#cfn-apigateway-method-integration-contenthandling)" : String,
"[Credentials](#cfn-apigateway-method-integration-credentials)" : String,
"[IntegrationHttpMethod](#cfn-apigateway-method-integration-integrationhttpmethod)" : String,
"[IntegrationResponses](#cfn-apigateway-method-integration-integrationresponses)" : [ IntegrationResponse, ... ],
"[IntegrationTarget](#cfn-apigateway-method-integration-integrationtarget)" : String,
"[PassthroughBehavior](#cfn-apigateway-method-integration-passthroughbehavior)" : String,
"[RequestParameters](#cfn-apigateway-method-integration-requestparameters)" : {Key: Value, ...},
"[RequestTemplates](#cfn-apigateway-method-integration-requesttemplates)" : {Key: Value, ...},
"[ResponseTransferMode](#cfn-apigateway-method-integration-responsetransfermode)" : String,
"[TimeoutInMillis](#cfn-apigateway-method-integration-timeoutinmillis)" : Integer,
"[Type](#cfn-apigateway-method-integration-type)" : String,
"[Uri](#cfn-apigateway-method-integration-uri)" : String
}
```
### YAML
```
[CacheKeyParameters](#cfn-apigateway-method-integration-cachekeyparameters):
- String
[CacheNamespace](#cfn-apigateway-method-integration-cachenamespace): String
[ConnectionId](#cfn-apigateway-method-integration-connectionid): String
[ConnectionType](#cfn-apigateway-method-integration-connectiontype): String
[ContentHandling](#cfn-apigateway-method-integration-contenthandling): String
[Credentials](#cfn-apigateway-method-integration-credentials): String
[IntegrationHttpMethod](#cfn-apigateway-method-integration-integrationhttpmethod): String
[IntegrationResponses](#cfn-apigateway-method-integration-integrationresponses):
- IntegrationResponse
[IntegrationTarget](#cfn-apigateway-method-integration-integrationtarget): String
[PassthroughBehavior](#cfn-apigateway-method-integration-passthroughbehavior): String
[RequestParameters](#cfn-apigateway-method-integration-requestparameters):
Key: Value
[RequestTemplates](#cfn-apigateway-method-integration-requesttemplates):
Key: Value
[ResponseTransferMode](#cfn-apigateway-method-integration-responsetransfermode): String
[TimeoutInMillis](#cfn-apigateway-method-integration-timeoutinmillis): Integer
[Type](#cfn-apigateway-method-integration-type): String
[Uri](#cfn-apigateway-method-integration-uri): String
```
## Properties
`CacheKeyParameters`
A list of request parameters whose values API Gateway caches. To be valid values for `cacheKeyParameters`, these parameters must also be specified for Method `requestParameters`.
*Required*: No
*Type*: Array of String
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)
`CacheNamespace`
Specifies a group of related cached parameters. By default, API Gateway uses the resource ID as the `cacheNamespace`. You can specify the same `cacheNamespace` across resources to return the same cached data for requests to different resources.
*Required*: No
*Type*: String
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)
`ConnectionId`
The ID of the VpcLink used for the integration when `connectionType=VPC_LINK` and undefined, otherwise.
*Required*: No
*Type*: String
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)
`ConnectionType`
The type of the network connection to the integration endpoint. The valid value is `INTERNET` for connections through the public routable internet or `VPC_LINK` for private connections between API Gateway and a network load balancer in a VPC. The default value is `INTERNET`.
*Required*: No
*Type*: String
*Allowed values*: `INTERNET | VPC_LINK`
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)
`ContentHandling`
Specifies how to handle request payload content type conversions. Supported values are `CONVERT_TO_BINARY` and `CONVERT_TO_TEXT`, with the following behaviors:
If this property is not defined, the request payload will be passed through from the method request to integration request without modification, provided that the `passthroughBehavior` is configured to support payload pass-through.
*Required*: No
*Type*: String
*Allowed values*: `CONVERT_TO_BINARY | CONVERT_TO_TEXT`
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)
`Credentials`
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](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)
`IntegrationHttpMethod`
Specifies the integration's HTTP method type. For the Type property, if you specify `MOCK`, this property is optional. For Lambda integrations, you must set the integration method to `POST`. For all other types, you must specify this property.
*Required*: No
*Type*: String
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)
`IntegrationResponses`
Specifies the integration's responses.
*Required*: No
*Type*: Array of [IntegrationResponse](aws-properties-apigateway-method-integrationresponse.md)
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)
`IntegrationTarget`
The ALB or NLB listener to send the request to. Only supported for private integrations that use VPC links V2.
*Required*: No
*Type*: String
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)
`PassthroughBehavior`
Specifies how the method request body of an unmapped content type will be passed through the integration request to the back end without transformation. A content type is unmapped if no mapping template is defined in the integration or the content type does not match any of the mapped content types, as specified in `requestTemplates`. The valid value is one of the following: `WHEN_NO_MATCH`: passes the method request body through the integration request to the back end without transformation when the method request content type does not match any content type associated with the mapping templates defined in the integration request. `WHEN_NO_TEMPLATES`: passes the method request body through the integration request to the back end without transformation when no mapping template is defined in the integration request. If a template is defined when this option is selected, the method request of an unmapped content-type will be rejected with an HTTP 415 Unsupported Media Type response. `NEVER`: rejects the method request with an HTTP 415 Unsupported Media Type response when either the method request content type does not match any content type associated with the mapping templates defined in the integration request or no mapping template is defined in the integration request.
*Required*: No
*Type*: String
*Allowed values*: `WHEN_NO_MATCH | WHEN_NO_TEMPLATES | NEVER`
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)
`RequestParameters`
A key-value map specifying request parameters that are passed from the method request to the back end. 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 back end. 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*: Object of String
*Pattern*: `[a-zA-Z0-9]+`
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)
`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*: Object of String
*Pattern*: `[a-zA-Z0-9]+`
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)
`ResponseTransferMode`
The response transfer mode of the integration. Use `STREAM` to have API Gateway stream response your back to you or use `BUFFERED` to have API Gateway wait to receive the complete response before beginning transmission.
*Required*: No
*Type*: String
*Allowed values*: `BUFFERED | STREAM`
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)
`TimeoutInMillis`
Custom timeout between 50 and 29,000 milliseconds. The default value is 29,000 milliseconds or 29 seconds. You can increase the default value to longer than 29 seconds for Regional or private APIs only.
*Required*: No
*Type*: Integer
*Minimum*: `50`
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)
`Type`
Specifies an API method integration type. The valid value is one of the following:
For the HTTP and HTTP proxy integrations, each integration can specify a protocol (`http/https`), port and path. Standard 80 and 443 ports are supported as well as custom ports above 1024. An HTTP or HTTP proxy integration with a `connectionType` of `VPC_LINK` is referred to as a private integration and uses a VpcLink to connect API Gateway to a network load balancer of a VPC.
*Required*: Yes
*Type*: String
*Allowed values*: `AWS | AWS_PROXY | HTTP | HTTP_PROXY | MOCK`
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)
`Uri`
Specifies Uniform Resource Identifier (URI) of the integration endpoint.
For `HTTP` or `HTTP_PROXY` integrations, the URI must be a fully formed, encoded HTTP(S) URL according to the RFC-3986 specification for standard integrations. If `connectionType` is `VPC_LINK` specify the Network Load Balancer DNS name. For `AWS` or `AWS_PROXY` integrations, the URI is of the form `arn:aws:apigateway:{region}:{subdomain.service|service}:path|action/{service_api}`. Here, \$1Region\$1 is the API Gateway region (e.g., us-east-1); \$1service\$1 is the name of the integrated AWS service (e.g., s3); and \$1subdomain\$1 is a designated subdomain supported by certain AWS service for fast host-name lookup. action can be used for an AWS service action-based API, using an Action=\$1name\$1&\$1p1\$1=\$1v1\$1&p2=\$1v2\$1... query string. The ensuing \$1service\$1api\$1 refers to a supported action \$1name\$1 plus any required input parameters. Alternatively, path can be used for an AWS service path-based API. The ensuing service\$1api refers to the path to an AWS service resource, including the region of the integrated AWS service, if applicable. For example, for integration with the S3 API of GetObject, the uri can be either `arn:aws:apigateway:us-west-2:s3:action/GetObject&Bucket={bucket}&Key={key}` or `arn:aws:apigateway:us-west-2:s3:path/{bucket}/{key}`
*Required*: No
*Type*: String
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)
## See also
+ [Method](https://docs.aws.amazon.com/apigateway/latest/api/API_Method.html) in the *Amazon API Gateway REST API Reference*