interface CfnPrivateVirtualInterfaceMixinProps

Language	Type name
.NET	Amazon.CDK.CfnPropertyMixins.AWS.DirectConnect.CfnPrivateVirtualInterfaceMixinProps
Go	github.com/aws/aws-cdk-go/awscdkcfnpropertymixins/v2/awsdirectconnect#CfnPrivateVirtualInterfaceMixinProps
Java	software.amazon.awscdk.cfnpropertymixins.services.directconnect.CfnPrivateVirtualInterfaceMixinProps
Python	aws_cdk.cfn_property_mixins.aws_directconnect.CfnPrivateVirtualInterfaceMixinProps
TypeScript	@aws-cdk/cfn-property-mixins » aws_directconnect » CfnPrivateVirtualInterfaceMixinProps

Properties for CfnPrivateVirtualInterfacePropsMixin.

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/cfn-property-mixins';
const cfnPrivateVirtualInterfaceMixinProps: directconnect.CfnPrivateVirtualInterfaceMixinProps = {
  allocatePrivateVirtualInterfaceRoleArn: 'allocatePrivateVirtualInterfaceRoleArn',
  bgpPeers: [{
    addressFamily: 'addressFamily',
    amazonAddress: 'amazonAddress',
    asn: 'asn',
    authKey: 'authKey',
    bgpPeerId: 'bgpPeerId',
    customerAddress: 'customerAddress',
  }],
  connectionId: 'connectionId',
  directConnectGatewayId: 'directConnectGatewayId',
  enableSiteLink: false,
  mtu: 123,
  rateLimit: 'rateLimit',
  tags: [{
    key: 'key',
    value: 'value',
  }],
  virtualGatewayId: 'virtualGatewayId',
  virtualInterfaceName: 'virtualInterfaceName',
  vlan: 123,
};

Properties

Name	Type	Description
allocatePrivateVirtualInterfaceRoleArn?	string	The Amazon Resource Name (ARN) of the role to allocate the private virtual interface.
bgpPeers?	IResolvable | (IResolvable | BgpPeerProperty)[]	The BGP peers configured on this virtual interface.
connectionId?	string | IConnectionRef | ILagRef
directConnectGatewayId?	string | IDirectConnectGatewayRef
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.
virtualGatewayId?	string	The ID or ARN of the virtual private gateway.
virtualInterfaceName?	string	The name of the virtual interface assigned by the customer network.
vlan?	number	The ID of the 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

---

bgpPeers?

Type: IResolvable | (IResolvable | BgpPeerProperty)[] (optional)

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 (optional)

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

---

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

---

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

---

virtualInterfaceName?

Type: string (optional)

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 (optional)

The ID of the VLAN.

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