Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. AWS
  3. API Docs
  4. ec2
  5. VpnGateway
AWS v6.77.0 published on Wednesday, Apr 9, 2025 by Pulumi
pulumi/pulumi-aws

aws.ec2.VpnGateway

Explore with Pulumi AI

AWS v6.77.0 published on Wednesday, Apr 9, 2025 by Pulumi
pulumi/pulumi-aws

Provides a resource to create a VPC VPN Gateway.

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";

const vpnGw = new aws.ec2.VpnGateway("vpn_gw", {
    vpcId: main.id,
    tags: {
        Name: "main",
    },
});
Copy
import pulumi
import pulumi_aws as aws

vpn_gw = aws.ec2.VpnGateway("vpn_gw",
    vpc_id=main["id"],
    tags={
        "Name": "main",
    })
Copy
package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := ec2.NewVpnGateway(ctx, "vpn_gw", &ec2.VpnGatewayArgs{
			VpcId: pulumi.Any(main.Id),
			Tags: pulumi.StringMap{
				"Name": pulumi.String("main"),
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;

return await Deployment.RunAsync(() => 
{
    var vpnGw = new Aws.Ec2.VpnGateway("vpn_gw", new()
    {
        VpcId = main.Id,
        Tags = 
        {
            { "Name", "main" },
        },
    });

});
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.ec2.VpnGateway;
import com.pulumi.aws.ec2.VpnGatewayArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        var vpnGw = new VpnGateway("vpnGw", VpnGatewayArgs.builder()
            .vpcId(main.id())
            .tags(Map.of("Name", "main"))
            .build());

    }
}
Copy
resources:
  vpnGw:
    type: aws:ec2:VpnGateway
    name: vpn_gw
    properties:
      vpcId: ${main.id}
      tags:
        Name: main
Copy

Create VpnGateway Resource

Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

Constructor syntax

new VpnGateway(name: string, args?: VpnGatewayArgs, opts?: CustomResourceOptions);
@overload
def VpnGateway(resource_name: str,
               args: Optional[VpnGatewayArgs] = None,
               opts: Optional[ResourceOptions] = None)

@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,
               vpc_id: Optional[str] = None)
func NewVpnGateway(ctx *Context, name string, args *VpnGatewayArgs, opts ...ResourceOption) (*VpnGateway, error)
public VpnGateway(string name, VpnGatewayArgs? args = null, CustomResourceOptions? opts = null)
public VpnGateway(String name, VpnGatewayArgs args)
public VpnGateway(String name, VpnGatewayArgs args, CustomResourceOptions options)

type: aws:ec2:VpnGateway
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

name This property is required. 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 This property is required. 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 This property is required. 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 This property is required. string
The unique name of the resource.
args VpnGatewayArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name This property is required. String
The unique name of the resource.
args This property is required. VpnGatewayArgs
The arguments to resource properties.
options CustomResourceOptions
Bag of options to control resource's behavior.

Constructor example

The following reference example uses placeholder values for all input properties.

var vpnGatewayResource = new Aws.Ec2.VpnGateway("vpnGatewayResource", new()
{
    AmazonSideAsn = "string",
    AvailabilityZone = "string",
    Tags = 
    {
        { "string", "string" },
    },
    VpcId = "string",
});
Copy
example, err := ec2.NewVpnGateway(ctx, "vpnGatewayResource", &ec2.VpnGatewayArgs{
	AmazonSideAsn:    pulumi.String("string"),
	AvailabilityZone: pulumi.String("string"),
	Tags: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
	VpcId: pulumi.String("string"),
})
Copy
var vpnGatewayResource = new VpnGateway("vpnGatewayResource", VpnGatewayArgs.builder()
    .amazonSideAsn("string")
    .availabilityZone("string")
    .tags(Map.of("string", "string"))
    .vpcId("string")
    .build());
Copy
vpn_gateway_resource = aws.ec2.VpnGateway("vpnGatewayResource",
    amazon_side_asn="string",
    availability_zone="string",
    tags={
        "string": "string",
    },
    vpc_id="string")
Copy
const vpnGatewayResource = new aws.ec2.VpnGateway("vpnGatewayResource", {
    amazonSideAsn: "string",
    availabilityZone: "string",
    tags: {
        string: "string",
    },
    vpcId: "string",
});
Copy
type: aws:ec2:VpnGateway
properties:
    amazonSideAsn: string
    availabilityZone: string
    tags:
        string: string
    vpcId: string
