vpn_tunnel_replacement_status

Creates, updates, deletes, gets or lists a vpn_tunnel_replacement_status resource.

Overview

Name	vpn_tunnel_replacement_status
Type	Resource
Id	aws.ec2.vpn_tunnel_replacement_status

Fields

The following fields are returned by SELECT queries:

get_vpn_tunnel_replacement_status

Name	Datatype	Description
customer_gateway_id	string	The ID of the customer gateway.
maintenance_details	string	Get details of pending tunnel endpoint maintenance.
transit_gateway_id	string	The ID of the transit gateway associated with the VPN connection.
vpn_connection_id	string	The ID of the Site-to-Site VPN connection.
vpn_gateway_id	string	The ID of the virtual private gateway.
vpn_tunnel_outside_ip_address	string	The external IP address of the VPN tunnel.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_vpn_tunnel_replacement_status	select	VpnConnectionId, VpnTunnelOutsideIpAddress, region	DryRun	Get details of available tunnel endpoint maintenance.

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 Site-to-Site VPN connection.
VpnTunnelOutsideIpAddress	string	The external IP address of the VPN tunnel.
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, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

SELECT examples

get_vpn_tunnel_replacement_status

Get details of available tunnel endpoint maintenance.

SELECT
customer_gateway_id,
maintenance_details,
transit_gateway_id,
vpn_connection_id,
vpn_gateway_id,
vpn_tunnel_outside_ip_address
FROM aws.ec2.vpn_tunnel_replacement_status
WHERE VpnConnectionId = '{{ VpnConnectionId }}' -- required
AND VpnTunnelOutsideIpAddress = '{{ VpnTunnelOutsideIpAddress }}' -- required
AND region = '{{ region }}' -- required
AND DryRun = '{{ DryRun }}'
;