import * as pulumi from "@pulumi/pulumi"; import { input as inputs, output as outputs } from "../../types"; /** * Creates an image in the specified project using the data included in the request. */ export declare class Image extends pulumi.CustomResource { /** * Get an existing Image 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 opts Optional settings to control the behavior of the CustomResource. */ static get(name: string, id: pulumi.Input, opts?: pulumi.CustomResourceOptions): Image; /** * Returns true if the given object is an instance of Image. 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 Image; /** * Size of the image tar.gz archive stored in Google Cloud Storage (in bytes). */ readonly archiveSizeBytes: pulumi.Output; /** * [Output Only] Creation timestamp in RFC3339 text format. */ readonly creationTimestamp: pulumi.Output; /** * The deprecation status associated with this image. */ readonly deprecated: pulumi.Output; /** * An optional description of this resource. Provide this property when you create the resource. */ readonly description: pulumi.Output; /** * Size of the image when restored onto a persistent disk (in GB). */ readonly diskSizeGb: pulumi.Output; /** * The name of the image family to which this image belongs. You can create disks by specifying an image family instead of a specific image name. The image family always returns its latest image that is not deprecated. The name of the image family must comply with RFC1035. */ readonly family: pulumi.Output; /** * A list of features to enable on the guest operating system. Applicable only for bootable images. Read Enabling guest operating system features to see a list of available options. */ readonly guestOsFeatures: pulumi.Output; /** * Encrypts the image using a customer-supplied encryption key. * * After you encrypt an image with a customer-supplied key, you must provide the same key if you use the image later (e.g. to create a disk from the image). * * Customer-supplied encryption keys do not protect access to metadata of the disk. * * If you do not provide an encryption key when creating the image, then the disk will be encrypted using an automatically generated key and you do not need to provide a key to use the image later. */ readonly imageEncryptionKey: pulumi.Output; /** * [Output Only] Type of the resource. Always compute#image for images. */ readonly kind: pulumi.Output; /** * A fingerprint for the labels being applied to this image, which is essentially a hash of the labels used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update labels. You must always provide an up-to-date fingerprint hash in order to update or change labels, otherwise the request will fail with error 412 conditionNotMet. * * To see the latest fingerprint, make a get() request to retrieve an image. */ readonly labelFingerprint: pulumi.Output; /** * Labels to apply to this image. These can be later modified by the setLabels method. */ readonly labels: pulumi.Output<{ [key: string]: string; }>; /** * Integer license codes indicating which licenses are attached to this image. */ readonly licenseCodes: pulumi.Output; /** * Any applicable license URI. */ readonly licenses: pulumi.Output; /** * Name of the resource; provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. */ readonly name: pulumi.Output; /** * The parameters of the raw disk image. */ readonly rawDisk: pulumi.Output<{ [key: string]: string; }>; /** * A rollout policy to apply to this image. When specified, the rollout policy overrides per-zone references to the image via the associated image family. The rollout policy restricts the zones where this image is accessible when using a zonal image family reference. When the rollout policy does not include the user specified zone, or if the zone is rolled out, this image is accessible. */ readonly rolloutOverride: pulumi.Output; /** * [Output Only] Reserved for future use. */ readonly satisfiesPzs: pulumi.Output; /** * [Output Only] Server-defined URL for the resource. */ readonly selfLink: pulumi.Output; /** * [Output Only] Server-defined URL for this resource's resource id. */ readonly selfLinkWithId: pulumi.Output; /** * Set the secure boot keys of shielded instance. */ readonly shieldedInstanceInitialState: pulumi.Output; /** * URL of the source disk used to create this image. This can be a full or valid partial URL. You must provide either this property or the rawDisk.source property but not both to create an image. For example, the following are valid values: * - https://www.googleapis.com/compute/v1/projects/project/zones/zone/disks/disk * - projects/project/zones/zone/disks/disk * - zones/zone/disks/disk */ readonly sourceDisk: pulumi.Output; /** * The customer-supplied encryption key of the source disk. Required if the source disk is protected by a customer-supplied encryption key. */ readonly sourceDiskEncryptionKey: pulumi.Output; /** * [Output Only] The ID value of the disk used to create this image. This value may be used to determine whether the image was taken from the current or a previous instance of a given disk name. */ readonly sourceDiskId: pulumi.Output; /** * URL of the source image used to create this image. * * In order to create an image, you must provide the full or partial URL of one of the following: * - The selfLink URL * - This property * - The rawDisk.source URL * - The sourceDisk URL */ readonly sourceImage: pulumi.Output; /** * The customer-supplied encryption key of the source image. Required if the source image is protected by a customer-supplied encryption key. */ readonly sourceImageEncryptionKey: pulumi.Output; /** * [Output Only] The ID value of the image used to create this image. This value may be used to determine whether the image was taken from the current or a previous instance of a given image name. */ readonly sourceImageId: pulumi.Output; /** * URL of the source snapshot used to create this image. * * In order to create an image, you must provide the full or partial URL of one of the following: * - The selfLink URL * - This property * - The sourceImage URL * - The rawDisk.source URL * - The sourceDisk URL */ readonly sourceSnapshot: pulumi.Output; /** * The customer-supplied encryption key of the source snapshot. Required if the source snapshot is protected by a customer-supplied encryption key. */ readonly sourceSnapshotEncryptionKey: pulumi.Output; /** * [Output Only] The ID value of the snapshot used to create this image. This value may be used to determine whether the snapshot was taken from the current or a previous instance of a given snapshot name. */ readonly sourceSnapshotId: pulumi.Output; /** * The type of the image used to create this disk. The default and only value is RAW */ readonly sourceType: pulumi.Output; /** * [Output Only] The status of the image. An image can be used to create other resources, such as instances, only after the image has been successfully created and the status is set to READY. Possible values are FAILED, PENDING, or READY. */ readonly status: pulumi.Output; /** * Cloud Storage bucket storage location of the image (regional or multi-regional). */ readonly storageLocations: pulumi.Output; /** * Create a Image 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: ImageArgs, opts?: pulumi.CustomResourceOptions); } /** * The set of arguments for constructing a Image resource. */ export interface ImageArgs { /** * Size of the image tar.gz archive stored in Google Cloud Storage (in bytes). */ readonly archiveSizeBytes?: pulumi.Input; /** * [Output Only] Creation timestamp in RFC3339 text format. */ readonly creationTimestamp?: pulumi.Input; /** * The deprecation status associated with this image. */ readonly deprecated?: pulumi.Input; /** * An optional description of this resource. Provide this property when you create the resource. */ readonly description?: pulumi.Input; /** * Size of the image when restored onto a persistent disk (in GB). */ readonly diskSizeGb?: pulumi.Input; /** * The name of the image family to which this image belongs. You can create disks by specifying an image family instead of a specific image name. The image family always returns its latest image that is not deprecated. The name of the image family must comply with RFC1035. */ readonly family?: pulumi.Input; /** * A list of features to enable on the guest operating system. Applicable only for bootable images. Read Enabling guest operating system features to see a list of available options. */ readonly guestOsFeatures?: pulumi.Input[]>; /** * [Output Only] The unique identifier for the resource. This identifier is defined by the server. */ readonly id?: pulumi.Input; readonly image: pulumi.Input; /** * Encrypts the image using a customer-supplied encryption key. * * After you encrypt an image with a customer-supplied key, you must provide the same key if you use the image later (e.g. to create a disk from the image). * * Customer-supplied encryption keys do not protect access to metadata of the disk. * * If you do not provide an encryption key when creating the image, then the disk will be encrypted using an automatically generated key and you do not need to provide a key to use the image later. */ readonly imageEncryptionKey?: pulumi.Input; /** * [Output Only] Type of the resource. Always compute#image for images. */ readonly kind?: pulumi.Input; /** * A fingerprint for the labels being applied to this image, which is essentially a hash of the labels used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update labels. You must always provide an up-to-date fingerprint hash in order to update or change labels, otherwise the request will fail with error 412 conditionNotMet. * * To see the latest fingerprint, make a get() request to retrieve an image. */ readonly labelFingerprint?: pulumi.Input; /** * Labels to apply to this image. These can be later modified by the setLabels method. */ readonly labels?: pulumi.Input<{ [key: string]: pulumi.Input; }>; /** * Integer license codes indicating which licenses are attached to this image. */ readonly licenseCodes?: pulumi.Input[]>; /** * Any applicable license URI. */ readonly licenses?: pulumi.Input[]>; /** * Name of the resource; provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. */ readonly name?: pulumi.Input; readonly project: pulumi.Input; /** * The parameters of the raw disk image. */ readonly rawDisk?: pulumi.Input<{ [key: string]: pulumi.Input; }>; /** * A rollout policy to apply to this image. When specified, the rollout policy overrides per-zone references to the image via the associated image family. The rollout policy restricts the zones where this image is accessible when using a zonal image family reference. When the rollout policy does not include the user specified zone, or if the zone is rolled out, this image is accessible. */ readonly rolloutOverride?: pulumi.Input; /** * [Output Only] Reserved for future use. */ readonly satisfiesPzs?: pulumi.Input; /** * [Output Only] Server-defined URL for the resource. */ readonly selfLink?: pulumi.Input; /** * [Output Only] Server-defined URL for this resource's resource id. */ readonly selfLinkWithId?: pulumi.Input; /** * Set the secure boot keys of shielded instance. */ readonly shieldedInstanceInitialState?: pulumi.Input; /** * URL of the source disk used to create this image. This can be a full or valid partial URL. You must provide either this property or the rawDisk.source property but not both to create an image. For example, the following are valid values: * - https://www.googleapis.com/compute/v1/projects/project/zones/zone/disks/disk * - projects/project/zones/zone/disks/disk * - zones/zone/disks/disk */ readonly sourceDisk?: pulumi.Input; /** * The customer-supplied encryption key of the source disk. Required if the source disk is protected by a customer-supplied encryption key. */ readonly sourceDiskEncryptionKey?: pulumi.Input; /** * [Output Only] The ID value of the disk used to create this image. This value may be used to determine whether the image was taken from the current or a previous instance of a given disk name. */ readonly sourceDiskId?: pulumi.Input; /** * URL of the source image used to create this image. * * In order to create an image, you must provide the full or partial URL of one of the following: * - The selfLink URL * - This property * - The rawDisk.source URL * - The sourceDisk URL */ readonly sourceImage?: pulumi.Input; /** * The customer-supplied encryption key of the source image. Required if the source image is protected by a customer-supplied encryption key. */ readonly sourceImageEncryptionKey?: pulumi.Input; /** * [Output Only] The ID value of the image used to create this image. This value may be used to determine whether the image was taken from the current or a previous instance of a given image name. */ readonly sourceImageId?: pulumi.Input; /** * URL of the source snapshot used to create this image. * * In order to create an image, you must provide the full or partial URL of one of the following: * - The selfLink URL * - This property * - The sourceImage URL * - The rawDisk.source URL * - The sourceDisk URL */ readonly sourceSnapshot?: pulumi.Input; /** * The customer-supplied encryption key of the source snapshot. Required if the source snapshot is protected by a customer-supplied encryption key. */ readonly sourceSnapshotEncryptionKey?: pulumi.Input; /** * [Output Only] The ID value of the snapshot used to create this image. This value may be used to determine whether the snapshot was taken from the current or a previous instance of a given snapshot name. */ readonly sourceSnapshotId?: pulumi.Input; /** * The type of the image used to create this disk. The default and only value is RAW */ readonly sourceType?: pulumi.Input; /** * [Output Only] The status of the image. An image can be used to create other resources, such as instances, only after the image has been successfully created and the status is set to READY. Possible values are FAILED, PENDING, or READY. */ readonly status?: pulumi.Input; /** * Cloud Storage bucket storage location of the image (regional or multi-regional). */ readonly storageLocations?: pulumi.Input[]>; }