2015-10-30 20:14:36 +00:00
---
2018-04-30 21:27:45 +00:00
# ----------------------------------------------------------------------------
#
# *** AUTO GENERATED CODE *** AUTO GENERATED CODE ***
#
# ----------------------------------------------------------------------------
#
# This file is automatically generated by Magic Modules and manual
# changes will be clobbered when the file is regenerated.
#
# Please read more about how to change this file in
# .github/CONTRIBUTING.md.
#
# ----------------------------------------------------------------------------
2015-10-30 20:14:36 +00:00
layout: "google"
page_title: "Google: google_compute_global_address"
sidebar_current: "docs-google-compute-global-address"
description: |-
2018-04-27 21:53:45 +00:00
Represents a Global Address resource.
2015-10-30 20:14:36 +00:00
---
# google\_compute\_global\_address
2018-04-27 21:53:45 +00:00
Represents a Global Address resource. Global addresses are used for
HTTP(S) load balancing.
2018-10-04 02:45:53 +00:00
2018-04-27 21:53:45 +00:00
To get more information about GlobalAddress, see:
2015-10-30 20:14:36 +00:00
2018-04-27 21:53:45 +00:00
* [API documentation ](https://cloud.google.com/compute/docs/reference/latest/globalAddresses )
* How-to Guides
* [Reserving a Static External IP Address ](https://cloud.google.com/compute/docs/ip-addresses/reserve-static-external-ip-address )
2015-10-30 20:14:36 +00:00
## Example Usage
2017-04-17 10:17:54 +00:00
```hcl
2015-10-30 20:14:36 +00:00
resource "google_compute_global_address" "default" {
2017-06-16 17:53:36 +00:00
name = "global-appserver-ip"
2015-10-30 20:14:36 +00:00
}
```
## Argument Reference
The following arguments are supported:
2018-07-10 22:42:50 +00:00
2018-04-27 21:53:45 +00:00
* `name` -
(Required)
Name of the resource. Provided by the client when the resource is
2018-05-11 22:25:06 +00:00
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]([-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.
2018-04-27 21:53:45 +00:00
2018-08-20 23:46:13 +00:00
2016-04-10 21:34:15 +00:00
- - -
2018-07-10 22:42:50 +00:00
2018-04-27 21:53:45 +00:00
* `description` -
(Optional)
An optional description of this resource.
2018-05-11 22:25:06 +00:00
Provide this property when you create the resource.
2018-07-10 22:42:50 +00:00
2018-07-25 20:25:16 +00:00
* `labels` -
(Optional)
2018-10-04 02:45:53 +00:00
Labels to apply to this address. A list of key->value pairs. This property is in beta, and should be used with the terraform-provider-google-beta provider.
See [Provider Versions ](http://terraform.io/docs/provider/google/provider_versions.html ) for more details on beta fields.
2018-07-25 20:25:16 +00:00
2018-04-27 21:53:45 +00:00
* `ip_version` -
(Optional)
The IP Version that will be used by this address. Valid options are
2018-05-11 22:25:06 +00:00
IPV4 or IPV6. The default value is IPV4.
2018-09-21 16:43:45 +00:00
* `prefix_length` -
(Optional)
The prefix length of the IP range. If not present, it means the
address field is a single IP address.
2018-10-04 02:45:53 +00:00
This field is not applicable to addresses with addressType=EXTERNAL. This property is in beta, and should be used with the terraform-provider-google-beta provider.
See [Provider Versions ](http://terraform.io/docs/provider/google/provider_versions.html ) for more details on beta fields.
2018-09-21 16:43:45 +00:00
* `address_type` -
(Optional)
The type of the address to reserve, default is EXTERNAL.
* EXTERNAL indicates public/external single IP address.
2018-10-04 16:51:57 +00:00
* INTERNAL indicates internal IP ranges belonging to some network.
2018-09-21 16:43:45 +00:00
* `purpose` -
(Optional)
The purpose of the resource. For global internal addresses it can be
* VPC_PEERING - for peer networks
2018-10-04 02:45:53 +00:00
This should only be set when using an Internal address. This property is in beta, and should be used with the terraform-provider-google-beta provider.
See [Provider Versions ](http://terraform.io/docs/provider/google/provider_versions.html ) for more details on beta fields.
2018-09-21 16:43:45 +00:00
* `network` -
(Optional)
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.
2018-10-04 02:45:53 +00:00
This should only be set when using an Internal address. This property is in beta, and should be used with the terraform-provider-google-beta provider.
See [Provider Versions ](http://terraform.io/docs/provider/google/provider_versions.html ) for more details on beta fields.
2018-08-16 05:59:44 +00:00
* `project` - (Optional) The ID of the project in which the resource belongs.
2018-04-27 21:53:45 +00:00
If it is not provided, the provider project is used.
2016-04-10 21:34:15 +00:00
2017-08-04 17:53:43 +00:00
2015-10-30 20:14:36 +00:00
## Attributes Reference
2018-04-27 21:53:45 +00:00
In addition to the arguments listed above, the following computed attributes are exported:
2015-10-30 20:14:36 +00:00
2018-07-10 22:42:50 +00:00
2018-04-27 21:53:45 +00:00
* `address` -
The static external IP address represented by this resource.
2018-07-10 22:42:50 +00:00
2018-04-27 21:53:45 +00:00
* `creation_timestamp` -
Creation timestamp in RFC3339 text format.
2018-07-25 20:25:16 +00:00
* `label_fingerprint` -
The fingerprint used for optimistic locking of this resource. Used
internally during updates.
2015-10-30 20:14:36 +00:00
* `self_link` - The URI of the created resource.
2017-06-16 17:53:36 +00:00
2018-04-27 21:53:45 +00:00
## Timeouts
This resource provides the following
[Timeouts ](/docs/configuration/resources.html#timeouts ) configuration options:
- `create` - Default is 4 minutes.
2018-07-25 20:25:16 +00:00
- `update` - Default is 4 minutes.
2018-04-27 21:53:45 +00:00
- `delete` - Default is 4 minutes.
2017-06-16 17:53:36 +00:00
## Import
2018-04-27 21:53:45 +00:00
GlobalAddress can be imported using any of these accepted formats:
2017-06-16 17:53:36 +00:00
```
2018-04-27 21:53:45 +00:00
$ terraform import google_compute_global_address.default projects/{{project}}/global/addresses/{{name}}
$ terraform import google_compute_global_address.default {{project}}/{{name}}
$ terraform import google_compute_global_address.default {{name}}
2017-06-16 17:53:36 +00:00
```