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
The `AWS::ApiGateway::Method` resource creates API Gateway methods that define the parameters and body that clients must send in their requests.
## Syntax
To declare this entity in your CloudFormation template, use the following syntax:
### JSON
```
{
"Type" : "AWS::ApiGateway::Method",
"Properties" : {
"[ApiKeyRequired](#cfn-apigateway-method-apikeyrequired)" : Boolean,
"[AuthorizationScopes](#cfn-apigateway-method-authorizationscopes)" : [ String, ... ],
"[AuthorizationType](#cfn-apigateway-method-authorizationtype)" : String,
"[AuthorizerId](#cfn-apigateway-method-authorizerid)" : String,
"[HttpMethod](#cfn-apigateway-method-httpmethod)" : String,
"[Integration](#cfn-apigateway-method-integration)" : Integration,
"[MethodResponses](#cfn-apigateway-method-methodresponses)" : [ MethodResponse, ... ],
"[OperationName](#cfn-apigateway-method-operationname)" : String,
"[RequestModels](#cfn-apigateway-method-requestmodels)" : {Key: Value, ...},
"[RequestParameters](#cfn-apigateway-method-requestparameters)" : {Key: Value, ...},
"[RequestValidatorId](#cfn-apigateway-method-requestvalidatorid)" : String,
"[ResourceId](#cfn-apigateway-method-resourceid)" : String,
"[RestApiId](#cfn-apigateway-method-restapiid)" : String
}
}
```
### YAML
```
Type: AWS::ApiGateway::Method
Properties:
[ApiKeyRequired](#cfn-apigateway-method-apikeyrequired): Boolean
[AuthorizationScopes](#cfn-apigateway-method-authorizationscopes):
- String
[AuthorizationType](#cfn-apigateway-method-authorizationtype): String
[AuthorizerId](#cfn-apigateway-method-authorizerid): String
[HttpMethod](#cfn-apigateway-method-httpmethod): String
[Integration](#cfn-apigateway-method-integration):
Integration
[MethodResponses](#cfn-apigateway-method-methodresponses):
- MethodResponse
[OperationName](#cfn-apigateway-method-operationname): String
[RequestModels](#cfn-apigateway-method-requestmodels):
Key: Value
[RequestParameters](#cfn-apigateway-method-requestparameters):
Key: Value
[RequestValidatorId](#cfn-apigateway-method-requestvalidatorid): String
[ResourceId](#cfn-apigateway-method-resourceid): String
[RestApiId](#cfn-apigateway-method-restapiid): String
```
## Properties
`ApiKeyRequired`
A boolean flag specifying whether a valid ApiKey is required to invoke this method.
*Required*: No
*Type*: Boolean
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)
`AuthorizationScopes`
A list of authorization scopes configured on the method. The scopes are used with a `COGNITO_USER_POOLS` authorizer to authorize the method invocation. The authorization works by matching the method scopes against the scopes parsed from the access token in the incoming request. The method invocation is authorized if any method scopes matches a claimed scope in the access token. Otherwise, the invocation is not authorized. When the method scope is configured, the client must provide an access token instead of an identity token for authorization purposes.
*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)
`AuthorizationType`
The method's authorization type. This parameter is required. For valid values, see [Method](https://docs.aws.amazon.com/apigateway/latest/api/API_Method.html) in the *API Gateway API Reference*.
If you specify the `AuthorizerId` property, specify `CUSTOM` or `COGNITO_USER_POOLS` for 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)
`AuthorizerId`
The identifier of an authorizer to use on this method. The method's authorization type must be `CUSTOM` or `COGNITO_USER_POOLS`.
*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)
`HttpMethod`
The method's HTTP verb.
*Required*: Yes
*Type*: String
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)
`Integration`
Represents an `HTTP`, `HTTP_PROXY`, `AWS`, `AWS_PROXY`, or Mock integration.
*Required*: No
*Type*: [Integration](aws-properties-apigateway-method-integration.md)
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)
`MethodResponses`
Gets a method response associated with a given HTTP status code.
*Required*: No
*Type*: Array of [MethodResponse](aws-properties-apigateway-method-methodresponse.md)
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)
`OperationName`
A human-friendly operation identifier for the method. For example, you can assign the `operationName` of `ListPets` for the `GET /pets` method in the `PetStore` example.
*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)
`RequestModels`
A key-value map specifying data schemas, represented by Model resources, (as the mapped value) of the request payloads of given content types (as the mapping key).
*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)
`RequestParameters`
A key-value map defining required or optional method request parameters that can be accepted by API Gateway. A key is a method request parameter name matching the pattern of `method.request.{location}.{name}`, where `location` is `querystring`, `path`, or `header` and `name` is a valid and unique parameter name. The value associated with the key is a Boolean flag indicating whether the parameter is required (`true`) or optional (`false`). The method request parameter names defined here are available in Integration to be mapped to integration request parameters or templates.
*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)
`RequestValidatorId`
The identifier of a RequestValidator for request validation.
*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)
`ResourceId`
The Resource identifier for the MethodResponse resource.
*Required*: Yes
*Type*: String
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)
`RestApiId`
The string identifier of the associated RestApi.
*Required*: Yes
*Type*: String
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)
## Return values
### Ref
When you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the method ID, such as `mysta-metho-01234b567890example`.
For more information about using the `Ref` function, see [https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).
## Examples
**Topics**
+ [Mock Method](#aws-resource-apigateway-method--examples--Mock_Method)
+ [Lambda Proxy](#aws-resource-apigateway-method--examples--Lambda_Proxy)
+ [Associated Request Validator](#aws-resource-apigateway-method--examples--Associated_Request_Validator)
### Mock Method
The following example creates a mock GET method for the `MyApi` API.
#### JSON
```
{
"AWSTemplateFormatVersion": "2010-09-09",
"Resources": {
"Api": {
"Type": "AWS::ApiGateway::RestApi",
"Properties": {
"Name": "myAPI"
}
},
"MockMethod": {
"Type": "AWS::ApiGateway::Method",
"Properties": {
"RestApiId": {
"Ref": "Api"
},
"ResourceId": {
"Fn::GetAtt": [
"Api",
"RootResourceId"
]
},
"HttpMethod": "GET",
"AuthorizationType": "NONE",
"RequestParameters": {
"method.request.header.myheader": false
},
"Integration": {
"Type": "MOCK",
"RequestParameters": {
"integration.request.header.header1": "method.request.header.myheader"
},
"RequestTemplates": {
"application/json": "{\"statusCode\": 200}"
},
"IntegrationResponses": [
{
"StatusCode": "200",
"ResponseParameters": {
"method.response.header.header1": "integration.response.header.header1",
"method.response.header.header2": "'staticvalue'"
}
}
]
},
"MethodResponses": [
{
"StatusCode": "200",
"ResponseParameters": {
"method.response.header.header1": true,
"method.response.header.header2": true
}
}
]
}
}
}
}
```
#### YAML
```
AWSTemplateFormatVersion: '2010-09-09'
Resources:
Api:
Type: AWS::ApiGateway::RestApi
Properties:
Name: myAPI
MockMethod:
Type: AWS::ApiGateway::Method
Properties:
RestApiId: !Ref Api
ResourceId: !GetAtt Api.RootResourceId
HttpMethod: GET
AuthorizationType: NONE
RequestParameters:
method.request.header.myheader: false
Integration:
Type: MOCK
RequestTemplates:
application/json: "{\"statusCode\": 200}"
RequestParameters:
integration.request.header.header1: method.request.header.myheader
IntegrationResponses:
- StatusCode: '200'
ResponseParameters:
method.response.header.header1: integration.response.header.header1
method.response.header.header2: '''staticvalue'''
MethodResponses:
- StatusCode: '200'
ResponseParameters:
method.response.header.header1: true
method.response.header.header2: true
```
### Lambda Proxy
The following example creates a proxy resource to enable clients to call a Lambda function with a single integration setup on a catch-all ANY method. The `Uri` property specifies the Lambda function. For more information about Lambda proxy integration and a sample Lambda function, see [Create an API with Lambda Proxy Integration through a Proxy Resource](https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-create-api-as-simple-proxy-for-lambda.html) in the *API Gateway Developer Guide*.
**Note**
Use the [AWS::Lambda::Permission](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-permission.html) resource to grant API Gateway permission to invoke your Lambda function.
#### JSON
```
{
"ProxyResource": {
"Type": "AWS::ApiGateway::Resource",
"Properties": {
"RestApiId": {
"Ref": "LambdaSimpleProxy"
},
"ParentId": {
"Fn::GetAtt": [
"LambdaSimpleProxy",
"RootResourceId"
]
},
"PathPart": "{proxy+}"
}
},
"ProxyResourceANY": {
"Type": "AWS::ApiGateway::Method",
"Properties": {
"RestApiId": {
"Ref": "LambdaSimpleProxy"
},
"ResourceId": {
"Ref": "ProxyResource"
},
"HttpMethod": "ANY",
"AuthorizationType": "NONE",
"Integration": {
"Type": "AWS_PROXY",
"IntegrationHttpMethod": "POST",
"Uri": {
"Fn::Sub": "arn:aws:apigateway:${AWS::Region}:lambda:path/2015-03-31/functions/${LambdaForSimpleProxy.Arn}/invocations"
}
}
}
}
}
```
#### YAML
```
ProxyResource:
Type: 'AWS::ApiGateway::Resource'
Properties:
RestApiId: !Ref LambdaSimpleProxy
ParentId: !GetAtt
- LambdaSimpleProxy
- RootResourceId
PathPart: '{proxy+}'
ProxyResourceANY:
Type: 'AWS::ApiGateway::Method'
Properties:
RestApiId: !Ref LambdaSimpleProxy
ResourceId: !Ref ProxyResource
HttpMethod: ANY
AuthorizationType: NONE
Integration:
Type: AWS_PROXY
IntegrationHttpMethod: POST
Uri: !Sub >-
arn:aws:apigateway:${AWS::Region}:lambda:path/2015-03-31/functions/${LambdaForSimpleProxy.Arn}/invocations
```
### Associated Request Validator
The following example creates a REST API, method, and request validator, and associates the request validator with the method. It also lets you specify how to convert the request payload.
#### JSON
```
{
"Parameters": {
"contentHandling": {
"Type": "String"
},
"operationName": {
"Type": "String",
"Default": "testoperationName"
},
"restApiName": {
"Type": "String",
"Default": "testrestApiName"
},
"validatorName": {
"Type": "String",
"Default": "testvalidatorName"
},
"validateRequestBody": {
"Type": "String",
"Default": "testvalidateRequestBody"
},
"validateRequestParameters": {
"Type": "String",
"Default": true
}
},
"Resources": {
"RestApi": {
"Type": "AWS::ApiGateway::RestApi",
"Properties": {
"Name": {
"Ref": "restApiName"
}
}
},
"Method": {
"Type": "AWS::ApiGateway::Method",
"Properties": {
"HttpMethod": "POST",
"ResourceId": {
"Fn::GetAtt": [
"RestApi",
"RootResourceId"
]
},
"RestApiId": {
"Ref": "RestApi"
},
"AuthorizationType": "NONE",
"Integration": {
"Type": "MOCK",
"ContentHandling": {
"Ref": "contentHandling"
},
"IntegrationResponses": [
{
"ContentHandling": {
"Ref": "contentHandling"
},
"StatusCode": 400
}
]
},
"RequestValidatorId": {
"Ref": "RequestValidator"
},
"OperationName": {
"Ref": "operationName"
}
}
},
"RequestValidator": {
"Type": "AWS::ApiGateway::RequestValidator",
"Properties": {
"Name": {
"Ref": "validatorName"
},
"RestApiId": {
"Ref": "RestApi"
},
"ValidateRequestBody": {
"Ref": "validateRequestBody"
},
"ValidateRequestParameters": {
"Ref": "validateRequestParameters"
}
}
}
},
"Outputs": {
"RootResourceId": {
"Value": {
"Fn::GetAtt": [
"RestApi",
"RootResourceId"
]
}
}
}
}
```
#### YAML
```
Parameters:
contentHandling:
Type: String
operationName:
Type: String
Default: testoperationName
restApiName:
Type: String
Default: testrestApiName
validatorName:
Type: String
Default: testvalidatorName
validateRequestBody:
Type: String
Default: testvalidateRequestBody
validateRequestParameters:
Type: String
Default: true
Resources:
RestApi:
Type: AWS::ApiGateway::RestApi
Properties:
Name: !Ref restApiName
Method:
Type: AWS::ApiGateway::Method
Properties:
HttpMethod: POST
ResourceId: !GetAtt RestApi.RootResourceId
RestApiId: !Ref RestApi
AuthorizationType: NONE
Integration:
Type: MOCK
ContentHandling: !Ref contentHandling
IntegrationResponses:
- ContentHandling: !Ref contentHandling
StatusCode: 400
RequestValidatorId: !Ref RequestValidator
OperationName: !Ref operationName
RequestValidator:
Type: AWS::ApiGateway::RequestValidator
Properties:
Name: !Ref validatorName
RestApiId: !Ref RestApi
ValidateRequestBody: !Ref validateRequestBody
ValidateRequestParameters: !Ref validateRequestParameters
Outputs:
RootResourceId:
Value: !GetAtt RestApi.RootResourceId
```
## See also
+ [method:put](https://docs.aws.amazon.com/apigateway/latest/api/API_PutMethod.html) in the *Amazon API Gateway REST API Reference*