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	Resource Type definition for Local Gateway Route which describes a route for a local gateway route table.
Id	awscc.ec2.local_gateway_routes

Fields

get (all properties)

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.

list (identifiers only)

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.
region	string	AWS region.

For more information, see AWS::EC2::LocalGatewayRoute.

Methods

Name	Resource	Accessible by	Required Params
create_resource	local_gateway_routes	INSERT	region
delete_resource	local_gateway_routes	DELETE	Identifier, region
update_resource	local_gateway_routes	UPDATE	Identifier, PatchDocument, region
list_resources	local_gateway_routes_list_only	SELECT	region
get_resource	local_gateway_routes	SELECT	Identifier, region

SELECT examples

get (all properties)

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 awscc.ec2.local_gateway_routes
WHERE
  region = '{{ region }}' AND
  Identifier = '{{ destination_cidr_block }}|{{ local_gateway_route_table_id }}';

list (identifiers only)

Lists all local_gateway_routes in a region.

SELECT
  region,
  destination_cidr_block,
  local_gateway_route_table_id
FROM awscc.ec2.local_gateway_routes_list_only
WHERE
  region = '{{ region }}';

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 awscc.ec2.local_gateway_routes (
  DestinationCidrBlock,
  LocalGatewayRouteTableId,
  LocalGatewayVirtualInterfaceGroupId,
  NetworkInterfaceId,
  region
)
SELECT
  '{{ destination_cidr_block }}',
  '{{ local_gateway_route_table_id }}',
  '{{ local_gateway_virtual_interface_group_id }}',
  '{{ network_interface_id }}',
  '{{ region }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

All Properties

/*+ create */
INSERT INTO awscc.ec2.local_gateway_routes (
  DestinationCidrBlock,
  LocalGatewayRouteTableId,
  LocalGatewayVirtualInterfaceGroupId,
  NetworkInterfaceId,
  region
)
SELECT
  '{{ destination_cidr_block }}',
  '{{ local_gateway_route_table_id }}',
  '{{ local_gateway_virtual_interface_group_id }}',
  '{{ network_interface_id }}',
  '{{ region }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

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: destination_cidr_block
      value: '{{ destination_cidr_block }}'
    - name: local_gateway_route_table_id
      value: '{{ local_gateway_route_table_id }}'
    - name: local_gateway_virtual_interface_group_id
      value: '{{ local_gateway_virtual_interface_group_id }}'
    - name: network_interface_id
      value: '{{ network_interface_id }}'

UPDATE example

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

/*+ update */
UPDATE awscc.ec2.local_gateway_routes
SET PatchDocument = string('{{ {
    "LocalGatewayVirtualInterfaceGroupId": local_gateway_virtual_interface_group_id,
    "NetworkInterfaceId": network_interface_id
} | generate_patch_document }}')
WHERE
  region = '{{ region }}' AND
  Identifier = '{{ destination_cidr_block }}|{{ local_gateway_route_table_id }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

DELETE example

/*+ delete */
DELETE FROM awscc.ec2.local_gateway_routes
WHERE
  Identifier = '{{ destination_cidr_block }}|{{ local_gateway_route_table_id }}' AND
  region = '{{ region }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

Additional Parameters

Mutable resources in the Cloud Control provider support additional optional parameters which can be supplied with INSERT, UPDATE, or DELETE operations. These include:

Parameter	Description
ClientToken	A unique identifier to ensure the idempotency of the resource request. This allows the provider to accurately distinguish between retries and new requests. A client token is valid for 36 hours once used. After that, a resource request with the same client token is treated as a new request. If you do not specify a client token, one is generated for inclusion in the request.
RoleArn	The ARN of the IAM role used to perform this resource operation. The role specified must have the permissions required for this operation. If you do not specify a role, a temporary session is created using your AWS user credentials.
TypeVersionId	For private resource types, the type version to use in this resource operation. If you do not specify a resource version, the default version is used.

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