Class ModifyRouteServerRequest

java.lang.Object
software.amazon.awssdk.core.SdkRequest
software.amazon.awssdk.awscore.AwsRequest
software.amazon.awssdk.services.ec2.model.Ec2Request
software.amazon.awssdk.services.ec2.model.ModifyRouteServerRequest
All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<ModifyRouteServerRequest.Builder,ModifyRouteServerRequest>
@Generated("software.amazon.awssdk:codegen") public final class ModifyRouteServerRequest extends Ec2Request implements ToCopyableBuilder<ModifyRouteServerRequest.Builder,ModifyRouteServerRequest>

  • Method Details

    • routeServerId

      public final String routeServerId()

      The ID of the route server to modify.

      Returns:
      The ID of the route server to modify.

    • persistRoutes

      public final RouteServerPersistRoutesAction persistRoutes()

      Specifies whether to persist routes after all BGP sessions are terminated.

      • enable: Routes will be persisted in FIB and RIB after all BGP sessions are terminated.

      • disable: Routes will not be persisted in FIB and RIB after all BGP sessions are terminated.

      • reset: If a route server has persisted routes due to all BGP sessions having ended, reset will withdraw all routes and reset route server to an empty FIB and RIB.

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

      Returns:
      Specifies whether to persist routes after all BGP sessions are terminated.

      • enable: Routes will be persisted in FIB and RIB after all BGP sessions are terminated.

      • disable: Routes will not be persisted in FIB and RIB after all BGP sessions are terminated.

      • reset: If a route server has persisted routes due to all BGP sessions having ended, reset will withdraw all routes and reset route server to an empty FIB and RIB.

      See Also:

    • persistRoutesAsString

      public final String persistRoutesAsString()

      Specifies whether to persist routes after all BGP sessions are terminated.

      • enable: Routes will be persisted in FIB and RIB after all BGP sessions are terminated.

      • disable: Routes will not be persisted in FIB and RIB after all BGP sessions are terminated.

      • reset: If a route server has persisted routes due to all BGP sessions having ended, reset will withdraw all routes and reset route server to an empty FIB and RIB.

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

      Returns:
      Specifies whether to persist routes after all BGP sessions are terminated.

      • enable: Routes will be persisted in FIB and RIB after all BGP sessions are terminated.

      • disable: Routes will not be persisted in FIB and RIB after all BGP sessions are terminated.

      • reset: If a route server has persisted routes due to all BGP sessions having ended, reset will withdraw all routes and reset route server to an empty FIB and RIB.

      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. Required if PersistRoutes 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. Required if PersistRoutes 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()

      Specifies whether to enable SNS notifications for route server events. Enabling SNS notifications persists BGP status changes to an SNS topic provisioned by Amazon Web Services.

      Returns:
      Specifies whether to enable SNS notifications for route server events. Enabling SNS notifications persists BGP status changes to an SNS topic provisioned by Amazon Web Services.

    • dryRun

      public final Boolean dryRun()

      A check for whether you have the required permissions for the action without actually making the request and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

      Returns:
      A check for whether you have the required permissions for the action without actually making the request and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

    • toBuilder

      public ModifyRouteServerRequest.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<ModifyRouteServerRequest.Builder,ModifyRouteServerRequest>
      Specified by:
      toBuilder in class Ec2Request
      Returns:
      a builder for type T

    • builder

      public static ModifyRouteServerRequest.Builder builder()

    • serializableBuilderClass

      public static Class<? extends ModifyRouteServerRequest.Builder> serializableBuilderClass()

    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class AwsRequest

    • equals

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

    • 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)
      Description copied from class: SdkRequest
      Used to retrieve the value of a field from any class that extends SdkRequest. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, the SdkRequest.getValueForField(String, Class) method will again be available.
      Overrides:
      getValueForField in class SdkRequest
      Parameters:
      fieldName - The name of the member to be retrieved.
      clazz - The class to cast the returned object to.
      Returns:
      Optional containing the casted return value

    • 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.