vpn_connection

Gets or updates an individual vpn_connection resource, use vpn_connections to retrieve a list of resources or to create or delete a resource.

Overview

Name	vpn_connection
Type	Resource
Description	Resource Type definition for AWS::EC2::VPNConnection
Id	aws.ec2.vpn_connection

Fields

Name	Datatype	Description
vpn_connection_id	string	The provider-assigned unique ID for this managed resource
customer_gateway_id	string	The ID of the customer gateway at your end of the VPN connection.
static_routes_only	boolean	Indicates whether the VPN connection uses static routes only.
tags	array	Any tags assigned to the VPN connection.
transit_gateway_id	string	The ID of the transit gateway associated with the VPN connection.
type	string	The type of VPN connection.
vpn_gateway_id	string	The ID of the virtual private gateway at the AWS side of the VPN connection.
vpn_tunnel_options_specifications	array	The tunnel options for the VPN connection.
region	string	AWS region.

Methods

Name	Accessible by	Required Params
update_resource	UPDATE	data__Identifier, data__PatchDocument, region
get_resource	SELECT	data__Identifier, region

SELECT Example

SELECT
region,
vpn_connection_id,
customer_gateway_id,
static_routes_only,
tags,
transit_gateway_id,
type,
vpn_gateway_id,
vpn_tunnel_options_specifications
FROM aws.ec2.vpn_connection
WHERE region = 'us-east-1' AND data__Identifier = '<VpnConnectionId>';

Permissions

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

Update

ec2:DescribeVpnConnections,
ec2:CreateTags,
ec2:DeleteTags

Read

ec2:DescribeVpnConnections