Struct aws_sdk_directconnect::types::BgpPeer
source · #[non_exhaustive]pub struct BgpPeer {
pub bgp_peer_id: Option<String>,
pub asn: i32,
pub auth_key: Option<String>,
pub address_family: Option<AddressFamily>,
pub amazon_address: Option<String>,
pub customer_address: Option<String>,
pub bgp_peer_state: Option<BgpPeerState>,
pub bgp_status: Option<BgpStatus>,
pub aws_device_v2: Option<String>,
pub aws_logical_device_id: Option<String>,
}
Expand description
Information about a BGP peer.
Fields (Non-exhaustive)§
This struct is marked as non-exhaustive
Struct { .. }
syntax; cannot be matched against without a wildcard ..
; and struct update syntax will not work.bgp_peer_id: Option<String>
The ID of the BGP peer.
asn: i32
The autonomous system (AS) number for Border Gateway Protocol (BGP) configuration.
auth_key: Option<String>
The authentication key for BGP configuration. This string has a minimum length of 6 characters and and a maximun lenth of 80 characters.
address_family: Option<AddressFamily>
The address family for the BGP peer.
amazon_address: Option<String>
The IP address assigned to the Amazon interface.
customer_address: Option<String>
The IP address assigned to the customer interface.
bgp_peer_state: Option<BgpPeerState>
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.
bgp_status: Option<BgpStatus>
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.
aws_device_v2: Option<String>
The Direct Connect endpoint that terminates the BGP peer.
aws_logical_device_id: Option<String>
The Direct Connect endpoint that terminates the logical connection. This device might be different than the device that terminates the physical connection.
Implementations§
source§impl BgpPeer
impl BgpPeer
sourcepub fn bgp_peer_id(&self) -> Option<&str>
pub fn bgp_peer_id(&self) -> Option<&str>
The ID of the BGP peer.
sourcepub fn asn(&self) -> i32
pub fn asn(&self) -> i32
The autonomous system (AS) number for Border Gateway Protocol (BGP) configuration.
sourcepub fn auth_key(&self) -> Option<&str>
pub fn auth_key(&self) -> Option<&str>
The authentication key for BGP configuration. This string has a minimum length of 6 characters and and a maximun lenth of 80 characters.
sourcepub fn address_family(&self) -> Option<&AddressFamily>
pub fn address_family(&self) -> Option<&AddressFamily>
The address family for the BGP peer.
sourcepub fn amazon_address(&self) -> Option<&str>
pub fn amazon_address(&self) -> Option<&str>
The IP address assigned to the Amazon interface.
sourcepub fn customer_address(&self) -> Option<&str>
pub fn customer_address(&self) -> Option<&str>
The IP address assigned to the customer interface.
sourcepub fn bgp_peer_state(&self) -> Option<&BgpPeerState>
pub fn bgp_peer_state(&self) -> Option<&BgpPeerState>
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.
sourcepub fn bgp_status(&self) -> Option<&BgpStatus>
pub fn bgp_status(&self) -> Option<&BgpStatus>
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.
sourcepub fn aws_device_v2(&self) -> Option<&str>
pub fn aws_device_v2(&self) -> Option<&str>
The Direct Connect endpoint that terminates the BGP peer.
sourcepub fn aws_logical_device_id(&self) -> Option<&str>
pub fn aws_logical_device_id(&self) -> Option<&str>
The Direct Connect endpoint that terminates the logical connection. This device might be different than the device that terminates the physical connection.