EC2 / Client / describe_route_servers

describe_route_servers

EC2.Client.describe_route_servers(**kwargs)

Describes one or more route servers.

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.describe_route_servers(
    RouteServerIds=[
        'string',
    ],
    NextToken='string',
    MaxResults=123,
    Filters=[
        {
            'Name': 'string',
            'Values': [
                'string',
            ]
        },
    ],
    DryRun=True|False
)
Parameters:

  • RouteServerIds (list) –

    The IDs of the route servers to describe.

    • (string) –

  • NextToken (string) – The token for the next page of results.

  • MaxResults (integer) – The maximum number of results to return with a single call.

  • Filters (list) –

    One or more filters to apply to the describe request.

    • (dict) –

      A filter name and value pair that is used to return a more specific list of results from a describe operation. Filters can be used to match a set of resources by specific criteria, such as tags, attributes, or IDs.

      If you specify multiple filters, the filters are joined with an AND, and the request returns only results that match all of the specified filters.

      For more information, see List and filter using the CLI and API in the Amazon EC2 User Guide.

      • Name (string) –

        The name of the filter. Filter names are case-sensitive.

      • Values (list) –

        The filter values. Filter values are case-sensitive. If you specify multiple values for a filter, the values are joined with an OR, and the request returns all results that match any of the specified values.

        • (string) –

  • 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

{
    'RouteServers': [
        {
            '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'
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) –

    • RouteServers (list) –

      Information about the described route servers.

      • (dict) –

        Describes a route server and its configuration.

        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.

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

    • NextToken (string) –

      The token to use to retrieve the next page of results. This value is null when there are no more results to return.