UNPKG

@pulumi/hcloud

Version:

A Pulumi package for creating and managing hcloud cloud resources.

113 lines (112 loc) 3.28 kB
import * as pulumi from "@pulumi/pulumi"; import * as outputs from "./types/output"; /** * Provides details about multiple Hetzner Cloud Images. * * When relevant, it is recommended to always provide the image architecture * (`withArchitecture`) when fetching images. * * ## 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 { /** * Also list images that are marked as deprecated. */ includeDeprecated?: boolean; /** * Sorts list by date. */ mostRecent?: boolean; /** * List only images with this architecture, could contain `x86` or `arm`. */ withArchitectures?: string[]; /** * [Label selector](https://docs.hetzner.cloud/#overview-label-selector) */ withSelector?: string; /** * List only images with the specified status, could contain `creating` or `available`. */ withStatuses?: string[]; } /** * A collection of values returned by getImages. */ export interface GetImagesResult { /** * The provider-assigned unique ID for this managed resource. */ readonly id: string; /** * (list) List of all matching images. See `data.hcloud_image` for schema. */ readonly images: outputs.GetImagesImage[]; readonly includeDeprecated?: boolean; readonly mostRecent?: boolean; readonly withArchitectures?: string[]; readonly withSelector?: string; readonly withStatuses?: string[]; } /** * Provides details about multiple Hetzner Cloud Images. * * When relevant, it is recommended to always provide the image architecture * (`withArchitecture`) when fetching images. * * ## 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 { /** * Also list images that are marked as deprecated. */ includeDeprecated?: pulumi.Input<boolean>; /** * Sorts list by date. */ mostRecent?: pulumi.Input<boolean>; /** * List only images with this architecture, could contain `x86` or `arm`. */ withArchitectures?: pulumi.Input<pulumi.Input<string>[]>; /** * [Label selector](https://docs.hetzner.cloud/#overview-label-selector) */ withSelector?: pulumi.Input<string>; /** * List only images with the specified status, could contain `creating` or `available`. */ withStatuses?: pulumi.Input<pulumi.Input<string>[]>; }