Package software.amazon.awscdk.services.directconnect

Class CfnPrivateVirtualInterface

java.lang.Object

software.amazon.jsii.JsiiObject

software.constructs.Construct

software.amazon.awscdk.CfnElement

software.amazon.awscdk.CfnRefElement

software.amazon.awscdk.CfnResource

software.amazon.awscdk.services.directconnect.CfnPrivateVirtualInterface

All Implemented Interfaces:

IInspectable, IPrivateVirtualInterfaceRef, IEnvironmentAware, ITaggableV2, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable

@Generated(value="jsii-pacmak/1.127.0 (build 2117ad5)",
           date="2026-03-11T13:19:41.941Z")
@Stability(Stable)
public class CfnPrivateVirtualInterface
extends CfnResource
implements IInspectable, IPrivateVirtualInterfaceRef, ITaggableV2

Resource Type definition for AWS::DirectConnect::PrivateVirtualInterface.

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.*;
 CfnPrivateVirtualInterface cfnPrivateVirtualInterface = CfnPrivateVirtualInterface.Builder.create(this, "MyCfnPrivateVirtualInterface")
         .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	Class	Description
static interface	CfnPrivateVirtualInterface.BgpPeerProperty	Information about a BGP peer.
static final class	CfnPrivateVirtualInterface.Builder	A fluent builder for CfnPrivateVirtualInterface.

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.constructs.IConstruct

software.constructs.IConstruct.Jsii$Default

Nested classes/interfaces inherited from interface software.amazon.awscdk.IInspectable

IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

Nested classes/interfaces inherited from interface software.amazon.awscdk.interfaces.directconnect.IPrivateVirtualInterfaceRef

IPrivateVirtualInterfaceRef.Jsii$Default, IPrivateVirtualInterfaceRef.Jsii$Proxy

Nested classes/interfaces inherited from interface software.amazon.awscdk.ITaggableV2

ITaggableV2.Jsii$Default, ITaggableV2.Jsii$Proxy

Field Summary

Fields

