1. Packages
  2. AWS
  3. API Docs
  4. vpc
  5. RouteServerEndpoint
AWS v6.83.0 published on Monday, Jun 16, 2025 by Pulumi

aws.vpc.RouteServerEndpoint

Explore with Pulumi AI

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

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

    Example Usage

    Basic Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as aws from "@pulumi/aws";
    
    const test = new aws.vpc.RouteServerEndpoint("test", {
        routeServerId: example.routeServerId,
        subnetId: main.id,
        tags: {
            Name: "Endpoint A",
        },
    });
    
    import pulumi
    import pulumi_aws as aws
    
    test = aws.vpc.RouteServerEndpoint("test",
        route_server_id=example["routeServerId"],
        subnet_id=main["id"],
        tags={
            "Name": "Endpoint A",
        })
    
    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.NewRouteServerEndpoint(ctx, "test", &vpc.RouteServerEndpointArgs{
    			RouteServerId: pulumi.Any(example.RouteServerId),
    			SubnetId:      pulumi.Any(main.Id),
    			Tags: pulumi.StringMap{
    				"Name": pulumi.String("Endpoint A"),
    			},
    		})
    		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.RouteServerEndpoint("test", new()
        {
            RouteServerId = example.RouteServerId,
            SubnetId = main.Id,
            Tags = 
            {
                { "Name", "Endpoint A" },
            },
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.aws.vpc.RouteServerEndpoint;
    import com.pulumi.aws.vpc.RouteServerEndpointArgs;
    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 RouteServerEndpoint("test", RouteServerEndpointArgs.builder()
                .routeServerId(example.routeServerId())
                .subnetId(main.id())
                .tags(Map.of("Name", "Endpoint A"))
                .build());
    
        }
    }
    
    resources:
      test:
        type: aws:vpc:RouteServerEndpoint
        properties:
          routeServerId: ${example.routeServerId}
          subnetId: ${main.id}
          tags:
            Name: Endpoint A
    

    Create RouteServerEndpoint Resource

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

    Constructor syntax

    new RouteServerEndpoint(name: string, args: RouteServerEndpointArgs, opts?: CustomResourceOptions);
    @overload
    def RouteServerEndpoint(resource_name: str,
                            args: RouteServerEndpointArgs,
                            opts: Optional[ResourceOptions] = None)
    
    @overload
    def RouteServerEndpoint(resource_name: str,
                            opts: Optional[ResourceOptions] = None,
                            route_server_id: Optional[str] = None,
                            subnet_id: Optional[str] = None,
                            tags: Optional[Mapping[str, str]] = None,
                            timeouts: Optional[RouteServerEndpointTimeoutsArgs] = None)
    func NewRouteServerEndpoint(ctx *Context, name string, args RouteServerEndpointArgs, opts ...ResourceOption) (*RouteServerEndpoint, error)
    public RouteServerEndpoint(string name, RouteServerEndpointArgs args, CustomResourceOptions? opts = null)
    public RouteServerEndpoint(String name, RouteServerEndpointArgs args)
    public RouteServerEndpoint(String name, RouteServerEndpointArgs args, CustomResourceOptions options)
    
    type: aws:vpc:RouteServerEndpoint
    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 RouteServerEndpointArgs
    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 RouteServerEndpointArgs
    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 RouteServerEndpointArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args RouteServerEndpointArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args RouteServerEndpointArgs
    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 routeServerEndpointResource = new Aws.Vpc.RouteServerEndpoint("routeServerEndpointResource", new()
    {
        RouteServerId = "string",
        SubnetId = "string",
        Tags = 
        {
            { "string", "string" },
        },
        Timeouts = new Aws.Vpc.Inputs.RouteServerEndpointTimeoutsArgs
        {
            Create = "string",
            Delete = "string",
        },
    });
    
    example, err := vpc.NewRouteServerEndpoint(ctx, "routeServerEndpointResource", &vpc.RouteServerEndpointArgs{
    	RouteServerId: pulumi.String("string"),
    	SubnetId:      pulumi.String("string"),
    	Tags: pulumi.StringMap{
    		"string": pulumi.String("string"),
    	},
    	Timeouts: &vpc.RouteServerEndpointTimeoutsArgs{
    		Create: pulumi.String("string"),
    		Delete: pulumi.String("string"),
    	},
    })
    
    var routeServerEndpointResource = new RouteServerEndpoint("routeServerEndpointResource", RouteServerEndpointArgs.builder()
        .routeServerId("string")
        .subnetId("string")
        .tags(Map.of("string", "string"))
        .timeouts(RouteServerEndpointTimeoutsArgs.builder()
            .create("string")
            .delete("string")
            .build())
        .build());
    
    route_server_endpoint_resource = aws.vpc.RouteServerEndpoint("routeServerEndpointResource",
        route_server_id="string",
        subnet_id="string",
        tags={
            "string": "string",
        },
        timeouts={
            "create": "string",
            "delete": "string",
        })
    
    const routeServerEndpointResource = new aws.vpc.RouteServerEndpoint("routeServerEndpointResource", {
        routeServerId: "string",
        subnetId: "string",
        tags: {
            string: "string",
        },
        timeouts: {
            create: "string",
            "delete": "string",
        },
    });
    
    type: aws:vpc:RouteServerEndpoint
    properties:
        routeServerId: string
        subnetId: string
        tags:
            string: string
        timeouts:
            create: string
            delete: string
    

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

    RouteServerId string
    The ID of the route server for which to create an endpoint.
    SubnetId string

    The ID of the subnet in which to create the route server endpoint.

    The following arguments are optional:

    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 RouteServerEndpointTimeouts
    RouteServerId string
    The ID of the route server for which to create an endpoint.
    SubnetId string

    The ID of the subnet in which to create the route server endpoint.

    The following arguments are optional:

    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 RouteServerEndpointTimeoutsArgs
    routeServerId String
    The ID of the route server for which to create an endpoint.
    subnetId String

    The ID of the subnet in which to create the route server endpoint.

    The following arguments are optional:

    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 RouteServerEndpointTimeouts
    routeServerId string
    The ID of the route server for which to create an endpoint.
    subnetId string

    The ID of the subnet in which to create the route server endpoint.

    The following arguments are optional:

    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 RouteServerEndpointTimeouts
    route_server_id str
    The ID of the route server for which to create an endpoint.
    subnet_id str

    The ID of the subnet in which to create the route server endpoint.

    The following arguments are optional:

    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 RouteServerEndpointTimeoutsArgs
    routeServerId String
    The ID of the route server for which to create an endpoint.
    subnetId String

    The ID of the subnet in which to create the route server endpoint.

    The following arguments are optional:

    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 RouteServerEndpoint resource produces the following output properties:

    Arn string
    The ARN of the route server endpoint.
    EniAddress string
    The IP address of the Elastic network interface for the endpoint.
    EniId string
    The ID of the Elastic network interface for the endpoint.
    Id string
    The provider-assigned unique ID for this managed resource.
    RouteServerEndpointId string
    The unique identifier of the route server endpoint.
    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 endpoint.
    Arn string
    The ARN of the route server endpoint.
    EniAddress string
    The IP address of the Elastic network interface for the endpoint.
    EniId string
    The ID of the Elastic network interface for the endpoint.
    Id string
    The provider-assigned unique ID for this managed resource.
    RouteServerEndpointId string
    The unique identifier of the route server endpoint.
    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 endpoint.
    arn String
    The ARN of the route server endpoint.
    eniAddress String
    The IP address of the Elastic network interface for the endpoint.
    eniId String
    The ID of the Elastic network interface for the endpoint.
    id String
    The provider-assigned unique ID for this managed resource.
    routeServerEndpointId String
    The unique identifier of the route server endpoint.
    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 endpoint.
    arn string
    The ARN of the route server endpoint.
    eniAddress string
    The IP address of the Elastic network interface for the endpoint.
    eniId string
    The ID of the Elastic network interface for the endpoint.
    id string
    The provider-assigned unique ID for this managed resource.
    routeServerEndpointId string
    The unique identifier of the route server endpoint.
    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 endpoint.
    arn str
    The ARN of the route server endpoint.
    eni_address str
    The IP address of the Elastic network interface for the endpoint.
    eni_id str
    The ID of the Elastic network interface for the endpoint.
    id str
    The provider-assigned unique ID for this managed resource.
    route_server_endpoint_id str
    The unique identifier of the route server endpoint.
    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 endpoint.
    arn String
    The ARN of the route server endpoint.
    eniAddress String
    The IP address of the Elastic network interface for the endpoint.
    eniId String
    The ID of the Elastic network interface for the endpoint.
    id String
    The provider-assigned unique ID for this managed resource.
    routeServerEndpointId String
    The unique identifier of the route server endpoint.
    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 endpoint.

    Look up Existing RouteServerEndpoint Resource

    Get an existing RouteServerEndpoint 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?: RouteServerEndpointState, opts?: CustomResourceOptions): RouteServerEndpoint
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            arn: Optional[str] = None,
            eni_address: Optional[str] = None,
            eni_id: Optional[str] = None,
            route_server_endpoint_id: Optional[str] = None,
            route_server_id: Optional[str] = None,
            subnet_id: Optional[str] = None,
            tags: Optional[Mapping[str, str]] = None,
            tags_all: Optional[Mapping[str, str]] = None,
            timeouts: Optional[RouteServerEndpointTimeoutsArgs] = None,
            vpc_id: Optional[str] = None) -> RouteServerEndpoint
    func GetRouteServerEndpoint(ctx *Context, name string, id IDInput, state *RouteServerEndpointState, opts ...ResourceOption) (*RouteServerEndpoint, error)
    public static RouteServerEndpoint Get(string name, Input<string> id, RouteServerEndpointState? state, CustomResourceOptions? opts = null)
    public static RouteServerEndpoint get(String name, Output<String> id, RouteServerEndpointState state, CustomResourceOptions options)
    resources:  _:    type: aws:vpc:RouteServerEndpoint    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 endpoint.
    EniAddress string
    The IP address of the Elastic network interface for the endpoint.
    EniId string
    The ID of the Elastic network interface for the endpoint.
    RouteServerEndpointId string
    The unique identifier of the route server endpoint.
    RouteServerId string
    The ID of the route server for which to create an endpoint.
    SubnetId string

    The ID of the subnet in which to create the route server endpoint.

    The following arguments are optional:

    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.

    Deprecated: Please use tags instead.

    Timeouts RouteServerEndpointTimeouts
    VpcId string
    The ID of the VPC containing the endpoint.
    Arn string
    The ARN of the route server endpoint.
    EniAddress string
    The IP address of the Elastic network interface for the endpoint.
    EniId string
    The ID of the Elastic network interface for the endpoint.
    RouteServerEndpointId string
    The unique identifier of the route server endpoint.
    RouteServerId string
    The ID of the route server for which to create an endpoint.
    SubnetId string

    The ID of the subnet in which to create the route server endpoint.

    The following arguments are optional:

    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.

    Deprecated: Please use tags instead.

    Timeouts RouteServerEndpointTimeoutsArgs
    VpcId string
    The ID of the VPC containing the endpoint.
    arn String
    The ARN of the route server endpoint.
    eniAddress String
    The IP address of the Elastic network interface for the endpoint.
    eniId String
    The ID of the Elastic network interface for the endpoint.
    routeServerEndpointId String
    The unique identifier of the route server endpoint.
    routeServerId String
    The ID of the route server for which to create an endpoint.
    subnetId String

    The ID of the subnet in which to create the route server endpoint.

    The following arguments are optional:

    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.

    Deprecated: Please use tags instead.

    timeouts RouteServerEndpointTimeouts
    vpcId String
    The ID of the VPC containing the endpoint.
    arn string
    The ARN of the route server endpoint.
    eniAddress string
    The IP address of the Elastic network interface for the endpoint.
    eniId string
    The ID of the Elastic network interface for the endpoint.
    routeServerEndpointId string
    The unique identifier of the route server endpoint.
    routeServerId string
    The ID of the route server for which to create an endpoint.
    subnetId string

    The ID of the subnet in which to create the route server endpoint.

    The following arguments are optional:

    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.

    Deprecated: Please use tags instead.

    timeouts RouteServerEndpointTimeouts
    vpcId string
    The ID of the VPC containing the endpoint.
    arn str
    The ARN of the route server endpoint.
    eni_address str
    The IP address of the Elastic network interface for the endpoint.
    eni_id str
    The ID of the Elastic network interface for the endpoint.
    route_server_endpoint_id str
    The unique identifier of the route server endpoint.
    route_server_id str
    The ID of the route server for which to create an endpoint.
    subnet_id str

    The ID of the subnet in which to create the route server endpoint.

    The following arguments are optional:

    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.

    Deprecated: Please use tags instead.

    timeouts RouteServerEndpointTimeoutsArgs
    vpc_id str
    The ID of the VPC containing the endpoint.
    arn String
    The ARN of the route server endpoint.
    eniAddress String
    The IP address of the Elastic network interface for the endpoint.
    eniId String
    The ID of the Elastic network interface for the endpoint.
    routeServerEndpointId String
    The unique identifier of the route server endpoint.
    routeServerId String
    The ID of the route server for which to create an endpoint.
    subnetId String

    The ID of the subnet in which to create the route server endpoint.

    The following arguments are optional:

    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.

    Deprecated: Please use tags instead.

    timeouts Property Map
    vpcId String
    The ID of the VPC containing the endpoint.

    Supporting Types

    RouteServerEndpointTimeouts, RouteServerEndpointTimeoutsArgs

    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 Endpoint using the route_server_endpoint_id. For example:

    $ pulumi import aws:vpc/routeServerEndpoint:RouteServerEndpoint example rse-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 v6.83.0 published on Monday, Jun 16, 2025 by Pulumi