Class: AWSCDK::Directconnect::CfnPublicVirtualInterface::BgpPeerProperty

Inherits:
Jsii::Struct
  • Object
show all
Defined in:
directconnect/cfn_public_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.



599
600
601
602
603
604
605
606
607
608
609
610
611
612
 
# File 'directconnect/cfn_public_virtual_interface.rb', line 599

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:



618
619
620
 
# File 'directconnect/cfn_public_virtual_interface.rb', line 618

def address_family
  @address_family
end

#amazon_address ⇒ String? (readonly)

The IP address assigned to the Amazon interface.

Returns:

  • (String, nil)

See Also:



628
629
630
 
# File 'directconnect/cfn_public_virtual_interface.rb', line 628

def amazon_address
  @amazon_address
end

#asn ⇒ String (readonly)

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

Returns:

  • (String)

See Also:



623
624
625
 
# File 'directconnect/cfn_public_virtual_interface.rb', line 623

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:



635
636
637
 
# File 'directconnect/cfn_public_virtual_interface.rb', line 635

def auth_key
  @auth_key
end

#bgp_peer_id ⇒ String? (readonly)

Returns:

  • (String, nil)

See Also:



638
639
640
 
# File 'directconnect/cfn_public_virtual_interface.rb', line 638

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:



643
644
645
 
# File 'directconnect/cfn_public_virtual_interface.rb', line 643

def customer_address
  @customer_address
end

Class Method Details

.jsii_properties ⇒ Object 



645
646
647
648
649
650
651
652
653
654
 
# File 'directconnect/cfn_public_virtual_interface.rb', line 645

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 



656
657
658
659
660
661
662
663
664
665
666
667
 
# File 'directconnect/cfn_public_virtual_interface.rb', line 656

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