EC2 / Client / describe_route_server_peers

describe_route_server_peers¶

EC2.Client.describe_route_server_peers(**kwargs)¶

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.

Request Syntax

response = client.describe_route_server_peers(
    RouteServerPeerIds=[
        'string',
    ],
    NextToken='string',
    MaxResults=123,
    Filters=[
        {
            'Name': 'string',
            'Values': [
                'string',
            ]
        },
    ],
    DryRun=True|False
)

Parameters:

RouteServerPeerIds (list) –
The IDs of the route server peers to describe.
- (string) –
NextToken (string) – The token for the next page of results.
MaxResults (integer) – The maximum number of results to return with a single call.
Filters (list) –
One or more filters to apply to the describe request.
- (dict) –
  
  A filter name and value pair that is used to return a more specific list of results from a describe operation. Filters can be used to match a set of resources by specific criteria, such as tags, attributes, or IDs.
  
  If you specify multiple filters, the filters are joined with an AND, and the request returns only results that match all of the specified filters.
  
  For more information, see List and filter using the CLI and API in the Amazon EC2 User Guide.
  - Name (string) –
    
    The name of the filter. Filter names are case-sensitive.
  - Values (list) –
    
    The filter values. Filter values are case-sensitive. If you specify multiple values for a filter, the values are joined with an OR, and the request returns all results that match any of the specified values.
    - (string) –
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.

Return type:

dict

Returns:

Response Syntax

{
    'RouteServerPeers': [
        {
            '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': {
                'PeerAsn': 123,
                'PeerLivenessDetection': 'bfd'|'bgp-keepalive'
            },
            'BgpStatus': {
                'Status': 'up'|'down'
            },
            'BfdStatus': {
                'Status': 'up'|'down'
            },
            'Tags': [
                {
                    'Key': 'string',
                    'Value': 'string'
                },
            ]
        },
    ],
    'NextToken': 'string'
}

Response Structure

(dict) –
- RouteServerPeers (list) –
  
  Information about the described route server peers.
  - (dict) –
    
    Describes a BGP peer configuration for a 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
    - RouteServerPeerId (string) –
      
      The unique identifier of the route server peer.
    - RouteServerEndpointId (string) –
      
      The ID of the route server endpoint associated with this peer.
    - RouteServerId (string) –
      
      The ID of the route server associated with this peer.
    - VpcId (string) –
      
      The ID of the VPC containing the route server peer.
    - SubnetId (string) –
      
      The ID of the subnet containing the route server peer.
    - State (string) –
      
      The current state of the route server peer.
    - FailureReason (string) –
      
      The reason for any failure in peer creation or operation.
    - EndpointEniId (string) –
      
      The ID of the Elastic network interface for the route server endpoint.
    - EndpointEniAddress (string) –
      
      The IP address of the Elastic network interface for the route server endpoint.
    - PeerAddress (string) –
      
      The IPv4 address of the peer device.
    - BgpOptions (dict) –
      
      The BGP configuration options for this peer, including ASN (Autonomous System Number) and BFD (Bidrectional Forwarding Detection) settings.
      - PeerAsn (integer) –
        
        The Border Gateway Protocol (BGP) Autonomous System Number (ASN) for the appliance. Valid values are from 1 to 4294967295. We recommend using a private ASN in the 64512–65534 (16-bit ASN) or 4200000000–4294967294 (32-bit ASN) range.
      - PeerLivenessDetection (string) –
        
        The liveness detection protocol used for the BGP peer.
        
        The requested liveness detection protocol for the BGP peer.
        
        bgp-keepalive: The standard BGP keep alive mechanism ( RFC4271) that is stable but may take longer to fail-over in cases of network impact or router failure.
        
        bfd: An additional Bidirectional Forwarding Detection (BFD) protocol ( RFC5880) that enables fast failover by using more sensitive liveness detection.
        
        Defaults to bgp-keepalive.
    - BgpStatus (dict) –
      
      The current status of the BGP session with this peer.
      - Status (string) –
        
        The operational status of the BGP session. The status enables you to monitor session liveness if you lack monitoring on your router/appliance.
    - BfdStatus (dict) –
      
      The current status of the BFD session with this peer.
      - Status (string) –
        
        The operational status of the BFD session.
    - Tags (list) –
      
      Any tags assigned to the route server peer.
      - (dict) –
        
        Describes a tag.
        
        Key (string) –
        
        The key of the tag.
        
        Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with aws:.
        
        Value (string) –
        
        The value of the tag.
        
        Constraints: Tag values are case-sensitive and accept a maximum of 256 Unicode characters.
- NextToken (string) –
  
  The token to use to retrieve the next page of results. This value is null when there are no more results to return.