Skip to content

Deletes the specified BGP peer from a route server

Description

Deletes the specified BGP peer from a route server.

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

Usage

ec2_delete_route_server_peer(RouteServerPeerId, DryRun)

Arguments

  • RouteServerPeerId

    [required] The ID of the route server peer to delete.

  • 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(
  RouteServerPeer = 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"
      )
    )
  )
)

Request syntax

svc$delete_route_server_peer(
  RouteServerPeerId = "string",
  DryRun = TRUE|FALSE
)