steampipe plugin install awssteampipe plugin install aws

Table: aws_api_gatewayv2_route

Routes direct incoming API requests to backend resources.

Examples

Basic info

select
  route_key,
  api_id,
  route_id,
  api_gateway_managed,
  api_key_required
from
  aws_api_gatewayv2_route;

List routes by API

select
  route_key,
  api_id,
  route_id
from
  aws_api_gatewayv2_route
where
  api_id = 'w5n71b2m85';

List routes with default endpoint enabled APIs

select
  r.route_id,
  a.name,
  a.api_id,
  a.api_endpoint
from
  aws_api_gatewayv2_route as r,
  aws_api_gatewayv2_api as a
where
  not a.disable_execute_api_endpoint;

.inspect aws_api_gatewayv2_route

AWS API Gateway Version 2 Route

Name	Type	Description
_ctx	jsonb	Steampipe context in JSON form, e.g. connection_name.
account_id	text	The AWS Account ID in which the resource is located.
akas	jsonb	Array of globally unique identifier strings (also known as) for the resource.
api_gateway_managed	boolean	Specifies whether a route is managed by API Gateway.
api_id	text	Represents the identifier of an API.
api_key_required	boolean	Specifies whether an API key is required for this route. Supported only for WebSocket APIs.
authorization_scopes	jsonb	A list of authorization scopes configured on a route. The scopes are used with a JWT authorizer to authorize the method invocation. The authorization works by matching the route scopes against the scopes parsed from the access token in the incoming request. The method invocation is authorized if any route scope matches a claimed scope in the access token. Otherwise, the invocation is not authorized. When the route scope is configured, the client must provide an access token instead of an identity token for authorization purposes.
authorization_type	text	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.
authorizer_id	text	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.
model_selection_expression	text	The model selection expression for the route. Supported only for WebSocket APIs.
operation_name	text	The operation name for the route.
partition	text	The AWS partition in which the resource is located (aws, aws-cn, or aws-us-gov).
region	text	The AWS Region in which the resource is located.
request_models	jsonb	The request models for the route. Supported only for WebSocket APIs.
request_parameters	jsonb	The request parameters for the route. Supported only for WebSocket APIs.
route_id	text	The route ID.
route_key	text	The route key for the route.
route_response_selection_expression	text	The route response selection expression for the route. Supported only for WebSocket APIs.
target	text	The target for the route.
title	text	Title of the resource.

turbot/aws

Table: aws_api_gatewayv2_route

Examples

Basic info

List routes by API

List routes with default endpoint enabled APIs

.inspect aws_api_gatewayv2_route

Steampipe

Resources

Community