Network class

A Distributed Cloud Edge network, which provides L3 isolation within a zone.

To get more information about Network, see:

• API documentation
• How-to Guides
• Create and manage networks

Example Usage

Edgenetwork Network

import * as pulumi from "@pulumi/pulumi";
import * as gcp from "@pulumi/gcp";

const exampleNetwork = new gcp.edgenetwork.Network("example_network", {
    networkId: "example-network",
    location: "us-west1",
    zone: "",
    description: "Example network.",
    mtu: 9000,
    labels: {
        environment: "dev",
    },
});

import pulumi
import pulumi_gcp as gcp

example_network = gcp.edgenetwork.Network("example_network",
    network_id="example-network",
    location="us-west1",
    zone="",
    description="Example network.",
    mtu=9000,
    labels={
        "environment": "dev",
    })

using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Gcp = Pulumi.Gcp;

return await Deployment.RunAsync(() =>
{
    var exampleNetwork = new Gcp.EdgeNetwork.Network("example_network", new()
    {
        NetworkId = "example-network",
        Location = "us-west1",
        Zone = "",
        Description = "Example network.",
        Mtu = 9000,
        Labels =
        {
            { "environment", "dev" },
        },
    });

});

package main

import (
	"github.com/pulumi/pulumi-gcp/sdk/v9/go/gcp/edgenetwork"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := edgenetwork.NewNetwork(ctx, "example_network", &edgenetwork.NetworkArgs{
			NetworkId:   pulumi.String("example-network"),
			Location:    pulumi.String("us-west1"),
			Zone:        pulumi.String(""),
			Description: pulumi.String("Example network."),
			Mtu:         pulumi.Int(9000),
			Labels: pulumi.StringMap{
				"environment": pulumi.String("dev"),
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}

pulumi {
  required_providers {
    gcp = {
      source = "pulumi/gcp"
    }
  }
}

resource "gcp_edgenetwork_network" "example_network" {
  network_id  = "example-network"
  location    = "us-west1"
  zone        = ""
  description = "Example network."
  mtu         = 9000
  labels = {
    "environment" = "dev"
  }
}

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.gcp.edgenetwork.Network;
import com.pulumi.gcp.edgenetwork.NetworkArgs;
import java.util.ArrayList;
import java.util.Arrays;
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 exampleNetwork = new Network("exampleNetwork", NetworkArgs.builder()
            .networkId("example-network")
            .location("us-west1")
            .zone("")
            .description("Example network.")
            .mtu(9000)
            .labels(Map.of("environment", "dev"))
            .build());

    }
}

resources:
  exampleNetwork:
    type: gcp:edgenetwork:Network
    name: example_network
    properties:
      networkId: example-network
      location: us-west1
      zone: ""
      description: Example network.
      mtu: 9000
      labels:
        environment: dev

Import

Network can be imported using any of these accepted formats:

• projects/{{project}}/locations/{{location}}/zones/{{zone}}/networks/{{network_id}}
• {{project}}/{{location}}/{{zone}}/{{network_id}}
• {{location}}/{{zone}}/{{network_id}}
• {{location}}/{{network_id}}
• {{name}}

When using the pulumi import command, Network can be imported using one of the formats above. For example:

$ pulumi import gcp:edgenetwork/network:Network default projects/{{project}}/locations/{{location}}/zones/{{zone}}/networks/{{network_id}}
$ pulumi import gcp:edgenetwork/network:Network default {{project}}/{{location}}/{{zone}}/{{network_id}}
$ pulumi import gcp:edgenetwork/network:Network default {{location}}/{{zone}}/{{network_id}}
$ pulumi import gcp:edgenetwork/network:Network default {{location}}/{{network_id}}
$ pulumi import gcp:edgenetwork/network:Network default {{name}}

Constructors

Network(String name, {NetworkArgs? args, CustomResourceOptions? options})

Creates a new Network. name The Pulumi resource name. args Arguments used to configure this Network. The set of arguments for Network. options Resource options controlling this resource's behavior.

Network.reference(String urn)

Creates a typed reference to an existing Network resource.

Properties

childResources → Set<Resource>

final, inherited

completionSources ↔ Map<String, IOutputCompletionSource>

late, final, inherited

createTime ↔ Output<String>

The time when the subnet was created. A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: 2014-10-02T15:01:23Z and 2014-10-02T15:01:23.045123456Z.

late, final

deletionPolicy ↔ Output<String>

Whether Terraform will be prevented from destroying the resource. Defaults to DELETE. When a 'terraform destroy' or 'pulumi up' would delete the resource, the command will fail if this field is set to "PREVENT" in Terraform state. When set to "ABANDON", the command will remove the resource from Terraform management without updating or deleting the resource in the API. When set to "DELETE", deleting the resource is allowed.

late, final

description ↔ Output<String?>

A free-text description of the resource. Max length 1024 characters.

late, final

effectiveLabels ↔ Output<Map<String, String>>

All of labels (key/value pairs) present on the resource in GCP, including the labels configured through Pulumi, other clients and services.

late, final

hashCode → int

The hash code for this object.

no setter, inherited

id ↔ Output<String>

getter/setter pair, inherited

isCustom → bool

Returns whether this resource is provider-managed.

no setter, inherited

isProtected → bool

Returns whether this resource is protected from deletion.

no setter, inherited

isRemote → bool

Whether this resource is registered as remote.

no setter, inherited

isResourceReference → bool

Whether this instance represents a resource value returned over RPC.

final, inherited

labels ↔ Output<Map<String, String>?>

Labels associated with this resource.

late, final

location ↔ Output<String>

The Google Cloud region to which the target Distributed Cloud Edge zone belongs.

late, final

mtu ↔ Output<int?>

IP (L3) MTU value of the network. Default value is 1500. Possible values are: 1500, 9000.

late, final

name ↔ Output<String>

The canonical name of this resource, with format projects/{{project}}/locations/{{location}}/zones/{{zone}}/networks/{{network_id}}

late, final

networkId ↔ Output<String>

A unique ID that identifies this network.

late, final

project ↔ Output<String>

The ID of the project in which the resource belongs. If it is not provided, the provider project is used.

late, final

pulumiLabels ↔ Output<Map<String, String>>

The combination of labels configured directly on the resource and default labels configured on the provider.

late, final

resourceTransforms → List<ResourceTransform>

Inherited/explicit async transforms.

no setter, inherited

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

transformations → List<ResourceTransformation>

Inherited/explicit legacy transformations.

no setter, inherited

updateTime ↔ Output<String>

The time when the subnet was last updated. A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: 2014-10-02T15:01:23Z and 2014-10-02T15:01:23.045123456Z.

late, final

urn ↔ Output<String>

late, final, inherited

zone ↔ Output<String>

The name of the target Distributed Cloud Edge zone.

late, final

Methods

failId(Object error) → void

Completes this resource ID with an error when registration fails.

inherited

failOutputs(Object error) → void

Completes all output properties with error.

inherited

failUrn(Object error) → void

Completes this resource URN with an error when registration fails.

inherited

getProvider(String moduleMember) → ProviderResource?

Returns provider for moduleMember's package, if configured.

inherited

getResourceName() → String

Returns this resource's logical name.

inherited

getResourceType() → String

Returns this resource's Pulumi type token.

inherited

noSuchMethod(Invocation invocation) → dynamic

Invoked when a nonexistent method or property is accessed.

inherited

registerOutput<T>(String propertyName, {Object? decoder(Object?)?, bool isSecret = false}) → Output<T>

Registers a dynamic output property for this resource.

inherited

resolveId(String? value, {required bool isKnown}) → void

Resolves the provider-assigned ID for this resource.

inherited

resolveOutputs(Struct outputs) → void

Resolves all output properties from a monitor response payload.

inherited

resolveUrn(String value) → void

Resolves this resource's URN once assigned by the engine.

inherited

serializeProperties(Map<String, dynamic> properties) → Future<Struct>

Serializes resource properties for RPC transmission.

inherited

toString() → String

A string representation of this object.

inherited

Operators

operator ==(Object other) → bool

The equality operator.

inherited

Static Methods

get(String name, Input<String> id, {NetworkState? state, CustomResourceOptions? options}) → Network

Gets an existing Network resource's state with the given name and id.