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

A structure containing information about a BGP peer.

Instance Attribute Summary collapse

Instance Attribute Details

#address_familyString

Indicates the address family for the BGP peer.

  • ipv4: IPv4 address family

  • ipv6: IPv6 address family

Returns:

  • (String)


419
420
421
422
423
424
425
426
427
428
# File 'gems/aws-sdk-directconnect/lib/aws-sdk-directconnect/types.rb', line 419

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

#amazon_addressString

IP address assigned to the Amazon interface.

Example: 192.168.1.1/30 or 2001:db8::1/125

Returns:

  • (String)


419
420
421
422
423
424
425
426
427
428
# File 'gems/aws-sdk-directconnect/lib/aws-sdk-directconnect/types.rb', line 419

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

#asnInteger

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

Example: 65000

Returns:

  • (Integer)


419
420
421
422
423
424
425
426
427
428
# File 'gems/aws-sdk-directconnect/lib/aws-sdk-directconnect/types.rb', line 419

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

#auth_keyString

The authentication key for BGP configuration.

Example: asdf34example

Returns:

  • (String)


419
420
421
422
423
424
425
426
427
428
# File 'gems/aws-sdk-directconnect/lib/aws-sdk-directconnect/types.rb', line 419

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

#bgp_peer_stateString

The state of the BGP peer.

  • Verifying: The BGP peering addresses or ASN require validation before the BGP peer can be created. This state only applies to BGP peers on a public virtual interface.

  • Pending: The BGP peer has been created, and is in this state until it is ready to be established.

  • Available: The BGP peer can be established.

  • Deleting: The BGP peer is in the process of being deleted.

  • Deleted: The BGP peer has been deleted and cannot be established.

Returns:

  • (String)


419
420
421
422
423
424
425
426
427
428
# File 'gems/aws-sdk-directconnect/lib/aws-sdk-directconnect/types.rb', line 419

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

#bgp_statusString

The Up/Down state of the BGP peer.

  • Up: The BGP peer is established.

  • Down: The BGP peer is down.

Returns:

  • (String)


419
420
421
422
423
424
425
426
427
428
# File 'gems/aws-sdk-directconnect/lib/aws-sdk-directconnect/types.rb', line 419

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

#customer_addressString

IP address assigned to the customer interface.

Example: 192.168.1.2/30 or 2001:db8::2/125

Returns:

  • (String)


419
420
421
422
423
424
425
426
427
428
# File 'gems/aws-sdk-directconnect/lib/aws-sdk-directconnect/types.rb', line 419

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