1. Packages
  2. Civo Provider
  3. API Docs
  4. VpcNetwork
Viewing docs for civo 1.2.3
published on Thursday, Apr 9, 2026 by civo
Schema (JSON)
civo/terraform-provider-civo

civo.VpcNetwork

civo logo
Viewing docs for civo 1.2.3
published on Thursday, Apr 9, 2026 by civo
Schema (JSON)
civo/terraform-provider-civo

    Create VpcNetwork Resource

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

    Constructor syntax

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

@overload
def VpcNetwork(resource_name: str,
               opts: Optional[ResourceOptions] = None,
               label: Optional[str] = None,
               cidr_v4: Optional[str] = None,
               nameservers_v4s: Optional[Sequence[str]] = None,
               region: Optional[str] = None,
               timeouts: Optional[VpcNetworkTimeoutsArgs] = None,
               vlan_allocation_pool_v4_end: Optional[str] = None,
               vlan_allocation_pool_v4_start: Optional[str] = None,
               vlan_cidr_v4: Optional[str] = None,
               vlan_gateway_ip_v4: Optional[str] = None,
               vlan_id: Optional[float] = None,
               vlan_physical_interface: Optional[str] = None,
               vpc_network_id: Optional[str] = None)
    func NewVpcNetwork(ctx *Context, name string, args VpcNetworkArgs, opts ...ResourceOption) (*VpcNetwork, error)
    public VpcNetwork(string name, VpcNetworkArgs args, CustomResourceOptions? opts = null)
    public VpcNetwork(String name, VpcNetworkArgs args)
public VpcNetwork(String name, VpcNetworkArgs args, CustomResourceOptions options)

    type: civo:VpcNetwork
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 VpcNetworkArgs
    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 VpcNetworkArgs
    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 VpcNetworkArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args VpcNetworkArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args VpcNetworkArgs
    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 vpcNetworkResource = new Civo.Index.VpcNetwork("vpcNetworkResource", new()
{
    Label = "string",
    CidrV4 = "string",
    NameserversV4s = new[]
    {
        "string",
    },
    Region = "string",
    Timeouts = new Civo.Inputs.VpcNetworkTimeoutsArgs
    {
        Create = "string",
        Delete = "string",
        Update = "string",
    },
    VlanAllocationPoolV4End = "string",
    VlanAllocationPoolV4Start = "string",
    VlanCidrV4 = "string",
    VlanGatewayIpV4 = "string",
    VlanId = 0,
    VlanPhysicalInterface = "string",
    VpcNetworkId = "string",
});

    example, err := civo.NewVpcNetwork(ctx, "vpcNetworkResource", &civo.VpcNetworkArgs{
	Label:  pulumi.String("string"),
	CidrV4: pulumi.String("string"),
	NameserversV4s: pulumi.StringArray{
		pulumi.String("string"),
	},
	Region: pulumi.String("string"),
	Timeouts: &civo.VpcNetworkTimeoutsArgs{
		Create: pulumi.String("string"),
		Delete: pulumi.String("string"),
		Update: pulumi.String("string"),
	},
	VlanAllocationPoolV4End:   pulumi.String("string"),
	VlanAllocationPoolV4Start: pulumi.String("string"),
	VlanCidrV4:                pulumi.String("string"),
	VlanGatewayIpV4:           pulumi.String("string"),
	VlanId:                    pulumi.Float64(0),
	VlanPhysicalInterface:     pulumi.String("string"),
	VpcNetworkId:              pulumi.String("string"),
})

    var vpcNetworkResource = new VpcNetwork("vpcNetworkResource", VpcNetworkArgs.builder()
    .label("string")
    .cidrV4("string")
    .nameserversV4s("string")
    .region("string")
    .timeouts(VpcNetworkTimeoutsArgs.builder()
        .create("string")
        .delete("string")
        .update("string")
        .build())
    .vlanAllocationPoolV4End("string")
    .vlanAllocationPoolV4Start("string")
    .vlanCidrV4("string")
    .vlanGatewayIpV4("string")
    .vlanId(0.0)
    .vlanPhysicalInterface("string")
    .vpcNetworkId("string")
    .build());

    vpc_network_resource = civo.VpcNetwork("vpcNetworkResource",
    label="string",
    cidr_v4="string",
    nameservers_v4s=["string"],
    region="string",
    timeouts={
        "create": "string",
        "delete": "string",
        "update": "string",
    },
    vlan_allocation_pool_v4_end="string",
    vlan_allocation_pool_v4_start="string",
    vlan_cidr_v4="string",
    vlan_gateway_ip_v4="string",
    vlan_id=0,
    vlan_physical_interface="string",
    vpc_network_id="string")

    const vpcNetworkResource = new civo.VpcNetwork("vpcNetworkResource", {
    label: "string",
    cidrV4: "string",
    nameserversV4s: ["string"],
    region: "string",
    timeouts: {
        create: "string",
        "delete": "string",
        update: "string",
    },
    vlanAllocationPoolV4End: "string",
    vlanAllocationPoolV4Start: "string",
    vlanCidrV4: "string",
    vlanGatewayIpV4: "string",
    vlanId: 0,
    vlanPhysicalInterface: "string",
    vpcNetworkId: "string",
});

    type: civo:VpcNetwork
