Package software.amazon.awssdk.services.directconnect.model

Interface BGPPeer.Builder

All Superinterfaces:
Buildable, CopyableBuilder<BGPPeer.Builder,BGPPeer>, SdkBuilder<BGPPeer.Builder,BGPPeer>, SdkPojo
Enclosing class:
BGPPeer
public static interface BGPPeer.Builder extends SdkPojo, CopyableBuilder<BGPPeer.Builder,BGPPeer>

  • Method Details

    • bgpPeerId

      BGPPeer.Builder bgpPeerId(String bgpPeerId)

      The ID of the BGP peer.

      Parameters:
      bgpPeerId - The ID of the BGP peer.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • asn

      BGPPeer.Builder asn(Integer asn)

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

      Parameters:
      asn - The autonomous system (AS) number for Border Gateway Protocol (BGP) configuration.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • authKey

      BGPPeer.Builder authKey(String authKey)

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

      Parameters:
      authKey - The authentication key for BGP configuration. This string has a minimum length of 6 characters and and a maximun lenth of 80 characters.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • addressFamily

      BGPPeer.Builder addressFamily(String addressFamily)

      The address family for the BGP peer.

      Parameters:
      addressFamily - The address family for the BGP peer.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • addressFamily

      BGPPeer.Builder addressFamily(AddressFamily addressFamily)

      The address family for the BGP peer.

      Parameters:
      addressFamily - The address family for the BGP peer.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • amazonAddress

      BGPPeer.Builder amazonAddress(String amazonAddress)

      The IP address assigned to the Amazon interface.

      Parameters:
      amazonAddress - The IP address assigned to the Amazon interface.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • customerAddress

      BGPPeer.Builder customerAddress(String customerAddress)

      The IP address assigned to the customer interface.

      Parameters:
      customerAddress - The IP address assigned to the customer interface.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • bgpPeerState

      BGPPeer.Builder bgpPeerState(String 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.

      Parameters:
      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.

      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • bgpPeerState

      BGPPeer.Builder bgpPeerState(BGPPeerState 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.

      Parameters:
      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.

      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • bgpStatus

      BGPPeer.Builder bgpStatus(String 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.

      Parameters:
      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.

      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • bgpStatus

      BGPPeer.Builder bgpStatus(BGPStatus 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.

      Parameters:
      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.

      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • awsDeviceV2

      BGPPeer.Builder awsDeviceV2(String awsDeviceV2)

      The Direct Connect endpoint that terminates the BGP peer.

      Parameters:
      awsDeviceV2 - The Direct Connect endpoint that terminates the BGP peer.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • awsLogicalDeviceId

      BGPPeer.Builder awsLogicalDeviceId(String awsLogicalDeviceId)

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

      Parameters:
      awsLogicalDeviceId - The Direct Connect endpoint that terminates the logical connection. This device might be different than the device that terminates the physical connection.
      Returns:
      Returns a reference to this object so that method calls can be chained together.