AWS Fundamentals Logo
AWS Fundamentals
AWS::ApiGateway::Method

ApiGateway Method

The AWS::ApiGateway::Method resource creates API Gateway methods that define the parameters and body that clients must send in their requests.

Properties

13 configurable properties. 3 required. Click a row to see details.

Filter:
PropertyTypeFlags
HttpMethod
string
RequiredCreate-only
ResourceId
string
RequiredCreate-only
RestApiId
string
RequiredCreate-only
ApiKeyRequired
boolean
AuthorizationScopes
Array<string>
AuthorizationType
string
AuthorizerId
string
Integration
Integration
MethodResponses
Array<MethodResponse>
OperationName
string
RequestModels
object
RequestParameters
object
RequestValidatorId
string

Sample CloudFormation Template

A minimal template with required properties and common optional ones.

template.yaml
AWSTemplateFormatVersion: "2010-09-09"
Description: Sample template for AWS::ApiGateway::Method

Resources:
  MyResource:
    Type: AWS::ApiGateway::Method
    Properties:
      RestApiId: "my-restapiid"
      ResourceId: "my-resourceid"
      HttpMethod: "value"

Required IAM Permissions

Permissions CloudFormation needs in your IAM role to manage this resource.

read

apigateway:GET

create

apigateway:PUTapigateway:GETiam:PassRole

update

apigateway:GETapigateway:DELETEapigateway:PUTiam:PassRole

delete

apigateway:DELETE

Get the ApiGateway Cheat Sheet

Everything you need to know about ApiGateway on one page. HD quality, print-friendly.

Download Free Infographic

Quick Facts

ServiceApiGateway
Properties13
Required3
TaggingNot supported
Primary IDRestApiId

Supported Operations

ReadCreateUpdateDelete

Immutable After Creation

These properties cannot be changed after the resource is created. Updating them triggers a replacement.

RestApiIdResourceIdHttpMethod

Related Resources

External Links