method

Gets an individual method resource

Overview

Name	method
Type	Resource
Description	method
Id	awscc.apigateway.method

Fields

Name	Datatype	Description
api_key_required	boolean	A boolean flag specifying whether a valid ApiKey is required to invoke this method.
authorization_scopes	array	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.
authorization_type	string	The method's authorization type. This parameter is required. For valid values, see [Method](https://docs.aws.amazon.com/apigateway/latest/api/API_Method.html) in the *API Gateway API Reference*.<br/> If you specify the ``AuthorizerId`` property, specify ``CUSTOM`` or ``COGNITO_USER_POOLS`` for this property.
authorizer_id	string	The identifier of an authorizer to use on this method. The method's authorization type must be ``CUSTOM`` or ``COGNITO_USER_POOLS``.
http_method	string	The method's HTTP verb.
integration	object	Represents an ``HTTP``, ``HTTP_PROXY``, ``AWS``, ``AWS_PROXY``, or Mock integration.
method_responses	array	Gets a method response associated with a given HTTP status code.
operation_name	string	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.
request_models	object	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).
request_parameters	object	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.
request_validator_id	string	The identifier of a RequestValidator for request validation.
resource_id	string	The Resource identifier for the MethodResponse resource.
rest_api_id	string	The string identifier of the associated RestApi.
region	string	AWS region.

Methods

Currently only SELECT is supported for this resource resource.

Example

SELECT
region,
api_key_required,
authorization_scopes,
authorization_type,
authorizer_id,
http_method,
integration,
method_responses,
operation_name,
request_models,
request_parameters,
request_validator_id,
resource_id,
rest_api_id
FROM awscc.apigateway.method
WHERE data__Identifier = '<RestApiId>|<ResourceId>|<HttpMethod>';

Permissions

To operate on the method resource, the following permissions are required:

Read

apigateway:GET

Update

apigateway:GET,
apigateway:DELETE,
apigateway:PUT,
iam:PassRole

Delete

apigateway:DELETE