AWS Tools for Windows PowerShell
Command Reference

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

Synopsis

Calls the Amazon Elastic Compute Cloud (EC2) CreateVpnConnection API operation.

Syntax

New-EC2VpnConnection
-Type <String>
-CustomerGatewayId <String>
-VpnGatewayId <String>
-Options_StaticRoutesOnly <Boolean>
-Options_EnableAcceleration <Boolean>
-Options_LocalIpv4NetworkCidr <String>
-Options_LocalIpv6NetworkCidr <String>
-Options_OutsideIpAddressType <String>
-Options_RemoteIpv4NetworkCidr <String>
-Options_RemoteIpv6NetworkCidr <String>
-TagSpecification <TagSpecification[]>
-TransitGatewayId <String>
-Options_TransportTransitGatewayAttachmentId <String>
-Options_TunnelInsideIpVersion <TunnelInsideIpVersion>
-Options_TunnelOption <VpnTunnelOptionsSpecification[]>
-Select <String>
-PassThru <SwitchParameter>
-Force <SwitchParameter>
-ClientConfig <AmazonEC2Config>

Description

Creates a VPN connection between an existing virtual private gateway or transit gateway and a customer gateway. The supported connection type is ipsec.1. The response includes information that you need to give to your network administrator to configure your customer gateway. We strongly recommend that you use HTTPS when calling this operation because the response contains sensitive cryptographic information for configuring your customer gateway device. If you decide to shut down your VPN connection for any reason and later create a new VPN connection, you must reconfigure your customer gateway with the new information returned from this call. This is an idempotent operation. If you perform the operation more than once, Amazon EC2 doesn't return an error. For more information, see Amazon Web Services Site-to-Site VPN in the Amazon Web Services Site-to-Site VPN User Guide.

Parameters

-ClientConfig <AmazonEC2Config>
Amazon.PowerShell.Cmdlets.EC2.AmazonEC2ClientCmdlet.ClientConfig
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-CustomerGatewayId <String>
The ID of the customer gateway.
Required?True
Position?2
Accept pipeline input?True (ByPropertyName)
-Force <SwitchParameter>
This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Options_EnableAcceleration <Boolean>
Indicate whether to enable acceleration for the VPN connection.Default: false
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Options_LocalIpv4NetworkCidr <String>
The IPv4 CIDR on the customer gateway (on-premises) side of the VPN connection.Default: 0.0.0.0/0
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Options_LocalIpv6NetworkCidr <String>
The IPv6 CIDR on the customer gateway (on-premises) side of the VPN connection.Default: ::/0
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Options_OutsideIpAddressType <String>
The type of IPv4 address assigned to the outside interface of the customer gateway device.Valid values: PrivateIpv4 | PublicIpv4Default: PublicIpv4
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Options_RemoteIpv4NetworkCidr <String>
The IPv4 CIDR on the Amazon Web Services side of the VPN connection.Default: 0.0.0.0/0
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Options_RemoteIpv6NetworkCidr <String>
The IPv6 CIDR on the Amazon Web Services side of the VPN connection.Default: ::/0
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Options_StaticRoutesOnly <Boolean>
Indicate whether the VPN connection uses static routes only. If you are creating a VPN connection for a device that does not support BGP, you must specify true. Use CreateVpnConnectionRoute to create a static route.Default: false
Required?False
Position?4
Accept pipeline input?True (ByPropertyName)
AliasesStaticRoutesOnly
-Options_TransportTransitGatewayAttachmentId <String>
The transit gateway attachment ID to use for the VPN tunnel.Required if OutsideIpAddressType is set to PrivateIpv4.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Options_TunnelInsideIpVersion <TunnelInsideIpVersion>
Indicate whether the VPN tunnels process IPv4 or IPv6 traffic.Default: ipv4
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Options_TunnelOption <VpnTunnelOptionsSpecification[]>
The tunnel options for the VPN connection.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesOptions_TunnelOptions
-PassThru <SwitchParameter>
Changes the cmdlet behavior to return the value passed to the Type parameter. The -PassThru parameter is deprecated, use -Select '^Type' instead. This parameter will be removed in a future version.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Select <String>
Use the -Select parameter to control the cmdlet output. The default value is 'VpnConnection'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.EC2.Model.CreateVpnConnectionResponse). Specifying the name of a property of type Amazon.EC2.Model.CreateVpnConnectionResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-TagSpecification <TagSpecification[]>
The tags to apply to the VPN connection.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesTagSpecifications
-TransitGatewayId <String>
The ID of the transit gateway. If you specify a transit gateway, you cannot specify a virtual private gateway.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Type <String>
The type of VPN connection (ipsec.1).
Required?True
Position?1
Accept pipeline input?True (ByValue, ByPropertyName)
-VpnGatewayId <String>
The ID of the virtual private gateway. If you specify a virtual private gateway, you cannot specify a transit gateway.
Required?False
Position?3
Accept pipeline input?True (ByPropertyName)

