CfnPrivateVirtualInterfaceMixinProps

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

Bases: object

Properties for CfnPrivateVirtualInterfacePropsMixin.

Parameters:

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.
bgp_peers (Union[IResolvable, Sequence[Union[IResolvable, BgpPeerProperty, Dict[str, Any]]], None]) – The BGP peers configured on this virtual interface.
connection_id (Union[str, IConnectionRef, ILagRef, None])
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.
rate_limit (Optional[str]) – The rate limit (bandwidth allocation) for the virtual interface. The value must be one of the supported bandwidth values (e.g., 50Mbps, 1Gbps, 10Gbps) and cannot exceed the bandwidth of the parent connection or LAG.
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.
virtual_interface_name (Optional[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, None]) – The ID of the VLAN.

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.cfn_property_mixins import aws_directconnect as directconnect

cfn_private_virtual_interface_mixin_props = directconnect.CfnPrivateVirtualInterfaceMixinProps(
    allocate_private_virtual_interface_role_arn="allocatePrivateVirtualInterfaceRoleArn",
    bgp_peers=[directconnect.CfnPrivateVirtualInterfacePropsMixin.BgpPeerProperty(
        address_family="addressFamily",
        amazon_address="amazonAddress",
        asn="asn",
        auth_key="authKey",
        bgp_peer_id="bgpPeerId",
        customer_address="customerAddress"
    )],
    connection_id="connectionId",
    direct_connect_gateway_id="directConnectGatewayId",
    enable_site_link=False,
    mtu=123,
    rate_limit="rateLimit",
    tags=[CfnTag(
        key="key",
        value="value"
    )],
    virtual_gateway_id="virtualGatewayId",
    virtual_interface_name="virtualInterfaceName",
    vlan=123
)

Attributes

allocate_private_virtual_interface_role_arn

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

Needs directconnect:AllocatePrivateVirtualInterface permissions and tag permissions if applicable.

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

bgp_peers

The BGP peers configured on this virtual interface.

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

connection_id

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

Type:: see

direct_connect_gateway_id

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

Type:: see

enable_site_link

Indicates whether to enable or disable SiteLink.

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

mtu

The maximum transmission unit (MTU), in bytes.

The supported values are 1500 and 9001. The default value is 1500.

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

rate_limit

The rate limit (bandwidth allocation) for the virtual interface.

The value must be one of the supported bandwidth values (e.g., 50Mbps, 1Gbps, 10Gbps) and cannot exceed the bandwidth of the parent connection or LAG.

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

tags

The tags associated with the private virtual interface.

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

virtual_gateway_id

The ID or ARN of the virtual private gateway.

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

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-privatevirtualinterface.html#cfn-directconnect-privatevirtualinterface-virtualinterfacename

vlan

The ID of the VLAN.

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