Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi IDP Pulumi Cloud Packages Tutorials
  1. Packages
  2. AWS
  3. API Docs
  4. vpc
  5. RouteServer
AWS v7.1.0 published on Monday, Jul 21, 2025 by Pulumi
pulumi/pulumi-aws

aws.vpc.RouteServer

Explore with Pulumi AI

aws logo
AWS v7.1.0 published on Monday, Jul 21, 2025 by Pulumi
pulumi/pulumi-aws

    Provides a resource for managing a VPC (Virtual Private Cloud) Route Server.

    Example Usage

    Basic Usage

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

const test = new aws.vpc.RouteServer("test", {
    amazonSideAsn: 65534,
    tags: {
        Name: "Test",
    },
});

    import pulumi
import pulumi_aws as aws

test = aws.vpc.RouteServer("test",
    amazon_side_asn=65534,
    tags={
        "Name": "Test",
    })

    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.NewRouteServer(ctx, "test", &vpc.RouteServerArgs{
			AmazonSideAsn: pulumi.Int(65534),
			Tags: pulumi.StringMap{
				"Name": pulumi.String("Test"),
			},
		})
		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 = 65534,
        Tags = 
        {
            { "Name", "Test" },
        },
    });

});

    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 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(65534)
            .tags(Map.of("Name", "Test"))
            .build());

    }
}

    resources:
  test:
    type: aws:vpc:RouteServer
    properties:
      amazonSideAsn: 65534
      tags:
        Name: Test

    Persist Route and SNS Notification

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

const test = new aws.vpc.RouteServer("test", {
    amazonSideAsn: 65534,
    persistRoutes: "enable",
    persistRoutesDuration: 2,
    snsNotificationsEnabled: true,
    tags: {
        Name: "Main Route Server",
    },
});

    import pulumi
import pulumi_aws as aws

test = aws.vpc.RouteServer("test",
    amazon_side_asn=65534,
    persist_routes="enable",
    persist_routes_duration=2,
    sns_notifications_enabled=True,
    tags={
        "Name": "Main Route Server",
    })

    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.NewRouteServer(ctx, "test", &vpc.RouteServerArgs{
			AmazonSideAsn:           pulumi.Int(65534),
			PersistRoutes:           pulumi.String("enable"),
			PersistRoutesDuration:   pulumi.Int(2),
			SnsNotificationsEnabled: pulumi.Bool(true),
			Tags: pulumi.StringMap{
				"Name": pulumi.String("Main Route Server"),
			},
		})
		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 = 65534,
        PersistRoutes = "enable",
        PersistRoutesDuration = 2,
        SnsNotificationsEnabled = true,
        Tags = 
        {
            { "Name", "Main Route Server" },
        },
    });

});

    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 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(65534)
            .persistRoutes("enable")
            .persistRoutesDuration(2)
            .snsNotificationsEnabled(true)
            .tags(Map.of("Name", "Main Route Server"))
            .build());

    }
}

    resources:
  test:
    type: aws:vpc:RouteServer
    properties:
      amazonSideAsn: 65534
      persistRoutes: enable
      persistRoutesDuration: 2
      snsNotificationsEnabled: true
      tags:
        Name: Main Route Server

    Create RouteServer Resource

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

    Constructor syntax

    new RouteServer(name: string, args: RouteServerArgs, opts?: CustomResourceOptions);
    @overload
def RouteServer(resource_name: str,
                args: RouteServerArgs,
                opts: Optional[ResourceOptions] = None)

@overload
def RouteServer(resource_name: str,
                opts: Optional[ResourceOptions] = None,
                amazon_side_asn: Optional[int] = None,
                persist_routes: Optional[str] = None,
                persist_routes_duration: Optional[int] = None,
                region: Optional[str] = None,
                sns_notifications_enabled: Optional[bool] = None,
                tags: Optional[Mapping[str, str]] = None,
                timeouts: Optional[RouteServerTimeoutsArgs] = None)
    func NewRouteServer(ctx *Context, name string, args RouteServerArgs, opts ...ResourceOption) (*RouteServer, error)
    public RouteServer(string name, RouteServerArgs args, CustomResourceOptions? opts = null)
    public RouteServer(String name, RouteServerArgs args)
