hcloud.Network
Explore with Pulumi AI
Provides a Hetzner Cloud Network to represent a Network in the Hetzner Cloud.
Example Usage
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using HCloud = Pulumi.HCloud;
return await Deployment.RunAsync(() =>
{
var privNet = new HCloud.Network("privNet", new()
{
IpRange = "10.0.1.0/24",
});
});
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 {
_, err := hcloud.NewNetwork(ctx, "privNet", &hcloud.NetworkArgs{
IpRange: pulumi.String("10.0.1.0/24"),
})
if err != nil {
return err
}
return nil
})
}
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 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 privNet = new Network("privNet", NetworkArgs.builder()
.ipRange("10.0.1.0/24")
.build());
}
}
import pulumi
import pulumi_hcloud as hcloud
priv_net = hcloud.Network("privNet", ip_range="10.0.1.0/24")
import * as pulumi from "@pulumi/pulumi";
import * as hcloud from "@pulumi/hcloud";
const privNet = new hcloud.Network("privNet", {ipRange: "10.0.1.0/24"});
resources:
privNet:
type: hcloud:Network
properties:
ipRange: 10.0.1.0/24
Create Network Resource
new Network(name: string, args: NetworkArgs, opts?: CustomResourceOptions);
@overload
def Network(resource_name: str,
opts: Optional[ResourceOptions] = None,
delete_protection: Optional[bool] = None,
expose_routes_to_vswitch: Optional[bool] = None,
ip_range: Optional[str] = None,
labels: Optional[Mapping[str, Any]] = None,
name: Optional[str] = None)
@overload
def Network(resource_name: str,
args: NetworkArgs,
opts: Optional[ResourceOptions] = 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: hcloud:Network
properties: # The arguments to resource properties.
options: # 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.
- 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.
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
The Network resource accepts the following input properties:
- Ip
Range string IP Range of the whole Network which must span all included subnets and route destinations. Must be one of the private ipv4 ranges of RFC1918.
- Delete
Protection bool Enable or disable delete protection.
- Expose
Routes boolTo Vswitch Enable or disable exposing the routes to the vSwitch connection. The exposing only takes effect if a vSwitch connection is active.
- Labels Dictionary<string, object>
User-defined labels (key-value pairs) should be created with.
- Name string
Name of the Network to create (must be unique per project).
- Ip
Range string IP Range of the whole Network which must span all included subnets and route destinations. Must be one of the private ipv4 ranges of RFC1918.
- Delete
Protection bool Enable or disable delete protection.
- Expose
Routes boolTo Vswitch Enable or disable exposing the routes to the vSwitch connection. The exposing only takes effect if a vSwitch connection is active.
- Labels map[string]interface{}
User-defined labels (key-value pairs) should be created with.
- Name string
Name of the Network to create (must be unique per project).
- ip
Range String IP Range of the whole Network which must span all included subnets and route destinations. Must be one of the private ipv4 ranges of RFC1918.
- delete
Protection Boolean Enable or disable delete protection.
- expose
Routes BooleanTo Vswitch Enable or disable exposing the routes to the vSwitch connection. The exposing only takes effect if a vSwitch connection is active.
- labels Map<String,Object>
User-defined labels (key-value pairs) should be created with.
- name String
Name of the Network to create (must be unique per project).
- ip
Range string IP Range of the whole Network which must span all included subnets and route destinations. Must be one of the private ipv4 ranges of RFC1918.
- delete
Protection boolean Enable or disable delete protection.
- expose
Routes booleanTo Vswitch Enable or disable exposing the routes to the vSwitch connection. The exposing only takes effect if a vSwitch connection is active.
- labels {[key: string]: any}
User-defined labels (key-value pairs) should be created with.
- name string
Name of the Network to create (must be unique per project).
- ip_
range str IP Range of the whole Network which must span all included subnets and route destinations. Must be one of the private ipv4 ranges of RFC1918.
- delete_
protection bool Enable or disable delete protection.
- expose_
routes_ boolto_ vswitch Enable or disable exposing the routes to the vSwitch connection. The exposing only takes effect if a vSwitch connection is active.
- labels Mapping[str, Any]
User-defined labels (key-value pairs) should be created with.
- name str
Name of the Network to create (must be unique per project).
- ip
Range String IP Range of the whole Network which must span all included subnets and route destinations. Must be one of the private ipv4 ranges of RFC1918.
- delete
Protection Boolean Enable or disable delete protection.
- expose
Routes BooleanTo Vswitch Enable or disable exposing the routes to the vSwitch connection. The exposing only takes effect if a vSwitch connection is active.
- labels Map<Any>
User-defined labels (key-value pairs) should be created with.
- name String
Name of the Network to create (must be unique per project).
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.
- 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 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,
delete_protection: Optional[bool] = None,
expose_routes_to_vswitch: Optional[bool] = None,
ip_range: Optional[str] = None,
labels: Optional[Mapping[str, Any]] = None,
name: 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)
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.
- Delete
Protection bool Enable or disable delete protection.
- Expose
Routes boolTo Vswitch Enable or disable exposing the routes to the vSwitch connection. The exposing only takes effect if a vSwitch connection is active.
- Ip
Range string IP Range of the whole Network which must span all included subnets and route destinations. Must be one of the private ipv4 ranges of RFC1918.
- Labels Dictionary<string, object>
User-defined labels (key-value pairs) should be created with.
- Name string
Name of the Network to create (must be unique per project).
- Delete
Protection bool Enable or disable delete protection.
- Expose
Routes boolTo Vswitch Enable or disable exposing the routes to the vSwitch connection. The exposing only takes effect if a vSwitch connection is active.
- Ip
Range string IP Range of the whole Network which must span all included subnets and route destinations. Must be one of the private ipv4 ranges of RFC1918.
- Labels map[string]interface{}
User-defined labels (key-value pairs) should be created with.
- Name string
Name of the Network to create (must be unique per project).
- delete
Protection Boolean Enable or disable delete protection.
- expose
Routes BooleanTo Vswitch Enable or disable exposing the routes to the vSwitch connection. The exposing only takes effect if a vSwitch connection is active.
- ip
Range String IP Range of the whole Network which must span all included subnets and route destinations. Must be one of the private ipv4 ranges of RFC1918.
- labels Map<String,Object>
User-defined labels (key-value pairs) should be created with.
- name String
Name of the Network to create (must be unique per project).
- delete
Protection boolean Enable or disable delete protection.
- expose
Routes booleanTo Vswitch Enable or disable exposing the routes to the vSwitch connection. The exposing only takes effect if a vSwitch connection is active.
- ip
Range string IP Range of the whole Network which must span all included subnets and route destinations. Must be one of the private ipv4 ranges of RFC1918.
- labels {[key: string]: any}
User-defined labels (key-value pairs) should be created with.
- name string
Name of the Network to create (must be unique per project).
- delete_
protection bool Enable or disable delete protection.
- expose_
routes_ boolto_ vswitch Enable or disable exposing the routes to the vSwitch connection. The exposing only takes effect if a vSwitch connection is active.
- ip_
range str IP Range of the whole Network which must span all included subnets and route destinations. Must be one of the private ipv4 ranges of RFC1918.
- labels Mapping[str, Any]
User-defined labels (key-value pairs) should be created with.
- name str
Name of the Network to create (must be unique per project).
- delete
Protection Boolean Enable or disable delete protection.
- expose
Routes BooleanTo Vswitch Enable or disable exposing the routes to the vSwitch connection. The exposing only takes effect if a vSwitch connection is active.
- ip
Range String IP Range of the whole Network which must span all included subnets and route destinations. Must be one of the private ipv4 ranges of RFC1918.
- labels Map<Any>
User-defined labels (key-value pairs) should be created with.
- name String
Name of the Network to create (must be unique per project).
Import
Networks can be imported using its id
$ pulumi import hcloud:index/network:Network myip id
Package Details
- Repository
- Hetzner Cloud pulumi/pulumi-hcloud
- License
- Apache-2.0
- Notes
This Pulumi package is based on the
hcloud
Terraform Provider.