Common Credential and Region Parameters

-AccessKey <String>
The AWS access key for the user account. This can be a temporary access key if the corresponding session token is supplied to the -SessionToken parameter.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesAK
-Credential <AWSCredentials>
An AWSCredentials object instance containing access and secret key information, and optionally a token for session-based credentials.
Required?False
Position?Named
Accept pipeline input?True (ByValue, ByPropertyName)
-EndpointUrl <String>
The endpoint to make the call against.Note: This parameter is primarily for internal AWS use and is not required/should not be specified for normal usage. The cmdlets normally determine which endpoint to call based on the region specified to the -Region parameter or set as default in the shell (via Set-DefaultAWSRegion). Only specify this parameter if you must direct the call to a specific custom endpoint.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-NetworkCredential <PSCredential>
Used with SAML-based authentication when ProfileName references a SAML role profile. Contains the network credentials to be supplied during authentication with the configured identity provider's endpoint. This parameter is not required if the user's default network identity can or should be used during authentication.
Required?False
Position?Named
Accept pipeline input?True (ByValue, ByPropertyName)
-ProfileLocation <String>
Used to specify the name and location of the ini-format credential file (shared with the AWS CLI and other AWS SDKs)If this optional parameter is omitted this cmdlet will search the encrypted credential file used by the AWS SDK for .NET and AWS Toolkit for Visual Studio first. If the profile is not found then the cmdlet will search in the ini-format credential file at the default location: (user's home directory)\.aws\credentials.If this parameter is specified then this cmdlet will only search the ini-format credential file at the location given.As the current folder can vary in a shell or during script execution it is advised that you use specify a fully qualified path instead of a relative path.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesAWSProfilesLocation, ProfilesLocation
-ProfileName <String>
The user-defined name of an AWS credentials or SAML-based role profile containing credential information. The profile is expected to be found in the secure credential file shared with the AWS SDK for .NET and AWS Toolkit for Visual Studio. You can also specify the name of a profile stored in the .ini-format credential file used with the AWS CLI and other AWS SDKs.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesStoredCredentials, AWSProfileName
-Region <Object>
The system name of an AWS region or an AWSRegion instance. This governs the endpoint that will be used when calling service operations. Note that the AWS resources referenced in a call are usually region-specific.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesRegionToCall
-SecretKey <String>
The AWS secret key for the user account. This can be a temporary secret key if the corresponding session token is supplied to the -SessionToken parameter.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesSK, SecretAccessKey
-SessionToken <String>
The session token if the access and secret keys are temporary session-based credentials.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesST

Outputs

Amazon.EC2.Model.VpnConnection or Amazon.EC2.Model.CreateVpnConnectionResponse
This cmdlet returns an Amazon.EC2.Model.VpnConnection object. The service call response (type Amazon.EC2.Model.CreateVpnConnectionResponse) can be returned by specifying '-Select *'.

Examples

Example 1

New-EC2VpnConnection -Type ipsec.1 -CustomerGatewayId cgw-1a2b3c4d -VpnGatewayId vgw-1a2b3c4d

CustomerGatewayConfiguration : [XML document]
CustomerGatewayId            : cgw-1a2b3c4d
Options                      :
Routes                       : {}
State                        : pending
Tags                         : {}
Type                         :
VgwTelemetry                 : {}
VpnConnectionId              : vpn-12345678
VpnGatewayId                 : vgw-1a2b3c4d
This example creates a VPN connection between the specified virtual private gateway and the specified customer gateway. The output includes the configuration information that your network administrator needs, in XML format.

Example 2

(New-EC2VpnConnection -CustomerGatewayId cgw-1a2b3c4d -VpnGatewayId vgw-1a2b3c4d).CustomerGatewayConfiguration | Out-File C:\path\vpn-configuration.xml
This example creates the VPN connection and captures the configuration in a file with the specified name.

Example 3

New-EC2VpnConnection -Type ipsec.1 -CustomerGatewayId cgw-1a2b3c4d -VpnGatewayId vgw-1a2b3c4d -Options_StaticRoutesOnly $true
This example creates a VPN connection, with static routing, between the specified virtual private gateway and the specified customer gateway.
User Guide
Service API Reference
Microsoft Windows Guide
VPC User Guide
AWS Tools for PowerShell User Guide

Supported Version

AWS Tools for PowerShell: 2.x.y.z