CfnPublicVirtualInterfaceProps

class aws_cdk.aws_directconnect.CfnPublicVirtualInterfaceProps(*, bgp_peers, connection_id, virtual_interface_name, vlan, allocate_public_virtual_interface_role_arn=None, route_filter_prefixes=None, tags=None)

Bases: object

Properties for defining a CfnPublicVirtualInterface.

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_public_virtual_interface_role_arn (Optional[str]) – The Amazon Resource Name (ARN) of the role to allocate the public virtual interface. Needs directconnect:AllocatePublicVirtualInterface permissions and tag permissions if applicable.

  • route_filter_prefixes (Optional[Sequence[str]]) – The routes to be advertised to the AWS network in this region.

  • tags (Optional[Sequence[Union[CfnTag, Dict[str, Any]]]]) – The tags associated with the public virtual interface.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-directconnect-publicvirtualinterface.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_public_virtual_interface_props = directconnect.CfnPublicVirtualInterfaceProps(
    bgp_peers=[directconnect.CfnPublicVirtualInterface.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_public_virtual_interface_role_arn="allocatePublicVirtualInterfaceRoleArn",
    route_filter_prefixes=["routeFilterPrefixes"],
    tags=[CfnTag(
        key="key",
        value="value"
    )]
)

Attributes

allocate_public_virtual_interface_role_arn

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

Needs directconnect:AllocatePublicVirtualInterface permissions and tag permissions if applicable.

See:

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

bgp_peers

The BGP peers configured on this virtual interface.

See:

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

connection_id

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

Type:

see

route_filter_prefixes

The routes to be advertised to the AWS network in this region.

See:

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

tags

The tags associated with the public virtual interface.

See:

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

virtual_interface_name

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:

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

vlan

The ID of the VLAN.

See:

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