interface CfnTransitVirtualInterfaceProps

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

Properties for defining a CfnTransitVirtualInterface.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-directconnect-transitvirtualinterface.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 cfnTransitVirtualInterfaceProps: directconnect.CfnTransitVirtualInterfaceProps = {
  bgpPeers: [{
    addressFamily: 'addressFamily',
    asn: 'asn',

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

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

Properties

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

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-transitvirtualinterface.html#cfn-directconnect-transitvirtualinterface-bgppeers

connectionId

Type: string | IConnectionRef | ILagRef

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

directConnectGatewayId

Type: string | IDirectConnectGatewayRef

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

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-transitvirtualinterface.html#cfn-directconnect-transitvirtualinterface-virtualinterfacename

vlan

Type: number

The ID of the VLAN.

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

allocateTransitVirtualInterfaceRoleArn?

Type: string (optional)

The Amazon Resource Name (ARN) of the role to allocate the TransitVifAllocation.

Needs directconnect:AllocateTransitVirtualInterface permissions and tag permissions if applicable.

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

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-transitvirtualinterface.html#cfn-directconnect-transitvirtualinterface-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-transitvirtualinterface.html#cfn-directconnect-transitvirtualinterface-mtu

rateLimit?

Type: string (optional)

The rate limit (bandwidth allocation) for the virtual interface.

The value must be one of the supported bandwidth values (e.g., 50Mbps, 1Gbps, 10Gbps) and cannot exceed the bandwidth of the parent connection or LAG.

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

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-transitvirtualinterface.html#cfn-directconnect-transitvirtualinterface-tags

AWS CDK

2.268.0