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

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

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-directconnect/lib/aws-sdk-directconnect/types.rb

Overview

Information about a BGP peer.

Instance Attribute Summary collapse

Instance Attribute Details

#address_familyString

The address family for the BGP peer.

Returns:

  • (String)


495
496
497
498
499
500
501
502
503
504
505
506
# File 'gems/aws-sdk-directconnect/lib/aws-sdk-directconnect/types.rb', line 495

class BGPPeer < Struct.new(
  :bgp_peer_id,
  :asn,
  :auth_key,
  :address_family,
  :amazon_address,
  :customer_address,
  :bgp_peer_state,
  :bgp_status,
  :aws_device_v2)
  include Aws::Structure
end

#amazon_addressString

The IP address assigned to the Amazon interface.

Returns:

  • (String)


495
496
497
498
499
500
501
502
503
504
505
506
# File 'gems/aws-sdk-directconnect/lib/aws-sdk-directconnect/types.rb', line 495

class BGPPeer < Struct.new(
  :bgp_peer_id,
  :asn,
  :auth_key,
  :address_family,
  :amazon_address,
  :customer_address,
  :bgp_peer_state,
  :bgp_status,
  :aws_device_v2)
  include Aws::Structure
end

#asnInteger

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

Returns:

  • (Integer)


495
496
497
498
499
500
501
502
503
504
505
506
# File 'gems/aws-sdk-directconnect/lib/aws-sdk-directconnect/types.rb', line 495

class BGPPeer < Struct.new(
  :bgp_peer_id,
  :asn,
  :auth_key,
  :address_family,
  :amazon_address,
  :customer_address,
  :bgp_peer_state,
  :bgp_status,
  :aws_device_v2)
  include Aws::Structure
end

#auth_keyString

The authentication key for BGP configuration. This string has a minimum length of 6 characters and and a maximun lenth of 80 characters.

Returns:

  • (String)


495
496
497
498
499
500
501
502
503
504
505
506
# File 'gems/aws-sdk-directconnect/lib/aws-sdk-directconnect/types.rb', line 495

class BGPPeer < Struct.new(
  :bgp_peer_id,
  :asn,
  :auth_key,
  :address_family,
  :amazon_address,
  :customer_address,
  :bgp_peer_state,
  :bgp_status,
  :aws_device_v2)
  include Aws::Structure
end

#aws_device_v2String

The Direct Connect endpoint on which the BGP peer terminates.

Returns:

  • (String)


495
496
497
498
499
500
501
502
503
504
505
506
# File 'gems/aws-sdk-directconnect/lib/aws-sdk-directconnect/types.rb', line 495

class BGPPeer < Struct.new(
  :bgp_peer_id,
  :asn,
  :auth_key,
  :address_family,
  :amazon_address,
  :customer_address,
  :bgp_peer_state,
  :bgp_status,
  :aws_device_v2)
  include Aws::Structure
end

#bgp_peer_idString

The ID of the BGP peer.

Returns:

  • (String)


495
496
497
498
499
500
501
502
503
504
505
506
# File 'gems/aws-sdk-directconnect/lib/aws-sdk-directconnect/types.rb', line 495

class BGPPeer < Struct.new(
  :bgp_peer_id,
  :asn,
  :auth_key,
  :address_family,
  :amazon_address,
  :customer_address,
  :bgp_peer_state,
  :bgp_status,
  :aws_device_v2)
  include Aws::Structure
end

#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.

Returns:

  • (String)


495
496
497
498
499
500
501
502
503
504
505
506
# File 'gems/aws-sdk-directconnect/lib/aws-sdk-directconnect/types.rb', line 495

class BGPPeer < Struct.new(
  :bgp_peer_id,
  :asn,
  :auth_key,
  :address_family,
  :amazon_address,
  :customer_address,
  :bgp_peer_state,
  :bgp_status,
  :aws_device_v2)
  include Aws::Structure
end

#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.

Returns:

  • (String)


495
496
497
498
499
500
501
502
503
504
505
506
# File 'gems/aws-sdk-directconnect/lib/aws-sdk-directconnect/types.rb', line 495

class BGPPeer < Struct.new(
  :bgp_peer_id,
  :asn,
  :auth_key,
  :address_family,
  :amazon_address,
  :customer_address,
  :bgp_peer_state,
  :bgp_status,
  :aws_device_v2)
  include Aws::Structure
end

#customer_addressString

The IP address assigned to the customer interface.

Returns:

  • (String)


495
496
497
498
499
500
501
502
503
504
505
506
# File 'gems/aws-sdk-directconnect/lib/aws-sdk-directconnect/types.rb', line 495

class BGPPeer < Struct.new(
  :bgp_peer_id,
  :asn,
  :auth_key,
  :address_family,
  :amazon_address,
  :customer_address,
  :bgp_peer_state,
  :bgp_status,
  :aws_device_v2)
  include Aws::Structure
end