Package software.amazon.awscdk.cfnpropertymixins.services.directconnect

Interface CfnPublicVirtualInterfaceMixinProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnPublicVirtualInterfaceMixinProps.Jsii$Proxy

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

Properties for CfnPublicVirtualInterfacePropsMixin.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.cfnpropertymixins.services.directconnect.*;
 CfnPublicVirtualInterfaceMixinProps cfnPublicVirtualInterfaceMixinProps = CfnPublicVirtualInterfaceMixinProps.builder()
         .allocatePublicVirtualInterfaceRoleArn("allocatePublicVirtualInterfaceRoleArn")
         .bgpPeers(List.of(BgpPeerProperty.builder()
                 .addressFamily("addressFamily")
                 .amazonAddress("amazonAddress")
                 .asn("asn")
                 .authKey("authKey")
                 .bgpPeerId("bgpPeerId")
                 .customerAddress("customerAddress")
                 .build()))
         .connectionId("connectionId")
         .routeFilterPrefixes(List.of("routeFilterPrefixes"))
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .virtualInterfaceName("virtualInterfaceName")
         .vlan(123)
         .build();
 

See Also:

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

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static CfnPublicVirtualInterfaceMixinProps.Builder	builder()
default String	getAllocatePublicVirtualInterfaceRoleArn()	The Amazon Resource Name (ARN) of the role to allocate the public virtual interface.
default Object	getBgpPeers()	The BGP peers configured on this virtual interface.
default Object	getConnectionId()	Returns union: either String or IConnectionRef or ILagRef
default List<String>	getRouteFilterPrefixes()	The routes to be advertised to the AWS network in this region.
default List<CfnTag>	getTags()	The tags associated with the public virtual interface.
default String	getVirtualInterfaceName()	The name of the virtual interface assigned by the customer network.
default Number	getVlan()	The ID of the VLAN.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getAllocatePublicVirtualInterfaceRoleArn

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

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

getBgpPeers

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

The BGP peers configured on this virtual interface.

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

See Also:

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

getConnectionId

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

Returns union: either String or IConnectionRef or ILagRef

See Also:

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

getRouteFilterPrefixes

@Stability(Stable)
@Nullable
default List<String> getRouteFilterPrefixes()

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

getTags

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

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

getVirtualInterfaceName

@Stability(Stable)
@Nullable
default 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-publicvirtualinterface.html#cfn-directconnect-publicvirtualinterface-virtualinterfacename

getVlan

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

The ID of the VLAN.

See Also:

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

builder

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

Returns:

a CfnPublicVirtualInterfaceMixinProps.Builder of CfnPublicVirtualInterfaceMixinProps