Method
import type { Method } from "https://aws-api.deno.dev/v0.3/services/apigateway.ts?docs=full";
TODO: Failed to render documentation: unhandled paragraph inner tag h4
§Properties
A boolean flag specifying whether a valid "ApiKey" is required to invoke this method.
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.
Valid values are NONE
for open access, AWS_IAM
for using AWS IAM permissions, CUSTOM
for using a custom authorizer, or COGNITO_USER_POOLS
for using a Cognito user pool.
The identifier of an "Authorizer" to use on this method.
The authorizationType
must be CUSTOM
.
TODO: Failed to render documentation: unhandled paragraph inner tag h4
TODO: Failed to render documentation: unhandled paragraph inner tag h4
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.
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).
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.