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>

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static interface ModifyRouteServerRequest.Builder

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`static ModifyRouteServerRequest.Builder`	`builder()`
`Boolean`	`dryRun()`	A check for whether you have the required permissions for the action without actually making the request and provides an error response.
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`int`	`hashCode()`
`RouteServerPersistRoutesAction`	`persistRoutes()`	Specifies whether to persist routes after all BGP sessions are terminated.
`String`	`persistRoutesAsString()`	Specifies whether to persist routes after all BGP sessions are terminated.
`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.
`String`	`routeServerId()`	The ID of the route server to modify.
`Map<String,SdkField<?>>`	`sdkFieldNameToField()`
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends ModifyRouteServerRequest.Builder>`	`serializableBuilderClass()`
`Boolean`	`snsNotificationsEnabled()`	Specifies whether to enable SNS notifications for route server events.
`ModifyRouteServerRequest.Builder`	`toBuilder()`
`String`	`toString()`	Returns a string representation of this object.

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest
overrideConfiguration

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy

- Method Detail
  - 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:
    
    RouteServerPersistRoutesAction
  - 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:
    
    RouteServerPersistRoutesAction
  - 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()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<ModifyRouteServerRequest.Builder,ModifyRouteServerRequest>
    
    Specified by:
    
    toBuilder in class Ec2Request
  - 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)
```
    Specified by:
    
    equalsBySdkFields in interface SdkPojo
  - 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)
```
    Overrides:
    
    getValueForField in class SdkRequest
  - sdkFields
```
public final List<SdkField<?>> sdkFields()
```
    Specified by:
    
    sdkFields in interface SdkPojo
  - sdkFieldNameToField
```
public final Map<String,SdkField<?>> sdkFieldNameToField()
```
    Specified by:
    
    sdkFieldNameToField in interface SdkPojo

Class ModifyRouteServerRequest

Nested Class Summary

Method Summary

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

Methods inherited from class java.lang.Object

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

Method Detail

routeServerId

persistRoutes

persistRoutesAsString

persistRoutesDuration

snsNotificationsEnabled

dryRun

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields

sdkFieldNameToField