AWS API Gateway Method

aws_api_gateway_method (Terraform)

The Method in API Gateway can be configured in Terraform with the resource name aws_api_gateway_method. The following sections describe 4 examples of how to use the resource and its parameters.

Example Usage from GitHub

trackit/aws-workflow-live-streaming

resource "aws_api_gateway_method" "api_method_post_streams" {
  rest_api_id   = aws_api_gateway_rest_api.api.id
  resource_id   = aws_api_gateway_resource.api_resource_streams.id
  http_method   = "POST"
  authorization = "NONE"
}

snyk-labs/infrastructure-as-code-goof

resource "aws_api_gateway_method" "denied" {
  http_method = "ANY"
  authorization = "NONE"
}

resource "aws_api_gateway_method" "denied_2" {

shisho-security/shisho-security

resource "aws_api_gateway_method" "good_example" {
  rest_api_id   = aws_api_gateway_rest_api.MyDemoAPI.id
  resource_id   = aws_api_gateway_resource.MyDemoResource.id
  http_method   = "GET"
  authorization = "AWS_IAM"
}

jjoc007/poc-appsync-golang-mongo

resource "aws_api_gateway_method" "poc_person_post_method" {
  rest_api_id   = aws_api_gateway_rest_api.poc_rest_api.id
  resource_id   = aws_api_gateway_resource.poc_person_resource.id
  http_method   = "POST"
  authorization = "NONE"
  api_key_required = false

Security Best Practices for aws_api_gateway_method

There is 1 setting in aws_api_gateway_method that should be taken care of for security reasons. The following section explain an overview and example code.

Ensure that your API Gateway method blocks unwanted access

It is better that the API Gateway method does not allow public access.

Parameters

• api_key_required optional - bool
• authorization required - string
• authorization_scopes optional - set of string
• authorizer_id optional - string
• http_method required - string
• id optional computed - string
• operation_name optional - string
• request_models optional - map from string to string
• request_parameters optional - map from string to bool
• request_validator_id optional - string
• resource_id required - string
• rest_api_id required - string

Explanation in Terraform Registry

Provides a HTTP Method for an API Gateway Resource.

Tips: Best Practices for The Other AWS API Gateway Resources

In addition to the aws_api_gateway_method_settings, AWS API Gateway has the other resources that should be configured for security reasons. Please check some examples of those resources and precautions.

aws_api_gateway_method_settings

Ensure that API Gateway stage-level cache is encrypted

It is better to enable the stage-level cache encryption which reduces the risk of data leakage.

aws_api_gateway_domain_name

Ensure to use modern TLS protocols

It is better to adopt TLS v1.2+.

aws_api_gateway_stage

Ensure to enable access logging of your API Gateway stage (v1)

It is better to enable the access logging of your API Gateway stage (v1).