Package software.amazon.awscdk.services.ec2

Class CfnRouteServerPeer

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.CfnRouteServerPeer
All Implemented Interfaces:
IInspectable, IRouteServerPeerRef, 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.988Z") @Stability(Stable) public class CfnRouteServerPeer extends CfnResource implements IInspectable, IRouteServerPeerRef, ITaggableV2
Specifies a BGP peer configuration for a route server endpoint.

A route server peer is a session between a route server endpoint and the device deployed in AWS (such as a firewall appliance or other network security function running on an EC2 instance).

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.*;
 CfnRouteServerPeer cfnRouteServerPeer = CfnRouteServerPeer.Builder.create(this, "MyCfnRouteServerPeer")
         .bgpOptions(BgpOptionsProperty.builder()
                 .peerAsn(123)
                 .peerLivenessDetection("peerLivenessDetection")
                 .build())
         .peerAddress("peerAddress")
         .routeServerEndpointId("routeServerEndpointId")
         // 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

    • CfnRouteServerPeer

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

    • CfnRouteServerPeer

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

    • CfnRouteServerPeer

      @Stability(Stable) public CfnRouteServerPeer(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull CfnRouteServerPeerProps props)
      Create a new AWS::EC2::RouteServerPeer.

      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

    • arnForRouteServerPeer

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

    • fromRouteServerPeerArn

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

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

    • fromRouteServerPeerId

      @Stability(Stable) @NotNull public static IRouteServerPeerRef fromRouteServerPeerId(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull String routeServerPeerId)
      Creates a new IRouteServerPeerRef from a routeServerPeerId.

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

    • isCfnRouteServerPeer

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

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

    • getAttrEndpointEniAddress

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

    • getAttrEndpointEniId

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

    • getAttrId

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

    • getAttrRouteServerId

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

    • getAttrSubnetId

      @Stability(Stable) @NotNull public String getAttrSubnetId()
      The ID of the subnet containing the route server peer.

    • getAttrVpcId

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

    • 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

    • getRouteServerPeerRef

      @Stability(Stable) @NotNull public RouteServerPeerReference getRouteServerPeerRef()
      A reference to a RouteServerPeer resource.
      Specified by:
      getRouteServerPeerRef in interface IRouteServerPeerRef

    • getBgpOptions

      @Stability(Stable) @NotNull public Object getBgpOptions()
      The BGP configuration options for this peer, including ASN (Autonomous System Number) and BFD (Bidrectional Forwarding Detection) settings.

      Returns union: either IResolvable or CfnRouteServerPeer.BgpOptionsProperty

    • setBgpOptions

      @Stability(Stable) public void setBgpOptions(@NotNull IResolvable value)
      The BGP configuration options for this peer, including ASN (Autonomous System Number) and BFD (Bidrectional Forwarding Detection) settings.

    • setBgpOptions

      @Stability(Stable) public void setBgpOptions(@NotNull CfnRouteServerPeer.BgpOptionsProperty value)
      The BGP configuration options for this peer, including ASN (Autonomous System Number) and BFD (Bidrectional Forwarding Detection) settings.

    • getPeerAddress

      @Stability(Stable) @NotNull public String getPeerAddress()
      The IPv4 address of the peer device.

    • setPeerAddress

      @Stability(Stable) public void setPeerAddress(@NotNull String value)
      The IPv4 address of the peer device.

    • getRouteServerEndpointId

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

    • setRouteServerEndpointId

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

    • getTags

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

    • setTags

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