Skip to content

EC2  >  Operations  >  create_route_server_peer

create_route_server_peer

Operation

create_route_server_peer async 

create_route_server_peer(input: CreateRouteServerPeerInput, plugins: list[Plugin] | None = None) -> CreateRouteServerPeerOutput

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.

Parameters:

Name Type Description Default
input CreateRouteServerPeerInput

An instance of CreateRouteServerPeerInput.

 required
plugins list[Plugin] | None

A list of callables that modify the configuration dynamically. Changes made by these plugins only apply for the duration of the operation execution and will not affect any other operation invocations.

 None

Returns:

Type Description
CreateRouteServerPeerOutput

An instance of CreateRouteServerPeerOutput.

Input

CreateRouteServerPeerInput dataclass

Bases: _SerdeShape

Dataclass for CreateRouteServerPeerInput structure.

Attributes

bgp_options class-attribute instance-attribute 
bgp_options: RouteServerBgpOptionsRequest | None = ...

The BGP options for the peer, including ASN (Autonomous System Number) and BFD (Bidrectional Forwarding Detection) settings.

dry_run class-attribute instance-attribute 
dry_run: bool | None = ...

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.

peer_address class-attribute instance-attribute 
peer_address: str | None = ...

The IPv4 address of the peer device.

route_server_endpoint_id class-attribute instance-attribute 
route_server_endpoint_id: str | None = ...

The ID of the route server endpoint for which to create a peer.

tag_specifications class-attribute instance-attribute 
tag_specifications: list[TagSpecification] | None = ...

The tags to apply to the route server peer during creation.

Output

CreateRouteServerPeerOutput dataclass

Bases: _SerdeShape

Dataclass for CreateRouteServerPeerOutput structure.

Attributes

response_metadata class-attribute instance-attribute 
response_metadata: ResponseMetadata = ...

Metadata about the response that produced this output. Use this to recover the request identifiers a service's support team needs in order to investigate a call. Members of the metadata are individually optional.

route_server_peer class-attribute instance-attribute 
route_server_peer: RouteServerPeer | None = ...

Information about the created route server peer.