routes_list_only

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

Overview

Name	routes_list_only
Type	Resource
Description	The AWS::ApiGatewayV2::Route resource creates a route for an API.
Id	aws.apigatewayv2.routes_list_only

Fields

Name	Datatype	Description
route_id	string
route_response_selection_expression	string	The route response selection expression for the route. Supported only for WebSocket APIs.
request_models	object	The request models for the route. Supported only for WebSocket APIs.
operation_name	string	The operation name for the route.
authorization_scopes	array	The authorization scopes supported by this route.
api_key_required	boolean	Specifies whether an API key is required for the route. Supported only for WebSocket APIs.
route_key	string	The route key for the route. For HTTP APIs, the route key can be either $default, or a combination of an HTTP method and resource path, for example, GET /pets.
authorization_type	string	The authorization type for the route. For WebSocket APIs, valid values are NONE for open access, AWS_IAM for using AWS IAM permissions, and CUSTOM for using a Lambda authorizer. For HTTP APIs, valid values are NONE for open access, JWT for using JSON Web Tokens, AWS_IAM for using AWS IAM permissions, and CUSTOM for using a Lambda authorizer.
model_selection_expression	string	The model selection expression for the route. Supported only for WebSocket APIs.
api_id	string	The API identifier.
request_parameters	object	The request parameters for the route. Supported only for WebSocket APIs.
target	string	The target for the route.
authorizer_id	string	The identifier of the Authorizer resource to be associated with this route. The authorizer identifier is generated by API Gateway when you created the authorizer.
region	string	AWS region.

Methods

Name	Accessible by	Required Params
list_resources	SELECT	region

SELECT examples

Lists all routes in a region.

SELECT
region,
api_id,
route_id
FROM aws.apigatewayv2.routes_list_only
WHERE region = 'us-east-1';

Permissions

For permissions required to operate on the routes_list_only resource, see routes