Interface CreateRouteServerRequest.Builder
- All Superinterfaces:
AwsRequest.Builder
,Buildable
,CopyableBuilder<CreateRouteServerRequest.Builder,
,CreateRouteServerRequest> Ec2Request.Builder
,SdkBuilder<CreateRouteServerRequest.Builder,
,CreateRouteServerRequest> SdkPojo
,SdkRequest.Builder
- Enclosing class:
CreateRouteServerRequest
-
Method Summary
Modifier and TypeMethodDescriptionamazonSideAsn
(Long amazonSideAsn) The private Autonomous System Number (ASN) for the Amazon side of the BGP session.clientToken
(String clientToken) Unique, case-sensitive identifier to ensure idempotency of the request.A check for whether you have the required permissions for the action without actually making the request and provides an error response.overrideConfiguration
(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) Add an optional request override configuration.overrideConfiguration
(AwsRequestOverrideConfiguration overrideConfiguration) Add an optional request override configuration.persistRoutes
(String persistRoutes) Indicates whether routes should be persisted after all BGP sessions are terminated.persistRoutes
(RouteServerPersistRoutesAction persistRoutes) Indicates whether routes should be persisted after all BGP sessions are terminated.persistRoutesDuration
(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.snsNotificationsEnabled
(Boolean snsNotificationsEnabled) Indicates whether SNS notifications should be enabled for route server events.tagSpecifications
(Collection<TagSpecification> tagSpecifications) The tags to apply to the route server during creation.tagSpecifications
(Consumer<TagSpecification.Builder>... tagSpecifications) The tags to apply to the route server during creation.tagSpecifications
(TagSpecification... tagSpecifications) The tags to apply to the route server during creation.Methods inherited from interface software.amazon.awssdk.awscore.AwsRequest.Builder
overrideConfiguration
Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder
copy
Methods inherited from interface software.amazon.awssdk.services.ec2.model.Ec2Request.Builder
build
Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder
applyMutation, build
Methods inherited from interface software.amazon.awssdk.core.SdkPojo
equalsBySdkFields, sdkFieldNameToField, sdkFields
-
Method Details
-
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.
- Parameters:
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:
- Returns a reference to this object so that method calls can be chained together.
-
clientToken
Unique, case-sensitive identifier to ensure idempotency of the request.
- Parameters:
clientToken
- Unique, case-sensitive identifier to ensure idempotency of the request.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
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 isUnauthorizedOperation
.- Parameters:
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 isDryRunOperation
. Otherwise, it isUnauthorizedOperation
.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
persistRoutes
Indicates whether routes should be persisted after all BGP sessions are terminated.
- Parameters:
persistRoutes
- Indicates whether routes should be persisted after all BGP sessions are terminated.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
persistRoutes
Indicates whether routes should be persisted after all BGP sessions are terminated.
- Parameters:
persistRoutes
- Indicates whether routes should be persisted after all BGP sessions are terminated.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
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.
- Parameters:
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 isenabled
.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:
- Returns a reference to this object so that method calls can be chained together.
-
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.
- Parameters:
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:
- Returns a reference to this object so that method calls can be chained together.
-
tagSpecifications
The tags to apply to the route server during creation.
- Parameters:
tagSpecifications
- The tags to apply to the route server during creation.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
tagSpecifications
The tags to apply to the route server during creation.
- Parameters:
tagSpecifications
- The tags to apply to the route server during creation.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
tagSpecifications
CreateRouteServerRequest.Builder tagSpecifications(Consumer<TagSpecification.Builder>... tagSpecifications) The tags to apply to the route server during creation.
This is a convenience method that creates an instance of theTagSpecification.Builder
avoiding the need to create one manually viaTagSpecification.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed totagSpecifications(List<TagSpecification>)
.- Parameters:
tagSpecifications
- a consumer that will call methods onTagSpecification.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
overrideConfiguration
CreateRouteServerRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration) Description copied from interface:AwsRequest.Builder
Add an optional request override configuration.- Specified by:
overrideConfiguration
in interfaceAwsRequest.Builder
- Parameters:
overrideConfiguration
- The override configuration.- Returns:
- This object for method chaining.
-
overrideConfiguration
CreateRouteServerRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) Description copied from interface:AwsRequest.Builder
Add an optional request override configuration.- Specified by:
overrideConfiguration
in interfaceAwsRequest.Builder
- Parameters:
builderConsumer
- AConsumer
to which an emptyAwsRequestOverrideConfiguration.Builder
will be given.- Returns:
- This object for method chaining.
-