Route

Represents a Route resource.

A route is a rule that specifies how certain packets should be handled by the virtual network. Routes are associated with virtual machines by tag, and the set of routes for a particular virtual machine is called its routing table. For each packet leaving a virtual machine, the system searches that virtual machine’s routing table for a single best matching route.

Routes match packets by destination IP address, preferring smaller or more specific ranges over larger ones. If there is a tie, the system selects the route with the smallest priority value. If there is still a tie, it uses the layer three and four packet headers to select just one of the remaining matching routes. The packet is then forwarded as specified by the next_hop field of the winning route – either to another virtual machine destination, a virtual machine gateway or a Compute Engine-operated gateway. Packets that do not match any route in the sending virtual machine’s routing table will be dropped.

A Route resource must have exactly one specification of either nextHopGateway, nextHopInstance, nextHopIp, nextHopVpnTunnel, or nextHopIlb.

To get more information about Route, see:

API documentation
How-to Guides
- Using Routes

Create a Route Resource

new Route(name: string, args: RouteArgs, opts?: CustomResourceOptions);

def Route(resource_name, opts=None, description=None, dest_range=None, name=None, network=None, next_hop_gateway=None, next_hop_ilb=None, next_hop_instance=None, next_hop_instance_zone=None, next_hop_ip=None, next_hop_vpn_tunnel=None, priority=None, project=None, tags=None, __props__=None);

func NewRoute(ctx *Context, name string, args RouteArgs, opts ...ResourceOption) (*Route, error)

public Route(string name, RouteArgs args, CustomResourceOptions? opts = null)

name string: The unique name of the resource.
args RouteArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

resource_name str: The unique name of the resource.
opts ResourceOptions: A bag of options that control this resource's behavior.

ctx Context: Context object for the current deployment.
name string: The unique name of the resource.
args RouteArgs: The arguments to resource properties.
opts ResourceOption: Bag of options to control resource's behavior.

name string: The unique name of the resource.
args RouteArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

Route Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Programming Model docs.

Inputs

The Route resource accepts the following input properties:

DestRange string: The destination range of outgoing packets that this route applies to. Only IPv4 is supported.
Network string: The network that this route applies to.
Description string: An optional description of this resource. Provide this property when you create the resource.
Name string: Name of the resource. Provided by the client when the resource is 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? 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.
NextHopGateway string: URL to a gateway that should handle matching packets. Currently, you can only specify the internet gateway, using a full or partial valid URL: * https://www.googleapis.com/compute/v1/projects/project/global/gateways/default-internet-gateway * projects/project/global/gateways/default-internet-gateway * global/gateways/default-internet-gateway * The string default-internet-gateway.
NextHopIlb string: The URL to a forwarding rule of type loadBalancingScheme=INTERNAL that should handle matching packets. You can only specify the forwarding rule as a partial or full URL. For example, the following are all valid URLs: https://www.googleapis.com/compute/v1/projects/project/regions/region/forwardingRules/forwardingRule regions/region/forwardingRules/forwardingRule Note that this can only be used when the destinationRange is a public (non-RFC 1918) IP CIDR range.
NextHopInstance string: URL to an instance that should handle matching packets. You can specify this as a full or partial URL. For example: * https://www.googleapis.com/compute/v1/projects/project/zones/zone/instances/instance * projects/project/zones/zone/instances/instance * zones/zone/instances/instance * Just the instance name, with the zone in next_hop_instance_zone.
NextHopInstanceZone string: (Optional when next_hop_instance is specified) The zone of the instance specified in next_hop_instance. Omit if next_hop_instance is specified as a URL.
NextHopIp string: Network IP address of an instance that should handle matching packets.
NextHopVpnTunnel string: URL to a VpnTunnel that should handle matching packets.
Priority int: The priority of this route. Priority is used to break ties in cases where there is more than one matching route of equal prefix length. In the case of two routes with equal prefix length, the one with the lowest-numbered priority value wins. Default value is 1000. Valid range is 0 through 65535.
Project string: The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
Tags List<string>: A list of instance tags to which this route applies.

