Cloud.Service.AWS.API.Gateway.Method

JSON Example

{
    "account": "string",
    "api_key_required": false,
    "authorization": "string",
    "authorization_scopes": [
        "string"
    ],
    "authorizer_id": "string",
    "count": 0,
    "http_method": "string",
    "region": "string",
    "request_models": {},
    "request_parameters": {},
    "request_parameters_in_json": "string",
    "request_validator_id": "string",
    "resource_id": "string",
    "rest_api_id": "string"
}

string

account

Required

(Required) The name of the AWS cloud account to use for this resource

boolean

api_key_required

Optional

Whether the method requires an API key, TRUE or FALSE.

string

authorization

Required

(Required) Method authorization of NONE, CUSTOM, AWS_IAM, or COGNITO_USER_POOLS.

array of string

authorization_scopes

Optional

List of authorization scopes configured on the method, which are used with the COGNITO_USER_POOLS authorizer to authorize the method invocation.

string

authorizer_id

Optional

Method authorizer to use when authorization is CUSTOM or COGNITO_USER_POOLS.

integer

count

Optional

The number of resource instances to be created.

string

http_method

Required

(Required) API HTTP method of GET, POST, PUT, DELETE, HEAD, OPTION, or ANY.

string

region

Required

(Required) Target cloud region, such as us-east-1. Must be within the provider cloud account.

object

request_models

Optional

Map of the API models used for the request content type.

object

request_parameters

Optional

Map of request parameters from the path, query string, and headers to pass to the integration. Includes a boolean true-false value to indicate whether the parameter is required.

string

request_parameters_in_json

Optional

JSON formatted map of request query string parameters and headers to pass to the back-end responder.

string

request_validator_id

Optional

Unique identifier of the set of validation rules for incoming method requests.

string

resource_id

Required

(Required) Unique identifier assigned to the method by AWS.

string

rest_api_id

Required

(Required) Unique identifier of the associated application REST API.