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

upcloud.Network

Explore with Pulumi AI

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

    This resource represents an SDN private network that cloud servers and other resources from the same zone can be attached to.

    Example Usage

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

const exampleRouter = new upcloud.Router("example_router", {name: "example_router"});
// SDN network with a router
const exampleNetwork = new upcloud.Network("example_network", {
    name: "example_private_net",
    zone: "nl-ams1",
    router: exampleRouter.id,
    ipNetwork: {
        address: "10.0.0.0/24",
        dhcp: true,
        dhcpDefaultRoute: false,
        family: "IPv4",
        gateway: "10.0.0.1",
    },
});

    import pulumi
import pulumi_upcloud as upcloud

example_router = upcloud.Router("example_router", name="example_router")
# SDN network with a router
example_network = upcloud.Network("example_network",
    name="example_private_net",
    zone="nl-ams1",
    router=example_router.id,
    ip_network={
        "address": "10.0.0.0/24",
        "dhcp": True,
        "dhcp_default_route": False,
        "family": "IPv4",
        "gateway": "10.0.0.1",
    })

    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 {
		exampleRouter, err := upcloud.NewRouter(ctx, "example_router", &upcloud.RouterArgs{
			Name: pulumi.String("example_router"),
		})
		if err != nil {
			return err
		}
		// SDN network with a router
		_, err = upcloud.NewNetwork(ctx, "example_network", &upcloud.NetworkArgs{
			Name:   pulumi.String("example_private_net"),
			Zone:   pulumi.String("nl-ams1"),
			Router: exampleRouter.ID(),
			IpNetwork: &upcloud.NetworkIpNetworkArgs{
				Address:          pulumi.String("10.0.0.0/24"),
				Dhcp:             pulumi.Bool(true),
				DhcpDefaultRoute: pulumi.Bool(false),
				Family:           pulumi.String("IPv4"),
				Gateway:          pulumi.String("10.0.0.1"),
			},
		})
		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 exampleRouter = new UpCloud.Router("example_router", new()
    {
        Name = "example_router",
    });

    // SDN network with a router
    var exampleNetwork = new UpCloud.Network("example_network", new()
    {
        Name = "example_private_net",
        Zone = "nl-ams1",
        Router = exampleRouter.Id,
        IpNetwork = new UpCloud.Inputs.NetworkIpNetworkArgs
        {
            Address = "10.0.0.0/24",
            Dhcp = true,
            DhcpDefaultRoute = false,
            Family = "IPv4",
            Gateway = "10.0.0.1",
        },
    });

});

    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 com.pulumi.upcloud.Network;
import com.pulumi.upcloud.NetworkArgs;
import com.pulumi.upcloud.inputs.NetworkIpNetworkArgs;
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 exampleRouter = new Router("exampleRouter", RouterArgs.builder()
            .name("example_router")
            .build());

        // SDN network with a router
        var exampleNetwork = new Network("exampleNetwork", NetworkArgs.builder()
            .name("example_private_net")
            .zone("nl-ams1")
            .router(exampleRouter.id())
            .ipNetwork(NetworkIpNetworkArgs.builder()
                .address("10.0.0.0/24")
                .dhcp(true)
                .dhcpDefaultRoute(false)
                .family("IPv4")
                .gateway("10.0.0.1")
                .build())
            .build());

    }
}

    resources:
  # SDN network with a router
  exampleNetwork:
    type: upcloud:Network
    name: example_network
    properties:
      name: example_private_net
      zone: nl-ams1
      router: ${exampleRouter.id}
      ipNetwork:
        address: 10.0.0.0/24
        dhcp: true
        dhcpDefaultRoute: false
        family: IPv4
        gateway: 10.0.0.1
  exampleRouter:
    type: upcloud:Router
    name: example_router
    properties:
      name: example_router

    Create Network Resource

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

    Constructor syntax

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

