Top / Amazon Web Service / AWS API Gateway / Base Path Mapping

AWS API Gateway Base Path Mapping

This page shows how to write Terraform and CloudFormation for API Gateway Base Path Mapping and write them securely.

terraform-logo

Review your .tf file for AWS best practices

Shisho Cloud, our free checker to make sure your Terraform configuration follows best practices, is available (beta).

aws_api_gateway_base_path_mapping (Terraform)

The Base Path Mapping in API Gateway can be configured in Terraform with the resource name aws_api_gateway_base_path_mapping. The following sections describe 1 example of how to use the resource and its parameters.

Example Usage from GitHub

main.tf#L14
resource "aws_api_gateway_base_path_mapping" "domain_mapping" {
  api_id      = var.rest_api_id
  domain_name = aws_api_gateway_domain_name.domain.domain_name
  stage_name  = var.stage_name

Review your Terraform file for AWS best practices

Shisho Cloud, our free checker to make sure your Terraform configuration follows best practices, is available (beta).

Parameters

>> from Terraform Registry

Explanation in Terraform Registry

Connects a custom domain name registered via aws_api_gateway_domain_name with a deployed API so that its methods can be called via the custom domain name.

>> from Terraform Registry

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.

risk-label

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.

risk-label

aws_api_gateway_domain_name

Ensure to use modern TLS protocols

It is better to adopt TLS v1.2+.

risk-label

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).

risk-label

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.

Review your AWS API Gateway settings

In addition to the above, there are other security points you should be aware of making sure that your .tf files are protected in Shisho Cloud.

AWS::ApiGateway::BasePathMapping (CloudFormation)

The BasePathMapping in ApiGateway can be configured in CloudFormation with the resource name AWS::ApiGateway::BasePathMapping. 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

>> from AWS CloudFormation Documentation

Explanation in CloudFormation Registry

The AWS::ApiGateway::BasePathMapping resource creates a base path that clients who call your API must use in the invocation URL.

>> from AWS CloudFormation Documentation

The Other Related AWS API Gateway Resources

Frequently asked questions

What is AWS API Gateway Base Path Mapping?

AWS API Gateway Base Path Mapping 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 Base Path Mapping?

For Terraform, the cosmic-fusion/cosmic-fusion-api source code example is useful. See the Terraform Example section for further details.

security-icon

Automate config file reviews on your commits

Fix issues in your infrastructure as code with auto-generated patches.

Table of Contents