AWS API Gateway Resource
This page shows how to write Terraform and CloudFormation for API Gateway Resource and write them securely.
aws_api_gateway_resource (Terraform)
The Resource in API Gateway can be configured in Terraform with the resource name aws_api_gateway_resource
. The following sections describe 2 examples of how to use the resource and its parameters.
Example Usage from GitHub
resource "aws_api_gateway_resource" "namespace" {
rest_api_id = var.rest_api_id
parent_id = var.parent_resource_id
path_part = "{namespace}"
}
resource "aws_api_gateway_resource" "events_root" {
parent_id = aws_api_gateway_rest_api.glados_example_api.root_resource_id
path_part = "Events"
rest_api_id = aws_api_gateway_rest_api.glados_example_api.id
}
Parameters
-
id
optional computed - string -
parent_id
required - string -
path
optional computed - string -
path_part
required - string -
rest_api_id
required - string
Explanation in Terraform Registry
Provides 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).
aws_api_gateway_method
Ensure that your API Gateway method blocks unwanted access
It is better that the API Gateway method does not allow public access.
AWS::ApiGateway::Resource (CloudFormation)
The Resource in ApiGateway can be configured in CloudFormation with the resource name AWS::ApiGateway::Resource
. The following sections describe how to use the resource and its parameters.
Example Usage from GitHub
An example could not be found in GitHub.
Parameters
Explanation in CloudFormation Registry
The
AWS::ApiGateway::Resource
resource creates a resource in an API.
Frequently asked questions
What is AWS API Gateway Resource?
AWS API Gateway Resource is a resource for API Gateway of Amazon Web Service. Settings can be wrote in Terraform and CloudFormation.
Where can I find the example code for the AWS API Gateway Resource?
For Terraform, the apparentlymart/terraform-aws-tf-registry and zpriddy/GLaDOS source code examples are useful. See the Terraform Example section for further details.