AWS Fundamentals Logo
AWS Fundamentals
L1 ConstructAWS::ApiGateway::Method

CfnMethod

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

Import

import { CfnMethod } from 'aws-cdk-lib/aws-apigateway';

Or use the module namespace:

import * as apigateway from 'aws-cdk-lib/aws-apigateway';
// apigateway.CfnMethod

Properties

Configuration passed to the constructor as CfnMethodProps.

httpMethodRequired
string

The method's HTTP verb.

resourceIdRequired
string | IResourceRef

The Resource identifier for the MethodResponse resource.

restApiIdRequired
string | IRestApiRef

The string identifier of the associated RestApi.

apiKeyRequiredOptional
boolean | IResolvable

A boolean flag specifying whether a valid ApiKey is required to invoke this method.

authorizationScopesOptional
string[]

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.

authorizationTypeOptional
string

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.

authorizerIdOptional
string | IAuthorizerRef

The identifier of an authorizer to use on this method. The method's authorization type must be `CUSTOM` or `COGNITO_USER_POOLS` .

integrationOptional
IResolvable | IntegrationProperty

Represents an `HTTP` , `HTTP_PROXY` , `AWS` , `AWS_PROXY` , or Mock integration.

methodResponsesOptional
IResolvable | IResolvable | MethodResponseProperty[]

Gets a method response associated with a given HTTP status code.

operationNameOptional
string

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.

requestModelsOptional
{ [key: string]: string } | IResolvable

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).

requestParametersOptional
IResolvable | { [key: string]: boolean | IResolvable }

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.

requestValidatorIdOptional
string | IRequestValidatorRef

The identifier of a RequestValidator for request validation.

CloudFormation Resource

This L1 construct maps directly to the following CloudFormation resource type.

Get the Amazon API Gateway Cheat Sheet

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

Download Free Infographic