AWS v6.83.0, Jun 16 25

AWS v6.83.0 published on Monday, Jun 16, 2025 by Pulumi

aws.vpc.RouteServerPeer

Explore with Pulumi AI

AWS v6.83.0 published on Monday, Jun 16, 2025 by Pulumi

pulumi/pulumi-aws

Example Usage

Basic Usage

import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";

const test = new aws.vpc.RouteServerPeer("test", {
    routeServerEndpointId: example.routeServerEndpointId,
    peerAddress: "10.0.1.250",
    bgpOptions: {
        peerAsn: 65200,
    },
    tags: {
        Name: "Appliance 1",
    },
});

import pulumi
import pulumi_aws as aws

test = aws.vpc.RouteServerPeer("test",
    route_server_endpoint_id=example["routeServerEndpointId"],
    peer_address="10.0.1.250",
    bgp_options={
        "peer_asn": 65200,
    },
    tags={
        "Name": "Appliance 1",
    })

package main

import (
	"github.com/pulumi/pulumi-aws/sdk/v6/go/aws/vpc"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := vpc.NewRouteServerPeer(ctx, "test", &vpc.RouteServerPeerArgs{
			RouteServerEndpointId: pulumi.Any(example.RouteServerEndpointId),
			PeerAddress:           pulumi.String("10.0.1.250"),
			BgpOptions: &vpc.RouteServerPeerBgpOptionsArgs{
				PeerAsn: pulumi.Int(65200),
			},
			Tags: pulumi.StringMap{
				"Name": pulumi.String("Appliance 1"),
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}

using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;

return await Deployment.RunAsync(() => 
{
    var test = new Aws.Vpc.RouteServerPeer("test", new()
    {
        RouteServerEndpointId = example.RouteServerEndpointId,
        PeerAddress = "10.0.1.250",
        BgpOptions = new Aws.Vpc.Inputs.RouteServerPeerBgpOptionsArgs
        {
            PeerAsn = 65200,
        },
        Tags = 
        {
            { "Name", "Appliance 1" },
        },
    });

});

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.vpc.RouteServerPeer;
import com.pulumi.aws.vpc.RouteServerPeerArgs;
import com.pulumi.aws.vpc.inputs.RouteServerPeerBgpOptionsArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        var test = new RouteServerPeer("test", RouteServerPeerArgs.builder()
            .routeServerEndpointId(example.routeServerEndpointId())
            .peerAddress("10.0.1.250")
            .bgpOptions(RouteServerPeerBgpOptionsArgs.builder()
                .peerAsn(65200)
                .build())
            .tags(Map.of("Name", "Appliance 1"))
            .build());

    }
}

resources:
  test:
    type: aws:vpc:RouteServerPeer
    properties:
      routeServerEndpointId: ${example.routeServerEndpointId}
      peerAddress: 10.0.1.250
      bgpOptions:
        peerAsn: 65200
      tags:
        Name: Appliance 1

Complete Configuration

import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";

const test = new aws.vpc.RouteServer("test", {
    amazonSideAsn: 4294967294,
    tags: {
        Name: "Test",
    },
});
const testVpcRouteServerAssociation = new aws.index.VpcRouteServerAssociation("test", {
    routeServerId: test.routeServerId,
    vpcId: testAwsVpc.id,
});
const testRouteServerEndpoint = new aws.vpc.RouteServerEndpoint("test", {
    routeServerId: test.routeServerId,
    subnetId: testAwsSubnet.id,
    tags: {
        Name: "Test Endpoint",
    },
}, {
    dependsOn: [testVpcRouteServerAssociation],
});
const testRouteServerPropagation = new aws.vpc.RouteServerPropagation("test", {
    routeServerId: test.routeServerId,
    routeTableId: testAwsRouteTable.id,
}, {
    dependsOn: [testVpcRouteServerAssociation],
});
const testRouteServerPeer = new aws.vpc.RouteServerPeer("test", {
    routeServerEndpointId: testRouteServerEndpoint.routeServerEndpointId,
    peerAddress: "10.0.1.250",
    bgpOptions: {
        peerAsn: 65000,
        peerLivenessDetection: "bgp-keepalive",
    },
    tags: {
        Name: "Test Appliance",
    },
});

import pulumi
import pulumi_aws as aws

test = aws.vpc.RouteServer("test",
    amazon_side_asn=4294967294,
    tags={
        "Name": "Test",
    })
test_vpc_route_server_association = aws.index.VpcRouteServerAssociation("test",
    route_server_id=test.route_server_id,
    vpc_id=test_aws_vpc.id)
test_route_server_endpoint = aws.vpc.RouteServerEndpoint("test",
    route_server_id=test.route_server_id,
    subnet_id=test_aws_subnet["id"],
    tags={
        "Name": "Test Endpoint",
    },
    opts = pulumi.ResourceOptions(depends_on=[test_vpc_route_server_association]))
test_route_server_propagation = aws.vpc.RouteServerPropagation("test",
    route_server_id=test.route_server_id,
    route_table_id=test_aws_route_table["id"],
    opts = pulumi.ResourceOptions(depends_on=[test_vpc_route_server_association]))
test_route_server_peer = aws.vpc.RouteServerPeer("test",
    route_server_endpoint_id=test_route_server_endpoint.route_server_endpoint_id,
    peer_address="10.0.1.250",
    bgp_options={
        "peer_asn": 65000,
        "peer_liveness_detection": "bgp-keepalive",
    },
    tags={
        "Name": "Test Appliance",
    })

package main

import (
	"github.com/pulumi/pulumi-aws/sdk/v6/go/aws"
	"github.com/pulumi/pulumi-aws/sdk/v6/go/aws/vpc"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		test, err := vpc.NewRouteServer(ctx, "test", &vpc.RouteServerArgs{
			AmazonSideAsn: pulumi.Int(4294967294),
			Tags: pulumi.StringMap{
				"Name": pulumi.String("Test"),
			},
		})
		if err != nil {
			return err
		}
		testVpcRouteServerAssociation, err := aws.NewVpcRouteServerAssociation(ctx, "test", &aws.VpcRouteServerAssociationArgs{
			RouteServerId: test.RouteServerId,
			VpcId:         testAwsVpc.Id,
		})
		if err != nil {
			return err
		}
		testRouteServerEndpoint, err := vpc.NewRouteServerEndpoint(ctx, "test", &vpc.RouteServerEndpointArgs{
			RouteServerId: test.RouteServerId,
			SubnetId:      pulumi.Any(testAwsSubnet.Id),
			Tags: pulumi.StringMap{
				"Name": pulumi.String("Test Endpoint"),
			},
		}, pulumi.DependsOn([]pulumi.Resource{
			testVpcRouteServerAssociation,
		}))
		if err != nil {
			return err
		}
		_, err = vpc.NewRouteServerPropagation(ctx, "test", &vpc.RouteServerPropagationArgs{
			RouteServerId: test.RouteServerId,
			RouteTableId:  pulumi.Any(testAwsRouteTable.Id),
		}, pulumi.DependsOn([]pulumi.Resource{
			testVpcRouteServerAssociation,
		}))
		if err != nil {
			return err
		}
		_, err = vpc.NewRouteServerPeer(ctx, "test", &vpc.RouteServerPeerArgs{
			RouteServerEndpointId: testRouteServerEndpoint.RouteServerEndpointId,
			PeerAddress:           pulumi.String("10.0.1.250"),
			BgpOptions: &vpc.RouteServerPeerBgpOptionsArgs{
				PeerAsn:               pulumi.Int(65000),
				PeerLivenessDetection: pulumi.String("bgp-keepalive"),
			},
			Tags: pulumi.StringMap{
				"Name": pulumi.String("Test Appliance"),
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}

using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;

return await Deployment.RunAsync(() => 
{
    var test = new Aws.Vpc.RouteServer("test", new()
    {
        AmazonSideAsn = 4294967294,
        Tags = 
        {
            { "Name", "Test" },
        },
    });

    var testVpcRouteServerAssociation = new Aws.Index.VpcRouteServerAssociation("test", new()
    {
        RouteServerId = test.RouteServerId,
        VpcId = testAwsVpc.Id,
    });

    var testRouteServerEndpoint = new Aws.Vpc.RouteServerEndpoint("test", new()
    {
        RouteServerId = test.RouteServerId,
        SubnetId = testAwsSubnet.Id,
        Tags = 
        {
            { "Name", "Test Endpoint" },
        },
    }, new CustomResourceOptions
    {
        DependsOn =
        {
            testVpcRouteServerAssociation,
        },
    });

    var testRouteServerPropagation = new Aws.Vpc.RouteServerPropagation("test", new()
    {
        RouteServerId = test.RouteServerId,
        RouteTableId = testAwsRouteTable.Id,
    }, new CustomResourceOptions
    {
        DependsOn =
        {
            testVpcRouteServerAssociation,
        },
    });

    var testRouteServerPeer = new Aws.Vpc.RouteServerPeer("test", new()
    {
        RouteServerEndpointId = testRouteServerEndpoint.RouteServerEndpointId,
        PeerAddress = "10.0.1.250",
        BgpOptions = new Aws.Vpc.Inputs.RouteServerPeerBgpOptionsArgs
        {
            PeerAsn = 65000,
            PeerLivenessDetection = "bgp-keepalive",
        },
        Tags = 
        {
            { "Name", "Test Appliance" },
        },
    });

});

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.vpc.RouteServer;
import com.pulumi.aws.vpc.RouteServerArgs;
import com.pulumi.aws.vpcRouteServerAssociation;
import com.pulumi.aws.vpcRouteServerAssociationArgs;
import com.pulumi.aws.vpc.RouteServerEndpoint;
import com.pulumi.aws.vpc.RouteServerEndpointArgs;
import com.pulumi.aws.vpc.RouteServerPropagation;
import com.pulumi.aws.vpc.RouteServerPropagationArgs;
import com.pulumi.aws.vpc.RouteServerPeer;
import com.pulumi.aws.vpc.RouteServerPeerArgs;
import com.pulumi.aws.vpc.inputs.RouteServerPeerBgpOptionsArgs;
import com.pulumi.resources.CustomResourceOptions;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        var test = new RouteServer("test", RouteServerArgs.builder()
            .amazonSideAsn(4294967294)
            .tags(Map.of("Name", "Test"))
            .build());

        var testVpcRouteServerAssociation = new VpcRouteServerAssociation("testVpcRouteServerAssociation", VpcRouteServerAssociationArgs.builder()
            .routeServerId(test.routeServerId())
            .vpcId(testAwsVpc.id())
            .build());

        var testRouteServerEndpoint = new RouteServerEndpoint("testRouteServerEndpoint", RouteServerEndpointArgs.builder()
            .routeServerId(test.routeServerId())
            .subnetId(testAwsSubnet.id())
            .tags(Map.of("Name", "Test Endpoint"))
            .build(), CustomResourceOptions.builder()
                .dependsOn(testVpcRouteServerAssociation)
                .build());

        var testRouteServerPropagation = new RouteServerPropagation("testRouteServerPropagation", RouteServerPropagationArgs.builder()
            .routeServerId(test.routeServerId())
            .routeTableId(testAwsRouteTable.id())
            .build(), CustomResourceOptions.builder()
                .dependsOn(testVpcRouteServerAssociation)
                .build());

        var testRouteServerPeer = new RouteServerPeer("testRouteServerPeer", RouteServerPeerArgs.builder()
            .routeServerEndpointId(testRouteServerEndpoint.routeServerEndpointId())
            .peerAddress("10.0.1.250")
            .bgpOptions(RouteServerPeerBgpOptionsArgs.builder()
                .peerAsn(65000)
                .peerLivenessDetection("bgp-keepalive")
                .build())
            .tags(Map.of("Name", "Test Appliance"))
            .build());

    }
}

resources:
  test:
    type: aws:vpc:RouteServer
    properties:
      amazonSideAsn: 4.294967294e+09
      tags:
        Name: Test
  testVpcRouteServerAssociation:
    type: aws:vpcRouteServerAssociation
    name: test
    properties:
      routeServerId: ${test.routeServerId}
      vpcId: ${testAwsVpc.id}
  testRouteServerEndpoint:
    type: aws:vpc:RouteServerEndpoint
    name: test
    properties:
      routeServerId: ${test.routeServerId}
      subnetId: ${testAwsSubnet.id}
      tags:
        Name: Test Endpoint
    options:
      dependsOn:
        - ${testVpcRouteServerAssociation}
  testRouteServerPropagation:
    type: aws:vpc:RouteServerPropagation
    name: test
    properties:
      routeServerId: ${test.routeServerId}
      routeTableId: ${testAwsRouteTable.id}
    options:
      dependsOn:
        - ${testVpcRouteServerAssociation}
  testRouteServerPeer:
    type: aws:vpc:RouteServerPeer
    name: test
    properties:
      routeServerEndpointId: ${testRouteServerEndpoint.routeServerEndpointId}
      peerAddress: 10.0.1.250
      bgpOptions:
        peerAsn: 65000
        peerLivenessDetection: bgp-keepalive
      tags:
        Name: Test Appliance

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,
                    peer_address: Optional[str] = None,
                    route_server_endpoint_id: Optional[str] = None,
                    bgp_options: Optional[RouteServerPeerBgpOptionsArgs] = None,
                    tags: Optional[Mapping[str, str]] = None,
                    timeouts: Optional[RouteServerPeerTimeoutsArgs] = 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:vpc:RouteServerPeer
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

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.

Constructor example

The following reference example uses placeholder values for all input properties.

var routeServerPeerResource = new Aws.Vpc.RouteServerPeer("routeServerPeerResource", new()
{
    PeerAddress = "string",
    RouteServerEndpointId = "string",
    BgpOptions = new Aws.Vpc.Inputs.RouteServerPeerBgpOptionsArgs
    {
        PeerAsn = 0,
        PeerLivenessDetection = "string",
    },
    Tags = 
    {
        { "string", "string" },
    },
    Timeouts = new Aws.Vpc.Inputs.RouteServerPeerTimeoutsArgs
    {
        Create = "string",
        Delete = "string",
    },
});

example, err := vpc.NewRouteServerPeer(ctx, "routeServerPeerResource", &vpc.RouteServerPeerArgs{
	PeerAddress:           pulumi.String("string"),
	RouteServerEndpointId: pulumi.String("string"),
	BgpOptions: &vpc.RouteServerPeerBgpOptionsArgs{
		PeerAsn:               pulumi.Int(0),
		PeerLivenessDetection: pulumi.String("string"),
	},
	Tags: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
	Timeouts: &vpc.RouteServerPeerTimeoutsArgs{
		Create: pulumi.String("string"),
		Delete: pulumi.String("string"),
	},
})

var routeServerPeerResource = new RouteServerPeer("routeServerPeerResource", RouteServerPeerArgs.builder()
    .peerAddress("string")
    .routeServerEndpointId("string")
    .bgpOptions(RouteServerPeerBgpOptionsArgs.builder()
        .peerAsn(0)
        .peerLivenessDetection("string")
        .build())
    .tags(Map.of("string", "string"))
    .timeouts(RouteServerPeerTimeoutsArgs.builder()
        .create("string")
        .delete("string")
        .build())
    .build());

route_server_peer_resource = aws.vpc.RouteServerPeer("routeServerPeerResource",
    peer_address="string",
    route_server_endpoint_id="string",
    bgp_options={
        "peer_asn": 0,
        "peer_liveness_detection": "string",
    },
    tags={
        "string": "string",
    },
    timeouts={
        "create": "string",
        "delete": "string",
    })

const routeServerPeerResource = new aws.vpc.RouteServerPeer("routeServerPeerResource", {
    peerAddress: "string",
    routeServerEndpointId: "string",
    bgpOptions: {
        peerAsn: 0,
        peerLivenessDetection: "string",
    },
    tags: {
        string: "string",
    },
    timeouts: {
        create: "string",
        "delete": "string",
    },
});

type: aws:vpc:RouteServerPeer
properties:
    bgpOptions:
        peerAsn: 0
        peerLivenessDetection: string
    peerAddress: string
    routeServerEndpointId: string
    tags:
        string: string
    timeouts:
        create: string
        delete: string

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:

PeerAddress string: The IPv4 address of the peer device.
RouteServerEndpointId string: The ID of the route server endpoint for which to create a peer.
BgpOptions RouteServerPeerBgpOptions: The BGP options for the peer, including ASN (Autonomous System Number) and BFD (Bidrectional Forwarding Detection) settings. Configuration block with BGP Options configuration Detailed below
Tags Dictionary<string, string>
Timeouts RouteServerPeerTimeouts

PeerAddress string: The IPv4 address of the peer device.
RouteServerEndpointId string: The ID of the route server endpoint for which to create a peer.
BgpOptions RouteServerPeerBgpOptionsArgs: The BGP options for the peer, including ASN (Autonomous System Number) and BFD (Bidrectional Forwarding Detection) settings. Configuration block with BGP Options configuration Detailed below
Tags map[string]string
Timeouts RouteServerPeerTimeoutsArgs

peerAddress String: The IPv4 address of the peer device.
routeServerEndpointId String: The ID of the route server endpoint for which to create a peer.
bgpOptions RouteServerPeerBgpOptions: The BGP options for the peer, including ASN (Autonomous System Number) and BFD (Bidrectional Forwarding Detection) settings. Configuration block with BGP Options configuration Detailed below
tags Map<String,String>
timeouts RouteServerPeerTimeouts

peerAddress string: The IPv4 address of the peer device.
routeServerEndpointId string: The ID of the route server endpoint for which to create a peer.
bgpOptions RouteServerPeerBgpOptions: The BGP options for the peer, including ASN (Autonomous System Number) and BFD (Bidrectional Forwarding Detection) settings. Configuration block with BGP Options configuration Detailed below
tags {[key: string]: string}
timeouts RouteServerPeerTimeouts

peer_address str: The IPv4 address of the peer device.
route_server_endpoint_id str: The ID of the route server endpoint for which to create a peer.
bgp_options RouteServerPeerBgpOptionsArgs: The BGP options for the peer, including ASN (Autonomous System Number) and BFD (Bidrectional Forwarding Detection) settings. Configuration block with BGP Options configuration Detailed below
tags Mapping[str, str]
timeouts RouteServerPeerTimeoutsArgs

peerAddress String: The IPv4 address of the peer device.
routeServerEndpointId String: The ID of the route server endpoint for which to create a peer.
bgpOptions Property Map: The BGP options for the peer, including ASN (Autonomous System Number) and BFD (Bidrectional Forwarding Detection) settings. Configuration block with BGP Options configuration Detailed below
tags Map<String>
timeouts Property Map

Outputs

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

Arn string: The ARN of the route server peer.
EndpointEniAddress string: The IP address of the Elastic network interface for the route server endpoint.
EndpointEniId string: The ID of the Elastic network interface for the route server endpoint.
Id string: The provider-assigned unique ID for this managed resource.
RouteServerId string: The ID of the route server associated with this peer.
RouteServerPeerId string: The unique identifier of the route server peer.
SubnetId string: The ID of the subnet containing the route server peer.
TagsAll Dictionary<string, string>: A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.
Deprecated: Please use tags instead.
VpcId string: The ID of the VPC containing the route server peer.

Arn string: The ARN of the route server peer.
EndpointEniAddress string: The IP address of the Elastic network interface for the route server endpoint.
EndpointEniId string: The ID of the Elastic network interface for the route server endpoint.
Id string: The provider-assigned unique ID for this managed resource.
RouteServerId string: The ID of the route server associated with this peer.
RouteServerPeerId string: The unique identifier of the route server peer.
SubnetId string: The ID of the subnet containing the route server peer.
TagsAll map[string]string: A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.
Deprecated: Please use tags instead.
VpcId string: The ID of the VPC containing the route server peer.

arn String: The ARN of the route server peer.
endpointEniAddress String: The IP address of the Elastic network interface for the route server endpoint.
endpointEniId String: The ID of the Elastic network interface for the route server endpoint.
id String: The provider-assigned unique ID for this managed resource.
routeServerId String: The ID of the route server associated with this peer.
routeServerPeerId String: The unique identifier of the route server peer.
subnetId String: The ID of the subnet containing the route server peer.
tagsAll Map<String,String>: A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.
Deprecated: Please use tags instead.
vpcId String: The ID of the VPC containing the route server peer.

arn string: The ARN of the route server peer.
endpointEniAddress string: The IP address of the Elastic network interface for the route server endpoint.
endpointEniId string: The ID of the Elastic network interface for the route server endpoint.
id string: The provider-assigned unique ID for this managed resource.
routeServerId string: The ID of the route server associated with this peer.
routeServerPeerId string: The unique identifier of the route server peer.
subnetId string: The ID of the subnet containing the route server peer.
tagsAll {[key: string]: string}: A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.
Deprecated: Please use tags instead.
vpcId string: The ID of the VPC containing the route server peer.

arn str: The ARN of the route server peer.
endpoint_eni_address str: The IP address of the Elastic network interface for the route server endpoint.
endpoint_eni_id str: The ID of the Elastic network interface for the route server endpoint.
id str: The provider-assigned unique ID for this managed resource.
route_server_id str: The ID of the route server associated with this peer.
route_server_peer_id str: The unique identifier of the route server peer.
subnet_id str: The ID of the subnet containing the route server peer.
tags_all Mapping[str, str]: A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.
Deprecated: Please use tags instead.
vpc_id str: The ID of the VPC containing the route server peer.

arn String: The ARN of the route server peer.
endpointEniAddress String: The IP address of the Elastic network interface for the route server endpoint.
endpointEniId String: The ID of the Elastic network interface for the route server endpoint.
id String: The provider-assigned unique ID for this managed resource.
routeServerId String: The ID of the route server associated with this peer.
routeServerPeerId String: The unique identifier of the route server peer.
subnetId String: The ID of the subnet containing the route server peer.
tagsAll Map<String>: A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.
Deprecated: Please use tags instead.
vpcId String: The ID of the VPC containing the route server peer.

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>, state?: RouteServerPeerState, opts?: CustomResourceOptions): RouteServerPeer

@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        arn: Optional[str] = None,
        bgp_options: Optional[RouteServerPeerBgpOptionsArgs] = None,
        endpoint_eni_address: Optional[str] = None,
        endpoint_eni_id: Optional[str] = None,
        peer_address: Optional[str] = None,
        route_server_endpoint_id: Optional[str] = None,
        route_server_id: Optional[str] = None,
        route_server_peer_id: Optional[str] = None,
        subnet_id: Optional[str] = None,
        tags: Optional[Mapping[str, str]] = None,
        tags_all: Optional[Mapping[str, str]] = None,
        timeouts: Optional[RouteServerPeerTimeoutsArgs] = None,
        vpc_id: Optional[str] = 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, RouteServerPeerState? state, CustomResourceOptions? opts = null)

