import * as pulumi from "@pulumi/pulumi"; import * as inputs from "../../types/input"; import * as outputs from "../../types/output"; import * as enums from "../../types/enums"; /** * 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; /** * The architecture of the image. Valid values are ARM64 or X86_64. */ readonly architecture: pulumi.Output; /** * Size of the image tar.gz archive stored in Google Cloud Storage (in bytes). */ readonly archiveSizeBytes: pulumi.Output; /** * 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. The image family name can be from a publicly managed image family provided by Compute Engine, or from a custom image family you create. For example, centos-stream-9 is a publicly available image family. For more information, see Image family best practices. When creating disks, you can specify 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; /** * Force image creation if true. */ readonly forceCreate: pulumi.Output; /** * A list of features to enable on the guest operating system. Applicable only for bootable images. To see a list of available options, see the guestOSfeatures[].type parameter. */ 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; /** * 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; readonly project: pulumi.Output; /** * The parameters of the raw disk image. */ readonly rawDisk: pulumi.Output; /** * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). */ readonly requestId: pulumi.Output; /** * Reserved for future use. */ readonly satisfiesPzs: pulumi.Output; /** * Server-defined URL for the resource. */ readonly selfLink: pulumi.Output; /** * Set the secure boot keys of shielded instance. */ readonly shieldedInstanceInitialState: pulumi.Output; /** * URL of the source disk used to create this 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 In order to create an image, you must provide the full or partial URL of one of the following: - The rawDisk.source URL - The sourceDisk URL - The sourceImage URL - The sourceSnapshot URL */ 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; /** * 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. The following are valid formats for the URL: - https://www.googleapis.com/compute/v1/projects/project_id/global/ images/image_name - projects/project_id/global/images/image_name In order to create an image, you must provide the full or partial URL of one of the following: - The rawDisk.source URL - The sourceDisk URL - The sourceImage URL - The sourceSnapshot 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; /** * 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. The following are valid formats for the URL: - https://www.googleapis.com/compute/v1/projects/project_id/global/ snapshots/snapshot_name - projects/project_id/global/snapshots/snapshot_name In order to create an image, you must provide the full or partial URL of one of the following: - The rawDisk.source URL - The sourceDisk URL - The sourceImage URL - The sourceSnapshot 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; /** * 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 valid value is RAW. */ readonly sourceType: pulumi.Output; /** * 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 { /** * The architecture of the image. Valid values are ARM64 or X86_64. */ architecture?: pulumi.Input; /** * Size of the image tar.gz archive stored in Google Cloud Storage (in bytes). */ archiveSizeBytes?: pulumi.Input; /** * The deprecation status associated with this image. */ deprecated?: pulumi.Input; /** * An optional description of this resource. Provide this property when you create the resource. */ description?: pulumi.Input; /** * Size of the image when restored onto a persistent disk (in GB). */ diskSizeGb?: pulumi.Input; /** * The name of the image family to which this image belongs. The image family name can be from a publicly managed image family provided by Compute Engine, or from a custom image family you create. For example, centos-stream-9 is a publicly available image family. For more information, see Image family best practices. When creating disks, you can specify 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. */ family?: pulumi.Input; /** * Force image creation if true. */ forceCreate?: pulumi.Input; /** * A list of features to enable on the guest operating system. Applicable only for bootable images. To see a list of available options, see the guestOSfeatures[].type parameter. */ guestOsFeatures?: 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. */ imageEncryptionKey?: pulumi.Input; /** * Labels to apply to this image. These can be later modified by the setLabels method. */ labels?: pulumi.Input<{ [key: string]: pulumi.Input; }>; /** * Integer license codes indicating which licenses are attached to this image. */ licenseCodes?: pulumi.Input[]>; /** * Any applicable license URI. */ 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. */ name?: pulumi.Input; project?: pulumi.Input; /** * The parameters of the raw disk image. */ rawDisk?: pulumi.Input; /** * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). */ requestId?: pulumi.Input; /** * Set the secure boot keys of shielded instance. */ shieldedInstanceInitialState?: pulumi.Input; /** * URL of the source disk used to create this 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 In order to create an image, you must provide the full or partial URL of one of the following: - The rawDisk.source URL - The sourceDisk URL - The sourceImage URL - The sourceSnapshot URL */ 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. */ sourceDiskEncryptionKey?: pulumi.Input; /** * URL of the source image used to create this image. The following are valid formats for the URL: - https://www.googleapis.com/compute/v1/projects/project_id/global/ images/image_name - projects/project_id/global/images/image_name In order to create an image, you must provide the full or partial URL of one of the following: - The rawDisk.source URL - The sourceDisk URL - The sourceImage URL - The sourceSnapshot URL */ 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. */ sourceImageEncryptionKey?: pulumi.Input; /** * URL of the source snapshot used to create this image. The following are valid formats for the URL: - https://www.googleapis.com/compute/v1/projects/project_id/global/ snapshots/snapshot_name - projects/project_id/global/snapshots/snapshot_name In order to create an image, you must provide the full or partial URL of one of the following: - The rawDisk.source URL - The sourceDisk URL - The sourceImage URL - The sourceSnapshot URL */ 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. */ sourceSnapshotEncryptionKey?: pulumi.Input; /** * The type of the image used to create this disk. The default and only valid value is RAW. */ sourceType?: pulumi.Input; /** * Cloud Storage bucket storage location of the image (regional or multi-regional). */ storageLocations?: pulumi.Input[]>; }