Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. UpCloud
  3. API Docs
  4. Router
UpCloud v0.1.0 published on Friday, Mar 14, 2025 by UpCloudLtd
UpCloudLtd/pulumi-upcloud

upcloud.Router

Explore with Pulumi AI

upcloud logo
UpCloud v0.1.0 published on Friday, Mar 14, 2025 by UpCloudLtd
UpCloudLtd/pulumi-upcloud

    Routers can be used to connect multiple Private Networks. UpCloud Servers on any attached network can communicate directly with each other.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
import * as upcloud from "@upcloud/pulumi-upcloud";

const myExampleRouter = new upcloud.Router("my_example_router", {name: "My Example Router"});

    import pulumi
import pulumi_upcloud as upcloud

my_example_router = upcloud.Router("my_example_router", name="My Example Router")

    package main

import (
	"github.com/UpCloudLtd/pulumi-upcloud/sdk/go/upcloud"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := upcloud.NewRouter(ctx, "my_example_router", &upcloud.RouterArgs{
			Name: pulumi.String("My Example Router"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

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

return await Deployment.RunAsync(() => 
{
    var myExampleRouter = new UpCloud.Router("my_example_router", new()
    {
        Name = "My Example Router",
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.upcloud.Router;
import com.pulumi.upcloud.RouterArgs;
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 myExampleRouter = new Router("myExampleRouter", RouterArgs.builder()
            .name("My Example Router")
            .build());

    }
}

    resources:
  myExampleRouter:
    type: upcloud:Router
    name: my_example_router
    properties:
      name: My Example Router

    Create Router Resource

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

    Constructor syntax

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

@overload
def Router(resource_name: str,
           opts: Optional[ResourceOptions] = None,
           labels: Optional[Mapping[str, str]] = None,
           name: Optional[str] = None,
           static_route: Optional[Sequence[RouterStaticRouteArgs]] = None)
    func NewRouter(ctx *Context, name string, args *RouterArgs, opts ...ResourceOption) (*Router, error)
    public Router(string name, RouterArgs? args = null, CustomResourceOptions? opts = null)
    public Router(String name, RouterArgs args)
public Router(String name, RouterArgs args, CustomResourceOptions options)

    type: upcloud:Router
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 RouterArgs
    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 RouterArgs
    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 RouterArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args RouterArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args RouterArgs
    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 routerResource = new UpCloud.Router("routerResource", new()
{
    Labels = 
    {
        { "string", "string" },
    },
    Name = "string",
    StaticRoute = new[]
    {
        new UpCloud.Inputs.RouterStaticRouteArgs
        {
            Name = "string",
            Nexthop = "string",
            Route = "string",
            Type = "string",
        },
    },
});

    example, err := upcloud.NewRouter(ctx, "routerResource", &upcloud.RouterArgs{
	Labels: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
	Name: pulumi.String("string"),
	StaticRoute: upcloud.RouterStaticRouteArray{
		&upcloud.RouterStaticRouteArgs{
			Name:    pulumi.String("string"),
			Nexthop: pulumi.String("string"),
			Route:   pulumi.String("string"),
			Type:    pulumi.String("string"),
		},
	},
})

    var routerResource = new Router("routerResource", RouterArgs.builder()
    .labels(Map.of("string", "string"))
    .name("string")
    .staticRoute(RouterStaticRouteArgs.builder()
        .name("string")
        .nexthop("string")
        .route("string")
        .type("string")
        .build())
    .build());

    router_resource = upcloud.Router("routerResource",
    labels={
        "string": "string",
    },
    name="string",
    static_route=[{
        "name": "string",
        "nexthop": "string",
        "route": "string",
        "type": "string",
    }])

    const routerResource = new upcloud.Router("routerResource", {
    labels: {
        string: "string",
    },
    name: "string",
    staticRoute: [{
        name: "string",
        nexthop: "string",
        route: "string",
        type: "string",
    }],
});

    type: upcloud:Router
properties:
    labels:
        string: string
    name: string
    staticRoute:
        - name: string
          nexthop: string
          route: string
          type: string

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

    Labels Dictionary<string, string>
    User defined key-value pairs to classify the router.
    Name string
    Name of the router.
    StaticRoute List<UpCloud.Pulumi.UpCloud.Inputs.RouterStaticRoute>
    A collection of user managed static routes for this router.
    Labels map[string]string
    User defined key-value pairs to classify the router.
    Name string
    Name of the router.
    StaticRoute []RouterStaticRouteArgs
    A collection of user managed static routes for this router.
    labels Map<String,String>
    User defined key-value pairs to classify the router.
    name String
    Name of the router.
    staticRoute List<RouterStaticRoute>
    A collection of user managed static routes for this router.
    labels {[key: string]: string}
    User defined key-value pairs to classify the router.
    name string
    Name of the router.
    staticRoute RouterStaticRoute[]
    A collection of user managed static routes for this router.
    labels Mapping[str, str]
    User defined key-value pairs to classify the router.
    name str
    Name of the router.
    static_route Sequence[RouterStaticRouteArgs]
    A collection of user managed static routes for this router.
    labels Map<String>
    User defined key-value pairs to classify the router.
    name String
    Name of the router.
    staticRoute List<Property Map>
    A collection of user managed static routes for this router.

    Outputs

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

    AttachedNetworks List<string>
    List of UUIDs representing networks attached to this router.
    Id string
    The provider-assigned unique ID for this managed resource.
    StaticRoutes List<UpCloud.Pulumi.UpCloud.Outputs.RouterStaticRoute>
    A collection of static routes for this router. This set includes both user and service defined static routes. The objects in this set use the same schema as static_route blocks.
    Type string
    Type of the router
    AttachedNetworks []string
    List of UUIDs representing networks attached to this router.
    Id string
    The provider-assigned unique ID for this managed resource.
    StaticRoutes []RouterStaticRoute
    A collection of static routes for this router. This set includes both user and service defined static routes. The objects in this set use the same schema as static_route blocks.
    Type string
    Type of the router
    attachedNetworks List<String>
    List of UUIDs representing networks attached to this router.
    id String
    The provider-assigned unique ID for this managed resource.
    staticRoutes List<RouterStaticRoute>
    A collection of static routes for this router. This set includes both user and service defined static routes. The objects in this set use the same schema as static_route blocks.
    type String
    Type of the router
    attachedNetworks string[]
    List of UUIDs representing networks attached to this router.
    id string
    The provider-assigned unique ID for this managed resource.
    staticRoutes RouterStaticRoute[]
    A collection of static routes for this router. This set includes both user and service defined static routes. The objects in this set use the same schema as static_route blocks.
    type string
    Type of the router
    attached_networks Sequence[str]
    List of UUIDs representing networks attached to this router.
    id str
    The provider-assigned unique ID for this managed resource.
    static_routes Sequence[RouterStaticRoute]
    A collection of static routes for this router. This set includes both user and service defined static routes. The objects in this set use the same schema as static_route blocks.
    type str
    Type of the router
    attachedNetworks List<String>
    List of UUIDs representing networks attached to this router.
    id String
    The provider-assigned unique ID for this managed resource.
    staticRoutes List<Property Map>
    A collection of static routes for this router. This set includes both user and service defined static routes. The objects in this set use the same schema as static_route blocks.
    type String
    Type of the router

    Look up Existing Router Resource

    Get an existing Router 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?: RouterState, opts?: CustomResourceOptions): Router
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        attached_networks: Optional[Sequence[str]] = None,
        labels: Optional[Mapping[str, str]] = None,
        name: Optional[str] = None,
        static_route: Optional[Sequence[RouterStaticRouteArgs]] = None,
        static_routes: Optional[Sequence[RouterStaticRouteArgs]] = None,
        type: Optional[str] = None) -> Router
    func GetRouter(ctx *Context, name string, id IDInput, state *RouterState, opts ...ResourceOption) (*Router, error)
    public static Router Get(string name, Input<string> id, RouterState? state, CustomResourceOptions? opts = null)
    public static Router get(String name, Output<String> id, RouterState state, CustomResourceOptions options)
    resources:  _:    type: upcloud:Router    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:
    AttachedNetworks List<string>
    List of UUIDs representing networks attached to this router.
    Labels Dictionary<string, string>
    User defined key-value pairs to classify the router.
    Name string
    Name of the router.
    StaticRoute List<UpCloud.Pulumi.UpCloud.Inputs.RouterStaticRoute>
    A collection of user managed static routes for this router.
    StaticRoutes List<UpCloud.Pulumi.UpCloud.Inputs.RouterStaticRoute>
    A collection of static routes for this router. This set includes both user and service defined static routes. The objects in this set use the same schema as static_route blocks.
    Type string
    Type of the router
    AttachedNetworks []string
    List of UUIDs representing networks attached to this router.
    Labels map[string]string
    User defined key-value pairs to classify the router.
    Name string
    Name of the router.
    StaticRoute []RouterStaticRouteArgs
    A collection of user managed static routes for this router.
    StaticRoutes []RouterStaticRouteArgs
    A collection of static routes for this router. This set includes both user and service defined static routes. The objects in this set use the same schema as static_route blocks.
    Type string
    Type of the router
    attachedNetworks List<String>
    List of UUIDs representing networks attached to this router.
    labels Map<String,String>
    User defined key-value pairs to classify the router.
    name String
    Name of the router.
    staticRoute List<RouterStaticRoute>
    A collection of user managed static routes for this router.
    staticRoutes List<RouterStaticRoute>
    A collection of static routes for this router. This set includes both user and service defined static routes. The objects in this set use the same schema as static_route blocks.
    type String
    Type of the router
    attachedNetworks string[]
    List of UUIDs representing networks attached to this router.
    labels {[key: string]: string}
    User defined key-value pairs to classify the router.
    name string
    Name of the router.
    staticRoute RouterStaticRoute[]
    A collection of user managed static routes for this router.
    staticRoutes RouterStaticRoute[]
    A collection of static routes for this router. This set includes both user and service defined static routes. The objects in this set use the same schema as static_route blocks.
    type string
    Type of the router
    attached_networks Sequence[str]
    List of UUIDs representing networks attached to this router.
    labels Mapping[str, str]
    User defined key-value pairs to classify the router.
    name str
    Name of the router.
    static_route Sequence[RouterStaticRouteArgs]
    A collection of user managed static routes for this router.
    static_routes Sequence[RouterStaticRouteArgs]
    A collection of static routes for this router. This set includes both user and service defined static routes. The objects in this set use the same schema as static_route blocks.
    type str
    Type of the router
    attachedNetworks List<String>
    List of UUIDs representing networks attached to this router.
    labels Map<String>
    User defined key-value pairs to classify the router.
    name String
    Name of the router.
    staticRoute List<Property Map>
    A collection of user managed static routes for this router.
    staticRoutes List<Property Map>
    A collection of static routes for this router. This set includes both user and service defined static routes. The objects in this set use the same schema as static_route blocks.
    type String
    Type of the router

    Supporting Types

    RouterStaticRoute, RouterStaticRouteArgs

    Name string
    Nexthop string
    Route string
    Type string
    Name string
    Nexthop string
    Route string
    Type string
    name String
    nexthop String
    route String
    type String
    name string
    nexthop string
    route string
    type string
    name str
    nexthop str
    route str
    type str
    name String
    nexthop String
    route String
    type String

    Import

    $ pulumi import upcloud:index/router:Router my_example_router 049d7ca2-757e-4fb1-a833-f87ee056547a

    To learn more about importing existing cloud resources, see Importing resources.

    Package Details

    Repository
    upcloud UpCloudLtd/pulumi-upcloud
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the upcloud Terraform Provider.
    upcloud logo
    UpCloud v0.1.0 published on Friday, Mar 14, 2025 by UpCloudLtd
    UpCloudLtd/pulumi-upcloud