public static RouteServerPeer get(String name, Output<String> id, RouteServerPeerState state, CustomResourceOptions options)

resources:  _:    type: aws:vpc:RouteServerPeer    get:      id: ${id}

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

resource_name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

The following state arguments are supported:

Arn string: The ARN of the route server peer.
BgpOptions RouteServerPeerBgpOptions: The BGP options for the peer, including ASN (Autonomous System Number) and BFD (Bidrectional Forwarding Detection) settings. Configuration block with BGP Options configuration Detailed below
EndpointEniAddress string: The IP address of the Elastic network interface for the route server endpoint.
EndpointEniId string: The ID of the Elastic network interface for the route server endpoint.
PeerAddress string: The IPv4 address of the peer device.
RouteServerEndpointId string: The ID of the route server endpoint for which to create a peer.
RouteServerId string: The ID of the route server associated with this peer.
RouteServerPeerId string: The unique identifier of the route server peer.
SubnetId string: The ID of the subnet containing the route server peer.
Tags Dictionary<string, string>
TagsAll Dictionary<string, string>: A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.
Deprecated: Please use tags instead.
Timeouts RouteServerPeerTimeouts
VpcId string: The ID of the VPC containing the route server peer.

Arn string: The ARN of the route server peer.
BgpOptions RouteServerPeerBgpOptionsArgs: The BGP options for the peer, including ASN (Autonomous System Number) and BFD (Bidrectional Forwarding Detection) settings. Configuration block with BGP Options configuration Detailed below
EndpointEniAddress string: The IP address of the Elastic network interface for the route server endpoint.
EndpointEniId string: The ID of the Elastic network interface for the route server endpoint.
PeerAddress string: The IPv4 address of the peer device.
RouteServerEndpointId string: The ID of the route server endpoint for which to create a peer.
RouteServerId string: The ID of the route server associated with this peer.
RouteServerPeerId string: The unique identifier of the route server peer.
SubnetId string: The ID of the subnet containing the route server peer.
Tags map[string]string
TagsAll map[string]string: A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.
Deprecated: Please use tags instead.
Timeouts RouteServerPeerTimeoutsArgs
VpcId string: The ID of the VPC containing the route server peer.

