aws-native.ec2.VpnConnection

Explore with Pulumi AI

AWS Native is in preview. AWS Classic is fully supported.

AWS Native v0.102.0 published on Tuesday, Apr 16, 2024 by Pulumi

pulumi/pulumi-aws-native

Create VpnConnection Resource

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

Constructor syntax

new VpnConnection(name: string, args: VpnConnectionArgs, opts?: CustomResourceOptions);

@overload
def VpnConnection(resource_name: str,
                  args: VpnConnectionArgs,
                  opts: Optional[ResourceOptions] = None)

@overload
def VpnConnection(resource_name: str,
                  opts: Optional[ResourceOptions] = None,
                  customer_gateway_id: Optional[str] = None,
                  type: Optional[str] = None,
                  static_routes_only: Optional[bool] = None,
                  tags: Optional[Sequence[_root_inputs.TagArgs]] = None,
                  transit_gateway_id: Optional[str] = None,
                  vpn_gateway_id: Optional[str] = None,
                  vpn_tunnel_options_specifications: Optional[Sequence[VpnConnectionVpnTunnelOptionsSpecificationArgs]] = None)

func NewVpnConnection(ctx *Context, name string, args VpnConnectionArgs, opts ...ResourceOption) (*VpnConnection, error)

public VpnConnection(string name, VpnConnectionArgs args, CustomResourceOptions? opts = null)

public VpnConnection(String name, VpnConnectionArgs args)
public VpnConnection(String name, VpnConnectionArgs args, CustomResourceOptions options)

type: aws-native:ec2:VpnConnection
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 VpnConnectionArgs: 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 VpnConnectionArgs: 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 VpnConnectionArgs: The arguments to resource properties.
opts ResourceOption: Bag of options to control resource's behavior.

name string: The unique name of the resource.
args VpnConnectionArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

name String: The unique name of the resource.
args VpnConnectionArgs: The arguments to resource properties.
options CustomResourceOptions: Bag of options to control resource's behavior.

Example

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

Coming soon!

Coming soon!

Coming soon!

Coming soon!

const vpnConnectionResource = new aws_native.ec2.VpnConnection("vpnConnectionResource", {
    customerGatewayId: "string",
    type: "string",
    staticRoutesOnly: false,
    tags: [{
        key: "string",
        value: "string",
    }],
    transitGatewayId: "string",
    vpnGatewayId: "string",
    vpnTunnelOptionsSpecifications: [{
        preSharedKey: "string",
        tunnelInsideCidr: "string",
    }],
});

Coming soon!

VpnConnection 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 VpnConnection resource accepts the following input properties:

CustomerGatewayId string: The ID of the customer gateway at your end of the VPN connection.
Type string: The type of VPN connection.
StaticRoutesOnly bool: Indicates whether the VPN connection uses static routes only.
Tags List<Pulumi.AwsNative.Inputs.Tag>: Any tags assigned to the VPN connection.
TransitGatewayId string: The ID of the transit gateway associated with the VPN connection.
VpnGatewayId string: The ID of the virtual private gateway at the AWS side of the VPN connection.
VpnTunnelOptionsSpecifications List<Pulumi.AwsNative.Ec2.Inputs.VpnConnectionVpnTunnelOptionsSpecification>: The tunnel options for the VPN connection.

CustomerGatewayId string: The ID of the customer gateway at your end of the VPN connection.
Type string: The type of VPN connection.
StaticRoutesOnly bool: Indicates whether the VPN connection uses static routes only.
Tags TagArgs: Any tags assigned to the VPN connection.
TransitGatewayId string: The ID of the transit gateway associated with the VPN connection.
VpnGatewayId string: The ID of the virtual private gateway at the AWS side of the VPN connection.
VpnTunnelOptionsSpecifications []VpnConnectionVpnTunnelOptionsSpecificationArgs: The tunnel options for the VPN connection.

customerGatewayId String: The ID of the customer gateway at your end of the VPN connection.
type String: The type of VPN connection.
staticRoutesOnly Boolean: Indicates whether the VPN connection uses static routes only.
tags List<Tag>: Any tags assigned to the VPN connection.
transitGatewayId String: The ID of the transit gateway associated with the VPN connection.
vpnGatewayId String: The ID of the virtual private gateway at the AWS side of the VPN connection.
vpnTunnelOptionsSpecifications List<VpnConnectionVpnTunnelOptionsSpecification>: The tunnel options for the VPN connection.

customerGatewayId string: The ID of the customer gateway at your end of the VPN connection.
type string: The type of VPN connection.
staticRoutesOnly boolean: Indicates whether the VPN connection uses static routes only.
tags Tag[]: Any tags assigned to the VPN connection.
transitGatewayId string: The ID of the transit gateway associated with the VPN connection.
vpnGatewayId string: The ID of the virtual private gateway at the AWS side of the VPN connection.
vpnTunnelOptionsSpecifications VpnConnectionVpnTunnelOptionsSpecification[]: The tunnel options for the VPN connection.

customer_gateway_id str: The ID of the customer gateway at your end of the VPN connection.
type str: The type of VPN connection.
static_routes_only bool: Indicates whether the VPN connection uses static routes only.
tags Sequence[TagArgs]: Any tags assigned to the VPN connection.
transit_gateway_id str: The ID of the transit gateway associated with the VPN connection.
vpn_gateway_id str: The ID of the virtual private gateway at the AWS side of the VPN connection.
vpn_tunnel_options_specifications Sequence[VpnConnectionVpnTunnelOptionsSpecificationArgs]: The tunnel options for the VPN connection.

customerGatewayId String: The ID of the customer gateway at your end of the VPN connection.
type String: The type of VPN connection.
staticRoutesOnly Boolean: Indicates whether the VPN connection uses static routes only.
tags List<Property Map>: Any tags assigned to the VPN connection.
transitGatewayId String: The ID of the transit gateway associated with the VPN connection.
vpnGatewayId String: The ID of the virtual private gateway at the AWS side of the VPN connection.
vpnTunnelOptionsSpecifications List<Property Map>: The tunnel options for the VPN connection.

Outputs

All input properties are implicitly available as output properties. Additionally, the VpnConnection resource produces the following output properties:

Id string: The provider-assigned unique ID for this managed resource.
VpnConnectionId string: The provider-assigned unique ID for this managed resource

Id string: The provider-assigned unique ID for this managed resource.
VpnConnectionId string: The provider-assigned unique ID for this managed resource

id String: The provider-assigned unique ID for this managed resource.
vpnConnectionId String: The provider-assigned unique ID for this managed resource

id string: The provider-assigned unique ID for this managed resource.
vpnConnectionId string: The provider-assigned unique ID for this managed resource

id str: The provider-assigned unique ID for this managed resource.
vpn_connection_id str: The provider-assigned unique ID for this managed resource

id String: The provider-assigned unique ID for this managed resource.
vpnConnectionId String: The provider-assigned unique ID for this managed resource