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
        {
            Tags = 
            {
                { "Name", "main" },
            },
            VpcId = aws_vpc.Main.Id,
        });
    }

}

package main

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

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

import pulumi
import pulumi_aws as aws

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

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

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

Create a VpnGateway Resource

new VpnGateway(name: string, args?: VpnGatewayArgs, opts?: CustomResourceOptions);

def VpnGateway(resource_name, opts=None, amazon_side_asn=None, availability_zone=None, tags=None, vpc_id=None, __props__=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.
opts ResourceOptions: A bag of options that control this 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.
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.
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.
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 Dict[str, str]: A map of tags to assign to the resource.
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

static get(resource_name, id, opts=None, amazon_side_asn=None, arn=None, availability_zone=None, tags=None, vpc_id=None, __props__=None);

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.
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.
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.
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 Dict[str, str]: A map of tags to assign to the resource.
vpc_id str: The VPC ID to create in.

Package Details

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

The Pulumi Platform

Get Started

Migrate to Pulumi

Solutions for All Teams and Engineers

Any Code

Any Cloud