Modifier and Type	Field	Description
static final String	CFN_RESOURCE_TYPE_NAME	The CloudFormation resource type name for this resource class.

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	CfnPrivateVirtualInterface(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnPrivateVirtualInterface(software.amazon.jsii.JsiiObjectRef objRef)
	CfnPrivateVirtualInterface(software.constructs.Construct scope, String id, CfnPrivateVirtualInterfaceProps props)	Create a new AWS::DirectConnect::PrivateVirtualInterface.

Method Summary

Modifier and Type	Method	Description
String	getAllocatePrivateVirtualInterfaceRoleArn()	The Amazon Resource Name (ARN) of the role to allocate the private virtual interface.
String	getAttrVirtualInterfaceArn()	The ID of the virtual interface.
String	getAttrVirtualInterfaceId()	The ID of the virtual interface.
Object	getBgpPeers()	The BGP peers configured on this virtual interface.
TagManager	getCdkTagManager()	Tag Manager which manages the tags for this resource.
protected Map<String,Object>	getCfnProperties()
String	getConnectionId()
String	getDirectConnectGatewayId()
Object	getEnableSiteLink()	Indicates whether to enable or disable SiteLink.
Number	getMtu()	The maximum transmission unit (MTU), in bytes.
PrivateVirtualInterfaceReference	getPrivateVirtualInterfaceRef()	A reference to a PrivateVirtualInterface resource.
List<CfnTag>	getTags()	The tags associated with the private virtual interface.
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.
void	inspect(TreeInspector inspector)	Examines the CloudFormation resource and discloses attributes.
static Boolean	isCfnPrivateVirtualInterface(Object x)	Checks whether the given object is a CfnPrivateVirtualInterface.
protected Map<String,Object>	renderProperties(Map<String,Object> props)
void	setAllocatePrivateVirtualInterfaceRoleArn(String value)	The Amazon Resource Name (ARN) of the role to allocate the private virtual interface.
void	setBgpPeers(List<Object> value)	The BGP peers configured on this virtual interface.
void	setBgpPeers(IResolvable value)	The BGP peers configured on this virtual interface.
void	setConnectionId(String value)
void	setDirectConnectGatewayId(String value)
void	setEnableSiteLink(Boolean value)	Indicates whether to enable or disable SiteLink.
void	setEnableSiteLink(IResolvable value)	Indicates whether to enable or disable SiteLink.
void	setMtu(Number value)	The maximum transmission unit (MTU), in bytes.
void	setTags(List<CfnTag> value)	The tags associated with the private virtual interface.
void	setVirtualGatewayId(String value)	The ID or ARN of the virtual private gateway.
void	setVirtualInterfaceName(String value)	The name of the virtual interface assigned by the customer network.
void	setVlan(Number value)	The ID of the VLAN.

Methods inherited from class software.amazon.awscdk.CfnResource

addDeletionOverride, addDependency, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getAtt, getCfnOptions, getCfnResourceType, getEnv, getMetadata, getUpdatedProperites, getUpdatedProperties, isCfnResource, obtainDependencies, obtainResourceDependencies, removeDependency, replaceDependency, shouldSynthesize, toString, validateProperties

Methods inherited from class software.amazon.awscdk.CfnRefElement

getRef

Methods inherited from class software.amazon.awscdk.CfnElement

getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId, with

Methods inherited from class software.constructs.Construct

getNode, isConstruct

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.constructs.IConstruct

getNode, with

Methods inherited from interface software.amazon.awscdk.interfaces.IEnvironmentAware

getEnv

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Field Details

CFN_RESOURCE_TYPE_NAME

@Stability(Stable)
public static final String CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

Constructor Details

CfnPrivateVirtualInterface

protected CfnPrivateVirtualInterface(software.amazon.jsii.JsiiObjectRef objRef)

CfnPrivateVirtualInterface

protected CfnPrivateVirtualInterface(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

CfnPrivateVirtualInterface

@Stability(Stable)
public CfnPrivateVirtualInterface(@NotNull
 software.constructs.Construct scope,
 @NotNull
 String id,
 @NotNull
 CfnPrivateVirtualInterfaceProps props)

Create a new AWS::DirectConnect::PrivateVirtualInterface.

Parameters:

scope - Scope in which this resource is defined. This parameter is required.

id - Construct identifier for this resource (unique in its scope). This parameter is required.

props - Resource properties. This parameter is required.

Method Details

isCfnPrivateVirtualInterface

@Stability(Stable)
@NotNull
public static Boolean isCfnPrivateVirtualInterface(@NotNull
 Object x)

Checks whether the given object is a CfnPrivateVirtualInterface.

Parameters:

x - This parameter is required.

inspect

@Stability(Stable)
public void inspect(@NotNull
 TreeInspector inspector)

Examines the CloudFormation resource and discloses attributes.

Specified by:

inspect in interface IInspectable

Parameters:

inspector - tree inspector to collect and process attributes. This parameter is required.

renderProperties

@Stability(Stable)
@NotNull
protected Map<String,Object> renderProperties(@NotNull
 Map<String,Object> props)

Overrides:

renderProperties in class CfnResource

Parameters:

props - This parameter is required.

getAttrVirtualInterfaceArn

@Stability(Stable)
@NotNull
public String getAttrVirtualInterfaceArn()

The ID of the virtual interface.

getAttrVirtualInterfaceId

@Stability(Stable)
@NotNull
public String getAttrVirtualInterfaceId()

The ID of the virtual interface.

getCdkTagManager

@Stability(Stable)
@NotNull
public TagManager getCdkTagManager()

Tag Manager which manages the tags for this resource.

Specified by:

getCdkTagManager in interface ITaggableV2

getCfnProperties

@Stability(Stable)
@NotNull
protected Map<String,Object> getCfnProperties()

Overrides:

getCfnProperties in class CfnResource

getPrivateVirtualInterfaceRef

@Stability(Stable)
@NotNull
public PrivateVirtualInterfaceReference getPrivateVirtualInterfaceRef()

A reference to a PrivateVirtualInterface resource.

Specified by:

getPrivateVirtualInterfaceRef in interface IPrivateVirtualInterfaceRef

getBgpPeers

@Stability(Stable)
@NotNull
public Object getBgpPeers()

The BGP peers configured on this virtual interface.

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

setBgpPeers

@Stability(Stable)
public void setBgpPeers(@NotNull
 IResolvable value)

The BGP peers configured on this virtual interface.

setBgpPeers

@Stability(Stable)
public void setBgpPeers(@NotNull
 List<Object> value)

The BGP peers configured on this virtual interface.

getConnectionId

@Stability(Stable)
@NotNull
public String getConnectionId()

setConnectionId

@Stability(Stable)
public void setConnectionId(@NotNull
 String value)

getVirtualInterfaceName

@Stability(Stable)
@NotNull
public String getVirtualInterfaceName()

The name of the virtual interface assigned by the customer network.

setVirtualInterfaceName

@Stability(Stable)
public void setVirtualInterfaceName(@NotNull
 String value)

The name of the virtual interface assigned by the customer network.

getVlan

@Stability(Stable)
@NotNull
public Number getVlan()

The ID of the VLAN.

setVlan

@Stability(Stable)
public void setVlan(@NotNull
 Number value)

The ID of the VLAN.

getAllocatePrivateVirtualInterfaceRoleArn

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

The Amazon Resource Name (ARN) of the role to allocate the private virtual interface.

setAllocatePrivateVirtualInterfaceRoleArn

@Stability(Stable)
public void setAllocatePrivateVirtualInterfaceRoleArn(@Nullable
 String value)

The Amazon Resource Name (ARN) of the role to allocate the private virtual interface.

getDirectConnectGatewayId

@Stability(Stable)
@Nullable
public String getDirectConnectGatewayId()

setDirectConnectGatewayId

@Stability(Stable)
public void setDirectConnectGatewayId(@Nullable
 String value)

getEnableSiteLink

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

Indicates whether to enable or disable SiteLink.

Returns union: either Boolean or IResolvable

setEnableSiteLink

@Stability(Stable)
public void setEnableSiteLink(@Nullable
 Boolean value)

Indicates whether to enable or disable SiteLink.

setEnableSiteLink

@Stability(Stable)
public void setEnableSiteLink(@Nullable
 IResolvable value)

Indicates whether to enable or disable SiteLink.

getMtu

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

The maximum transmission unit (MTU), in bytes.

setMtu

@Stability(Stable)
public void setMtu(@Nullable
 Number value)

The maximum transmission unit (MTU), in bytes.

getTags

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

The tags associated with the private virtual interface.

setTags

@Stability(Stable)
public void setTags(@Nullable
 List<CfnTag> value)

The tags associated with the private virtual interface.

getVirtualGatewayId

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

The ID or ARN of the virtual private gateway.

setVirtualGatewayId

@Stability(Stable)
public void setVirtualGatewayId(@Nullable
 String value)

The ID or ARN of the virtual private gateway.