Skip to main content

routes_list_only

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

Overview

Nameroutes_list_only
TypeResource
DescriptionSpecifies a route in a route table. For more information, see [Routes](https://docs.aws.amazon.com/vpc/latest/userguide/VPC_Route_Tables.html#route-table-routes) in the *Amazon VPC User Guide*.
You must specify either a destination CIDR block or prefix list ID. You must also specify exactly one of the resources as the target.
If you create a route that references a transit gateway in the same template where you create the transit gateway, you must declare a dependency on the transit gateway attachment. The route table cannot use the transit gateway until it has successfully attached to the VPC. Add a [DependsOn Attribute](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-dependson.html) in the AWS::EC2::Route resource to explicitly declare a dependency on the AWS::EC2::TransitGatewayAttachment resource.
Idaws.ec2.routes_list_only

Fields

NameDatatypeDescription
carrier_gateway_idstringThe ID of the carrier gateway.
You can only use this option when the VPC contains a subnet which is associated with a Wavelength Zone.
cidr_blockstring
core_network_arnstringThe Amazon Resource Name (ARN) of the core network.
destination_cidr_blockstringThe IPv4 CIDR address block used for the destination match. Routing decisions are based on the most specific match. We modify the specified CIDR block to its canonical form; for example, if you specify 100.68.0.18/18, we modify it to 100.68.0.0/18.
destination_ipv6_cidr_blockstringThe IPv6 CIDR block used for the destination match. Routing decisions are based on the most specific match.
destination_prefix_list_idstringThe ID of a prefix list used for the destination match.
egress_only_internet_gateway_idstring[IPv6 traffic only] The ID of an egress-only internet gateway.
gateway_idstringThe ID of an internet gateway or virtual private gateway attached to your VPC.
instance_idstringThe ID of a NAT instance in your VPC. The operation fails if you specify an instance ID unless exactly one network interface is attached.
local_gateway_idstringThe ID of the local gateway.
nat_gateway_idstring[IPv4 traffic only] The ID of a NAT gateway.
network_interface_idstringThe ID of a network interface.
route_table_idstringThe ID of the route table for the route.
transit_gateway_idstringThe ID of a transit gateway.
vpc_endpoint_idstringThe ID of a VPC endpoint. Supported for Gateway Load Balancer endpoints only.
vpc_peering_connection_idstringThe ID of a VPC peering connection.
regionstringAWS region.

Methods

NameAccessible byRequired Params
list_resourcesSELECTregion

SELECT examples

Lists all routes in a region.

SELECT
region,
route_table_id,
cidr_block
FROM aws.ec2.routes_list_only
WHERE region = 'us-east-1';

Permissions

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