Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. Google Cloud (GCP) Classic
  3. API Docs
  4. compute
  5. getRouterStatus
Google Cloud Classic v8.3.1 published on Wednesday, Sep 25, 2024 by Pulumi
pulumi/pulumi-gcp

gcp.compute.getRouterStatus

Explore with Pulumi AI

gcp logo
Google Cloud Classic v8.3.1 published on Wednesday, Sep 25, 2024 by Pulumi
pulumi/pulumi-gcp

    Get a Cloud Router’s status within GCE from its name and region. This data source exposes the routes learned by a Cloud Router via BGP peers.

    For more information see the official documentation and API.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
import * as gcp from "@pulumi/gcp";

const my-router = gcp.compute.getRouterStatus({
    name: "myrouter",
});

    import pulumi
import pulumi_gcp as gcp

my_router = gcp.compute.get_router_status(name="myrouter")

    package main

import (
	"github.com/pulumi/pulumi-gcp/sdk/v8/go/gcp/compute"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := compute.GetRouterStatus(ctx, &compute.GetRouterStatusArgs{
			Name: "myrouter",
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Gcp = Pulumi.Gcp;

return await Deployment.RunAsync(() => 
{
    var my_router = Gcp.Compute.GetRouterStatus.Invoke(new()
    {
        Name = "myrouter",
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.gcp.compute.ComputeFunctions;
import com.pulumi.gcp.compute.inputs.GetRouterStatusArgs;
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) {
        final var my-router = ComputeFunctions.getRouterStatus(GetRouterStatusArgs.builder()
            .name("myrouter")
            .build());

    }
}

    variables:
  my-router:
    fn::invoke:
      Function: gcp:compute:getRouterStatus
      Arguments:
        name: myrouter

    Using getRouterStatus

    Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

    function getRouterStatus(args: GetRouterStatusArgs, opts?: InvokeOptions): Promise<GetRouterStatusResult>
function getRouterStatusOutput(args: GetRouterStatusOutputArgs, opts?: InvokeOptions): Output<GetRouterStatusResult>
    def get_router_status(name: Optional[str] = None,
                      project: Optional[str] = None,
                      region: Optional[str] = None,
                      opts: Optional[InvokeOptions] = None) -> GetRouterStatusResult
def get_router_status_output(name: Optional[pulumi.Input[str]] = None,
                      project: Optional[pulumi.Input[str]] = None,
                      region: Optional[pulumi.Input[str]] = None,
                      opts: Optional[InvokeOptions] = None) -> Output[GetRouterStatusResult]
    func GetRouterStatus(ctx *Context, args *GetRouterStatusArgs, opts ...InvokeOption) (*GetRouterStatusResult, error)
func GetRouterStatusOutput(ctx *Context, args *GetRouterStatusOutputArgs, opts ...InvokeOption) GetRouterStatusResultOutput

    > Note: This function is named GetRouterStatus in the Go SDK.

    public static class GetRouterStatus 
{
    public static Task<GetRouterStatusResult> InvokeAsync(GetRouterStatusArgs args, InvokeOptions? opts = null)
    public static Output<GetRouterStatusResult> Invoke(GetRouterStatusInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetRouterStatusResult> getRouterStatus(GetRouterStatusArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet

    fn::invoke:
  function: gcp:compute/getRouterStatus:getRouterStatus
  arguments:
    # arguments dictionary

    The following arguments are supported:

    Name string
    The name of the router.
    Project string
    The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
    Region string
    The region this router has been created in. If unspecified, this defaults to the region configured in the provider.
    Name string
    The name of the router.
    Project string
    The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
    Region string
    The region this router has been created in. If unspecified, this defaults to the region configured in the provider.
    name String
    The name of the router.
    project String
    The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
    region String
    The region this router has been created in. If unspecified, this defaults to the region configured in the provider.
    name string
    The name of the router.
    project string
    The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
    region string
    The region this router has been created in. If unspecified, this defaults to the region configured in the provider.
    name str
    The name of the router.
    project str
    The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
    region str
    The region this router has been created in. If unspecified, this defaults to the region configured in the provider.
    name String
    The name of the router.
    project String
    The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
    region String
    The region this router has been created in. If unspecified, this defaults to the region configured in the provider.

    getRouterStatus Result

    The following output properties are available:

    BestRoutes List<GetRouterStatusBestRoute>
    List of best compute#routes configurations for this router's network. See gcp.compute.Route resource for available attributes.
    BestRoutesForRouters List<GetRouterStatusBestRoutesForRouter>
    List of best compute#routes for this specific router. See gcp.compute.Route resource for available attributes.
    Id string
    The provider-assigned unique ID for this managed resource.
    Name string
    Network string
    The network name or resource link to the parent network of this subnetwork.
    Region string
    Project string
    BestRoutes []GetRouterStatusBestRoute
    List of best compute#routes configurations for this router's network. See gcp.compute.Route resource for available attributes.
    BestRoutesForRouters []GetRouterStatusBestRoutesForRouter
    List of best compute#routes for this specific router. See gcp.compute.Route resource for available attributes.
    Id string
    The provider-assigned unique ID for this managed resource.
    Name string
    Network string
    The network name or resource link to the parent network of this subnetwork.
    Region string
    Project string
    bestRoutes List<GetRouterStatusBestRoute>
    List of best compute#routes configurations for this router's network. See gcp.compute.Route resource for available attributes.
    bestRoutesForRouters List<GetRouterStatusBestRoutesForRouter>
    List of best compute#routes for this specific router. See gcp.compute.Route resource for available attributes.
    id String
    The provider-assigned unique ID for this managed resource.
    name String
    network String
    The network name or resource link to the parent network of this subnetwork.
    region String
    project String
    bestRoutes GetRouterStatusBestRoute[]
    List of best compute#routes configurations for this router's network. See gcp.compute.Route resource for available attributes.
    bestRoutesForRouters GetRouterStatusBestRoutesForRouter[]
    List of best compute#routes for this specific router. See gcp.compute.Route resource for available attributes.
    id string
    The provider-assigned unique ID for this managed resource.
    name string
    network string
    The network name or resource link to the parent network of this subnetwork.
    region string
    project string
    best_routes Sequence[GetRouterStatusBestRoute]
    List of best compute#routes configurations for this router's network. See gcp.compute.Route resource for available attributes.
    best_routes_for_routers Sequence[GetRouterStatusBestRoutesForRouter]
    List of best compute#routes for this specific router. See gcp.compute.Route resource for available attributes.
    id str
    The provider-assigned unique ID for this managed resource.
    name str
    network str
    The network name or resource link to the parent network of this subnetwork.
    region str
    project str
    bestRoutes List<Property Map>
    List of best compute#routes configurations for this router's network. See gcp.compute.Route resource for available attributes.
    bestRoutesForRouters List<Property Map>
    List of best compute#routes for this specific router. See gcp.compute.Route resource for available attributes.
    id String
    The provider-assigned unique ID for this managed resource.
    name String
    network String
    The network name or resource link to the parent network of this subnetwork.
    region String
    project String

    Supporting Types

    GetRouterStatusBestRoute

    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
    The name of the router.
    Network string
    The network name or resource link to the parent network of this subnetwork.
    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
    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
    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
    The name of the router.
    Network string
    The network name or resource link to the parent network of this subnetwork.
    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
    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
    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
    The name of the router.
    network String
    The network name or resource link to the parent network of this subnetwork.
    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
    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
    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
    The name of the router.
    network string
    The network name or resource link to the parent network of this subnetwork.
    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
    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
    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
    The name of the router.
    network str
    The network name or resource link to the parent network of this subnetwork.
    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
    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
    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
    The name of the router.
    network String
    The network name or resource link to the parent network of this subnetwork.
    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
    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
    tags List<String>
    A list of instance tags to which this route applies.

    GetRouterStatusBestRoutesForRouter

    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
    The name of the router.
    Network string
    The network name or resource link to the parent network of this subnetwork.
    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
    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
    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
    The name of the router.
    Network string
    The network name or resource link to the parent network of this subnetwork.
    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
    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
    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
    The name of the router.
    network String
    The network name or resource link to the parent network of this subnetwork.
    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
    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
    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
    The name of the router.
    network string
    The network name or resource link to the parent network of this subnetwork.
    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
    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
    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
    The name of the router.
    network str
    The network name or resource link to the parent network of this subnetwork.
    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
    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
    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
    The name of the router.
    network String
    The network name or resource link to the parent network of this subnetwork.
    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
    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
    tags List<String>
    A list of instance tags to which this route applies.

    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 v8.3.1 published on Wednesday, Sep 25, 2024 by Pulumi
    pulumi/pulumi-gcp