Package software.amazon.awscdk.services.ec2

Interface CfnRouteServerProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnRouteServerProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.113.0 (build fc68b25)",
           date="2025-09-22T11:33:04.922Z")
@Stability(Stable)
public interface CfnRouteServerProps
extends software.amazon.jsii.JsiiSerializable

Properties for defining a CfnRouteServer.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.ec2.*;
 CfnRouteServerProps cfnRouteServerProps = CfnRouteServerProps.builder()
         .amazonSideAsn(123)
         // the properties below are optional
         .persistRoutes("persistRoutes")
         .persistRoutesDuration(123)
         .snsNotificationsEnabled(false)
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .build();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-routeserver.html

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnRouteServerProps.Builder	A builder for CfnRouteServerProps
static final class	CfnRouteServerProps.Jsii$Proxy	An implementation for CfnRouteServerProps

Method Summary

Modifier and Type	Method	Description
static CfnRouteServerProps.Builder	builder()
Number	getAmazonSideAsn()	The Border Gateway Protocol (BGP) Autonomous System Number (ASN) for the appliance.
default String	getPersistRoutes()	Indicates whether routes should be persisted after all BGP sessions are terminated.
default Number	getPersistRoutesDuration()	The number of minutes a route server will wait after BGP is re-established to unpersist the routes in the FIB and RIB.
default Object	getSnsNotificationsEnabled()	Indicates whether SNS notifications are enabled for the route server.
default List<CfnTag>	getTags()	Any tags assigned to the route server.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getAmazonSideAsn

@Stability(Stable)
@NotNull
Number getAmazonSideAsn()

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.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-routeserver.html#cfn-ec2-routeserver-amazonsideasn

getPersistRoutes

@Stability(Stable)
@Nullable
default String getPersistRoutes()

Indicates whether routes should be persisted after all BGP sessions are terminated.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-routeserver.html#cfn-ec2-routeserver-persistroutes

getPersistRoutesDuration

@Stability(Stable)
@Nullable
default Number getPersistRoutesDuration()

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.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-routeserver.html#cfn-ec2-routeserver-persistroutesduration

getSnsNotificationsEnabled

@Stability(Stable)
@Nullable
default Object getSnsNotificationsEnabled()

Indicates whether SNS notifications are enabled for the route server.

Enabling SNS notifications persists BGP status changes to an SNS topic provisioned by AWS .

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-routeserver.html#cfn-ec2-routeserver-snsnotificationsenabled

getTags

@Stability(Stable)
@Nullable
default List<CfnTag> getTags()

Any tags assigned to the route server.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-routeserver.html#cfn-ec2-routeserver-tags

builder

@Stability(Stable)
static CfnRouteServerProps.Builder builder()

Returns:

a CfnRouteServerProps.Builder of CfnRouteServerProps