Represents an Address resource.
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:
resource "google_compute_address" "ip_address" {
name = "my-address"
}
resource "google_compute_network" "default" {
name = "my-network"
}
resource "google_compute_subnetwork" "default" {
name = "my-subnet"
ip_cidr_range = "10.0.0.0/16"
region = "us-central1"
network = google_compute_network.default.id
}
resource "google_compute_address" "internal_with_subnet_and_address" {
name = "my-internal-address"
subnetwork = google_compute_subnetwork.default.id
address_type = "INTERNAL"
address = "10.0.42.42"
region = "us-central1"
}
resource "google_compute_address" "internal_with_gce_endpoint" {
name = "my-internal-address-"
address_type = "INTERNAL"
purpose = "GCE_ENDPOINT"
}
resource "google_compute_address" "static" {
name = "ipv4-address"
}
data "google_compute_image" "debian_image" {
family = "debian-11"
project = "debian-cloud"
}
resource "google_compute_instance" "instance_with_ip" {
name = "vm-instance"
machine_type = "f1-micro"
zone = "us-central1-a"
boot_disk {
initialize_params {
image = data.google_compute_image.debian_image.self_link
}
}
network_interface {
network = "default"
access_config {
nat_ip = google_compute_address.static.address
}
}
}
resource "google_compute_address" "ipsec-interconnect-address" {
name = "test-address"
address_type = "INTERNAL"
purpose = "IPSEC_INTERCONNECT"
address = "192.168.1.0"
prefix_length = 29
network = google_compute_network.network.self_link
}
resource "google_compute_network" "network" {
name = "test-network"
auto_create_subnetworks = false
}
The following arguments are supported:
name
-
(Required)
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]([-a-z0-9]*[a-z0-9])?
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.address
-
(Optional)
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
-
(Optional)
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
-
(Optional)
An optional description of this resource.
purpose
-
(Optional)
The purpose of this resource, which can be one of the following values.
This should only be set when using an Internal address.
network_tier
-
(Optional)
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
.
subnetwork
-
(Optional)
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.
labels
-
(Optional)
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.
network
-
(Optional)
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.
prefix_length
-
(Optional)
The prefix length if the resource represents an IP range.
ip_version
-
(Optional)
The IP Version that will be used by this address. The default value is IPV4
.
Possible values are: IPV4
, IPV6
.
ipv6_endpoint_type
-
(Optional)
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
.
region
-
(Optional)
The Region in which the created address should reside.
If it is not provided, the provider region is used.
project
- (Optional) The ID of the project in which the resource belongs.
If it is not provided, the provider project is used.
In addition to the arguments listed above, the following computed attributes are exported:
id
- an identifier for the resource with format projects/{{project}}/regions/{{region}}/addresses/{{name}}
creation_timestamp
-
Creation timestamp in RFC3339 text format.
users
-
The URLs of the resources that are using this address.
label_fingerprint
-
The fingerprint used for optimistic locking of this resource. Used
internally during updates.
terraform_labels
-
The combination of labels configured directly on the resource
and default labels configured on the provider.
effective_labels
-
All of labels (key/value pairs) present on the resource in GCP, including the labels configured through Terraform, other clients and services.
self_link
- The URI of the created resource.This resource provides the following Timeouts configuration options:
create
- Default is 20 minutes.update
- Default is 20 minutes.delete
- Default is 20 minutes.Address can be imported using any of these accepted formats:
projects/{{project}}/regions/{{region}}/addresses/{{name}}
{{project}}/{{region}}/{{name}}
{{region}}/{{name}}
{{name}}
In Terraform v1.5.0 and later, use an import
block to import Address using one of the formats above. For example:
import {
id = "projects/{{project}}/regions/{{region}}/addresses/{{name}}"
to = google_compute_address.default
}
When using the terraform import
command, Address can be imported using one of the formats above. For example:
$ terraform import google_compute_address.default projects/{{project}}/regions/{{region}}/addresses/{{name}}
$ terraform import google_compute_address.default {{project}}/{{region}}/{{name}}
$ terraform import google_compute_address.default {{region}}/{{name}}
$ terraform import google_compute_address.default {{name}}
This resource supports User Project Overrides.