Class: AWSCDK::Directconnect::CfnPrivateVirtualInterface::BgpPeerProperty

Inherits:
Jsii::Struct
  • Object
show all
Defined in:
directconnect/cfn_private_virtual_interface.rb

Overview

Information about a BGP peer.

See Also:

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(address_family:, asn:, amazon_address: nil, auth_key: nil, bgp_peer_id: nil, customer_address: nil) ⇒ BgpPeerProperty

Returns a new instance of BgpPeerProperty.

Parameters:

  • address_family (String) —

    The address family for the BGP peer.

  • asn (String) —

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

  • amazon_address (String, nil) (defaults to: nil) —

    The IP address assigned to the Amazon interface.

  • auth_key (String, nil) (defaults to: nil) —

    The authentication key for BGP configuration.

  • bgp_peer_id (String, nil) (defaults to: nil)
  • customer_address (String, nil) (defaults to: nil) —

    The IP address assigned to the customer interface.



636
637
638
639
640
641
642
643
644
645
646
647
648
649
 
# File 'directconnect/cfn_private_virtual_interface.rb', line 636

def initialize(address_family:, asn:, amazon_address: nil, auth_key: nil, bgp_peer_id: nil, customer_address: nil)
  @address_family = address_family
  Jsii::Type.check_type(@address_family, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "addressFamily")
  @asn = asn
  Jsii::Type.check_type(@asn, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "asn")
  @amazon_address = amazon_address
  Jsii::Type.check_type(@amazon_address, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "amazonAddress") unless @amazon_address.nil?
  @auth_key = auth_key
  Jsii::Type.check_type(@auth_key, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "authKey") unless @auth_key.nil?
  @bgp_peer_id = bgp_peer_id
  Jsii::Type.check_type(@bgp_peer_id, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "bgpPeerId") unless @bgp_peer_id.nil?
  @customer_address = customer_address
  Jsii::Type.check_type(@customer_address, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "customerAddress") unless @customer_address.nil?
end

Instance Attribute Details

#address_family ⇒ String (readonly)

The address family for the BGP peer.

Returns:

  • (String)

See Also:



655
656
657
 
# File 'directconnect/cfn_private_virtual_interface.rb', line 655

def address_family
  @address_family
end

#amazon_address ⇒ String? (readonly)

The IP address assigned to the Amazon interface.

Returns:

  • (String, nil)

See Also:



665
666
667
 
# File 'directconnect/cfn_private_virtual_interface.rb', line 665

def amazon_address
  @amazon_address
end

#asn ⇒ String (readonly)

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

Returns:

  • (String)

See Also:



660
661
662
 
# File 'directconnect/cfn_private_virtual_interface.rb', line 660

def asn
  @asn
end

#auth_key ⇒ String? (readonly)

The authentication key for BGP configuration.

This string has a minimum length of 6 characters and and a maximum length of 80 characters.

Returns:

  • (String, nil)

See Also:



672
673
674
 
# File 'directconnect/cfn_private_virtual_interface.rb', line 672

def auth_key
  @auth_key
end

#bgp_peer_id ⇒ String? (readonly)

Returns:

  • (String, nil)

See Also:



675
676
677
 
# File 'directconnect/cfn_private_virtual_interface.rb', line 675

def bgp_peer_id
  @bgp_peer_id
end

#customer_address ⇒ String? (readonly)

The IP address assigned to the customer interface.

Returns:

  • (String, nil)

See Also:



680
681
682
 
# File 'directconnect/cfn_private_virtual_interface.rb', line 680

def customer_address
  @customer_address
end

Class Method Details

.jsii_properties ⇒ Object 



682
683
684
685
686
687
688
689
690
691
 
# File 'directconnect/cfn_private_virtual_interface.rb', line 682

def self.jsii_properties
  {
    :address_family => "addressFamily",
    :asn => "asn",
    :amazon_address => "amazonAddress",
    :auth_key => "authKey",
    :bgp_peer_id => "bgpPeerId",
    :customer_address => "customerAddress",
  }
end

Instance Method Details

#to_jsii ⇒ Object 



693
694
695
696
697
698
699
700
701
702
703
704
 
# File 'directconnect/cfn_private_virtual_interface.rb', line 693

def to_jsii
  result = {}
  result.merge!({
    "addressFamily" => @address_family,
    "asn" => @asn,
    "amazonAddress" => @amazon_address,
    "authKey" => @auth_key,
    "bgpPeerId" => @bgp_peer_id,
    "customerAddress" => @customer_address,
  })
  result.compact
end