---
title: Getting Started with Datadog
description: Datadog, the leading service for cloud-scale monitoring.
breadcrumbs: Docs > Infrastructure > Datadog Resource Catalog
---

# gcp_compute_subnetwork{% #gcp_compute_subnetwork %}

## `ancestors`{% #ancestors %}

**Type**: `UNORDERED_LIST_STRING`

## `creation_timestamp`{% #creation_timestamp %}

**Type**: `TIMESTAMP`**Provider name**: `creationTimestamp`**Description**: [Output Only] Creation timestamp in RFC3339 text format.

## `description`{% #description %}

**Type**: `STRING`**Provider name**: `description`**Description**: An optional description of this resource. Provide this property when you create the resource. This field can be set only at resource creation time.

## `enable_flow_logs`{% #enable_flow_logs %}

**Type**: `BOOLEAN`**Provider name**: `enableFlowLogs`**Description**: Whether to enable flow logging for this subnetwork. If this field is not explicitly set, it will not appear in get listings. If not set the default behavior is determined by the org policy, if there is no org policy specified, then it will default to disabled. This field isn't supported if the subnet purpose field is set to REGIONAL_MANAGED_PROXY.

## `external_ipv6_prefix`{% #external_ipv6_prefix %}

**Type**: `STRING`**Provider name**: `externalIpv6Prefix`**Description**: The external IPv6 address range that is owned by this subnetwork.

## `gateway_address`{% #gateway_address %}

**Type**: `STRING`**Provider name**: `gatewayAddress`**Description**: [Output Only] The gateway address for default routes to reach destination addresses outside this subnetwork.

## `id`{% #id %}

**Type**: `STRING`**Provider name**: `id`**Description**: [Output Only] The unique identifier for the resource. This identifier is defined by the server.

## `internal_ipv6_prefix`{% #internal_ipv6_prefix %}

**Type**: `STRING`**Provider name**: `internalIpv6Prefix`**Description**: The internal IPv6 address range that is owned by this subnetwork.

## `ip_cidr_range`{% #ip_cidr_range %}

**Type**: `STRING`**Provider name**: `ipCidrRange`**Description**: The range of internal addresses that are owned by this subnetwork. Provide this property when you create the subnetwork. For example, 10.0.0.0/8 or 100.64.0.0/10. Ranges must be unique and non-overlapping within a network. Only IPv4 is supported. This field is set at resource creation time. The range can be any range listed in the Valid ranges list. The range can be expanded after creation using expandIpCidrRange.

## `ip_collection`{% #ip_collection %}

