Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. Google Cloud (GCP) Classic
  3. API Docs
  4. compute
  5. GlobalAddress
Google Cloud v8.21.0 published on Wednesday, Mar 5, 2025 by Pulumi
pulumi/pulumi-gcp

gcp.compute.GlobalAddress

Explore with Pulumi AI

gcp logo
Google Cloud v8.21.0 published on Wednesday, Mar 5, 2025 by Pulumi
pulumi/pulumi-gcp

    Represents a Global Address resource. Global addresses are used for HTTP(S) load balancing.

    To get more information about GlobalAddress, see:

    Example Usage

    Global Address Basic

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

const _default = new gcp.compute.GlobalAddress("default", {name: "global-appserver-ip"});

    import pulumi
import pulumi_gcp as gcp

default = gcp.compute.GlobalAddress("default", name="global-appserver-ip")

    package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := compute.NewGlobalAddress(ctx, "default", &compute.GlobalAddressArgs{
			Name: pulumi.String("global-appserver-ip"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

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

return await Deployment.RunAsync(() => 
{
    var @default = new Gcp.Compute.GlobalAddress("default", new()
    {
        Name = "global-appserver-ip",
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.gcp.compute.GlobalAddress;
import com.pulumi.gcp.compute.GlobalAddressArgs;
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 default_ = new GlobalAddress("default", GlobalAddressArgs.builder()
            .name("global-appserver-ip")
            .build());

    }
}

    resources:
  default:
    type: gcp:compute:GlobalAddress
    properties:
      name: global-appserver-ip

    Global Address Private Services Connect

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

const network = new gcp.compute.Network("network", {
    name: "my-network-name",
    autoCreateSubnetworks: false,
});
const _default = new gcp.compute.GlobalAddress("default", {
    name: "global-psconnect-ip",
    addressType: "INTERNAL",
    purpose: "PRIVATE_SERVICE_CONNECT",
    network: network.id,
    address: "100.100.100.105",
});

    import pulumi
import pulumi_gcp as gcp

network = gcp.compute.Network("network",
    name="my-network-name",
    auto_create_subnetworks=False)
default = gcp.compute.GlobalAddress("default",
    name="global-psconnect-ip",
    address_type="INTERNAL",
    purpose="PRIVATE_SERVICE_CONNECT",
    network=network.id,
    address="100.100.100.105")

    package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		network, err := compute.NewNetwork(ctx, "network", &compute.NetworkArgs{
			Name:                  pulumi.String("my-network-name"),
			AutoCreateSubnetworks: pulumi.Bool(false),
		})
		if err != nil {
			return err
		}
		_, err = compute.NewGlobalAddress(ctx, "default", &compute.GlobalAddressArgs{
			Name:        pulumi.String("global-psconnect-ip"),
			AddressType: pulumi.String("INTERNAL"),
			Purpose:     pulumi.String("PRIVATE_SERVICE_CONNECT"),
			Network:     network.ID(),
			Address:     pulumi.String("100.100.100.105"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

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

return await Deployment.RunAsync(() => 
{
    var network = new Gcp.Compute.Network("network", new()
    {
        Name = "my-network-name",
        AutoCreateSubnetworks = false,
    });

    var @default = new Gcp.Compute.GlobalAddress("default", new()
    {
        Name = "global-psconnect-ip",
        AddressType = "INTERNAL",
        Purpose = "PRIVATE_SERVICE_CONNECT",
        Network = network.Id,
        Address = "100.100.100.105",
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.gcp.compute.Network;
import com.pulumi.gcp.compute.NetworkArgs;
import com.pulumi.gcp.compute.GlobalAddress;
import com.pulumi.gcp.compute.GlobalAddressArgs;
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()
            .name("my-network-name")
            .autoCreateSubnetworks(false)
            .build());

        var default_ = new GlobalAddress("default", GlobalAddressArgs.builder()
            .name("global-psconnect-ip")
            .addressType("INTERNAL")
            .purpose("PRIVATE_SERVICE_CONNECT")
            .network(network.id())
            .address("100.100.100.105")
            .build());

    }
}

    resources:
  default:
    type: gcp:compute:GlobalAddress
    properties:
      name: global-psconnect-ip
      addressType: INTERNAL
      purpose: PRIVATE_SERVICE_CONNECT
      network: ${network.id}
      address: 100.100.100.105
  network:
    type: gcp:compute:Network
    properties:
      name: my-network-name
      autoCreateSubnetworks: false

    Create GlobalAddress Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new GlobalAddress(name: string, args?: GlobalAddressArgs, opts?: CustomResourceOptions);
    @overload
def GlobalAddress(resource_name: str,
                  args: Optional[GlobalAddressArgs] = None,
                  opts: Optional[ResourceOptions] = None)

@overload
def GlobalAddress(resource_name: str,
                  opts: Optional[ResourceOptions] = None,
                  address: Optional[str] = None,
                  address_type: Optional[str] = None,
                  description: Optional[str] = None,
                  ip_version: Optional[str] = None,
                  labels: Optional[Mapping[str, str]] = None,
                  name: Optional[str] = None,
                  network: Optional[str] = None,
                  prefix_length: Optional[int] = None,
                  project: Optional[str] = None,
                  purpose: Optional[str] = None)
    func NewGlobalAddress(ctx *Context, name string, args *GlobalAddressArgs, opts ...ResourceOption) (*GlobalAddress, error)
    public GlobalAddress(string name, GlobalAddressArgs? args = null, CustomResourceOptions? opts = null)
    public GlobalAddress(String name, GlobalAddressArgs args)
public GlobalAddress(String name, GlobalAddressArgs args, CustomResourceOptions options)

    type: gcp:compute:GlobalAddress
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 GlobalAddressArgs
    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 GlobalAddressArgs
    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 GlobalAddressArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args GlobalAddressArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args GlobalAddressArgs
    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 globalAddressResource = new Gcp.Compute.GlobalAddress("globalAddressResource", new()
{
    Address = "string",
    AddressType = "string",
    Description = "string",
    IpVersion = "string",
    Labels = 
    {
        { "string", "string" },
    },
    Name = "string",
    Network = "string",
    PrefixLength = 0,
    Project = "string",
    Purpose = "string",
});

    example, err := compute.NewGlobalAddress(ctx, "globalAddressResource", &compute.GlobalAddressArgs{
	Address:     pulumi.String("string"),
	AddressType: pulumi.String("string"),
	Description: pulumi.String("string"),
	IpVersion:   pulumi.String("string"),
	Labels: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
	Name:         pulumi.String("string"),
	Network:      pulumi.String("string"),
	PrefixLength: pulumi.Int(0),
	Project:      pulumi.String("string"),
	Purpose:      pulumi.String("string"),
})

    var globalAddressResource = new GlobalAddress("globalAddressResource", GlobalAddressArgs.builder()
    .address("string")
    .addressType("string")
    .description("string")
    .ipVersion("string")
    .labels(Map.of("string", "string"))
    .name("string")
    .network("string")
    .prefixLength(0)
    .project("string")
    .purpose("string")
    .build());

    global_address_resource = gcp.compute.GlobalAddress("globalAddressResource",
    address="string",
    address_type="string",
    description="string",
    ip_version="string",
    labels={
        "string": "string",
    },
    name="string",
    network="string",
    prefix_length=0,
    project="string",
    purpose="string")

    const globalAddressResource = new gcp.compute.GlobalAddress("globalAddressResource", {
    address: "string",
    addressType: "string",
    description: "string",
    ipVersion: "string",
    labels: {
        string: "string",
    },
    name: "string",
    network: "string",
    prefixLength: 0,
    project: "string",
    purpose: "string",
});

    type: gcp:compute:GlobalAddress
properties:
    address: string
    addressType: string
    description: string
    ipVersion: string
    labels:
        string: string
    name: string
    network: string
    prefixLength: 0
    project: string
    purpose: string

    GlobalAddress 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 GlobalAddress resource accepts the following input properties:

    Address string
    The IP address or beginning of the address range represented by this resource. This can be supplied as an input to reserve a specific address or omitted to allow GCP to choose a valid one for you.
    AddressType string
    The type of the address to reserve.

    • EXTERNAL indicates public/external single IP address.
    • INTERNAL indicates internal IP ranges belonging to some network. Default value is EXTERNAL. Possible values are: EXTERNAL, INTERNAL.
    Description string
    An optional description of this resource.
    IpVersion string
    The IP Version that will be used by this address. The default value is IPV4. Possible values are: IPV4, IPV6.
    Labels Dictionary<string, string>

    Labels to apply to this address. A list of key->value pairs.

    Note: This field is non-authoritative, and will only manage the labels present in your configuration. Please refer to the field effective_labels for all of the labels present on the resource.

    Name 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.

    Network string
    The URL of the network in which to reserve the IP range. The IP range must be in RFC1918 space. The network cannot be deleted if there are any reserved IP ranges referring to it. This should only be set when using an Internal address.
    PrefixLength int
    The prefix length of the IP range. If not present, it means the address field is a single IP address. This field is not applicable to addresses with addressType=INTERNAL when purpose=PRIVATE_SERVICE_CONNECT
    Project string
    The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
    Purpose string
    The purpose of the resource. Possible values include:

    • VPC_PEERING - for peer networks
    • PRIVATE_SERVICE_CONNECT - for Private Service Connect networks
    Address string
    The IP address or beginning of the address range represented by this resource. This can be supplied as an input to reserve a specific address or omitted to allow GCP to choose a valid one for you.
    AddressType string
    The type of the address to reserve.

    • EXTERNAL indicates public/external single IP address.
    • INTERNAL indicates internal IP ranges belonging to some network. Default value is EXTERNAL. Possible values are: EXTERNAL, INTERNAL.
    Description string
    An optional description of this resource.
    IpVersion string
    The IP Version that will be used by this address. The default value is IPV4. Possible values are: IPV4, IPV6.
    Labels map[string]string

    Labels to apply to this address. A list of key->value pairs.

    Note: This field is non-authoritative, and will only manage the labels present in your configuration. Please refer to the field effective_labels for all of the labels present on the resource.

    Name 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.

    Network string
    The URL of the network in which to reserve the IP range. The IP range must be in RFC1918 space. The network cannot be deleted if there are any reserved IP ranges referring to it. This should only be set when using an Internal address.
    PrefixLength int
    The prefix length of the IP range. If not present, it means the address field is a single IP address. This field is not applicable to addresses with addressType=INTERNAL when purpose=PRIVATE_SERVICE_CONNECT
    Project string
    The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
    Purpose string
    The purpose of the resource. Possible values include:

    • VPC_PEERING - for peer networks
    • PRIVATE_SERVICE_CONNECT - for Private Service Connect networks
    address String
    The IP address or beginning of the address range represented by this resource. This can be supplied as an input to reserve a specific address or omitted to allow GCP to choose a valid one for you.
    addressType String
    The type of the address to reserve.

    • EXTERNAL indicates public/external single IP address.
    • INTERNAL indicates internal IP ranges belonging to some network. Default value is EXTERNAL. Possible values are: EXTERNAL, INTERNAL.
    description String
    An optional description of this resource.
    ipVersion String
    The IP Version that will be used by this address. The default value is IPV4. Possible values are: IPV4, IPV6.
    labels Map<String,String>

    Labels to apply to this address. A list of key->value pairs.

    Note: This field is non-authoritative, and will only manage the labels present in your configuration. Please refer to the field effective_labels for all of the labels present on the resource.

    name 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.

    network String
    The URL of the network in which to reserve the IP range. The IP range must be in RFC1918 space. The network cannot be deleted if there are any reserved IP ranges referring to it. This should only be set when using an Internal address.
    prefixLength Integer
    The prefix length of the IP range. If not present, it means the address field is a single IP address. This field is not applicable to addresses with addressType=INTERNAL when purpose=PRIVATE_SERVICE_CONNECT
    project String
    The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
    purpose String
    The purpose of the resource. Possible values include:

    • VPC_PEERING - for peer networks
    • PRIVATE_SERVICE_CONNECT - for Private Service Connect networks
    address string
    The IP address or beginning of the address range represented by this resource. This can be supplied as an input to reserve a specific address or omitted to allow GCP to choose a valid one for you.
    addressType string
    The type of the address to reserve.

    • EXTERNAL indicates public/external single IP address.
    • INTERNAL indicates internal IP ranges belonging to some network. Default value is EXTERNAL. Possible values are: EXTERNAL, INTERNAL.
    description string
    An optional description of this resource.
    ipVersion string
    The IP Version that will be used by this address. The default value is IPV4. Possible values are: IPV4, IPV6.
    labels {[key: string]: string}

    Labels to apply to this address. A list of key->value pairs.

    Note: This field is non-authoritative, and will only manage the labels present in your configuration. Please refer to the field effective_labels for all of the labels present on the resource.

    name 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.

    network string
    The URL of the network in which to reserve the IP range. The IP range must be in RFC1918 space. The network cannot be deleted if there are any reserved IP ranges referring to it. This should only be set when using an Internal address.
    prefixLength number
    The prefix length of the IP range. If not present, it means the address field is a single IP address. This field is not applicable to addresses with addressType=INTERNAL when purpose=PRIVATE_SERVICE_CONNECT
    project string
    The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
    purpose string
    The purpose of the resource. Possible values include:

    • VPC_PEERING - for peer networks
    • PRIVATE_SERVICE_CONNECT - for Private Service Connect networks
    address str
    The IP address or beginning of the address range represented by this resource. This can be supplied as an input to reserve a specific address or omitted to allow GCP to choose a valid one for you.
    address_type str
    The type of the address to reserve.

    • EXTERNAL indicates public/external single IP address.
    • INTERNAL indicates internal IP ranges belonging to some network. Default value is EXTERNAL. Possible values are: EXTERNAL, INTERNAL.
    description str
    An optional description of this resource.
    ip_version str
    The IP Version that will be used by this address. The default value is IPV4. Possible values are: IPV4, IPV6.
    labels Mapping[str, str]

    Labels to apply to this address. A list of key->value pairs.

    Note: This field is non-authoritative, and will only manage the labels present in your configuration. Please refer to the field effective_labels for all of the labels present on the resource.

    name str
    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.

    network str
    The URL of the network in which to reserve the IP range. The IP range must be in RFC1918 space. The network cannot be deleted if there are any reserved IP ranges referring to it. This should only be set when using an Internal address.
    prefix_length int
    The prefix length of the IP range. If not present, it means the address field is a single IP address. This field is not applicable to addresses with addressType=INTERNAL when purpose=PRIVATE_SERVICE_CONNECT
    project str
    The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
    purpose str
    The purpose of the resource. Possible values include:

    • VPC_PEERING - for peer networks
    • PRIVATE_SERVICE_CONNECT - for Private Service Connect networks
    address String
    The IP address or beginning of the address range represented by this resource. This can be supplied as an input to reserve a specific address or omitted to allow GCP to choose a valid one for you.
    addressType String
    The type of the address to reserve.

    • EXTERNAL indicates public/external single IP address.
    • INTERNAL indicates internal IP ranges belonging to some network. Default value is EXTERNAL. Possible values are: EXTERNAL, INTERNAL.
    description String
    An optional description of this resource.
    ipVersion String
    The IP Version that will be used by this address. The default value is IPV4. Possible values are: IPV4, IPV6.
    labels Map<String>

    Labels to apply to this address. A list of key->value pairs.

    Note: This field is non-authoritative, and will only manage the labels present in your configuration. Please refer to the field effective_labels for all of the labels present on the resource.

    name 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.

    network String
    The URL of the network in which to reserve the IP range. The IP range must be in RFC1918 space. The network cannot be deleted if there are any reserved IP ranges referring to it. This should only be set when using an Internal address.
    prefixLength Number
    The prefix length of the IP range. If not present, it means the address field is a single IP address. This field is not applicable to addresses with addressType=INTERNAL when purpose=PRIVATE_SERVICE_CONNECT
    project String
    The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
    purpose String
    The purpose of the resource. Possible values include:

    • VPC_PEERING - for peer networks
    • PRIVATE_SERVICE_CONNECT - for Private Service Connect networks

    Outputs

    All input properties are implicitly available as output properties. Additionally, the GlobalAddress resource produces the following output properties:

    CreationTimestamp string
    Creation timestamp in RFC3339 text format.
    EffectiveLabels Dictionary<string, string>
    All of labels (key/value pairs) present on the resource in GCP, including the labels configured through Pulumi, other clients and services.
    Id string
    The provider-assigned unique ID for this managed resource.
    LabelFingerprint string
    The fingerprint used for optimistic locking of this resource. Used internally during updates.
    PulumiLabels Dictionary<string, string>
    The combination of labels configured directly on the resource and default labels configured on the provider.
    SelfLink string
    The URI of the created resource.
    CreationTimestamp string
    Creation timestamp in RFC3339 text format.
    EffectiveLabels 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.
    Id string
    The provider-assigned unique ID for this managed resource.
    LabelFingerprint string
    The fingerprint used for optimistic locking of this resource. Used internally during updates.
    PulumiLabels map[string]string
    The combination of labels configured directly on the resource and default labels configured on the provider.
    SelfLink string
    The URI of the created resource.
    creationTimestamp String
    Creation timestamp in RFC3339 text format.
    effectiveLabels 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.
    id String
    The provider-assigned unique ID for this managed resource.
    labelFingerprint String
    The fingerprint used for optimistic locking of this resource. Used internally during updates.
    pulumiLabels Map<String,String>
    The combination of labels configured directly on the resource and default labels configured on the provider.
    selfLink String
    The URI of the created resource.
    creationTimestamp string
    Creation timestamp in RFC3339 text format.
    effectiveLabels {[key: string]: string}
    All of labels (key/value pairs) present on the resource in GCP, including the labels configured through Pulumi, other clients and services.
    id string
    The provider-assigned unique ID for this managed resource.
    labelFingerprint string
    The fingerprint used for optimistic locking of this resource. Used internally during updates.
    pulumiLabels {[key: string]: string}
    The combination of labels configured directly on the resource and default labels configured on the provider.
    selfLink string
    The URI of the created resource.
    creation_timestamp str
    Creation timestamp in RFC3339 text format.
    effective_labels Mapping[str, str]
    All of labels (key/value pairs) present on the resource in GCP, including the labels configured through Pulumi, other clients and services.
    id str
    The provider-assigned unique ID for this managed resource.
    label_fingerprint str
    The fingerprint used for optimistic locking of this resource. Used internally during updates.
    pulumi_labels Mapping[str, str]
    The combination of labels configured directly on the resource and default labels configured on the provider.
    self_link str
    The URI of the created resource.
    creationTimestamp String
    Creation timestamp in RFC3339 text format.
    effectiveLabels Map<String>
    All of labels (key/value pairs) present on the resource in GCP, including the labels configured through Pulumi, other clients and services.
    id String
    The provider-assigned unique ID for this managed resource.
    labelFingerprint String
    The fingerprint used for optimistic locking of this resource. Used internally during updates.
    pulumiLabels Map<String>
    The combination of labels configured directly on the resource and default labels configured on the provider.
    selfLink String
    The URI of the created resource.

    Look up Existing GlobalAddress Resource

    Get an existing GlobalAddress 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?: GlobalAddressState, opts?: CustomResourceOptions): GlobalAddress
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        address: Optional[str] = None,
        address_type: Optional[str] = None,
        creation_timestamp: Optional[str] = None,
        description: Optional[str] = None,
        effective_labels: Optional[Mapping[str, str]] = None,
        ip_version: Optional[str] = None,
        label_fingerprint: Optional[str] = None,
        labels: Optional[Mapping[str, str]] = None,
        name: Optional[str] = None,
        network: Optional[str] = None,
        prefix_length: Optional[int] = None,
        project: Optional[str] = None,
        pulumi_labels: Optional[Mapping[str, str]] = None,
        purpose: Optional[str] = None,
        self_link: Optional[str] = None) -> GlobalAddress
    func GetGlobalAddress(ctx *Context, name string, id IDInput, state *GlobalAddressState, opts ...ResourceOption) (*GlobalAddress, error)
    public static GlobalAddress Get(string name, Input<string> id, GlobalAddressState? state, CustomResourceOptions? opts = null)
    public static GlobalAddress get(String name, Output<String> id, GlobalAddressState state, CustomResourceOptions options)
    resources:  _:    type: gcp:compute:GlobalAddress    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:
    Address string
    The IP address or beginning of the address range represented by this resource. This can be supplied as an input to reserve a specific address or omitted to allow GCP to choose a valid one for you.
    AddressType string
    The type of the address to reserve.

    • EXTERNAL indicates public/external single IP address.
    • INTERNAL indicates internal IP ranges belonging to some network. Default value is EXTERNAL. Possible values are: EXTERNAL, INTERNAL.
    CreationTimestamp string
    Creation timestamp in RFC3339 text format.
    Description string
    An optional description of this resource.
    EffectiveLabels Dictionary<string, string>
    All of labels (key/value pairs) present on the resource in GCP, including the labels configured through Pulumi, other clients and services.
    IpVersion string
    The IP Version that will be used by this address. The default value is IPV4. Possible values are: IPV4, IPV6.
    LabelFingerprint string
    The fingerprint used for optimistic locking of this resource. Used internally during updates.
    Labels Dictionary<string, string>

    Labels to apply to this address. A list of key->value pairs.

    Note: This field is non-authoritative, and will only manage the labels present in your configuration. Please refer to the field effective_labels for all of the labels present on the resource.

    Name 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.

    Network string
    The URL of the network in which to reserve the IP range. The IP range must be in RFC1918 space. The network cannot be deleted if there are any reserved IP ranges referring to it. This should only be set when using an Internal address.
    PrefixLength int
    The prefix length of the IP range. If not present, it means the address field is a single IP address. This field is not applicable to addresses with addressType=INTERNAL when purpose=PRIVATE_SERVICE_CONNECT
    Project string
    The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
    PulumiLabels Dictionary<string, string>
    The combination of labels configured directly on the resource and default labels configured on the provider.
    Purpose string
    The purpose of the resource. Possible values include:

    • VPC_PEERING - for peer networks
    • PRIVATE_SERVICE_CONNECT - for Private Service Connect networks
    SelfLink string
    The URI of the created resource.
    Address string
    The IP address or beginning of the address range represented by this resource. This can be supplied as an input to reserve a specific address or omitted to allow GCP to choose a valid one for you.
    AddressType string
    The type of the address to reserve.

    • EXTERNAL indicates public/external single IP address.
    • INTERNAL indicates internal IP ranges belonging to some network. Default value is EXTERNAL. Possible values are: EXTERNAL, INTERNAL.
    CreationTimestamp string
    Creation timestamp in RFC3339 text format.
    Description string
    An optional description of this resource.
    EffectiveLabels 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.
    IpVersion string
    The IP Version that will be used by this address. The default value is IPV4. Possible values are: IPV4, IPV6.
    LabelFingerprint string
    The fingerprint used for optimistic locking of this resource. Used internally during updates.
    Labels map[string]string

    Labels to apply to this address. A list of key->value pairs.

    Note: This field is non-authoritative, and will only manage the labels present in your configuration. Please refer to the field effective_labels for all of the labels present on the resource.

    Name 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.

    Network string
    The URL of the network in which to reserve the IP range. The IP range must be in RFC1918 space. The network cannot be deleted if there are any reserved IP ranges referring to it. This should only be set when using an Internal address.
    PrefixLength int
    The prefix length of the IP range. If not present, it means the address field is a single IP address. This field is not applicable to addresses with addressType=INTERNAL when purpose=PRIVATE_SERVICE_CONNECT
    Project string
    The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
    PulumiLabels map[string]string
    The combination of labels configured directly on the resource and default labels configured on the provider.
    Purpose string
    The purpose of the resource. Possible values include:

    • VPC_PEERING - for peer networks
    • PRIVATE_SERVICE_CONNECT - for Private Service Connect networks
    SelfLink string
    The URI of the created resource.
    address String
    The IP address or beginning of the address range represented by this resource. This can be supplied as an input to reserve a specific address or omitted to allow GCP to choose a valid one for you.
    addressType String
    The type of the address to reserve.

    • EXTERNAL indicates public/external single IP address.
    • INTERNAL indicates internal IP ranges belonging to some network. Default value is EXTERNAL. Possible values are: EXTERNAL, INTERNAL.
    creationTimestamp String
    Creation timestamp in RFC3339 text format.
    description String
    An optional description of this resource.
    effectiveLabels 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.
    ipVersion String
    The IP Version that will be used by this address. The default value is IPV4. Possible values are: IPV4, IPV6.
    labelFingerprint String
    The fingerprint used for optimistic locking of this resource. Used internally during updates.
    labels Map<String,String>

    Labels to apply to this address. A list of key->value pairs.

    Note: This field is non-authoritative, and will only manage the labels present in your configuration. Please refer to the field effective_labels for all of the labels present on the resource.

    name 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.

    network String
    The URL of the network in which to reserve the IP range. The IP range must be in RFC1918 space. The network cannot be deleted if there are any reserved IP ranges referring to it. This should only be set when using an Internal address.
    prefixLength Integer
    The prefix length of the IP range. If not present, it means the address field is a single IP address. This field is not applicable to addresses with addressType=INTERNAL when purpose=PRIVATE_SERVICE_CONNECT
    project String
    The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
    pulumiLabels Map<String,String>
    The combination of labels configured directly on the resource and default labels configured on the provider.
    purpose String
    The purpose of the resource. Possible values include:

    • VPC_PEERING - for peer networks
    • PRIVATE_SERVICE_CONNECT - for Private Service Connect networks
    selfLink String
    The URI of the created resource.
    address string
    The IP address or beginning of the address range represented by this resource. This can be supplied as an input to reserve a specific address or omitted to allow GCP to choose a valid one for you.
    addressType string
    The type of the address to reserve.

    • EXTERNAL indicates public/external single IP address.
    • INTERNAL indicates internal IP ranges belonging to some network. Default value is EXTERNAL. Possible values are: EXTERNAL, INTERNAL.
    creationTimestamp string
    Creation timestamp in RFC3339 text format.
    description string
    An optional description of this resource.
    effectiveLabels {[key: string]: string}
    All of labels (key/value pairs) present on the resource in GCP, including the labels configured through Pulumi, other clients and services.
    ipVersion string
    The IP Version that will be used by this address. The default value is IPV4. Possible values are: IPV4, IPV6.
    labelFingerprint string
    The fingerprint used for optimistic locking of this resource. Used internally during updates.
    labels {[key: string]: string}

    Labels to apply to this address. A list of key->value pairs.

    Note: This field is non-authoritative, and will only manage the labels present in your configuration. Please refer to the field effective_labels for all of the labels present on the resource.

    name 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.

    network string
    The URL of the network in which to reserve the IP range. The IP range must be in RFC1918 space. The network cannot be deleted if there are any reserved IP ranges referring to it. This should only be set when using an Internal address.
    prefixLength number
    The prefix length of the IP range. If not present, it means the address field is a single IP address. This field is not applicable to addresses with addressType=INTERNAL when purpose=PRIVATE_SERVICE_CONNECT
    project string
    The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
    pulumiLabels {[key: string]: string}
    The combination of labels configured directly on the resource and default labels configured on the provider.
    purpose string
    The purpose of the resource. Possible values include:

    • VPC_PEERING - for peer networks
    • PRIVATE_SERVICE_CONNECT - for Private Service Connect networks
    selfLink string
    The URI of the created resource.
    address str
    The IP address or beginning of the address range represented by this resource. This can be supplied as an input to reserve a specific address or omitted to allow GCP to choose a valid one for you.
    address_type str
    The type of the address to reserve.

    • EXTERNAL indicates public/external single IP address.
    • INTERNAL indicates internal IP ranges belonging to some network. Default value is EXTERNAL. Possible values are: EXTERNAL, INTERNAL.
    creation_timestamp str
    Creation timestamp in RFC3339 text format.
    description str
    An optional description of this resource.
    effective_labels Mapping[str, str]
    All of labels (key/value pairs) present on the resource in GCP, including the labels configured through Pulumi, other clients and services.
    ip_version str
    The IP Version that will be used by this address. The default value is IPV4. Possible values are: IPV4, IPV6.
    label_fingerprint str
    The fingerprint used for optimistic locking of this resource. Used internally during updates.
    labels Mapping[str, str]

    Labels to apply to this address. A list of key->value pairs.

    Note: This field is non-authoritative, and will only manage the labels present in your configuration. Please refer to the field effective_labels for all of the labels present on the resource.

    name str
    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.

    network str
    The URL of the network in which to reserve the IP range. The IP range must be in RFC1918 space. The network cannot be deleted if there are any reserved IP ranges referring to it. This should only be set when using an Internal address.
    prefix_length int
    The prefix length of the IP range. If not present, it means the address field is a single IP address. This field is not applicable to addresses with addressType=INTERNAL when purpose=PRIVATE_SERVICE_CONNECT
    project str
    The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
    pulumi_labels Mapping[str, str]
    The combination of labels configured directly on the resource and default labels configured on the provider.
    purpose str
    The purpose of the resource. Possible values include:

    • VPC_PEERING - for peer networks
    • PRIVATE_SERVICE_CONNECT - for Private Service Connect networks
    self_link str
    The URI of the created resource.
    address String
    The IP address or beginning of the address range represented by this resource. This can be supplied as an input to reserve a specific address or omitted to allow GCP to choose a valid one for you.
    addressType String
    The type of the address to reserve.

    • EXTERNAL indicates public/external single IP address.
    • INTERNAL indicates internal IP ranges belonging to some network. Default value is EXTERNAL. Possible values are: EXTERNAL, INTERNAL.
    creationTimestamp String
    Creation timestamp in RFC3339 text format.
    description String
    An optional description of this resource.
    effectiveLabels Map<String>
    All of labels (key/value pairs) present on the resource in GCP, including the labels configured through Pulumi, other clients and services.
    ipVersion String
    The IP Version that will be used by this address. The default value is IPV4. Possible values are: IPV4, IPV6.
    labelFingerprint String
    The fingerprint used for optimistic locking of this resource. Used internally during updates.
    labels Map<String>

    Labels to apply to this address. A list of key->value pairs.

    Note: This field is non-authoritative, and will only manage the labels present in your configuration. Please refer to the field effective_labels for all of the labels present on the resource.

    name 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.

    network String
    The URL of the network in which to reserve the IP range. The IP range must be in RFC1918 space. The network cannot be deleted if there are any reserved IP ranges referring to it. This should only be set when using an Internal address.
    prefixLength Number
    The prefix length of the IP range. If not present, it means the address field is a single IP address. This field is not applicable to addresses with addressType=INTERNAL when purpose=PRIVATE_SERVICE_CONNECT
    project String
    The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
    pulumiLabels Map<String>
    The combination of labels configured directly on the resource and default labels configured on the provider.
    purpose String
    The purpose of the resource. Possible values include:

    • VPC_PEERING - for peer networks
    • PRIVATE_SERVICE_CONNECT - for Private Service Connect networks
    selfLink String
    The URI of the created resource.

    Import

    GlobalAddress can be imported using any of these accepted formats:

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

    • {{project}}/{{name}}

    • {{name}}

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

    $ pulumi import gcp:compute/globalAddress:GlobalAddress default projects/{{project}}/global/addresses/{{name}}

    $ pulumi import gcp:compute/globalAddress:GlobalAddress default {{project}}/{{name}}

    $ pulumi import gcp:compute/globalAddress:GlobalAddress default {{name}}

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

    Package Details

    Repository
    Google Cloud (GCP) Classic pulumi/pulumi-gcp
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the google-beta Terraform Provider.
    gcp logo
    Google Cloud v8.21.0 published on Wednesday, Mar 5, 2025 by Pulumi
    pulumi/pulumi-gcp