vpn_gateway
Gets or updates an individual vpn_gateway resource, use vpn_gateways to retrieve a list of resources or to create or delete a resource.
Overview
| Name | vpn_gateway |
| Type | Resource |
| Description | Schema for EC2 VPN Gateway |
| Id | aws.ec2.vpn_gateway |
Fields
| Name | Datatype | Description |
|---|---|---|
v_pn_gateway_id | string | VPN Gateway ID generated by service |
amazon_side_asn | integer | The private Autonomous System Number (ASN) for the Amazon side of a BGP session. |
tags | array | Any tags assigned to the virtual private gateway. |
type | string | The type of VPN connection the virtual private gateway supports. |
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,
v_pn_gateway_id,
amazon_side_asn,
tags,
type
FROM aws.ec2.vpn_gateway
WHERE region = 'us-east-1' AND data__Identifier = '<VPNGatewayId>';
Permissions
To operate on the vpn_gateway resource, the following permissions are required:
Read
ec2:DescribeVpnGateways
Update
ec2:CreateTags,
ec2:DeleteTags