getRouter function

Future<GetRouterResult> getRouter(
  1. GetRouterArgs args, {
  2. InvokeOptions? options,
})

Get a router within GCE from its name and VPC.

Example Usage

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

const my_router = gcp.compute.getRouter({
    name: "myrouter-us-east1",
    network: "my-network",
});
import pulumi
import pulumi_gcp as gcp

my_router = gcp.compute.get_router(name="myrouter-us-east1",
    network="my-network")
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Gcp = Pulumi.Gcp;

return await Deployment.RunAsync(() =>
{
    var my_router = Gcp.Compute.GetRouter.Invoke(new()
    {
        Name = "myrouter-us-east1",
        Network = "my-network",
    });

});
package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := compute.LookupRouter(ctx, &compute.LookupRouterArgs{
			Name:    "myrouter-us-east1",
			Network: "my-network",
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}
pulumi {
  required_providers {
    gcp = {
      source = "pulumi/gcp"
    }
  }
}

data "gcp_compute_getrouter" "my-router" {
  name    = "myrouter-us-east1"
  network = "my-network"
}
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.GetRouterArgs;
import java.util.ArrayList;
import java.util.Arrays;
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.getRouter(GetRouterArgs.builder()
            .name("myrouter-us-east1")
            .network("my-network")
            .build());

    }
}
variables:
  my-router:
    fn::invoke:
      function: gcp:compute:getRouter
      arguments:
        name: myrouter-us-east1
        network: my-network

args Arguments passed to this invoke. Arguments for getRouter. options Invoke options controlling this call.

Implementation

Future<GetRouterResult> getRouter(
  GetRouterArgs args, {
  pulumi.InvokeOptions? options,
}) async {
  final deployment = pulumi.Deployment.instance;
  final result = await deployment.invoke<Map<String, dynamic>>(
    'gcp:compute/getRouter:getRouter',
    args.toMap(),
    options: pulumi.toDeploymentInvokeOptions(options),
  );
  return GetRouterResult.fromMap(result);
}