EC2 / Client / create_route_server_peer

create_route_server_peer#

EC2.Client.create_route_server_peer(**kwargs)#

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

A route server peer is a network appliance or function deployed in Amazon Web Services, such as firewall appliances and other network security functions, that meet these requirements:

Have an elastic network interface in the VPC
Support BGP (Border Gateway Protocol)
Can initiate BGP sessions

Request Syntax

response = client.create_route_server_peer(
    RouteServerEndpointId='string',
    PeerAddress='string',
    BgpOptions={
        'PeerAsn': 123,
        'PeerLivenessDetection': 'bfd'|'bgp-keepalive'
    },
    DryRun=True|False,
    TagSpecifications=[
        {
            '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'|'placement-group'|'prefix-list'|'replace-root-volume-task'|'reserved-instances'|'route-table'|'security-group'|'security-group-rule'|'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': [
                {
                    'Key': 'string',
                    'Value': 'string'
                },
            ]
        },
    ]
)

Parameters:

RouteServerEndpointId (string) –
[REQUIRED]

The ID of the route server endpoint for which to create a peer.
PeerAddress (string) –
[REQUIRED]

The IPv4 address of the peer.
BgpOptions (dict) –
[REQUIRED]

The BGP options for the peer, including ASN (Autonomous System Number) and BFD (Bidrectional Forwarding Detection) settings.
- PeerAsn (integer) – [REQUIRED]
  
  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 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.
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.
TagSpecifications (list) –
The tags to apply to the route server peer during creation.
- (dict) –
  
  The tags to apply to a resource when the resource is being created. When you specify a tag, you must specify the resource type to tag, otherwise the request will fail.
  
  Note
  The Valid Values lists all the resource types that can be tagged. However, the action you’re using might not support tagging all of these resource types. If you try to tag a resource type that is unsupported for the action you’re using, you’ll get an error.
  - ResourceType (string) –
    
    The type of resource to tag on creation.
  - Tags (list) –
    
    The tags to apply to the resource.
    - (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.

Return type:

dict

Returns:

Response Syntax

{
    'RouteServerPeer': {
        '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'
            },
        ]
    }
}

Response Structure

(dict) –
- RouteServerPeer (dict) –
  
  Information about the created route server peer.
  - 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.
  - 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.