Class: Method

ApiGateway.Method

new Method()

Properties:
Name Type Description
ApiKeyRequired Boolean Required: No. Indicates whether the method requires clients to submit a valid API key.Update requires: No interruption
AuthorizationType String Required: Conditional. The method's authorization type.Update requires: No interruption
AuthorizerId String Required: No. The identifier of the authorizer to use on this method. If you specify this property, specify CUSTOM for the AuthorizationType property.Update requires: No interruption
HttpMethod String Required: Yes. The HTTP method that clients will use to call this method.Update requires: No interruption
Integration AmazonAPIGatewayMethodIntegration Required: No. The back-end system that the method calls when it receives a request.Update requires: No interruption
MethodResponses AmazonAPIGatewayMethodMethodResponse Required: No. The responses that can be sent to the client who calls the method.Update requires: No interruption
RequestModels Map Required: No. 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.Update requires: No interruption
RequestParameters Map Required: No. Request parameters that API Gateway accepts. Specify request parameters as key-value pairs (string-to-Boolean maps), with a source as the key and a Boolean as the value. The Boolean specifies whether a parameter is required. A source must match the following format method.request.location.name, where the location is querystring, path, or header, and name is a valid, unique parameter name.Update requires: No interruption
ResourceId String Required: Yes. The ID of an API Gateway resource. For root resource methods, specify the RestApi root resource ID, such as { "Fn::GetAtt": ["MyRestApi", "RootResourceId"] }.Update requires: No interruption
RestApiId String Required: Yes. The ID of the RestApi resource in which API Gateway creates the method.Update requires: No interruption
Source:

Extends

  • WKResource

ApiGateway.Method

new Method()

Properties:
Name Type Description
ApiKeyRequired Boolean Required: No. Indicates whether the method requires clients to submit a valid API key.Update requires: No interruption
AuthorizationType String Required: Conditional. The method's authorization type.Update requires: No interruption
AuthorizerId String Required: No. The identifier of the authorizer to use on this method. If you specify this property, specify CUSTOM for the AuthorizationType property.Update requires: No interruption
HttpMethod String Required: Yes. The HTTP method that clients will use to call this method.Update requires: No interruption
Integration AmazonAPIGatewayMethodIntegration Required: No. The back-end system that the method calls when it receives a request.Update requires: No interruption
MethodResponses AmazonAPIGatewayMethodMethodResponse Required: No. The responses that can be sent to the client who calls the method.Update requires: No interruption
RequestModels Map Required: No. 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.Update requires: No interruption
RequestParameters Map Required: No. Request parameters that API Gateway accepts. Specify request parameters as key-value pairs (string-to-Boolean maps), with a source as the key and a Boolean as the value. The Boolean specifies whether a parameter is required. A source must match the following format method.request.location.name, where the location is querystring, path, or header, and name is a valid, unique parameter name.Update requires: No interruption
ResourceId String Required: Yes. The ID of an API Gateway resource. For root resource methods, specify the RestApi root resource ID, such as { "Fn::GetAtt": ["MyRestApi", "RootResourceId"] }.Update requires: No interruption
RestApiId String Required: Yes. The ID of the RestApi resource in which API Gateway creates the method.Update requires: No interruption
Source:

Extends

  • WKResource