pulumi-gcp-kotlin/com.pulumi.gcp.compute.kotlin/Route

Route

class Route : KotlinCustomResource

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

Example Usage

Route Basic

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());
    }
}

Route Ilb

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());
    }
}

Route Ilb Vip

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());
    }
}

Import

Route can be imported using any of these accepted formats

$ 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}}

Properties

description

val description: Output<String>?

An optional description of this resource. Provide this property when you create the resource.

destRange

val destRange: Output<String>

The destination range of outgoing packets that this route applies to. Only IPv4 is supported.

val id: Output<String>

name

val name: Output<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

val network: Output<String>

The network that this route applies to.

nextHopGateway

val nextHopGateway: Output<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:

nextHopIlb

val nextHopIlb: Output<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:

nextHopInstance

val nextHopInstance: Output<String>?

URL to an instance that should handle matching packets. You can specify this as a full or partial URL. For example:

nextHopInstanceZone

val nextHopInstanceZone: Output<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

val nextHopIp: Output<String>

Network IP address of an instance that should handle matching packets.

nextHopNetwork

val nextHopNetwork: Output<String>

URL to a Network that should handle matching packets.

nextHopVpnTunnel

val nextHopVpnTunnel: Output<String>?

URL to a VpnTunnel that should handle matching packets.

priority

val priority: Output<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

val project: Output<String>

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

pulumiChildResources

val pulumiChildResources: Set<KotlinResource>

pulumiResourceName

val pulumiResourceName: String

pulumiResourceType

val pulumiResourceType: String

selfLink

val selfLink: Output<String>

The URI of the created resource.