Skip to main content

base_path_mapping

Gets an individual base_path_mapping resource

Overview

Namebase_path_mapping
TypeResource
Descriptionbase_path_mapping
Idawscc.apigateway.base_path_mapping

Fields

NameDatatypeDescription
base_pathstringThe base path name that callers of the API must provide as part of the URL after the domain name.
domain_namestringThe domain name of the BasePathMapping resource to be described.
rest_api_idstringThe string identifier of the associated RestApi.
stagestringThe name of the associated stage.
regionstringAWS region.

Methods

Currently only SELECT is supported for this resource resource.

Example

SELECT
region,
base_path,
domain_name,
rest_api_id,
stage
FROM awscc.apigateway.base_path_mapping
WHERE data__Identifier = '<DomainName>|<BasePath>';

Permissions

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

Read

apigateway:GET

Update

apigateway:GET,
apigateway:DELETE,
apigateway:PATCH

Delete

apigateway:DELETE