Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. threefold
  3. API Docs
  4. Network
Threefold Grid v0.7.4 published on Thursday, Sep 5, 2024 by Threefold
threefoldtech/pulumi-threefold

threefold.Network

Explore with Pulumi AI

threefold logo
Threefold Grid v0.7.4 published on Thursday, Sep 5, 2024 by Threefold
threefoldtech/pulumi-threefold

    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,
            description: Optional[str] = None,
            ip_range: Optional[str] = None,
            name: Optional[str] = None,
            nodes: Optional[Sequence[Any]] = None,
            add_wg_access: Optional[bool] = None,
            mycelium: Optional[bool] = None,
            mycelium_keys: Optional[Mapping[str, str]] = None,
            solution_type: 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: threefold: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 Threefold.Network("networkResource", new()
{
    Description = "string",
    Ip_range = "string",
    Name = "string",
    Nodes = new[]
    {
        "any",
    },
    Add_wg_access = false,
    Mycelium = false,
    Mycelium_keys = 
    {
        { "string", "string" },
    },
    Solution_type = "string",
});

    example, err := threefold.NewNetwork(ctx, "networkResource", &threefold.NetworkArgs{
	Description: pulumi.String("string"),
	Ip_range:    pulumi.String("string"),
	Name:        pulumi.String("string"),
	Nodes: pulumi.Array{
		pulumi.Any("any"),
	},
	Add_wg_access: pulumi.Bool(false),
	Mycelium:      pulumi.Bool(false),
	Mycelium_keys: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
	Solution_type: pulumi.String("string"),
})

    var networkResource = new Network("networkResource", NetworkArgs.builder()
    .description("string")
    .ip_range("string")
    .name("string")
    .nodes("any")
    .add_wg_access(false)
    .mycelium(false)
    .mycelium_keys(Map.of("string", "string"))
    .solution_type("string")
    .build());

    network_resource = threefold.Network("networkResource",
    description="string",
    ip_range="string",
    name="string",
    nodes=["any"],
    add_wg_access=False,
    mycelium=False,
    mycelium_keys={
        "string": "string",
    },
    solution_type="string")

    const networkResource = new threefold.Network("networkResource", {
    description: "string",
    ip_range: "string",
    name: "string",
    nodes: ["any"],
    add_wg_access: false,
    mycelium: false,
    mycelium_keys: {
        string: "string",
    },
    solution_type: "string",
});

    type: threefold:Network
properties:
    add_wg_access: false
    description: string
    ip_range: string
    mycelium: false
    mycelium_keys:
        string: string
    name: string
    nodes:
        - any
    solution_type: 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

    The Network resource accepts the following input properties:

    Description string
    Ip_range string
    Name string
    Nodes List<object>
    Add_wg_access bool
    Mycelium bool
    Mycelium_keys Dictionary<string, string>
    Solution_type string
    Description string
    Ip_range string
    Name string
    Nodes []interface{}
    Add_wg_access bool
    Mycelium bool
    Mycelium_keys map[string]string
    Solution_type string
    description String
    ip_range String
    name String
    nodes List<Object>
    add_wg_access Boolean
    mycelium Boolean
    mycelium_keys Map<String,String>
    solution_type String
    description string
    ip_range string
    name string
    nodes any[]
    add_wg_access boolean
    mycelium boolean
    mycelium_keys {[key: string]: string}
    solution_type string
    description str
    ip_range str
    name str
    nodes Sequence[Any]
    add_wg_access bool
    mycelium bool
    mycelium_keys Mapping[str, str]
    solution_type str
    description String
    ip_range String
    name String
    nodes List<Any>
    add_wg_access Boolean
    mycelium Boolean
    mycelium_keys Map<String>
    solution_type String

    Outputs

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

    Access_wg_config string
    External_ip string
    External_sk string
    Id string
    The provider-assigned unique ID for this managed resource.
    Node_deployment_id Dictionary<string, int>
    Nodes_ip_range Dictionary<string, string>
    Public_node_id int
    Access_wg_config string
    External_ip string
    External_sk string
    Id string
    The provider-assigned unique ID for this managed resource.
    Node_deployment_id map[string]int
    Nodes_ip_range map[string]string
    Public_node_id int
    access_wg_config String
    external_ip String
    external_sk String
    id String
    The provider-assigned unique ID for this managed resource.
    node_deployment_id Map<String,Integer>
    nodes_ip_range Map<String,String>
    public_node_id Integer
    access_wg_config string
    external_ip string
    external_sk string
    id string
    The provider-assigned unique ID for this managed resource.
    node_deployment_id {[key: string]: number}
    nodes_ip_range {[key: string]: string}
    public_node_id number
    access_wg_config str
    external_ip str
    external_sk str
    id str
    The provider-assigned unique ID for this managed resource.
    node_deployment_id Mapping[str, int]
    nodes_ip_range Mapping[str, str]
    public_node_id int
    access_wg_config String
    external_ip String
    external_sk String
    id String
    The provider-assigned unique ID for this managed resource.
    node_deployment_id Map<Number>
    nodes_ip_range Map<String>
    public_node_id Number

    Package Details

    Repository
    threefold threefoldtech/pulumi-threefold
    License
    Apache-2.0
    threefold logo
    Threefold Grid v0.7.4 published on Thursday, Sep 5, 2024 by Threefold
    threefoldtech/pulumi-threefold