Google Cloud v8.21.0, Mar 5 25

Google Cloud v8.21.0 published on Wednesday, Mar 5, 2025 by Pulumi

gcp.compute.Address

Explore with Pulumi AI

Google Cloud v8.21.0 published on Wednesday, Mar 5, 2025 by Pulumi

Each virtual machine instance has an ephemeral internal IP address and, optionally, an external IP address. To communicate between instances on the same network, you can use an instance’s internal IP address. To communicate with the Internet and instances outside of the same network, you must specify the instance’s external IP address.

Internal IP addresses are ephemeral and only belong to an instance for the lifetime of the instance; if the instance is deleted and recreated, the instance is assigned a new internal IP address, either by Compute Engine or by you. External IP addresses can be either ephemeral or static.

To get more information about Address, see:

Example Usage

Address Basic

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

const ipAddress = new gcp.compute.Address("ip_address", {name: "my-address"});

import pulumi
import pulumi_gcp as gcp

ip_address = gcp.compute.Address("ip_address", name="my-address")

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.NewAddress(ctx, "ip_address", &compute.AddressArgs{
			Name: pulumi.String("my-address"),
		})
		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 ipAddress = new Gcp.Compute.Address("ip_address", new()
    {
        Name = "my-address",
    });

});

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.gcp.compute.Address;
import com.pulumi.gcp.compute.AddressArgs;
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 ipAddress = new Address("ipAddress", AddressArgs.builder()
            .name("my-address")
            .build());

    }
}

resources:
  ipAddress:
    type: gcp:compute:Address
    name: ip_address
    properties:
      name: my-address

Address With Subnetwork

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

const _default = new gcp.compute.Network("default", {name: "my-network"});
const defaultSubnetwork = new gcp.compute.Subnetwork("default", {
    name: "my-subnet",
    ipCidrRange: "10.0.0.0/16",
    region: "us-central1",
    network: _default.id,
});
const internalWithSubnetAndAddress = new gcp.compute.Address("internal_with_subnet_and_address", {
    name: "my-internal-address",
    subnetwork: defaultSubnetwork.id,
    addressType: "INTERNAL",
    address: "10.0.42.42",
    region: "us-central1",
});

import pulumi
import pulumi_gcp as gcp

default = gcp.compute.Network("default", name="my-network")
default_subnetwork = gcp.compute.Subnetwork("default",
    name="my-subnet",
    ip_cidr_range="10.0.0.0/16",
    region="us-central1",
    network=default.id)
internal_with_subnet_and_address = gcp.compute.Address("internal_with_subnet_and_address",
    name="my-internal-address",
    subnetwork=default_subnetwork.id,
    address_type="INTERNAL",
    address="10.0.42.42",
    region="us-central1")

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 {
		_default, err := compute.NewNetwork(ctx, "default", &compute.NetworkArgs{
			Name: pulumi.String("my-network"),
		})
		if err != nil {
			return err
		}
		defaultSubnetwork, err := compute.NewSubnetwork(ctx, "default", &compute.SubnetworkArgs{
			Name:        pulumi.String("my-subnet"),
			IpCidrRange: pulumi.String("10.0.0.0/16"),
			Region:      pulumi.String("us-central1"),
			Network:     _default.ID(),
		})
		if err != nil {
			return err
		}
		_, err = compute.NewAddress(ctx, "internal_with_subnet_and_address", &compute.AddressArgs{
			Name:        pulumi.String("my-internal-address"),
			Subnetwork:  defaultSubnetwork.ID(),
			AddressType: pulumi.String("INTERNAL"),
			Address:     pulumi.String("10.0.42.42"),
			Region:      pulumi.String("us-central1"),
		})
		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.Network("default", new()
    {
        Name = "my-network",
    });

    var defaultSubnetwork = new Gcp.Compute.Subnetwork("default", new()
    {
        Name = "my-subnet",
        IpCidrRange = "10.0.0.0/16",
        Region = "us-central1",
        Network = @default.Id,
    });

    var internalWithSubnetAndAddress = new Gcp.Compute.Address("internal_with_subnet_and_address", new()
    {
        Name = "my-internal-address",
        Subnetwork = defaultSubnetwork.Id,
        AddressType = "INTERNAL",
        IPAddress = "10.0.42.42",
        Region = "us-central1",
    });

});

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.Subnetwork;
import com.pulumi.gcp.compute.SubnetworkArgs;
import com.pulumi.gcp.compute.Address;
import com.pulumi.gcp.compute.AddressArgs;
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 Network("default", NetworkArgs.builder()
            .name("my-network")
            .build());

        var defaultSubnetwork = new Subnetwork("defaultSubnetwork", SubnetworkArgs.builder()
            .name("my-subnet")
            .ipCidrRange("10.0.0.0/16")
            .region("us-central1")
            .network(default_.id())
            .build());

        var internalWithSubnetAndAddress = new Address("internalWithSubnetAndAddress", AddressArgs.builder()
            .name("my-internal-address")
            .subnetwork(defaultSubnetwork.id())
            .addressType("INTERNAL")
            .address("10.0.42.42")
            .region("us-central1")
            .build());

    }
}

