CfnRouteServerPeerPropsMixin

class aws_cdk.mixins_preview.aws_ec2.mixins.CfnRouteServerPeerPropsMixin(props, *, strategy=None)

Bases: Mixin

Specifies a BGP peer configuration for a route server endpoint.

A route server peer is a session between a route server endpoint and the device deployed in AWS (such as a firewall appliance or other network security function running on an EC2 instance).

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-routeserverpeer.html
CloudformationResource:: AWS::EC2::RouteServerPeer
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.mixins_preview import mixins
from aws_cdk.mixins_preview.aws_ec2 import mixins as ec2_mixins

cfn_route_server_peer_props_mixin = ec2_mixins.CfnRouteServerPeerPropsMixin(ec2_mixins.CfnRouteServerPeerMixinProps(
    bgp_options=ec2_mixins.CfnRouteServerPeerPropsMixin.BgpOptionsProperty(
        peer_asn=123,
        peer_liveness_detection="peerLivenessDetection"
    ),
    peer_address="peerAddress",
    route_server_endpoint_id="routeServerEndpointId",
    tags=[CfnTag(
        key="key",
        value="value"
    )]
),
    strategy=mixins.PropertyMergeStrategy.OVERRIDE
)

Create a mixin to apply properties to AWS::EC2::RouteServerPeer.

Parameters:

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

Methods

apply_to(construct)

Apply the mixin properties to the construct.

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

supports(construct)

Check if this mixin supports the given construct.

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

Attributes

CFN_PROPERTY_KEYS = ['bgpOptions', 'peerAddress', 'routeServerEndpointId', 'tags']

Static Methods

classmethod is_mixin(x)

(experimental) 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.
Stability:: experimental

BgpOptionsProperty

class CfnRouteServerPeerPropsMixin.BgpOptionsProperty(*, peer_asn=None, peer_liveness_detection=None)

Bases: object

The BGP configuration options for this peer, including ASN (Autonomous System Number) and BFD (Bidrectional Forwarding Detection) settings.

Parameters:

peer_asn (Union[int, float, None]) – The Border Gateway Protocol (BGP) Autonomous System Number (ASN) for the appliance. Valid values are from 1 to 4294967295. We recommend using a private ASN in the 64512–65534 (16-bit ASN) or 4200000000–4294967294 (32-bit ASN) range.
peer_liveness_detection (Optional[str]) – The liveness detection protocol used for the BGP peer. The requested liveness detection protocol for the BGP peer. - bgp-keepalive : The standard BGP keep alive mechanism ( RFC4271 ) that is stable but may take longer to fail-over in cases of network impact or router failure. - bfd : An additional Bidirectional Forwarding Detection (BFD) protocol ( RFC5880 ) that enables fast failover by using more sensitive liveness detection. Defaults to bgp-keepalive .

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-routeserverpeer-bgpoptions.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.mixins_preview.aws_ec2 import mixins as ec2_mixins

bgp_options_property = ec2_mixins.CfnRouteServerPeerPropsMixin.BgpOptionsProperty(
    peer_asn=123,
    peer_liveness_detection="peerLivenessDetection"
)

Attributes

peer_asn

The Border Gateway Protocol (BGP) Autonomous System Number (ASN) for the appliance.

Valid values are from 1 to 4294967295. We recommend using a private ASN in the 64512–65534 (16-bit ASN) or 4200000000–4294967294 (32-bit ASN) range.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-routeserverpeer-bgpoptions.html#cfn-ec2-routeserverpeer-bgpoptions-peerasn

peer_liveness_detection

The liveness detection protocol used for the BGP peer.

The requested liveness detection protocol for the BGP peer.

bgp-keepalive : The standard BGP keep alive mechanism ( RFC4271 ) that is stable but may take longer to fail-over in cases of network impact or router failure.
bfd : An additional Bidirectional Forwarding Detection (BFD) protocol ( RFC5880 ) that enables fast failover by using more sensitive liveness detection.

Defaults to bgp-keepalive .

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-routeserverpeer-bgpoptions.html#cfn-ec2-routeserverpeer-bgpoptions-peerlivenessdetection