@volcengine/pulumi
Version:
A Pulumi package for creating and managing volcengine cloud resources.
161 lines (160 loc) • 3.83 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
import * as inputs from "../types/input";
import * as outputs from "../types/output";
/**
* Use this data source to query detailed information of apig gateways
* ## Example Usage
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as volcengine from "@pulumi/volcengine";
*
* const foo = volcengine.apig.getGateways({
* ids: [
* "gd13d8c6eq1emkiunq6p0",
* "gd07fq7pte3scmnaj1b1g",
* ],
* });
* ```
*/
export declare function getGateways(args?: GetGatewaysArgs, opts?: pulumi.InvokeOptions): Promise<GetGatewaysResult>;
/**
* A collection of arguments for invoking getGateways.
*/
export interface GetGatewaysArgs {
/**
* A list of api gateway IDs.
*/
ids?: string[];
/**
* The name of api gateway. 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 project name of api gateway.
*/
projectName?: string;
/**
* The status of api gateway.
*/
status?: string;
/**
* Tags.
*/
tags?: inputs.apig.GetGatewaysTag[];
/**
* The type of api gateway.
*/
type?: string;
/**
* A list of vpc IDs.
*/
vpcIds?: string[];
}
/**
* A collection of values returned by getGateways.
*/
export interface GetGatewaysResult {
/**
* The collection of query.
*/
readonly gateways: outputs.apig.GetGatewaysGateway[];
/**
* The provider-assigned unique ID for this managed resource.
*/
readonly id: string;
readonly ids?: string[];
/**
* The name of the api gateway.
*/
readonly name?: string;
readonly nameRegex?: string;
readonly outputFile?: string;
/**
* The project name of the api gateway.
*/
readonly projectName?: string;
/**
* The status of the api gateway.
*/
readonly status?: string;
/**
* Tags.
*/
readonly tags?: outputs.apig.GetGatewaysTag[];
/**
* The total count of query.
*/
readonly totalCount: number;
/**
* The type of the api gateway.
*/
readonly type?: string;
readonly vpcIds?: string[];
}
/**
* Use this data source to query detailed information of apig gateways
* ## Example Usage
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as volcengine from "@pulumi/volcengine";
*
* const foo = volcengine.apig.getGateways({
* ids: [
* "gd13d8c6eq1emkiunq6p0",
* "gd07fq7pte3scmnaj1b1g",
* ],
* });
* ```
*/
export declare function getGatewaysOutput(args?: GetGatewaysOutputArgs, opts?: pulumi.InvokeOptions): pulumi.Output<GetGatewaysResult>;
/**
* A collection of arguments for invoking getGateways.
*/
export interface GetGatewaysOutputArgs {
/**
* A list of api gateway IDs.
*/
ids?: pulumi.Input<pulumi.Input<string>[]>;
/**
* The name of api gateway. 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 project name of api gateway.
*/
projectName?: pulumi.Input<string>;
/**
* The status of api gateway.
*/
status?: pulumi.Input<string>;
/**
* Tags.
*/
tags?: pulumi.Input<pulumi.Input<inputs.apig.GetGatewaysTagArgs>[]>;
/**
* The type of api gateway.
*/
type?: pulumi.Input<string>;
/**
* A list of vpc IDs.
*/
vpcIds?: pulumi.Input<pulumi.Input<string>[]>;
}