1. Packages
  2. Google Cloud (GCP) Classic
  3. API Docs
  4. compute
  5. Route
Google Cloud Classic v7.2.1 published on Wednesday, Nov 22, 2023 by Pulumi

gcp.compute.Route

Explore with Pulumi AI

gcp logo
Google Cloud Classic v7.2.1 published on Wednesday, Nov 22, 2023 by Pulumi

    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:

    Example Usage

    Route Basic

    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Gcp = Pulumi.Gcp;
    
    return await Deployment.RunAsync(() => 
    {
        var defaultNetwork = new Gcp.Compute.Network("defaultNetwork");
    
        var defaultRoute = new Gcp.Compute.Route("defaultRoute", new()
        {
            DestRange = "15.0.0.0/24",
            Network = defaultNetwork.Name,
            NextHopIp = "10.132.1.5",
            Priority = 100,
        });
    
    });
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-gcp/sdk/v7/go/gcp/compute"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		defaultNetwork, err := compute.NewNetwork(ctx, "defaultNetwork", nil)
    		if err != nil {
    			return err
    		}
    		_, err = compute.NewRoute(ctx, "defaultRoute", &compute.RouteArgs{
    			DestRange: pulumi.String("15.0.0.0/24"),
    			Network:   defaultNetwork.Name,
    			NextHopIp: pulumi.String("10.132.1.5"),
    			Priority:  pulumi.Int(100),
    		})
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.gcp.compute.Network;
    import com.pulumi.gcp.compute.Route;
    import com.pulumi.gcp.compute.RouteArgs;
    import java.util.List;
    import java.util.ArrayList;
    import java.util.Map;
    import java.io.File;
    import java.nio.file.Files;
    import java.nio.file.Paths;
    
    public class App {
        public static void main(String[] args) {
            Pulumi.run(App::stack);
        }
    
        public static void stack(Context ctx) {
            var defaultNetwork = new Network("defaultNetwork");
    
            var defaultRoute = new Route("defaultRoute", RouteArgs.builder()        
                .destRange("15.0.0.0/24")
                .network(defaultNetwork.name())
                .nextHopIp("10.132.1.5")
                .priority(100)
                .build());
    
        }
    }
    
    import pulumi
    import pulumi_gcp as gcp
    
    default_network = gcp.compute.Network("defaultNetwork")
    default_route = gcp.compute.Route("defaultRoute",
        dest_range="15.0.0.0/24",
        network=default_network.name,
        next_hop_ip="10.132.1.5",
        priority=100)
    
    import * as pulumi from "@pulumi/pulumi";
    import * as gcp from "@pulumi/gcp";
    
    const defaultNetwork = new gcp.compute.Network("defaultNetwork", {});
    const defaultRoute = new gcp.compute.Route("defaultRoute", {
        destRange: "15.0.0.0/24",
        network: defaultNetwork.name,
        nextHopIp: "10.132.1.5",
        priority: 100,
    });
    
    resources:
      defaultRoute:
        type: gcp:compute:Route
        properties:
          destRange: 15.0.0.0/24
          network: ${defaultNetwork.name}
          nextHopIp: 10.132.1.5
          priority: 100
      defaultNetwork:
        type: gcp:compute:Network
    

    Route Ilb

    Coming soon!

    Coming soon!

    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.gcp.compute.Network;
    import com.pulumi.gcp.compute.NetworkArgs;
    import com.pulumi.gcp.compute.Subnetwork;
    import com.pulumi.gcp.compute.SubnetworkArgs;
    import com.pulumi.gcp.compute.HealthCheck;
    import com.pulumi.gcp.compute.HealthCheckArgs;
    import com.pulumi.gcp.compute.inputs.HealthCheckTcpHealthCheckArgs;
    import com.pulumi.gcp.compute.RegionBackendService;
    import com.pulumi.gcp.compute.RegionBackendServiceArgs;
    import com.pulumi.gcp.compute.ForwardingRule;
    import com.pulumi.gcp.compute.ForwardingRuleArgs;
    import com.pulumi.gcp.compute.Route;
    import com.pulumi.gcp.compute.RouteArgs;
    import java.util.List;
    import java.util.ArrayList;
    import java.util.Map;
    import java.io.File;
    import java.nio.file.Files;
    import java.nio.file.Paths;
    
    public class App {
        public static void main(String[] args) {
            Pulumi.run(App::stack);
        }
    
        public static void stack(Context ctx) {
            var defaultNetwork = new Network("defaultNetwork", NetworkArgs.builder()        
                .autoCreateSubnetworks(false)
                .build());
    
            var defaultSubnetwork = new Subnetwork("defaultSubnetwork", SubnetworkArgs.builder()        
                .ipCidrRange("10.0.1.0/24")
                .region("us-central1")
                .network(defaultNetwork.id())
                .build());
    
            var hc = new HealthCheck("hc", HealthCheckArgs.builder()        
                .checkIntervalSec(1)
                .timeoutSec(1)
                .tcpHealthCheck(HealthCheckTcpHealthCheckArgs.builder()
                    .port("80")
                    .build())
                .build());
    
            var backend = new RegionBackendService("backend", RegionBackendServiceArgs.builder()        
                .region("us-central1")
                .healthChecks(hc.id())
                .build());
    
            var defaultForwardingRule = new ForwardingRule("defaultForwardingRule", ForwardingRuleArgs.builder()        
                .region("us-central1")
                .loadBalancingScheme("INTERNAL")
                .backendService(backend.id())
                .allPorts(true)
                .network(defaultNetwork.name())
                .subnetwork(defaultSubnetwork.name())
                .build());
    
            var route_ilb = new Route("route-ilb", RouteArgs.builder()        
                .destRange("0.0.0.0/0")
                .network(defaultNetwork.name())
                .nextHopIlb(defaultForwardingRule.id())
                .priority(2000)
                .build());
    
        }
    }
    

    Coming soon!

    Coming soon!

    resources:
      defaultNetwork:
        type: gcp:compute:Network
        properties:
          autoCreateSubnetworks: false
      defaultSubnetwork:
        type: gcp:compute:Subnetwork
        properties:
          ipCidrRange: 10.0.1.0/24
          region: us-central1
          network: ${defaultNetwork.id}
      hc:
        type: gcp:compute:HealthCheck
        properties:
          checkIntervalSec: 1
          timeoutSec: 1
          tcpHealthCheck:
            port: '80'
      backend:
        type: gcp:compute:RegionBackendService
        properties:
          region: us-central1
          healthChecks:
            - ${hc.id}
      defaultForwardingRule:
        type: gcp:compute:ForwardingRule
        properties:
          region: us-central1
          loadBalancingScheme: INTERNAL
          backendService: ${backend.id}
          allPorts: true
          network: ${defaultNetwork.name}
          subnetwork: ${defaultSubnetwork.name}
      route-ilb:
        type: gcp:compute:Route
        properties:
          destRange: 0.0.0.0/0
          network: ${defaultNetwork.name}
          nextHopIlb: ${defaultForwardingRule.id}
          priority: 2000
    

    Route Ilb Vip

    Coming soon!

    Coming soon!

    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.gcp.compute.Network;
    import com.pulumi.gcp.compute.NetworkArgs;
    import com.pulumi.gcp.compute.Subnetwork;
    import com.pulumi.gcp.compute.SubnetworkArgs;
    import com.pulumi.gcp.compute.NetworkPeering;
    import com.pulumi.gcp.compute.NetworkPeeringArgs;
    import com.pulumi.gcp.compute.HealthCheck;
    import com.pulumi.gcp.compute.HealthCheckArgs;
    import com.pulumi.gcp.compute.inputs.HealthCheckTcpHealthCheckArgs;
    import com.pulumi.gcp.compute.RegionBackendService;
    import com.pulumi.gcp.compute.RegionBackendServiceArgs;
    import com.pulumi.gcp.compute.ForwardingRule;
    import com.pulumi.gcp.compute.ForwardingRuleArgs;
    import com.pulumi.gcp.compute.Route;
    import com.pulumi.gcp.compute.RouteArgs;
    import com.pulumi.resources.CustomResourceOptions;
    import java.util.List;
    import java.util.ArrayList;
    import java.util.Map;
    import java.io.File;
    import java.nio.file.Files;
    import java.nio.file.Paths;
    
    public class App {
        public static void main(String[] args) {
            Pulumi.run(App::stack);
        }
    
        public static void stack(Context ctx) {
            var producerNetwork = new Network("producerNetwork", NetworkArgs.builder()        
                .autoCreateSubnetworks(false)
                .build(), CustomResourceOptions.builder()
                    .provider(google_beta)
                    .build());
    
            var producerSubnetwork = new Subnetwork("producerSubnetwork", SubnetworkArgs.builder()        
                .ipCidrRange("10.0.1.0/24")
                .region("us-central1")
                .network(producerNetwork.id())
                .build(), CustomResourceOptions.builder()
                    .provider(google_beta)
                    .build());
    
            var consumerNetwork = new Network("consumerNetwork", NetworkArgs.builder()        
                .autoCreateSubnetworks(false)
                .build(), CustomResourceOptions.builder()
                    .provider(google_beta)
                    .build());
    
            var consumerSubnetwork = new Subnetwork("consumerSubnetwork", SubnetworkArgs.builder()        
                .ipCidrRange("10.0.2.0/24")
                .region("us-central1")
                .network(consumerNetwork.id())
                .build(), CustomResourceOptions.builder()
                    .provider(google_beta)
                    .build());
    
            var peering1 = new NetworkPeering("peering1", NetworkPeeringArgs.builder()        
                .network(consumerNetwork.id())
                .peerNetwork(producerNetwork.id())
                .build(), CustomResourceOptions.builder()
                    .provider(google_beta)
                    .build());
    
            var peering2 = new NetworkPeering("peering2", NetworkPeeringArgs.builder()        
                .network(producerNetwork.id())
                .peerNetwork(consumerNetwork.id())
                .build(), CustomResourceOptions.builder()
                    .provider(google_beta)
                    .build());
    
            var hc = new HealthCheck("hc", HealthCheckArgs.builder()        
                .checkIntervalSec(1)
                .timeoutSec(1)
                .tcpHealthCheck(HealthCheckTcpHealthCheckArgs.builder()
                    .port("80")
                    .build())
                .build(), CustomResourceOptions.builder()
                    .provider(google_beta)
                    .build());
    
            var backend = new RegionBackendService("backend", RegionBackendServiceArgs.builder()        
                .region("us-central1")
                .healthChecks(hc.id())
                .build(), CustomResourceOptions.builder()
                    .provider(google_beta)
                    .build());
    
            var default_ = new ForwardingRule("default", ForwardingRuleArgs.builder()        
                .region("us-central1")
                .loadBalancingScheme("INTERNAL")
                .backendService(backend.id())
                .allPorts(true)
                .network(producerNetwork.name())
                .subnetwork(producerSubnetwork.name())
                .build(), CustomResourceOptions.builder()
                    .provider(google_beta)
                    .build());
    
            var route_ilb = new Route("route-ilb", RouteArgs.builder()        
                .destRange("0.0.0.0/0")
                .network(consumerNetwork.name())
                .nextHopIlb(default_.ipAddress())
                .priority(2000)
                .tags(            
                    "tag1",
                    "tag2")
                .build(), CustomResourceOptions.builder()
                    .provider(google_beta)
                    .dependsOn(                
                        peering1,
                        peering2)
                    .build());
    
        }
    }
    

    Coming soon!

    Coming soon!

    resources:
      producerNetwork:
        type: gcp:compute:Network
        properties:
          autoCreateSubnetworks: false
        options:
          provider: ${["google-beta"]}
      producerSubnetwork:
        type: gcp:compute:Subnetwork
        properties:
          ipCidrRange: 10.0.1.0/24
          region: us-central1
          network: ${producerNetwork.id}
        options:
          provider: ${["google-beta"]}
      consumerNetwork:
        type: gcp:compute:Network
        properties:
          autoCreateSubnetworks: false
        options:
          provider: ${["google-beta"]}
      consumerSubnetwork:
        type: gcp:compute:Subnetwork
        properties:
          ipCidrRange: 10.0.2.0/24
          region: us-central1
          network: ${consumerNetwork.id}
        options:
          provider: ${["google-beta"]}
      peering1:
        type: gcp:compute:NetworkPeering
        properties:
          network: ${consumerNetwork.id}
          peerNetwork: ${producerNetwork.id}
        options:
          provider: ${["google-beta"]}
      peering2:
        type: gcp:compute:NetworkPeering
        properties:
          network: ${producerNetwork.id}
          peerNetwork: ${consumerNetwork.id}
        options:
          provider: ${["google-beta"]}
      hc:
        type: gcp:compute:HealthCheck
        properties:
          checkIntervalSec: 1
          timeoutSec: 1
          tcpHealthCheck:
            port: '80'
        options:
          provider: ${["google-beta"]}
      backend:
        type: gcp:compute:RegionBackendService
        properties:
          region: us-central1
          healthChecks:
            - ${hc.id}
        options:
          provider: ${["google-beta"]}
      default:
        type: gcp:compute:ForwardingRule
        properties:
          region: us-central1
          loadBalancingScheme: INTERNAL
          backendService: ${backend.id}
          allPorts: true
          network: ${producerNetwork.name}
          subnetwork: ${producerSubnetwork.name}
        options:
          provider: ${["google-beta"]}
      route-ilb:
        type: gcp:compute:Route
        properties:
          destRange: 0.0.0.0/0
          network: ${consumerNetwork.name}
          nextHopIlb: ${default.ipAddress}
          priority: 2000
          tags:
            - tag1
            - tag2
        options:
          provider: ${["google-beta"]}
          dependson:
            - ${peering1}
            - ${peering2}
    

    Create Route Resource

    new Route(name: string, args: RouteArgs, opts?: CustomResourceOptions);
    @overload
    def Route(resource_name: str,
              opts: Optional[ResourceOptions] = None,
              description: Optional[str] = None,
              dest_range: Optional[str] = None,
              name: Optional[str] = None,
              network: Optional[str] = None,
              next_hop_gateway: Optional[str] = None,
              next_hop_ilb: Optional[str] = None,
              next_hop_instance: Optional[str] = None,
              next_hop_instance_zone: Optional[str] = None,
              next_hop_ip: Optional[str] = None,
              next_hop_vpn_tunnel: Optional[str] = None,
              priority: Optional[int] = None,
              project: Optional[str] = None,
              tags: Optional[Sequence[str]] = None)
    @overload
    def Route(resource_name: str,
              args: RouteArgs,
              opts: Optional[ResourceOptions] = None)
    func NewRoute(ctx *Context, name string, args RouteArgs, opts ...ResourceOption) (*Route, error)
    public Route(string name, RouteArgs args, CustomResourceOptions? opts = null)
    public Route(String name, RouteArgs args)
    public Route(String name, RouteArgs args, CustomResourceOptions options)
    
    type: gcp:compute:Route
    properties: # The arguments to resource properties.
    options: # 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.
    resource_name str
    The unique name of the resource.
    args RouteArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control 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.
    name String
    The unique name of the resource.
    args RouteArgs
    The arguments to resource properties.
    options 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 Architecture and Concepts 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 IP address or URL to a forwarding rule of type loadBalancingScheme=INTERNAL that should handle matching packets. With the GA provider you can only specify the forwarding rule as a partial or full URL. For example, the following are all valid values:

    • 10.128.0.56
    • https://www.googleapis.com/compute/v1/projects/project/regions/region/forwardingRules/forwardingRule
    • regions/region/forwardingRules/forwardingRule When the beta provider, you can also specify the IP address of a forwarding rule from the same VPC or any peered VPC. 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 IP address or URL to a forwarding rule of type loadBalancingScheme=INTERNAL that should handle matching packets. With the GA provider you can only specify the forwarding rule as a partial or full URL. For example, the following are all valid values:

    • 10.128.0.56
    • https://www.googleapis.com/compute/v1/projects/project/regions/region/forwardingRules/forwardingRule
    • regions/region/forwardingRules/forwardingRule When the beta provider, you can also specify the IP address of a forwarding rule from the same VPC or any peered VPC. 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 IP address or URL to a forwarding rule of type loadBalancingScheme=INTERNAL that should handle matching packets. With the GA provider you can only specify the forwarding rule as a partial or full URL. For example, the following are all valid values:

    • 10.128.0.56
    • https://www.googleapis.com/compute/v1/projects/project/regions/region/forwardingRules/forwardingRule
    • regions/region/forwardingRules/forwardingRule When the beta provider, you can also specify the IP address of a forwarding rule from the same VPC or any peered VPC. 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 Integer

    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 IP address or URL to a forwarding rule of type loadBalancingScheme=INTERNAL that should handle matching packets. With the GA provider you can only specify the forwarding rule as a partial or full URL. For example, the following are all valid values:

    • 10.128.0.56
    • https://www.googleapis.com/compute/v1/projects/project/regions/region/forwardingRules/forwardingRule
    • regions/region/forwardingRules/forwardingRule When the beta provider, you can also specify the IP address of a forwarding rule from the same VPC or any peered VPC. 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 IP address or URL to a forwarding rule of type loadBalancingScheme=INTERNAL that should handle matching packets. With the GA provider you can only specify the forwarding rule as a partial or full URL. For example, the following are all valid values:

    • 10.128.0.56
    • https://www.googleapis.com/compute/v1/projects/project/regions/region/forwardingRules/forwardingRule
    • regions/region/forwardingRules/forwardingRule When the beta provider, you can also specify the IP address of a forwarding rule from the same VPC or any peered VPC. 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 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 str

    The ID of the project in which the resource belongs. If it is not provided, the provider project is used.

    tags Sequence[str]

    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 IP address or URL to a forwarding rule of type loadBalancingScheme=INTERNAL that should handle matching packets. With the GA provider you can only specify the forwarding rule as a partial or full URL. For example, the following are all valid values:

    • 10.128.0.56
    • https://www.googleapis.com/compute/v1/projects/project/regions/region/forwardingRules/forwardingRule
    • regions/region/forwardingRules/forwardingRule When the beta provider, you can also specify the IP address of a forwarding rule from the same VPC or any peered VPC. 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 List<String>

    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 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.

    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.

    Look up 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
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            description: Optional[str] = None,
            dest_range: Optional[str] = None,
            name: Optional[str] = None,
            network: Optional[str] = None,
            next_hop_gateway: Optional[str] = None,
            next_hop_ilb: Optional[str] = None,
            next_hop_instance: Optional[str] = None,
            next_hop_instance_zone: Optional[str] = None,
            next_hop_ip: Optional[str] = None,
            next_hop_network: Optional[str] = None,
            next_hop_vpn_tunnel: Optional[str] = None,
            priority: Optional[int] = None,
            project: Optional[str] = None,
            self_link: Optional[str] = None,
            tags: Optional[Sequence[str]] = None) -> Route
    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)
    public static Route get(String name, Output<String> id, RouteState state, CustomResourceOptions options)
    Resource lookup is not supported in YAML
    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.
    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 IP address or URL to a forwarding rule of type loadBalancingScheme=INTERNAL that should handle matching packets. With the GA provider you can only specify the forwarding rule as a partial or full URL. For example, the following are all valid values:

    • 10.128.0.56
    • https://www.googleapis.com/compute/v1/projects/project/regions/region/forwardingRules/forwardingRule
    • regions/region/forwardingRules/forwardingRule When the beta provider, you can also specify the IP address of a forwarding rule from the same VPC or any peered VPC. 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 IP address or URL to a forwarding rule of type loadBalancingScheme=INTERNAL that should handle matching packets. With the GA provider you can only specify the forwarding rule as a partial or full URL. For example, the following are all valid values:

    • 10.128.0.56
    • https://www.googleapis.com/compute/v1/projects/project/regions/region/forwardingRules/forwardingRule
    • regions/region/forwardingRules/forwardingRule When the beta provider, you can also specify the IP address of a forwarding rule from the same VPC or any peered VPC. 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 IP address or URL to a forwarding rule of type loadBalancingScheme=INTERNAL that should handle matching packets. With the GA provider you can only specify the forwarding rule as a partial or full URL. For example, the following are all valid values:

    • 10.128.0.56
    • https://www.googleapis.com/compute/v1/projects/project/regions/region/forwardingRules/forwardingRule
    • regions/region/forwardingRules/forwardingRule When the beta provider, you can also specify the IP address of a forwarding rule from the same VPC or any peered VPC. 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 Integer

    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 IP address or URL to a forwarding rule of type loadBalancingScheme=INTERNAL that should handle matching packets. With the GA provider you can only specify the forwarding rule as a partial or full URL. For example, the following are all valid values:

    • 10.128.0.56
    • https://www.googleapis.com/compute/v1/projects/project/regions/region/forwardingRules/forwardingRule
    • regions/region/forwardingRules/forwardingRule When the beta provider, you can also specify the IP address of a forwarding rule from the same VPC or any peered VPC. 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 IP address or URL to a forwarding rule of type loadBalancingScheme=INTERNAL that should handle matching packets. With the GA provider you can only specify the forwarding rule as a partial or full URL. For example, the following are all valid values:

    • 10.128.0.56
    • https://www.googleapis.com/compute/v1/projects/project/regions/region/forwardingRules/forwardingRule
    • regions/region/forwardingRules/forwardingRule When the beta provider, you can also specify the IP address of a forwarding rule from the same VPC or any peered VPC. 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 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 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 Sequence[str]

    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 IP address or URL to a forwarding rule of type loadBalancingScheme=INTERNAL that should handle matching packets. With the GA provider you can only specify the forwarding rule as a partial or full URL. For example, the following are all valid values:

    • 10.128.0.56
    • https://www.googleapis.com/compute/v1/projects/project/regions/region/forwardingRules/forwardingRule
    • regions/region/forwardingRules/forwardingRule When the beta provider, you can also specify the IP address of a forwarding rule from the same VPC or any peered VPC. 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 List<String>

    A list of instance tags to which this route applies.

    Import

    Route can be imported using any of these accepted formats* projects/{{project}}/global/routes/{{name}} * {{project}}/{{name}} * {{name}} In Terraform v1.5.0 and later, use an import block to import Route using one of the formats above. For exampletf import {

    id = “projects/{{project}}/global/routes/{{name}}”

    to = google_compute_route.default }

     $ pulumi import gcp:compute/route:Route When using the [`terraform import` command](https://developer.hashicorp.com/terraform/cli/commands/import), Route can be imported using one of the formats above. For example
    
     $ pulumi import gcp:compute/route:Route default projects/{{project}}/global/routes/{{name}}
    
     $ pulumi import gcp:compute/route:Route default {{project}}/{{name}}
    
     $ pulumi import gcp:compute/route:Route default {{name}}
    

    Package Details

    Repository
    Google Cloud (GCP) Classic pulumi/pulumi-gcp
    License
    Apache-2.0
    Notes

    This Pulumi package is based on the google-beta Terraform Provider.

    gcp logo
    Google Cloud Classic v7.2.1 published on Wednesday, Nov 22, 2023 by Pulumi