@overload
def Network(resource_name: str,
            opts: Optional[ResourceOptions] = None,
            ip_network: Optional[NetworkIpNetworkArgs] = None,
            zone: Optional[str] = None,
            labels: Optional[Mapping[str, str]] = None,
            name: Optional[str] = None,
            router: Optional[str] = None)
    func NewNetwork(ctx *Context, name string, args NetworkArgs, opts ...ResourceOption) (*Network, error)
    public Network(string name, NetworkArgs args, CustomResourceOptions? opts = null)
    public Network(String name, NetworkArgs args)
public Network(String name, NetworkArgs args, CustomResourceOptions options)

    type: upcloud:Network
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 NetworkArgs
    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 NetworkArgs
    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 NetworkArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args NetworkArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args NetworkArgs
    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 networkResource = new UpCloud.Network("networkResource", new()
{
    IpNetwork = new UpCloud.Inputs.NetworkIpNetworkArgs
    {
        Address = "string",
        Dhcp = false,
        Family = "string",
        DhcpDefaultRoute = false,
        DhcpDns = new[]
        {
            "string",
        },
        DhcpRoutes = new[]
        {
            "string",
        },
        Gateway = "string",
    },
    Zone = "string",
    Labels = 
    {
        { "string", "string" },
    },
    Name = "string",
    Router = "string",
});

    example, err := upcloud.NewNetwork(ctx, "networkResource", &upcloud.NetworkArgs{
	IpNetwork: &upcloud.NetworkIpNetworkArgs{
		Address:          pulumi.String("string"),
		Dhcp:             pulumi.Bool(false),
		Family:           pulumi.String("string"),
		DhcpDefaultRoute: pulumi.Bool(false),
		DhcpDns: pulumi.StringArray{
			pulumi.String("string"),
		},
		DhcpRoutes: pulumi.StringArray{
			pulumi.String("string"),
		},
		Gateway: pulumi.String("string"),
	},
	Zone: pulumi.String("string"),
	Labels: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
	Name:   pulumi.String("string"),
	Router: pulumi.String("string"),
})

    var networkResource = new Network("networkResource", NetworkArgs.builder()
    .ipNetwork(NetworkIpNetworkArgs.builder()
        .address("string")
        .dhcp(false)
        .family("string")
        .dhcpDefaultRoute(false)
        .dhcpDns("string")
        .dhcpRoutes("string")
        .gateway("string")
        .build())
    .zone("string")
    .labels(Map.of("string", "string"))
    .name("string")
    .router("string")
    .build());

    network_resource = upcloud.Network("networkResource",
    ip_network={
        "address": "string",
        "dhcp": False,
        "family": "string",
        "dhcp_default_route": False,
        "dhcp_dns": ["string"],
        "dhcp_routes": ["string"],
        "gateway": "string",
    },
    zone="string",
    labels={
        "string": "string",
    },
    name="string",
    router="string")

    const networkResource = new upcloud.Network("networkResource", {
    ipNetwork: {
        address: "string",
        dhcp: false,
        family: "string",
        dhcpDefaultRoute: false,
        dhcpDns: ["string"],
        dhcpRoutes: ["string"],
        gateway: "string",
    },
    zone: "string",
    labels: {
        string: "string",
    },
    name: "string",
    router: "string",
});

    type: upcloud:Network