DestRange string: The destination range of outgoing packets that this route applies to. Only IPv4 is supported.
Network string: The network that this route applies to.
Description string: An optional description of this resource. Provide this property when you create the resource.
Name string: Name of the resource. Provided by the client when the resource is 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? 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.
NextHopGateway string: URL to a gateway that should handle matching packets. Currently, you can only specify the internet gateway, using a full or partial valid URL: * https://www.googleapis.com/compute/v1/projects/project/global/gateways/default-internet-gateway * projects/project/global/gateways/default-internet-gateway * global/gateways/default-internet-gateway * The string default-internet-gateway.
NextHopIlb string: The URL to a forwarding rule of type loadBalancingScheme=INTERNAL that should handle matching packets. You can only specify the forwarding rule as a partial or full URL. For example, the following are all valid URLs: https://www.googleapis.com/compute/v1/projects/project/regions/region/forwardingRules/forwardingRule regions/region/forwardingRules/forwardingRule Note that this can only be used when the destinationRange is a public (non-RFC 1918) IP CIDR range.
NextHopInstance string: URL to an instance that should handle matching packets. You can specify this as a full or partial URL. For example: * https://www.googleapis.com/compute/v1/projects/project/zones/zone/instances/instance * projects/project/zones/zone/instances/instance * zones/zone/instances/instance * Just the instance name, with the zone in next_hop_instance_zone.
NextHopInstanceZone string: (Optional when next_hop_instance is specified) The zone of the instance specified in next_hop_instance. Omit if next_hop_instance is specified as a URL.
NextHopIp string: Network IP address of an instance that should handle matching packets.
NextHopVpnTunnel string: URL to a VpnTunnel that should handle matching packets.
Priority int: The priority of this route. Priority is used to break ties in cases where there is more than one matching route of equal prefix length. In the case of two routes with equal prefix length, the one with the lowest-numbered priority value wins. Default value is 1000. Valid range is 0 through 65535.
Project string: The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
Tags []string: A list of instance tags to which this route applies.

destRange string: The destination range of outgoing packets that this route applies to. Only IPv4 is supported.
network string: The network that this route applies to.
description string: An optional description of this resource. Provide this property when you create the resource.
name string: Name of the resource. Provided by the client when the resource is 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? 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.
nextHopGateway string: URL to a gateway that should handle matching packets. Currently, you can only specify the internet gateway, using a full or partial valid URL: * https://www.googleapis.com/compute/v1/projects/project/global/gateways/default-internet-gateway * projects/project/global/gateways/default-internet-gateway * global/gateways/default-internet-gateway * The string default-internet-gateway.
nextHopIlb string: The URL to a forwarding rule of type loadBalancingScheme=INTERNAL that should handle matching packets. You can only specify the forwarding rule as a partial or full URL. For example, the following are all valid URLs: https://www.googleapis.com/compute/v1/projects/project/regions/region/forwardingRules/forwardingRule regions/region/forwardingRules/forwardingRule Note that this can only be used when the destinationRange is a public (non-RFC 1918) IP CIDR range.
nextHopInstance string: URL to an instance that should handle matching packets. You can specify this as a full or partial URL. For example: * https://www.googleapis.com/compute/v1/projects/project/zones/zone/instances/instance * projects/project/zones/zone/instances/instance * zones/zone/instances/instance * Just the instance name, with the zone in next_hop_instance_zone.
nextHopInstanceZone string: (Optional when next_hop_instance is specified) The zone of the instance specified in next_hop_instance. Omit if next_hop_instance is specified as a URL.
nextHopIp string: Network IP address of an instance that should handle matching packets.
nextHopVpnTunnel string: URL to a VpnTunnel that should handle matching packets.
priority number: The priority of this route. Priority is used to break ties in cases where there is more than one matching route of equal prefix length. In the case of two routes with equal prefix length, the one with the lowest-numbered priority value wins. Default value is 1000. Valid range is 0 through 65535.
project string: The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
tags string[]: A list of instance tags to which this route applies.

