Package software.amazon.awscdk.services.ec2

Class CfnRouteServer

java.lang.Object
software.amazon.jsii.JsiiObject
software.constructs.Construct
software.amazon.awscdk.CfnElement
software.amazon.awscdk.CfnRefElement
software.amazon.awscdk.CfnResource
software.amazon.awscdk.services.ec2.CfnRouteServer
All Implemented Interfaces:
IInspectable, IRouteServerRef, IEnvironmentAware, ITaggableV2, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable
@Generated(value="jsii-pacmak/1.120.0 (build 192dc88)", date="2025-12-05T22:26:34.984Z") @Stability(Stable) public class CfnRouteServer extends CfnResource implements IInspectable, IRouteServerRef, ITaggableV2
Specifies a route server to manage dynamic routing in a VPC.

Amazon VPC Route Server simplifies routing for traffic between workloads that are deployed within a VPC and its internet gateways. With this feature, VPC Route Server dynamically updates VPC and internet gateway route tables with your preferred routes to achieve routing fault tolerance for those workloads. This enables you to automatically reroute traffic within a VPC, which increases the manageability of VPC routing and interoperability with third-party workloads.

For more information see Dynamic routing in your VPC with VPC Route Server in the Amazon VPC User Guide .

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.*;
 CfnRouteServer cfnRouteServer = CfnRouteServer.Builder.create(this, "MyCfnRouteServer")
         .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:

  • Field Details

    • CFN_RESOURCE_TYPE_NAME

      @Stability(Stable) public static final String CFN_RESOURCE_TYPE_NAME
      The CloudFormation resource type name for this resource class.

  • Constructor Details

    • CfnRouteServer

      protected CfnRouteServer(software.amazon.jsii.JsiiObjectRef objRef)

    • CfnRouteServer

      protected CfnRouteServer(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

    • CfnRouteServer

      @Stability(Stable) public CfnRouteServer(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull CfnRouteServerProps props)
      Create a new AWS::EC2::RouteServer.

      Parameters:
      scope - Scope in which this resource is defined. This parameter is required.
      id - Construct identifier for this resource (unique in its scope). This parameter is required.
      props - Resource properties. This parameter is required.

  • Method Details

    • arnForRouteServer

      @Stability(Stable) @NotNull public static String arnForRouteServer(@NotNull IRouteServerRef resource)
      Parameters:
      resource - This parameter is required.

    • fromRouteServerArn

      @Stability(Stable) @NotNull public static IRouteServerRef fromRouteServerArn(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull String arn)
      Creates a new IRouteServerRef from an ARN.

      Parameters:
      scope - This parameter is required.
      id - This parameter is required.
      arn - This parameter is required.

    • fromRouteServerId

      @Stability(Stable) @NotNull public static IRouteServerRef fromRouteServerId(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull String routeServerId)
      Creates a new IRouteServerRef from a routeServerId.

      Parameters:
      scope - This parameter is required.
      id - This parameter is required.
      routeServerId - This parameter is required.

    • isCfnRouteServer

      @Stability(Stable) @NotNull public static Boolean isCfnRouteServer(@NotNull Object x)
      Checks whether the given object is a CfnRouteServer.

      Parameters:
      x - This parameter is required.

    • inspect

      @Stability(Stable) public void inspect(@NotNull TreeInspector inspector)
      Examines the CloudFormation resource and discloses attributes.

      Specified by:
      inspect in interface IInspectable
      Parameters:
      inspector - tree inspector to collect and process attributes. This parameter is required.

    • renderProperties

      @Stability(Stable) @NotNull protected Map<String,Object> renderProperties(@NotNull Map<String,Object> props)
      Overrides:
      renderProperties in class CfnResource
      Parameters:
      props - This parameter is required.

    • getAttrArn

      @Stability(Stable) @NotNull public String getAttrArn()
      The ARN of the route server.

    • getAttrId

      @Stability(Stable) @NotNull public String getAttrId()
      The ID of the route server.

    • getCdkTagManager

      @Stability(Stable) @NotNull public TagManager getCdkTagManager()
      Tag Manager which manages the tags for this resource.
      Specified by:
      getCdkTagManager in interface ITaggableV2

    • getCfnProperties

      @Stability(Stable) @NotNull protected Map<String,Object> getCfnProperties()
      Overrides:
      getCfnProperties in class CfnResource

    • getRouteServerRef

      @Stability(Stable) @NotNull public RouteServerReference getRouteServerRef()
      A reference to a RouteServer resource.
      Specified by:
      getRouteServerRef in interface IRouteServerRef

    • getAmazonSideAsn

      @Stability(Stable) @NotNull public Number getAmazonSideAsn()
      The Border Gateway Protocol (BGP) Autonomous System Number (ASN) for the appliance.

    • setAmazonSideAsn

      @Stability(Stable) public void setAmazonSideAsn(@NotNull Number value)
      The Border Gateway Protocol (BGP) Autonomous System Number (ASN) for the appliance.

    • getPersistRoutes

      @Stability(Stable) @Nullable public String getPersistRoutes()
      Indicates whether routes should be persisted after all BGP sessions are terminated.

    • setPersistRoutes

      @Stability(Stable) public void setPersistRoutes(@Nullable String value)
      Indicates whether routes should be persisted after all BGP sessions are terminated.

    • getPersistRoutesDuration

      @Stability(Stable) @Nullable public 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.

    • setPersistRoutesDuration

      @Stability(Stable) public void setPersistRoutesDuration(@Nullable Number value)
      The number of minutes a route server will wait after BGP is re-established to unpersist the routes in the FIB and RIB.

    • getSnsNotificationsEnabled

      @Stability(Stable) @Nullable public Object getSnsNotificationsEnabled()
      Indicates whether SNS notifications are enabled for the route server.

      Returns union: either Boolean or IResolvable

    • setSnsNotificationsEnabled

      @Stability(Stable) public void setSnsNotificationsEnabled(@Nullable Boolean value)
      Indicates whether SNS notifications are enabled for the route server.

    • setSnsNotificationsEnabled

      @Stability(Stable) public void setSnsNotificationsEnabled(@Nullable IResolvable value)
      Indicates whether SNS notifications are enabled for the route server.

    • getTags

      @Stability(Stable) @Nullable public List<CfnTag> getTags()
      Any tags assigned to the route server.

    • setTags

      @Stability(Stable) public void setTags(@Nullable List<CfnTag> value)
      Any tags assigned to the route server.