Image

class Image : KotlinCustomResource

Creates an image in the specified project using the data included in the request.

Properties

Link copied to clipboard
val architecture: Output<String>

The architecture of the image. Valid values are ARM64 or X86_64.

Link copied to clipboard

Size of the image tar.gz archive stored in Google Cloud Storage (in bytes).

Link copied to clipboard

Creation timestamp in RFC3339 text format.

Link copied to clipboard

The deprecation status associated with this image.

Link copied to clipboard
val description: Output<String>

An optional description of this resource. Provide this property when you create the resource.

Link copied to clipboard
val diskSizeGb: Output<String>

Size of the image when restored onto a persistent disk (in GB).

Link copied to clipboard
val family: Output<String>

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.

Link copied to clipboard
val forceCreate: Output<Boolean>?

Force image creation if true.

Link copied to clipboard

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.

Link copied to clipboard
val id: Output<String>
Link copied to clipboard

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.

Link copied to clipboard
val kind: Output<String>

Type of the resource. Always compute#image for images.

Link copied to clipboard

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.

Link copied to clipboard
val labels: Output<Map<String, String>>

Labels to apply to this image. These can be later modified by the setLabels method.

Link copied to clipboard
val licenseCodes: Output<List<String>>

Integer license codes indicating which licenses are attached to this image.

Link copied to clipboard
val licenses: Output<List<String>>

Any applicable license URI.

Link copied to clipboard
val locked: Output<Boolean>

A flag for marketplace VM disk created from the image, which is designed for marketplace VM disk to prevent the proprietary data on the disk from being accessed unwantedly. The flag will be inherited by the disk created from the image. The disk with locked flag set to true will be prohibited from performing the operations below: - R/W or R/O disk attach - Disk detach, if disk is created via create-on-create - Create images - Create snapshots - Create disk clone (create disk from the current disk) The image with the locked field set to true will be prohibited from performing the operations below: - Create images from the current image - Update the locked field for the current image The instance with at least one disk with locked flag set to true will be prohibited from performing the operations below: - Secondary disk attach - Create instant snapshot - Create machine images - Create instance template - Delete the instance with --keep-disk parameter set to true

Link copied to clipboard
val name: Output<String>

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.

Link copied to clipboard
val project: Output<String>
Link copied to clipboard
val pulumiChildResources: Set<KotlinResource>
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard

The parameters of the raw disk image.

Link copied to clipboard
val requestId: Output<String>?

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).

Link copied to clipboard

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. The rollout policy for this image is read-only, except for allowlisted users. This field might not be configured. To view the latest non-deprecated image in a specific zone, use the imageFamilyViews.get method.

Link copied to clipboard
val satisfiesPzs: Output<Boolean>

Reserved for future use.

Link copied to clipboard
val selfLink: Output<String>

Server-defined URL for the resource.

Link copied to clipboard
val selfLinkWithId: Output<String>

Server-defined URL for this resource's resource id.

Link copied to clipboard

Set the secure boot keys of shielded instance.

Link copied to clipboard
val sourceDisk: Output<String>

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

Link copied to clipboard

The customer-supplied encryption key of the source disk. Required if the source disk is protected by a customer-supplied encryption key.

Link copied to clipboard
val sourceDiskId: Output<String>

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.

Link copied to clipboard
val sourceImage: Output<String>

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

Link copied to clipboard

The customer-supplied encryption key of the source image. Required if the source image is protected by a customer-supplied encryption key.

Link copied to clipboard
val sourceImageId: Output<String>

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.

Link copied to clipboard
val sourceSnapshot: Output<String>

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

Link copied to clipboard

The customer-supplied encryption key of the source snapshot. Required if the source snapshot is protected by a customer-supplied encryption key.

Link copied to clipboard

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.

Link copied to clipboard
val sourceType: Output<String>

The type of the image used to create this disk. The default and only valid value is RAW.

Link copied to clipboard
val status: Output<String>

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.

Link copied to clipboard

Cloud Storage bucket storage location of the image (regional or multi-regional).

Link copied to clipboard
val urn: Output<String>
Link copied to clipboard
val userLicenses: Output<List<String>>

A list of publicly visible user-licenses. Unlike regular licenses, user provided licenses can be modified after the disk is created. This includes a list of URLs to the license resource. For example, to provide a debian license: https://www.googleapis.com/compute/v1/projects/debian-cloud/global/licenses/debian-9-stretch