You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.

Class: Aws::DirectConnect::Types::BGPPeer

Inherits:
Struct
  • Object
show all
Defined in:
(unknown)

Overview

Information about a BGP peer.

Instance Attribute Summary collapse

Instance Attribute Details

#address_familyString

The address family for the BGP peer.

Possible values:

  • ipv4
  • ipv6

Returns:

  • (String)

    The address family for the BGP peer.

#amazon_addressString

The IP address assigned to the Amazon interface.

Returns:

  • (String)

    The IP address assigned to the Amazon interface.

#asnInteger

The autonomous system (AS) number for Border Gateway Protocol (BGP) configuration.

Returns:

  • (Integer)

    The autonomous system (AS) number for Border Gateway Protocol (BGP) configuration.

#auth_keyString

The authentication key for BGP configuration.

Returns:

  • (String)

    The authentication key for BGP configuration.

#aws_device_v2String

The Direct Connect endpoint on which the BGP peer terminates.

Returns:

  • (String)

    The Direct Connect endpoint on which the BGP peer terminates.

#bgp_peer_idString

The ID of the BGP peer.

Returns:

  • (String)

    The ID of the BGP peer.

#bgp_peer_stateString

The state of the BGP peer. The following are the possible values:

  • verifying: The BGP peering addresses or ASN require validation before the BGP peer can be created. This state applies only to public virtual interfaces.

  • pending: The BGP peer is created, and remains in this state until it is ready to be established.

  • available: The BGP peer is ready to be established.

  • deleting: The BGP peer is being deleted.

  • deleted: The BGP peer is deleted and cannot be established.

    Possible values:

    • verifying
    • pending
    • available
    • deleting
    • deleted

Returns:

  • (String)

    The state of the BGP peer.

#bgp_statusString

The status of the BGP peer. The following are the possible values:

  • up: The BGP peer is established. This state does not indicate the state of the routing function. Ensure that you are receiving routes over the BGP session.

  • down: The BGP peer is down.

  • unknown: The BGP peer status is not available.

    Possible values:

    • up
    • down
    • unknown

Returns:

  • (String)

    The status of the BGP peer.

#customer_addressString

The IP address assigned to the customer interface.

Returns:

  • (String)

    The IP address assigned to the customer interface.