GlobalNetworkEndpointGroup class

A global network endpoint group contains endpoints that reside outside of Google Cloud. Currently a global network endpoint group can only support a single endpoint.

Recreating a global network endpoint group that's in use by another resource will give a resourceInUseByAnotherResource error. Use lifecycle.create_before_destroy to avoid this type of error.

To get more information about GlobalNetworkEndpointGroup, see:

Example Usage

Global Network Endpoint Group

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

const neg = new gcp.compute.GlobalNetworkEndpointGroup("neg", {
    name: "my-lb-neg",
    defaultPort: 90,
    networkEndpointType: "INTERNET_FQDN_PORT",
});

import pulumi
import pulumi_gcp as gcp

neg = gcp.compute.GlobalNetworkEndpointGroup("neg",
    name="my-lb-neg",
    default_port=90,
    network_endpoint_type="INTERNET_FQDN_PORT")

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

return await Deployment.RunAsync(() =>
{
    var neg = new Gcp.Compute.GlobalNetworkEndpointGroup("neg", new()
    {
        Name = "my-lb-neg",
        DefaultPort = 90,
        NetworkEndpointType = "INTERNET_FQDN_PORT",
    });

});

package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := compute.NewGlobalNetworkEndpointGroup(ctx, "neg", &compute.GlobalNetworkEndpointGroupArgs{
			Name:                pulumi.String("my-lb-neg"),
			DefaultPort:         pulumi.Int(90),
			NetworkEndpointType: pulumi.String("INTERNET_FQDN_PORT"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

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

resource "gcp_compute_globalnetworkendpointgroup" "neg" {
  name                  = "my-lb-neg"
  default_port          = "90"
  network_endpoint_type = "INTERNET_FQDN_PORT"
}

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.gcp.compute.GlobalNetworkEndpointGroup;
import com.pulumi.gcp.compute.GlobalNetworkEndpointGroupArgs;
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 neg = new GlobalNetworkEndpointGroup("neg", GlobalNetworkEndpointGroupArgs.builder()
            .name("my-lb-neg")
            .defaultPort(90)
            .networkEndpointType("INTERNET_FQDN_PORT")
            .build());

    }
}

resources:
  neg:
    type: gcp:compute:GlobalNetworkEndpointGroup
    properties:
      name: my-lb-neg
      defaultPort: '90'
      networkEndpointType: INTERNET_FQDN_PORT

Global Network Endpoint Group Ip Address

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

const neg = new gcp.compute.GlobalNetworkEndpointGroup("neg", {
    name: "my-lb-neg",
    networkEndpointType: "INTERNET_IP_PORT",
    defaultPort: 90,
});

import pulumi
import pulumi_gcp as gcp

neg = gcp.compute.GlobalNetworkEndpointGroup("neg",
    name="my-lb-neg",
    network_endpoint_type="INTERNET_IP_PORT",
    default_port=90)

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

return await Deployment.RunAsync(() =>
{
    var neg = new Gcp.Compute.GlobalNetworkEndpointGroup("neg", new()
    {
        Name = "my-lb-neg",
        NetworkEndpointType = "INTERNET_IP_PORT",
        DefaultPort = 90,
    });

});

package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := compute.NewGlobalNetworkEndpointGroup(ctx, "neg", &compute.GlobalNetworkEndpointGroupArgs{
			Name:                pulumi.String("my-lb-neg"),
			NetworkEndpointType: pulumi.String("INTERNET_IP_PORT"),
			DefaultPort:         pulumi.Int(90),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

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

resource "gcp_compute_globalnetworkendpointgroup" "neg" {
  name                  = "my-lb-neg"
  network_endpoint_type = "INTERNET_IP_PORT"
  default_port          = 90
}

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.gcp.compute.GlobalNetworkEndpointGroup;
import com.pulumi.gcp.compute.GlobalNetworkEndpointGroupArgs;
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 neg = new GlobalNetworkEndpointGroup("neg", GlobalNetworkEndpointGroupArgs.builder()
            .name("my-lb-neg")
            .networkEndpointType("INTERNET_IP_PORT")
            .defaultPort(90)
            .build());

    }
}

resources:
  neg:
    type: gcp:compute:GlobalNetworkEndpointGroup
    properties:
      name: my-lb-neg
      networkEndpointType: INTERNET_IP_PORT
      defaultPort: 90

Import

GlobalNetworkEndpointGroup can be imported using any of these accepted formats:

  • projects/{{project}}/global/networkEndpointGroups/{{name}}
  • {{project}}/{{name}}
  • {{name}}

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

$ pulumi import gcp:compute/globalNetworkEndpointGroup:GlobalNetworkEndpointGroup default projects/{{project}}/global/networkEndpointGroups/{{name}}
$ pulumi import gcp:compute/globalNetworkEndpointGroup:GlobalNetworkEndpointGroup default {{project}}/{{name}}
$ pulumi import gcp:compute/globalNetworkEndpointGroup:GlobalNetworkEndpointGroup default {{name}}

Constructors

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

Properties

childResources → Set<Resource>
finalinherited
completionSources ↔ Map<String, IOutputCompletionSource>
latefinalinherited
defaultPort ↔ Output<int?>
The default port used if the port number is not specified in the network endpoint.
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?>
An optional description of this resource. Provide this property when you create the resource.
latefinal
hashCode → int
The hash code for this object.
no setterinherited
id ↔ Output<String>
getter/setter pairinherited
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
name ↔ Output<String>
Name of the resource; provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression a-z? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
latefinal
networkEndpointType ↔ Output<String>
Type of network endpoints in this network endpoint group. Possible values are: INTERNET_IP_PORT, INTERNET_FQDN_PORT.
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
The URI of the created resource.
latefinal
transformations → List<ResourceTransformation>
Inherited/explicit legacy transformations.
no setterinherited
urn ↔ Output<String>
latefinalinherited

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