AWS CDK

2.242.0

interface CfnPrivateVirtualInterfaceProps

Language	Type name
.NET	`Amazon.CDK.AWS.DirectConnect.CfnPrivateVirtualInterfaceProps`
Go	`github.com/aws/aws-cdk-go/awscdk/v2/awsdirectconnect#CfnPrivateVirtualInterfaceProps`
Java	`software.amazon.awscdk.services.directconnect.CfnPrivateVirtualInterfaceProps`
Python	`aws_cdk.aws_directconnect.CfnPrivateVirtualInterfaceProps`
TypeScript	`aws-cdk-lib` » `aws_directconnect` » `CfnPrivateVirtualInterfaceProps`

Properties for defining a CfnPrivateVirtualInterface.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-directconnect-privatevirtualinterface.html

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_directconnect as directconnect } from 'aws-cdk-lib';
const cfnPrivateVirtualInterfaceProps: directconnect.CfnPrivateVirtualInterfaceProps = {
  bgpPeers: [{
    addressFamily: 'addressFamily',
    asn: 'asn',

    // the properties below are optional
    amazonAddress: 'amazonAddress',
    authKey: 'authKey',
    bgpPeerId: 'bgpPeerId',
    customerAddress: 'customerAddress',
  }],
  connectionId: 'connectionId',
  virtualInterfaceName: 'virtualInterfaceName',
  vlan: 123,

  // the properties below are optional
  allocatePrivateVirtualInterfaceRoleArn: 'allocatePrivateVirtualInterfaceRoleArn',
  directConnectGatewayId: 'directConnectGatewayId',
  enableSiteLink: false,
  mtu: 123,
  tags: [{
    key: 'key',
    value: 'value',
  }],
  virtualGatewayId: 'virtualGatewayId',
};

Properties

Name	Type	Description
bgpPeers	`IResolvable` `\| (IResolvable` `\|` `BgpPeerProperty)[]`	The BGP peers configured on this virtual interface.
connectionId	`string \|` `IConnectionRef` `\|` `ILagRef`
virtualInterfaceName	`string`	The name of the virtual interface assigned by the customer network.
vlan	`number`	The ID of the VLAN.
allocatePrivateVirtualInterfaceRoleArn?	`string`	The Amazon Resource Name (ARN) of the role to allocate the private virtual interface.
directConnectGatewayId?	`string \|` `IDirectConnectGatewayRef`
enableSiteLink?	`boolean \|` `IResolvable`	Indicates whether to enable or disable SiteLink.
mtu?	`number`	The maximum transmission unit (MTU), in bytes.
tags?	`CfnTag[]`	The tags associated with the private virtual interface.
virtualGatewayId?	`string`	The ID or ARN of the virtual private gateway.

bgpPeers

Type: IResolvable | (IResolvable | BgpPeerProperty)[]

The BGP peers configured on this virtual interface.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-directconnect-privatevirtualinterface.html#cfn-directconnect-privatevirtualinterface-bgppeers

connectionId

Type: string | IConnectionRef | ILagRef

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-directconnect-privatevirtualinterface.html#cfn-directconnect-privatevirtualinterface-connectionid

virtualInterfaceName

Type: 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 (-).

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-directconnect-privatevirtualinterface.html#cfn-directconnect-privatevirtualinterface-virtualinterfacename

vlan

Type: number

The ID of the VLAN.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-directconnect-privatevirtualinterface.html#cfn-directconnect-privatevirtualinterface-vlan

allocatePrivateVirtualInterfaceRoleArn?

Type: string (optional)

The Amazon Resource Name (ARN) of the role to allocate the private virtual interface.

Needs directconnect:AllocatePrivateVirtualInterface permissions and tag permissions if applicable.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-directconnect-privatevirtualinterface.html#cfn-directconnect-privatevirtualinterface-allocateprivatevirtualinterfacerolearn

directConnectGatewayId?

Type: string | IDirectConnectGatewayRef (optional)

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-directconnect-privatevirtualinterface.html#cfn-directconnect-privatevirtualinterface-directconnectgatewayid

enableSiteLink?

Type: boolean | IResolvable (optional)

Indicates whether to enable or disable SiteLink.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-directconnect-privatevirtualinterface.html#cfn-directconnect-privatevirtualinterface-enablesitelink

mtu?

Type: number (optional)

The maximum transmission unit (MTU), in bytes.

The supported values are 1500 and 9001. The default value is 1500.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-directconnect-privatevirtualinterface.html#cfn-directconnect-privatevirtualinterface-mtu

tags?

Type: CfnTag[] (optional)

The tags associated with the private virtual interface.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-directconnect-privatevirtualinterface.html#cfn-directconnect-privatevirtualinterface-tags

virtualGatewayId?

Type: string (optional)

The ID or ARN of the virtual private gateway.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-directconnect-privatevirtualinterface.html#cfn-directconnect-privatevirtualinterface-virtualgatewayid

← Previous Next →