Skip to main content

vpn_connection_tags

Expands all tag keys and values for vpn_connections in a region

Overview

Namevpn_connection_tags
TypeResource
DescriptionSpecifies a VPN connection between a virtual private gateway and a VPN customer gateway or a transit gateway and a VPN customer gateway.
To specify a VPN connection between a transit gateway and customer gateway, use the TransitGatewayId and CustomerGatewayId properties.
To specify a VPN connection between a virtual private gateway and customer gateway, use the VpnGatewayId and CustomerGatewayId properties.
For more information, see [](https://docs.aws.amazon.com/vpn/latest/s2svpn/VPC_VPN.html) in the *User Guide*.
Idaws.ec2.vpn_connection_tags

Fields

NameDatatypeDescription
remote_ipv6_network_cidrstringThe IPv6 CIDR on the AWS side of the VPN connection.
Default: ::/0
remote_ipv4_network_cidrstringThe IPv4 CIDR on the AWS side of the VPN connection.
Default: 0.0.0.0/0
vpn_tunnel_options_specificationsarrayThe tunnel options for the VPN connection.
customer_gateway_idstringThe ID of the customer gateway at your end of the VPN connection.
outside_ip_address_typestringThe type of IPv4 address assigned to the outside interface of the customer gateway device.
Valid values: PrivateIpv4 | PublicIpv4
Default: PublicIpv4
static_routes_onlybooleanIndicates whether the VPN connection uses static routes only. Static routes must be used for devices that don't support BGP.
If you are creating a VPN connection for a device that does not support Border Gateway Protocol (BGP), you must specify true.
enable_accelerationbooleanIndicate whether to enable acceleration for the VPN connection.
Default: false
transit_gateway_idstringThe ID of the transit gateway associated with the VPN connection.
You must specify either TransitGatewayId or VpnGatewayId, but not both.
typestringThe type of VPN connection.
local_ipv4_network_cidrstringThe IPv4 CIDR on the customer gateway (on-premises) side of the VPN connection.
Default: 0.0.0.0/0
vpn_gateway_idstringThe ID of the virtual private gateway at the AWS side of the VPN connection.
You must specify either TransitGatewayId or VpnGatewayId, but not both.
transport_transit_gateway_attachment_idstringThe transit gateway attachment ID to use for the VPN tunnel.
Required if OutsideIpAddressType is set to PrivateIpv4.
local_ipv6_network_cidrstringThe IPv6 CIDR on the customer gateway (on-premises) side of the VPN connection.
Default: ::/0
vpn_connection_idstring
tunnel_inside_ip_versionstringIndicate whether the VPN tunnels process IPv4 or IPv6 traffic.
Default: ipv4
tag_keystringTag key.
tag_valuestringTag value.
regionstringAWS region.

Methods

NameAccessible byRequired Params
list_resourcesSELECTregion

SELECT examples

Expands tags for all vpn_connections in a region.

SELECT
region,
remote_ipv6_network_cidr,
remote_ipv4_network_cidr,
vpn_tunnel_options_specifications,
customer_gateway_id,
outside_ip_address_type,
static_routes_only,
enable_acceleration,
transit_gateway_id,
type,
local_ipv4_network_cidr,
vpn_gateway_id,
transport_transit_gateway_attachment_id,
local_ipv6_network_cidr,
vpn_connection_id,
tunnel_inside_ip_version,
tag_key,
tag_value
FROM aws.ec2.vpn_connection_tags
WHERE region = 'us-east-1';

Permissions

For permissions required to operate on the vpn_connection_tags resource, see vpn_connections