CfnPublicVirtualInterfacePropsMixin

class aws_cdk.cfn_property_mixins.aws_directconnect.CfnPublicVirtualInterfacePropsMixin(props, *, strategy=None)

Bases: Mixin

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

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-directconnect-publicvirtualinterface.html
CloudformationResource:: AWS::DirectConnect::PublicVirtualInterface
Mixin:: true
ExampleMetadata:: fixture=_generated

Example:

# 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
import aws_cdk as cdk

# merge_strategy: cdk.IMergeStrategy

cfn_public_virtual_interface_props_mixin = directconnect.CfnPublicVirtualInterfacePropsMixin(directconnect.CfnPublicVirtualInterfaceMixinProps(
    allocate_public_virtual_interface_role_arn="allocatePublicVirtualInterfaceRoleArn",
    bgp_peers=[directconnect.CfnPublicVirtualInterfacePropsMixin.BgpPeerProperty(
        address_family="addressFamily",
        amazon_address="amazonAddress",
        asn="asn",
        auth_key="authKey",
        bgp_peer_id="bgpPeerId",
        customer_address="customerAddress"
    )],
    connection_id="connectionId",
    route_filter_prefixes=["routeFilterPrefixes"],
    tags=[cdk.CfnTag(
        key="key",
        value="value"
    )],
    virtual_interface_name="virtualInterfaceName",
    vlan=123
),
    strategy=merge_strategy
)

Create a mixin to apply properties to AWS::DirectConnect::PublicVirtualInterface.

Parameters:

props (Union[CfnPublicVirtualInterfaceMixinProps, Dict[str, Any]]) – L1 properties to apply.
strategy (Optional[IMergeStrategy]) – Strategy for merging nested properties. Default: - PropertyMergeStrategy.combine()

Methods

apply_to(construct)

Apply the mixin properties to the construct.

Parameters:: construct (IConstruct)
Return type:: None

supports(construct)

Check if this mixin supports the given construct.

Parameters:: construct (IConstruct)
Return type:: bool

Attributes

CFN_PROPERTY_KEYS = ['allocatePublicVirtualInterfaceRoleArn', 'bgpPeers', 'connectionId', 'routeFilterPrefixes', 'tags', 'virtualInterfaceName', 'vlan']

Static Methods

classmethod is_mixin(x)

Checks if x is a Mixin.

Parameters:: x (Any) – Any object.
Return type:: bool
Returns:: true if x is an object created from a class which extends Mixin.

BgpPeerProperty

class CfnPublicVirtualInterfacePropsMixin.BgpPeerProperty(*, address_family=None, amazon_address=None, asn=None, auth_key=None, bgp_peer_id=None, customer_address=None)

Bases: object

Information about a BGP peer.

Parameters:

address_family (Optional[str]) – The address family for the BGP peer.
amazon_address (Optional[str]) – The IP address assigned to the Amazon interface.
asn (Optional[str]) – The autonomous system (AS) number for Border Gateway Protocol (BGP) configuration.
auth_key (Optional[str]) – The authentication key for BGP configuration. This string has a minimum length of 6 characters and and a maximum length of 80 characters.
bgp_peer_id (Optional[str])
customer_address (Optional[str]) – The IP address assigned to the customer interface.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-directconnect-publicvirtualinterface-bgppeer.html

ExampleMetadata:

fixture=_generated

Example:

# 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

bgp_peer_property = directconnect.CfnPublicVirtualInterfacePropsMixin.BgpPeerProperty(
    address_family="addressFamily",
    amazon_address="amazonAddress",
    asn="asn",
    auth_key="authKey",
    bgp_peer_id="bgpPeerId",
    customer_address="customerAddress"
)