arn String: The ARN of the route server peer.
bgpOptions RouteServerPeerBgpOptions: The BGP options for the peer, including ASN (Autonomous System Number) and BFD (Bidrectional Forwarding Detection) settings. Configuration block with BGP Options configuration Detailed below
endpointEniAddress String: The IP address of the Elastic network interface for the route server endpoint.
endpointEniId String: The ID of the Elastic network interface for the route server endpoint.
peerAddress String: The IPv4 address of the peer device.
routeServerEndpointId String: The ID of the route server endpoint for which to create a peer.
routeServerId String: The ID of the route server associated with this peer.
routeServerPeerId String: The unique identifier of the route server peer.
subnetId String: The ID of the subnet containing the route server peer.
tags Map<String,String>
tagsAll Map<String,String>: A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.
Deprecated: Please use tags instead.
timeouts RouteServerPeerTimeouts
vpcId String: The ID of the VPC containing the route server peer.

arn string: The ARN of the route server peer.
bgpOptions RouteServerPeerBgpOptions: The BGP options for the peer, including ASN (Autonomous System Number) and BFD (Bidrectional Forwarding Detection) settings. Configuration block with BGP Options configuration Detailed below
endpointEniAddress string: The IP address of the Elastic network interface for the route server endpoint.
endpointEniId string: The ID of the Elastic network interface for the route server endpoint.
peerAddress string: The IPv4 address of the peer device.
routeServerEndpointId string: The ID of the route server endpoint for which to create a peer.
routeServerId string: The ID of the route server associated with this peer.
routeServerPeerId string: The unique identifier of the route server peer.
subnetId string: The ID of the subnet containing the route server peer.
tags {[key: string]: string}
tagsAll {[key: string]: string}: A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.
Deprecated: Please use tags instead.
timeouts RouteServerPeerTimeouts
vpcId string: The ID of the VPC containing the route server peer.

