NetworkPolicy class

Represents a network policy resource. Network policies are regional resources.

To get more information about NetworkPolicy, see:

API documentation

Example Usage

Vmware Engine Network Policy Basic

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

const network_policy_nw = new gcp.vmwareengine.Network("network-policy-nw", {
    name: "sample-network",
    location: "global",
    type: "STANDARD",
    description: "VMwareEngine standard network sample",
});
const vmw_engine_network_policy = new gcp.vmwareengine.NetworkPolicy("vmw-engine-network-policy", {
    location: "us-west1",
    name: "sample-network-policy",
    edgeServicesCidr: "192.168.30.0/26",
    vmwareEngineNetwork: network_policy_nw.id,
});

import pulumi
import pulumi_gcp as gcp

network_policy_nw = gcp.vmwareengine.Network("network-policy-nw",
    name="sample-network",
    location="global",
    type="STANDARD",
    description="VMwareEngine standard network sample")
vmw_engine_network_policy = gcp.vmwareengine.NetworkPolicy("vmw-engine-network-policy",
    location="us-west1",
    name="sample-network-policy",
    edge_services_cidr="192.168.30.0/26",
    vmware_engine_network=network_policy_nw.id)

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

return await Deployment.RunAsync(() =>
{
    var network_policy_nw = new Gcp.VMwareEngine.Network("network-policy-nw", new()
    {
        Name = "sample-network",
        Location = "global",
        Type = "STANDARD",
        Description = "VMwareEngine standard network sample",
    });

    var vmw_engine_network_policy = new Gcp.VMwareEngine.NetworkPolicy("vmw-engine-network-policy", new()
    {
        Location = "us-west1",
        Name = "sample-network-policy",
        EdgeServicesCidr = "192.168.30.0/26",
        VmwareEngineNetwork = network_policy_nw.Id,
    });

});

package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		network_policy_nw, err := vmwareengine.NewNetwork(ctx, "network-policy-nw", &vmwareengine.NetworkArgs{
			Name:        pulumi.String("sample-network"),
			Location:    pulumi.String("global"),
			Type:        pulumi.String("STANDARD"),
			Description: pulumi.String("VMwareEngine standard network sample"),
		})
		if err != nil {
			return err
		}
		_, err = vmwareengine.NewNetworkPolicy(ctx, "vmw-engine-network-policy", &vmwareengine.NetworkPolicyArgs{
			Location:            pulumi.String("us-west1"),
			Name:                pulumi.String("sample-network-policy"),
			EdgeServicesCidr:    pulumi.String("192.168.30.0/26"),
			VmwareEngineNetwork: network_policy_nw.ID().ToIDOutput().ToStringOutput(),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

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

resource "gcp_vmwareengine_network" "network-policy-nw" {
  name        = "sample-network"
  location    = "global"
  type        = "STANDARD"
  description = "VMwareEngine standard network sample"
}
resource "gcp_vmwareengine_networkpolicy" "vmw-engine-network-policy" {
  location              = "us-west1"
  name                  = "sample-network-policy"
  edge_services_cidr    = "192.168.30.0/26"
  vmware_engine_network = gcp_vmwareengine_network.network-policy-nw.id
}

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.gcp.vmwareengine.Network;
import com.pulumi.gcp.vmwareengine.NetworkArgs;
import com.pulumi.gcp.vmwareengine.NetworkPolicy;
import com.pulumi.gcp.vmwareengine.NetworkPolicyArgs;
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 network_policy_nw = new Network("network-policy-nw", NetworkArgs.builder()
            .name("sample-network")
            .location("global")
            .type("STANDARD")
            .description("VMwareEngine standard network sample")
            .build());

        var vmw_engine_network_policy = new NetworkPolicy("vmw-engine-network-policy", NetworkPolicyArgs.builder()
            .location("us-west1")
            .name("sample-network-policy")
            .edgeServicesCidr("192.168.30.0/26")
            .vmwareEngineNetwork(network_policy_nw.id())
            .build());

    }
}

resources:
  network-policy-nw:
    type: gcp:vmwareengine:Network
    properties:
      name: sample-network
      location: global
      type: STANDARD
      description: VMwareEngine standard network sample
  vmw-engine-network-policy:
    type: gcp:vmwareengine:NetworkPolicy
    properties:
      location: us-west1
      name: sample-network-policy
      edgeServicesCidr: 192.168.30.0/26
      vmwareEngineNetwork: ${["network-policy-nw"].id}

Vmware Engine Network Policy Full

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

