Method
The `AWS::ApiGateway::Method`
resource creates API Gateway methods that define the parameters and body that clients must send in their requests.
Properties
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.
The method's authorization type. This parameter is required. For valid values, see Method in the API Gateway API Reference. If you specify the `AuthorizerId`
property, specify `CUSTOM`
or `COGNITO_USER_POOLS`
for this property.
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.