arn str: The ARN of the route server peer.
bgp_options RouteServerPeerBgpOptionsArgs: The BGP options for the peer, including ASN (Autonomous System Number) and BFD (Bidrectional Forwarding Detection) settings. Configuration block with BGP Options configuration Detailed below
endpoint_eni_address str: The IP address of the Elastic network interface for the route server endpoint.
endpoint_eni_id str: The ID of the Elastic network interface for the route server endpoint.
peer_address str: The IPv4 address of the peer device.
route_server_endpoint_id str: The ID of the route server endpoint for which to create a peer.
route_server_id str: The ID of the route server associated with this peer.
route_server_peer_id str: The unique identifier of the route server peer.
subnet_id str: The ID of the subnet containing the route server peer.
tags Mapping[str, str]
tags_all Mapping[str, str]: A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.
Deprecated: Please use tags instead.
timeouts RouteServerPeerTimeoutsArgs
vpc_id str: The ID of the VPC containing the route server peer.

arn String: The ARN of the route server peer.
bgpOptions Property Map: The BGP options for the peer, including ASN (Autonomous System Number) and BFD (Bidrectional Forwarding Detection) settings. Configuration block with BGP Options configuration Detailed below
endpointEniAddress String: The IP address of the Elastic network interface for the route server endpoint.
endpointEniId String: The ID of the Elastic network interface for the route server endpoint.
peerAddress String: The IPv4 address of the peer device.
routeServerEndpointId String: The ID of the route server endpoint for which to create a peer.
routeServerId String: The ID of the route server associated with this peer.
routeServerPeerId String: The unique identifier of the route server peer.
subnetId String: The ID of the subnet containing the route server peer.
tags Map<String>
tagsAll Map<String>: A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.
Deprecated: Please use tags instead.
timeouts Property Map
vpcId String: The ID of the VPC containing the route server peer.

Supporting Types

RouteServerPeerBgpOptions, RouteServerPeerBgpOptionsArgs

PeerAsn int

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.

PeerLivenessDetection string