| --- |
| subcategory: "Compute Engine" |
| description: |- |
| Get a subnetwork within GCE. |
| --- |
| |
| # google_compute_subnetwork |
| |
| Get a subnetwork within GCE from its name and region. |
| |
| ## Example Usage |
| |
| ```hcl |
| data "google_compute_subnetwork" "my-subnetwork" { |
| name = "default-us-east1" |
| region = "us-east1" |
| } |
| ``` |
| |
| ## Argument Reference |
| |
| The following arguments are supported: |
| |
| * `self_link` - (Optional) The self link of the subnetwork. If `self_link` is |
| specified, `name`, `project`, and `region` are ignored. |
| |
| * `name` - (Optional) The name of the subnetwork. One of `name` or `self_link` |
| must be specified. |
| |
| * `project` - (Optional) The ID of the project in which the resource belongs. If it |
| is not provided, the provider project is used. |
| |
| * `region` - (Optional) The region this subnetwork has been created in. If |
| unspecified, this defaults to the region configured in the provider. |
| |
| ## Attributes Reference |
| |
| In addition to the arguments listed above, the following attributes are exported: |
| |
| * `network` - The network name or resource link to the parent |
| network of this subnetwork. |
| |
| * `description` - Description of this subnetwork. |
| |
| * `ip_cidr_range` - The IP address range that machines in this |
| network are assigned to, represented as a CIDR block. |
| |
| * `internal_ipv6_prefix` - The internal IPv6 address range that is assigned to this subnetwork. |
| |
| * `gateway_address` - The IP address of the gateway. |
| |
| * `private_ip_google_access` - Whether the VMs in this subnet |
| can access Google services without assigned external IP |
| addresses. |
| |
| * `secondary_ip_range` - An array of configurations for secondary IP ranges for |
| VM instances contained in this subnetwork. Structure is [documented below](#nested_secondary_ip_range). |
| |
| <a name="nested_secondary_ip_range"></a>The `secondary_ip_range` block supports: |
| |
| * `range_name` - The name associated with this subnetwork secondary range, used |
| when adding an alias IP range to a VM instance. |
| |
| * `ip_cidr_range` - The range of IP addresses belonging to this subnetwork |
| secondary range. |
