aws_vpn_gateway.md

April 1, 2019 ยท View on GitHub

Document: "ec2"

Path: "https://github.com/aws/aws-sdk-go-v2/tree/master/models/apis/ec2/2016-11-15/api-2.json")

VpnGateway

aws_vpn_gateway {
  amazon_side_asn => $aws_long
  availability_zone => "availability_zone (optional)",
  dry_run => "DryRun (optional)",
  filters => "Filters (optional)",
  type => $aws_gateway_type
  vpn_gateway_id => "vpn_gateway_id (optional)",
  vpn_gateway_ids => "VpnGatewayIds (optional)",
}
NameTypeRequired
amazon_side_asnLongfalse
availability_zoneStringfalse
dry_runBooleanfalse
filtersFilterListfalse
typeGatewayTypefalse
vpn_gateway_idStringfalse
vpn_gateway_idsVpnGatewayIdStringListfalse

CRUD operations

Here is a list of endpoints that we use to create, read, update and delete the VpnGateway

OperationPathVerbDescriptionOperationID
Create/POST

Creates a virtual private gateway. A virtual private gateway is the endpoint on the VPC side of your VPN connection. You can create a virtual private gateway before creating the VPC itself.

For more information, see AWS Site-to-Site VPN in the AWS Site-to-Site VPN User Guide.

CreateVpnGateway
List - list all/POST

Describes one or more of your virtual private gateways.

For more information, see AWS Site-to-Site VPN in the AWS Site-to-Site VPN User Guide.

DescribeVpnGateways
List - get one``
List - get list using params/POST

Describes one or more of your virtual private gateways.

For more information, see AWS Site-to-Site VPN in the AWS Site-to-Site VPN User Guide.

DescribeVpnGateways
Update``
Delete/POST

Deletes the specified virtual private gateway. We recommend that before you delete a virtual private gateway, you detach it from the VPC and delete the VPN connection. Note that you don't need to delete the virtual private gateway if you plan to delete and recreate the VPN connection between your VPC and your network.

DeleteVpnGateway