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 AWS Direct Connect CreatePrivateVirtualInterface API operation.

Syntax

New-DCPrivateVirtualInterface
-ConnectionId <String>
-NewPrivateVirtualInterface_AddressFamily <AddressFamily>
-NewPrivateVirtualInterface_AmazonAddress <String>
-NewPrivateVirtualInterface_Asn <Int32>
-NewPrivateVirtualInterface_AsnLong <Int64>
-NewPrivateVirtualInterface_AuthKey <String>
-NewPrivateVirtualInterface_CustomerAddress <String>
-NewPrivateVirtualInterface_DirectConnectGatewayId <String>
-NewPrivateVirtualInterface_EnableSiteLink <Boolean>
-NewPrivateVirtualInterface_Mtu <Int32>
-NewPrivateVirtualInterface_Tag <Tag[]>
-NewPrivateVirtualInterface_VirtualGatewayId <String>
-NewPrivateVirtualInterface_VirtualInterfaceName <String>
-NewPrivateVirtualInterface_Vlan <Int32>
-Select <String>
-Force <SwitchParameter>
-ClientConfig <AmazonDirectConnectConfig>

Description

Creates a private virtual interface. A virtual interface is the VLAN that transports Direct Connect traffic. A private virtual interface can be connected to either a Direct Connect gateway or a Virtual Private Gateway (VGW). Connecting the private virtual interface to a Direct Connect gateway enables the possibility for connecting to multiple VPCs, including VPCs in different Amazon Web Services Regions. Connecting the private virtual interface to a VGW only provides access to a single VPC within the same Region. Setting the MTU of a virtual interface to 8500 (jumbo frames) can cause an update to the underlying physical connection if it wasn't updated to support jumbo frames. Updating the connection disrupts network connectivity for all virtual interfaces associated with the connection for up to 30 seconds. To check whether your connection supports jumbo frames, call DescribeConnections. To check whether your virtual interface supports jumbo frames, call DescribeVirtualInterfaces.

Parameters

-ClientConfig <AmazonDirectConnectConfig>
Amazon.PowerShell.Cmdlets.DC.AmazonDirectConnectClientCmdlet.ClientConfig
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-ConnectionId <String>
The ID of the connection.
Required?True
Position?1
Accept pipeline input?True (ByValue, 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)
-NewPrivateVirtualInterface_AddressFamily <AddressFamily>
The address family for the BGP peer.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-NewPrivateVirtualInterface_AmazonAddress <String>
The IP address assigned to the Amazon interface.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-NewPrivateVirtualInterface_Asn <Int32>
The autonomous system number (ASN). The valid range is from 1 to 2147483646 for Border Gateway Protocol (BGP) configuration. If you provide a number greater than the maximum, an error is returned. Use asnLong instead.You can use asnLong or asn, but not both. We recommend using asnLong as it supports a greater pool of numbers.
  • The asnLong attribute accepts both ASN and long ASN ranges.
  • If you provide a value in the same API call for both asn and asnLong, the API will only accept the value for asnLong.
The valid values are 1-2147483646.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-NewPrivateVirtualInterface_AsnLong <Int64>
The long ASN for a new private virtual interface. The valid range is from 1 to 4294967294 for BGP configuration.You can use asnLong or asn, but not both. We recommend using asnLong as it supports a greater pool of numbers.
  • The asnLong attribute accepts both ASN and long ASN ranges.
  • If you provide a value in the same API call for both asn and asnLong, the API will only accept the value for asnLong.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-NewPrivateVirtualInterface_AuthKey <String>
The authentication key for BGP configuration. This string has a minimum length of 6 characters and and a maximun lenth of 80 characters.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-NewPrivateVirtualInterface_CustomerAddress <String>
The IP address assigned to the customer interface.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-NewPrivateVirtualInterface_DirectConnectGatewayId <String>
The ID of the Direct Connect gateway.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-NewPrivateVirtualInterface_EnableSiteLink <Boolean>
Indicates whether to enable or disable SiteLink.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-NewPrivateVirtualInterface_Mtu <Int32>
The maximum transmission unit (MTU), in bytes. The supported values are 1500 and 8500. The default value is 1500.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-NewPrivateVirtualInterface_Tag <Tag[]>
The tags associated with the private virtual interface. Starting with version 4 of the SDK this property will default to null. If no data for this property is returned from the service the property will also be null. This was changed to improve performance and allow the SDK and caller to distinguish between a property not set or a property being empty to clear out a value. To retain the previous SDK behavior set the AWSConfigs.InitializeCollections static property to true.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesNewPrivateVirtualInterface_Tags
-NewPrivateVirtualInterface_VirtualGatewayId <String>
The ID of the virtual private gateway.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-NewPrivateVirtualInterface_VirtualInterfaceName <String>
The name of the virtual interface assigned by the customer network. The name has a maximum of 100 characters. The following are valid characters: a-z, 0-9 and a hyphen (-).
Required?True
Position?Named
Accept pipeline input?True (ByPropertyName)
-NewPrivateVirtualInterface_Vlan <Int32>
The ID of the VLAN.
Required?True
Position?Named
Accept pipeline input?True (ByPropertyName)
-Select <String>
Use the -Select parameter to control the cmdlet output. The default value is '*'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.DirectConnect.Model.CreatePrivateVirtualInterfaceResponse). Specifying the name of a property of type Amazon.DirectConnect.Model.CreatePrivateVirtualInterfaceResponse 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)

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.DirectConnect.Model.CreatePrivateVirtualInterfaceResponse
This cmdlet returns an Amazon.DirectConnect.Model.CreatePrivateVirtualInterfaceResponse object containing multiple properties.
User Guide
Service API Reference
AWS Tools for PowerShell User Guide

Supported Version

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