@pulumi/linode
Version:
A Pulumi package for creating and managing linode cloud resources.
126 lines (125 loc) • 3.95 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
import * as inputs from "./types/input";
import * as outputs from "./types/output";
/**
* Provides information about a Linode image
* For more information, see the [Linode APIv4 docs](https://techdocs.akamai.com/linode-api/reference/get-image).
*
* ## Example Usage
*
* The following example shows how one might use this data source to access information about a Linode image.
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as linode from "@pulumi/linode";
*
* const k8Master = linode.getImage({
* id: "linode/debian12",
* });
* ```
*/
export declare function getImage(args: GetImageArgs, opts?: pulumi.InvokeOptions): Promise<GetImageResult>;
/**
* A collection of arguments for invoking getImage.
*/
export interface GetImageArgs {
/**
* The unique ID of this Image. The ID of private images begin with `private/` followed by the numeric identifier of the private image, for example `private/12345`.
*/
id: string;
/**
* A list of image replication regions and corresponding status.
*/
replications?: inputs.GetImageReplication[];
}
/**
* A collection of values returned by getImage.
*/
export interface GetImageResult {
readonly capabilities: string[];
/**
* When this Image was created.
*/
readonly created: string;
/**
* The name of the User who created this Image, or "linode" for official Images.
*/
readonly createdBy: string;
/**
* Whether or not this Image is deprecated. Will only be true for deprecated public Images.
*/
readonly deprecated: boolean;
/**
* A detailed description of this Image.
*/
readonly description: string;
readonly expiry: string;
readonly id: string;
/**
* True if the Image is public.
*/
readonly isPublic: boolean;
/**
* A short description of the Image.
*/
readonly label: string;
/**
* A list of image replication regions and corresponding status.
*/
readonly replications?: outputs.GetImageReplication[];
/**
* The minimum size this Image needs to deploy. Size is in MB. example: 2500
*/
readonly size: number;
/**
* The status of an image replica.
*/
readonly status: string;
/**
* A list of customized tags.
*/
readonly tags: string[];
/**
* The total size of the image in all available regions.
*/
readonly totalSize: number;
/**
* How the Image was created. Manual Images can be created at any time. "Automatic" Images are created automatically from a deleted Linode. (`manual`, `automatic`)
*/
readonly type: string;
/**
* The upstream distribution vendor. `None` for private Images.
*/
readonly vendor: string;
}
/**
* Provides information about a Linode image
* For more information, see the [Linode APIv4 docs](https://techdocs.akamai.com/linode-api/reference/get-image).
*
* ## Example Usage
*
* The following example shows how one might use this data source to access information about a Linode image.
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as linode from "@pulumi/linode";
*
* const k8Master = linode.getImage({
* id: "linode/debian12",
* });
* ```
*/
export declare function getImageOutput(args: GetImageOutputArgs, opts?: pulumi.InvokeOutputOptions): pulumi.Output<GetImageResult>;
/**
* A collection of arguments for invoking getImage.
*/
export interface GetImageOutputArgs {
/**
* The unique ID of this Image. The ID of private images begin with `private/` followed by the numeric identifier of the private image, for example `private/12345`.
*/
id: pulumi.Input<string>;
/**
* A list of image replication regions and corresponding status.
*/
replications?: pulumi.Input<pulumi.Input<inputs.GetImageReplicationArgs>[]>;
}