1. Packages
  2. Gcore Provider
  3. API Docs
  4. Network
gcore 0.22.0 published on Wednesday, Apr 30, 2025 by g-core

gcore.Network

Explore with Pulumi AI

gcore logo
gcore 0.22.0 published on Wednesday, Apr 30, 2025 by g-core

    Represent network. A network is a software-defined network in a cloud computing infrastructure

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as gcore from "@pulumi/gcore";
    
    const network = new gcore.Network("network", {
        projectId: 1,
        regionId: 1,
        type: "vxlan",
    });
    
    import pulumi
    import pulumi_gcore as gcore
    
    network = gcore.Network("network",
        project_id=1,
        region_id=1,
        type="vxlan")
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-terraform-provider/sdks/go/gcore/gcore"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		_, err := gcore.NewNetwork(ctx, "network", &gcore.NetworkArgs{
    			ProjectId: pulumi.Float64(1),
    			RegionId:  pulumi.Float64(1),
    			Type:      pulumi.String("vxlan"),
    		})
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Gcore = Pulumi.Gcore;
    
    return await Deployment.RunAsync(() => 
    {
        var network = new Gcore.Network("network", new()
        {
            ProjectId = 1,
            RegionId = 1,
            Type = "vxlan",
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.gcore.Network;
    import com.pulumi.gcore.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 network = new Network("network", NetworkArgs.builder()
                .projectId(1)
                .regionId(1)
                .type("vxlan")
                .build());
    
        }
    }
    
    resources:
      network:
        type: gcore:Network
        properties:
          projectId: 1
          regionId: 1
          type: vxlan
    

    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: Optional[NetworkArgs] = None,
                opts: Optional[ResourceOptions] = None)
    
    @overload
    def Network(resource_name: str,
                opts: Optional[ResourceOptions] = None,
                create_router: Optional[bool] = None,
                metadata_map: Optional[Mapping[str, str]] = None,
                name: Optional[str] = None,
                network_id: Optional[str] = None,
                project_id: Optional[float] = None,
                project_name: Optional[str] = None,
                region_id: Optional[float] = None,
                region_name: Optional[str] = None,
                type: Optional[str] = None)
    func NewNetwork(ctx *Context, name string, args *NetworkArgs, opts ...ResourceOption) (*Network, error)
    public Network(string name, NetworkArgs? args = null, CustomResourceOptions? opts = null)
    public Network(String name, NetworkArgs args)
    public Network(String name, NetworkArgs args, CustomResourceOptions options)
    
    type: gcore: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 Gcore.Network("networkResource", new()
    {
        CreateRouter = false,
        MetadataMap = 
        {
            { "string", "string" },
        },
        Name = "string",
        NetworkId = "string",
        ProjectId = 0,
        ProjectName = "string",
        RegionId = 0,
        RegionName = "string",
        Type = "string",
    });
    
    example, err := gcore.NewNetwork(ctx, "networkResource", &gcore.NetworkArgs{
    	CreateRouter: pulumi.Bool(false),
    	MetadataMap: pulumi.StringMap{
    		"string": pulumi.String("string"),
    	},
    	Name:        pulumi.String("string"),
    	NetworkId:   pulumi.String("string"),
    	ProjectId:   pulumi.Float64(0),
    	ProjectName: pulumi.String("string"),
    	RegionId:    pulumi.Float64(0),
    	RegionName:  pulumi.String("string"),
    	Type:        pulumi.String("string"),
    })
    
    var networkResource = new Network("networkResource", NetworkArgs.builder()
        .createRouter(false)
        .metadataMap(Map.of("string", "string"))
        .name("string")
        .networkId("string")
        .projectId(0)
        .projectName("string")
        .regionId(0)
        .regionName("string")
        .type("string")
        .build());
    
    network_resource = gcore.Network("networkResource",
        create_router=False,
        metadata_map={
            "string": "string",
        },
        name="string",
        network_id="string",
        project_id=0,
        project_name="string",
        region_id=0,
        region_name="string",
        type="string")
    
    const networkResource = new gcore.Network("networkResource", {
        createRouter: false,
        metadataMap: {
            string: "string",
        },
        name: "string",
        networkId: "string",
        projectId: 0,
        projectName: "string",
        regionId: 0,
        regionName: "string",
        type: "string",
    });
    
    type: gcore:Network
    properties:
        createRouter: false
        metadataMap:
            string: string
        name: string
        networkId: string
        projectId: 0
        projectName: string
        regionId: 0
        regionName: string
        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

    In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

    The Network resource accepts the following input properties:

    CreateRouter bool
    Create external router to the network, default true
    MetadataMap Dictionary<string, string>
    Name string
    NetworkId string
    The ID of this resource.
    ProjectId double
    ProjectName string
    RegionId double
    RegionName string
    Type string
    'vlan' or 'vxlan' network type is allowed. Default value is 'vxlan'
    CreateRouter bool
    Create external router to the network, default true
    MetadataMap map[string]string
    Name string
    NetworkId string
    The ID of this resource.
    ProjectId float64
    ProjectName string
    RegionId float64
    RegionName string
    Type string
    'vlan' or 'vxlan' network type is allowed. Default value is 'vxlan'
    createRouter Boolean
    Create external router to the network, default true
    metadataMap Map<String,String>
    name String
    networkId String
    The ID of this resource.
    projectId Double
    projectName String
    regionId Double
    regionName String
    type String
    'vlan' or 'vxlan' network type is allowed. Default value is 'vxlan'
    createRouter boolean
    Create external router to the network, default true
    metadataMap {[key: string]: string}
    name string
    networkId string
    The ID of this resource.
    projectId number
    projectName string
    regionId number
    regionName string
    type string
    'vlan' or 'vxlan' network type is allowed. Default value is 'vxlan'
    create_router bool
    Create external router to the network, default true
    metadata_map Mapping[str, str]
    name str
    network_id str
    The ID of this resource.
    project_id float
    project_name str
    region_id float
    region_name str
    type str
    'vlan' or 'vxlan' network type is allowed. Default value is 'vxlan'
    createRouter Boolean
    Create external router to the network, default true
    metadataMap Map<String>
    name String
    networkId String
    The ID of this resource.
    projectId Number
    projectName String
    regionId Number
    regionName String
    type String
    'vlan' or 'vxlan' network type is allowed. Default value is 'vxlan'

    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.
    LastUpdated string
    MetadataReadOnlies List<NetworkMetadataReadOnly>
    Mtu double
    Id string
    The provider-assigned unique ID for this managed resource.
    LastUpdated string
    MetadataReadOnlies []NetworkMetadataReadOnly
    Mtu float64
    id String
    The provider-assigned unique ID for this managed resource.
    lastUpdated String
    metadataReadOnlies List<NetworkMetadataReadOnly>
    mtu Double
    id string
    The provider-assigned unique ID for this managed resource.
    lastUpdated string
    metadataReadOnlies NetworkMetadataReadOnly[]
    mtu number
    id str
    The provider-assigned unique ID for this managed resource.
    last_updated str
    metadata_read_onlies Sequence[NetworkMetadataReadOnly]
    mtu float
    id String
    The provider-assigned unique ID for this managed resource.
    lastUpdated String
    metadataReadOnlies List<Property Map>
    mtu Number

    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,
            create_router: Optional[bool] = None,
            last_updated: Optional[str] = None,
            metadata_map: Optional[Mapping[str, str]] = None,
            metadata_read_onlies: Optional[Sequence[NetworkMetadataReadOnlyArgs]] = None,
            mtu: Optional[float] = None,
            name: Optional[str] = None,
            network_id: Optional[str] = None,
            project_id: Optional[float] = None,
            project_name: Optional[str] = None,
            region_id: Optional[float] = None,
            region_name: Optional[str] = None,
            type: 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)
    resources:  _:    type: gcore:Network    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:
    CreateRouter bool
    Create external router to the network, default true
    LastUpdated string
    MetadataMap Dictionary<string, string>
    MetadataReadOnlies List<NetworkMetadataReadOnly>
    Mtu double
    Name string
    NetworkId string
    The ID of this resource.
    ProjectId double
    ProjectName string
    RegionId double
    RegionName string
    Type string
    'vlan' or 'vxlan' network type is allowed. Default value is 'vxlan'
    CreateRouter bool
    Create external router to the network, default true
    LastUpdated string
    MetadataMap map[string]string
    MetadataReadOnlies []NetworkMetadataReadOnlyArgs
    Mtu float64
    Name string
    NetworkId string
    The ID of this resource.
    ProjectId float64
    ProjectName string
    RegionId float64
    RegionName string
    Type string
    'vlan' or 'vxlan' network type is allowed. Default value is 'vxlan'
    createRouter Boolean
    Create external router to the network, default true
    lastUpdated String
    metadataMap Map<String,String>
    metadataReadOnlies List<NetworkMetadataReadOnly>
    mtu Double
    name String
    networkId String
    The ID of this resource.
    projectId Double
    projectName String
    regionId Double
    regionName String
    type String
    'vlan' or 'vxlan' network type is allowed. Default value is 'vxlan'
    createRouter boolean
    Create external router to the network, default true
    lastUpdated string
    metadataMap {[key: string]: string}
    metadataReadOnlies NetworkMetadataReadOnly[]
    mtu number
    name string
    networkId string
    The ID of this resource.
    projectId number
    projectName string
    regionId number
    regionName string
    type string
    'vlan' or 'vxlan' network type is allowed. Default value is 'vxlan'
    create_router bool
    Create external router to the network, default true
    last_updated str
    metadata_map Mapping[str, str]
    metadata_read_onlies Sequence[NetworkMetadataReadOnlyArgs]
    mtu float
    name str
    network_id str
    The ID of this resource.
    project_id float
    project_name str
    region_id float
    region_name str
    type str
    'vlan' or 'vxlan' network type is allowed. Default value is 'vxlan'
    createRouter Boolean
    Create external router to the network, default true
    lastUpdated String
    metadataMap Map<String>
    metadataReadOnlies List<Property Map>
    mtu Number
    name String
    networkId String
    The ID of this resource.
    projectId Number
    projectName String
    regionId Number
    regionName String
    type String
    'vlan' or 'vxlan' network type is allowed. Default value is 'vxlan'

    Supporting Types

    NetworkMetadataReadOnly, NetworkMetadataReadOnlyArgs

    Key string
    ReadOnly bool
    Value string
    Key string
    ReadOnly bool
    Value string
    key String
    readOnly Boolean
    value String
    key string
    readOnly boolean
    value string
    key str
    read_only bool
    value str
    key String
    readOnly Boolean
    value String

    Import

    import using <project_id>:<region_id>:<network_id> format

    $ pulumi import gcore:index/network:Network metwork1 1:6:447d2959-8ae0-4ca0-8d47-9f050a3637d7
    

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

    Package Details

    Repository
    gcore g-core/terraform-provider-gcore
    License
    Notes
    This Pulumi package is based on the gcore Terraform Provider.
    gcore logo
    gcore 0.22.0 published on Wednesday, Apr 30, 2025 by g-core