Class RouteServerBgpOptions

java.lang.Object
software.amazon.awssdk.services.ec2.model.RouteServerBgpOptions
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<RouteServerBgpOptions.Builder,RouteServerBgpOptions>

@Generated("software.amazon.awssdk:codegen") public final class RouteServerBgpOptions extends Object implements SdkPojo, Serializable, ToCopyableBuilder<RouteServerBgpOptions.Builder,RouteServerBgpOptions>

The BGP configuration options for a route server peer.

See Also:
  • Method Details

    • peerAsn

      public final Long peerAsn()

      The Border Gateway Protocol (BGP) Autonomous System Number (ASN) for the appliance. Valid values are from 1 to 4294967295. We recommend using a private ASN in the 64512–65534 (16-bit ASN) or 4200000000–4294967294 (32-bit ASN) range.

      Returns:
      The Border Gateway Protocol (BGP) Autonomous System Number (ASN) for the appliance. Valid values are from 1 to 4294967295. We recommend using a private ASN in the 64512–65534 (16-bit ASN) or 4200000000–4294967294 (32-bit ASN) range.
    • peerLivenessDetection

      public final RouteServerPeerLivenessMode peerLivenessDetection()

      The liveness detection protocol used for the BGP peer.

      The requested liveness detection protocol for the BGP peer.

      • bgp-keepalive: The standard BGP keep alive mechanism (RFC4271) that is stable but may take longer to fail-over in cases of network impact or router failure.

      • bfd: An additional Bidirectional Forwarding Detection (BFD) protocol (RFC5880) that enables fast failover by using more sensitive liveness detection.

      Defaults to bgp-keepalive.

      If the service returns an enum value that is not available in the current SDK version, peerLivenessDetection will return RouteServerPeerLivenessMode.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from peerLivenessDetectionAsString().

      Returns:
      The liveness detection protocol used for the BGP peer.

      The requested liveness detection protocol for the BGP peer.

      • bgp-keepalive: The standard BGP keep alive mechanism (RFC4271) that is stable but may take longer to fail-over in cases of network impact or router failure.

      • bfd: An additional Bidirectional Forwarding Detection (BFD) protocol (RFC5880) that enables fast failover by using more sensitive liveness detection.

      Defaults to bgp-keepalive.

      See Also:
    • peerLivenessDetectionAsString

      public final String peerLivenessDetectionAsString()

      The liveness detection protocol used for the BGP peer.

      The requested liveness detection protocol for the BGP peer.

      • bgp-keepalive: The standard BGP keep alive mechanism (RFC4271) that is stable but may take longer to fail-over in cases of network impact or router failure.

      • bfd: An additional Bidirectional Forwarding Detection (BFD) protocol (RFC5880) that enables fast failover by using more sensitive liveness detection.

      Defaults to bgp-keepalive.

      If the service returns an enum value that is not available in the current SDK version, peerLivenessDetection will return RouteServerPeerLivenessMode.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from peerLivenessDetectionAsString().

      Returns:
      The liveness detection protocol used for the BGP peer.

      The requested liveness detection protocol for the BGP peer.

      • bgp-keepalive: The standard BGP keep alive mechanism (RFC4271) that is stable but may take longer to fail-over in cases of network impact or router failure.

      • bfd: An additional Bidirectional Forwarding Detection (BFD) protocol (RFC5880) that enables fast failover by using more sensitive liveness detection.

      Defaults to bgp-keepalive.

      See Also:
    • toBuilder

      public RouteServerBgpOptions.Builder toBuilder()
      Description copied from interface: ToCopyableBuilder
      Take this object and create a builder that contains all of the current property values of this object.
      Specified by:
      toBuilder in interface ToCopyableBuilder<RouteServerBgpOptions.Builder,RouteServerBgpOptions>
      Returns:
      a builder for type T
    • builder

      public static RouteServerBgpOptions.Builder builder()
    • serializableBuilderClass

      public static Class<? extends RouteServerBgpOptions.Builder> serializableBuilderClass()
    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class Object
    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class Object
    • equalsBySdkFields

      public final boolean equalsBySdkFields(Object obj)
      Description copied from interface: SdkPojo
      Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.
    • toString

      public final String toString()
      Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
      Overrides:
      toString in class Object
    • getValueForField

      public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
    • sdkFields

      public final List<SdkField<?>> sdkFields()
      Specified by:
      sdkFields in interface SdkPojo
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.
    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.