resources:
  default:
    type: gcp:compute:Network
    properties:
      name: my-network
  defaultSubnetwork:
    type: gcp:compute:Subnetwork
    name: default
    properties:
      name: my-subnet
      ipCidrRange: 10.0.0.0/16
      region: us-central1
      network: ${default.id}
  internalWithSubnetAndAddress:
    type: gcp:compute:Address
    name: internal_with_subnet_and_address
    properties:
      name: my-internal-address
      subnetwork: ${defaultSubnetwork.id}
      addressType: INTERNAL
      address: 10.0.42.42
      region: us-central1

Address With Gce Endpoint

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

const internalWithGceEndpoint = new gcp.compute.Address("internal_with_gce_endpoint", {
    name: "my-internal-address-",
    addressType: "INTERNAL",
    purpose: "GCE_ENDPOINT",
});

import pulumi
import pulumi_gcp as gcp

internal_with_gce_endpoint = gcp.compute.Address("internal_with_gce_endpoint",
    name="my-internal-address-",
    address_type="INTERNAL",
    purpose="GCE_ENDPOINT")

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.NewAddress(ctx, "internal_with_gce_endpoint", &compute.AddressArgs{
			Name:        pulumi.String("my-internal-address-"),
			AddressType: pulumi.String("INTERNAL"),
			Purpose:     pulumi.String("GCE_ENDPOINT"),
		})
		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 internalWithGceEndpoint = new Gcp.Compute.Address("internal_with_gce_endpoint", new()
    {
        Name = "my-internal-address-",
        AddressType = "INTERNAL",
        Purpose = "GCE_ENDPOINT",
    });

});

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.gcp.compute.Address;
import com.pulumi.gcp.compute.AddressArgs;
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 internalWithGceEndpoint = new Address("internalWithGceEndpoint", AddressArgs.builder()
            .name("my-internal-address-")
            .addressType("INTERNAL")
            .purpose("GCE_ENDPOINT")
            .build());

    }
}

resources:
  internalWithGceEndpoint:
    type: gcp:compute:Address
    name: internal_with_gce_endpoint
    properties:
      name: my-internal-address-
      addressType: INTERNAL
      purpose: GCE_ENDPOINT

Instance With Ip

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

const static = new gcp.compute.Address("static", {name: "ipv4-address"});
const debianImage = gcp.compute.getImage({
    family: "debian-11",
    project: "debian-cloud",
});
const instanceWithIp = new gcp.compute.Instance("instance_with_ip", {
    name: "vm-instance",
    machineType: "f1-micro",
    zone: "us-central1-a",
    bootDisk: {
        initializeParams: {
            image: debianImage.then(debianImage => debianImage.selfLink),
        },
    },
    networkInterfaces: [{
        network: "default",
        accessConfigs: [{
            natIp: static.address,
        }],
    }],
});

import pulumi
import pulumi_gcp as gcp

static = gcp.compute.Address("static", name="ipv4-address")
debian_image = gcp.compute.get_image(family="debian-11",
    project="debian-cloud")