properties:
    cidrV4: string
    label: string
    nameserversV4s:
        - string
    region: string
    timeouts:
        create: string
        delete: string
        update: string
    vlanAllocationPoolV4End: string
    vlanAllocationPoolV4Start: string
    vlanCidrV4: string
    vlanGatewayIpV4: string
    vlanId: 0
    vlanPhysicalInterface: string
    vpcNetworkId: string

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

    Label string
    Name for the network
    CidrV4 string
    The CIDR block for the network
    NameserversV4s List<string>
    List of nameservers for the network
    Region string
    The region of the network
    Timeouts VpcNetworkTimeouts
    VlanAllocationPoolV4End string
    End of the IPv4 allocation pool for VLAN
    VlanAllocationPoolV4Start string
    Start of the IPv4 allocation pool for VLAN
    VlanCidrV4 string
    CIDR for VLAN IPv4
    VlanGatewayIpV4 string
    Gateway IP for VLAN IPv4
    VlanId double
    VLAN ID for the network
    VlanPhysicalInterface string
    Physical interface for VLAN
    VpcNetworkId string
    Label string
    Name for the network
    CidrV4 string
    The CIDR block for the network
    NameserversV4s []string
    List of nameservers for the network
    Region string
    The region of the network
    Timeouts VpcNetworkTimeoutsArgs
    VlanAllocationPoolV4End string
    End of the IPv4 allocation pool for VLAN
    VlanAllocationPoolV4Start string
    Start of the IPv4 allocation pool for VLAN
    VlanCidrV4 string
    CIDR for VLAN IPv4
    VlanGatewayIpV4 string
    Gateway IP for VLAN IPv4
    VlanId float64
    VLAN ID for the network
    VlanPhysicalInterface string
    Physical interface for VLAN
    VpcNetworkId string
    label String
    Name for the network
    cidrV4 String
    The CIDR block for the network
    nameserversV4s List<String>
    List of nameservers for the network
    region String
    The region of the network
    timeouts VpcNetworkTimeouts
    vlanAllocationPoolV4End String
    End of the IPv4 allocation pool for VLAN
    vlanAllocationPoolV4Start String
    Start of the IPv4 allocation pool for VLAN
    vlanCidrV4 String
    CIDR for VLAN IPv4
    vlanGatewayIpV4 String
    Gateway IP for VLAN IPv4
    vlanId Double
    VLAN ID for the network
    vlanPhysicalInterface String
    Physical interface for VLAN
    vpcNetworkId String
    label string
    Name for the network
    cidrV4 string
    The CIDR block for the network
    nameserversV4s string[]
    List of nameservers for the network
    region string
    The region of the network
    timeouts VpcNetworkTimeouts
    vlanAllocationPoolV4End string
    End of the IPv4 allocation pool for VLAN
    vlanAllocationPoolV4Start string
    Start of the IPv4 allocation pool for VLAN
    vlanCidrV4 string
    CIDR for VLAN IPv4
    vlanGatewayIpV4 string
    Gateway IP for VLAN IPv4
    vlanId number
    VLAN ID for the network
    vlanPhysicalInterface string
    Physical interface for VLAN
    vpcNetworkId string
    label str
    Name for the network
    cidr_v4 str
    The CIDR block for the network
    nameservers_v4s Sequence[str]
    List of nameservers for the network
    region str
    The region of the network
    timeouts VpcNetworkTimeoutsArgs
    vlan_allocation_pool_v4_end str
    End of the IPv4 allocation pool for VLAN
    vlan_allocation_pool_v4_start str
    Start of the IPv4 allocation pool for VLAN
    vlan_cidr_v4 str
    CIDR for VLAN IPv4
    vlan_gateway_ip_v4 str
    Gateway IP for VLAN IPv4
    vlan_id float
    VLAN ID for the network
    vlan_physical_interface str
    Physical interface for VLAN
    vpc_network_id str
    label String
    Name for the network
    cidrV4 String
    The CIDR block for the network
    nameserversV4s List<String>
    List of nameservers for the network
    region String
    The region of the network
    timeouts Property Map
    vlanAllocationPoolV4End String
    End of the IPv4 allocation pool for VLAN
    vlanAllocationPoolV4Start String
    Start of the IPv4 allocation pool for VLAN
    vlanCidrV4 String
    CIDR for VLAN IPv4
    vlanGatewayIpV4 String
    Gateway IP for VLAN IPv4
    vlanId Number
    VLAN ID for the network
    vlanPhysicalInterface String
    Physical interface for VLAN
    vpcNetworkId String

    Outputs

    All input properties are implicitly available as output properties. Additionally, the VpcNetwork 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 VpcNetwork Resource

    Get an existing VpcNetwork 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?: VpcNetworkState, opts?: CustomResourceOptions): VpcNetwork
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        cidr_v4: Optional[str] = None,
        default: Optional[bool] = None,
        label: Optional[str] = None,
        name: Optional[str] = None,
        nameservers_v4s: Optional[Sequence[str]] = None,
        region: Optional[str] = None,
        timeouts: Optional[VpcNetworkTimeoutsArgs] = None,
        vlan_allocation_pool_v4_end: Optional[str] = None,
        vlan_allocation_pool_v4_start: Optional[str] = None,
        vlan_cidr_v4: Optional[str] = None,
        vlan_gateway_ip_v4: Optional[str] = None,
        vlan_id: Optional[float] = None,
        vlan_physical_interface: Optional[str] = None,
        vpc_network_id: Optional[str] = None) -> VpcNetwork
    func GetVpcNetwork(ctx *Context, name string, id IDInput, state *VpcNetworkState, opts ...ResourceOption) (*VpcNetwork, error)
    public static VpcNetwork Get(string name, Input<string> id, VpcNetworkState? state, CustomResourceOptions? opts = null)
    public static VpcNetwork get(String name, Output<String> id, VpcNetworkState state, CustomResourceOptions options)
    resources:  _:    type: civo:VpcNetwork    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:
    CidrV4 string
    The CIDR block for 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
    NameserversV4s List<string>
    List of nameservers for the network
    Region string
    The region of the network
    Timeouts VpcNetworkTimeouts
    VlanAllocationPoolV4End string
    End of the IPv4 allocation pool for VLAN
    VlanAllocationPoolV4Start string
    Start of the IPv4 allocation pool for VLAN
    VlanCidrV4 string
    CIDR for VLAN IPv4
    VlanGatewayIpV4 string
    Gateway IP for VLAN IPv4
    VlanId double
    VLAN ID for the network
    VlanPhysicalInterface string
    Physical interface for VLAN
    VpcNetworkId string
    CidrV4 string
    The CIDR block for 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
    NameserversV4s []string
    List of nameservers for the network
    Region string
    The region of the network
    Timeouts VpcNetworkTimeoutsArgs
    VlanAllocationPoolV4End string
    End of the IPv4 allocation pool for VLAN
    VlanAllocationPoolV4Start string
    Start of the IPv4 allocation pool for VLAN
    VlanCidrV4 string
    CIDR for VLAN IPv4
    VlanGatewayIpV4 string
    Gateway IP for VLAN IPv4
    VlanId float64
    VLAN ID for the network
    VlanPhysicalInterface string
    Physical interface for VLAN
    VpcNetworkId string
    cidrV4 String
    The CIDR block for 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
    nameserversV4s List<String>
    List of nameservers for the network
    region String
    The region of the network
    timeouts VpcNetworkTimeouts
    vlanAllocationPoolV4End String
    End of the IPv4 allocation pool for VLAN
    vlanAllocationPoolV4Start String
    Start of the IPv4 allocation pool for VLAN
    vlanCidrV4 String
    CIDR for VLAN IPv4
    vlanGatewayIpV4 String
    Gateway IP for VLAN IPv4
    vlanId Double
    VLAN ID for the network
    vlanPhysicalInterface String
    Physical interface for VLAN
    vpcNetworkId String
    cidrV4 string
    The CIDR block for 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
    nameserversV4s string[]
    List of nameservers for the network
    region string
    The region of the network
    timeouts VpcNetworkTimeouts
    vlanAllocationPoolV4End string
    End of the IPv4 allocation pool for VLAN
    vlanAllocationPoolV4Start string
    Start of the IPv4 allocation pool for VLAN
    vlanCidrV4 string
    CIDR for VLAN IPv4
    vlanGatewayIpV4 string
    Gateway IP for VLAN IPv4
    vlanId number
    VLAN ID for the network
    vlanPhysicalInterface string
    Physical interface for VLAN
    vpcNetworkId string
    cidr_v4 str
    The CIDR block for 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
    nameservers_v4s Sequence[str]
    List of nameservers for the network
    region str
    The region of the network
    timeouts VpcNetworkTimeoutsArgs
    vlan_allocation_pool_v4_end str
    End of the IPv4 allocation pool for VLAN
    vlan_allocation_pool_v4_start str
    Start of the IPv4 allocation pool for VLAN
    vlan_cidr_v4 str
    CIDR for VLAN IPv4
    vlan_gateway_ip_v4 str
    Gateway IP for VLAN IPv4
    vlan_id float
    VLAN ID for the network
    vlan_physical_interface str
    Physical interface for VLAN
    vpc_network_id str
    cidrV4 String
    The CIDR block for 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
    nameserversV4s List<String>
    List of nameservers for the network
    region String
    The region of the network
    timeouts Property Map
    vlanAllocationPoolV4End String
    End of the IPv4 allocation pool for VLAN
    vlanAllocationPoolV4Start String
    Start of the IPv4 allocation pool for VLAN
    vlanCidrV4 String
    CIDR for VLAN IPv4
    vlanGatewayIpV4 String
    Gateway IP for VLAN IPv4
    vlanId Number
    VLAN ID for the network
    vlanPhysicalInterface String
    Physical interface for VLAN
    vpcNetworkId String

    Supporting Types

    VpcNetworkTimeouts, VpcNetworkTimeoutsArgs

    Create string
    Delete string
    Update string
    Create string
    Delete string
    Update string
    create String
    delete String
    update String
    create string
    delete string
    update string
    create str
    delete str
    update str
    create String
    delete String
    update String

    Package Details

    Repository
    Civo civo/terraform-provider-civo
    License
    Notes
    This Pulumi package is based on the civo Terraform Provider.
    civo logo
    Viewing docs for civo 1.2.3
    published on Thursday, Apr 9, 2026 by civo
    Schema (JSON)
    civo/terraform-provider-civo
      Try Pulumi Cloud free. Your team will thank you.