active_vpn_tunnel_status

Creates, updates, deletes, gets or lists an active_vpn_tunnel_status resource.

Overview

Name	active_vpn_tunnel_status
Type	Resource
Id	aws.ec2.active_vpn_tunnel_status

Fields

The following fields are returned by SELECT queries:

get_active_vpn_tunnel_status

Name	Datatype	Description
ike_version	string	The version of the Internet Key Exchange (IKE) protocol being used.
phase_1_dh_group	integer	The Diffie-Hellman group number being used in Phase 1 IKE negotiations.
phase_1_encryption_algorithm	string	The encryption algorithm negotiated in Phase 1 IKE negotiations.
phase_1_integrity_algorithm	string	The integrity algorithm negotiated in Phase 1 IKE negotiations.
phase_2_dh_group	integer	The Diffie-Hellman group number being used in Phase 2 IKE negotiations.
phase_2_encryption_algorithm	string	The encryption algorithm negotiated in Phase 2 IKE negotiations.
phase_2_integrity_algorithm	string	The integrity algorithm negotiated in Phase 2 IKE negotiations.
provisioning_status	string	The current provisioning status of the VPN tunnel.
provisioning_status_reason	string	The reason for the current provisioning status.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_active_vpn_tunnel_status	select	VpnConnectionId, VpnTunnelOutsideIpAddress, region	DryRun	Returns the currently negotiated security parameters for an active VPN tunnel, including IKE version, DH groups, encryption algorithms, and integrity algorithms.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
VpnConnectionId	string	The ID of the VPN connection for which to retrieve the active tunnel status.
VpnTunnelOutsideIpAddress	string	The external IP address of the VPN tunnel for which to retrieve the active status.
region	string	AWS region (default: us-east-1)
DryRun	boolean	Checks whether you have the required permissions for the action, without actually making the request.

SELECT examples

get_active_vpn_tunnel_status

Returns the currently negotiated security parameters for an active VPN tunnel, including IKE version, DH groups, encryption algorithms, and integrity algorithms.

SELECT
ike_version,
phase_1_dh_group,
phase_1_encryption_algorithm,
phase_1_integrity_algorithm,
phase_2_dh_group,
phase_2_encryption_algorithm,
phase_2_integrity_algorithm,
provisioning_status,
provisioning_status_reason
FROM aws.ec2.active_vpn_tunnel_status
WHERE VpnConnectionId = '{{ VpnConnectionId }}' -- required
AND VpnTunnelOutsideIpAddress = '{{ VpnTunnelOutsideIpAddress }}' -- required
AND region = '{{ region }}' -- required
AND DryRun = '{{ DryRun }}'
;