Package software.amazon.awscdk.services.directconnect

Interface CfnPublicVirtualInterfaceProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnPublicVirtualInterfaceProps.Jsii$Proxy

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

Properties for defining a CfnPublicVirtualInterface.

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.*;
 CfnPublicVirtualInterfaceProps cfnPublicVirtualInterfaceProps = CfnPublicVirtualInterfaceProps.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
         .allocatePublicVirtualInterfaceRoleArn("allocatePublicVirtualInterfaceRoleArn")
         .routeFilterPrefixes(List.of("routeFilterPrefixes"))
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .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	CfnPublicVirtualInterfaceProps.Builder	A builder for CfnPublicVirtualInterfaceProps
static final class	CfnPublicVirtualInterfaceProps.Jsii$Proxy	An implementation for CfnPublicVirtualInterfaceProps

Method Summary

Modifier and Type	Method	Description
static CfnPublicVirtualInterfaceProps.Builder	builder()
default String	getAllocatePublicVirtualInterfaceRoleArn()	The Amazon Resource Name (ARN) of the role to allocate the public virtual interface.
Object	getBgpPeers()	The BGP peers configured on this virtual interface.
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.
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 CfnPublicVirtualInterface.BgpPeerProperty>

See Also:

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

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

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

builder

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

Returns:

a CfnPublicVirtualInterfaceProps.Builder of CfnPublicVirtualInterfaceProps