api_mappings_list_only

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

Overview

Name	api_mappings_list_only
Type	Resource
Description	The AWS::ApiGatewayV2::ApiMapping resource contains an API mapping. An API mapping relates a path of your custom domain name to a stage of your API. A custom domain name can have multiple API mappings, but the paths can't overlap. A custom domain can map only to APIs of the same protocol type. For more information, see [CreateApiMapping](https://docs.aws.amazon.com/apigatewayv2/latest/api-reference/domainnames-domainname-apimappings.html#CreateApiMapping) in the *Amazon API Gateway V2 API Reference*.
Id	aws.apigatewayv2.api_mappings_list_only

Fields

Name	Datatype	Description
api_mapping_id	string
domain_name	string	The domain name.
stage	string	The API stage.
api_mapping_key	string	The API mapping key.
api_id	string	The identifier of the API.
region	string	AWS region.

Methods

Name	Accessible by	Required Params
list_resources	SELECT	region

SELECT examples

Lists all api_mappings in a region.

SELECT
region,
api_mapping_id,
domain_name
FROM aws.apigatewayv2.api_mappings_list_only
WHERE region = 'us-east-1';

Permissions

For permissions required to operate on the api_mappings_list_only resource, see api_mappings