GlobalNetworkEndpoint class

A Global Network endpoint represents a IP address and port combination that exists outside of GCP. NOTE: Global network endpoints cannot be created outside of a global network endpoint group.

To get more information about GlobalNetworkEndpoint, see:

• API documentation
• How-to Guides
• Official Documentation

Example Usage

Global Network Endpoint

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",
});
const default_endpoint = new gcp.compute.GlobalNetworkEndpoint("default-endpoint", {
    globalNetworkEndpointGroup: neg.name,
    fqdn: "www.example.com",
    port: 90,
});

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")
default_endpoint = gcp.compute.GlobalNetworkEndpoint("default-endpoint",
    global_network_endpoint_group=neg.name,
    fqdn="www.example.com",
    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",
        DefaultPort = 90,
        NetworkEndpointType = "INTERNET_FQDN_PORT",
    });

    var default_endpoint = new Gcp.Compute.GlobalNetworkEndpoint("default-endpoint", new()
    {
        GlobalNetworkEndpointGroup = neg.Name,
        Fqdn = "www.example.com",
        Port = 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 {
		neg, 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
		}
		_, err = compute.NewGlobalNetworkEndpoint(ctx, "default-endpoint", &compute.GlobalNetworkEndpointArgs{
			GlobalNetworkEndpointGroup: neg.Name,
			Fqdn:                       pulumi.String("www.example.com"),
			Port:                       pulumi.Int(90),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

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

resource "gcp_compute_globalnetworkendpoint" "default-endpoint" {
  global_network_endpoint_group = gcp_compute_globalnetworkendpointgroup.neg.name
  fqdn                          = "www.example.com"
  port                          = 90
}
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 com.pulumi.gcp.compute.GlobalNetworkEndpoint;
import com.pulumi.gcp.compute.GlobalNetworkEndpointArgs;
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());

        var default_endpoint = new GlobalNetworkEndpoint("default-endpoint", GlobalNetworkEndpointArgs.builder()
            .globalNetworkEndpointGroup(neg.name())
            .fqdn("www.example.com")
            .port(90)
            .build());

    }
}

resources:
  default-endpoint:
    type: gcp:compute:GlobalNetworkEndpoint
    properties:
      globalNetworkEndpointGroup: ${neg.name}
      fqdn: www.example.com
      port: 90
  neg:
    type: gcp:compute:GlobalNetworkEndpointGroup
    properties:
      name: my-lb-neg
      defaultPort: '90'
      networkEndpointType: INTERNET_FQDN_PORT

Import

GlobalNetworkEndpoint can be imported using any of these accepted formats:

• projects/{{project}}/global/networkEndpointGroups/{{global_network_endpoint_group}}/{{ip_address}}/{{fqdn}}/{{port}}
• {{project}}/{{global_network_endpoint_group}}/{{ip_address}}/{{fqdn}}/{{port}}
• {{global_network_endpoint_group}}/{{ip_address}}/{{fqdn}}/{{port}}

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

$ pulumi import gcp:compute/globalNetworkEndpoint:GlobalNetworkEndpoint default projects/{{project}}/global/networkEndpointGroups/{{global_network_endpoint_group}}/{{ip_address}}/{{fqdn}}/{{port}}
$ pulumi import gcp:compute/globalNetworkEndpoint:GlobalNetworkEndpoint default {{project}}/{{global_network_endpoint_group}}/{{ip_address}}/{{fqdn}}/{{port}}
$ pulumi import gcp:compute/globalNetworkEndpoint:GlobalNetworkEndpoint default {{global_network_endpoint_group}}/{{ip_address}}/{{fqdn}}/{{port}}

Constructors

GlobalNetworkEndpoint(String name, {GlobalNetworkEndpointArgs? args, CustomResourceOptions? options})

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

GlobalNetworkEndpoint.reference(String urn)

Creates a typed reference to an existing GlobalNetworkEndpoint resource.

Properties

childResources → Set<Resource>

final, inherited

completionSources ↔ Map<String, IOutputCompletionSource>

late, final, inherited

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

fqdn ↔ Output<String?>

Fully qualified domain name of network endpoint. This can only be specified when networkEndpointType of the NEG is INTERNET_FQDN_PORT.

late, final

globalNetworkEndpointGroup ↔ Output<String>

The global network endpoint group this endpoint is part of.

late, final

hashCode → int

The hash code for this object.

no setter, inherited

id ↔ Output<String>

getter/setter pair, inherited

ipAddress ↔ Output<String?>

IPv4 address external endpoint.

late, final

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

port ↔ Output<int>

Port number of the external endpoint.

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

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

urn ↔ Output<String>

late, final, inherited

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, {GlobalNetworkEndpointState? state, CustomResourceOptions? options}) → GlobalNetworkEndpoint

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