Describe Route Servers

ec2_describe_route_servers

R Documentation

Describes one or more route servers

Description

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 internet 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 not associated with subnets

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

Usage

ec2_describe_route_servers(RouteServerIds, NextToken, MaxResults,
  Filters, DryRun)

Arguments

RouteServerIds	The IDs of the route servers to describe.
NextToken	The token for the next page of results.
MaxResults	The maximum number of results to return with a single call.
Filters	One or more filters to apply to the describe request.
DryRun	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.

Value

A list with the following syntax:

list(
  RouteServers = list(
    list(
      RouteServerId = "string",
      AmazonSideAsn = 123,
      State = "pending"|"available"|"modifying"|"deleting"|"deleted",
      Tags = list(
        list(
          Key = "string",
          Value = "string"
        )
      ),
      PersistRoutesState = "enabling"|"enabled"|"resetting"|"disabling"|"disabled"|"modifying",
      PersistRoutesDuration = 123,
      SnsNotificationsEnabled = TRUE|FALSE,
      SnsTopicArn = "string"
    )
  ),
  NextToken = "string"
)

Request syntax

svc$describe_route_servers(
  RouteServerIds = list(
    "string"
  ),
  NextToken = "string",
  MaxResults = 123,
  Filters = list(
    list(
      Name = "string",
      Values = list(
        "string"
      )
    )
  ),
  DryRun = TRUE|FALSE
)