vpn_connection_routes

Creates, updates, deletes or gets a vpn_connection_route resource or lists vpn_connection_routes in a region

Overview

Name	vpn_connection_routes
Type	Resource
Description	Specifies a static route for a VPN connection between an existing virtual private gateway and a VPN customer gateway. The static route allows traffic to be routed from the virtual private gateway to the VPN customer gateway. For more information, see [](https://docs.aws.amazon.com/vpn/latest/s2svpn/VPC_VPN.html) in the User Guide.
Id	aws.ec2.vpn_connection_routes

Fields

Name	Datatype	Description
destination_cidr_block	string	The CIDR block associated with the local subnet of the customer network.
vpn_connection_id	string	The ID of the VPN connection.
region	string	AWS region.

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

Methods

Name	Accessible by	Required Params
create_resource	INSERT	DestinationCidrBlock, VpnConnectionId, region
delete_resource	DELETE	data__Identifier, region
list_resources	SELECT	region
get_resource	SELECT	data__Identifier, region

SELECT examples

Gets all vpn_connection_routes in a region.

SELECT
region,
destination_cidr_block,
vpn_connection_id
FROM aws.ec2.vpn_connection_routes
WHERE region = 'us-east-1';

Gets all properties from an individual vpn_connection_route.

SELECT
region,
destination_cidr_block,
vpn_connection_id
FROM aws.ec2.vpn_connection_routes
WHERE region = 'us-east-1' AND data__Identifier = '<DestinationCidrBlock>|<VpnConnectionId>';

INSERT example

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

Required Properties

/*+ create */
INSERT INTO aws.ec2.vpn_connection_routes (
 DestinationCidrBlock,
 VpnConnectionId,
 region
)
SELECT 
'{{ DestinationCidrBlock }}',
 '{{ VpnConnectionId }}',
'{{ region }}';

All Properties

/*+ create */
INSERT INTO aws.ec2.vpn_connection_routes (
 DestinationCidrBlock,
 VpnConnectionId,
 region
)
SELECT 
 '{{ DestinationCidrBlock }}',
 '{{ VpnConnectionId }}',
 '{{ region }}';

Manifest

version: 1
name: stack name
description: stack description
providers:
  - aws
globals:
  - name: region
    value: '{{ vars.AWS_REGION }}'
resources:
  - name: vpn_connection_route
    props:
      - name: DestinationCidrBlock
        value: '{{ DestinationCidrBlock }}'
      - name: VpnConnectionId
        value: '{{ VpnConnectionId }}'

DELETE example

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

Permissions

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

Read

ec2:DescribeVpnConnections

Create

ec2:CreateVpnConnectionRoute,
ec2:DescribeVpnConnections

List

ec2:DescribeVpnConnections

Delete

ec2:DeleteVpnConnectionRoute,
ec2:DescribeVpnConnections