dest_range str: The destination range of outgoing packets that this route applies to. Only IPv4 is supported.
network str: The network that this route applies to.
description str: An optional description of this resource. Provide this property when you create the resource.
name str: Name of the resource. Provided by the client when the resource is 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? 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.
next_hop_gateway str: URL to a gateway that should handle matching packets. Currently, you can only specify the internet gateway, using a full or partial valid URL: * https://www.googleapis.com/compute/v1/projects/project/global/gateways/default-internet-gateway * projects/project/global/gateways/default-internet-gateway * global/gateways/default-internet-gateway * The string default-internet-gateway.
next_hop_ilb str: The URL to a forwarding rule of type loadBalancingScheme=INTERNAL that should handle matching packets. You can only specify the forwarding rule as a partial or full URL. For example, the following are all valid URLs: https://www.googleapis.com/compute/v1/projects/project/regions/region/forwardingRules/forwardingRule regions/region/forwardingRules/forwardingRule Note that this can only be used when the destinationRange is a public (non-RFC 1918) IP CIDR range.
next_hop_instance str: URL to an instance that should handle matching packets. You can specify this as a full or partial URL. For example: * https://www.googleapis.com/compute/v1/projects/project/zones/zone/instances/instance * projects/project/zones/zone/instances/instance * zones/zone/instances/instance * Just the instance name, with the zone in next_hop_instance_zone.
next_hop_instance_zone str: (Optional when next_hop_instance is specified) The zone of the instance specified in next_hop_instance. Omit if next_hop_instance is specified as a URL.
next_hop_ip str: Network IP address of an instance that should handle matching packets.
next_hop_vpn_tunnel str: URL to a VpnTunnel that should handle matching packets.
priority float: The priority of this route. Priority is used to break ties in cases where there is more than one matching route of equal prefix length. In the case of two routes with equal prefix length, the one with the lowest-numbered priority value wins. Default value is 1000. Valid range is 0 through 65535.
project str: The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
tags List[str]: A list of instance tags to which this route applies.

Outputs

All input properties are implicitly available as output properties. Additionally, the Route resource produces the following output properties:

Id string: The provider-assigned unique ID for this managed resource.
NextHopNetwork string: URL to a Network that should handle matching packets.
SelfLink string: The URI of the created resource.

Id string: The provider-assigned unique ID for this managed resource.
NextHopNetwork string: URL to a Network that should handle matching packets.
SelfLink string: The URI of the created resource.

id string: The provider-assigned unique ID for this managed resource.
nextHopNetwork string: URL to a Network that should handle matching packets.
selfLink string: The URI of the created resource.

id str: The provider-assigned unique ID for this managed resource.
next_hop_network str: URL to a Network that should handle matching packets.
self_link str: The URI of the created resource.

Look up an Existing Route Resource

Get an existing Route resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

public static get(name: string, id: Input<ID>, state?: RouteState, opts?: CustomResourceOptions): Route

static get(resource_name, id, opts=None, description=None, dest_range=None, name=None, network=None, next_hop_gateway=None, next_hop_ilb=None, next_hop_instance=None, next_hop_instance_zone=None, next_hop_ip=None, next_hop_network=None, next_hop_vpn_tunnel=None, priority=None, project=None, self_link=None, tags=None, __props__=None);

func GetRoute(ctx *Context, name string, id IDInput, state *RouteState, opts ...ResourceOption) (*Route, error)

public static Route Get(string name, Input<string> id, RouteState? state, CustomResourceOptions? opts = null)

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

resource_name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

The following state arguments are supported:

