Package software.amazon.awscdk.services.ec2

Class CfnRouteServerEndpoint

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.CfnRouteServerEndpoint
All Implemented Interfaces:
IEnvironmentAware, IInspectable, ITaggableV2, IRouteServerEndpointRef, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable
@Generated(value="jsii-pacmak/1.118.0 (build 02eec31)", date="2025-11-04T09:27:39.801Z") @Stability(Stable) public class CfnRouteServerEndpoint extends CfnResource implements IInspectable, IRouteServerEndpointRef, ITaggableV2
Creates a new endpoint for a route server in a specified subnet.

A route server endpoint is an AWS -managed component inside a subnet that facilitates BGP (Border Gateway Protocol) connections between your route server and your BGP peers.

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.*;
 CfnRouteServerEndpoint cfnRouteServerEndpoint = CfnRouteServerEndpoint.Builder.create(this, "MyCfnRouteServerEndpoint")
         .routeServerId("routeServerId")
         .subnetId("subnetId")
         // the properties below are optional
         .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

    • CfnRouteServerEndpoint

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

    • CfnRouteServerEndpoint

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

    • CfnRouteServerEndpoint

      @Stability(Stable) public CfnRouteServerEndpoint(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull CfnRouteServerEndpointProps props)
      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

    • fromRouteServerEndpointArn

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

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

    • fromRouteServerEndpointId

      @Stability(Stable) @NotNull public static IRouteServerEndpointRef fromRouteServerEndpointId(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull String routeServerEndpointId)
      Creates a new IRouteServerEndpointRef from a routeServerEndpointId.

      Parameters:
      scope - This parameter is required.
      id - This parameter is required.
      routeServerEndpointId - 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 for the endpoint.

    • getAttrEniAddress

      @Stability(Stable) @NotNull public String getAttrEniAddress()
      The IP address of the Elastic network interface for the endpoint.

    • getAttrEniId

      @Stability(Stable) @NotNull public String getAttrEniId()
      The ID of the Elastic network interface for the endpoint.

    • getAttrId

      @Stability(Stable) @NotNull public String getAttrId()
      The unique identifier of the route server endpoint.

    • getAttrVpcId

      @Stability(Stable) @NotNull public String getAttrVpcId()
      The ID of the VPC containing the endpoint.

    • 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

    • getRouteServerEndpointRef

      @Stability(Stable) @NotNull public RouteServerEndpointReference getRouteServerEndpointRef()
      A reference to a RouteServerEndpoint resource.
      Specified by:
      getRouteServerEndpointRef in interface IRouteServerEndpointRef

    • getRouteServerId

      @Stability(Stable) @NotNull public String getRouteServerId()
      The ID of the route server associated with this endpoint.

    • setRouteServerId

      @Stability(Stable) public void setRouteServerId(@NotNull String value)
      The ID of the route server associated with this endpoint.

    • getSubnetId

      @Stability(Stable) @NotNull public String getSubnetId()
      The ID of the subnet to place the route server endpoint into.

    • setSubnetId

      @Stability(Stable) public void setSubnetId(@NotNull String value)
      The ID of the subnet to place the route server endpoint into.

    • getTags

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

    • setTags

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