properties:
    ipNetwork:
        address: string
        dhcp: false
        dhcpDefaultRoute: false
        dhcpDns:
            - string
        dhcpRoutes:
            - string
        family: string
        gateway: string
    labels:
        string: string
    name: string
    router: string
    zone: string

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

    IpNetwork UpCloud.Pulumi.UpCloud.Inputs.NetworkIpNetwork
    IP subnet within the network. Network must have exactly one IP subnet.
    Zone string
    The zone the network is in, e.g. de-fra1. You can list available zones with upctl zone list.
    Labels Dictionary<string, string>
    User defined key-value pairs to classify the network.
    Name string
    Name of the network.
    Router string
    UUID of a router to attach to this network.
    IpNetwork NetworkIpNetworkArgs
    IP subnet within the network. Network must have exactly one IP subnet.
    Zone string
    The zone the network is in, e.g. de-fra1. You can list available zones with upctl zone list.
    Labels map[string]string
    User defined key-value pairs to classify the network.
    Name string
    Name of the network.
    Router string
    UUID of a router to attach to this network.
    ipNetwork NetworkIpNetwork
    IP subnet within the network. Network must have exactly one IP subnet.
    zone String
    The zone the network is in, e.g. de-fra1. You can list available zones with upctl zone list.
    labels Map<String,String>
    User defined key-value pairs to classify the network.
    name String
    Name of the network.
    router String
    UUID of a router to attach to this network.
    ipNetwork NetworkIpNetwork
    IP subnet within the network. Network must have exactly one IP subnet.
    zone string
    The zone the network is in, e.g. de-fra1. You can list available zones with upctl zone list.
    labels {[key: string]: string}
    User defined key-value pairs to classify the network.
    name string
    Name of the network.
    router string
    UUID of a router to attach to this network.
    ip_network NetworkIpNetworkArgs
    IP subnet within the network. Network must have exactly one IP subnet.
    zone str
    The zone the network is in, e.g. de-fra1. You can list available zones with upctl zone list.
    labels Mapping[str, str]
    User defined key-value pairs to classify the network.
    name str
    Name of the network.
    router str
    UUID of a router to attach to this network.
    ipNetwork Property Map
    IP subnet within the network. Network must have exactly one IP subnet.
    zone String
    The zone the network is in, e.g. de-fra1. You can list available zones with upctl zone list.
    labels Map<String>
    User defined key-value pairs to classify the network.
    name String
    Name of the network.
    router String
    UUID of a router to attach to this network.

    Outputs

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

    Id string
    The provider-assigned unique ID for this managed resource.
    Type string
    The network type
    Id string
    The provider-assigned unique ID for this managed resource.
    Type string
    The network type
    id String
    The provider-assigned unique ID for this managed resource.
    type String
    The network type
    id string
    The provider-assigned unique ID for this managed resource.
    type string
    The network type
    id str
    The provider-assigned unique ID for this managed resource.
    type str
    The network type
    id String
    The provider-assigned unique ID for this managed resource.
    type String
    The network type

    Look up Existing Network Resource

    Get an existing Network 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?: NetworkState, opts?: CustomResourceOptions): Network
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        ip_network: Optional[NetworkIpNetworkArgs] = None,
        labels: Optional[Mapping[str, str]] = None,
        name: Optional[str] = None,
        router: Optional[str] = None,
        type: Optional[str] = None,
        zone: Optional[str] = None) -> Network
    func GetNetwork(ctx *Context, name string, id IDInput, state *NetworkState, opts ...ResourceOption) (*Network, error)
    public static Network Get(string name, Input<string> id, NetworkState? state, CustomResourceOptions? opts = null)
    public static Network get(String name, Output<String> id, NetworkState state, CustomResourceOptions options)
    resources:  _:    type: upcloud:Network    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:
    IpNetwork UpCloud.Pulumi.UpCloud.Inputs.NetworkIpNetwork
    IP subnet within the network. Network must have exactly one IP subnet.
    Labels Dictionary<string, string>
    User defined key-value pairs to classify the network.
    Name string
    Name of the network.
    Router string
    UUID of a router to attach to this network.
    Type string
    The network type
    Zone string
    The zone the network is in, e.g. de-fra1. You can list available zones with upctl zone list.
    IpNetwork NetworkIpNetworkArgs
    IP subnet within the network. Network must have exactly one IP subnet.
    Labels map[string]string
    User defined key-value pairs to classify the network.
    Name string
    Name of the network.
    Router string
    UUID of a router to attach to this network.
    Type string
    The network type
    Zone string
    The zone the network is in, e.g. de-fra1. You can list available zones with upctl zone list.
    ipNetwork NetworkIpNetwork
    IP subnet within the network. Network must have exactly one IP subnet.
    labels Map<String,String>
    User defined key-value pairs to classify the network.
    name String
    Name of the network.
    router String
    UUID of a router to attach to this network.
    type String
    The network type
    zone String
    The zone the network is in, e.g. de-fra1. You can list available zones with upctl zone list.
    ipNetwork NetworkIpNetwork
    IP subnet within the network. Network must have exactly one IP subnet.
    labels {[key: string]: string}
    User defined key-value pairs to classify the network.
    name string
    Name of the network.
    router string
    UUID of a router to attach to this network.
    type string
    The network type
    zone string
    The zone the network is in, e.g. de-fra1. You can list available zones with upctl zone list.
    ip_network NetworkIpNetworkArgs
    IP subnet within the network. Network must have exactly one IP subnet.
    labels Mapping[str, str]
    User defined key-value pairs to classify the network.
    name str
    Name of the network.
    router str
    UUID of a router to attach to this network.
    type str
    The network type
    zone str
    The zone the network is in, e.g. de-fra1. You can list available zones with upctl zone list.
    ipNetwork Property Map
    IP subnet within the network. Network must have exactly one IP subnet.
    labels Map<String>
    User defined key-value pairs to classify the network.
    name String
    Name of the network.
    router String
    UUID of a router to attach to this network.
    type String
    The network type
    zone String
    The zone the network is in, e.g. de-fra1. You can list available zones with upctl zone list.

    Supporting Types

    NetworkIpNetwork, NetworkIpNetworkArgs

    Address string
    The CIDR range of the subnet
    Dhcp bool
    Is DHCP enabled?
    Family string
    IP address family
    DhcpDefaultRoute bool
    Is the gateway the DHCP default route?
    DhcpDns List<string>
    The DNS servers given by DHCP
    DhcpRoutes List<string>
    The additional DHCP classless static routes given by DHCP
    Gateway string
    Gateway address given by DHCP
    Address string
    The CIDR range of the subnet
    Dhcp bool
    Is DHCP enabled?
    Family string
    IP address family
    DhcpDefaultRoute bool
    Is the gateway the DHCP default route?
    DhcpDns []string
    The DNS servers given by DHCP
    DhcpRoutes []string
    The additional DHCP classless static routes given by DHCP
    Gateway string
    Gateway address given by DHCP
    address String
    The CIDR range of the subnet
    dhcp Boolean
    Is DHCP enabled?
    family String
    IP address family
    dhcpDefaultRoute Boolean
    Is the gateway the DHCP default route?
    dhcpDns List<String>
    The DNS servers given by DHCP
    dhcpRoutes List<String>
    The additional DHCP classless static routes given by DHCP
    gateway String
    Gateway address given by DHCP
    address string
    The CIDR range of the subnet
    dhcp boolean
    Is DHCP enabled?
    family string
    IP address family
    dhcpDefaultRoute boolean
    Is the gateway the DHCP default route?
    dhcpDns string[]
    The DNS servers given by DHCP
    dhcpRoutes string[]
    The additional DHCP classless static routes given by DHCP
    gateway string
    Gateway address given by DHCP
    address str
    The CIDR range of the subnet
    dhcp bool
    Is DHCP enabled?
    family str
    IP address family
    dhcp_default_route bool
    Is the gateway the DHCP default route?
    dhcp_dns Sequence[str]
    The DNS servers given by DHCP
    dhcp_routes Sequence[str]
    The additional DHCP classless static routes given by DHCP
    gateway str
    Gateway address given by DHCP
    address String
    The CIDR range of the subnet
    dhcp Boolean
    Is DHCP enabled?
    family String
    IP address family
    dhcpDefaultRoute Boolean
    Is the gateway the DHCP default route?
    dhcpDns List<String>
    The DNS servers given by DHCP
    dhcpRoutes List<String>
    The additional DHCP classless static routes given by DHCP
    gateway String
    Gateway address given by DHCP

    Import

    $ pulumi import upcloud:index/network:Network my_example_network 03e44422-07b8-4798-a597-c8eab1fa64df

    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