Package software.amazon.awscdk.services.directconnect

Interface CfnPrivateVirtualInterfaceProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnPrivateVirtualInterfaceProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.127.0 (build 2117ad5)",
           date="2026-03-11T13:19:41.942Z")
@Stability(Stable)
public interface CfnPrivateVirtualInterfaceProps
extends software.amazon.jsii.JsiiSerializable

Properties for defining a CfnPrivateVirtualInterface.

Example:

 // 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)
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .virtualGatewayId("virtualGatewayId")
         .build();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-directconnect-privatevirtualinterface.html

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnPrivateVirtualInterfaceProps.Builder	A builder for CfnPrivateVirtualInterfaceProps
static final class	CfnPrivateVirtualInterfaceProps.Jsii$Proxy	An implementation for CfnPrivateVirtualInterfaceProps

Method Summary

Modifier and Type	Method	Description
static CfnPrivateVirtualInterfaceProps.Builder	builder()
default String	getAllocatePrivateVirtualInterfaceRoleArn()	The Amazon Resource Name (ARN) of the role to allocate the private virtual interface.
Object	getBgpPeers()	The BGP peers configured on this virtual interface.
Object	getConnectionId()	Returns union: either String or IConnectionRef or ILagRef
default Object	getDirectConnectGatewayId()	Returns union: either String or IDirectConnectGatewayRef
default Object	getEnableSiteLink()	Indicates whether to enable or disable SiteLink.
default Number	getMtu()	The maximum transmission unit (MTU), in bytes.
default List<CfnTag>	getTags()	The tags associated with the private virtual interface.
default String	getVirtualGatewayId()	The ID or ARN of the virtual private gateway.
String	getVirtualInterfaceName()	The name of the virtual interface assigned by the customer network.
Number	getVlan()	The ID of the VLAN.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getBgpPeers

@Stability(Stable)
@NotNull
Object getBgpPeers()

The BGP peers configured on this virtual interface.

Returns union: either IResolvable or Listinvalid input: '<'either IResolvable or CfnPrivateVirtualInterface.BgpPeerProperty>

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-directconnect-privatevirtualinterface.html#cfn-directconnect-privatevirtualinterface-bgppeers

getConnectionId

@Stability(Stable)
@NotNull
Object getConnectionId()

Returns union: either String or IConnectionRef or ILagRef

See Also:

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

getVirtualInterfaceName

@Stability(Stable)
@NotNull
String getVirtualInterfaceName()

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

getVlan

@Stability(Stable)
@NotNull
Number getVlan()

The ID of the VLAN.

See Also:

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

getAllocatePrivateVirtualInterfaceRoleArn

@Stability(Stable)
@Nullable
default String getAllocatePrivateVirtualInterfaceRoleArn()

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

getDirectConnectGatewayId

@Stability(Stable)
@Nullable
default Object getDirectConnectGatewayId()

Returns union: either String or IDirectConnectGatewayRef

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-directconnect-privatevirtualinterface.html#cfn-directconnect-privatevirtualinterface-directconnectgatewayid

getEnableSiteLink

@Stability(Stable)
@Nullable
default Object getEnableSiteLink()

Indicates whether to enable or disable SiteLink.

Returns union: either Boolean or IResolvable

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-directconnect-privatevirtualinterface.html#cfn-directconnect-privatevirtualinterface-enablesitelink

getMtu

@Stability(Stable)
@Nullable
default Number getMtu()

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

getTags

@Stability(Stable)
@Nullable
default List<CfnTag> getTags()

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

getVirtualGatewayId

@Stability(Stable)
@Nullable
default String getVirtualGatewayId()

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

builder

@Stability(Stable)
static CfnPrivateVirtualInterfaceProps.Builder builder()

Returns:

a CfnPrivateVirtualInterfaceProps.Builder of CfnPrivateVirtualInterfaceProps