instance_with_ip = gcp.compute.Instance("instance_with_ip",
    name="vm-instance",
    machine_type="f1-micro",
    zone="us-central1-a",
    boot_disk={
        "initialize_params": {
            "image": debian_image.self_link,
        },
    },
    network_interfaces=[{
        "network": "default",
        "access_configs": [{
            "nat_ip": static.address,
        }],
    }])

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 {
		static, err := compute.NewAddress(ctx, "static", &compute.AddressArgs{
			Name: pulumi.String("ipv4-address"),
		})
		if err != nil {
			return err
		}
		debianImage, err := compute.LookupImage(ctx, &compute.LookupImageArgs{
			Family:  pulumi.StringRef("debian-11"),
			Project: pulumi.StringRef("debian-cloud"),
		}, nil)
		if err != nil {
			return err
		}
		_, err = compute.NewInstance(ctx, "instance_with_ip", &compute.InstanceArgs{
			Name:        pulumi.String("vm-instance"),
			MachineType: pulumi.String("f1-micro"),
			Zone:        pulumi.String("us-central1-a"),
			BootDisk: &compute.InstanceBootDiskArgs{
				InitializeParams: &compute.InstanceBootDiskInitializeParamsArgs{
					Image: pulumi.String(debianImage.SelfLink),
				},
			},
			NetworkInterfaces: compute.InstanceNetworkInterfaceArray{
				&compute.InstanceNetworkInterfaceArgs{
					Network: pulumi.String("default"),
					AccessConfigs: compute.InstanceNetworkInterfaceAccessConfigArray{
						&compute.InstanceNetworkInterfaceAccessConfigArgs{
							NatIp: static.Address,
						},
					},
				},
			},
		})
		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 @static = new Gcp.Compute.Address("static", new()
    {
        Name = "ipv4-address",
    });

    var debianImage = Gcp.Compute.GetImage.Invoke(new()
    {
        Family = "debian-11",
        Project = "debian-cloud",
    });

    var instanceWithIp = new Gcp.Compute.Instance("instance_with_ip", new()
    {
        Name = "vm-instance",
        MachineType = "f1-micro",
        Zone = "us-central1-a",
        BootDisk = new Gcp.Compute.Inputs.InstanceBootDiskArgs
        {
            InitializeParams = new Gcp.Compute.Inputs.InstanceBootDiskInitializeParamsArgs
            {
                Image = debianImage.Apply(getImageResult => getImageResult.SelfLink),
            },
        },
        NetworkInterfaces = new[]
        {
            new Gcp.Compute.Inputs.InstanceNetworkInterfaceArgs
            {
                Network = "default",
                AccessConfigs = new[]
                {
                    new Gcp.Compute.Inputs.InstanceNetworkInterfaceAccessConfigArgs
                    {
                        NatIp = @static.IPAddress,
                    },
                },
            },
        },
    });

});

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.gcp.compute.Address;
import com.pulumi.gcp.compute.AddressArgs;
import com.pulumi.gcp.compute.ComputeFunctions;
import com.pulumi.gcp.compute.inputs.GetImageArgs;
import com.pulumi.gcp.compute.Instance;
import com.pulumi.gcp.compute.InstanceArgs;
import com.pulumi.gcp.compute.inputs.InstanceBootDiskArgs;
import com.pulumi.gcp.compute.inputs.InstanceBootDiskInitializeParamsArgs;
import com.pulumi.gcp.compute.inputs.InstanceNetworkInterfaceArgs;
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 static_ = new Address("static", AddressArgs.builder()
            .name("ipv4-address")
            .build());

        final var debianImage = ComputeFunctions.getImage(GetImageArgs.builder()
            .family("debian-11")
            .project("debian-cloud")
            .build());

        var instanceWithIp = new Instance("instanceWithIp", InstanceArgs.builder()
            .name("vm-instance")
            .machineType("f1-micro")
            .zone("us-central1-a")
            .bootDisk(InstanceBootDiskArgs.builder()
                .initializeParams(InstanceBootDiskInitializeParamsArgs.builder()
                    .image(debianImage.applyValue(getImageResult -> getImageResult.selfLink()))
                    .build())
                .build())
            .networkInterfaces(InstanceNetworkInterfaceArgs.builder()
                .network("default")
                .accessConfigs(InstanceNetworkInterfaceAccessConfigArgs.builder()
                    .natIp(static_.address())
                    .build())
                .build())
            .build());

    }
}

resources:
  static:
    type: gcp:compute:Address
    properties:
      name: ipv4-address
  instanceWithIp:
    type: gcp:compute:Instance
    name: instance_with_ip
    properties:
      name: vm-instance
      machineType: f1-micro
      zone: us-central1-a
      bootDisk:
        initializeParams:
          image: ${debianImage.selfLink}
      networkInterfaces:
        - network: default
          accessConfigs:
            - natIp: ${static.address}
variables:
  debianImage:
    fn::invoke:
      function: gcp:compute:getImage
      arguments:
        family: debian-11
        project: debian-cloud

Compute Address Ipsec Interconnect

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

const network = new gcp.compute.Network("network", {
    name: "test-network",
    autoCreateSubnetworks: false,
});
const ipsec_interconnect_address = new gcp.compute.Address("ipsec-interconnect-address", {
    name: "test-address",
    addressType: "INTERNAL",
    purpose: "IPSEC_INTERCONNECT",
    address: "192.168.1.0",
    prefixLength: 29,
    network: network.selfLink,
});

import pulumi
import pulumi_gcp as gcp

network = gcp.compute.Network("network",
    name="test-network",
    auto_create_subnetworks=False)
