@pulumi/aws
Version:
A Pulumi package for creating and managing Amazon Web Services (AWS) cloud resources.
157 lines (156 loc) • 5.9 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
/**
* Provides a resource to create a VPN Concentrator that aggregates multiple VPN connections to a transit gateway.
*
* ## Example Usage
*
* ```typescript
* 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
*
* Using `pulumi import`, import VPN Concentrators using the VPN concentrator ID. For example:
*
* ```sh
* $ pulumi import aws:ec2/vpnConcentrator:VpnConcentrator example vcn-12345678
* ```
*/
export declare class VpnConcentrator extends pulumi.CustomResource {
/**
* Get an existing VpnConcentrator resource's state with the given name, ID, and optional extra
* properties used to qualify the lookup.
*
* @param name The _unique_ name of the resulting resource.
* @param id The _unique_ provider ID of the resource to lookup.
* @param state Any extra arguments used during the lookup.
* @param opts Optional settings to control the behavior of the CustomResource.
*/
static get(name: string, id: pulumi.Input<pulumi.ID>, state?: VpnConcentratorState, opts?: pulumi.CustomResourceOptions): VpnConcentrator;
/**
* Returns true if the given object is an instance of VpnConcentrator. This is designed to work even
* when multiple copies of the Pulumi SDK have been loaded into the same process.
*/
static isInstance(obj: any): obj is VpnConcentrator;
/**
* Region where this resource will be [managed](https://docs.aws.amazon.com/general/latest/gr/rande.html#regional-endpoints). Defaults to the Region set in the provider configuration.
*/
readonly region: pulumi.Output<string>;
/**
* Key-value mapping of resource tags. If configured with a provider `defaultTags` configuration block present, tags with matching keys will overwrite those defined at the provider-level.
*/
readonly tags: pulumi.Output<{
[key: string]: string;
} | undefined>;
/**
* A map of tags assigned to the resource, including those inherited from the provider `defaultTags` configuration block.
*/
readonly tagsAll: pulumi.Output<{
[key: string]: string;
}>;
/**
* ID of the transit gateway attachment created for the VPN concentrator.
*/
readonly transitGatewayAttachmentId: pulumi.Output<string>;
/**
* ID of the transit gateway to attach the VPN concentrator to.
*
* The following arguments are optional:
*/
readonly transitGatewayId: pulumi.Output<string>;
/**
* Type of VPN concentrator. Valid value: `ipsec.1`.
*/
readonly type: pulumi.Output<string>;
/**
* ID of the VPN Concentrator.
*/
readonly vpnConcentratorId: pulumi.Output<string>;
/**
* Create a VpnConcentrator resource with the given unique name, arguments, and options.
*
* @param name The _unique_ name of the resource.
* @param args The arguments to use to populate this resource's properties.
* @param opts A bag of options that control this resource's behavior.
*/
constructor(name: string, args: VpnConcentratorArgs, opts?: pulumi.CustomResourceOptions);
}
/**
* Input properties used for looking up and filtering VpnConcentrator resources.
*/
export interface VpnConcentratorState {
/**
* Region where this resource will be [managed](https://docs.aws.amazon.com/general/latest/gr/rande.html#regional-endpoints). Defaults to the Region set in the provider configuration.
*/
region?: pulumi.Input<string>;
/**
* Key-value mapping of resource tags. If configured with a provider `defaultTags` configuration block present, tags with matching keys will overwrite those defined at the provider-level.
*/
tags?: pulumi.Input<{
[key: string]: pulumi.Input<string>;
}>;
/**
* A map of tags assigned to the resource, including those inherited from the provider `defaultTags` configuration block.
*/
tagsAll?: pulumi.Input<{
[key: string]: pulumi.Input<string>;
}>;
/**
* ID of the transit gateway attachment created for the VPN concentrator.
*/
transitGatewayAttachmentId?: pulumi.Input<string>;
/**
* ID of the transit gateway to attach the VPN concentrator to.
*
* The following arguments are optional:
*/
transitGatewayId?: pulumi.Input<string>;
/**
* Type of VPN concentrator. Valid value: `ipsec.1`.
*/
type?: pulumi.Input<string>;
/**
* ID of the VPN Concentrator.
*/
vpnConcentratorId?: pulumi.Input<string>;
}
/**
* The set of arguments for constructing a VpnConcentrator resource.
*/
export interface VpnConcentratorArgs {
/**
* Region where this resource will be [managed](https://docs.aws.amazon.com/general/latest/gr/rande.html#regional-endpoints). Defaults to the Region set in the provider configuration.
*/
region?: pulumi.Input<string>;
/**
* Key-value mapping of resource tags. If configured with a provider `defaultTags` configuration block present, tags with matching keys will overwrite those defined at the provider-level.
*/
tags?: pulumi.Input<{
[key: string]: pulumi.Input<string>;
}>;
/**
* ID of the transit gateway to attach the VPN concentrator to.
*
* The following arguments are optional:
*/
transitGatewayId: pulumi.Input<string>;
/**
* Type of VPN concentrator. Valid value: `ipsec.1`.
*/
type: pulumi.Input<string>;
}