public RouteServer(String name, RouteServerArgs args, CustomResourceOptions options)

    type: aws:vpc:RouteServer
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 RouteServerArgs
    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 RouteServerArgs
    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 RouteServerArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args RouteServerArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args RouteServerArgs
    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 routeServerResource = new Aws.Vpc.RouteServer("routeServerResource", new()
{
    AmazonSideAsn = 0,
    PersistRoutes = "string",
    PersistRoutesDuration = 0,
    Region = "string",
    SnsNotificationsEnabled = false,
    Tags = 
    {
        { "string", "string" },
    },
    Timeouts = new Aws.Vpc.Inputs.RouteServerTimeoutsArgs
    {
        Create = "string",
        Delete = "string",
        Update = "string",
    },
});

    example, err := vpc.NewRouteServer(ctx, "routeServerResource", &vpc.RouteServerArgs{
	AmazonSideAsn:           pulumi.Int(0),
	PersistRoutes:           pulumi.String("string"),
	PersistRoutesDuration:   pulumi.Int(0),
	Region:                  pulumi.String("string"),
	SnsNotificationsEnabled: pulumi.Bool(false),
	Tags: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
	Timeouts: &vpc.RouteServerTimeoutsArgs{
		Create: pulumi.String("string"),
		Delete: pulumi.String("string"),
		Update: pulumi.String("string"),
	},
})

    var routeServerResource = new RouteServer("routeServerResource", RouteServerArgs.builder()
    .amazonSideAsn(0)
    .persistRoutes("string")
    .persistRoutesDuration(0)
    .region("string")
    .snsNotificationsEnabled(false)
    .tags(Map.of("string", "string"))
    .timeouts(RouteServerTimeoutsArgs.builder()
        .create("string")
        .delete("string")
        .update("string")
        .build())
    .build());

    route_server_resource = aws.vpc.RouteServer("routeServerResource",
    amazon_side_asn=0,
    persist_routes="string",
    persist_routes_duration=0,
    region="string",
    sns_notifications_enabled=False,
    tags={
        "string": "string",
    },
    timeouts={
        "create": "string",
        "delete": "string",
        "update": "string",
    })

    const routeServerResource = new aws.vpc.RouteServer("routeServerResource", {
    amazonSideAsn: 0,
    persistRoutes: "string",
    persistRoutesDuration: 0,
    region: "string",
    snsNotificationsEnabled: false,
    tags: {
        string: "string",
    },
    timeouts: {
        create: "string",
        "delete": "string",
        update: "string",
    },
});

    type: aws:vpc:RouteServer
