Skip to content
v2.278.0

CfnTransitVirtualInterfaceProps Struct ​

Properties for defining a CfnTransitVirtualInterface.

Example ​

ts
// 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',
  }],
};
python
from aws_cdk import CfnTag
# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_directconnect as directconnect

cfn_transit_virtual_interface_props = directconnect.CfnTransitVirtualInterfaceProps(
    bgp_peers=[directconnect.CfnTransitVirtualInterface.BgpPeerProperty(
        address_family="addressFamily",
        asn="asn",

        # the properties below are optional
        amazon_address="amazonAddress",
        auth_key="authKey",
        bgp_peer_id="bgpPeerId",
        customer_address="customerAddress"
    )],
    connection_id="connectionId",
    direct_connect_gateway_id="directConnectGatewayId",
    virtual_interface_name="virtualInterfaceName",
    vlan=123,

    # the properties below are optional
    allocate_transit_virtual_interface_role_arn="allocateTransitVirtualInterfaceRoleArn",
    enable_site_link=False,
    mtu=123,
    rate_limit="rateLimit",
    tags=[CfnTag(
        key="key",
        value="value"
    )]
)
java
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import software.amazon.awscdk.services.directconnect.*;

CfnTransitVirtualInterfaceProps cfnTransitVirtualInterfaceProps = CfnTransitVirtualInterfaceProps.builder()
        .bgpPeers(List.of(BgpPeerProperty.builder()
                .addressFamily("addressFamily")
                .asn("asn")

                // the properties below are optional
                .amazonAddress("amazonAddress")
                .authKey("authKey")
                .bgpPeerId("bgpPeerId")
                .customerAddress("customerAddress")
                .build()))
        .connectionId("connectionId")
        .directConnectGatewayId("directConnectGatewayId")
        .virtualInterfaceName("virtualInterfaceName")
        .vlan(123)

        // the properties below are optional
        .allocateTransitVirtualInterfaceRoleArn("allocateTransitVirtualInterfaceRoleArn")
        .enableSiteLink(false)
        .mtu(123)
        .rateLimit("rateLimit")
        .tags(List.of(CfnTag.builder()
                .key("key")
                .value("value")
                .build()))
        .build();
csharp
// Install: dotnet add package Amazon.CDK.Lib
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.DirectConnect;

var cfnTransitVirtualInterfaceProps = new CfnTransitVirtualInterfaceProps {
    BgpPeers = new [] { new BgpPeerProperty {
        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 = new [] { new CfnTag {
        Key = "key",
        Value = "value"
    } }
};
go
// Install: go get github.com/aws/aws-cdk-go/awscdk/v2
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"

cfnTransitVirtualInterfaceProps := &CfnTransitVirtualInterfaceProps{
	BgpPeers: []interface{}{
		&BgpPeerProperty{
			AddressFamily: jsii.String("addressFamily"),
			Asn: jsii.String("asn"),

			// the properties below are optional
			AmazonAddress: jsii.String("amazonAddress"),
			AuthKey: jsii.String("authKey"),
			BgpPeerId: jsii.String("bgpPeerId"),
			CustomerAddress: jsii.String("customerAddress"),
		},
	},
	ConnectionId: jsii.String("connectionId"),
	DirectConnectGatewayId: jsii.String("directConnectGatewayId"),
	VirtualInterfaceName: jsii.String("virtualInterfaceName"),
	Vlan: jsii.Number(123),

	// the properties below are optional
	AllocateTransitVirtualInterfaceRoleArn: jsii.String("allocateTransitVirtualInterfaceRoleArn"),
	EnableSiteLink: jsii.Boolean(false),
	Mtu: jsii.Number(123),
	RateLimit: jsii.String("rateLimit"),
	Tags: []CfnTag{
		&CfnTag{
			Key: jsii.String("key"),
			Value: jsii.String("value"),
		},
	},
}

Properties ​

allocateTransitVirtualInterfaceRoleArnoptionalstringallocate_transit_virtual_interface_role_arnoptionalstrallocateTransitVirtualInterfaceRoleArnoptionalStringAllocateTransitVirtualInterfaceRoleArnoptionalstringAllocateTransitVirtualInterfaceRoleArnoptional*string #
The Amazon Resource Name (ARN) of the role to allocate the TransitVifAllocation.

Needs directconnect:AllocateTransitVirtualInterface permissions and tag permissions if applicable.

bgpPeersIResolvable | IResolvable | CfnTransitVirtualInterface.BgpPeerProperty[]bgp_peerstyping.Union[IResolvable, typing.List[typing.Union[IResolvable, BgpPeerProperty]]]bgpPeersIResolvableBgpPeersIResolvableBgpPeersinterface{} required #
The BGP peers configured on this virtual interface..
connectionIdstring | IConnectionRef | ILagRefconnection_idtyping.Union[str, IConnectionRef, ILagRef]connectionIdStringConnectionIdstringConnectionIdinterface{} required #
directConnectGatewayIdstring | IDirectConnectGatewayRefdirect_connect_gateway_idtyping.Union[str, IDirectConnectGatewayRef]directConnectGatewayIdStringDirectConnectGatewayIdstringDirectConnectGatewayIdinterface{} required #
mtuoptionalnumbermtuoptionalint | floatmtuoptionalNumberMtuoptionaldoubleMtuoptional*float64 #
The maximum transmission unit (MTU), in bytes.

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

rateLimitoptionalstringrate_limitoptionalstrrateLimitoptionalStringRateLimitoptionalstringRateLimitoptional*string #
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.

tagsoptionalCfnTag[]tagsoptionaltyping.List[CfnTag]tagsoptionalList<CfnTag>TagsoptionalCfnTag[]Tagsoptional*[]CfnTag #
The tags associated with the private virtual interface.
virtualInterfaceNamestringvirtual_interface_namestrvirtualInterfaceNameStringVirtualInterfaceNamestringVirtualInterfaceName*string required #
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 (-).

vlannumbervlanint | floatvlanNumberVlandoubleVlan*float64 required #
The ID of the VLAN.