Describe Route Server Peers

ec2_describe_route_server_peers

R Documentation

Describes one or more route server peers

Description

Describes one or more route server peers.

A route server peer is a session between a route server endpoint and the device deployed in Amazon Web Services (such as a firewall appliance or other network security function running on an EC2 instance). The device must meet these requirements:

• Have an elastic network interface in the VPC

• Support BGP (Border Gateway Protocol)

• Can initiate BGP sessions

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

Usage

ec2_describe_route_server_peers(RouteServerPeerIds, NextToken,
  MaxResults, Filters, DryRun)

Arguments

RouteServerPeerIds	The IDs of the route server peers 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(
  RouteServerPeers = list(
    list(
      RouteServerPeerId = "string",
      RouteServerEndpointId = "string",
      RouteServerId = "string",
      VpcId = "string",
      SubnetId = "string",
      State = "pending"|"available"|"deleting"|"deleted"|"failing"|"failed",
      FailureReason = "string",
      EndpointEniId = "string",
      EndpointEniAddress = "string",
      PeerAddress = "string",
      BgpOptions = list(
        PeerAsn = 123,
        PeerLivenessDetection = "bfd"|"bgp-keepalive"
      ),
      BgpStatus = list(
        Status = "up"|"down"
      ),
      BfdStatus = list(
        Status = "up"|"down"
      ),
      Tags = list(
        list(
          Key = "string",
          Value = "string"
        )
      )
    )
  ),
  NextToken = "string"
)

Request syntax

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