Docs
PackagesTry AWS Native preview for resources not in the classic version.
aws.ec2.VpnGateway
Explore with Pulumi AI
Try AWS Native preview for resources not in the classic version.
Provides a resource to create a VPC VPN Gateway.
Example Usage
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;
return await Deployment.RunAsync(() =>
{
var vpnGw = new Aws.Ec2.VpnGateway("vpnGw", new()
{
VpcId = aws_vpc.Main.Id,
Tags =
{
{ "Name", "main" },
},
});
});
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, "vpnGw", &ec2.VpnGatewayArgs{
VpcId: pulumi.Any(aws_vpc.Main.Id),
Tags: pulumi.StringMap{
"Name": pulumi.String("main"),
},
})
if err != nil {
return err
}
return nil
})
}
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(aws_vpc.main().id())
.tags(Map.of("Name", "main"))
.build());
}
}
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",
},
});
resources:
vpnGw:
type: aws:ec2:VpnGateway
properties:
vpcId: ${aws_vpc.main.id}
tags:
Name: main
Create 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,
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)
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.
- 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.
- name String
- The unique name of the resource.
- args VpnGatewayArgs
- The arguments to resource properties.
- options 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 Architecture and Concepts docs.
Inputs
The VpnGateway resource accepts the following input properties:
- Amazon
Side stringAsn 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 string The Availability Zone for the virtual private gateway.
- Dictionary<string, string>
A map of tags to assign to the resource. .If configured with a provider
default_tagsconfiguration block present, tags with matching keys will overwrite those defined at the provider-level.- Vpc
Id string The VPC ID to create in.
- Amazon
Side stringAsn 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 string The Availability Zone for the virtual private gateway.
- map[string]string
A map of tags to assign to the resource. .If configured with a provider
default_tagsconfiguration block present, tags with matching keys will overwrite those defined at the provider-level.- Vpc
Id string The VPC ID to create in.
- amazon
Side StringAsn 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 String The Availability Zone for the virtual private gateway.
- Map<String,String>
A map of tags to assign to the resource. .If configured with a provider
default_tagsconfiguration block present, tags with matching keys will overwrite those defined at the provider-level.- vpc
Id String The VPC ID to create in.
- amazon
Side stringAsn 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 string The Availability Zone for the virtual private gateway.
- {[key: string]: string}
A map of tags to assign to the resource. .If configured with a provider
default_tagsconfiguration block present, tags with matching keys will overwrite those defined at the provider-level.- vpc
Id string The VPC ID to create in.
- amazon_
side_ strasn 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.
- Mapping[str, str]
A map of tags to assign to the resource. .If configured with a provider
default_tagsconfiguration block present, tags with matching keys will overwrite those defined at the provider-level.- vpc_
id str The VPC ID to create in.
- amazon
Side StringAsn 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 String The Availability Zone for the virtual private gateway.
- Map<String>
A map of tags to assign to the resource. .If configured with a provider
default_tagsconfiguration block present, tags with matching keys will overwrite those defined at the provider-level.- vpc
Id 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:
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) -> VpnGatewayfunc 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)Resource lookup is not supported in YAML- 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.
- 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.
- Amazon
Side stringAsn 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.
- Availability
Zone string The Availability Zone for the virtual private gateway.
- Dictionary<string, string>
A map of tags to assign to the resource. .If configured with a provider
default_tagsconfiguration block present, tags with matching keys will overwrite those defined at the provider-level.- Dictionary<string, string>
A map of tags assigned to the resource, including those inherited from the provider
default_tagsconfiguration block.Please use
tagsinstead.- Vpc
Id string The VPC ID to create in.
- Amazon
Side stringAsn 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.
- Availability
Zone string The Availability Zone for the virtual private gateway.
- map[string]string
A map of tags to assign to the resource. .If configured with a provider
default_tagsconfiguration block present, tags with matching keys will overwrite those defined at the provider-level.- map[string]string
A map of tags assigned to the resource, including those inherited from the provider
default_tagsconfiguration block.Please use
tagsinstead.- Vpc
Id string The VPC ID to create in.
- amazon
Side StringAsn 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.
- availability
Zone String The Availability Zone for the virtual private gateway.
- Map<String,String>
A map of tags to assign to the resource. .If configured with a provider
default_tagsconfiguration block present, tags with matching keys will overwrite those defined at the provider-level.- Map<String,String>
A map of tags assigned to the resource, including those inherited from the provider
default_tagsconfiguration block.Please use
tagsinstead.- vpc
Id String The VPC ID to create in.
- amazon
Side stringAsn 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.
- availability
Zone string The Availability Zone for the virtual private gateway.
- {[key: string]: string}
A map of tags to assign to the resource. .If configured with a provider
default_tagsconfiguration block present, tags with matching keys will overwrite those defined at the provider-level.- {[key: string]: string}
A map of tags assigned to the resource, including those inherited from the provider
default_tagsconfiguration block.Please use
tagsinstead.- vpc
Id string The VPC ID to create in.
- amazon_
side_ strasn 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.
- Mapping[str, str]
A map of tags to assign to the resource. .If configured with a provider
default_tagsconfiguration block present, tags with matching keys will overwrite those defined at the provider-level.- Mapping[str, str]
A map of tags assigned to the resource, including those inherited from the provider
default_tagsconfiguration block.Please use
tagsinstead.- vpc_
id str The VPC ID to create in.
- amazon
Side StringAsn 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.
- availability
Zone String The Availability Zone for the virtual private gateway.
- Map<String>
A map of tags to assign to the resource. .If configured with a provider
default_tagsconfiguration block present, tags with matching keys will overwrite those defined at the provider-level.- Map<String>
A map of tags assigned to the resource, including those inherited from the provider
default_tagsconfiguration block.Please use
tagsinstead.- vpc
Id 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
Package Details
- Repository
- AWS Classic pulumi/pulumi-aws
- License
- Apache-2.0
- Notes
This Pulumi package is based on the
awsTerraform Provider.
Try AWS Native preview for resources not in the classic version.