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

All Implemented Interfaces:: SdkPojo, ToCopyableBuilder<CreateRouteServerRequest.Builder,CreateRouteServerRequest>

@Generated("software.amazon.awssdk:codegen")
public final class CreateRouteServerRequest
extends Ec2Request
implements ToCopyableBuilder<CreateRouteServerRequest.Builder,CreateRouteServerRequest>

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static interface CreateRouteServerRequest.Builder

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`Long`	`amazonSideAsn()`	The private Autonomous System Number (ASN) for the Amazon side of the BGP session.
`static CreateRouteServerRequest.Builder`	`builder()`
`String`	`clientToken()`	Unique, case-sensitive identifier to ensure idempotency of the request.
`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()`
`boolean`	`hasTagSpecifications()`	For responses, this returns true if the service returned a value for the TagSpecifications property.
`RouteServerPersistRoutesAction`	`persistRoutes()`	Indicates whether routes should be persisted after all BGP sessions are terminated.
`String`	`persistRoutesAsString()`	Indicates whether routes should be persisted 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.
`Map<String,SdkField<?>>`	`sdkFieldNameToField()`
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends CreateRouteServerRequest.Builder>`	`serializableBuilderClass()`
`Boolean`	`snsNotificationsEnabled()`	Indicates whether SNS notifications should be enabled for route server events.
`List<TagSpecification>`	`tagSpecifications()`	The tags to apply to the route server during creation.
`CreateRouteServerRequest.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
  - amazonSideAsn
```
public final Long amazonSideAsn()
```
    The private Autonomous System Number (ASN) for the Amazon side of the BGP session. 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 private Autonomous System Number (ASN) for the Amazon side of the BGP session. 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.
  - clientToken
```
public final String clientToken()
```
    Unique, case-sensitive identifier to ensure idempotency of the request.
    
    Returns:
    
    Unique, case-sensitive identifier to ensure idempotency of the request.
  - 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.
  - persistRoutes
```
public final RouteServerPersistRoutesAction persistRoutes()
```
    Indicates whether routes should be persisted after all BGP sessions are terminated.
    
    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:
    
    Indicates whether routes should be persisted after all BGP sessions are terminated.
    
    See Also:
    
    RouteServerPersistRoutesAction
  - persistRoutesAsString
```
public final String persistRoutesAsString()
```
    Indicates whether routes should be persisted after all BGP sessions are terminated.
    
    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:
    
    Indicates whether routes should be persisted after all BGP sessions are terminated.
    
    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()
```
    Indicates whether SNS notifications should be enabled for route server events. Enabling SNS notifications persists BGP status changes to an SNS topic provisioned by Amazon Web Services.
    
    Returns:
    
    Indicates whether SNS notifications should be enabled for route server events. Enabling SNS notifications persists BGP status changes to an SNS topic provisioned by Amazon Web Services.
  - hasTagSpecifications
```
public final boolean hasTagSpecifications()
```
    For responses, this returns true if the service returned a value for the TagSpecifications 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.
  - tagSpecifications
```
public final List<TagSpecification> tagSpecifications()
```
    The tags to apply to the route server during creation.
    
    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 hasTagSpecifications() method.
    
    Returns:
    
    The tags to apply to the route server during creation.
  - toBuilder
```
public CreateRouteServerRequest.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<CreateRouteServerRequest.Builder,CreateRouteServerRequest>
    
    Specified by:
    
    toBuilder in class Ec2Request
  - builder
```
public static CreateRouteServerRequest.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends CreateRouteServerRequest.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 CreateRouteServerRequest

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

amazonSideAsn

clientToken

dryRun

persistRoutes

persistRoutesAsString

persistRoutesDuration

snsNotificationsEnabled

hasTagSpecifications

tagSpecifications

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields

sdkFieldNameToField