vpn_gateways

Creates, updates, deletes or gets a vpn_gateway resource or lists vpn_gateways in a region

Overview

Name	vpn_gateways
Type	Resource
Description	Specifies 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 [](https://docs.aws.amazon.com/vpn/latest/s2svpn/VPC_VPN.html) in the *User Guide*.
Id	awscc.ec2.vpn_gateways

Fields

get (all properties)

Name	Datatype	Description
v_pn_gateway_id	string
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.

list (identifiers only)

Name	Datatype	Description
v_pn_gateway_id	string
region	string	AWS region.

For more information, see AWS::EC2::VPNGateway.

Methods

Name	Resource	Accessible by	Required Params
create_resource	vpn_gateways	INSERT	Type, region
delete_resource	vpn_gateways	DELETE	Identifier, region
update_resource	vpn_gateways	UPDATE	Identifier, PatchDocument, region
list_resources	vpn_gateways_list_only	SELECT	region
get_resource	vpn_gateways	SELECT	Identifier, region

SELECT examples

get (all properties)

Gets all properties from an individual vpn_gateway.

SELECT
  region,
  v_pn_gateway_id,
  amazon_side_asn,
  tags,
  type
FROM awscc.ec2.vpn_gateways
WHERE
  region = 'us-east-1' AND
  Identifier = '{{ v_pn_gateway_id }}';

list (identifiers only)

Lists all vpn_gateways in a region.

SELECT
  region,
  v_pn_gateway_id
FROM awscc.ec2.vpn_gateways_list_only
WHERE
  region = 'us-east-1';

INSERT example

Use the following StackQL query and manifest file to create a new vpn_gateway resource, using stack-deploy.

Required Properties

/*+ create */
INSERT INTO awscc.ec2.vpn_gateways (
  Type,
  region
)
SELECT
  '{{ type }}',
  '{{ region }}';

All Properties

/*+ create */
INSERT INTO awscc.ec2.vpn_gateways (
  AmazonSideAsn,
  Tags,
  Type,
  region
)
SELECT
  '{{ amazon_side_asn }}',
  '{{ tags }}',
  '{{ type }}',
  '{{ region }}';

Manifest

version: 1
name: stack name
description: stack description
providers:
  - aws
globals:
  - name: region
    value: '{{ vars.AWS_REGION }}'
resources:
  - name: vpn_gateway
    props:
      - name: amazon_side_asn
        value: '{{ amazon_side_asn }}'
      - name: tags
        value:
          - key: '{{ key }}'
            value: '{{ value }}'
      - name: type
        value: '{{ type }}'

UPDATE example

Use the following StackQL query and manifest file to update a vpn_gateway resource, using stack-deploy.

/*+ update */
UPDATE awscc.ec2.vpn_gateways
SET PatchDocument = string('{{ {
    "Tags": tags
} | generate_patch_document }}')
WHERE
  region = '{{ region }}' AND
  Identifier = '{{ v_pn_gateway_id }}';

DELETE example

/*+ delete */
DELETE FROM awscc.ec2.vpn_gateways
WHERE
  Identifier = '{{ v_pn_gateway_id }}' AND
  region = 'us-east-1';

Permissions

To operate on the vpn_gateways resource, the following permissions are required:

Create

ec2:CreateVpnGateway,
ec2:DescribeVpnGateways,
ec2:CreateTags

Read

ec2:DescribeVpnGateways

Update

ec2:DescribeVpnGateways,
ec2:CreateTags,
ec2:DeleteTags

Delete

ec2:DeleteVpnGateway,
ec2:DescribeVpnGateways

List

ec2:DescribeVpnGateways