import * as pulumi from "@pulumi/pulumi"; import * as inputs from "../types/input"; import * as outputs from "../types/output"; /** * Represents a Machine Image resource. Machine images store all the configuration, * metadata, permissions, and data from one or more disks required to create a * Virtual machine (VM) instance. * * To get more information about MachineImage, see: * * * [API documentation](https://cloud.google.com/compute/docs/reference/rest/beta/machineImages) * * How-to Guides * * [Official Documentation](https://cloud.google.com/compute/docs/machine-images) * * ## Example Usage * * ### Machine Image Basic * * ```typescript * import * as pulumi from "@pulumi/pulumi"; * import * as gcp from "@pulumi/gcp"; * * const vm = new gcp.compute.Instance("vm", { * name: "my-vm", * machineType: "e2-medium", * bootDisk: { * initializeParams: { * image: "debian-cloud/debian-11", * }, * }, * networkInterfaces: [{ * network: "default", * }], * }); * const image = new gcp.compute.MachineImage("image", { * name: "my-image", * sourceInstance: vm.selfLink, * }); * ``` * ### Compute Machine Image Kms * * ```typescript * import * as pulumi from "@pulumi/pulumi"; * import * as gcp from "@pulumi/gcp"; * * const vm = new gcp.compute.Instance("vm", { * name: "my-vm", * machineType: "e2-medium", * bootDisk: { * initializeParams: { * image: "debian-cloud/debian-11", * }, * }, * networkInterfaces: [{ * network: "default", * }], * }); * const keyRing = new gcp.kms.KeyRing("key_ring", { * name: "keyring", * location: "us", * }); * const cryptoKey = new gcp.kms.CryptoKey("crypto_key", { * name: "key", * keyRing: keyRing.id, * }); * const image = new gcp.compute.MachineImage("image", { * name: "my-image", * sourceInstance: vm.selfLink, * machineImageEncryptionKey: { * kmsKeyName: cryptoKey.id, * }, * }); * ``` * * ## Import * * MachineImage can be imported using any of these accepted formats: * * * `projects/{{project}}/global/machineImages/{{name}}` * * * `{{project}}/{{name}}` * * * `{{name}}` * * When using the `pulumi import` command, MachineImage can be imported using one of the formats above. For example: * * ```sh * $ pulumi import gcp:compute/machineImage:MachineImage default projects/{{project}}/global/machineImages/{{name}} * ``` * * ```sh * $ pulumi import gcp:compute/machineImage:MachineImage default {{project}}/{{name}} * ``` * * ```sh * $ pulumi import gcp:compute/machineImage:MachineImage default {{name}} * ``` */ export declare class MachineImage extends pulumi.CustomResource { /** * Get an existing MachineImage resource's state with the given name, ID, and optional extra * properties used to qualify the lookup. * * @param name The _unique_ name of the resulting resource. * @param id The _unique_ provider ID of the resource to lookup. * @param state Any extra arguments used during the lookup. * @param opts Optional settings to control the behavior of the CustomResource. */ static get(name: string, id: pulumi.Input, state?: MachineImageState, opts?: pulumi.CustomResourceOptions): MachineImage; /** * Returns true if the given object is an instance of MachineImage. This is designed to work even * when multiple copies of the Pulumi SDK have been loaded into the same process. */ static isInstance(obj: any): obj is MachineImage; /** * A text description of the resource. */ readonly description: pulumi.Output; /** * Specify this to create an application consistent machine image by informing the OS to prepare for the snapshot process. * Currently only supported on Windows instances using the Volume Shadow Copy Service (VSS). */ readonly guestFlush: pulumi.Output; /** * Encrypts the machine image using a customer-supplied encryption key. * After you encrypt a machine image with a customer-supplied key, you must * provide the same key if you use the machine image later (e.g. to create a * instance from the image) * Structure is documented below. */ readonly machineImageEncryptionKey: pulumi.Output; /** * Name of the resource. */ readonly name: pulumi.Output; /** * The ID of the project in which the resource belongs. * If it is not provided, the provider project is used. */ readonly project: pulumi.Output; /** * The URI of the created resource. */ readonly selfLink: pulumi.Output; /** * The source instance used to create the machine image. You can provide this as a partial or full URL to the resource. * * * - - - */ readonly sourceInstance: pulumi.Output; /** * The regional or multi-regional Cloud Storage bucket location where the machine image is stored. */ readonly storageLocations: pulumi.Output; /** * Create a MachineImage resource with the given unique name, arguments, and options. * * @param name The _unique_ name of the resource. * @param args The arguments to use to populate this resource's properties. * @param opts A bag of options that control this resource's behavior. */ constructor(name: string, args: MachineImageArgs, opts?: pulumi.CustomResourceOptions); } /** * Input properties used for looking up and filtering MachineImage resources. */ export interface MachineImageState { /** * A text description of the resource. */ description?: pulumi.Input; /** * Specify this to create an application consistent machine image by informing the OS to prepare for the snapshot process. * Currently only supported on Windows instances using the Volume Shadow Copy Service (VSS). */ guestFlush?: pulumi.Input; /** * Encrypts the machine image using a customer-supplied encryption key. * After you encrypt a machine image with a customer-supplied key, you must * provide the same key if you use the machine image later (e.g. to create a * instance from the image) * Structure is documented below. */ machineImageEncryptionKey?: pulumi.Input; /** * Name of the resource. */ name?: pulumi.Input; /** * The ID of the project in which the resource belongs. * If it is not provided, the provider project is used. */ project?: pulumi.Input; /** * The URI of the created resource. */ selfLink?: pulumi.Input; /** * The source instance used to create the machine image. You can provide this as a partial or full URL to the resource. * * * - - - */ sourceInstance?: pulumi.Input; /** * The regional or multi-regional Cloud Storage bucket location where the machine image is stored. */ storageLocations?: pulumi.Input[]>; } /** * The set of arguments for constructing a MachineImage resource. */ export interface MachineImageArgs { /** * A text description of the resource. */ description?: pulumi.Input; /** * Specify this to create an application consistent machine image by informing the OS to prepare for the snapshot process. * Currently only supported on Windows instances using the Volume Shadow Copy Service (VSS). */ guestFlush?: pulumi.Input; /** * Encrypts the machine image using a customer-supplied encryption key. * After you encrypt a machine image with a customer-supplied key, you must * provide the same key if you use the machine image later (e.g. to create a * instance from the image) * Structure is documented below. */ machineImageEncryptionKey?: pulumi.Input; /** * Name of the resource. */ name?: pulumi.Input; /** * The ID of the project in which the resource belongs. * If it is not provided, the provider project is used. */ project?: pulumi.Input; /** * The source instance used to create the machine image. You can provide this as a partial or full URL to the resource. * * * - - - */ sourceInstance: pulumi.Input; }