@volcengine/pulumi/rocketmq/getInstances.d.ts

A Pulumi package for creating and managing volcengine cloud resources.

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 rocketmq instances
 * ## Example Usage
 *
 * ```typescript
 * import * as pulumi from "@pulumi/pulumi";
 * import * as volcengine from "@pulumi/volcengine";
 *
 * const foo = volcengine.rocketmq.getInstances({
 *     instanceId: "rocketmq-cnoeea6b32118fc2",
 * });
 * ```
 */
export declare function getInstances(args?: GetInstancesArgs, opts?: pulumi.InvokeOptions): Promise<GetInstancesResult>;
/**
 * A collection of arguments for invoking getInstances.
 */
export interface GetInstancesArgs {
    /**
     * The charge type of rocketmq instance. Valid values: `PostPaid`, `PrePaid`.
     */
    chargeType?: string;
    /**
     * The id of rocketmq instance.
     */
    instanceId?: string;
    /**
     * The name of rocketmq instance. This field support fuzzy query.
     */
    instanceName?: string;
    /**
     * The status of rocketmq instance.
     */
    instanceStatus?: string;
    /**
     * A Name Regex of Resource.
     */
    nameRegex?: string;
    /**
     * File name where to save data source results.
     */
    outputFile?: string;
    /**
     * The project name of rocketmq instance.
     */
    projectName?: string;
    /**
     * The spec of rocketmq instance.
     */
    spec?: string;
    /**
     * Tags.
     */
    tags?: inputs.rocketmq.GetInstancesTag[];
    /**
     * The version of rocketmq instance. Valid values: `4.8`.
     */
    version?: string;
    /**
     * The vpc id of rocketmq instance.
     */
    vpcId?: string;
    /**
     * The zone id of rocketmq instance.
     */
    zoneId?: string;
}
/**
 * A collection of values returned by getInstances.
 */
export interface GetInstancesResult {
    /**
     * The charge type of the rocketmq instance.
     */
    readonly chargeType?: string;
    /**
     * The provider-assigned unique ID for this managed resource.
     */
    readonly id: string;
    /**
     * The id of the rocketmq instance.
     */
    readonly instanceId?: string;
    /**
     * The name of the rocketmq instance.
     */
    readonly instanceName?: string;
    /**
     * The status of the rocketmq instance.
     */
    readonly instanceStatus?: string;
    readonly nameRegex?: string;
    readonly outputFile?: string;
    /**
     * The project name of the rocketmq instance.
     */
    readonly projectName?: string;
    /**
     * The collection of query.
     */
    readonly rocketmqInstances: outputs.rocketmq.GetInstancesRocketmqInstance[];
    readonly spec?: string;
    /**
     * Tags.
     */
    readonly tags?: outputs.rocketmq.GetInstancesTag[];
    /**
     * The total count of query.
     */
    readonly totalCount: number;
    /**
     * The version of the rocketmq instance.
     */
    readonly version?: string;
    /**
     * The vpc id of the rocketmq instance.
     */
    readonly vpcId?: string;
    /**
     * The zone id of the rocketmq instance.
     */
    readonly zoneId?: string;
}
/**
 * Use this data source to query detailed information of rocketmq instances
 * ## Example Usage
 *
 * ```typescript
 * import * as pulumi from "@pulumi/pulumi";
 * import * as volcengine from "@pulumi/volcengine";
 *
 * const foo = volcengine.rocketmq.getInstances({
 *     instanceId: "rocketmq-cnoeea6b32118fc2",
 * });
 * ```
 */
export declare function getInstancesOutput(args?: GetInstancesOutputArgs, opts?: pulumi.InvokeOptions): pulumi.Output<GetInstancesResult>;
/**
 * A collection of arguments for invoking getInstances.
 */
export interface GetInstancesOutputArgs {
    /**
     * The charge type of rocketmq instance. Valid values: `PostPaid`, `PrePaid`.
     */
    chargeType?: pulumi.Input<string>;
    /**
     * The id of rocketmq instance.
     */
    instanceId?: pulumi.Input<string>;
    /**
     * The name of rocketmq instance. This field support fuzzy query.
     */
    instanceName?: pulumi.Input<string>;
    /**
     * The status of rocketmq instance.
     */
    instanceStatus?: 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 rocketmq instance.
     */
    projectName?: pulumi.Input<string>;
    /**
     * The spec of rocketmq instance.
     */
    spec?: pulumi.Input<string>;
    /**
     * Tags.
     */
    tags?: pulumi.Input<pulumi.Input<inputs.rocketmq.GetInstancesTagArgs>[]>;
    /**
     * The version of rocketmq instance. Valid values: `4.8`.
     */
    version?: pulumi.Input<string>;
    /**
     * The vpc id of rocketmq instance.
     */
    vpcId?: pulumi.Input<string>;
    /**
     * The zone id of rocketmq instance.
     */
    zoneId?: pulumi.Input<string>;
}