CfnPrivateVirtualInterfaceProps Struct
Properties for defining a CfnPrivateVirtualInterface.
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 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,
rateLimit: 'rateLimit',
tags: [{
key: 'key',
value: 'value',
}],
virtualGatewayId: 'virtualGatewayId',
};
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_private_virtual_interface_props = directconnect.CfnPrivateVirtualInterfaceProps(
bgp_peers=[directconnect.CfnPrivateVirtualInterface.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",
virtual_interface_name="virtualInterfaceName",
vlan=123,
# the properties below are optional
allocate_private_virtual_interface_role_arn="allocatePrivateVirtualInterfaceRoleArn",
direct_connect_gateway_id="directConnectGatewayId",
enable_site_link=False,
mtu=123,
rate_limit="rateLimit",
tags=[CfnTag(
key="key",
value="value"
)],
virtual_gateway_id="virtualGatewayId"
)
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.*;
CfnPrivateVirtualInterfaceProps cfnPrivateVirtualInterfaceProps = CfnPrivateVirtualInterfaceProps.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")
.virtualInterfaceName("virtualInterfaceName")
.vlan(123)
// the properties below are optional
.allocatePrivateVirtualInterfaceRoleArn("allocatePrivateVirtualInterfaceRoleArn")
.directConnectGatewayId("directConnectGatewayId")
.enableSiteLink(false)
.mtu(123)
.rateLimit("rateLimit")
.tags(List.of(CfnTag.builder()
.key("key")
.value("value")
.build()))
.virtualGatewayId("virtualGatewayId")
.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 cfnPrivateVirtualInterfaceProps = new CfnPrivateVirtualInterfaceProps {
BgpPeers = new [] { new BgpPeerProperty {
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,
RateLimit = "rateLimit",
Tags = new [] { new CfnTag {
Key = "key",
Value = "value"
} },
VirtualGatewayId = "virtualGatewayId"
};
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"
cfnPrivateVirtualInterfaceProps := &CfnPrivateVirtualInterfaceProps{
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"),
VirtualInterfaceName: jsii.String("virtualInterfaceName"),
Vlan: jsii.Number(123),
// the properties below are optional
AllocatePrivateVirtualInterfaceRoleArn: jsii.String("allocatePrivateVirtualInterfaceRoleArn"),
DirectConnectGatewayId: jsii.String("directConnectGatewayId"),
EnableSiteLink: jsii.Boolean(false),
Mtu: jsii.Number(123),
RateLimit: jsii.String("rateLimit"),
Tags: []CfnTag{
&CfnTag{
Key: jsii.String("key"),
Value: jsii.String("value"),
},
},
VirtualGatewayId: jsii.String("virtualGatewayId"),
}
Properties
allocatePrivateVirtualInterfaceRoleArnoptionalstringallocate_private_virtual_interface_role_arnoptionalstrallocatePrivateVirtualInterfaceRoleArnoptionalStringAllocatePrivateVirtualInterfaceRoleArnoptionalstringAllocatePrivateVirtualInterfaceRoleArnoptional*string#The Amazon Resource Name (ARN) of the role to allocate the private virtual interface.
Needs directconnect:AllocatePrivateVirtualInterface permissions and tag permissions if applicable.
bgpPeersIResolvable | IResolvable | CfnPrivateVirtualInterface.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#directConnectGatewayIdoptionalstring | IDirectConnectGatewayRefdirect_connect_gateway_idoptionaltyping.Union[str, IDirectConnectGatewayRef]directConnectGatewayIdoptionalStringDirectConnectGatewayIdoptionalstringDirectConnectGatewayIdoptionalinterface{}#enableSiteLinkoptionalboolean | IResolvableenable_site_linkoptionaltyping.Union[bool, IResolvable]enableSiteLinkoptionalBooleanEnableSiteLinkoptionalboolEnableSiteLinkoptionalinterface{}#Indicates whether to enable or disable SiteLink.
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.
virtualGatewayIdoptionalstringvirtual_gateway_idoptionalstrvirtualGatewayIdoptionalStringVirtualGatewayIdoptionalstringVirtualGatewayIdoptional*string#The ID or ARN of the virtual private gateway.
virtualInterfaceNamestringvirtual_interface_namestrvirtualInterfaceNameStringVirtualInterfaceNamestringVirtualInterfaceName*stringrequired#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 (-).
The ID of the VLAN.