Skip to content

RouteServer

Source code in docs_src/capo_ec2/types/route_server.py
class RouteServer(TypedDict, closed=True):
    route_server_id: NotRequired["capo_ec2.types.route_server_id.RouteServerId"]
    """<p>The unique identifier of the route server.</p>"""
    amazon_side_asn: NotRequired["capo_ec2.types.long.Long"]
    """<p>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.</p>"""
    state: NotRequired["capo_ec2.types.route_server_state.RouteServerState"]
    """<p>The current state of the route server.</p>"""
    tags: NotRequired["capo_ec2.types.tag_list.TagList"]
    """<p>Any tags assigned to the route server.</p>"""
    persist_routes_state: NotRequired[
        "capo_ec2.types.route_server_persist_routes_state.RouteServerPersistRoutesState"
    ]
    """<p>The current state of route persistence for the route server.</p>"""
    persist_routes_duration: NotRequired["capo_ec2.types.boxed_long.BoxedLong"]
    """<p>The number of minutes a route server will wait after BGP is re-established to unpersist the routes in the FIB and RIB. Value must be in the range of 1-5. The default value is 1. Only valid if <code>persistRoutesState</code> is 'enabled'.</p> <p>If you set the duration to 1 minute, then when your network appliance re-establishes BGP with route server, it has 1 minute to relearn it's adjacent network and advertise those routes to route server before route server resumes normal functionality. In most cases, 1 minute is probably sufficient. If, however, you have concerns that your BGP network may not be capable of fully re-establishing and re-learning everything in 1 minute, you can increase the duration up to 5 minutes.</p>"""
    sns_notifications_enabled: NotRequired["capo_ec2.types.boolean.Boolean"]
    """<p>Indicates whether SNS notifications are enabled for the route server. Enabling SNS notifications persists BGP status changes to an SNS topic provisioned by Amazon Web Services.</p>"""
    sns_topic_arn: NotRequired["capo_ec2.types.string.String"]
    """<p>The ARN of the SNS topic where notifications are published.</p>"""

amazon_side_asn instance-attribute

amazon_side_asn: NotRequired[Long]

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.

persist_routes_duration instance-attribute

persist_routes_duration: NotRequired[BoxedLong]

The number of minutes a route server will wait after BGP is re-established to unpersist the routes in the FIB and RIB. Value must be in the range of 1-5. The default value is 1. Only valid if persistRoutesState is 'enabled'.

If you set the duration to 1 minute, then when your network appliance re-establishes BGP with route server, it has 1 minute to relearn it's adjacent network and advertise those routes to route server before route server resumes normal functionality. In most cases, 1 minute is probably sufficient. If, however, you have concerns that your BGP network may not be capable of fully re-establishing and re-learning everything in 1 minute, you can increase the duration up to 5 minutes.

persist_routes_state instance-attribute

persist_routes_state: NotRequired[RouteServerPersistRoutesState]

The current state of route persistence for the route server.

route_server_id instance-attribute

route_server_id: NotRequired[RouteServerId]

The unique identifier of the route server.

sns_notifications_enabled instance-attribute

sns_notifications_enabled: NotRequired[Boolean]

Indicates whether SNS notifications are enabled for the route server. Enabling SNS notifications persists BGP status changes to an SNS topic provisioned by Amazon Web Services.

sns_topic_arn instance-attribute

sns_topic_arn: NotRequired[String]

The ARN of the SNS topic where notifications are published.

state instance-attribute

state: NotRequired[RouteServerState]

The current state of the route server.

tags instance-attribute

tags: NotRequired[TagList]

Any tags assigned to the route server.