Copy

VpnGateway Resource Properties

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

Inputs

In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

The VpnGateway resource accepts the following input properties:

AmazonSideAsn Changes to this property will trigger replacement. 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 Changes to this property will trigger replacement. 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.
VpcId string
The VPC ID to create in.
AmazonSideAsn Changes to this property will trigger replacement. 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 Changes to this property will trigger replacement. 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.
VpcId string
The VPC ID to create in.
amazonSideAsn Changes to this property will trigger replacement. 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 Changes to this property will trigger replacement. 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.
vpcId String
The VPC ID to create in.
amazonSideAsn Changes to this property will trigger replacement. 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 Changes to this property will trigger replacement. 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.
vpcId string
The VPC ID to create in.
amazon_side_asn Changes to this property will trigger replacement. 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 Changes to this property will trigger replacement. 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.
vpc_id str
The VPC ID to create in.
amazonSideAsn Changes to this property will trigger replacement. 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 Changes to this property will trigger replacement. String
The Availability Zone for the virtual private gateway.
tags Map<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.
vpcId String
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.
TagsAll Dictionary<string, string>
A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

Deprecated: Please use tags instead.

Arn string
Amazon Resource Name (ARN) of the VPN Gateway.
Id string
The provider-assigned unique ID for this managed resource.
TagsAll map[string]string
A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

Deprecated: Please use tags instead.

arn String
Amazon Resource Name (ARN) of the VPN Gateway.
id String
The provider-assigned unique ID for this managed resource.
tagsAll Map<String,String>
A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

Deprecated: Please use tags instead.

arn string
Amazon Resource Name (ARN) of the VPN Gateway.
id string
The provider-assigned unique ID for this managed resource.
tagsAll {[key: string]: string}
A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

Deprecated: Please use tags instead.

arn str
Amazon Resource Name (ARN) of the VPN Gateway.
id str
The provider-assigned unique ID for this managed resource.
tags_all Mapping[str, str]
A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

Deprecated: Please use tags instead.

arn String
Amazon Resource Name (ARN) of the VPN Gateway.
id String
The provider-assigned unique ID for this managed resource.
tagsAll Map<String>
A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

Deprecated: Please use tags instead.

Look up 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)
public static VpnGateway get(String name, Output<String> id, VpnGatewayState state, CustomResourceOptions options)
resources:  _:    type: aws:ec2:VpnGateway    get:      id: ${id}
name This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
name This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
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 Changes to this property will trigger replacement. 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 Changes to this property will trigger replacement. 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 default_tags configuration block.

Deprecated: Please use tags instead.

VpcId string
The VPC ID to create in.
AmazonSideAsn Changes to this property will trigger replacement. 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 Changes to this property will trigger replacement. 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 default_tags configuration block.

Deprecated: Please use tags instead.

VpcId string
The VPC ID to create in.
amazonSideAsn Changes to this property will trigger replacement. 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 Changes to this property will trigger replacement. 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 default_tags configuration block.

Deprecated: Please use tags instead.

vpcId String
The VPC ID to create in.
amazonSideAsn Changes to this property will trigger replacement. 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 Changes to this property will trigger replacement. 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 default_tags configuration block.

Deprecated: Please use tags instead.

vpcId string
The VPC ID to create in.
amazon_side_asn Changes to this property will trigger replacement. 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 Changes to this property will trigger replacement. 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 default_tags configuration block.

Deprecated: Please use tags instead.

vpc_id str
The VPC ID to create in.
amazonSideAsn Changes to this property will trigger replacement. 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 Changes to this property will trigger replacement. String
The Availability Zone for the virtual private gateway.
tags Map<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>
A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

Deprecated: Please use tags instead.

vpcId String
The VPC ID to create in.

Import

Using pulumi import, import VPN Gateways using the VPN gateway id. For example:

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

To learn more about importing existing cloud resources, see Importing resources.

Package Details

Repository
AWS Classic pulumi/pulumi-aws
License
Apache-2.0
Notes
This Pulumi package is based on the aws Terraform Provider.
AWS v6.77.0 published on Wednesday, Apr 9, 2025 by Pulumi
pulumi/pulumi-aws