Provides a resource to create a VPN Concentrator that aggregates multiple VPN connections to a transit gateway.
Example Usage
import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";
const example = new aws.ec2transitgateway.TransitGateway("example", {
description: "example",
tags: {
Name: "example",
},
});
const exampleVpnConcentrator = new aws.ec2.VpnConcentrator("example", {
type: "ipsec.1",
transitGatewayId: example.id,
tags: {
Name: "example",
},
});
import pulumi
import pulumi_aws as aws
example = aws.ec2transitgateway.TransitGateway("example",
description="example",
tags={
"Name": "example",
})
example_vpn_concentrator = aws.ec2.VpnConcentrator("example",
type="ipsec.1",
transit_gateway_id=example.id,
tags={
"Name": "example",
})
package main
import (
"github.com/pulumi/pulumi-aws/sdk/v7/go/aws/ec2"
"github.com/pulumi/pulumi-aws/sdk/v7/go/aws/ec2transitgateway"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
example, err := ec2transitgateway.NewTransitGateway(ctx, "example", &ec2transitgateway.TransitGatewayArgs{
Description: pulumi.String("example"),
Tags: pulumi.StringMap{
"Name": pulumi.String("example"),
},
})
if err != nil {
return err
}
_, err = ec2.NewVpnConcentrator(ctx, "example", &ec2.VpnConcentratorArgs{
Type: pulumi.String("ipsec.1"),
TransitGatewayId: example.ID(),
Tags: pulumi.StringMap{
"Name": pulumi.String("example"),
},
})
if err != nil {
return err
}
return nil
})
}
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;
return await Deployment.RunAsync(() =>
{
var example = new Aws.Ec2TransitGateway.TransitGateway("example", new()
{
Description = "example",
Tags =
{
{ "Name", "example" },
},
});
var exampleVpnConcentrator = new Aws.Ec2.VpnConcentrator("example", new()
{
Type = "ipsec.1",
TransitGatewayId = example.Id,
Tags =
{
{ "Name", "example" },
},
});
});
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.ec2transitgateway.TransitGateway;
import com.pulumi.aws.ec2transitgateway.TransitGatewayArgs;
import com.pulumi.aws.ec2.VpnConcentrator;
import com.pulumi.aws.ec2.VpnConcentratorArgs;
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 example = new TransitGateway("example", TransitGatewayArgs.builder()
.description("example")
.tags(Map.of("Name", "example"))
.build());
var exampleVpnConcentrator = new VpnConcentrator("exampleVpnConcentrator", VpnConcentratorArgs.builder()
.type("ipsec.1")
.transitGatewayId(example.id())
.tags(Map.of("Name", "example"))
.build());
}
}
resources:
example:
type: aws:ec2transitgateway:TransitGateway
properties:
description: example
tags:
Name: example
exampleVpnConcentrator:
type: aws:ec2:VpnConcentrator
name: example
properties:
type: ipsec.1
transitGatewayId: ${example.id}
tags:
Name: example
Create VpnConcentrator Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new VpnConcentrator(name: string, args: VpnConcentratorArgs, opts?: CustomResourceOptions);@overload
def VpnConcentrator(resource_name: str,
args: VpnConcentratorArgs,
opts: Optional[ResourceOptions] = None)
@overload
def VpnConcentrator(resource_name: str,
opts: Optional[ResourceOptions] = None,
transit_gateway_id: Optional[str] = None,
type: Optional[str] = None,
region: Optional[str] = None,
tags: Optional[Mapping[str, str]] = None)func NewVpnConcentrator(ctx *Context, name string, args VpnConcentratorArgs, opts ...ResourceOption) (*VpnConcentrator, error)public VpnConcentrator(string name, VpnConcentratorArgs args, CustomResourceOptions? opts = null)
public VpnConcentrator(String name, VpnConcentratorArgs args)
public VpnConcentrator(String name, VpnConcentratorArgs args, CustomResourceOptions options)
type: aws:ec2:VpnConcentrator
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
Parameters
- name string
- The unique name of the resource.
- args VpnConcentratorArgs
- 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 VpnConcentratorArgs
- 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 VpnConcentratorArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args VpnConcentratorArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args VpnConcentratorArgs
- 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 vpnConcentratorResource = new Aws.Ec2.VpnConcentrator("vpnConcentratorResource", new()
{
TransitGatewayId = "string",
Type = "string",
Region = "string",
Tags =
{
{ "string", "string" },
},
});
example, err := ec2.NewVpnConcentrator(ctx, "vpnConcentratorResource", &ec2.VpnConcentratorArgs{
TransitGatewayId: pulumi.String("string"),
Type: pulumi.String("string"),
Region: pulumi.String("string"),
Tags: pulumi.StringMap{
"string": pulumi.String("string"),
},
})
var vpnConcentratorResource = new VpnConcentrator("vpnConcentratorResource", VpnConcentratorArgs.builder()
.transitGatewayId("string")
.type("string")
.region("string")
.tags(Map.of("string", "string"))
.build());
vpn_concentrator_resource = aws.ec2.VpnConcentrator("vpnConcentratorResource",
transit_gateway_id="string",
type="string",
region="string",
tags={
"string": "string",
})
const vpnConcentratorResource = new aws.ec2.VpnConcentrator("vpnConcentratorResource", {
transitGatewayId: "string",
type: "string",
region: "string",
tags: {
string: "string",
},
});
type: aws:ec2:VpnConcentrator
properties:
region: string
tags:
string: string
transitGatewayId: string
type: string
VpnConcentrator 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 VpnConcentrator resource accepts the following input properties:
- Transit
Gateway stringId ID of the transit gateway to attach the VPN concentrator to.
The following arguments are optional:
- Type string
- Type of VPN concentrator. Valid value:
ipsec.1. - Region string
- Region where this resource will be managed. Defaults to the Region set in the provider configuration.
- Dictionary<string, string>
- Key-value mapping of resource tags. If configured with a provider
default_tagsconfiguration block present, tags with matching keys will overwrite those defined at the provider-level.
- Transit
Gateway stringId ID of the transit gateway to attach the VPN concentrator to.
The following arguments are optional:
- Type string
- Type of VPN concentrator. Valid value:
ipsec.1. - Region string
- Region where this resource will be managed. Defaults to the Region set in the provider configuration.
- map[string]string
- Key-value mapping of resource tags. If configured with a provider
default_tagsconfiguration block present, tags with matching keys will overwrite those defined at the provider-level.
- transit
Gateway StringId ID of the transit gateway to attach the VPN concentrator to.
The following arguments are optional:
- type String
- Type of VPN concentrator. Valid value:
ipsec.1. - region String
- Region where this resource will be managed. Defaults to the Region set in the provider configuration.
- Map<String,String>
- Key-value mapping of resource tags. If configured with a provider
default_tagsconfiguration block present, tags with matching keys will overwrite those defined at the provider-level.
- transit
Gateway stringId ID of the transit gateway to attach the VPN concentrator to.
The following arguments are optional:
- type string
- Type of VPN concentrator. Valid value:
ipsec.1. - region string
- Region where this resource will be managed. Defaults to the Region set in the provider configuration.
- {[key: string]: string}
- Key-value mapping of resource tags. If configured with a provider
default_tagsconfiguration block present, tags with matching keys will overwrite those defined at the provider-level.
- transit_
gateway_ strid ID of the transit gateway to attach the VPN concentrator to.
The following arguments are optional:
- type str
- Type of VPN concentrator. Valid value:
ipsec.1. - region str
- Region where this resource will be managed. Defaults to the Region set in the provider configuration.
- Mapping[str, str]
- Key-value mapping of resource tags. If configured with a provider
default_tagsconfiguration block present, tags with matching keys will overwrite those defined at the provider-level.
- transit
Gateway StringId ID of the transit gateway to attach the VPN concentrator to.
The following arguments are optional:
- type String
- Type of VPN concentrator. Valid value:
ipsec.1. - region String
- Region where this resource will be managed. Defaults to the Region set in the provider configuration.
- Map<String>
- Key-value mapping of resource tags. If configured with a provider
default_tagsconfiguration block present, tags with matching keys will overwrite those defined at the provider-level.
Outputs
All input properties are implicitly available as output properties. Additionally, the VpnConcentrator resource produces the following output properties:
- Id string
- The provider-assigned unique ID for this managed resource.
- Dictionary<string, string>
- A map of tags assigned to the resource, including those inherited from the provider
default_tagsconfiguration block. - Transit
Gateway stringAttachment Id - ID of the transit gateway attachment created for the VPN concentrator.
- Vpn
Concentrator stringId - ID of the VPN Concentrator.
- Id string
- The provider-assigned unique ID for this managed resource.
- map[string]string
- A map of tags assigned to the resource, including those inherited from the provider
default_tagsconfiguration block. - Transit
Gateway stringAttachment Id - ID of the transit gateway attachment created for the VPN concentrator.
- Vpn
Concentrator stringId - ID of the VPN Concentrator.
- id String
- The provider-assigned unique ID for this managed resource.
- Map<String,String>
- A map of tags assigned to the resource, including those inherited from the provider
default_tagsconfiguration block. - transit
Gateway StringAttachment Id - ID of the transit gateway attachment created for the VPN concentrator.
- vpn
Concentrator StringId - ID of the VPN Concentrator.
- id string
- The provider-assigned unique ID for this managed resource.
- {[key: string]: string}
- A map of tags assigned to the resource, including those inherited from the provider
default_tagsconfiguration block. - transit
Gateway stringAttachment Id - ID of the transit gateway attachment created for the VPN concentrator.
- vpn
Concentrator stringId - ID of the VPN Concentrator.
- id str
- The provider-assigned unique ID for this managed resource.
- Mapping[str, str]
- A map of tags assigned to the resource, including those inherited from the provider
default_tagsconfiguration block. - transit_
gateway_ strattachment_ id - ID of the transit gateway attachment created for the VPN concentrator.
- vpn_
concentrator_ strid - ID of the VPN Concentrator.
- id String
- The provider-assigned unique ID for this managed resource.
- Map<String>
- A map of tags assigned to the resource, including those inherited from the provider
default_tagsconfiguration block. - transit
Gateway StringAttachment Id - ID of the transit gateway attachment created for the VPN concentrator.
- vpn
Concentrator StringId - ID of the VPN Concentrator.
Look up Existing VpnConcentrator Resource
Get an existing VpnConcentrator 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?: VpnConcentratorState, opts?: CustomResourceOptions): VpnConcentrator@staticmethod
def get(resource_name: str,
id: str,
opts: Optional[ResourceOptions] = None,
region: Optional[str] = None,
tags: Optional[Mapping[str, str]] = None,
tags_all: Optional[Mapping[str, str]] = None,
transit_gateway_attachment_id: Optional[str] = None,
transit_gateway_id: Optional[str] = None,
type: Optional[str] = None,
vpn_concentrator_id: Optional[str] = None) -> VpnConcentratorfunc GetVpnConcentrator(ctx *Context, name string, id IDInput, state *VpnConcentratorState, opts ...ResourceOption) (*VpnConcentrator, error)public static VpnConcentrator Get(string name, Input<string> id, VpnConcentratorState? state, CustomResourceOptions? opts = null)public static VpnConcentrator get(String name, Output<String> id, VpnConcentratorState state, CustomResourceOptions options)resources: _: type: aws:ec2:VpnConcentrator get: id: ${id}- 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.
- Region string
- Region where this resource will be managed. Defaults to the Region set in the provider configuration.
- Dictionary<string, string>
- Key-value mapping of resource tags. 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. - Transit
Gateway stringAttachment Id - ID of the transit gateway attachment created for the VPN concentrator.
- Transit
Gateway stringId ID of the transit gateway to attach the VPN concentrator to.
The following arguments are optional:
- Type string
- Type of VPN concentrator. Valid value:
ipsec.1. - Vpn
Concentrator stringId - ID of the VPN Concentrator.
- Region string
- Region where this resource will be managed. Defaults to the Region set in the provider configuration.
- map[string]string
- Key-value mapping of resource tags. 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. - Transit
Gateway stringAttachment Id - ID of the transit gateway attachment created for the VPN concentrator.
- Transit
Gateway stringId ID of the transit gateway to attach the VPN concentrator to.
The following arguments are optional:
- Type string
- Type of VPN concentrator. Valid value:
ipsec.1. - Vpn
Concentrator stringId - ID of the VPN Concentrator.
- region String
- Region where this resource will be managed. Defaults to the Region set in the provider configuration.
- Map<String,String>
- Key-value mapping of resource tags. 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. - transit
Gateway StringAttachment Id - ID of the transit gateway attachment created for the VPN concentrator.
- transit
Gateway StringId ID of the transit gateway to attach the VPN concentrator to.
The following arguments are optional:
- type String
- Type of VPN concentrator. Valid value:
ipsec.1. - vpn
Concentrator StringId - ID of the VPN Concentrator.
- region string
- Region where this resource will be managed. Defaults to the Region set in the provider configuration.
- {[key: string]: string}
- Key-value mapping of resource tags. 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. - transit
Gateway stringAttachment Id - ID of the transit gateway attachment created for the VPN concentrator.
- transit
Gateway stringId ID of the transit gateway to attach the VPN concentrator to.
The following arguments are optional:
- type string
- Type of VPN concentrator. Valid value:
ipsec.1. - vpn
Concentrator stringId - ID of the VPN Concentrator.
- region str
- Region where this resource will be managed. Defaults to the Region set in the provider configuration.
- Mapping[str, str]
- Key-value mapping of resource tags. 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. - transit_
gateway_ strattachment_ id - ID of the transit gateway attachment created for the VPN concentrator.
- transit_
gateway_ strid ID of the transit gateway to attach the VPN concentrator to.
The following arguments are optional:
- type str
- Type of VPN concentrator. Valid value:
ipsec.1. - vpn_
concentrator_ strid - ID of the VPN Concentrator.
- region String
- Region where this resource will be managed. Defaults to the Region set in the provider configuration.
- Map<String>
- Key-value mapping of resource tags. 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. - transit
Gateway StringAttachment Id - ID of the transit gateway attachment created for the VPN concentrator.
- transit
Gateway StringId ID of the transit gateway to attach the VPN concentrator to.
The following arguments are optional:
- type String
- Type of VPN concentrator. Valid value:
ipsec.1. - vpn
Concentrator StringId - ID of the VPN Concentrator.
Import
Using pulumi import, import VPN Concentrators using the VPN concentrator ID. For example:
$ pulumi import aws:ec2/vpnConcentrator:VpnConcentrator example vcn-12345678
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
awsTerraform Provider.
