2.268.0

interface CfnPublicVirtualInterfaceProps

LanguageType name
.NETAmazon.CDK.AWS.DirectConnect.CfnPublicVirtualInterfaceProps
Gogithub.com/aws/aws-cdk-go/awscdk/v2/awsdirectconnect#CfnPublicVirtualInterfaceProps
Javasoftware.amazon.awscdk.services.directconnect.CfnPublicVirtualInterfaceProps
Pythonaws_cdk.aws_directconnect.CfnPublicVirtualInterfaceProps
TypeScript aws-cdk-lib » aws_directconnect » CfnPublicVirtualInterfaceProps

Properties for defining a CfnPublicVirtualInterface.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-directconnect-publicvirtualinterface.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 cfnPublicVirtualInterfaceProps: directconnect.CfnPublicVirtualInterfaceProps = {
  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
  allocatePublicVirtualInterfaceRoleArn: 'allocatePublicVirtualInterfaceRoleArn',
  rateLimit: 'rateLimit',
  routeFilterPrefixes: ['routeFilterPrefixes'],
  tags: [{
    key: 'key',
    value: 'value',
  }],
};

Properties

NameTypeDescription
bgpPeersIResolvable | (IResolvable | BgpPeerProperty)[]The BGP peers configured on this virtual interface.
connectionIdstring | IConnectionRef | ILagRef
virtualInterfaceNamestringThe name of the virtual interface assigned by the customer network.
vlannumberThe ID of the VLAN.
allocatePublicVirtualInterfaceRoleArn?stringThe Amazon Resource Name (ARN) of the role to allocate the public virtual interface.
rateLimit?stringThe rate limit (bandwidth allocation) for the virtual interface.
routeFilterPrefixes?string[]The routes to be advertised to the AWS network in this region.
tags?CfnTag[]The tags associated with the public 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-publicvirtualinterface.html#cfn-directconnect-publicvirtualinterface-bgppeers

connectionId

Type: string | IConnectionRef | ILagRef

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-directconnect-publicvirtualinterface.html#cfn-directconnect-publicvirtualinterface-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-publicvirtualinterface.html#cfn-directconnect-publicvirtualinterface-virtualinterfacename

vlan

Type: number

The ID of the VLAN.

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

allocatePublicVirtualInterfaceRoleArn?

Type: string (optional)

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

Needs directconnect:AllocatePublicVirtualInterface permissions and tag permissions if applicable.

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

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

routeFilterPrefixes?

Type: string[] (optional)

The routes to be advertised to the AWS network in this region.

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

tags?

Type: CfnTag[] (optional)

The tags associated with the public virtual interface.

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

← PreviousNext →