Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. Hcloud Provider
  3. API Docs
  4. NetworkRoute
Hetzner Cloud v1.21.0 published on Tuesday, Nov 12, 2024 by Pulumi
pulumi/pulumi-hcloud

hcloud.NetworkRoute

Explore with Pulumi AI

hcloud logo
Hetzner Cloud v1.21.0 published on Tuesday, Nov 12, 2024 by Pulumi
pulumi/pulumi-hcloud

    Provides a Hetzner Cloud Network Route to represent a Network route in the Hetzner Cloud.

    Example Usage

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

const mynet = new hcloud.Network("mynet", {
    name: "my-net",
    ipRange: "10.0.0.0/8",
});
const privNet = new hcloud.NetworkRoute("privNet", {
    networkId: mynet.id,
    destination: "10.100.1.0/24",
    gateway: "10.0.1.1",
});

    import pulumi
import pulumi_hcloud as hcloud

mynet = hcloud.Network("mynet",
    name="my-net",
    ip_range="10.0.0.0/8")
priv_net = hcloud.NetworkRoute("privNet",
    network_id=mynet.id,
    destination="10.100.1.0/24",
    gateway="10.0.1.1")

    package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		mynet, err := hcloud.NewNetwork(ctx, "mynet", &hcloud.NetworkArgs{
			Name:    pulumi.String("my-net"),
			IpRange: pulumi.String("10.0.0.0/8"),
		})
		if err != nil {
			return err
		}
		_, err = hcloud.NewNetworkRoute(ctx, "privNet", &hcloud.NetworkRouteArgs{
			NetworkId:   mynet.ID(),
			Destination: pulumi.String("10.100.1.0/24"),
			Gateway:     pulumi.String("10.0.1.1"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

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

return await Deployment.RunAsync(() => 
{
    var mynet = new HCloud.Network("mynet", new()
    {
        Name = "my-net",
        IpRange = "10.0.0.0/8",
    });

    var privNet = new HCloud.NetworkRoute("privNet", new()
    {
        NetworkId = mynet.Id,
        Destination = "10.100.1.0/24",
        Gateway = "10.0.1.1",
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.hcloud.Network;
import com.pulumi.hcloud.NetworkArgs;
import com.pulumi.hcloud.NetworkRoute;
import com.pulumi.hcloud.NetworkRouteArgs;
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 mynet = new Network("mynet", NetworkArgs.builder()
            .name("my-net")
            .ipRange("10.0.0.0/8")
            .build());

        var privNet = new NetworkRoute("privNet", NetworkRouteArgs.builder()
            .networkId(mynet.id())
            .destination("10.100.1.0/24")
            .gateway("10.0.1.1")
            .build());

    }
}

    resources:
  mynet:
    type: hcloud:Network
    properties:
      name: my-net
      ipRange: 10.0.0.0/8
  privNet:
    type: hcloud:NetworkRoute
    properties:
      networkId: ${mynet.id}
      destination: 10.100.1.0/24
      gateway: 10.0.1.1

    Create NetworkRoute Resource

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

    Constructor syntax

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

@overload
def NetworkRoute(resource_name: str,
                 opts: Optional[ResourceOptions] = None,
                 destination: Optional[str] = None,
                 gateway: Optional[str] = None,
                 network_id: Optional[int] = None)
    func NewNetworkRoute(ctx *Context, name string, args NetworkRouteArgs, opts ...ResourceOption) (*NetworkRoute, error)
    public NetworkRoute(string name, NetworkRouteArgs args, CustomResourceOptions? opts = null)
    public NetworkRoute(String name, NetworkRouteArgs args)
public NetworkRoute(String name, NetworkRouteArgs args, CustomResourceOptions options)

    type: hcloud:NetworkRoute
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 NetworkRouteArgs
    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 NetworkRouteArgs
    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 NetworkRouteArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args NetworkRouteArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args NetworkRouteArgs
    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 networkRouteResource = new HCloud.NetworkRoute("networkRouteResource", new()
{
    Destination = "string",
    Gateway = "string",
    NetworkId = 0,
});

    example, err := hcloud.NewNetworkRoute(ctx, "networkRouteResource", &hcloud.NetworkRouteArgs{
	Destination: pulumi.String("string"),
	Gateway:     pulumi.String("string"),
	NetworkId:   pulumi.Int(0),
})

    var networkRouteResource = new NetworkRoute("networkRouteResource", NetworkRouteArgs.builder()
    .destination("string")
    .gateway("string")
    .networkId(0)
    .build());

    network_route_resource = hcloud.NetworkRoute("networkRouteResource",
    destination="string",
    gateway="string",
    network_id=0)

    const networkRouteResource = new hcloud.NetworkRoute("networkRouteResource", {
    destination: "string",
    gateway: "string",
    networkId: 0,
});

    type: hcloud:NetworkRoute
properties:
    destination: string
    gateway: string
    networkId: 0

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

    Destination string
    Destination network or host of this route. Must be a subnet of the ip_range of the Network. Must not overlap with an existing ip_range in any subnets or with any destinations in other routes or with the first ip of the networks ip_range or with 172.31.1.1.
    Gateway string
    Gateway for the route. Cannot be the first ip of the networks ip_range and also cannot be 172.31.1.1 as this IP is being used as a gateway for the public network interface of servers.
    NetworkId int
    ID of the Network the route should be added to.
    Destination string
    Destination network or host of this route. Must be a subnet of the ip_range of the Network. Must not overlap with an existing ip_range in any subnets or with any destinations in other routes or with the first ip of the networks ip_range or with 172.31.1.1.
    Gateway string
    Gateway for the route. Cannot be the first ip of the networks ip_range and also cannot be 172.31.1.1 as this IP is being used as a gateway for the public network interface of servers.
    NetworkId int
    ID of the Network the route should be added to.
    destination String
    Destination network or host of this route. Must be a subnet of the ip_range of the Network. Must not overlap with an existing ip_range in any subnets or with any destinations in other routes or with the first ip of the networks ip_range or with 172.31.1.1.
    gateway String
    Gateway for the route. Cannot be the first ip of the networks ip_range and also cannot be 172.31.1.1 as this IP is being used as a gateway for the public network interface of servers.
    networkId Integer
    ID of the Network the route should be added to.
    destination string
    Destination network or host of this route. Must be a subnet of the ip_range of the Network. Must not overlap with an existing ip_range in any subnets or with any destinations in other routes or with the first ip of the networks ip_range or with 172.31.1.1.
    gateway string
    Gateway for the route. Cannot be the first ip of the networks ip_range and also cannot be 172.31.1.1 as this IP is being used as a gateway for the public network interface of servers.
    networkId number
    ID of the Network the route should be added to.
    destination str
    Destination network or host of this route. Must be a subnet of the ip_range of the Network. Must not overlap with an existing ip_range in any subnets or with any destinations in other routes or with the first ip of the networks ip_range or with 172.31.1.1.
    gateway str
    Gateway for the route. Cannot be the first ip of the networks ip_range and also cannot be 172.31.1.1 as this IP is being used as a gateway for the public network interface of servers.
    network_id int
    ID of the Network the route should be added to.
    destination String
    Destination network or host of this route. Must be a subnet of the ip_range of the Network. Must not overlap with an existing ip_range in any subnets or with any destinations in other routes or with the first ip of the networks ip_range or with 172.31.1.1.
    gateway String
    Gateway for the route. Cannot be the first ip of the networks ip_range and also cannot be 172.31.1.1 as this IP is being used as a gateway for the public network interface of servers.
    networkId Number
    ID of the Network the route should be added to.

    Outputs

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

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

    Look up Existing NetworkRoute Resource

    Get an existing NetworkRoute 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?: NetworkRouteState, opts?: CustomResourceOptions): NetworkRoute
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        destination: Optional[str] = None,
        gateway: Optional[str] = None,
        network_id: Optional[int] = None) -> NetworkRoute
    func GetNetworkRoute(ctx *Context, name string, id IDInput, state *NetworkRouteState, opts ...ResourceOption) (*NetworkRoute, error)
    public static NetworkRoute Get(string name, Input<string> id, NetworkRouteState? state, CustomResourceOptions? opts = null)
    public static NetworkRoute get(String name, Output<String> id, NetworkRouteState state, CustomResourceOptions options)
    Resource lookup is not supported in YAML
    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:
    Destination string
    Destination network or host of this route. Must be a subnet of the ip_range of the Network. Must not overlap with an existing ip_range in any subnets or with any destinations in other routes or with the first ip of the networks ip_range or with 172.31.1.1.
    Gateway string
    Gateway for the route. Cannot be the first ip of the networks ip_range and also cannot be 172.31.1.1 as this IP is being used as a gateway for the public network interface of servers.
    NetworkId int
    ID of the Network the route should be added to.
    Destination string
    Destination network or host of this route. Must be a subnet of the ip_range of the Network. Must not overlap with an existing ip_range in any subnets or with any destinations in other routes or with the first ip of the networks ip_range or with 172.31.1.1.
    Gateway string
    Gateway for the route. Cannot be the first ip of the networks ip_range and also cannot be 172.31.1.1 as this IP is being used as a gateway for the public network interface of servers.
    NetworkId int
    ID of the Network the route should be added to.
    destination String
    Destination network or host of this route. Must be a subnet of the ip_range of the Network. Must not overlap with an existing ip_range in any subnets or with any destinations in other routes or with the first ip of the networks ip_range or with 172.31.1.1.
    gateway String
    Gateway for the route. Cannot be the first ip of the networks ip_range and also cannot be 172.31.1.1 as this IP is being used as a gateway for the public network interface of servers.
    networkId Integer
    ID of the Network the route should be added to.
    destination string
    Destination network or host of this route. Must be a subnet of the ip_range of the Network. Must not overlap with an existing ip_range in any subnets or with any destinations in other routes or with the first ip of the networks ip_range or with 172.31.1.1.
    gateway string
    Gateway for the route. Cannot be the first ip of the networks ip_range and also cannot be 172.31.1.1 as this IP is being used as a gateway for the public network interface of servers.
    networkId number
    ID of the Network the route should be added to.
    destination str
    Destination network or host of this route. Must be a subnet of the ip_range of the Network. Must not overlap with an existing ip_range in any subnets or with any destinations in other routes or with the first ip of the networks ip_range or with 172.31.1.1.
    gateway str
    Gateway for the route. Cannot be the first ip of the networks ip_range and also cannot be 172.31.1.1 as this IP is being used as a gateway for the public network interface of servers.
    network_id int
    ID of the Network the route should be added to.
    destination String
    Destination network or host of this route. Must be a subnet of the ip_range of the Network. Must not overlap with an existing ip_range in any subnets or with any destinations in other routes or with the first ip of the networks ip_range or with 172.31.1.1.
    gateway String
    Gateway for the route. Cannot be the first ip of the networks ip_range and also cannot be 172.31.1.1 as this IP is being used as a gateway for the public network interface of servers.
    networkId Number
    ID of the Network the route should be added to.

    Import

    Network Route entries can be imported using a compound ID with the following format:

    <network-id>-<destination>

    $ pulumi import hcloud:index/networkRoute:NetworkRoute myroute 123-10.0.0.0/16

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

    Package Details

    Repository
    Hetzner Cloud pulumi/pulumi-hcloud
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the hcloud Terraform Provider.
    hcloud logo
    Hetzner Cloud v1.21.0 published on Tuesday, Nov 12, 2024 by Pulumi
    pulumi/pulumi-hcloud