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

# gcp_networkconnectivity_policy_based_route{% #gcp_networkconnectivity_policy_based_route %}

## `ancestors`{% #ancestors %}

**Type**: `UNORDERED_LIST_STRING`

## `create_time`{% #create_time %}

**Type**: `TIMESTAMP`**Provider name**: `createTime`**Description**: Output only. Time when the policy-based route was created.

## `description`{% #description %}

**Type**: `STRING`**Provider name**: `description`**Description**: Optional. An optional description of this resource. Provide this field when you create the resource.

## `filter`{% #filter %}

**Type**: `STRUCT`**Provider name**: `filter`**Description**: Required. The filter to match L4 traffic.

- `dest_range`**Type**: `STRING`**Provider name**: `destRange`**Description**: Optional. The destination IP range of outgoing packets that this policy-based route applies to. Default is "0.0.0.0/0" if protocol version is IPv4.
- `ip_protocol`**Type**: `STRING`**Provider name**: `ipProtocol`**Description**: Optional. The IP protocol that this policy-based route applies to. Valid values are 'TCP', 'UDP', and 'ALL'. Default is 'ALL'.
- `protocol_version`**Type**: `STRING`**Provider name**: `protocolVersion`**Description**: Required. Internet protocol versions this policy-based route applies to. For this version, only IPV4 is supported. IPV6 is supported in preview.**Possible values**:
  - `PROTOCOL_VERSION_UNSPECIFIED` - Default value.
  - `IPV4` - The PBR is for IPv4 internet protocol traffic.
- `src_range`**Type**: `STRING`**Provider name**: `srcRange`**Description**: Optional. The source IP range of outgoing packets that this policy-based route applies to. Default is "0.0.0.0/0" if protocol version is IPv4.

## `interconnect_attachment`{% #interconnect_attachment %}

**Type**: `STRUCT`**Provider name**: `interconnectAttachment`**Description**: Optional. The interconnect attachments that this policy-based route applies to.

- `region`**Type**: `STRING`**Provider name**: `region`**Description**: Optional. Cloud region to install this policy-based route on interconnect attachment. Use `all` to install it on all interconnect attachments.

## `kind`{% #kind %}

**Type**: `STRING`**Provider name**: `kind`**Description**: Output only. Type of this resource. Always networkconnectivity#policyBasedRoute for policy-based Route resources.

## `labels`{% #labels %}

**Type**: `UNORDERED_LIST_STRING`

## `name`{% #name %}

**Type**: `STRING`**Provider name**: `name`**Description**: Immutable. A unique name of the resource in the form of `projects/{project_number}/locations/global/PolicyBasedRoutes/{policy_based_route_id}`

## `network`{% #network %}

**Type**: `STRING`**Provider name**: `network`**Description**: Required. Fully-qualified URL of the network that this route applies to, for example: projects/my-project/global/networks/my-network.

## `next_hop_ilb_ip`{% #next_hop_ilb_ip %}

**Type**: `STRING`**Provider name**: `nextHopIlbIp`**Description**: Optional. The IP address of a global-access-enabled L4 ILB that is the next hop for matching packets. For this version, only nextHopIlbIp is supported.

## `next_hop_other_routes`{% #next_hop_other_routes %}

**Type**: `STRING`**Provider name**: `nextHopOtherRoutes`**Description**: Optional. Other routes that will be referenced to determine the next hop of the packet.**Possible values**:

- `OTHER_ROUTES_UNSPECIFIED` - Default value.
- `DEFAULT_ROUTING` - Use the routes from the default routing tables (system-generated routes, custom routes, peering route) to determine the next hop. This effectively excludes matching packets being applied on other PBRs with a lower priority.

## `organization_id`{% #organization_id %}

**Type**: `STRING`

## `parent`{% #parent %}

**Type**: `STRING`

## `priority`{% #priority %}

**Type**: `INT32`**Provider name**: `priority`**Description**: Optional. The priority of this policy-based route. Priority is used to break ties in cases where there are more than one matching policy-based routes found. In cases where multiple policy-based routes are matched, the one with the lowest-numbered priority value wins. The default value is 1000. The priority value must be from 1 to 65535, inclusive.

## `project_id`{% #project_id %}

**Type**: `STRING`

## `project_number`{% #project_number %}

**Type**: `STRING`

## `region_id`{% #region_id %}

**Type**: `STRING`

## `resource_name`{% #resource_name %}

**Type**: `STRING`

## `self_link`{% #self_link %}

**Type**: `STRING`**Provider name**: `selfLink`**Description**: Output only. Server-defined fully-qualified URL for this resource.

## `tags`{% #tags %}

**Type**: `UNORDERED_LIST_STRING`

## `update_time`{% #update_time %}

**Type**: `TIMESTAMP`**Provider name**: `updateTime`**Description**: Output only. Time when the policy-based route was updated.

## `virtual_machine`{% #virtual_machine %}

**Type**: `STRUCT`**Provider name**: `virtualMachine`**Description**: Optional. VM instances that this policy-based route applies to.

## `warnings`{% #warnings %}

**Type**: `UNORDERED_LIST_STRUCT`**Provider name**: `warnings`**Description**: Output only. If potential misconfigurations are detected for this route, this field will be populated with warning messages.

- `code`**Type**: `STRING`**Provider name**: `code`**Description**: Output only. A warning code, if applicable.**Possible values**:
  - `WARNING_UNSPECIFIED` - Default value.
  - `RESOURCE_NOT_ACTIVE` - The policy-based route is not active and functioning. Common causes are that the dependent network was deleted or the resource project was turned off.
  - `RESOURCE_BEING_MODIFIED` - The policy-based route is being modified (e.g. created/deleted) at this time.
- `warning_message`**Type**: `STRING`**Provider name**: `warningMessage`**Description**: Output only. A human-readable description of the warning code.

## `zone_id`{% #zone_id %}

**Type**: `STRING`