ipsec_interconnect_address = gcp.compute.Address("ipsec-interconnect-address",
    name="test-address",
    address_type="INTERNAL",
    purpose="IPSEC_INTERCONNECT",
    address="192.168.1.0",
    prefix_length=29,
    network=network.self_link)

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("test-network"),
			AutoCreateSubnetworks: pulumi.Bool(false),
		})
		if err != nil {
			return err
		}
		_, err = compute.NewAddress(ctx, "ipsec-interconnect-address", &compute.AddressArgs{
			Name:         pulumi.String("test-address"),
			AddressType:  pulumi.String("INTERNAL"),
			Purpose:      pulumi.String("IPSEC_INTERCONNECT"),
			Address:      pulumi.String("192.168.1.0"),
			PrefixLength: pulumi.Int(29),
			Network:      network.SelfLink,
		})
		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 = "test-network",
        AutoCreateSubnetworks = false,
    });

    var ipsec_interconnect_address = new Gcp.Compute.Address("ipsec-interconnect-address", new()
    {
        Name = "test-address",
        AddressType = "INTERNAL",
        Purpose = "IPSEC_INTERCONNECT",
        IPAddress = "192.168.1.0",
        PrefixLength = 29,
        Network = network.SelfLink,
    });

});

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.Address;
import com.pulumi.gcp.compute.AddressArgs;
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("test-network")
            .autoCreateSubnetworks(false)
            .build());

        var ipsec_interconnect_address = new Address("ipsec-interconnect-address", AddressArgs.builder()
            .name("test-address")
            .addressType("INTERNAL")
            .purpose("IPSEC_INTERCONNECT")
            .address("192.168.1.0")
            .prefixLength(29)
            .network(network.selfLink())
            .build());

    }
}

resources:
  ipsec-interconnect-address:
    type: gcp:compute:Address
    properties:
      name: test-address
      addressType: INTERNAL
      purpose: IPSEC_INTERCONNECT
      address: 192.168.1.0
      prefixLength: 29
      network: ${network.selfLink}
  network:
    type: gcp:compute:Network
    properties:
      name: test-network
      autoCreateSubnetworks: false

Create Address Resource

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

Constructor syntax

new Address(name: string, args?: AddressArgs, opts?: CustomResourceOptions);

@overload
def Address(resource_name: str,
            args: Optional[AddressArgs] = None,
            opts: Optional[ResourceOptions] = None)

@overload
def Address(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,
            ipv6_endpoint_type: Optional[str] = None,
            labels: Optional[Mapping[str, str]] = None,
            name: Optional[str] = None,
            network: Optional[str] = None,
            network_tier: Optional[str] = None,
            prefix_length: Optional[int] = None,
            project: Optional[str] = None,
            purpose: Optional[str] = None,
            region: Optional[str] = None,
            subnetwork: Optional[str] = None)

func NewAddress(ctx *Context, name string, args *AddressArgs, opts ...ResourceOption) (*Address, error)

public Address(string name, AddressArgs? args = null, CustomResourceOptions? opts = null)

public Address(String name, AddressArgs args)
public Address(String name, AddressArgs args, CustomResourceOptions options)

type: gcp:compute:Address
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 AddressArgs: 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 AddressArgs: 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 AddressArgs: The arguments to resource properties.
opts ResourceOption: Bag of options to control resource's behavior.

name string: The unique name of the resource.
args AddressArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

name String: The unique name of the resource.
args AddressArgs: 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 addressResource = new Gcp.Compute.Address("addressResource", new()
{
    IPAddress = "string",
    AddressType = "string",
    Description = "string",
    IpVersion = "string",
    Ipv6EndpointType = "string",
    Labels = 
    {
        { "string", "string" },
    },
    Name = "string",
    Network = "string",
    NetworkTier = "string",
    PrefixLength = 0,
    Project = "string",
    Purpose = "string",
    Region = "string",
    Subnetwork = "string",
});

example, err := compute.NewAddress(ctx, "addressResource", &compute.AddressArgs{
	Address:          pulumi.String("string"),
	AddressType:      pulumi.String("string"),
	Description:      pulumi.String("string"),
	IpVersion:        pulumi.String("string"),
	Ipv6EndpointType: pulumi.String("string"),
	Labels: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
	Name:         pulumi.String("string"),
	Network:      pulumi.String("string"),
	NetworkTier:  pulumi.String("string"),
	PrefixLength: pulumi.Int(0),
	Project:      pulumi.String("string"),
	Purpose:      pulumi.String("string"),
	Region:       pulumi.String("string"),
	Subnetwork:   pulumi.String("string"),
})

var addressResource = new Address("addressResource", AddressArgs.builder()
    .address("string")
    .addressType("string")
    .description("string")
    .ipVersion("string")
    .ipv6EndpointType("string")
    .labels(Map.of("string", "string"))
    .name("string")
    .network("string")
    .networkTier("string")
    .prefixLength(0)
    .project("string")
    .purpose("string")
    .region("string")
    .subnetwork("string")
    .build());

address_resource = gcp.compute.Address("addressResource",
    address="string",
    address_type="string",
    description="string",
    ip_version="string",
    ipv6_endpoint_type="string",
    labels={
        "string": "string",
    },
    name="string",
    network="string",
    network_tier="string",
    prefix_length=0,
    project="string",
    purpose="string",
    region="string",
    subnetwork="string")

