Module Values.BGPPeerSource

Information about a BGP peer.

Sourcetype nonrec t = {
  1. bgpPeerId : BGPPeerId.t option;
    (*

    The ID of the BGP peer.

    *)
  2. asn : ASN.t option;
    (*

    The autonomous system number (ASN). The valid range is from 1 to 2147483646 for Border Gateway Protocol (BGP) configuration. If you provide a number greater than the maximum, an error is returned. Use asnLong instead. You can use asnLong or asn, but not both. We recommend using asnLong as it supports a greater pool of numbers. The asnLong attribute accepts both ASN and long ASN ranges. If you provide a value in the same API call for both asn and asnLong, the API will only accept the value for asnLong.

    *)
  3. asnLong : LongAsn.t option;
    (*

    The long ASN for the BGP peer. The valid range is from 1 to 4294967294 for BGP configuration. You can use asnLong or asn, but not both. We recommend using asnLong as it supports a greater pool of numbers. The asnLong attribute accepts both ASN and long ASN ranges. If you provide a value in the same API call for both asn and asnLong, the API will only accept the value for asnLong.

    *)
  4. authKey : BGPAuthKey.t option;
    (*

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

    *)
  5. addressFamily : AddressFamily.t option;
    (*

    The address family for the BGP peer.

    *)
  6. amazonAddress : AmazonAddress.t option;
    (*

    The IP address assigned to the Amazon interface.

    *)
  7. customerAddress : CustomerAddress.t option;
    (*

    The IP address assigned to the customer interface.

    *)
  8. bgpPeerState : BGPPeerState.t option;
    (*

    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.

    *)
  9. bgpStatus : BGPStatus.t option;
    (*

    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.

    *)
  10. awsDeviceV2 : AwsDeviceV2.t option;
    (*

    The Direct Connect endpoint that terminates the BGP peer.

    *)
  11. awsLogicalDeviceId : AwsLogicalDeviceId.t option;
    (*

    The Direct Connect endpoint that terminates the logical connection. This device might be different than the device that terminates the physical connection.

    *)
}
Sourceval make : ?bgpPeerId:??? -> ?asn:??? -> ?asnLong:??? -> ?authKey:??? -> ?addressFamily:??? -> ?amazonAddress:??? -> ?customerAddress:??? -> ?bgpPeerState:??? -> ?bgpStatus:??? -> ?awsDeviceV2:??? -> ?awsLogicalDeviceId:??? -> unit -> t
Sourceval to_value : t -> [> `Structure of (string * [> `Enum of string | `Integer of ASN.t | `Long of LongAsn.t | `String of BGPPeerId.t ]) list ]
Sourceval to_query : t -> Awso.Client.Query.t
Sourceval of_xml : Awso.Xml.t -> t
Sourceval of_string : string -> t
Sourceval of_json : Yojson.Safe.t -> t
Sourceval to_json : t -> Yojson.Safe.t