@pulumi/linode/getVolumes.d.ts

A Pulumi package for creating and managing linode cloud resources.

import * as pulumi from "@pulumi/pulumi";
import * as inputs from "./types/input";
import * as outputs from "./types/output";
/**
 * Provides information about Linode volumes that match a set of filters.
 * For more information, see the [Linode APIv4 docs](https://techdocs.akamai.com/linode-api/reference/get-volumes).
 *
 * ```typescript
 * import * as pulumi from "@pulumi/pulumi";
 * import * as linode from "@pulumi/linode";
 *
 * const filtered_volumes = linode.getVolumes({
 *     filters: [{
 *         name: "label",
 *         values: ["test-volume"],
 *     }],
 * });
 * export const volumes = filtered_volumes.then(filtered_volumes => filtered_volumes.volumes);
 * ```
 *
 * ## Filterable Fields
 *
 * * `label`
 *
 * * `tags`
 */
export declare function getVolumes(args?: GetVolumesArgs, opts?: pulumi.InvokeOptions): Promise<GetVolumesResult>;
/**
 * A collection of arguments for invoking getVolumes.
 */
export interface GetVolumesArgs {
    filters?: inputs.GetVolumesFilter[];
    /**
     * The order in which results should be returned. (`asc`, `desc`; default `asc`)
     */
    order?: string;
    /**
     * The attribute to order the results by. See the Filterable Fields section for a list of valid fields.
     */
    orderBy?: string;
    volumes?: inputs.GetVolumesVolume[];
}
/**
 * A collection of values returned by getVolumes.
 */
export interface GetVolumesResult {
    readonly filters?: outputs.GetVolumesFilter[];
    /**
     * The unique ID of this Volume.
     */
    readonly id: string;
    readonly order?: string;
    readonly orderBy?: string;
    readonly volumes?: outputs.GetVolumesVolume[];
}
/**
 * Provides information about Linode volumes that match a set of filters.
 * For more information, see the [Linode APIv4 docs](https://techdocs.akamai.com/linode-api/reference/get-volumes).
 *
 * ```typescript
 * import * as pulumi from "@pulumi/pulumi";
 * import * as linode from "@pulumi/linode";
 *
 * const filtered_volumes = linode.getVolumes({
 *     filters: [{
 *         name: "label",
 *         values: ["test-volume"],
 *     }],
 * });
 * export const volumes = filtered_volumes.then(filtered_volumes => filtered_volumes.volumes);
 * ```
 *
 * ## Filterable Fields
 *
 * * `label`
 *
 * * `tags`
 */
export declare function getVolumesOutput(args?: GetVolumesOutputArgs, opts?: pulumi.InvokeOutputOptions): pulumi.Output<GetVolumesResult>;
/**
 * A collection of arguments for invoking getVolumes.
 */
export interface GetVolumesOutputArgs {
    filters?: pulumi.Input<pulumi.Input<inputs.GetVolumesFilterArgs>[]>;
    /**
     * The order in which results should be returned. (`asc`, `desc`; default `asc`)
     */
    order?: pulumi.Input<string>;
    /**
     * The attribute to order the results by. See the Filterable Fields section for a list of valid fields.
     */
    orderBy?: pulumi.Input<string>;
    volumes?: pulumi.Input<pulumi.Input<inputs.GetVolumesVolumeArgs>[]>;
}