Description string: An optional description of this resource. Provide this property when you create the resource.
DestRange string: The destination range of outgoing packets that this route applies to. Only IPv4 is supported.
Name string: Name of the resource. Provided by the client when the resource is 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? 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 string: The network that this route applies to.
NextHopGateway string: URL to a gateway that should handle matching packets. Currently, you can only specify the internet gateway, using a full or partial valid URL: * https://www.googleapis.com/compute/v1/projects/project/global/gateways/default-internet-gateway * projects/project/global/gateways/default-internet-gateway * global/gateways/default-internet-gateway * The string default-internet-gateway.
NextHopIlb string: The URL to a forwarding rule of type loadBalancingScheme=INTERNAL that should handle matching packets. You can only specify the forwarding rule as a partial or full URL. For example, the following are all valid URLs: https://www.googleapis.com/compute/v1/projects/project/regions/region/forwardingRules/forwardingRule regions/region/forwardingRules/forwardingRule Note that this can only be used when the destinationRange is a public (non-RFC 1918) IP CIDR range.
NextHopInstance string: URL to an instance that should handle matching packets. You can specify this as a full or partial URL. For example: * https://www.googleapis.com/compute/v1/projects/project/zones/zone/instances/instance * projects/project/zones/zone/instances/instance * zones/zone/instances/instance * Just the instance name, with the zone in next_hop_instance_zone.
NextHopInstanceZone string: (Optional when next_hop_instance is specified) The zone of the instance specified in next_hop_instance. Omit if next_hop_instance is specified as a URL.
NextHopIp string: Network IP address of an instance that should handle matching packets.
NextHopNetwork string: URL to a Network that should handle matching packets.
NextHopVpnTunnel string: URL to a VpnTunnel that should handle matching packets.
Priority int: The priority of this route. Priority is used to break ties in cases where there is more than one matching route of equal prefix length. In the case of two routes with equal prefix length, the one with the lowest-numbered priority value wins. Default value is 1000. Valid range is 0 through 65535.
Project string: The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
SelfLink string: The URI of the created resource.
Tags List<string>: A list of instance tags to which this route applies.

Description string: An optional description of this resource. Provide this property when you create the resource.
DestRange string: The destination range of outgoing packets that this route applies to. Only IPv4 is supported.
Name string: Name of the resource. Provided by the client when the resource is 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? 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 string: The network that this route applies to.
NextHopGateway string: URL to a gateway that should handle matching packets. Currently, you can only specify the internet gateway, using a full or partial valid URL: * https://www.googleapis.com/compute/v1/projects/project/global/gateways/default-internet-gateway * projects/project/global/gateways/default-internet-gateway * global/gateways/default-internet-gateway * The string default-internet-gateway.
NextHopIlb string: The URL to a forwarding rule of type loadBalancingScheme=INTERNAL that should handle matching packets. You can only specify the forwarding rule as a partial or full URL. For example, the following are all valid URLs: https://www.googleapis.com/compute/v1/projects/project/regions/region/forwardingRules/forwardingRule regions/region/forwardingRules/forwardingRule Note that this can only be used when the destinationRange is a public (non-RFC 1918) IP CIDR range.
NextHopInstance string: URL to an instance that should handle matching packets. You can specify this as a full or partial URL. For example: * https://www.googleapis.com/compute/v1/projects/project/zones/zone/instances/instance * projects/project/zones/zone/instances/instance * zones/zone/instances/instance * Just the instance name, with the zone in next_hop_instance_zone.
NextHopInstanceZone string: (Optional when next_hop_instance is specified) The zone of the instance specified in next_hop_instance. Omit if next_hop_instance is specified as a URL.
NextHopIp string: Network IP address of an instance that should handle matching packets.
NextHopNetwork string: URL to a Network that should handle matching packets.
NextHopVpnTunnel string: URL to a VpnTunnel that should handle matching packets.
Priority int: The priority of this route. Priority is used to break ties in cases where there is more than one matching route of equal prefix length. In the case of two routes with equal prefix length, the one with the lowest-numbered priority value wins. Default value is 1000. Valid range is 0 through 65535.
Project string: The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
SelfLink string: The URI of the created resource.
Tags []string: A list of instance tags to which this route applies.

