Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Google Cloud (GCP) Classic
  3. API Docs
  4. compute
  5. getRouterStatus
Google Cloud v8.25.0 published on Thursday, Apr 3, 2025 by Pulumi
pulumi/pulumi-gcp

gcp.compute.getRouterStatus

Explore with Pulumi AI

Google Cloud v8.25.0 published on Thursday, Apr 3, 2025 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",
});
Copy
import pulumi
import pulumi_gcp as gcp

my_router = gcp.compute.get_router_status(name="myrouter")
Copy
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
	})
}
Copy
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",
    });

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

    }
}
Copy
variables:
  my-router:
    fn::invoke:
      function: gcp:compute:getRouterStatus
      arguments:
        name: myrouter
Copy

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>
Copy
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]
Copy
func GetRouterStatus(ctx *Context, args *GetRouterStatusArgs, opts ...InvokeOption) (*GetRouterStatusResult, error)
func GetRouterStatusOutput(ctx *Context, args *GetRouterStatusOutputArgs, opts ...InvokeOption) GetRouterStatusResultOutput
Copy

> 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)
}
Copy
public static CompletableFuture<GetRouterStatusResult> getRouterStatus(GetRouterStatusArgs args, InvokeOptions options)
public static Output<GetRouterStatusResult> getRouterStatus(GetRouterStatusArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: gcp:compute/getRouterStatus:getRouterStatus
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

Name This property is required. 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 This property is required. 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 This property is required. 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 This property is required. 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 This property is required. 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 This property is required. 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

AsPaths This property is required. List<GetRouterStatusBestRouteAsPath>
CreationTimestamp This property is required. string
Creation timestamp in RFC3339 text format.
Description This property is required. string
An optional description of this resource. Provide this property when you create the resource.
DestRange This property is required. string
The destination range of outgoing packets that this route applies to. Only IPv4 is supported.
Name This property is required. string
The name of the router.
Network This property is required. string
The network name or resource link to the parent network of this subnetwork.
NextHopGateway This property is required. 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'.
NextHopHub This property is required. string
The hub network that should handle matching packets, which should conform to RFC1035.
NextHopIlb This property is required. 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 This property is required. 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 This property is required. string
The zone of the instance specified in next_hop_instance. Omit if next_hop_instance is specified as a URL.
NextHopInterRegionCost This property is required. string
Internal fixed region-to-region cost that Google Cloud calculates based on factors such as network performance, distance, and available bandwidth between regions.
NextHopIp This property is required. string
Network IP address of an instance that should handle matching packets.
NextHopMed This property is required. string
Multi-Exit Discriminator, a BGP route metric that indicates the desirability of a particular route in a network.
NextHopNetwork This property is required. string
URL to a Network that should handle matching packets.
NextHopOrigin This property is required. string
Indicates the origin of the route. Can be IGP (Interior Gateway Protocol), EGP (Exterior Gateway Protocol), or INCOMPLETE.
NextHopPeering This property is required. string
The network peering name that should handle matching packets, which should conform to RFC1035.
NextHopVpnTunnel This property is required. string
URL to a VpnTunnel that should handle matching packets.
Priority This property is required. 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 This property is required. string
The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
RouteStatus This property is required. string
The status of the route, which can be one of the following values:

  • 'ACTIVE' for an active route
  • 'INACTIVE' for an inactive route
RouteType This property is required. string
The type of this route, which can be one of the following values:

  • 'TRANSIT' for a transit route that this router learned from another Cloud Router and will readvertise to one of its BGP peers
  • 'SUBNET' for a route from a subnet of the VPC
  • 'BGP' for a route learned from a BGP peer of this router
  • 'STATIC' for a static route
SelfLink This property is required. string
Tags This property is required. List<string>
A list of instance tags to which this route applies.
Warnings This property is required. List<GetRouterStatusBestRouteWarning>
If potential misconfigurations are detected for this route, this field will be populated with warning messages.
AsPaths This property is required. []GetRouterStatusBestRouteAsPath
CreationTimestamp This property is required. string
Creation timestamp in RFC3339 text format.
Description This property is required. string
An optional description of this resource. Provide this property when you create the resource.
DestRange This property is required. string
The destination range of outgoing packets that this route applies to. Only IPv4 is supported.
Name This property is required. string
The name of the router.
Network This property is required. string
The network name or resource link to the parent network of this subnetwork.
NextHopGateway This property is required. 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'.
NextHopHub This property is required. string
The hub network that should handle matching packets, which should conform to RFC1035.
NextHopIlb This property is required. 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 This property is required. 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 This property is required. string
The zone of the instance specified in next_hop_instance. Omit if next_hop_instance is specified as a URL.
NextHopInterRegionCost This property is required. string
Internal fixed region-to-region cost that Google Cloud calculates based on factors such as network performance, distance, and available bandwidth between regions.
NextHopIp This property is required. string
Network IP address of an instance that should handle matching packets.
NextHopMed This property is required. string
Multi-Exit Discriminator, a BGP route metric that indicates the desirability of a particular route in a network.
NextHopNetwork This property is required. string
URL to a Network that should handle matching packets.
NextHopOrigin This property is required. string
Indicates the origin of the route. Can be IGP (Interior Gateway Protocol), EGP (Exterior Gateway Protocol), or INCOMPLETE.
NextHopPeering This property is required. string
The network peering name that should handle matching packets, which should conform to RFC1035.
NextHopVpnTunnel This property is required. string
URL to a VpnTunnel that should handle matching packets.
Priority This property is required. 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 This property is required. string
The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
RouteStatus This property is required. string
The status of the route, which can be one of the following values:

  • 'ACTIVE' for an active route
  • 'INACTIVE' for an inactive route
RouteType This property is required. string
The type of this route, which can be one of the following values:

  • 'TRANSIT' for a transit route that this router learned from another Cloud Router and will readvertise to one of its BGP peers
  • 'SUBNET' for a route from a subnet of the VPC
  • 'BGP' for a route learned from a BGP peer of this router
  • 'STATIC' for a static route
SelfLink This property is required. string
Tags This property is required. []string
A list of instance tags to which this route applies.
Warnings This property is required. []GetRouterStatusBestRouteWarning
If potential misconfigurations are detected for this route, this field will be populated with warning messages.
asPaths This property is required. List<GetRouterStatusBestRouteAsPath>
creationTimestamp This property is required. String
Creation timestamp in RFC3339 text format.
description This property is required. String
An optional description of this resource. Provide this property when you create the resource.
destRange This property is required. String
The destination range of outgoing packets that this route applies to. Only IPv4 is supported.
name This property is required. String
The name of the router.
network This property is required. String
The network name or resource link to the parent network of this subnetwork.
nextHopGateway This property is required. 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'.
nextHopHub This property is required. String
The hub network that should handle matching packets, which should conform to RFC1035.
nextHopIlb This property is required. 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 This property is required. 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 This property is required. String
The zone of the instance specified in next_hop_instance. Omit if next_hop_instance is specified as a URL.
nextHopInterRegionCost This property is required. String
Internal fixed region-to-region cost that Google Cloud calculates based on factors such as network performance, distance, and available bandwidth between regions.
nextHopIp This property is required. String
Network IP address of an instance that should handle matching packets.
nextHopMed This property is required. String
Multi-Exit Discriminator, a BGP route metric that indicates the desirability of a particular route in a network.
nextHopNetwork This property is required. String
URL to a Network that should handle matching packets.
nextHopOrigin This property is required. String
Indicates the origin of the route. Can be IGP (Interior Gateway Protocol), EGP (Exterior Gateway Protocol), or INCOMPLETE.
nextHopPeering This property is required. String
The network peering name that should handle matching packets, which should conform to RFC1035.
nextHopVpnTunnel This property is required. String
URL to a VpnTunnel that should handle matching packets.
priority This property is required. 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 This property is required. String
The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
routeStatus This property is required. String
The status of the route, which can be one of the following values:

  • 'ACTIVE' for an active route
  • 'INACTIVE' for an inactive route
routeType This property is required. String
The type of this route, which can be one of the following values:

  • 'TRANSIT' for a transit route that this router learned from another Cloud Router and will readvertise to one of its BGP peers
  • 'SUBNET' for a route from a subnet of the VPC
  • 'BGP' for a route learned from a BGP peer of this router
  • 'STATIC' for a static route
selfLink This property is required. String
tags This property is required. List<String>
A list of instance tags to which this route applies.
warnings This property is required. List<GetRouterStatusBestRouteWarning>
If potential misconfigurations are detected for this route, this field will be populated with warning messages.
asPaths This property is required. GetRouterStatusBestRouteAsPath[]
creationTimestamp This property is required. string
Creation timestamp in RFC3339 text format.
description This property is required. string
An optional description of this resource. Provide this property when you create the resource.
destRange This property is required. string
The destination range of outgoing packets that this route applies to. Only IPv4 is supported.
name This property is required. string
The name of the router.
network This property is required. string
The network name or resource link to the parent network of this subnetwork.
nextHopGateway This property is required. 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'.
nextHopHub This property is required. string
The hub network that should handle matching packets, which should conform to RFC1035.
nextHopIlb This property is required. 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 This property is required. 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 This property is required. string
The zone of the instance specified in next_hop_instance. Omit if next_hop_instance is specified as a URL.
nextHopInterRegionCost This property is required. string
Internal fixed region-to-region cost that Google Cloud calculates based on factors such as network performance, distance, and available bandwidth between regions.
nextHopIp This property is required. string
Network IP address of an instance that should handle matching packets.
nextHopMed This property is required. string
Multi-Exit Discriminator, a BGP route metric that indicates the desirability of a particular route in a network.
nextHopNetwork This property is required. string
URL to a Network that should handle matching packets.
nextHopOrigin This property is required. string
Indicates the origin of the route. Can be IGP (Interior Gateway Protocol), EGP (Exterior Gateway Protocol), or INCOMPLETE.
nextHopPeering This property is required. string
The network peering name that should handle matching packets, which should conform to RFC1035.
nextHopVpnTunnel This property is required. string
URL to a VpnTunnel that should handle matching packets.
priority This property is required. 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 This property is required. string
The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
routeStatus This property is required. string
The status of the route, which can be one of the following values:

  • 'ACTIVE' for an active route
  • 'INACTIVE' for an inactive route
routeType This property is required. string
The type of this route, which can be one of the following values:

  • 'TRANSIT' for a transit route that this router learned from another Cloud Router and will readvertise to one of its BGP peers
  • 'SUBNET' for a route from a subnet of the VPC
  • 'BGP' for a route learned from a BGP peer of this router
  • 'STATIC' for a static route
selfLink This property is required. string
tags This property is required. string[]
A list of instance tags to which this route applies.
warnings This property is required. GetRouterStatusBestRouteWarning[]
If potential misconfigurations are detected for this route, this field will be populated with warning messages.
as_paths This property is required. Sequence[GetRouterStatusBestRouteAsPath]
creation_timestamp This property is required. str
Creation timestamp in RFC3339 text format.
description This property is required. str
An optional description of this resource. Provide this property when you create the resource.
dest_range This property is required. str
The destination range of outgoing packets that this route applies to. Only IPv4 is supported.
name This property is required. str
The name of the router.
network This property is required. str
The network name or resource link to the parent network of this subnetwork.
next_hop_gateway This property is required. 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_hub This property is required. str
The hub network that should handle matching packets, which should conform to RFC1035.
next_hop_ilb This property is required. 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 This property is required. 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 This property is required. str
The zone of the instance specified in next_hop_instance. Omit if next_hop_instance is specified as a URL.
next_hop_inter_region_cost This property is required. str
Internal fixed region-to-region cost that Google Cloud calculates based on factors such as network performance, distance, and available bandwidth between regions.
next_hop_ip This property is required. str
Network IP address of an instance that should handle matching packets.
next_hop_med This property is required. str
Multi-Exit Discriminator, a BGP route metric that indicates the desirability of a particular route in a network.
next_hop_network This property is required. str
URL to a Network that should handle matching packets.
next_hop_origin This property is required. str
Indicates the origin of the route. Can be IGP (Interior Gateway Protocol), EGP (Exterior Gateway Protocol), or INCOMPLETE.
next_hop_peering This property is required. str
The network peering name that should handle matching packets, which should conform to RFC1035.
next_hop_vpn_tunnel This property is required. str
URL to a VpnTunnel that should handle matching packets.
priority This property is required. 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 This property is required. str
The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
route_status This property is required. str
The status of the route, which can be one of the following values:

  • 'ACTIVE' for an active route
  • 'INACTIVE' for an inactive route
route_type This property is required. str
The type of this route, which can be one of the following values:

  • 'TRANSIT' for a transit route that this router learned from another Cloud Router and will readvertise to one of its BGP peers
  • 'SUBNET' for a route from a subnet of the VPC
  • 'BGP' for a route learned from a BGP peer of this router
  • 'STATIC' for a static route
self_link This property is required. str
tags This property is required. Sequence[str]
A list of instance tags to which this route applies.
warnings This property is required. Sequence[GetRouterStatusBestRouteWarning]
If potential misconfigurations are detected for this route, this field will be populated with warning messages.
asPaths This property is required. List<Property Map>
creationTimestamp This property is required. String
Creation timestamp in RFC3339 text format.
description This property is required. String
An optional description of this resource. Provide this property when you create the resource.
destRange This property is required. String
The destination range of outgoing packets that this route applies to. Only IPv4 is supported.
name This property is required. String
The name of the router.
network This property is required. String
The network name or resource link to the parent network of this subnetwork.
nextHopGateway This property is required. 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'.
nextHopHub This property is required. String
The hub network that should handle matching packets, which should conform to RFC1035.
nextHopIlb This property is required. 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 This property is required. 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 This property is required. String
The zone of the instance specified in next_hop_instance. Omit if next_hop_instance is specified as a URL.
nextHopInterRegionCost This property is required. String
Internal fixed region-to-region cost that Google Cloud calculates based on factors such as network performance, distance, and available bandwidth between regions.
nextHopIp This property is required. String
Network IP address of an instance that should handle matching packets.
nextHopMed This property is required. String
Multi-Exit Discriminator, a BGP route metric that indicates the desirability of a particular route in a network.
nextHopNetwork This property is required. String
URL to a Network that should handle matching packets.
nextHopOrigin This property is required. String
Indicates the origin of the route. Can be IGP (Interior Gateway Protocol), EGP (Exterior Gateway Protocol), or INCOMPLETE.
nextHopPeering This property is required. String
The network peering name that should handle matching packets, which should conform to RFC1035.
nextHopVpnTunnel This property is required. String
URL to a VpnTunnel that should handle matching packets.
priority This property is required. 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 This property is required. String
The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
routeStatus This property is required. String
The status of the route, which can be one of the following values:

  • 'ACTIVE' for an active route
  • 'INACTIVE' for an inactive route
routeType This property is required. String
The type of this route, which can be one of the following values:

  • 'TRANSIT' for a transit route that this router learned from another Cloud Router and will readvertise to one of its BGP peers
  • 'SUBNET' for a route from a subnet of the VPC
  • 'BGP' for a route learned from a BGP peer of this router
  • 'STATIC' for a static route
selfLink This property is required. String
tags This property is required. List<String>
A list of instance tags to which this route applies.
warnings This property is required. List<Property Map>
If potential misconfigurations are detected for this route, this field will be populated with warning messages.

GetRouterStatusBestRouteAsPath

AsLists This property is required. List<int>
The AS numbers of the AS Path.
PathSegmentType This property is required. string
The type of the AS Path, which can be one of the following values:

  • 'AS_SET': unordered set of autonomous systems that the route in has traversed
  • 'AS_SEQUENCE': ordered set of autonomous systems that the route has traversed
  • 'AS_CONFED_SEQUENCE': ordered set of Member Autonomous Systems in the local confederation that the route has traversed
  • 'AS_CONFED_SET': unordered set of Member Autonomous Systems in the local confederation that the route has traversed
AsLists This property is required. []int
The AS numbers of the AS Path.
PathSegmentType This property is required. string
The type of the AS Path, which can be one of the following values:

  • 'AS_SET': unordered set of autonomous systems that the route in has traversed
  • 'AS_SEQUENCE': ordered set of autonomous systems that the route has traversed
  • 'AS_CONFED_SEQUENCE': ordered set of Member Autonomous Systems in the local confederation that the route has traversed
  • 'AS_CONFED_SET': unordered set of Member Autonomous Systems in the local confederation that the route has traversed
asLists This property is required. List<Integer>
The AS numbers of the AS Path.
pathSegmentType This property is required. String
The type of the AS Path, which can be one of the following values:

  • 'AS_SET': unordered set of autonomous systems that the route in has traversed
  • 'AS_SEQUENCE': ordered set of autonomous systems that the route has traversed
  • 'AS_CONFED_SEQUENCE': ordered set of Member Autonomous Systems in the local confederation that the route has traversed
  • 'AS_CONFED_SET': unordered set of Member Autonomous Systems in the local confederation that the route has traversed
asLists This property is required. number[]
The AS numbers of the AS Path.
pathSegmentType This property is required. string
The type of the AS Path, which can be one of the following values:

  • 'AS_SET': unordered set of autonomous systems that the route in has traversed
  • 'AS_SEQUENCE': ordered set of autonomous systems that the route has traversed
  • 'AS_CONFED_SEQUENCE': ordered set of Member Autonomous Systems in the local confederation that the route has traversed
  • 'AS_CONFED_SET': unordered set of Member Autonomous Systems in the local confederation that the route has traversed
as_lists This property is required. Sequence[int]
The AS numbers of the AS Path.
path_segment_type This property is required. str
The type of the AS Path, which can be one of the following values:

  • 'AS_SET': unordered set of autonomous systems that the route in has traversed
  • 'AS_SEQUENCE': ordered set of autonomous systems that the route has traversed
  • 'AS_CONFED_SEQUENCE': ordered set of Member Autonomous Systems in the local confederation that the route has traversed
  • 'AS_CONFED_SET': unordered set of Member Autonomous Systems in the local confederation that the route has traversed
asLists This property is required. List<Number>
The AS numbers of the AS Path.
pathSegmentType This property is required. String
The type of the AS Path, which can be one of the following values:

  • 'AS_SET': unordered set of autonomous systems that the route in has traversed
  • 'AS_SEQUENCE': ordered set of autonomous systems that the route has traversed
  • 'AS_CONFED_SEQUENCE': ordered set of Member Autonomous Systems in the local confederation that the route has traversed
  • 'AS_CONFED_SET': unordered set of Member Autonomous Systems in the local confederation that the route has traversed

GetRouterStatusBestRouteWarning

Code This property is required. string
A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
Datas This property is required. List<GetRouterStatusBestRouteWarningData>
Metadata about this warning in key: value format. For example: "data": [ { "key": "scope", "value": "zones/us-east1-d" }
Message This property is required. string
A human-readable description of the warning code.
Code This property is required. string
A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
Datas This property is required. []GetRouterStatusBestRouteWarningData
Metadata about this warning in key: value format. For example: "data": [ { "key": "scope", "value": "zones/us-east1-d" }
Message This property is required. string
A human-readable description of the warning code.
code This property is required. String
A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
datas This property is required. List<GetRouterStatusBestRouteWarningData>
Metadata about this warning in key: value format. For example: "data": [ { "key": "scope", "value": "zones/us-east1-d" }
message This property is required. String
A human-readable description of the warning code.
code This property is required. string
A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
datas This property is required. GetRouterStatusBestRouteWarningData[]
Metadata about this warning in key: value format. For example: "data": [ { "key": "scope", "value": "zones/us-east1-d" }
message This property is required. string
A human-readable description of the warning code.
code This property is required. str
A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
datas This property is required. Sequence[GetRouterStatusBestRouteWarningData]
Metadata about this warning in key: value format. For example: "data": [ { "key": "scope", "value": "zones/us-east1-d" }
message This property is required. str
A human-readable description of the warning code.
code This property is required. String
A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
datas This property is required. List<Property Map>
Metadata about this warning in key: value format. For example: "data": [ { "key": "scope", "value": "zones/us-east1-d" }
message This property is required. String
A human-readable description of the warning code.

GetRouterStatusBestRouteWarningData

Key This property is required. string
A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
Value This property is required. string
A warning data value corresponding to the key.
Key This property is required. string
A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
Value This property is required. string
A warning data value corresponding to the key.
key This property is required. String
A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
value This property is required. String
A warning data value corresponding to the key.
key This property is required. string
A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
value This property is required. string
A warning data value corresponding to the key.
key This property is required. str
A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
value This property is required. str
A warning data value corresponding to the key.
key This property is required. String
A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
value This property is required. String
A warning data value corresponding to the key.

GetRouterStatusBestRoutesForRouter

AsPaths This property is required. List<GetRouterStatusBestRoutesForRouterAsPath>
CreationTimestamp This property is required. string
Creation timestamp in RFC3339 text format.
Description This property is required. string
An optional description of this resource. Provide this property when you create the resource.
DestRange This property is required. string
The destination range of outgoing packets that this route applies to. Only IPv4 is supported.
Name This property is required. string
The name of the router.
Network This property is required. string
The network name or resource link to the parent network of this subnetwork.
NextHopGateway This property is required. 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'.
NextHopHub This property is required. string
The hub network that should handle matching packets, which should conform to RFC1035.
NextHopIlb This property is required. 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 This property is required. 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 This property is required. string
The zone of the instance specified in next_hop_instance. Omit if next_hop_instance is specified as a URL.
NextHopInterRegionCost This property is required. string
Internal fixed region-to-region cost that Google Cloud calculates based on factors such as network performance, distance, and available bandwidth between regions.
NextHopIp This property is required. string
Network IP address of an instance that should handle matching packets.
NextHopMed This property is required. string
Multi-Exit Discriminator, a BGP route metric that indicates the desirability of a particular route in a network.
NextHopNetwork This property is required. string
URL to a Network that should handle matching packets.
NextHopOrigin This property is required. string
Indicates the origin of the route. Can be IGP (Interior Gateway Protocol), EGP (Exterior Gateway Protocol), or INCOMPLETE.
NextHopPeering This property is required. string
The network peering name that should handle matching packets, which should conform to RFC1035.
NextHopVpnTunnel This property is required. string
URL to a VpnTunnel that should handle matching packets.
Priority This property is required. 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 This property is required. string
The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
RouteStatus This property is required. string
The status of the route, which can be one of the following values:

  • 'ACTIVE' for an active route
  • 'INACTIVE' for an inactive route
RouteType This property is required. string
The type of this route, which can be one of the following values:

  • 'TRANSIT' for a transit route that this router learned from another Cloud Router and will readvertise to one of its BGP peers
  • 'SUBNET' for a route from a subnet of the VPC
  • 'BGP' for a route learned from a BGP peer of this router
  • 'STATIC' for a static route
SelfLink This property is required. string
Tags This property is required. List<string>
A list of instance tags to which this route applies.
Warnings This property is required. List<GetRouterStatusBestRoutesForRouterWarning>
If potential misconfigurations are detected for this route, this field will be populated with warning messages.
AsPaths This property is required. []GetRouterStatusBestRoutesForRouterAsPath
CreationTimestamp This property is required. string
Creation timestamp in RFC3339 text format.
Description This property is required. string
An optional description of this resource. Provide this property when you create the resource.
DestRange This property is required. string
The destination range of outgoing packets that this route applies to. Only IPv4 is supported.
Name This property is required. string
The name of the router.
Network This property is required. string
The network name or resource link to the parent network of this subnetwork.
NextHopGateway This property is required. 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'.
NextHopHub This property is required. string
The hub network that should handle matching packets, which should conform to RFC1035.
NextHopIlb This property is required. 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 This property is required. 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 This property is required. string
The zone of the instance specified in next_hop_instance. Omit if next_hop_instance is specified as a URL.
NextHopInterRegionCost This property is required. string
Internal fixed region-to-region cost that Google Cloud calculates based on factors such as network performance, distance, and available bandwidth between regions.
NextHopIp This property is required. string
Network IP address of an instance that should handle matching packets.
NextHopMed This property is required. string
Multi-Exit Discriminator, a BGP route metric that indicates the desirability of a particular route in a network.
NextHopNetwork This property is required. string
URL to a Network that should handle matching packets.
NextHopOrigin This property is required. string
Indicates the origin of the route. Can be IGP (Interior Gateway Protocol), EGP (Exterior Gateway Protocol), or INCOMPLETE.
NextHopPeering This property is required. string
The network peering name that should handle matching packets, which should conform to RFC1035.
NextHopVpnTunnel This property is required. string
URL to a VpnTunnel that should handle matching packets.
Priority This property is required. 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 This property is required. string
The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
RouteStatus This property is required. string
The status of the route, which can be one of the following values:

  • 'ACTIVE' for an active route
  • 'INACTIVE' for an inactive route
RouteType This property is required. string
The type of this route, which can be one of the following values:

  • 'TRANSIT' for a transit route that this router learned from another Cloud Router and will readvertise to one of its BGP peers
  • 'SUBNET' for a route from a subnet of the VPC
  • 'BGP' for a route learned from a BGP peer of this router
  • 'STATIC' for a static route
SelfLink This property is required. string
Tags This property is required. []string
A list of instance tags to which this route applies.
Warnings This property is required. []GetRouterStatusBestRoutesForRouterWarning
If potential misconfigurations are detected for this route, this field will be populated with warning messages.
asPaths This property is required. List<GetRouterStatusBestRoutesForRouterAsPath>
creationTimestamp This property is required. String
Creation timestamp in RFC3339 text format.
description This property is required. String
An optional description of this resource. Provide this property when you create the resource.
destRange This property is required. String
The destination range of outgoing packets that this route applies to. Only IPv4 is supported.
name This property is required. String
The name of the router.
network This property is required. String
The network name or resource link to the parent network of this subnetwork.
nextHopGateway This property is required. 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'.
nextHopHub This property is required. String
The hub network that should handle matching packets, which should conform to RFC1035.
nextHopIlb This property is required. 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 This property is required. 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 This property is required. String
The zone of the instance specified in next_hop_instance. Omit if next_hop_instance is specified as a URL.
nextHopInterRegionCost This property is required. String
Internal fixed region-to-region cost that Google Cloud calculates based on factors such as network performance, distance, and available bandwidth between regions.
nextHopIp This property is required. String
Network IP address of an instance that should handle matching packets.
nextHopMed This property is required. String
Multi-Exit Discriminator, a BGP route metric that indicates the desirability of a particular route in a network.
nextHopNetwork This property is required. String
URL to a Network that should handle matching packets.
nextHopOrigin This property is required. String
Indicates the origin of the route. Can be IGP (Interior Gateway Protocol), EGP (Exterior Gateway Protocol), or INCOMPLETE.
nextHopPeering This property is required. String
The network peering name that should handle matching packets, which should conform to RFC1035.
nextHopVpnTunnel This property is required. String
URL to a VpnTunnel that should handle matching packets.
priority This property is required. 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 This property is required. String
The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
routeStatus This property is required. String
The status of the route, which can be one of the following values:

  • 'ACTIVE' for an active route
  • 'INACTIVE' for an inactive route
routeType This property is required. String
The type of this route, which can be one of the following values:

  • 'TRANSIT' for a transit route that this router learned from another Cloud Router and will readvertise to one of its BGP peers
  • 'SUBNET' for a route from a subnet of the VPC
  • 'BGP' for a route learned from a BGP peer of this router
  • 'STATIC' for a static route
selfLink This property is required. String
tags This property is required. List<String>
A list of instance tags to which this route applies.
warnings This property is required. List<GetRouterStatusBestRoutesForRouterWarning>
If potential misconfigurations are detected for this route, this field will be populated with warning messages.
asPaths This property is required. GetRouterStatusBestRoutesForRouterAsPath[]
creationTimestamp This property is required. string
Creation timestamp in RFC3339 text format.
description This property is required. string
An optional description of this resource. Provide this property when you create the resource.
destRange This property is required. string
The destination range of outgoing packets that this route applies to. Only IPv4 is supported.
name This property is required. string
The name of the router.
network This property is required. string
The network name or resource link to the parent network of this subnetwork.
nextHopGateway This property is required. 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'.
nextHopHub This property is required. string
The hub network that should handle matching packets, which should conform to RFC1035.
nextHopIlb This property is required. 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 This property is required. 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 This property is required. string
The zone of the instance specified in next_hop_instance. Omit if next_hop_instance is specified as a URL.
nextHopInterRegionCost This property is required. string
Internal fixed region-to-region cost that Google Cloud calculates based on factors such as network performance, distance, and available bandwidth between regions.
nextHopIp This property is required. string
Network IP address of an instance that should handle matching packets.
nextHopMed This property is required. string
Multi-Exit Discriminator, a BGP route metric that indicates the desirability of a particular route in a network.
nextHopNetwork This property is required. string
URL to a Network that should handle matching packets.
nextHopOrigin This property is required. string
Indicates the origin of the route. Can be IGP (Interior Gateway Protocol), EGP (Exterior Gateway Protocol), or INCOMPLETE.
nextHopPeering This property is required. string
The network peering name that should handle matching packets, which should conform to RFC1035.
nextHopVpnTunnel This property is required. string
URL to a VpnTunnel that should handle matching packets.
priority This property is required. 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 This property is required. string
The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
routeStatus This property is required. string
The status of the route, which can be one of the following values:

  • 'ACTIVE' for an active route
  • 'INACTIVE' for an inactive route
routeType This property is required. string
The type of this route, which can be one of the following values:

  • 'TRANSIT' for a transit route that this router learned from another Cloud Router and will readvertise to one of its BGP peers
  • 'SUBNET' for a route from a subnet of the VPC
  • 'BGP' for a route learned from a BGP peer of this router
  • 'STATIC' for a static route
selfLink This property is required. string
tags This property is required. string[]
A list of instance tags to which this route applies.
warnings This property is required. GetRouterStatusBestRoutesForRouterWarning[]
If potential misconfigurations are detected for this route, this field will be populated with warning messages.
as_paths This property is required. Sequence[GetRouterStatusBestRoutesForRouterAsPath]
creation_timestamp This property is required. str
Creation timestamp in RFC3339 text format.
description This property is required. str
An optional description of this resource. Provide this property when you create the resource.
dest_range This property is required. str
The destination range of outgoing packets that this route applies to. Only IPv4 is supported.
name This property is required. str
The name of the router.
network This property is required. str
The network name or resource link to the parent network of this subnetwork.
next_hop_gateway This property is required. 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_hub This property is required. str
The hub network that should handle matching packets, which should conform to RFC1035.
next_hop_ilb This property is required. 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 This property is required. 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 This property is required. str
The zone of the instance specified in next_hop_instance. Omit if next_hop_instance is specified as a URL.
next_hop_inter_region_cost This property is required. str
Internal fixed region-to-region cost that Google Cloud calculates based on factors such as network performance, distance, and available bandwidth between regions.
next_hop_ip This property is required. str
Network IP address of an instance that should handle matching packets.
next_hop_med This property is required. str
Multi-Exit Discriminator, a BGP route metric that indicates the desirability of a particular route in a network.
next_hop_network This property is required. str
URL to a Network that should handle matching packets.
next_hop_origin This property is required. str
Indicates the origin of the route. Can be IGP (Interior Gateway Protocol), EGP (Exterior Gateway Protocol), or INCOMPLETE.
next_hop_peering This property is required. str
The network peering name that should handle matching packets, which should conform to RFC1035.
next_hop_vpn_tunnel This property is required. str
URL to a VpnTunnel that should handle matching packets.
priority This property is required. 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 This property is required. str
The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
route_status This property is required. str
The status of the route, which can be one of the following values:

  • 'ACTIVE' for an active route
  • 'INACTIVE' for an inactive route
route_type This property is required. str
The type of this route, which can be one of the following values:

  • 'TRANSIT' for a transit route that this router learned from another Cloud Router and will readvertise to one of its BGP peers
  • 'SUBNET' for a route from a subnet of the VPC
  • 'BGP' for a route learned from a BGP peer of this router
  • 'STATIC' for a static route
self_link This property is required. str
tags This property is required. Sequence[str]
A list of instance tags to which this route applies.
warnings This property is required. Sequence[GetRouterStatusBestRoutesForRouterWarning]
If potential misconfigurations are detected for this route, this field will be populated with warning messages.
asPaths This property is required. List<Property Map>
creationTimestamp This property is required. String
Creation timestamp in RFC3339 text format.
description This property is required. String
An optional description of this resource. Provide this property when you create the resource.
destRange This property is required. String
The destination range of outgoing packets that this route applies to. Only IPv4 is supported.
name This property is required. String
The name of the router.
network This property is required. String
The network name or resource link to the parent network of this subnetwork.
nextHopGateway This property is required. 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'.
nextHopHub This property is required. String
The hub network that should handle matching packets, which should conform to RFC1035.
nextHopIlb This property is required. 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 This property is required. 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 This property is required. String
The zone of the instance specified in next_hop_instance. Omit if next_hop_instance is specified as a URL.
nextHopInterRegionCost This property is required. String
Internal fixed region-to-region cost that Google Cloud calculates based on factors such as network performance, distance, and available bandwidth between regions.
nextHopIp This property is required. String
Network IP address of an instance that should handle matching packets.
nextHopMed This property is required. String
Multi-Exit Discriminator, a BGP route metric that indicates the desirability of a particular route in a network.
nextHopNetwork This property is required. String
URL to a Network that should handle matching packets.
nextHopOrigin This property is required. String
Indicates the origin of the route. Can be IGP (Interior Gateway Protocol), EGP (Exterior Gateway Protocol), or INCOMPLETE.
nextHopPeering This property is required. String
The network peering name that should handle matching packets, which should conform to RFC1035.
nextHopVpnTunnel This property is required. String
URL to a VpnTunnel that should handle matching packets.
priority This property is required. 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 This property is required. String
The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
routeStatus This property is required. String
The status of the route, which can be one of the following values:

  • 'ACTIVE' for an active route
  • 'INACTIVE' for an inactive route
routeType This property is required. String
The type of this route, which can be one of the following values:

  • 'TRANSIT' for a transit route that this router learned from another Cloud Router and will readvertise to one of its BGP peers
  • 'SUBNET' for a route from a subnet of the VPC
  • 'BGP' for a route learned from a BGP peer of this router
  • 'STATIC' for a static route
selfLink This property is required. String
tags This property is required. List<String>
A list of instance tags to which this route applies.
warnings This property is required. List<Property Map>
If potential misconfigurations are detected for this route, this field will be populated with warning messages.

GetRouterStatusBestRoutesForRouterAsPath

AsLists This property is required. List<int>
The AS numbers of the AS Path.
PathSegmentType This property is required. string
The type of the AS Path, which can be one of the following values:

  • 'AS_SET': unordered set of autonomous systems that the route in has traversed
  • 'AS_SEQUENCE': ordered set of autonomous systems that the route has traversed
  • 'AS_CONFED_SEQUENCE': ordered set of Member Autonomous Systems in the local confederation that the route has traversed
  • 'AS_CONFED_SET': unordered set of Member Autonomous Systems in the local confederation that the route has traversed
AsLists This property is required. []int
The AS numbers of the AS Path.
PathSegmentType This property is required. string
The type of the AS Path, which can be one of the following values:

  • 'AS_SET': unordered set of autonomous systems that the route in has traversed
  • 'AS_SEQUENCE': ordered set of autonomous systems that the route has traversed
  • 'AS_CONFED_SEQUENCE': ordered set of Member Autonomous Systems in the local confederation that the route has traversed
  • 'AS_CONFED_SET': unordered set of Member Autonomous Systems in the local confederation that the route has traversed
asLists This property is required. List<Integer>
The AS numbers of the AS Path.
pathSegmentType This property is required. String
The type of the AS Path, which can be one of the following values:

  • 'AS_SET': unordered set of autonomous systems that the route in has traversed
  • 'AS_SEQUENCE': ordered set of autonomous systems that the route has traversed
  • 'AS_CONFED_SEQUENCE': ordered set of Member Autonomous Systems in the local confederation that the route has traversed
  • 'AS_CONFED_SET': unordered set of Member Autonomous Systems in the local confederation that the route has traversed
asLists This property is required. number[]
The AS numbers of the AS Path.
pathSegmentType This property is required. string
The type of the AS Path, which can be one of the following values:

  • 'AS_SET': unordered set of autonomous systems that the route in has traversed
  • 'AS_SEQUENCE': ordered set of autonomous systems that the route has traversed
  • 'AS_CONFED_SEQUENCE': ordered set of Member Autonomous Systems in the local confederation that the route has traversed
  • 'AS_CONFED_SET': unordered set of Member Autonomous Systems in the local confederation that the route has traversed
as_lists This property is required. Sequence[int]
The AS numbers of the AS Path.
path_segment_type This property is required. str
The type of the AS Path, which can be one of the following values:

  • 'AS_SET': unordered set of autonomous systems that the route in has traversed
  • 'AS_SEQUENCE': ordered set of autonomous systems that the route has traversed
  • 'AS_CONFED_SEQUENCE': ordered set of Member Autonomous Systems in the local confederation that the route has traversed
  • 'AS_CONFED_SET': unordered set of Member Autonomous Systems in the local confederation that the route has traversed
asLists This property is required. List<Number>
The AS numbers of the AS Path.
pathSegmentType This property is required. String
The type of the AS Path, which can be one of the following values:

  • 'AS_SET': unordered set of autonomous systems that the route in has traversed
  • 'AS_SEQUENCE': ordered set of autonomous systems that the route has traversed
  • 'AS_CONFED_SEQUENCE': ordered set of Member Autonomous Systems in the local confederation that the route has traversed
  • 'AS_CONFED_SET': unordered set of Member Autonomous Systems in the local confederation that the route has traversed

GetRouterStatusBestRoutesForRouterWarning

Code This property is required. string
A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
Datas This property is required. List<GetRouterStatusBestRoutesForRouterWarningData>
Metadata about this warning in key: value format. For example: "data": [ { "key": "scope", "value": "zones/us-east1-d" }
Message This property is required. string
A human-readable description of the warning code.
Code This property is required. string
A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
Datas This property is required. []GetRouterStatusBestRoutesForRouterWarningData
Metadata about this warning in key: value format. For example: "data": [ { "key": "scope", "value": "zones/us-east1-d" }
Message This property is required. string
A human-readable description of the warning code.
code This property is required. String
A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
datas This property is required. List<GetRouterStatusBestRoutesForRouterWarningData>
Metadata about this warning in key: value format. For example: "data": [ { "key": "scope", "value": "zones/us-east1-d" }
message This property is required. String
A human-readable description of the warning code.
code This property is required. string
A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
datas This property is required. GetRouterStatusBestRoutesForRouterWarningData[]
Metadata about this warning in key: value format. For example: "data": [ { "key": "scope", "value": "zones/us-east1-d" }
message This property is required. string
A human-readable description of the warning code.
code This property is required. str
A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
datas This property is required. Sequence[GetRouterStatusBestRoutesForRouterWarningData]
Metadata about this warning in key: value format. For example: "data": [ { "key": "scope", "value": "zones/us-east1-d" }
message This property is required. str
A human-readable description of the warning code.
code This property is required. String
A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
datas This property is required. List<Property Map>
Metadata about this warning in key: value format. For example: "data": [ { "key": "scope", "value": "zones/us-east1-d" }
message This property is required. String
A human-readable description of the warning code.

GetRouterStatusBestRoutesForRouterWarningData

Key This property is required. string
A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
Value This property is required. string
A warning data value corresponding to the key.
Key This property is required. string
A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
Value This property is required. string
A warning data value corresponding to the key.
key This property is required. String
A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
value This property is required. String
A warning data value corresponding to the key.
key This property is required. string
A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
value This property is required. string
A warning data value corresponding to the key.
key This property is required. str
A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
value This property is required. str
A warning data value corresponding to the key.
key This property is required. String
A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
value This property is required. String
A warning data value corresponding to the key.

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.
Google Cloud v8.25.0 published on Thursday, Apr 3, 2025 by Pulumi
pulumi/pulumi-gcp