local_gateway_routes

Creates, updates, deletes or gets a local_gateway_route resource or lists local_gateway_routes in a region

Overview

Name	local_gateway_routes
Type	Resource
Description	Describes a route for a local gateway route table.
Id	aws.ec2.local_gateway_routes

Fields

Name	Datatype	Description
destination_cidr_block	string	The CIDR block used for destination matches.
local_gateway_route_table_id	string	The ID of the local gateway route table.
local_gateway_virtual_interface_group_id	string	The ID of the virtual interface group.
network_interface_id	string	The ID of the network interface.
state	string	The state of the route.
type	string	The route type.
region	string	AWS region.

Methods

Name	Accessible by	Required Params
create_resource	INSERT	region
delete_resource	DELETE	data__Identifier, region
update_resource	UPDATE	data__Identifier, data__PatchDocument, region
list_resources	SELECT	region
get_resource	SELECT	data__Identifier, region

SELECT examples

Gets all local_gateway_routes in a region.

SELECT
region,
destination_cidr_block,
local_gateway_route_table_id,
local_gateway_virtual_interface_group_id,
network_interface_id,
state,
type
FROM aws.ec2.local_gateway_routes
WHERE region = 'us-east-1';

Gets all properties from an individual local_gateway_route.

SELECT
region,
destination_cidr_block,
local_gateway_route_table_id,
local_gateway_virtual_interface_group_id,
network_interface_id,
state,
type
FROM aws.ec2.local_gateway_routes
WHERE region = 'us-east-1' AND data__Identifier = '<DestinationCidrBlock>|<LocalGatewayRouteTableId>';

INSERT example

Use the following StackQL query and manifest file to create a new local_gateway_route resource, using stack-deploy.

Required Properties

/*+ create */
INSERT INTO aws.ec2.local_gateway_routes (
 DestinationCidrBlock,
 LocalGatewayRouteTableId,
 LocalGatewayVirtualInterfaceGroupId,
 NetworkInterfaceId,
 region
)
SELECT 
'{{ DestinationCidrBlock }}',
 '{{ LocalGatewayRouteTableId }}',
 '{{ LocalGatewayVirtualInterfaceGroupId }}',
 '{{ NetworkInterfaceId }}',
'{{ region }}';

All Properties

/*+ create */
INSERT INTO aws.ec2.local_gateway_routes (
 DestinationCidrBlock,
 LocalGatewayRouteTableId,
 LocalGatewayVirtualInterfaceGroupId,
 NetworkInterfaceId,
 region
)
SELECT 
 '{{ DestinationCidrBlock }}',
 '{{ LocalGatewayRouteTableId }}',
 '{{ LocalGatewayVirtualInterfaceGroupId }}',
 '{{ NetworkInterfaceId }}',
 '{{ region }}';

Manifest

version: 1
name: stack name
description: stack description
providers:
  - aws
globals:
  - name: region
    value: '{{ vars.AWS_REGION }}'
resources:
  - name: local_gateway_route
    props:
      - name: DestinationCidrBlock
        value: '{{ DestinationCidrBlock }}'
      - name: LocalGatewayRouteTableId
        value: '{{ LocalGatewayRouteTableId }}'
      - name: LocalGatewayVirtualInterfaceGroupId
        value: '{{ LocalGatewayVirtualInterfaceGroupId }}'
      - name: NetworkInterfaceId
        value: '{{ NetworkInterfaceId }}'

DELETE example

/*+ delete */
DELETE FROM aws.ec2.local_gateway_routes
WHERE data__Identifier = '<DestinationCidrBlock|LocalGatewayRouteTableId>'
AND region = 'us-east-1';

Permissions

To operate on the local_gateway_routes resource, the following permissions are required:

Create

ec2:CreateLocalGatewayRoute,
ec2:SearchLocalGatewayRoutes

Read

ec2:SearchLocalGatewayRoutes

Delete

ec2:DeleteLocalGatewayRoute,
ec2:SearchLocalGatewayRoutes

List

ec2:DescribeLocalGatewayRouteTables,
ec2:SearchLocalGatewayRoutes

Update

ec2:ModifyLocalGatewayRoute,
ec2:SearchLocalGatewayRoutes