base_path_mappings_list_only

Lists base_path_mappings in a region or regions, for all properties use base_path_mappings

Overview

Name	base_path_mappings_list_only
Type	Resource
Description	The AWS::ApiGateway::BasePathMapping resource creates a base path that clients who call your API must use in the invocation URL.
Id	aws.apigateway.base_path_mappings_list_only

Fields

Name	Datatype	Description
base_path	string	The base path name that callers of the API must provide as part of the URL after the domain name.
domain_name	string	The domain name of the BasePathMapping resource to be described.
rest_api_id	string	The string identifier of the associated RestApi.
stage	string	The name of the associated stage.
region	string	AWS region.

Methods

Name	Accessible by	Required Params
list_resources	SELECT	region

SELECT examples

Lists all base_path_mappings in a region.

SELECT
region,
domain_name,
base_path
FROM aws.apigateway.base_path_mappings_list_only
WHERE region = 'us-east-1';

Permissions

For permissions required to operate on the base_path_mappings_list_only resource, see base_path_mappings