CfnPrivateVirtualInterfaceProps

class aws_cdk.aws_directconnect.CfnPrivateVirtualInterfaceProps(*, bgp_peers, connection_id, virtual_interface_name, vlan, allocate_private_virtual_interface_role_arn=None, direct_connect_gateway_id=None, enable_site_link=None, mtu=None, tags=None, virtual_gateway_id=None)

Bases: object

Properties for defining a CfnPrivateVirtualInterface.

Parameters:

bgp_peers (Union[IResolvable, Sequence[Union[IResolvable, BgpPeerProperty, Dict[str, Any]]]]) – The BGP peers configured on this virtual interface.
connection_id (Union[str, IConnectionRef, ILagRef])
virtual_interface_name (str) – 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 (-).
vlan (Union[int, float]) – The ID of the VLAN.
allocate_private_virtual_interface_role_arn (Optional[str]) – The Amazon Resource Name (ARN) of the role to allocate the private virtual interface. Needs directconnect:AllocatePrivateVirtualInterface permissions and tag permissions if applicable.
direct_connect_gateway_id (Union[str, IDirectConnectGatewayRef, None])
enable_site_link (Union[bool, IResolvable, None]) – Indicates whether to enable or disable SiteLink.
mtu (Union[int, float, None]) – The maximum transmission unit (MTU), in bytes. The supported values are 1500 and 9001. The default value is 1500.
tags (Optional[Sequence[Union[CfnTag, Dict[str, Any]]]]) – The tags associated with the private virtual interface.
virtual_gateway_id (Optional[str]) – The ID or ARN of the virtual private gateway.

See:

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

ExampleMetadata:

fixture=_generated

Example:

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,
    tags=[CfnTag(
        key="key",
        value="value"
    )],
    virtual_gateway_id="virtualGatewayId"
)