pulumi-gcp-kotlin/com.pulumi.gcp.compute.kotlin/ComputeFunctions/getRouterStatus

getRouterStatus

suspend fun getRouterStatus(argument: GetRouterStatusPlainArgs): GetRouterStatusResult

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",
});
Content copied to clipboard
import pulumi
import pulumi_gcp as gcp
my_router = gcp.compute.get_router_status(name="myrouter")
Content copied to clipboard
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",
    });
});
Content copied to clipboard
package main
import (
	"github.com/pulumi/pulumi-gcp/sdk/v7/go/gcp/compute"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := compute.GetRouterStatus(ctx, &compute.GetRouterStatusArgs{
			Name: "myrouter",
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}
Content copied to clipboard
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());
    }
}
Content copied to clipboard
variables:
  my-router:
    fn::invoke:
      Function: gcp:compute:getRouterStatus
      Arguments:
        name: myrouter
Content copied to clipboard

Return

A collection of values returned by getRouterStatus.

Parameters

argument

A collection of arguments for invoking getRouterStatus.

suspend fun getRouterStatus(name: String, project: String? = null, region: String? = null): GetRouterStatusResult

Return

A collection of values returned by getRouterStatus.

Parameters

name

The name of the router.

project

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

region

The region this router has been created in. If unspecified, this defaults to the region configured in the provider.

See also

.

suspend fun getRouterStatus(argument: suspend GetRouterStatusPlainArgsBuilder.() -> Unit): GetRouterStatusResult

Return

A collection of values returned by getRouterStatus.

Parameters

argument

Builder for com.pulumi.gcp.compute.kotlin.inputs.GetRouterStatusPlainArgs.

See also

.