description string: An optional description of this resource. Provide this property when you create the resource.
destRange string: The destination range of outgoing packets that this route applies to. Only IPv4 is supported.
name string: Name of the resource. Provided by the client when the resource is 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? 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 string: The network that this route applies to.
nextHopGateway string: URL to a gateway that should handle matching packets. Currently, you can only specify the internet gateway, using a full or partial valid URL: * https://www.googleapis.com/compute/v1/projects/project/global/gateways/default-internet-gateway * projects/project/global/gateways/default-internet-gateway * global/gateways/default-internet-gateway * The string default-internet-gateway.
nextHopIlb string: The URL to a forwarding rule of type loadBalancingScheme=INTERNAL that should handle matching packets. You can only specify the forwarding rule as a partial or full URL. For example, the following are all valid URLs: https://www.googleapis.com/compute/v1/projects/project/regions/region/forwardingRules/forwardingRule regions/region/forwardingRules/forwardingRule Note that this can only be used when the destinationRange is a public (non-RFC 1918) IP CIDR range.
nextHopInstance string: URL to an instance that should handle matching packets. You can specify this as a full or partial URL. For example: * https://www.googleapis.com/compute/v1/projects/project/zones/zone/instances/instance * projects/project/zones/zone/instances/instance * zones/zone/instances/instance * Just the instance name, with the zone in next_hop_instance_zone.
nextHopInstanceZone string: (Optional when next_hop_instance is specified) The zone of the instance specified in next_hop_instance. Omit if next_hop_instance is specified as a URL.
nextHopIp string: Network IP address of an instance that should handle matching packets.
nextHopNetwork string: URL to a Network that should handle matching packets.
nextHopVpnTunnel string: URL to a VpnTunnel that should handle matching packets.
priority number: The priority of this route. Priority is used to break ties in cases where there is more than one matching route of equal prefix length. In the case of two routes with equal prefix length, the one with the lowest-numbered priority value wins. Default value is 1000. Valid range is 0 through 65535.
project string: The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
selfLink string: The URI of the created resource.
tags string[]: A list of instance tags to which this route applies.

description str: An optional description of this resource. Provide this property when you create the resource.
dest_range str: The destination range of outgoing packets that this route applies to. Only IPv4 is supported.
name str: Name of the resource. Provided by the client when the resource is 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? 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 str: The network that this route applies to.
next_hop_gateway str: URL to a gateway that should handle matching packets. Currently, you can only specify the internet gateway, using a full or partial valid URL: * https://www.googleapis.com/compute/v1/projects/project/global/gateways/default-internet-gateway * projects/project/global/gateways/default-internet-gateway * global/gateways/default-internet-gateway * The string default-internet-gateway.
next_hop_ilb str: The URL to a forwarding rule of type loadBalancingScheme=INTERNAL that should handle matching packets. You can only specify the forwarding rule as a partial or full URL. For example, the following are all valid URLs: https://www.googleapis.com/compute/v1/projects/project/regions/region/forwardingRules/forwardingRule regions/region/forwardingRules/forwardingRule Note that this can only be used when the destinationRange is a public (non-RFC 1918) IP CIDR range.
next_hop_instance str: URL to an instance that should handle matching packets. You can specify this as a full or partial URL. For example: * https://www.googleapis.com/compute/v1/projects/project/zones/zone/instances/instance * projects/project/zones/zone/instances/instance * zones/zone/instances/instance * Just the instance name, with the zone in next_hop_instance_zone.
next_hop_instance_zone str: (Optional when next_hop_instance is specified) The zone of the instance specified in next_hop_instance. Omit if next_hop_instance is specified as a URL.
next_hop_ip str: Network IP address of an instance that should handle matching packets.
next_hop_network str: URL to a Network that should handle matching packets.
next_hop_vpn_tunnel str: URL to a VpnTunnel that should handle matching packets.
priority float: The priority of this route. Priority is used to break ties in cases where there is more than one matching route of equal prefix length. In the case of two routes with equal prefix length, the one with the lowest-numbered priority value wins. Default value is 1000. Valid range is 0 through 65535.
project str: The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
self_link str: The URI of the created resource.
tags List[str]: A list of instance tags to which this route applies.

Package Details

Repository: https://github.com/pulumi/pulumi-gcp
License: Apache-2.0
Notes: This Pulumi package is based on the google-beta Terraform Provider.

The Pulumi Platform

Get Started

Migrate to Pulumi

Solutions for All Teams and Engineers

Any Code

Any Cloud