1. Packages
  2. Civo
  3. API Docs
  4. Network
Civo v2.3.13 published on Friday, Jan 19, 2024 by Pulumi

civo.Network

Explore with Pulumi AI

civo logo
Civo v2.3.13 published on Friday, Jan 19, 2024 by Pulumi

    Provides a Civo network resource. This can be used to create, modify, and delete networks.

    Example Usage

    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Civo = Pulumi.Civo;
    
    return await Deployment.RunAsync(() => 
    {
        var customNet = new Civo.Network("customNet", new()
        {
            Label = "test_network",
        });
    
    });
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-civo/sdk/v2/go/civo"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		_, err := civo.NewNetwork(ctx, "customNet", &civo.NetworkArgs{
    			Label: pulumi.String("test_network"),
    		})
    		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.civo.Network;
    import com.pulumi.civo.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 customNet = new Network("customNet", NetworkArgs.builder()        
                .label("test_network")
                .build());
    
        }
    }
    
    import pulumi
    import pulumi_civo as civo
    
    custom_net = civo.Network("customNet", label="test_network")
    
    import * as pulumi from "@pulumi/pulumi";
    import * as civo from "@pulumi/civo";
    
    const customNet = new civo.Network("customNet", {label: "test_network"});
    
    resources:
      customNet:
        type: civo:Network
        properties:
          label: test_network
    

    Create Network Resource

    new Network(name: string, args: NetworkArgs, opts?: CustomResourceOptions);
    @overload
    def Network(resource_name: str,
                opts: Optional[ResourceOptions] = None,
                label: Optional[str] = None,
                region: 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: civo: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:

    Label string
    Name for the network
    Region string
    The region of the network
    Label string
    Name for the network
    Region string
    The region of the network
    label String
    Name for the network
    region String
    The region of the network
    label string
    Name for the network
    region string
    The region of the network
    label str
    Name for the network
    region str
    The region of the network
    label String
    Name for the network
    region String
    The region of the network

    Outputs

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

    Default bool
    If the network is default, this will be true
    Id string
    The provider-assigned unique ID for this managed resource.
    Name string
    The name of the network
    Default bool
    If the network is default, this will be true
    Id string
    The provider-assigned unique ID for this managed resource.
    Name string
    The name of the network
    default_ Boolean
    If the network is default, this will be true
    id String
    The provider-assigned unique ID for this managed resource.
    name String
    The name of the network
    default boolean
    If the network is default, this will be true
    id string
    The provider-assigned unique ID for this managed resource.
    name string
    The name of the network
    default bool
    If the network is default, this will be true
    id str
    The provider-assigned unique ID for this managed resource.
    name str
    The name of the network
    default Boolean
    If the network is default, this will be true
    id String
    The provider-assigned unique ID for this managed resource.
    name String
    The name of the network

    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,
            default: Optional[bool] = None,
            label: Optional[str] = None,
            name: Optional[str] = None,
            region: 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.
    The following state arguments are supported:
    Default bool
    If the network is default, this will be true
    Label string
    Name for the network
    Name string
    The name of the network
    Region string
    The region of the network
    Default bool
    If the network is default, this will be true
    Label string
    Name for the network
    Name string
    The name of the network
    Region string
    The region of the network
    default_ Boolean
    If the network is default, this will be true
    label String
    Name for the network
    name String
    The name of the network
    region String
    The region of the network
    default boolean
    If the network is default, this will be true
    label string
    Name for the network
    name string
    The name of the network
    region string
    The region of the network
    default bool
    If the network is default, this will be true
    label str
    Name for the network
    name str
    The name of the network
    region str
    The region of the network
    default Boolean
    If the network is default, this will be true
    label String
    Name for the network
    name String
    The name of the network
    region String
    The region of the network

    Import

    using ID

     $ pulumi import civo:index/network:Network custom_net b8ecd2ab-2267-4a5e-8692-cbf1d32583e3
    

    Package Details

    Repository
    Civo pulumi/pulumi-civo
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the civo Terraform Provider.
    civo logo
    Civo v2.3.13 published on Friday, Jan 19, 2024 by Pulumi