latest--aws-apigateway-method
shared| Type | object |
|---|---|
| Schema URL | https://catalog.lintel.tools/schemas/schemastore/serverless-framework-configuration/_shared/latest--aws-apigateway-method.json |
| Parent schema | serverless-framework-configuration |
Resource Type definition for AWS::ApiGateway::Method. Source:- https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-apigateway.git
Properties
The backend system that the method calls when it receives a request.
The ID of an API Gateway resource.
The ID of the RestApi resource in which API Gateway creates the method.
Indicates whether the method requires clients to submit a valid API key.
A list of authorization scopes configured on the method.
The method's authorization type.
The identifier of the authorizer to use on this method.
14 nested properties
The type of backend that your method is running.
A list of request parameters whose values API Gateway caches.
An API-specific tag group of related cached parameters.
The ID of the VpcLink used for the integration when connectionType=VPC_LINK, otherwise undefined.
The type of the network connection to the integration endpoint.
Specifies how to handle request payload content type conversions.
The credentials that are required for the integration.
The integration's HTTP method type.
The response that API Gateway provides after a method's backend completes processing a request.
Indicates when API Gateway passes requests to the targeted backend.
The request parameters that API Gateway sends with the backend request.
A map of Apache Velocity templates that are applied on the request payload.
Custom timeout between 50 and 29,000 milliseconds.
The Uniform Resource Identifier (URI) for the integration.
The responses that can be sent to the client who calls the method.
A friendly operation name for the method.
The resources that are used for the request's content type. Specify request models as key-value pairs (string-to-string mapping), with a content type as the key and a Model resource name as the value.
The request parameters that API Gateway accepts. Specify request parameters as key-value pairs (string-to-Boolean mapping), with a source as the key and a Boolean as the value.
The ID of the associated request validator.
Definitions
The type of backend that your method is running.
A list of request parameters whose values API Gateway caches.
An API-specific tag group of related cached parameters.
The ID of the VpcLink used for the integration when connectionType=VPC_LINK, otherwise undefined.
The type of the network connection to the integration endpoint.
Specifies how to handle request payload content type conversions.
The credentials that are required for the integration.
The integration's HTTP method type.
The response that API Gateway provides after a method's backend completes processing a request.
Indicates when API Gateway passes requests to the targeted backend.
The request parameters that API Gateway sends with the backend request.
A map of Apache Velocity templates that are applied on the request payload.
Custom timeout between 50 and 29,000 milliseconds.
The Uniform Resource Identifier (URI) for the integration.
The method response's status code, which you map to an IntegrationResponse.
The resources used for the response's content type. Specify response models as key-value pairs (string-to-string maps), with a content type as the key and a Model resource name as the value.
Response parameters that API Gateway sends to the client that called a method. Specify response parameters as key-value pairs (string-to-Boolean maps), with a destination as the key and a Boolean as the value.
The status code that API Gateway uses to map the integration response to a MethodResponse status code.
Specifies how to handle request payload content type conversions.
The response parameters from the backend response that API Gateway sends to the method response.
The templates that are used to transform the integration response body. Specify templates as key-value pairs (string-to-string mappings), with a content type as the key and a template as the value.
A regular expression that specifies which error strings or status codes from the backend map to the integration response.