@pulumi/gcp/compute/getRouterStatus.d.ts

A Pulumi package for creating and managing Google Cloud Platform resources.

import * as pulumi from "@pulumi/pulumi";
import * as outputs from "../types/output";
/**
 * 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](https://cloud.google.com/network-connectivity/docs/router/how-to/viewing-router-details)
 * and
 * [API](https://cloud.google.com/compute/docs/reference/rest/v1/routers/getRouterStatus).
 *
 * ## Example Usage
 *
 * ```typescript
 * import * as pulumi from "@pulumi/pulumi";
 * import * as gcp from "@pulumi/gcp";
 *
 * const my_router = gcp.compute.getRouterStatus({
 *     name: "myrouter",
 * });
 * ```
 */
export declare function getRouterStatus(args: GetRouterStatusArgs, opts?: pulumi.InvokeOptions): Promise<GetRouterStatusResult>;
/**
 * A collection of arguments for invoking getRouterStatus.
 */
export interface GetRouterStatusArgs {
    /**
     * The name of the router.
     */
    name: string;
    /**
     * The ID of the project in which the resource
     * belongs. If it is not provided, the provider project is used.
     */
    project?: string;
    /**
     * The region this router has been created in. If
     * unspecified, this defaults to the region configured in the provider.
     */
    region?: string;
}
/**
 * A collection of values returned by getRouterStatus.
 */
export interface GetRouterStatusResult {
    /**
     * List of best `compute#routes` configurations for this router's network. See gcp.compute.Route resource for available attributes.
     */
    readonly bestRoutes: outputs.compute.GetRouterStatusBestRoute[];
    /**
     * List of best `compute#routes` for this specific router. See gcp.compute.Route resource for available attributes.
     */
    readonly bestRoutesForRouters: outputs.compute.GetRouterStatusBestRoutesForRouter[];
    /**
     * The provider-assigned unique ID for this managed resource.
     */
    readonly id: string;
    readonly name: string;
    /**
     * The network name or resource link to the parent
     * network of this subnetwork.
     */
    readonly network: string;
    readonly project?: string;
    readonly region: string;
}
/**
 * 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](https://cloud.google.com/network-connectivity/docs/router/how-to/viewing-router-details)
 * and
 * [API](https://cloud.google.com/compute/docs/reference/rest/v1/routers/getRouterStatus).
 *
 * ## Example Usage
 *
 * ```typescript
 * import * as pulumi from "@pulumi/pulumi";
 * import * as gcp from "@pulumi/gcp";
 *
 * const my_router = gcp.compute.getRouterStatus({
 *     name: "myrouter",
 * });
 * ```
 */
export declare function getRouterStatusOutput(args: GetRouterStatusOutputArgs, opts?: pulumi.InvokeOutputOptions): pulumi.Output<GetRouterStatusResult>;
/**
 * A collection of arguments for invoking getRouterStatus.
 */
export interface GetRouterStatusOutputArgs {
    /**
     * The name of the router.
     */
    name: pulumi.Input<string>;
    /**
     * The ID of the project in which the resource
     * belongs. If it is not provided, the provider project is used.
     */
    project?: pulumi.Input<string>;
    /**
     * The region this router has been created in. If
     * unspecified, this defaults to the region configured in the provider.
     */
    region?: pulumi.Input<string>;
}