**Type**: `STRING`**Provider name**: `ipCollection`**Description**: Reference to the source of IP, like a PublicDelegatedPrefix (PDP) for BYOIP. The PDP must be a sub-PDP in EXTERNAL_IPV6_SUBNETWORK_CREATION mode. Use one of the following formats to specify a sub-PDP when creating a dual stack subnetwork with external access using BYOIP: - Full resource URL, as in [https://www.googleapis.com/compute/v1/projects/projectId/regions/region](https://www.googleapis.com/compute/v1/projects/projectId/regions/region) /publicDelegatedPrefixes/sub-pdp-name - Partial URL, as in - projects/projectId/regions/region/publicDelegatedPrefixes/ sub-pdp-name - regions/region/publicDelegatedPrefixes/sub-pdp-name

## `ipv6_access_type`{% #ipv6_access_type %}

**Type**: `STRING`**Provider name**: `ipv6AccessType`**Description**: The access type of IPv6 address this subnet holds. It's immutable and can only be specified during creation or the first time the subnet is updated into IPV4_IPV6 dual stack.**Possible values**:

- `EXTERNAL` - VMs on this subnet will be assigned IPv6 addresses that are accessible via the Internet, as well as the VPC network.
- `INTERNAL` - VMs on this subnet will be assigned IPv6 addresses that are only accessible over the VPC network.

## `ipv6_cidr_range`{% #ipv6_cidr_range %}

**Type**: `STRING`**Provider name**: `ipv6CidrRange`**Description**: [Output Only] This field is for internal use.

## `ipv6_gce_endpoint`{% #ipv6_gce_endpoint %}

**Type**: `STRING`**Provider name**: `ipv6GceEndpoint`**Description**: [Output Only] Possible endpoints of this subnetwork. It can be one of the following: - VM_ONLY: The subnetwork can be used for creating instances and IPv6 addresses with VM endpoint type. Such a subnetwork gets external IPv6 ranges from a public delegated prefix and cannot be used to create NetLb. - VM_AND_FR: The subnetwork can be used for creating both VM instances and Forwarding Rules. It can also be used to reserve IPv6 addresses with both VM and FR endpoint types. Such a subnetwork gets its IPv6 range from Google IP Pool directly.**Possible values**:

- `VM_AND_FR`
- `VM_ONLY`

## `kind`{% #kind %}

**Type**: `STRING`**Provider name**: `kind`**Description**: [Output Only] Type of the resource. Always compute#subnetwork for Subnetwork resources.

## `labels`{% #labels %}

**Type**: `UNORDERED_LIST_STRING`

## `log_config`{% #log_config %}

**Type**: `STRUCT`**Provider name**: `logConfig`**Description**: This field denotes the VPC flow logging options for this subnetwork. If logging is enabled, logs are exported to Cloud Logging.

- `aggregation_interval`**Type**: `STRING`**Provider name**: `aggregationInterval`**Description**: Can only be specified if VPC flow logging for this subnetwork is enabled. Toggles the aggregation interval for collecting flow logs. Increasing the interval time will reduce the amount of generated flow logs for long lasting connections. Default is an interval of 5 seconds per connection.**Possible values**:
  - `INTERVAL_10_MIN`
  - `INTERVAL_15_MIN`
  - `INTERVAL_1_MIN`
  - `INTERVAL_30_SEC`
  - `INTERVAL_5_MIN`
  - `INTERVAL_5_SEC`
- `enable`**Type**: `BOOLEAN`**Provider name**: `enable`**Description**: Whether to enable flow logging for this subnetwork. If this field is not explicitly set, it will not appear in get listings. If not set the default behavior is determined by the org policy, if there is no org policy specified, then it will default to disabled. Flow logging isn't supported if the subnet purpose field is set to REGIONAL_MANAGED_PROXY.
- `filter_expr`**Type**: `STRING`**Provider name**: `filterExpr`**Description**: Can only be specified if VPC flow logs for this subnetwork is enabled. The filter expression is used to define which VPC flow logs should be exported to Cloud Logging.
- `flow_sampling`**Type**: `FLOAT`**Provider name**: `flowSampling`**Description**: Can only be specified if VPC flow logging for this subnetwork is enabled. The value of the field must be in [0, 1]. Set the sampling rate of VPC flow logs within the subnetwork where 1.0 means all collected logs are reported and 0.0 means no logs are reported. Default is 0.5 unless otherwise specified by the org policy, which means half of all collected logs are reported.
- `metadata`**Type**: `STRING`**Provider name**: `metadata`**Description**: Can only be specified if VPC flow logs for this subnetwork is enabled. Configures whether all, none or a subset of metadata fields should be added to the reported VPC flow logs. Default is EXCLUDE_ALL_METADATA.**Possible values**:
  - `CUSTOM_METADATA`
  - `EXCLUDE_ALL_METADATA`
  - `INCLUDE_ALL_METADATA`
- `metadata_fields`**Type**: `UNORDERED_LIST_STRING`**Provider name**: `metadataFields`**Description**: Can only be specified if VPC flow logs for this subnetwork is enabled and "metadata" was set to CUSTOM_METADATA.

## `name`{% #name %}

**Type**: `STRING`**Provider name**: `name`**Description**: The name of the resource, provided by the client when initially creating 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.

## `network`{% #network %}

**Type**: `STRING`**Provider name**: `network`**Description**: The URL of the network to which this subnetwork belongs, provided by the client when initially creating the subnetwork. This field can be set only at resource creation time.

## `organization_id`{% #organization_id %}

**Type**: `STRING`

## `parent`{% #parent %}

**Type**: `STRING`

## `private_ip_google_access`{% #private_ip_google_access %}

**Type**: `BOOLEAN`**Provider name**: `privateIpGoogleAccess`**Description**: Whether the VMs in this subnet can access Google services without assigned external IP addresses. This field can be both set at resource creation time and updated using setPrivateIpGoogleAccess.

## `private_ipv6_google_access`{% #private_ipv6_google_access %}

**Type**: `STRING`**Provider name**: `privateIpv6GoogleAccess`**Description**: This field is for internal use. This field can be both set at resource creation time and updated using patch.**Possible values**:

- `DISABLE_GOOGLE_ACCESS` - Disable private IPv6 access to/from Google services.
- `ENABLE_BIDIRECTIONAL_ACCESS_TO_GOOGLE` - Bidirectional private IPv6 access to/from Google services.
- `ENABLE_OUTBOUND_VM_ACCESS_TO_GOOGLE` - Outbound private IPv6 access from VMs in this subnet to Google services.

## `project_id`{% #project_id %}

**Type**: `STRING`

## `project_number`{% #project_number %}

**Type**: `STRING`

## `purpose`{% #purpose %}

**Type**: `STRING`**Provider name**: `purpose`

## `region`{% #region %}

**Type**: `STRING`**Provider name**: `region`**Description**: URL of the region where the Subnetwork resides. This field can be set only at resource creation time.

## `region_id`{% #region_id %}

**Type**: `STRING`

## `reserved_internal_range`{% #reserved_internal_range %}

**Type**: `STRING`**Provider name**: `reservedInternalRange`**Description**: The URL of the reserved internal range.

## `resource_name`{% #resource_name %}

**Type**: `STRING`

## `role`{% #role %}

**Type**: `STRING`**Provider name**: `role`**Description**: The role of subnetwork. Currently, this field is only used when purpose is set to GLOBAL_MANAGED_PROXY or REGIONAL_MANAGED_PROXY. The value can be set to ACTIVE or BACKUP. An ACTIVE subnetwork is one that is currently being used for Envoy-based load balancers in a region. A BACKUP subnetwork is one that is ready to be promoted to ACTIVE or is currently draining. This field can be updated with a patch request.**Possible values**:

- `ACTIVE` - The ACTIVE subnet that is currently used.
- `BACKUP` - The BACKUP subnet that could be promoted to ACTIVE.

## `secondary_ip_ranges`{% #secondary_ip_ranges %}

**Type**: `UNORDERED_LIST_STRUCT`**Provider name**: `secondaryIpRanges`**Description**: An array of configurations for secondary IP ranges for VM instances contained in this subnetwork. The primary IP of such VM must belong to the primary ipCidrRange of the subnetwork. The alias IPs may belong to either primary or secondary ranges. This field can be updated with a patch request.

- `ip_cidr_range`**Type**: `STRING`**Provider name**: `ipCidrRange`**Description**: The range of IP addresses belonging to this subnetwork secondary range. Provide this property when you create the subnetwork. Ranges must be unique and non-overlapping with all primary and secondary IP ranges within a network. Only IPv4 is supported. The range can be any range listed in the Valid ranges list.
- `range_name`**Type**: `STRING`**Provider name**: `rangeName`**Description**: The name associated with this subnetwork secondary range, used when adding an alias IP range to a VM instance. The name must be 1-63 characters long, and comply with RFC1035. The name must be unique within the subnetwork.
- `reserved_internal_range`**Type**: `STRING`**Provider name**: `reservedInternalRange`**Description**: The URL of the reserved internal range.

## `self_link`{% #self_link %}

**Type**: `STRING`**Provider name**: `selfLink`**Description**: [Output Only] Server-defined URL for the resource.

## `stack_type`{% #stack_type %}

**Type**: `STRING`**Provider name**: `stackType`**Description**: The stack type for the subnet. If set to IPV4_ONLY, new VMs in the subnet are assigned IPv4 addresses only. If set to IPV4_IPV6, new VMs in the subnet can be assigned both IPv4 and IPv6 addresses. If not specified, IPV4_ONLY is used. This field can be both set at resource creation time and updated using patch.**Possible values**:

- `IPV4_IPV6` - New VMs in this subnet can have both IPv4 and IPv6 addresses.
- `IPV4_ONLY` - New VMs in this subnet will only be assigned IPv4 addresses.
- `IPV6_ONLY` - New VMs in this subnet will only be assigned IPv6 addresses.

## `state`{% #state %}

**Type**: `STRING`**Provider name**: `state`**Description**: [Output Only] The state of the subnetwork, which can be one of the following values: READY: Subnetwork is created and ready to use DRAINING: only applicable to subnetworks that have the purpose set to INTERNAL_HTTPS_LOAD_BALANCER and indicates that connections to the load balancer are being drained. A subnetwork that is draining cannot be used or modified until it reaches a status of READY**Possible values**:

- `DRAINING` - Subnetwork is being drained.
- `READY` - Subnetwork is ready for use.

## `tags`{% #tags %}

**Type**: `UNORDERED_LIST_STRING`

## `zone_id`{% #zone_id %}

**Type**: `STRING`