Snapshot

class Snapshot : KotlinCustomResource

Creates a snapshot in the specified project using the data included in the request. For regular snapshot creation, consider using this method instead of disks.createSnapshot, as this method supports more features, such as creating snapshots in a project different from the source disk project.

Properties

Link copied to clipboard
val architecture: Output<String>

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

Link copied to clipboard
val autoCreated: Output<Boolean>

Set to true if snapshots are automatically created by applying resource policy on the target disk.

Link copied to clipboard
val chainName: Output<String>

Creates the new snapshot in the snapshot chain labeled with the specified name. The chain name must be 1-63 characters long and comply with RFC1035. This is an uncommon option only for advanced service owners who needs to create separate snapshot chains, for example, for chargeback tracking. When you describe your snapshot resource, this field is visible only if it has a non-empty value.

Link copied to clipboard

Size in bytes of the snapshot at creation time.

Link copied to clipboard

Creation timestamp in RFC3339 text format.

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 source disk, specified in GB.

Link copied to clipboard
val downloadBytes: Output<String>

Number of bytes downloaded to restore a snapshot to a disk.

Link copied to clipboard

Whether this snapshot is created from a confidential compute mode disk. see go/confidential-mode-in-arcus for details. Output Only: This field is not set by user, but from source disk.

Link copied to clipboard
val guestFlush: Output<Boolean>

Input Only Whether to attempt an application consistent snapshot by informing the OS to prepare for the snapshot process.

Link copied to clipboard

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.

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

Type of the resource. Always compute#snapshot for Snapshot resources.

Link copied to clipboard

A fingerprint for the labels being applied to this snapshot, which is essentially a hash of the labels set 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 a snapshot.

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

Labels to apply to this snapshot. These can be later modified by the setLabels method. Label values may be empty.

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

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

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

A list of public visible licenses that apply to this snapshot. This can be because the original image had licenses attached (such as a Windows image).

Link copied to clipboard
val locationHint: Output<String>

An opaque location hint used to place the snapshot close to other resources. This field is for use by internal tools that use the public API.

Link copied to clipboard
val maxRetentionDays: Output<Int>

Number of days the snapshot should be retained before being deleted automatically.

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

Encrypts the snapshot using a customer-supplied encryption key. After you encrypt a snapshot using a customer-supplied key, you must provide the same key if you use the snapshot later. For example, you must provide the encryption key when you create a disk from the encrypted snapshot in a future request. Customer-supplied encryption keys do not protect access to metadata of the snapshot. If you do not provide an encryption key when creating the snapshot, then the snapshot will be encrypted using an automatically generated key and you do not need to provide a key to use the snapshot later.

Link copied to clipboard
val snapshotType: Output<String>

Indicates the type of the snapshot.

Link copied to clipboard
val sourceDisk: Output<String>

The source disk used to create this snapshot.

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

The source disk whose recovery checkpoint will be used to create this snapshot.

Link copied to clipboard
val sourceDiskId: Output<String>

The ID value of the disk used to create this snapshot. This value may be used to determine whether the snapshot was taken from the current or a previous instance of a given disk name.

Link copied to clipboard

The source instant snapshot used to create this snapshot. You can provide this as a partial or full URL to the resource. For example, the following are valid values: - https://www.googleapis.com/compute/v1/projects/project/zones/zone /instantSnapshots/instantSnapshot - projects/project/zones/zone/instantSnapshots/instantSnapshot - zones/zone/instantSnapshots/instantSnapshot

Link copied to clipboard

The unique ID of the instant snapshot used to create this snapshot. This value identifies the exact instant snapshot that was used to create this persistent disk. For example, if you created the persistent disk from an instant snapshot that was later deleted and recreated under the same name, the source instant snapshot ID would identify the exact instant snapshot that was used.

Link copied to clipboard

URL of the resource policy which created this scheduled snapshot.

Link copied to clipboard

ID of the resource policy which created this scheduled snapshot.

Link copied to clipboard
val status: Output<String>

The status of the snapshot. This can be CREATING, DELETING, FAILED, READY, or UPLOADING.

Link copied to clipboard
val storageBytes: Output<String>

A size of the storage used by the snapshot. As snapshots share storage, this number is expected to change with snapshot creation/deletion.

Link copied to clipboard

An indicator whether storageBytes is in a stable state or it is being adjusted as a result of shared storage reallocation. This status can either be UPDATING, meaning the size of the snapshot is being updated, or UP_TO_DATE, meaning the size of the snapshot is up-to-date.

Link copied to clipboard

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

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

A list of user provided licenses represented by a list of URLs to the license resource.