VpnGateway

Provides a resource to create a VPC VPN Gateway.

Example Usage

using Pulumi;
using Aws = Pulumi.Aws;

class MyStack : Stack
{
    public MyStack()
    {
        var vpnGw = new Aws.Ec2.VpnGateway("vpnGw", new Aws.Ec2.VpnGatewayArgs
        {
            VpcId = aws_vpc.Main.Id,
            Tags = 
            {
                { "Name", "main" },
            },
        });
    }

}
package main

import (
	"github.com/pulumi/pulumi-aws/sdk/v4/go/aws/ec2"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := ec2.NewVpnGateway(ctx, "vpnGw", &ec2.VpnGatewayArgs{
			VpcId: pulumi.Any(aws_vpc.Main.Id),
			Tags: pulumi.StringMap{
				"Name": pulumi.String("main"),
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}
import pulumi
import pulumi_aws as aws

vpn_gw = aws.ec2.VpnGateway("vpnGw",
    vpc_id=aws_vpc["main"]["id"],
    tags={
        "Name": "main",
    })
import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";

const vpnGw = new aws.ec2.VpnGateway("vpnGw", {
    vpcId: aws_vpc.main.id,
    tags: {
        Name: "main",
    },
});

Create a VpnGateway Resource

new VpnGateway(name: string, args?: VpnGatewayArgs, opts?: CustomResourceOptions);
@overload
def VpnGateway(resource_name: str,
               opts: Optional[ResourceOptions] = None,
               amazon_side_asn: Optional[str] = None,
               availability_zone: Optional[str] = None,
               tags: Optional[Mapping[str, str]] = None,
               tags_all: Optional[Mapping[str, str]] = None,
               vpc_id: Optional[str] = None)
@overload
def VpnGateway(resource_name: str,
               args: Optional[VpnGatewayArgs] = None,
               opts: Optional[ResourceOptions] = None)
func NewVpnGateway(ctx *Context, name string, args *VpnGatewayArgs, opts ...ResourceOption) (*VpnGateway, error)
public VpnGateway(string name, VpnGatewayArgs? args = null, CustomResourceOptions? opts = null)
name string
The unique name of the resource.
args VpnGatewayArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name str
The unique name of the resource.
args VpnGatewayArgs
The arguments to resource properties.
opts ResourceOptions
Bag of options to control resource's behavior.
ctx Context
Context object for the current deployment.
name string
The unique name of the resource.
args VpnGatewayArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name string
The unique name of the resource.
args VpnGatewayArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.

VpnGateway Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Programming Model docs.

Inputs

The VpnGateway resource accepts the following input properties:

AmazonSideAsn string
The Autonomous System Number (ASN) for the Amazon side of the gateway. If you don’t specify an ASN, the virtual private gateway is created with the default ASN.
AvailabilityZone string
The Availability Zone for the virtual private gateway.
Tags Dictionary<string, string>
A map of tags to assign to the resource. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
TagsAll Dictionary<string, string>
A map of tags assigned to the resource, including those inherited from the provider .
VpcId string
The VPC ID to create in.
AmazonSideAsn string
The Autonomous System Number (ASN) for the Amazon side of the gateway. If you don’t specify an ASN, the virtual private gateway is created with the default ASN.
AvailabilityZone string
The Availability Zone for the virtual private gateway.
Tags map[string]string
A map of tags to assign to the resource. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
TagsAll map[string]string
A map of tags assigned to the resource, including those inherited from the provider .
VpcId string
The VPC ID to create in.
amazonSideAsn string
The Autonomous System Number (ASN) for the Amazon side of the gateway. If you don’t specify an ASN, the virtual private gateway is created with the default ASN.
availabilityZone string
The Availability Zone for the virtual private gateway.
tags {[key: string]: string}
A map of tags to assign to the resource. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
tagsAll {[key: string]: string}
A map of tags assigned to the resource, including those inherited from the provider .
vpcId string
The VPC ID to create in.
amazon_side_asn str
The Autonomous System Number (ASN) for the Amazon side of the gateway. If you don’t specify an ASN, the virtual private gateway is created with the default ASN.
availability_zone str
The Availability Zone for the virtual private gateway.
tags Mapping[str, str]
A map of tags to assign to the resource. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
tags_all Mapping[str, str]
A map of tags assigned to the resource, including those inherited from the provider .
vpc_id str
The VPC ID to create in.

Outputs

All input properties are implicitly available as output properties. Additionally, the VpnGateway resource produces the following output properties:

Arn string
Amazon Resource Name (ARN) of the VPN Gateway.
Id string
The provider-assigned unique ID for this managed resource.
Arn string
Amazon Resource Name (ARN) of the VPN Gateway.
Id string
The provider-assigned unique ID for this managed resource.
arn string
Amazon Resource Name (ARN) of the VPN Gateway.
id string
The provider-assigned unique ID for this managed resource.
arn str
Amazon Resource Name (ARN) of the VPN Gateway.
id str
The provider-assigned unique ID for this managed resource.

Look up an Existing VpnGateway Resource

Get an existing VpnGateway resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

public static get(name: string, id: Input<ID>, state?: VpnGatewayState, opts?: CustomResourceOptions): VpnGateway
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        amazon_side_asn: Optional[str] = None,
        arn: Optional[str] = None,
        availability_zone: Optional[str] = None,
        tags: Optional[Mapping[str, str]] = None,
        tags_all: Optional[Mapping[str, str]] = None,
        vpc_id: Optional[str] = None) -> VpnGateway
func GetVpnGateway(ctx *Context, name string, id IDInput, state *VpnGatewayState, opts ...ResourceOption) (*VpnGateway, error)
public static VpnGateway Get(string name, Input<string> id, VpnGatewayState? state, CustomResourceOptions? opts = null)
name
The unique name of the resulting resource.
id
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
resource_name
The unique name of the resulting resource.
id
The unique provider ID of the resource to lookup.
name
The unique name of the resulting resource.
id
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
name
The unique name of the resulting resource.
id
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.

The following state arguments are supported:

AmazonSideAsn string
The Autonomous System Number (ASN) for the Amazon side of the gateway. If you don’t specify an ASN, the virtual private gateway is created with the default ASN.
Arn string
Amazon Resource Name (ARN) of the VPN Gateway.
AvailabilityZone string
The Availability Zone for the virtual private gateway.
Tags Dictionary<string, string>
A map of tags to assign to the resource. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
TagsAll Dictionary<string, string>
A map of tags assigned to the resource, including those inherited from the provider .
VpcId string
The VPC ID to create in.
AmazonSideAsn string
The Autonomous System Number (ASN) for the Amazon side of the gateway. If you don’t specify an ASN, the virtual private gateway is created with the default ASN.
Arn string
Amazon Resource Name (ARN) of the VPN Gateway.
AvailabilityZone string
The Availability Zone for the virtual private gateway.
Tags map[string]string
A map of tags to assign to the resource. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
TagsAll map[string]string
A map of tags assigned to the resource, including those inherited from the provider .
VpcId string
The VPC ID to create in.
amazonSideAsn string
The Autonomous System Number (ASN) for the Amazon side of the gateway. If you don’t specify an ASN, the virtual private gateway is created with the default ASN.
arn string
Amazon Resource Name (ARN) of the VPN Gateway.
availabilityZone string
The Availability Zone for the virtual private gateway.
tags {[key: string]: string}
A map of tags to assign to the resource. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
tagsAll {[key: string]: string}
A map of tags assigned to the resource, including those inherited from the provider .
vpcId string
The VPC ID to create in.
amazon_side_asn str
The Autonomous System Number (ASN) for the Amazon side of the gateway. If you don’t specify an ASN, the virtual private gateway is created with the default ASN.
arn str
Amazon Resource Name (ARN) of the VPN Gateway.
availability_zone str
The Availability Zone for the virtual private gateway.
tags Mapping[str, str]
A map of tags to assign to the resource. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
tags_all Mapping[str, str]
A map of tags assigned to the resource, including those inherited from the provider .
vpc_id str
The VPC ID to create in.

Import

VPN Gateways can be imported using the vpn gateway id, e.g.

 $ pulumi import aws:ec2/vpnGateway:VpnGateway testvpngateway vgw-9a4cacf3

Package Details

Repository
https://github.com/pulumi/pulumi-aws
License
Apache-2.0
Notes
This Pulumi package is based on the aws Terraform Provider.