Class RouteServer

java.lang.Object
software.amazon.awssdk.services.ec2.model.RouteServer
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<RouteServer.Builder,RouteServer>
@Generated("software.amazon.awssdk:codegen") public final class RouteServer extends Object implements SdkPojo, Serializable, ToCopyableBuilder<RouteServer.Builder,RouteServer>

Describes a route server and its configuration.

Amazon VPC Route Server simplifies routing for traffic between workloads that are deployed within a VPC and its internet gateways. With this feature, VPC Route Server dynamically updates VPC and internet gateway route tables with your preferred IPv4 or IPv6 routes to achieve routing fault tolerance for those workloads. This enables you to automatically reroute traffic within a VPC, which increases the manageability of VPC routing and interoperability with third-party workloads.

Route server supports the follow route table types:

  • VPC route tables not associated with subnets

  • Subnet route tables

  • Internet gateway route tables

Route server does not support route tables associated with virtual private gateways. To propagate routes into a transit gateway route table, use Transit Gateway Connect.

See Also:

  • Method Details

    • routeServerId

      public final String routeServerId()

      The unique identifier of the route server.

      Returns:
      The unique identifier of the route server.

    • amazonSideAsn

      public final Long amazonSideAsn()

      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.

    • state

      public final RouteServerState state()

      The current state of the route server.

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

      Returns:
      The current state of the route server.
      See Also:

    • stateAsString

      public final String stateAsString()

      The current state of the route server.

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

      Returns:
      The current state of the route server.
      See Also:

    • hasTags

      public final boolean hasTags()
      For responses, this returns true if the service returned a value for the Tags property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

    • tags

      public final List<Tag> tags()

      Any tags assigned to the route server.

      Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

      This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasTags() method.

      Returns:
      Any tags assigned to the route server.

    • persistRoutesState

      public final RouteServerPersistRoutesState persistRoutesState()

      The current state of route persistence for the route server.

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

      Returns:
      The current state of route persistence for the route server.
      See Also:

    • persistRoutesStateAsString

      public final String persistRoutesStateAsString()

      The current state of route persistence for the route server.

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

      Returns:
      The current state of route persistence for the route server.
      See Also:

    • persistRoutesDuration

      public final Long persistRoutesDuration()

      The number of minutes a route server will wait after BGP is re-established to unpersist the routes in the FIB and RIB. Value must be in the range of 1-5. The default value is 1. Only valid if persistRoutesState is 'enabled'.

      If you set the duration to 1 minute, then when your network appliance re-establishes BGP with route server, it has 1 minute to relearn it's adjacent network and advertise those routes to route server before route server resumes normal functionality. In most cases, 1 minute is probably sufficient. If, however, you have concerns that your BGP network may not be capable of fully re-establishing and re-learning everything in 1 minute, you can increase the duration up to 5 minutes.

      Returns:
      The number of minutes a route server will wait after BGP is re-established to unpersist the routes in the FIB and RIB. Value must be in the range of 1-5. The default value is 1. Only valid if persistRoutesState is 'enabled'.

      If you set the duration to 1 minute, then when your network appliance re-establishes BGP with route server, it has 1 minute to relearn it's adjacent network and advertise those routes to route server before route server resumes normal functionality. In most cases, 1 minute is probably sufficient. If, however, you have concerns that your BGP network may not be capable of fully re-establishing and re-learning everything in 1 minute, you can increase the duration up to 5 minutes.

    • snsNotificationsEnabled

      public final Boolean snsNotificationsEnabled()

      Indicates whether SNS notifications are enabled for the route server. Enabling SNS notifications persists BGP status changes to an SNS topic provisioned by Amazon Web Services.

      Returns:
      Indicates whether SNS notifications are enabled for the route server. Enabling SNS notifications persists BGP status changes to an SNS topic provisioned by Amazon Web Services.

    • snsTopicArn

      public final String snsTopicArn()

      The ARN of the SNS topic where notifications are published.

      Returns:
      The ARN of the SNS topic where notifications are published.

    • toBuilder

      public RouteServer.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<RouteServer.Builder,RouteServer>
      Returns:
      a builder for type T

    • builder

      public static RouteServer.Builder builder()

    • serializableBuilderClass

      public static Class<? extends RouteServer.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.