API Gateway Base Path Mapping

API Gateway Base Path Mapping in AWS links a custom domain name to a specific API stage within API Gateway. It allows you to define a base path that routes incoming requests on the custom domain to the correct API and stage. This makes it easier to provide user-friendly URLs and manage multiple APIs under a single domain.

aws.apigateway_base_path_mapping

Fields

TitleIDTypeData TypeDescription
_keycorestring
account_idcorestring
base_pathcorestringThe base path name that callers of the API must provide as part of the URL after the domain name.
base_path_mapping_arncorestring
rest_api_idcorestringThe string identifier of the associated RestApi.
stagecorestringThe name of the associated stage.
tagscorehstore