const network_policy_nw = new gcp.vmwareengine.Network("network-policy-nw", {
    name: "sample-network",
    location: "global",
    type: "STANDARD",
    description: "VMwareEngine standard network sample",
});
const vmw_engine_network_policy = new gcp.vmwareengine.NetworkPolicy("vmw-engine-network-policy", {
    location: "us-west1",
    name: "sample-network-policy",
    edgeServicesCidr: "192.168.30.0/26",
    vmwareEngineNetwork: network_policy_nw.id,
    description: "Sample Network Policy",
    internetAccess: {
        enabled: true,
    },
    externalIp: {
        enabled: true,
    },
});

import pulumi
import pulumi_gcp as gcp

network_policy_nw = gcp.vmwareengine.Network("network-policy-nw",
    name="sample-network",
    location="global",
    type="STANDARD",
    description="VMwareEngine standard network sample")
vmw_engine_network_policy = gcp.vmwareengine.NetworkPolicy("vmw-engine-network-policy",
    location="us-west1",
    name="sample-network-policy",
    edge_services_cidr="192.168.30.0/26",
    vmware_engine_network=network_policy_nw.id,
    description="Sample Network Policy",
    internet_access={
        "enabled": True,
    },
    external_ip={
        "enabled": True,
    })

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

return await Deployment.RunAsync(() =>
{
    var network_policy_nw = new Gcp.VMwareEngine.Network("network-policy-nw", new()
    {
        Name = "sample-network",
        Location = "global",
        Type = "STANDARD",
        Description = "VMwareEngine standard network sample",
    });

    var vmw_engine_network_policy = new Gcp.VMwareEngine.NetworkPolicy("vmw-engine-network-policy", new()
    {
        Location = "us-west1",
        Name = "sample-network-policy",
        EdgeServicesCidr = "192.168.30.0/26",
        VmwareEngineNetwork = network_policy_nw.Id,
        Description = "Sample Network Policy",
        InternetAccess = new Gcp.VMwareEngine.Inputs.NetworkPolicyInternetAccessArgs
        {
            Enabled = true,
        },
        ExternalIp = new Gcp.VMwareEngine.Inputs.NetworkPolicyExternalIpArgs
        {
            Enabled = true,
        },
    });

});

package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		network_policy_nw, err := vmwareengine.NewNetwork(ctx, "network-policy-nw", &vmwareengine.NetworkArgs{
			Name:        pulumi.String("sample-network"),
			Location:    pulumi.String("global"),
			Type:        pulumi.String("STANDARD"),
			Description: pulumi.String("VMwareEngine standard network sample"),
		})
		if err != nil {
			return err
		}
		_, err = vmwareengine.NewNetworkPolicy(ctx, "vmw-engine-network-policy", &vmwareengine.NetworkPolicyArgs{
			Location:            pulumi.String("us-west1"),
			Name:                pulumi.String("sample-network-policy"),
			EdgeServicesCidr:    pulumi.String("192.168.30.0/26"),
			VmwareEngineNetwork: network_policy_nw.ID().ToIDOutput().ToStringOutput(),
			Description:         pulumi.String("Sample Network Policy"),
			InternetAccess: &vmwareengine.NetworkPolicyInternetAccessArgs{
				Enabled: pulumi.Bool(true),
			},
			ExternalIp: &vmwareengine.NetworkPolicyExternalIpArgs{
				Enabled: pulumi.Bool(true),
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}

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

resource "gcp_vmwareengine_network" "network-policy-nw" {
  name        = "sample-network"
  location    = "global"
  type        = "STANDARD"
  description = "VMwareEngine standard network sample"
}
resource "gcp_vmwareengine_networkpolicy" "vmw-engine-network-policy" {
  location              = "us-west1"
  name                  = "sample-network-policy"
  edge_services_cidr    = "192.168.30.0/26"
  vmware_engine_network = gcp_vmwareengine_network.network-policy-nw.id
  description           = "Sample Network Policy"
  internet_access = {
    enabled = true
  }
  external_ip = {
    enabled = true
  }
}

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.gcp.vmwareengine.Network;
import com.pulumi.gcp.vmwareengine.NetworkArgs;
import com.pulumi.gcp.vmwareengine.NetworkPolicy;
import com.pulumi.gcp.vmwareengine.NetworkPolicyArgs;
import com.pulumi.gcp.vmwareengine.inputs.NetworkPolicyInternetAccessArgs;
import com.pulumi.gcp.vmwareengine.inputs.NetworkPolicyExternalIpArgs;
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 network_policy_nw = new Network("network-policy-nw", NetworkArgs.builder()
            .name("sample-network")
            .location("global")
            .type("STANDARD")
            .description("VMwareEngine standard network sample")
            .build());

        var vmw_engine_network_policy = new NetworkPolicy("vmw-engine-network-policy", NetworkPolicyArgs.builder()
            .location("us-west1")
            .name("sample-network-policy")
            .edgeServicesCidr("192.168.30.0/26")
            .vmwareEngineNetwork(network_policy_nw.id())
            .description("Sample Network Policy")
            .internetAccess(NetworkPolicyInternetAccessArgs.builder()
                .enabled(true)
                .build())
            .externalIp(NetworkPolicyExternalIpArgs.builder()
                .enabled(true)
                .build())
            .build());

    }
}

