EC2 / Client / modify_route_server

modify_route_server

EC2.Client.modify_route_server(**kwargs)

Modifies the configuration of an existing route server.

Amazon VPC Route Server simplifies routing for traffic between workloads that are deployed within a VPC and its internet gateways. With this feature, VPC Route Server dynamically updates VPC and gateway route tables with your preferred IPv4 or IPv6 routes to achieve routing fault tolerance for those workloads. This enables you to automatically reroute traffic within a VPC, which increases the manageability of VPC routing and interoperability with third-party workloads.

Route server supports the follow route table types:

  • VPC route tables

  • Subnet route tables

  • Internet gateway route tables

Route server does not support route tables associated with virtual private gateways. To propagate routes into a transit gateway route table, use Transit Gateway Connect.

For more information see Dynamic routing in your VPC with VPC Route Server in the Amazon VPC User Guide.

See also: AWS API Documentation

Request Syntax

response = client.modify_route_server(
    RouteServerId='string',
    PersistRoutes='enable'|'disable'|'reset',
    PersistRoutesDuration=123,
    SnsNotificationsEnabled=True|False,
    DryRun=True|False
)
Parameters:

  • RouteServerId (string) –

    [REQUIRED]

    The ID of the route server to modify.

  • PersistRoutes (string) –

    Specifies whether to persist routes after all BGP sessions are terminated.

    • enable: Routes will be persisted in FIB and RIB after all BGP sessions are terminated.

    • disable: Routes will not be persisted in FIB and RIB after all BGP sessions are terminated.

    • reset: If a route server has persisted routes due to all BGP sessions having ended, reset will withdraw all routes and reset route server to an empty FIB and RIB.

  • PersistRoutesDuration (integer) –

    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. Required if PersistRoutes 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.

  • SnsNotificationsEnabled (boolean) – Specifies whether to enable SNS notifications for route server events. Enabling SNS notifications persists BGP status changes to an SNS topic provisioned by Amazon Web Services.

  • DryRun (boolean) – A check for whether you have the required permissions for the action without actually making the request and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

Return type:

dict

Returns:

Response Syntax

{
    'RouteServer': {
        'RouteServerId': 'string',
        'AmazonSideAsn': 123,
        'State': 'pending'|'available'|'modifying'|'deleting'|'deleted',
        'Tags': [
            {
                'Key': 'string',
                'Value': 'string'
            },
        ],
        'PersistRoutesState': 'enabling'|'enabled'|'resetting'|'disabling'|'disabled'|'modifying',
        'PersistRoutesDuration': 123,
        'SnsNotificationsEnabled': True|False,
        'SnsTopicArn': 'string'
    }
}

Response Structure

  • (dict) –

    • RouteServer (dict) –

      Information about the modified route server.

      • RouteServerId (string) –

        The unique identifier of the route server.

      • AmazonSideAsn (integer) –

        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.

      • State (string) –

        The current state of the route server.

      • Tags (list) –

        Any tags assigned to the route server.

        • (dict) –

          Describes a tag.

          • Key (string) –

            The key of the tag.

            Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with aws:.

          • Value (string) –

            The value of the tag.

            Constraints: Tag values are case-sensitive and accept a maximum of 256 Unicode characters.

      • PersistRoutesState (string) –

        The current state of route persistence for the route server.

      • PersistRoutesDuration (integer) –

        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.

      • SnsNotificationsEnabled (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.

      • SnsTopicArn (string) –

        The ARN of the SNS topic where notifications are published.