Create Route Server Peer

ec2_create_route_server_peer

R Documentation

Creates a new BGP peer for a specified route server endpoint

Description

Creates a new BGP peer for a specified route server endpoint.

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_create_route_server_peer(RouteServerEndpointId, PeerAddress,
  BgpOptions, DryRun, TagSpecifications)

Arguments

RouteServerEndpointId	[required] The ID of the route server endpoint for which to create a peer.
PeerAddress	[required] The IPv4 address of the peer device.
BgpOptions	[required] The BGP options for the peer, including ASN (Autonomous System Number) and BFD (Bidrectional Forwarding Detection) settings.
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.
TagSpecifications	The tags to apply to the route server peer during creation.

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$create_route_server_peer(
  RouteServerEndpointId = "string",
  PeerAddress = "string",
  BgpOptions = list(
    PeerAsn = 123,
    PeerLivenessDetection = "bfd"|"bgp-keepalive"
  ),
  DryRun = TRUE|FALSE,
  TagSpecifications = list(
    list(
      ResourceType = "capacity-reservation"|"client-vpn-endpoint"|"customer-gateway"|"carrier-gateway"|"coip-pool"|"declarative-policies-report"|"dedicated-host"|"dhcp-options"|"egress-only-internet-gateway"|"elastic-ip"|"elastic-gpu"|"export-image-task"|"export-instance-task"|"fleet"|"fpga-image"|"host-reservation"|"image"|"import-image-task"|"import-snapshot-task"|"instance"|"instance-event-window"|"internet-gateway"|"ipam"|"ipam-pool"|"ipam-scope"|"ipv4pool-ec2"|"ipv6pool-ec2"|"key-pair"|"launch-template"|"local-gateway"|"local-gateway-route-table"|"local-gateway-virtual-interface"|"local-gateway-virtual-interface-group"|"local-gateway-route-table-vpc-association"|"local-gateway-route-table-virtual-interface-group-association"|"natgateway"|"network-acl"|"network-interface"|"network-insights-analysis"|"network-insights-path"|"network-insights-access-scope"|"network-insights-access-scope-analysis"|"outpost-lag"|"placement-group"|"prefix-list"|"replace-root-volume-task"|"reserved-instances"|"route-table"|"security-group"|"security-group-rule"|"service-link-virtual-interface"|"snapshot"|"spot-fleet-request"|"spot-instances-request"|"subnet"|"subnet-cidr-reservation"|"traffic-mirror-filter"|"traffic-mirror-session"|"traffic-mirror-target"|"transit-gateway"|"transit-gateway-attachment"|"transit-gateway-connect-peer"|"transit-gateway-multicast-domain"|"transit-gateway-policy-table"|"transit-gateway-route-table"|"transit-gateway-route-table-announcement"|"volume"|"vpc"|"vpc-endpoint"|"vpc-endpoint-connection"|"vpc-endpoint-service"|"vpc-endpoint-service-permission"|"vpc-peering-connection"|"vpn-connection"|"vpn-gateway"|"vpc-flow-log"|"capacity-reservation-fleet"|"traffic-mirror-filter-rule"|"vpc-endpoint-connection-device-type"|"verified-access-instance"|"verified-access-group"|"verified-access-endpoint"|"verified-access-policy"|"verified-access-trust-provider"|"vpn-connection-device-type"|"vpc-block-public-access-exclusion"|"route-server"|"route-server-endpoint"|"route-server-peer"|"ipam-resource-discovery"|"ipam-resource-discovery-association"|"instance-connect-endpoint"|"verified-access-endpoint-target"|"ipam-external-resource-verification-token",
      Tags = list(
        list(
          Key = "string",
          Value = "string"
        )
      )
    )
  )
)