resources:
  network-policy-nw:
    type: gcp:vmwareengine:Network
    properties:
      name: sample-network
      location: global
      type: STANDARD
      description: VMwareEngine standard network sample
  vmw-engine-network-policy:
    type: gcp:vmwareengine:NetworkPolicy
    properties:
      location: us-west1
      name: sample-network-policy
      edgeServicesCidr: 192.168.30.0/26
      vmwareEngineNetwork: ${["network-policy-nw"].id}
      description: Sample Network Policy
      internetAccess:
        enabled: true
      externalIp:
        enabled: true

Import

NetworkPolicy can be imported using any of these accepted formats:

projects/{{project}}/locations/{{location}}/networkPolicies/{{name}}
{{project}}/{{location}}/{{name}}
{{location}}/{{name}}

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

$ pulumi import gcp:vmwareengine/networkPolicy:NetworkPolicy default projects/{{project}}/locations/{{location}}/networkPolicies/{{name}}
$ pulumi import gcp:vmwareengine/networkPolicy:NetworkPolicy default {{project}}/{{location}}/{{name}}
$ pulumi import gcp:vmwareengine/networkPolicy:NetworkPolicy default {{location}}/{{name}}

Constructors

NetworkPolicy(String name, {NetworkPolicyArgs? args, CustomResourceOptions? options}): Creates a new NetworkPolicy. name The Pulumi resource name. args Arguments used to configure this NetworkPolicy. The set of arguments for NetworkPolicy. options Resource options controlling this resource's behavior.
NetworkPolicy.reference(String urn): Creates a typed reference to an existing NetworkPolicy resource.

Properties

childResources → Set<Resource>: finalinherited
completionSources ↔ Map<String, IOutputCompletionSource>: latefinalinherited
createTime ↔ Output<String>: Creation time of this resource. 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".
latefinal
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.
latefinal
description ↔ Output<String?>: User-provided description for this network policy.
latefinal
edgeServicesCidr ↔ Output<String>: IP address range in CIDR notation used to create internet access and external IP access. An RFC 1918 CIDR block, with a "/26" prefix, is required. The range cannot overlap with any prefixes either in the consumer VPC network or in use by the private clouds attached to that VPC network.
latefinal
externalIp ↔ Output<NetworkPolicyExternalIp>: Network service that allows External IP addresses to be assigned to VMware workloads. This service can only be enabled when internetAccess is also enabled. Structure is documented below.
latefinal
hashCode → int: The hash code for this object.
no setterinherited
id ↔ Output<String>: getter/setter pairinherited
internetAccess ↔ Output<NetworkPolicyInternetAccess>: Network service that allows VMware workloads to access the internet. Structure is documented below.
latefinal
isCustom → bool: Returns whether this resource is provider-managed.
no setterinherited
isProtected → bool: Returns whether this resource is protected from deletion.
no setterinherited
isRemote → bool: Whether this resource is registered as remote.
no setterinherited
isResourceReference → bool: Whether this instance represents a resource value returned over RPC.
finalinherited
location ↔ Output<String>: The resource name of the location (region) to create the new network policy in. Resource names are schemeless URIs that follow the conventions in https://cloud.google.com/apis/design/resource_names. For example: projects/my-project/locations/us-central1
latefinal
name ↔ Output<String>: The ID of the Network Policy.
latefinal
project ↔ Output<String>: The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
latefinal
resourceTransforms → List<ResourceTransform>: Inherited/explicit async transforms.
no setterinherited
runtimeType → Type: A representation of the runtime type of the object.
no setterinherited
transformations → List<ResourceTransformation>: Inherited/explicit legacy transformations.
no setterinherited
uid ↔ Output<String>: System-generated unique identifier for the resource.
latefinal
updateTime ↔ Output<String>: Last updated time of this resource. 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".
latefinal
urn ↔ Output<String>: latefinalinherited
vmwareEngineNetwork ↔ Output<String>: The relative resource name of the VMware Engine network. Specify the name in the following form: projects/{project}/locations/{location}/vmwareEngineNetworks/{vmwareEngineNetworkId} where {project} can either be a project number or a project ID.
latefinal
vmwareEngineNetworkCanonical ↔ Output<String>: The canonical name of the VMware Engine network in the form: projects/{project_number}/locations/{location}/vmwareEngineNetworks/{vmwareEngineNetworkId}
latefinal

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, {NetworkPolicyState? state, CustomResourceOptions? options}) → NetworkPolicy: Gets an existing NetworkPolicy resource's state with the given name and id.