properties:
    amazonSideAsn: 0
    persistRoutes: string
    persistRoutesDuration: 0
    region: string
    snsNotificationsEnabled: false
    tags:
        string: string
    timeouts:
        create: string
        delete: string
        update: string

    RouteServer 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 RouteServer resource accepts the following input properties:

    AmazonSideAsn int

    The Border Gateway Protocol (BGP) Autonomous System Number (ASN) for the appliance. Valid values are from 1 to 4294967295.

    The following arguments are optional:

    PersistRoutes string
    Indicates whether routes should be persisted after all BGP sessions are terminated. Valid values are enable, disable, reset
    PersistRoutesDuration int
    The number of minutes a route server will wait after BGP is re-established to unpersist the routes in the FIB and RIB. Value must be in the range of 1-5. Required if persist_routes is enabled.
    Region string
    Region where this resource will be managed. Defaults to the Region set in the provider configuration.
    SnsNotificationsEnabled bool
    Indicates whether SNS notifications should be enabled for route server events. Enabling SNS notifications persists BGP status changes to an SNS topic provisioned by AWS`.
    Tags Dictionary<string, string>
    A map of tags to assign to the resource. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    Timeouts RouteServerTimeouts
    AmazonSideAsn int

    The Border Gateway Protocol (BGP) Autonomous System Number (ASN) for the appliance. Valid values are from 1 to 4294967295.

    The following arguments are optional:

    PersistRoutes string
    Indicates whether routes should be persisted after all BGP sessions are terminated. Valid values are enable, disable, reset
    PersistRoutesDuration int
    The number of minutes a route server will wait after BGP is re-established to unpersist the routes in the FIB and RIB. Value must be in the range of 1-5. Required if persist_routes is enabled.
    Region string
    Region where this resource will be managed. Defaults to the Region set in the provider configuration.
    SnsNotificationsEnabled bool
    Indicates whether SNS notifications should be enabled for route server events. Enabling SNS notifications persists BGP status changes to an SNS topic provisioned by AWS`.
    Tags map[string]string
    A map of tags to assign to the resource. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    Timeouts RouteServerTimeoutsArgs
    amazonSideAsn Integer

    The Border Gateway Protocol (BGP) Autonomous System Number (ASN) for the appliance. Valid values are from 1 to 4294967295.

    The following arguments are optional:

    persistRoutes String
    Indicates whether routes should be persisted after all BGP sessions are terminated. Valid values are enable, disable, reset
    persistRoutesDuration Integer
    The number of minutes a route server will wait after BGP is re-established to unpersist the routes in the FIB and RIB. Value must be in the range of 1-5. Required if persist_routes is enabled.
    region String
    Region where this resource will be managed. Defaults to the Region set in the provider configuration.
    snsNotificationsEnabled Boolean
    Indicates whether SNS notifications should be enabled for route server events. Enabling SNS notifications persists BGP status changes to an SNS topic provisioned by AWS`.
    tags Map<String,String>
    A map of tags to assign to the resource. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    timeouts RouteServerTimeouts
    amazonSideAsn number

    The Border Gateway Protocol (BGP) Autonomous System Number (ASN) for the appliance. Valid values are from 1 to 4294967295.

    The following arguments are optional:

    persistRoutes string
    Indicates whether routes should be persisted after all BGP sessions are terminated. Valid values are enable, disable, reset
    persistRoutesDuration number
    The number of minutes a route server will wait after BGP is re-established to unpersist the routes in the FIB and RIB. Value must be in the range of 1-5. Required if persist_routes is enabled.
    region string
    Region where this resource will be managed. Defaults to the Region set in the provider configuration.
    snsNotificationsEnabled boolean
    Indicates whether SNS notifications should be enabled for route server events. Enabling SNS notifications persists BGP status changes to an SNS topic provisioned by AWS`.
    tags {[key: string]: string}
    A map of tags to assign to the resource. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    timeouts RouteServerTimeouts
    amazon_side_asn int

    The Border Gateway Protocol (BGP) Autonomous System Number (ASN) for the appliance. Valid values are from 1 to 4294967295.

    The following arguments are optional:

    persist_routes str
    Indicates whether routes should be persisted after all BGP sessions are terminated. Valid values are enable, disable, reset
    persist_routes_duration int
    The number of minutes a route server will wait after BGP is re-established to unpersist the routes in the FIB and RIB. Value must be in the range of 1-5. Required if persist_routes is enabled.
    region str
    Region where this resource will be managed. Defaults to the Region set in the provider configuration.
    sns_notifications_enabled bool
    Indicates whether SNS notifications should be enabled for route server events. Enabling SNS notifications persists BGP status changes to an SNS topic provisioned by AWS`.
    tags Mapping[str, str]
    A map of tags to assign to the resource. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    timeouts RouteServerTimeoutsArgs
    amazonSideAsn Number

    The Border Gateway Protocol (BGP) Autonomous System Number (ASN) for the appliance. Valid values are from 1 to 4294967295.

    The following arguments are optional:

    persistRoutes String
    Indicates whether routes should be persisted after all BGP sessions are terminated. Valid values are enable, disable, reset
    persistRoutesDuration Number
    The number of minutes a route server will wait after BGP is re-established to unpersist the routes in the FIB and RIB. Value must be in the range of 1-5. Required if persist_routes is enabled.
    region String
    Region where this resource will be managed. Defaults to the Region set in the provider configuration.
    snsNotificationsEnabled Boolean
    Indicates whether SNS notifications should be enabled for route server events. Enabling SNS notifications persists BGP status changes to an SNS topic provisioned by AWS`.
    tags Map<String>
    A map of tags to assign to the resource. If configured with a provider default_tags configuration 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 RouteServer resource produces the following output properties:

    Arn string
    The ARN of the route server.
    Id string
    The provider-assigned unique ID for this managed resource.
    RouteServerId string
    The unique identifier of the route server.
    SnsTopicArn string
    The ARN of the SNS topic where notifications are published.
    TagsAll Dictionary<string, string>
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.
    Arn string
    The ARN of the route server.
    Id string
    The provider-assigned unique ID for this managed resource.
    RouteServerId string
    The unique identifier of the route server.
    SnsTopicArn string
    The ARN of the SNS topic where notifications are published.
    TagsAll map[string]string
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.
    arn String
    The ARN of the route server.
    id String
    The provider-assigned unique ID for this managed resource.
    routeServerId String
    The unique identifier of the route server.
    snsTopicArn String
    The ARN of the SNS topic where notifications are published.
    tagsAll Map<String,String>
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.
    arn string
    The ARN of the route server.
    id string
    The provider-assigned unique ID for this managed resource.
    routeServerId string
    The unique identifier of the route server.
    snsTopicArn string
    The ARN of the SNS topic where notifications are published.
    tagsAll {[key: string]: string}
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.
    arn str
    The ARN of the route server.
    id str
    The provider-assigned unique ID for this managed resource.
    route_server_id str
    The unique identifier of the route server.
    sns_topic_arn str
    The ARN of the SNS topic where notifications are published.
    tags_all Mapping[str, str]
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.
    arn String
    The ARN of the route server.
    id String
    The provider-assigned unique ID for this managed resource.
    routeServerId String
    The unique identifier of the route server.
    snsTopicArn String
    The ARN of the SNS topic where notifications are published.
    tagsAll Map<String>
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Look up Existing RouteServer Resource

    Get an existing RouteServer 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?: RouteServerState, opts?: CustomResourceOptions): RouteServer
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        amazon_side_asn: Optional[int] = None,
        arn: Optional[str] = None,
        persist_routes: Optional[str] = None,
        persist_routes_duration: Optional[int] = None,
        region: Optional[str] = None,
        route_server_id: Optional[str] = None,
        sns_notifications_enabled: Optional[bool] = None,
        sns_topic_arn: Optional[str] = None,
        tags: Optional[Mapping[str, str]] = None,
        tags_all: Optional[Mapping[str, str]] = None,
        timeouts: Optional[RouteServerTimeoutsArgs] = None) -> RouteServer
    func GetRouteServer(ctx *Context, name string, id IDInput, state *RouteServerState, opts ...ResourceOption) (*RouteServer, error)
    public static RouteServer Get(string name, Input<string> id, RouteServerState? state, CustomResourceOptions? opts = null)
    public static RouteServer get(String name, Output<String> id, RouteServerState state, CustomResourceOptions options)
    resources:  _:    type: aws:vpc:RouteServer    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:
    AmazonSideAsn int

    The Border Gateway Protocol (BGP) Autonomous System Number (ASN) for the appliance. Valid values are from 1 to 4294967295.

    The following arguments are optional:

    Arn string
    The ARN of the route server.
    PersistRoutes string
    Indicates whether routes should be persisted after all BGP sessions are terminated. Valid values are enable, disable, reset
    PersistRoutesDuration int
    The number of minutes a route server will wait after BGP is re-established to unpersist the routes in the FIB and RIB. Value must be in the range of 1-5. Required if persist_routes is enabled.
    Region string
    Region where this resource will be managed. Defaults to the Region set in the provider configuration.
    RouteServerId string
    The unique identifier of the route server.
    SnsNotificationsEnabled bool
    Indicates whether SNS notifications should be enabled for route server events. Enabling SNS notifications persists BGP status changes to an SNS topic provisioned by AWS`.
    SnsTopicArn string
    The ARN of the SNS topic where notifications are published.
    Tags Dictionary<string, string>
    A map of tags to assign to the resource. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    TagsAll Dictionary<string, string>
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.
    Timeouts RouteServerTimeouts
    AmazonSideAsn int

    The Border Gateway Protocol (BGP) Autonomous System Number (ASN) for the appliance. Valid values are from 1 to 4294967295.

    The following arguments are optional:

    Arn string
    The ARN of the route server.
    PersistRoutes string
    Indicates whether routes should be persisted after all BGP sessions are terminated. Valid values are enable, disable, reset
    PersistRoutesDuration int
    The number of minutes a route server will wait after BGP is re-established to unpersist the routes in the FIB and RIB. Value must be in the range of 1-5. Required if persist_routes is enabled.
    Region string
    Region where this resource will be managed. Defaults to the Region set in the provider configuration.
    RouteServerId string
    The unique identifier of the route server.
    SnsNotificationsEnabled bool
    Indicates whether SNS notifications should be enabled for route server events. Enabling SNS notifications persists BGP status changes to an SNS topic provisioned by AWS`.
    SnsTopicArn string
    The ARN of the SNS topic where notifications are published.
    Tags map[string]string
    A map of tags to assign to the resource. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    TagsAll map[string]string
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.
    Timeouts RouteServerTimeoutsArgs
    amazonSideAsn Integer

    The Border Gateway Protocol (BGP) Autonomous System Number (ASN) for the appliance. Valid values are from 1 to 4294967295.

    The following arguments are optional:

    arn String
    The ARN of the route server.
    persistRoutes String
    Indicates whether routes should be persisted after all BGP sessions are terminated. Valid values are enable, disable, reset
    persistRoutesDuration Integer
    The number of minutes a route server will wait after BGP is re-established to unpersist the routes in the FIB and RIB. Value must be in the range of 1-5. Required if persist_routes is enabled.
    region String
    Region where this resource will be managed. Defaults to the Region set in the provider configuration.
    routeServerId String
    The unique identifier of the route server.
    snsNotificationsEnabled Boolean
    Indicates whether SNS notifications should be enabled for route server events. Enabling SNS notifications persists BGP status changes to an SNS topic provisioned by AWS`.
    snsTopicArn String
    The ARN of the SNS topic where notifications are published.
    tags Map<String,String>
    A map of tags to assign to the resource. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    tagsAll Map<String,String>
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.
    timeouts RouteServerTimeouts
    amazonSideAsn number

    The Border Gateway Protocol (BGP) Autonomous System Number (ASN) for the appliance. Valid values are from 1 to 4294967295.

    The following arguments are optional:

    arn string
    The ARN of the route server.
    persistRoutes string
    Indicates whether routes should be persisted after all BGP sessions are terminated. Valid values are enable, disable, reset
    persistRoutesDuration number
    The number of minutes a route server will wait after BGP is re-established to unpersist the routes in the FIB and RIB. Value must be in the range of 1-5. Required if persist_routes is enabled.
    region string
    Region where this resource will be managed. Defaults to the Region set in the provider configuration.
    routeServerId string
    The unique identifier of the route server.
    snsNotificationsEnabled boolean
    Indicates whether SNS notifications should be enabled for route server events. Enabling SNS notifications persists BGP status changes to an SNS topic provisioned by AWS`.
    snsTopicArn string
    The ARN of the SNS topic where notifications are published.
    tags {[key: string]: string}
    A map of tags to assign to the resource. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    tagsAll {[key: string]: string}
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.
    timeouts RouteServerTimeouts
    amazon_side_asn int

    The Border Gateway Protocol (BGP) Autonomous System Number (ASN) for the appliance. Valid values are from 1 to 4294967295.

    The following arguments are optional:

    arn str
    The ARN of the route server.
    persist_routes str
    Indicates whether routes should be persisted after all BGP sessions are terminated. Valid values are enable, disable, reset
    persist_routes_duration int
    The number of minutes a route server will wait after BGP is re-established to unpersist the routes in the FIB and RIB. Value must be in the range of 1-5. Required if persist_routes is enabled.
    region str
    Region where this resource will be managed. Defaults to the Region set in the provider configuration.
    route_server_id str
    The unique identifier of the route server.
    sns_notifications_enabled bool
    Indicates whether SNS notifications should be enabled for route server events. Enabling SNS notifications persists BGP status changes to an SNS topic provisioned by AWS`.
    sns_topic_arn str
    The ARN of the SNS topic where notifications are published.
    tags Mapping[str, str]
    A map of tags to assign to the resource. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    tags_all Mapping[str, str]
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.
    timeouts RouteServerTimeoutsArgs
    amazonSideAsn Number

    The Border Gateway Protocol (BGP) Autonomous System Number (ASN) for the appliance. Valid values are from 1 to 4294967295.

    The following arguments are optional:

    arn String
    The ARN of the route server.
    persistRoutes String
    Indicates whether routes should be persisted after all BGP sessions are terminated. Valid values are enable, disable, reset
    persistRoutesDuration Number
    The number of minutes a route server will wait after BGP is re-established to unpersist the routes in the FIB and RIB. Value must be in the range of 1-5. Required if persist_routes is enabled.
    region String
    Region where this resource will be managed. Defaults to the Region set in the provider configuration.
    routeServerId String
    The unique identifier of the route server.
    snsNotificationsEnabled Boolean
    Indicates whether SNS notifications should be enabled for route server events. Enabling SNS notifications persists BGP status changes to an SNS topic provisioned by AWS`.
    snsTopicArn String
    The ARN of the SNS topic where notifications are published.
    tags Map<String>
    A map of tags to assign to the resource. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    tagsAll Map<String>
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.
    timeouts Property Map

    Supporting Types

    RouteServerTimeouts, RouteServerTimeoutsArgs

    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.
    Update 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).
    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.
    Update 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).
    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.
    update 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).
    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.
    update 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).
    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.
    update 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).
    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.
    update 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).

    Import

    Using pulumi import, import VPC (Virtual Private Cloud) Route Server using the route_server_id. For example:

    $ pulumi import aws:vpc/routeServer:RouteServer example rs-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 aws Terraform Provider.
    aws logo
    AWS v7.1.0 published on Monday, Jul 21, 2025 by Pulumi
    pulumi/pulumi-aws