AWS v7.10.0 published on Friday, Oct 24, 2025 by Pulumi
aws.vpc.RouteServerPeer
Provides a resource for managing a VPC (Virtual Private Cloud) Route Server Peer.
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/v7/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/v7/go/aws"
"github.com/pulumi/pulumi-aws/sdk/v7/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,
region: Optional[str] = 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",
},
Region = "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"),
},
Region: 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())
.region("string")
.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",
},
region="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",
},
region: "string",
tags: {
string: "string",
},
timeouts: {
create: "string",
"delete": "string",
},
});
type: aws:vpc:RouteServerPeer
properties:
bgpOptions:
peerAsn: 0
peerLivenessDetection: string
peerAddress: string
region: 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:
- Peer
Address string - The IPv4 address of the peer device.
- Route
Server stringEndpoint Id The ID of the route server endpoint for which to create a peer.
The following arguments are optional:
- Bgp
Options RouteServer Peer Bgp Options - 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
- Region string
- Region where this resource will be managed. Defaults to the Region set in the provider configuration.
- Dictionary<string, string>
- A map of tags to assign to the resource. If configured with a provider
default_tagsconfiguration block present, tags with matching keys will overwrite those defined at the provider-level. - Timeouts
Route
Server Peer Timeouts
- Peer
Address string - The IPv4 address of the peer device.
- Route
Server stringEndpoint Id The ID of the route server endpoint for which to create a peer.
The following arguments are optional:
- Bgp
Options RouteServer Peer Bgp Options Args - 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
- Region string
- Region where this resource will be managed. Defaults to the Region set in the provider configuration.
- map[string]string
- A map of tags to assign to the resource. If configured with a provider
default_tagsconfiguration block present, tags with matching keys will overwrite those defined at the provider-level. - Timeouts
Route
Server Peer Timeouts Args
- peer
Address String - The IPv4 address of the peer device.
- route
Server StringEndpoint Id The ID of the route server endpoint for which to create a peer.
The following arguments are optional:
- bgp
Options RouteServer Peer Bgp Options - 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
- region String
- Region where this resource will be managed. Defaults to the Region set in the provider configuration.
- Map<String,String>
- A map of tags to assign to the resource. If configured with a provider
default_tagsconfiguration block present, tags with matching keys will overwrite those defined at the provider-level. - timeouts
Route
Server Peer Timeouts
- peer
Address string - The IPv4 address of the peer device.
- route
Server stringEndpoint Id The ID of the route server endpoint for which to create a peer.
The following arguments are optional:
- bgp
Options RouteServer Peer Bgp Options - 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
- region string
- Region where this resource will be managed. Defaults to the Region set in the provider configuration.
- {[key: string]: string}
- A map of tags to assign to the resource. If configured with a provider
default_tagsconfiguration block present, tags with matching keys will overwrite those defined at the provider-level. - timeouts
Route
Server Peer Timeouts
- peer_
address str - The IPv4 address of the peer device.
- route_
server_ strendpoint_ id The ID of the route server endpoint for which to create a peer.
The following arguments are optional:
- bgp_
options RouteServer Peer Bgp Options Args - 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
- region str
- Region where this resource will be managed. Defaults to the Region set in the provider configuration.
- Mapping[str, str]
- A map of tags to assign to the resource. If configured with a provider
default_tagsconfiguration block present, tags with matching keys will overwrite those defined at the provider-level. - timeouts
Route
Server Peer Timeouts Args
- peer
Address String - The IPv4 address of the peer device.
- route
Server StringEndpoint Id The ID of the route server endpoint for which to create a peer.
The following arguments are optional:
- bgp
Options 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
- region String
- Region where this resource will be managed. Defaults to the Region set in the provider configuration.
- Map<String>
- A map of tags to assign to the resource. If configured with a provider
default_tagsconfiguration block present, tags with matching keys will overwrite those defined at the provider-level. - 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.
- Endpoint
Eni stringAddress - The IP address of the Elastic network interface for the route server endpoint.
- Endpoint
Eni stringId - The ID of the Elastic network interface for the route server endpoint.
- Id string
- The provider-assigned unique ID for this managed resource.
- Route
Server stringId - The ID of the route server associated with this peer.
- Route
Server stringPeer Id - The unique identifier of the route server peer.
- Subnet
Id string - The ID of the subnet containing the route server peer.
- Dictionary<string, string>
- A map of tags assigned to the resource, including those inherited from the provider
default_tagsconfiguration block. - Vpc
Id string - The ID of the VPC containing the route server peer.
- Arn string
- The ARN of the route server peer.
- Endpoint
Eni stringAddress - The IP address of the Elastic network interface for the route server endpoint.
- Endpoint
Eni stringId - The ID of the Elastic network interface for the route server endpoint.
- Id string
- The provider-assigned unique ID for this managed resource.
- Route
Server stringId - The ID of the route server associated with this peer.
- Route
Server stringPeer Id - The unique identifier of the route server peer.
- Subnet
Id string - The ID of the subnet containing the route server peer.
- map[string]string
- A map of tags assigned to the resource, including those inherited from the provider
default_tagsconfiguration block. - Vpc
Id string - The ID of the VPC containing the route server peer.
- arn String
- The ARN of the route server peer.
- endpoint
Eni StringAddress - The IP address of the Elastic network interface for the route server endpoint.
- endpoint
Eni StringId - The ID of the Elastic network interface for the route server endpoint.
- id String
- The provider-assigned unique ID for this managed resource.
- route
Server StringId - The ID of the route server associated with this peer.
- route
Server StringPeer Id - The unique identifier of the route server peer.
- subnet
Id String - The ID of the subnet containing the route server peer.
- Map<String,String>
- A map of tags assigned to the resource, including those inherited from the provider
default_tagsconfiguration block. - vpc
Id String - The ID of the VPC containing the route server peer.
- arn string
- The ARN of the route server peer.
- endpoint
Eni stringAddress - The IP address of the Elastic network interface for the route server endpoint.
- endpoint
Eni stringId - The ID of the Elastic network interface for the route server endpoint.
- id string
- The provider-assigned unique ID for this managed resource.
- route
Server stringId - The ID of the route server associated with this peer.
- route
Server stringPeer Id - The unique identifier of the route server peer.
- subnet
Id string - The ID of the subnet containing the route server peer.
- {[key: string]: string}
- A map of tags assigned to the resource, including those inherited from the provider
default_tagsconfiguration block. - vpc
Id string - The ID of the VPC containing the route server peer.
- arn str
- The ARN of the route server peer.
- endpoint_
eni_ straddress - The IP address of the Elastic network interface for the route server endpoint.
- endpoint_
eni_ strid - 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_ strid - The ID of the route server associated with this peer.
- route_
server_ strpeer_ id - The unique identifier of the route server peer.
- subnet_
id str - The ID of the subnet containing the route server peer.
- Mapping[str, str]
- A map of tags assigned to the resource, including those inherited from the provider
default_tagsconfiguration block. - vpc_
id str - The ID of the VPC containing the route server peer.
- arn String
- The ARN of the route server peer.
- endpoint
Eni StringAddress - The IP address of the Elastic network interface for the route server endpoint.
- endpoint
Eni StringId - The ID of the Elastic network interface for the route server endpoint.
- id String
- The provider-assigned unique ID for this managed resource.
- route
Server StringId - The ID of the route server associated with this peer.
- route
Server StringPeer Id - The unique identifier of the route server peer.
- subnet
Id String - The ID of the subnet containing the route server peer.
- Map<String>
- A map of tags assigned to the resource, including those inherited from the provider
default_tagsconfiguration block. - vpc
Id 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,
region: 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) -> RouteServerPeerfunc 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.
- Arn string
- The ARN of the route server peer.
- Bgp
Options RouteServer Peer Bgp Options - 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 stringAddress - The IP address of the Elastic network interface for the route server endpoint.
- Endpoint
Eni stringId - The ID of the Elastic network interface for the route server endpoint.
- Peer
Address string - The IPv4 address of the peer device.
- Region string
- Region where this resource will be managed. Defaults to the Region set in the provider configuration.
- Route
Server stringEndpoint Id The ID of the route server endpoint for which to create a peer.
The following arguments are optional:
- Route
Server stringId - The ID of the route server associated with this peer.
- Route
Server stringPeer Id - The unique identifier of the route server peer.
- Subnet
Id string - The ID of the subnet containing the route server peer.
- Dictionary<string, string>
- A map of tags to assign to the resource. If configured with a provider
default_tagsconfiguration block present, tags with matching keys will overwrite those defined at the provider-level. - Dictionary<string, string>
- A map of tags assigned to the resource, including those inherited from the provider
default_tagsconfiguration block. - Timeouts
Route
Server Peer Timeouts - Vpc
Id string - The ID of the VPC containing the route server peer.
- Arn string
- The ARN of the route server peer.
- Bgp
Options RouteServer Peer Bgp Options Args - 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 stringAddress - The IP address of the Elastic network interface for the route server endpoint.
- Endpoint
Eni stringId - The ID of the Elastic network interface for the route server endpoint.
- Peer
Address string - The IPv4 address of the peer device.
- Region string
- Region where this resource will be managed. Defaults to the Region set in the provider configuration.
- Route
Server stringEndpoint Id The ID of the route server endpoint for which to create a peer.
The following arguments are optional:
- Route
Server stringId - The ID of the route server associated with this peer.
- Route
Server stringPeer Id - The unique identifier of the route server peer.
- Subnet
Id string - The ID of the subnet containing the route server peer.
- map[string]string
- A map of tags to assign to the resource. If configured with a provider
default_tagsconfiguration block present, tags with matching keys will overwrite those defined at the provider-level. - map[string]string
- A map of tags assigned to the resource, including those inherited from the provider
default_tagsconfiguration block. - Timeouts
Route
Server Peer Timeouts Args - Vpc
Id string - The ID of the VPC containing the route server peer.
- arn String
- The ARN of the route server peer.
- bgp
Options RouteServer Peer Bgp Options - 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 StringAddress - The IP address of the Elastic network interface for the route server endpoint.
- endpoint
Eni StringId - The ID of the Elastic network interface for the route server endpoint.
- peer
Address String - The IPv4 address of the peer device.
- region String
- Region where this resource will be managed. Defaults to the Region set in the provider configuration.
- route
Server StringEndpoint Id The ID of the route server endpoint for which to create a peer.
The following arguments are optional:
- route
Server StringId - The ID of the route server associated with this peer.
- route
Server StringPeer Id - The unique identifier of the route server peer.
- subnet
Id String - The ID of the subnet containing the route server peer.
- Map<String,String>
- A map of tags to assign to the resource. If configured with a provider
default_tagsconfiguration block present, tags with matching keys will overwrite those defined at the provider-level. - Map<String,String>
- A map of tags assigned to the resource, including those inherited from the provider
default_tagsconfiguration block. - timeouts
Route
Server Peer Timeouts - vpc
Id String - The ID of the VPC containing the route server peer.
- arn string
- The ARN of the route server peer.
- bgp
Options RouteServer Peer Bgp Options - 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 stringAddress - The IP address of the Elastic network interface for the route server endpoint.
- endpoint
Eni stringId - The ID of the Elastic network interface for the route server endpoint.
- peer
Address string - The IPv4 address of the peer device.
- region string
- Region where this resource will be managed. Defaults to the Region set in the provider configuration.
- route
Server stringEndpoint Id The ID of the route server endpoint for which to create a peer.
The following arguments are optional:
- route
Server stringId - The ID of the route server associated with this peer.
- route
Server stringPeer Id - The unique identifier of the route server peer.
- subnet
Id string - The ID of the subnet containing the route server peer.
- {[key: string]: string}
- A map of tags to assign to the resource. If configured with a provider
default_tagsconfiguration block present, tags with matching keys will overwrite those defined at the provider-level. - {[key: string]: string}
- A map of tags assigned to the resource, including those inherited from the provider
default_tagsconfiguration block. - timeouts
Route
Server Peer Timeouts - vpc
Id string - The ID of the VPC containing the route server peer.
- arn str
- The ARN of the route server peer.
- bgp_
options RouteServer Peer Bgp Options Args - 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_ straddress - The IP address of the Elastic network interface for the route server endpoint.
- endpoint_
eni_ strid - The ID of the Elastic network interface for the route server endpoint.
- peer_
address str - The IPv4 address of the peer device.
- region str
- Region where this resource will be managed. Defaults to the Region set in the provider configuration.
- route_
server_ strendpoint_ id The ID of the route server endpoint for which to create a peer.
The following arguments are optional:
- route_
server_ strid - The ID of the route server associated with this peer.
- route_
server_ strpeer_ id - The unique identifier of the route server peer.
- subnet_
id str - The ID of the subnet containing the route server peer.
- Mapping[str, str]
- A map of tags to assign to the resource. If configured with a provider
default_tagsconfiguration block present, tags with matching keys will overwrite those defined at the provider-level. - Mapping[str, str]
- A map of tags assigned to the resource, including those inherited from the provider
default_tagsconfiguration block. - timeouts
Route
Server Peer Timeouts Args - vpc_
id str - The ID of the VPC containing the route server peer.
- arn String
- The ARN of the route server peer.
- bgp
Options 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
- endpoint
Eni StringAddress - The IP address of the Elastic network interface for the route server endpoint.
- endpoint
Eni StringId - The ID of the Elastic network interface for the route server endpoint.
- peer
Address String - The IPv4 address of the peer device.
- region String
- Region where this resource will be managed. Defaults to the Region set in the provider configuration.
- route
Server StringEndpoint Id The ID of the route server endpoint for which to create a peer.
The following arguments are optional:
- route
Server StringId - The ID of the route server associated with this peer.
- route
Server StringPeer Id - The unique identifier of the route server peer.
- subnet
Id String - The ID of the subnet containing the route server peer.
- Map<String>
- A map of tags to assign to the resource. If configured with a provider
default_tagsconfiguration block present, tags with matching keys will overwrite those defined at the provider-level. - Map<String>
- A map of tags assigned to the resource, including those inherited from the provider
default_tagsconfiguration block. - timeouts Property Map
- vpc
Id String - The ID of the VPC containing the route server peer.
Supporting Types
RouteServerPeerBgpOptions, RouteServerPeerBgpOptionsArgs
- Peer
Asn 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.
- Peer
Liveness stringDetection - The requested liveness detection protocol for the BGP peer. Valid values are
bgp-keepaliveandbfd. Default value isbgp-keepalive.
- Peer
Asn 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.
- Peer
Liveness stringDetection - The requested liveness detection protocol for the BGP peer. Valid values are
bgp-keepaliveandbfd. Default value isbgp-keepalive.
- peer
Asn Integer - 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.
- peer
Liveness StringDetection - The requested liveness detection protocol for the BGP peer. Valid values are
bgp-keepaliveandbfd. Default value isbgp-keepalive.
- peer
Asn number - 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.
- peer
Liveness stringDetection - The requested liveness detection protocol for the BGP peer. Valid values are
bgp-keepaliveandbfd. Default value isbgp-keepalive.
- peer_
asn 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.
- peer_
liveness_ strdetection - The requested liveness detection protocol for the BGP peer. Valid values are
bgp-keepaliveandbfd. Default value isbgp-keepalive.
- peer
Asn Number - 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.
- peer
Liveness StringDetection - The requested liveness detection protocol for the BGP peer. Valid values are
bgp-keepaliveandbfd. Default value isbgp-keepalive.
RouteServerPeerTimeouts, RouteServerPeerTimeoutsArgs
- Create string
- A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours).
- Delete string
- A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours). Setting a timeout for a Delete operation is only applicable if changes are saved into state before the destroy operation occurs.
- Create string
- A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours).
- Delete string
- A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours). Setting a timeout for a Delete operation is only applicable if changes are saved into state before the destroy operation occurs.
- create String
- A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours).
- delete String
- A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours). Setting a timeout for a Delete operation is only applicable if changes are saved into state before the destroy operation occurs.
- create string
- A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours).
- delete string
- A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours). Setting a timeout for a Delete operation is only applicable if changes are saved into state before the destroy operation occurs.
- create str
- A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours).
- delete str
- A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours). Setting a timeout for a Delete operation is only applicable if changes are saved into state before the destroy operation occurs.
- create String
- A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours).
- delete String
- A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours). Setting a timeout for a Delete operation is only applicable if changes are saved into state before the destroy operation occurs.
Import
Using pulumi import, import VPC (Virtual Private Cloud) Route Server using the route_server_peer_id. For example:
$ pulumi import aws:vpc/routeServerPeer:RouteServerPeer example rsp-12345678
To learn more about importing existing cloud resources, see Importing resources.
Package Details
- Repository
- AWS Classic pulumi/pulumi-aws
- License
- Apache-2.0
- Notes
- This Pulumi package is based on the
awsTerraform Provider.