const addressResource = new gcp.compute.Address("addressResource", {
    address: "string",
    addressType: "string",
    description: "string",
    ipVersion: "string",
    ipv6EndpointType: "string",
    labels: {
        string: "string",
    },
    name: "string",
    network: "string",
    networkTier: "string",
    prefixLength: 0,
    project: "string",
    purpose: "string",
    region: "string",
    subnetwork: "string",
});

type: gcp:compute:Address
properties:
    address: string
    addressType: string
    description: string
    ipVersion: string
    ipv6EndpointType: string
    labels:
        string: string
    name: string
    network: string
    networkTier: string
    prefixLength: 0
    project: string
    purpose: string
    region: string
    subnetwork: string

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

AddressType string

The type of address to reserve. Note: if you set this argument's value as INTERNAL you need to leave the network_tier argument unset in that resource block. Default value is EXTERNAL. Possible values are: INTERNAL, EXTERNAL.

Description string

An optional description of this resource.

IPAddress string

The static external IP address represented by this resource. The IP address must be inside the specified subnetwork, if any. Set by the API if undefined.

IpVersion string

The IP Version that will be used by this address. The default value is IPV4. Possible values are: IPV4, IPV6.

Ipv6EndpointType string

The endpoint type of this address, which should be VM or NETLB. This is used for deciding which type of endpoint this address can be used after the external IPv6 address reservation. Possible values are: VM, NETLB.

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. 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 address. This field can only be used with INTERNAL type with the VPC_PEERING and IPSEC_INTERCONNECT purposes.

NetworkTier string

The networking tier used for configuring this address. If this field is not specified, it is assumed to be PREMIUM. This argument should not be used when configuring Internal addresses, because network tier cannot be set for internal traffic; it's always Premium. Possible values are: PREMIUM, STANDARD.

PrefixLength int

The prefix length if the resource represents an IP range.

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 this resource, which can be one of the following values.

GCE_ENDPOINT for addresses that are used by VM instances, alias IP ranges, load balancers, and similar resources.
SHARED_LOADBALANCER_VIP for an address that can be used by multiple internal load balancers.
VPC_PEERING for addresses that are reserved for VPC peer networks.
IPSEC_INTERCONNECT for addresses created from a private IP range that are reserved for a VLAN attachment in an HA VPN over Cloud Interconnect configuration. These addresses are regional resources.
PRIVATE_SERVICE_CONNECT for a private network address that is used to configure Private Service Connect. Only global internal addresses can use this purpose. This should only be set when using an Internal address.

Region string

The Region in which the created address should reside. If it is not provided, the provider region is used.

Subnetwork string

The URL of the subnetwork in which to reserve the address. If an IP address is specified, it must be within the subnetwork's IP range. This field can only be used with INTERNAL type with GCE_ENDPOINT/DNS_RESOLVER purposes.

Address string

The static external IP address represented by this resource. The IP address must be inside the specified subnetwork, if any. Set by the API if undefined.

AddressType string

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.

Ipv6EndpointType string

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

Network string

The URL of the network in which to reserve the address. This field can only be used with INTERNAL type with the VPC_PEERING and IPSEC_INTERCONNECT purposes.

NetworkTier string

PrefixLength int

The prefix length if the resource represents an IP range.

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 this resource, which can be one of the following values.

GCE_ENDPOINT for addresses that are used by VM instances, alias IP ranges, load balancers, and similar resources.
SHARED_LOADBALANCER_VIP for an address that can be used by multiple internal load balancers.
VPC_PEERING for addresses that are reserved for VPC peer networks.
IPSEC_INTERCONNECT for addresses created from a private IP range that are reserved for a VLAN attachment in an HA VPN over Cloud Interconnect configuration. These addresses are regional resources.
PRIVATE_SERVICE_CONNECT for a private network address that is used to configure Private Service Connect. Only global internal addresses can use this purpose. This should only be set when using an Internal address.

Region string

The Region in which the created address should reside. If it is not provided, the provider region is used.

Subnetwork string

address String

The static external IP address represented by this resource. The IP address must be inside the specified subnetwork, if any. Set by the API if undefined.

addressType String

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.

ipv6EndpointType String

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

network String

The URL of the network in which to reserve the address. This field can only be used with INTERNAL type with the VPC_PEERING and IPSEC_INTERCONNECT purposes.

networkTier String

prefixLength Integer

The prefix length if the resource represents an IP range.

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 this resource, which can be one of the following values.

