1. Registry
  2. Packages
  3. AWS Cloud Control
  4. API Docs
  5. ec2
  6. RouteServerPeer

We recommend new projects start with resources from the AWS provider.

Viewing docs for AWS Cloud Control v1.86.0
published on Wednesday, Nov 18, 2026 by Pulumi
aws-native logo aws-native logo AWS Cloud Control

We recommend new projects start with resources from the AWS provider.

Viewing docs for AWS Cloud Control v1.86.0
published on Wednesday, Nov 18, 2026 by Pulumi

    VPC Route Server Peer

    Create RouteServerPeer Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new RouteServerPeer(name: string, args: RouteServerPeerArgs, opts?: CustomResourceOptions);
    @overload
    def RouteServerPeer(resource_name: str,
                        args: RouteServerPeerArgs,
                        opts: Optional[ResourceOptions] = None)
    
    @overload
    def RouteServerPeer(resource_name: str,
                        opts: Optional[ResourceOptions] = None,
                        bgp_options: Optional[RouteServerPeerBgpOptionsArgs] = None,
                        peer_address: Optional[str] = None,
                        route_server_endpoint_id: Optional[str] = None,
                        tags: Optional[Sequence[_root_inputs.TagArgs]] = None)
    func NewRouteServerPeer(ctx *Context, name string, args RouteServerPeerArgs, opts ...ResourceOption) (*RouteServerPeer, error)
    public RouteServerPeer(string name, RouteServerPeerArgs args, CustomResourceOptions? opts = null)
    public RouteServerPeer(String name, RouteServerPeerArgs args)
    public RouteServerPeer(String name, RouteServerPeerArgs args, CustomResourceOptions options)
    
    type: aws-native:ec2:RouteServerPeer
    properties: # The arguments to resource properties.
    options: # Bag of options to control resource's behavior.
    
    
    resource "aws-native_ec2_route_server_peer" "name" {
        # resource properties
    }

    Parameters

    name string
    The unique name of the resource.
    args RouteServerPeerArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args RouteServerPeerArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args RouteServerPeerArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args RouteServerPeerArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args RouteServerPeerArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    RouteServerPeer Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

    The RouteServerPeer resource accepts the following input properties:

    BgpOptions Pulumi.AwsNative.Ec2.Inputs.RouteServerPeerBgpOptions
    The BGP configuration options for this peer, including ASN (Autonomous System Number) and BFD (Bidrectional Forwarding Detection) settings.
    PeerAddress string
    IP address of the Route Server Peer
    RouteServerEndpointId string
    Route Server Endpoint ID
    Tags List<Pulumi.AwsNative.Inputs.Tag>
    An array of key-value pairs to apply to this resource.
    BgpOptions RouteServerPeerBgpOptionsArgs
    The BGP configuration options for this peer, including ASN (Autonomous System Number) and BFD (Bidrectional Forwarding Detection) settings.
    PeerAddress string
    IP address of the Route Server Peer
    RouteServerEndpointId string
    Route Server Endpoint ID
    Tags TagArgs
    An array of key-value pairs to apply to this resource.
    bgp_options object
    The BGP configuration options for this peer, including ASN (Autonomous System Number) and BFD (Bidrectional Forwarding Detection) settings.
    peer_address string
    IP address of the Route Server Peer
    route_server_endpoint_id string
    Route Server Endpoint ID
    tags list(object)
    An array of key-value pairs to apply to this resource.
    bgpOptions RouteServerPeerBgpOptions
    The BGP configuration options for this peer, including ASN (Autonomous System Number) and BFD (Bidrectional Forwarding Detection) settings.
    peerAddress String
    IP address of the Route Server Peer
    routeServerEndpointId String
    Route Server Endpoint ID
    tags List<Tag>
    An array of key-value pairs to apply to this resource.
    bgpOptions RouteServerPeerBgpOptions
    The BGP configuration options for this peer, including ASN (Autonomous System Number) and BFD (Bidrectional Forwarding Detection) settings.
    peerAddress string
    IP address of the Route Server Peer
    routeServerEndpointId string
    Route Server Endpoint ID
    tags Tag[]
    An array of key-value pairs to apply to this resource.
    bgp_options RouteServerPeerBgpOptionsArgs
    The BGP configuration options for this peer, including ASN (Autonomous System Number) and BFD (Bidrectional Forwarding Detection) settings.
    peer_address str
    IP address of the Route Server Peer
    route_server_endpoint_id str
    Route Server Endpoint ID
    tags Sequence[TagArgs]
    An array of key-value pairs to apply to this resource.
    bgpOptions Property Map
    The BGP configuration options for this peer, including ASN (Autonomous System Number) and BFD (Bidrectional Forwarding Detection) settings.
    peerAddress String
    IP address of the Route Server Peer
    routeServerEndpointId String
    Route Server Endpoint ID
    tags List<Property Map>
    An array of key-value pairs to apply to this resource.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the RouteServerPeer resource produces the following output properties:

    Arn string
    The Amazon Resource Name (ARN) of the Route Server Peer.
    AwsId string
    The ID of the Route Server Peer.
    EndpointEniAddress string
    Elastic Network Interface IP address owned by the Route Server Endpoint
    EndpointEniId string
    Elastic Network Interface ID owned by the Route Server Endpoint
    Id string
    The provider-assigned unique ID for this managed resource.
    RouteServerId string
    Route Server ID
    SubnetId string
    Subnet ID
    VpcId string
    VPC ID
    Arn string
    The Amazon Resource Name (ARN) of the Route Server Peer.
    AwsId string
    The ID of the Route Server Peer.
    EndpointEniAddress string
    Elastic Network Interface IP address owned by the Route Server Endpoint
    EndpointEniId string
    Elastic Network Interface ID owned by the Route Server Endpoint
    Id string
    The provider-assigned unique ID for this managed resource.
    RouteServerId string
    Route Server ID
    SubnetId string
    Subnet ID
    VpcId string
    VPC ID
    arn string
    The Amazon Resource Name (ARN) of the Route Server Peer.
    aws_id string
    The ID of the Route Server Peer.
    endpoint_eni_address string
    Elastic Network Interface IP address owned by the Route Server Endpoint
    endpoint_eni_id string
    Elastic Network Interface ID owned by the Route Server Endpoint
    id string
    The provider-assigned unique ID for this managed resource.
    route_server_id string
    Route Server ID
    subnet_id string
    Subnet ID
    vpc_id string
    VPC ID
    arn String
    The Amazon Resource Name (ARN) of the Route Server Peer.
    awsId String
    The ID of the Route Server Peer.
    endpointEniAddress String
    Elastic Network Interface IP address owned by the Route Server Endpoint
    endpointEniId String
    Elastic Network Interface ID owned by the Route Server Endpoint
    id String
    The provider-assigned unique ID for this managed resource.
    routeServerId String
    Route Server ID
    subnetId String
    Subnet ID
    vpcId String
    VPC ID
    arn string
    The Amazon Resource Name (ARN) of the Route Server Peer.
    awsId string
    The ID of the Route Server Peer.
    endpointEniAddress string
    Elastic Network Interface IP address owned by the Route Server Endpoint
    endpointEniId string
    Elastic Network Interface ID owned by the Route Server Endpoint
    id string
    The provider-assigned unique ID for this managed resource.
    routeServerId string
    Route Server ID
    subnetId string
    Subnet ID
    vpcId string
    VPC ID
    arn str
    The Amazon Resource Name (ARN) of the Route Server Peer.
    aws_id str
    The ID of the Route Server Peer.
    endpoint_eni_address str
    Elastic Network Interface IP address owned by the Route Server Endpoint
    endpoint_eni_id str
    Elastic Network Interface ID owned by the Route Server Endpoint
    id str
    The provider-assigned unique ID for this managed resource.
    route_server_id str
    Route Server ID
    subnet_id str
    Subnet ID
    vpc_id str
    VPC ID
    arn String
    The Amazon Resource Name (ARN) of the Route Server Peer.
    awsId String
    The ID of the Route Server Peer.
    endpointEniAddress String
    Elastic Network Interface IP address owned by the Route Server Endpoint
    endpointEniId String
    Elastic Network Interface ID owned by the Route Server Endpoint
    id String
    The provider-assigned unique ID for this managed resource.
    routeServerId String
    Route Server ID
    subnetId String
    Subnet ID
    vpcId String
    VPC ID

    Look up Existing RouteServerPeer Resource

    Get an existing RouteServerPeer resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

    public static get(name: string, id: Input<ID>, opts?: CustomResourceOptions): RouteServerPeer
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None) -> RouteServerPeer
    func GetRouteServerPeer(ctx *Context, name string, id IDInput, state *RouteServerPeerState, opts ...ResourceOption) (*RouteServerPeer, error)
    public static RouteServerPeer Get(string name, Input<string> id, CustomResourceOptions? opts = null)
    public static RouteServerPeer get(String name, Output<String> id, CustomResourceOptions options)
    resources:  existingRouteServerPeer:    type: aws-native:ec2:RouteServerPeer    get:      id: ${id}
    import {
      to = aws-native_ec2_route_server_peer.example
      id = "${id}"
    }
    
    name string
    The unique name of the resulting resource.
    id Input<ID>
    The unique provider ID of the resource to look up.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resulting resource.
    id str
    The unique provider ID of the resource to look up.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resulting resource.
    id IDInput
    The unique provider ID of the resource to look up.
    state RouteServerPeerState
    Pass nil. This resource has no state arguments.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resulting resource.
    id Input<string>
    The unique provider ID of the resource to look up.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resulting resource.
    id Output<String>
    The unique provider ID of the resource to look up.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Supporting Types

    RouteServerPeerBgpOptions, RouteServerPeerBgpOptionsArgs

    BGP Options

    PeerAsn int
    BGP ASN of the Route Server Peer
    PeerLivenessDetection RouteServerPeerBgpOptionsPeerLivenessDetection
    BGP Liveness Detection
    peer_asn number
    BGP ASN of the Route Server Peer
    peer_liveness_detection "bfd" | "bgp-keepalive"
    BGP Liveness Detection
    peerAsn Integer
    BGP ASN of the Route Server Peer
    peerLivenessDetection RouteServerPeerBgpOptionsPeerLivenessDetection
    BGP Liveness Detection
    peerAsn number
    BGP ASN of the Route Server Peer
    peerLivenessDetection RouteServerPeerBgpOptionsPeerLivenessDetection
    BGP Liveness Detection
    peer_asn int
    BGP ASN of the Route Server Peer
    peer_liveness_detection RouteServerPeerBgpOptionsPeerLivenessDetection
    BGP Liveness Detection
    peerAsn Number
    BGP ASN of the Route Server Peer
    peerLivenessDetection "bfd" | "bgp-keepalive"
    BGP Liveness Detection

    RouteServerPeerBgpOptionsPeerLivenessDetection

    BGP Liveness Detection

    NameValue
    Bfdbfd
    BgpKeepalivebgp-keepalive
    NameValue
    RouteServerPeerBgpOptionsPeerLivenessDetectionBfdbfd
    RouteServerPeerBgpOptionsPeerLivenessDetectionBgpKeepalivebgp-keepalive
    Value
    bfd
    bgp-keepalive
    NameValue
    Bfdbfd
    BgpKeepalivebgp-keepalive
    NameValue
    Bfdbfd
    BgpKeepalivebgp-keepalive
    NameValue
    BFDbfd
    BGP_KEEPALIVEbgp-keepalive
    Value
    bfd
    bgp-keepalive

    Tag, TagArgs

    A set of tags to apply to the resource.

    Key string
    The key name of the tag
    Value string
    The value of the tag
    Key string
    The key name of the tag
    Value string
    The value of the tag
    key string
    The key name of the tag
    value string
    The value of the tag
    key String
    The key name of the tag
    value String
    The value of the tag
    key string
    The key name of the tag
    value string
    The value of the tag
    key str
    The key name of the tag
    value str
    The value of the tag
    key String
    The key name of the tag
    value String
    The value of the tag

    Package Details

    Repository
    AWS Native pulumi/pulumi-aws-native
    License
    Apache-2.0
    aws-native logo aws-native logo AWS Cloud Control

    We recommend new projects start with resources from the AWS provider.

    Viewing docs for AWS Cloud Control v1.86.0
    published on Wednesday, Nov 18, 2026 by Pulumi

      Try Pulumi Cloud free.
      Your team will thank you.

      Start free trial