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 in the User Guide.
Id	awscc.ec2.vpn_connection_routes

Fields

get (all properties)

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.

list (identifiers only)

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	Resource	Accessible by	Required Params
create_resource	vpn_connection_routes	INSERT	DestinationCidrBlock, VpnConnectionId, region
delete_resource	vpn_connection_routes	DELETE	Identifier, region
list_resources	vpn_connection_routes_list_only	SELECT	region
get_resource	vpn_connection_routes	SELECT	Identifier, region

SELECT examples

get (all properties)

Gets all properties from an individual vpn_connection_route.

SELECT
  region,
  destination_cidr_block,
  vpn_connection_id
FROM awscc.ec2.vpn_connection_routes
WHERE
  region = '{{ region }}' AND
  Identifier = '{{ destination_cidr_block }}|{{ vpn_connection_id }}';

list (identifiers only)

Lists all vpn_connection_routes in a region.

SELECT
  region,
  destination_cidr_block,
  vpn_connection_id
FROM awscc.ec2.vpn_connection_routes_list_only
WHERE
  region = '{{ region }}';

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 awscc.ec2.vpn_connection_routes (
  DestinationCidrBlock,
  VpnConnectionId,
  region
)
SELECT
  '{{ destination_cidr_block }}',
  '{{ vpn_connection_id }}',
  '{{ region }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

All Properties

/*+ create */
INSERT INTO awscc.ec2.vpn_connection_routes (
  DestinationCidrBlock,
  VpnConnectionId,
  region
)
SELECT
  '{{ destination_cidr_block }}',
  '{{ vpn_connection_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: vpn_connection_route
  props:
    - name: destination_cidr_block
      value: '{{ destination_cidr_block }}'
    - name: vpn_connection_id
      value: '{{ vpn_connection_id }}'

DELETE example

/*+ delete */
DELETE FROM awscc.ec2.vpn_connection_routes
WHERE
  Identifier = '{{ destination_cidr_block }}|{{ vpn_connection_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 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