GCE_ENDPOINT for addresses that are used by VM instances, alias IP ranges, load balancers, and similar resources.
SHARED_LOADBALANCER_VIP for an address that can be used by multiple internal load balancers.
VPC_PEERING for addresses that are reserved for VPC peer networks.
IPSEC_INTERCONNECT for addresses created from a private IP range that are reserved for a VLAN attachment in an HA VPN over Cloud Interconnect configuration. These addresses are regional resources.
PRIVATE_SERVICE_CONNECT for a private network address that is used to configure Private Service Connect. Only global internal addresses can use this purpose. This should only be set when using an Internal address.

region String

The Region in which the created address should reside. If it is not provided, the provider region is used.

subnetwork String

address string

The static external IP address represented by this resource. The IP address must be inside the specified subnetwork, if any. Set by the API if undefined.

addressType string

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.

ipv6EndpointType string

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

network string

The URL of the network in which to reserve the address. This field can only be used with INTERNAL type with the VPC_PEERING and IPSEC_INTERCONNECT purposes.

networkTier string

prefixLength number

The prefix length if the resource represents an IP range.

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 this resource, which can be one of the following values.

GCE_ENDPOINT for addresses that are used by VM instances, alias IP ranges, load balancers, and similar resources.
SHARED_LOADBALANCER_VIP for an address that can be used by multiple internal load balancers.
VPC_PEERING for addresses that are reserved for VPC peer networks.
IPSEC_INTERCONNECT for addresses created from a private IP range that are reserved for a VLAN attachment in an HA VPN over Cloud Interconnect configuration. These addresses are regional resources.
PRIVATE_SERVICE_CONNECT for a private network address that is used to configure Private Service Connect. Only global internal addresses can use this purpose. This should only be set when using an Internal address.

region string

The Region in which the created address should reside. If it is not provided, the provider region is used.

subnetwork string

address str

The static external IP address represented by this resource. The IP address must be inside the specified subnetwork, if any. Set by the API if undefined.

address_type str

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.

ipv6_endpoint_type str

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

network str

The URL of the network in which to reserve the address. This field can only be used with INTERNAL type with the VPC_PEERING and IPSEC_INTERCONNECT purposes.

network_tier str

prefix_length int

The prefix length if the resource represents an IP range.

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 this resource, which can be one of the following values.

GCE_ENDPOINT for addresses that are used by VM instances, alias IP ranges, load balancers, and similar resources.
SHARED_LOADBALANCER_VIP for an address that can be used by multiple internal load balancers.
VPC_PEERING for addresses that are reserved for VPC peer networks.
IPSEC_INTERCONNECT for addresses created from a private IP range that are reserved for a VLAN attachment in an HA VPN over Cloud Interconnect configuration. These addresses are regional resources.
PRIVATE_SERVICE_CONNECT for a private network address that is used to configure Private Service Connect. Only global internal addresses can use this purpose. This should only be set when using an Internal address.

region str

The Region in which the created address should reside. If it is not provided, the provider region is used.

subnetwork str

address String

The static external IP address represented by this resource. The IP address must be inside the specified subnetwork, if any. Set by the API if undefined.

addressType String

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.

ipv6EndpointType String

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

network String

The URL of the network in which to reserve the address. This field can only be used with INTERNAL type with the VPC_PEERING and IPSEC_INTERCONNECT purposes.

networkTier String

prefixLength Number

The prefix length if the resource represents an IP range.

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 this resource, which can be one of the following values.

GCE_ENDPOINT for addresses that are used by VM instances, alias IP ranges, load balancers, and similar resources.
SHARED_LOADBALANCER_VIP for an address that can be used by multiple internal load balancers.
VPC_PEERING for addresses that are reserved for VPC peer networks.
IPSEC_INTERCONNECT for addresses created from a private IP range that are reserved for a VLAN attachment in an HA VPN over Cloud Interconnect configuration. These addresses are regional resources.
PRIVATE_SERVICE_CONNECT for a private network address that is used to configure Private Service Connect. Only global internal addresses can use this purpose. This should only be set when using an Internal address.

region String

The Region in which the created address should reside. If it is not provided, the provider region is used.

subnetwork String

Outputs

All input properties are implicitly available as output properties. Additionally, the Address 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.
Users List<string>: The URLs of the resources that are using this address.

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.
Users []string: The URLs of the resources that are using this address.

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.
users List<String>: The URLs of the resources that are using this address.

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.
users string[]: The URLs of the resources that are using this address.

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.
users Sequence[str]: The URLs of the resources that are using this address.

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.
users List<String>: The URLs of the resources that are using this address.

Look up Existing Address Resource

Get an existing Address 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?: AddressState, opts?: CustomResourceOptions): Address

