@pulumi/hcloud
Version:
A Pulumi package for creating and managing hcloud cloud resources.
127 lines • 3.77 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
import * as outputs from "./types/output";
/**
* Provides a list of Hetzner Storage Images.
*
* It is recommended to always provide the image architecture (using ''with_architecture'').
*
* See the [Image API documentation](https://docs.hetzner.cloud/reference/cloud#images) for more details.
*
* ## Example Usage
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as hcloud from "@pulumi/hcloud";
*
* const byArchitecture = hcloud.getImages({
* withArchitectures: ["x86"],
* });
* const byLabel = hcloud.getImages({
* withSelector: "key=value",
* });
* ```
*/
export declare function getImages(args?: GetImagesArgs, opts?: pulumi.InvokeOptions): Promise<GetImagesResult>;
/**
* A collection of arguments for invoking getImages.
*/
export interface GetImagesArgs {
/**
* Include deprecated images.
*/
includeDeprecated?: boolean;
/**
* Sort results by created date.
*/
mostRecent?: boolean;
/**
* Filter results by architecture, for example `x86` or `arm`.
*/
withArchitectures?: string[];
/**
* Filter results using a [Label Selector](https://docs.hetzner.cloud/reference/hetzner#label-selector).
*/
withSelector?: string;
/**
* Filter results by statuses, for example `creating` or `available`.
*/
withStatuses?: string[];
}
/**
* A collection of values returned by getImages.
*/
export interface GetImagesResult {
/**
* The ID of this resource.
*/
readonly id: string;
readonly images: outputs.GetImagesImage[];
/**
* Include deprecated images.
*/
readonly includeDeprecated?: boolean;
/**
* Sort results by created date.
*/
readonly mostRecent?: boolean;
/**
* Filter results by architecture, for example `x86` or `arm`.
*/
readonly withArchitectures?: string[];
/**
* Filter results using a [Label Selector](https://docs.hetzner.cloud/reference/hetzner#label-selector).
*/
readonly withSelector?: string;
/**
* Filter results by statuses, for example `creating` or `available`.
*/
readonly withStatuses?: string[];
}
/**
* Provides a list of Hetzner Storage Images.
*
* It is recommended to always provide the image architecture (using ''with_architecture'').
*
* See the [Image API documentation](https://docs.hetzner.cloud/reference/cloud#images) for more details.
*
* ## Example Usage
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as hcloud from "@pulumi/hcloud";
*
* const byArchitecture = hcloud.getImages({
* withArchitectures: ["x86"],
* });
* const byLabel = hcloud.getImages({
* withSelector: "key=value",
* });
* ```
*/
export declare function getImagesOutput(args?: GetImagesOutputArgs, opts?: pulumi.InvokeOutputOptions): pulumi.Output<GetImagesResult>;
/**
* A collection of arguments for invoking getImages.
*/
export interface GetImagesOutputArgs {
/**
* Include deprecated images.
*/
includeDeprecated?: pulumi.Input<boolean | undefined>;
/**
* Sort results by created date.
*/
mostRecent?: pulumi.Input<boolean | undefined>;
/**
* Filter results by architecture, for example `x86` or `arm`.
*/
withArchitectures?: pulumi.Input<pulumi.Input<string>[] | undefined>;
/**
* Filter results using a [Label Selector](https://docs.hetzner.cloud/reference/hetzner#label-selector).
*/
withSelector?: pulumi.Input<string | undefined>;
/**
* Filter results by statuses, for example `creating` or `available`.
*/
withStatuses?: pulumi.Input<pulumi.Input<string>[] | undefined>;
}
//# sourceMappingURL=getImages.d.ts.map