route_server_peers

Creates, updates, deletes, gets or lists a route_server_peers resource.

Overview

Name	route_server_peers
Type	Resource
Id	aws.ec2.route_server_peers

Fields

The following fields are returned by SELECT queries:

describe_route_server_peers

Name	Datatype	Description
bfd_status	string	The current status of the BFD session with this peer.
bgp_options	string	The BGP configuration options for this peer, including ASN (Autonomous System Number) and BFD (Bidrectional Forwarding Detection) settings.
bgp_status	string	The current status of the BGP session with this peer.
endpoint_eni_address	string	The IP address of the Elastic network interface for the route server endpoint.
endpoint_eni_id	string	The ID of the Elastic network interface for the route server endpoint.
failure_reason	string	The reason for any failure in peer creation or operation.
peer_address	string	The IPv4 address of the peer device.
route_server_endpoint_id	string	The ID of the route server endpoint associated with this peer.
route_server_id	string	The ID of the route server associated with this peer.
route_server_peer_id	string	The unique identifier of the route server peer.
state	string	The current state of the route server peer.
subnet_id	string	The ID of the subnet containing the route server peer.
tags	string	Any tags assigned to the route server peer.
vpc_id	string	The ID of the VPC containing the route server peer.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
describe_route_server_peers	select	region	RouteServerPeerId, NextToken, MaxResults, Filter, DryRun	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.
create_route_server_peer	insert	RouteServerEndpointId, PeerAddress, BgpOptions, region	DryRun, TagSpecification	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.
delete_route_server_peer	delete	RouteServerPeerId, region	DryRun	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

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
BgpOptions	object	The BGP options for the peer, including ASN (Autonomous System Number) and BFD (Bidrectional Forwarding Detection) settings.
PeerAddress	string	The IPv4 address of the peer device.
RouteServerEndpointId	string	The ID of the route server endpoint for which to create a peer.
RouteServerPeerId	string	The ID of the route server peer to delete.
region	string	AWS region (default: us-east-1)
DryRun	boolean	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.
Filter	array	One or more filters to apply to the describe request.
MaxResults	integer	The maximum number of results to return with a single call.
NextToken	string	The token for the next page of results.
RouteServerPeerId	array	The IDs of the route server peers to describe.
TagSpecification	array	The tags to apply to the route server peer during creation.

SELECT examples

describe_route_server_peers

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.

SELECT
bfd_status,
bgp_options,
bgp_status,
endpoint_eni_address,
endpoint_eni_id,
failure_reason,
peer_address,
route_server_endpoint_id,
route_server_id,
route_server_peer_id,
state,
subnet_id,
tags,
vpc_id
FROM aws.ec2.route_server_peers
WHERE region = '{{ region }}' -- required
AND RouteServerPeerId = '{{ RouteServerPeerId }}'
AND NextToken = '{{ NextToken }}'
AND MaxResults = '{{ MaxResults }}'
AND Filter = '{{ Filter }}'
AND DryRun = '{{ DryRun }}'
;

INSERT examples

create_route_server_peer

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.

INSERT INTO aws.ec2.route_server_peers (
RouteServerEndpointId,
PeerAddress,
BgpOptions,
region,
DryRun,
TagSpecification
)
SELECT 
'{{ RouteServerEndpointId }}',
'{{ PeerAddress }}',
'{{ BgpOptions }}',
'{{ region }}',
'{{ DryRun }}',
'{{ TagSpecification }}'
RETURNING
bfd_status,
bgp_options,
bgp_status,
endpoint_eni_address,
endpoint_eni_id,
failure_reason,
peer_address,
route_server_endpoint_id,
route_server_id,
route_server_peer_id,
state,
subnet_id,
tags,
vpc_id
;

Manifest

# Description fields are for documentation purposes
- name: route_server_peers
props:
  - name: RouteServerEndpointId
    value: "{{ RouteServerEndpointId }}"
    description: Required parameter for the route_server_peers resource.
  - name: PeerAddress
    value: "{{ PeerAddress }}"
    description: Required parameter for the route_server_peers resource.
  - name: BgpOptions
    value: "{{ BgpOptions }}"
    description: Required parameter for the route_server_peers resource.
  - name: region
    value: "{{ region }}"
    description: Required parameter for the route_server_peers resource.
  - name: DryRun
    value: {{ DryRun }}
    description: 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.
    description: 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.
  - name: TagSpecification
    value: "{{ TagSpecification }}"
    description: The tags to apply to the route server peer during creation.
    description: The tags to apply to the route server peer during creation.

DELETE examples

delete_route_server_peer

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

DELETE FROM aws.ec2.route_server_peers
WHERE RouteServerPeerId = '{{ RouteServerPeerId }}' --required
AND region = '{{ region }}' --required
AND DryRun = '{{ DryRun }}'
;