@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,
        ipv6_endpoint_type: Optional[str] = None,
        label_fingerprint: Optional[str] = None,
        labels: Optional[Mapping[str, str]] = None,
        name: Optional[str] = None,
        network: Optional[str] = None,
        network_tier: Optional[str] = None,
        prefix_length: Optional[int] = None,
        project: Optional[str] = None,
        pulumi_labels: Optional[Mapping[str, str]] = None,
        purpose: Optional[str] = None,
        region: Optional[str] = None,
        self_link: Optional[str] = None,
        subnetwork: Optional[str] = None,
        users: Optional[Sequence[str]] = None) -> Address

func GetAddress(ctx *Context, name string, id IDInput, state *AddressState, opts ...ResourceOption) (*Address, error)

public static Address Get(string name, Input<string> id, AddressState? state, CustomResourceOptions? opts = null)

public static Address get(String name, Output<String> id, AddressState state, CustomResourceOptions options)

resources:  _:    type: gcp:compute:Address    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:

AddressType string

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.

IPAddress string

The static external IP address represented by this resource. The IP address must be inside the specified subnetwork, if any. Set by the API if undefined.

IpVersion string

The IP Version that will be used by this address. The default value is IPV4. Possible values are: IPV4, IPV6.

Ipv6EndpointType string

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

Network string

The URL of the network in which to reserve the address. This field can only be used with INTERNAL type with the VPC_PEERING and IPSEC_INTERCONNECT purposes.

NetworkTier string

PrefixLength int

The prefix length if the resource represents an IP range.

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 this resource, which can be one of the following values.

GCE_ENDPOINT for addresses that are used by VM instances, alias IP ranges, load balancers, and similar resources.
SHARED_LOADBALANCER_VIP for an address that can be used by multiple internal load balancers.
VPC_PEERING for addresses that are reserved for VPC peer networks.
IPSEC_INTERCONNECT for addresses created from a private IP range that are reserved for a VLAN attachment in an HA VPN over Cloud Interconnect configuration. These addresses are regional resources.
PRIVATE_SERVICE_CONNECT for a private network address that is used to configure Private Service Connect. Only global internal addresses can use this purpose. This should only be set when using an Internal address.

Region string

The Region in which the created address should reside. If it is not provided, the provider region is used.

SelfLink string

The URI of the created resource.

Subnetwork string

Users List<string>

The URLs of the resources that are using this address.

Address string

The static external IP address represented by this resource. The IP address must be inside the specified subnetwork, if any. Set by the API if undefined.

AddressType string

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.

Ipv6EndpointType string

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

Network string

The URL of the network in which to reserve the address. This field can only be used with INTERNAL type with the VPC_PEERING and IPSEC_INTERCONNECT purposes.

NetworkTier string

PrefixLength int

The prefix length if the resource represents an IP range.

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 this resource, which can be one of the following values.

GCE_ENDPOINT for addresses that are used by VM instances, alias IP ranges, load balancers, and similar resources.
SHARED_LOADBALANCER_VIP for an address that can be used by multiple internal load balancers.
VPC_PEERING for addresses that are reserved for VPC peer networks.
IPSEC_INTERCONNECT for addresses created from a private IP range that are reserved for a VLAN attachment in an HA VPN over Cloud Interconnect configuration. These addresses are regional resources.
PRIVATE_SERVICE_CONNECT for a private network address that is used to configure Private Service Connect. Only global internal addresses can use this purpose. This should only be set when using an Internal address.

Region string

The Region in which the created address should reside. If it is not provided, the provider region is used.

SelfLink string

The URI of the created resource.

Subnetwork string

Users []string

The URLs of the resources that are using this address.

address String

The static external IP address represented by this resource. The IP address must be inside the specified subnetwork, if any. Set by the API if undefined.

addressType String

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.

ipv6EndpointType String

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

network String

The URL of the network in which to reserve the address. This field can only be used with INTERNAL type with the VPC_PEERING and IPSEC_INTERCONNECT purposes.

networkTier String

prefixLength Integer

The prefix length if the resource represents an IP range.

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 this resource, which can be one of the following values.

GCE_ENDPOINT for addresses that are used by VM instances, alias IP ranges, load balancers, and similar resources.
SHARED_LOADBALANCER_VIP for an address that can be used by multiple internal load balancers.
VPC_PEERING for addresses that are reserved for VPC peer networks.
IPSEC_INTERCONNECT for addresses created from a private IP range that are reserved for a VLAN attachment in an HA VPN over Cloud Interconnect configuration. These addresses are regional resources.
PRIVATE_SERVICE_CONNECT for a private network address that is used to configure Private Service Connect. Only global internal addresses can use this purpose. This should only be set when using an Internal address.

region String

The Region in which the created address should reside. If it is not provided, the provider region is used.

selfLink String

The URI of the created resource.

subnetwork String

users List<String>

The URLs of the resources that are using this address.

address string

