@volcengine/pulumi/apig/routes.d.ts

A Pulumi package for creating and managing volcengine cloud resources.

import * as pulumi from "@pulumi/pulumi";
import * as outputs from "../types/output";
/**
 * Use this data source to query detailed information of apig routes
 * ## Example Usage
 *
 * ```typescript
 * import * as pulumi from "@pulumi/pulumi";
 * import * as volcengine from "@pulumi/volcengine";
 *
 * const foo = volcengine.apig.getRoutes({
 *     gatewayId: "gd1ek1ki9optek6ooabh0",
 * });
 * ```
 */
/** @deprecated volcengine.apig.Routes has been deprecated in favor of volcengine.apig.getRoutes */
export declare function routes(args?: RoutesArgs, opts?: pulumi.InvokeOptions): Promise<RoutesResult>;
/**
 * A collection of arguments for invoking Routes.
 */
export interface RoutesArgs {
    /**
     * The id of api gateway.
     */
    gatewayId?: string;
    /**
     * The name of api gateway route. This field support fuzzy query.
     */
    name?: string;
    /**
     * A Name Regex of Resource.
     */
    nameRegex?: string;
    /**
     * File name where to save data source results.
     */
    outputFile?: string;
    /**
     * The path of api gateway route.
     */
    path?: string;
    /**
     * The resource type of route. Valid values: `Console`, `Ingress`.
     */
    resourceType?: string;
    /**
     * The id of api gateway service.
     */
    serviceId?: string;
    /**
     * The id of api gateway upstream.
     */
    upstreamId?: string;
    /**
     * The version of api gateway upstream.
     */
    upstreamVersion?: string;
}
/**
 * A collection of values returned by Routes.
 */
export interface RoutesResult {
    readonly gatewayId?: string;
    /**
     * The provider-assigned unique ID for this managed resource.
     */
    readonly id: string;
    /**
     * The name of the api gateway route.
     */
    readonly name?: string;
    readonly nameRegex?: string;
    readonly outputFile?: string;
    /**
     * The path of the api gateway route.
     */
    readonly path?: string;
    /**
     * The resource type of route. Valid values: `Console`, `Ingress`.
     */
    readonly resourceType?: string;
    /**
     * The collection of query.
     */
    readonly routes: outputs.apig.RoutesRoute[];
    /**
     * The id of the api gateway service.
     */
    readonly serviceId?: string;
    /**
     * The total count of query.
     */
    readonly totalCount: number;
    /**
     * The id of the api gateway upstream.
     */
    readonly upstreamId?: string;
    readonly upstreamVersion?: string;
}
/**
 * Use this data source to query detailed information of apig routes
 * ## Example Usage
 *
 * ```typescript
 * import * as pulumi from "@pulumi/pulumi";
 * import * as volcengine from "@pulumi/volcengine";
 *
 * const foo = volcengine.apig.getRoutes({
 *     gatewayId: "gd1ek1ki9optek6ooabh0",
 * });
 * ```
 */
/** @deprecated volcengine.apig.Routes has been deprecated in favor of volcengine.apig.getRoutes */
export declare function routesOutput(args?: RoutesOutputArgs, opts?: pulumi.InvokeOptions): pulumi.Output<RoutesResult>;
/**
 * A collection of arguments for invoking Routes.
 */
export interface RoutesOutputArgs {
    /**
     * The id of api gateway.
     */
    gatewayId?: pulumi.Input<string>;
    /**
     * The name of api gateway route. This field support fuzzy query.
     */
    name?: pulumi.Input<string>;
    /**
     * A Name Regex of Resource.
     */
    nameRegex?: pulumi.Input<string>;
    /**
     * File name where to save data source results.
     */
    outputFile?: pulumi.Input<string>;
    /**
     * The path of api gateway route.
     */
    path?: pulumi.Input<string>;
    /**
     * The resource type of route. Valid values: `Console`, `Ingress`.
     */
    resourceType?: pulumi.Input<string>;
    /**
     * The id of api gateway service.
     */
    serviceId?: pulumi.Input<string>;
    /**
     * The id of api gateway upstream.
     */
    upstreamId?: pulumi.Input<string>;
    /**
     * The version of api gateway upstream.
     */
    upstreamVersion?: pulumi.Input<string>;
}