The static external IP address represented by this resource. The IP address must be inside the specified subnetwork, if any. Set by the API if undefined.

addressType string

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.

ipv6EndpointType string

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

network string

The URL of the network in which to reserve the address. This field can only be used with INTERNAL type with the VPC_PEERING and IPSEC_INTERCONNECT purposes.

networkTier string

prefixLength number

The prefix length if the resource represents an IP range.

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 this resource, which can be one of the following values.

GCE_ENDPOINT for addresses that are used by VM instances, alias IP ranges, load balancers, and similar resources.
SHARED_LOADBALANCER_VIP for an address that can be used by multiple internal load balancers.
VPC_PEERING for addresses that are reserved for VPC peer networks.
IPSEC_INTERCONNECT for addresses created from a private IP range that are reserved for a VLAN attachment in an HA VPN over Cloud Interconnect configuration. These addresses are regional resources.
PRIVATE_SERVICE_CONNECT for a private network address that is used to configure Private Service Connect. Only global internal addresses can use this purpose. This should only be set when using an Internal address.

region string

The Region in which the created address should reside. If it is not provided, the provider region is used.

selfLink string

The URI of the created resource.

subnetwork string

users string[]

The URLs of the resources that are using this address.

address str

The static external IP address represented by this resource. The IP address must be inside the specified subnetwork, if any. Set by the API if undefined.

address_type str

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.

ipv6_endpoint_type str

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

network str

The URL of the network in which to reserve the address. This field can only be used with INTERNAL type with the VPC_PEERING and IPSEC_INTERCONNECT purposes.

network_tier str

prefix_length int

The prefix length if the resource represents an IP range.

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 this resource, which can be one of the following values.

GCE_ENDPOINT for addresses that are used by VM instances, alias IP ranges, load balancers, and similar resources.
SHARED_LOADBALANCER_VIP for an address that can be used by multiple internal load balancers.
VPC_PEERING for addresses that are reserved for VPC peer networks.
IPSEC_INTERCONNECT for addresses created from a private IP range that are reserved for a VLAN attachment in an HA VPN over Cloud Interconnect configuration. These addresses are regional resources.
PRIVATE_SERVICE_CONNECT for a private network address that is used to configure Private Service Connect. Only global internal addresses can use this purpose. This should only be set when using an Internal address.

region str

The Region in which the created address should reside. If it is not provided, the provider region is used.

self_link str

The URI of the created resource.

subnetwork str

users Sequence[str]

The URLs of the resources that are using this address.

address String

The static external IP address represented by this resource. The IP address must be inside the specified subnetwork, if any. Set by the API if undefined.

addressType String

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.

ipv6EndpointType String

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

network String

The URL of the network in which to reserve the address. This field can only be used with INTERNAL type with the VPC_PEERING and IPSEC_INTERCONNECT purposes.

networkTier String

prefixLength Number

The prefix length if the resource represents an IP range.

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 this resource, which can be one of the following values.

GCE_ENDPOINT for addresses that are used by VM instances, alias IP ranges, load balancers, and similar resources.
SHARED_LOADBALANCER_VIP for an address that can be used by multiple internal load balancers.
VPC_PEERING for addresses that are reserved for VPC peer networks.
IPSEC_INTERCONNECT for addresses created from a private IP range that are reserved for a VLAN attachment in an HA VPN over Cloud Interconnect configuration. These addresses are regional resources.
PRIVATE_SERVICE_CONNECT for a private network address that is used to configure Private Service Connect. Only global internal addresses can use this purpose. This should only be set when using an Internal address.

region String

The Region in which the created address should reside. If it is not provided, the provider region is used.

selfLink String

The URI of the created resource.

subnetwork String

users List<String>

The URLs of the resources that are using this address.

Import

Address can be imported using any of these accepted formats:

projects/{{project}}/regions/{{region}}/addresses/{{name}}
{{project}}/{{region}}/{{name}}
{{region}}/{{name}}
{{name}}

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

$ pulumi import gcp:compute/address:Address default projects/{{project}}/regions/{{region}}/addresses/{{name}}

$ pulumi import gcp:compute/address:Address default {{project}}/{{region}}/{{name}}

$ pulumi import gcp:compute/address:Address default {{region}}/{{name}}

$ pulumi import gcp:compute/address:Address 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.

Google Cloud v8.21.0 published on Wednesday, Mar 5, 2025 by Pulumi

pulumi/pulumi-gcp

gcp.compute.Address

On this page

On this page

Example Usage

Address Basic

Address With Subnetwork

Address With Gce Endpoint

Instance With Ip

Compute Address Ipsec Interconnect

Create Address Resource

Constructor syntax

Parameters

Constructor example

Address Resource Properties

Inputs

Outputs

Look up Existing Address Resource

Import

Package Details

On this page

On this page