Compute Engine Snapshot

A Compute Engine Snapshot in Google Cloud is a point-in-time backup of a persistent disk. It captures the disk’s data at the moment the snapshot is created, allowing you to restore or create new disks from it later. Snapshots are incremental, meaning only changes since the last snapshot are stored, which saves storage space and reduces costs.

gcp.compute_snapshot

Fields

TitleIDTypeData TypeDescription
_keycorestring
ancestorscorearray<string>
architecturecorestringOutput only. [Output Only] The architecture of the snapshot. Valid values are ARM64 or X86_64.
auto_createdcoreboolOutput only. [Output Only] Set to true if snapshots are automatically created by applying resource policy on the target disk.
chain_namecorestringCreates 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.
creation_size_bytescoreint64Output only. [Output Only] Size in bytes of the snapshot at creation time.
creation_timestampcoretimestampOutput only. [Output Only] Creation timestamp inRFC3339 text format.
datadog_display_namecorestring
descriptioncorestringAn optional description of this resource. Provide this property when you create the resource.
disk_size_gbcoreint64Output only. [Output Only] Size of the source disk, specified in GB.
download_bytescoreint64Output only. [Output Only] Number of bytes downloaded to restore a snapshot to a disk.
enable_confidential_computecoreboolOutput only. Whether this snapshot is created from a confidential compute mode disk. [Output Only]: This field is not set by user, but from source disk.
gcp_statuscorestring[Output Only] The status of the snapshot. This can be CREATING, DELETING, FAILED, READY, or UPLOADING. Possible values: ['CREATING', 'DELETING', 'FAILED', 'READY', 'UPLOADING']. Values descriptions: ['Snapshot creation is in progress.', 'Snapshot is currently being deleted.', 'Snapshot creation failed.', 'Snapshot has been created successfully.', 'Snapshot is being uploaded.']
guest_flushcorebool[Input Only] Whether to attempt an application consistent snapshot by informing the OS to prepare for the snapshot process.
guest_os_featurescorejsonOutput only. [Output Only] 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.
idcorestringOutput only. [Output Only] The unique identifier for the resource. This identifier is defined by the server.
kindcorestringOutput only. [Output Only] Type of the resource. Always compute#snapshot for Snapshot resources.
labelscorearray<string>Labels to apply to this snapshot. These can be later modified by the setLabels method. Label values may be empty.
license_codescorearray<string>Output only. [Output Only] Integer license codes indicating which licenses are attached to this snapshot.
licensescorearray<string>Output only. [Output Only] 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).
location_hintcorestringAn 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.
namecorestringName of the resource; provided by the client when the resource is created. The name must be 1-63 characters long, and comply withRFC1035. 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.
organization_idcorestring
parentcorestring
project_idcorestring
project_numbercorestring
region_idcorestring
resource_namecorestring
satisfies_pzicoreboolOutput only. Reserved for future use.
satisfies_pzscoreboolOutput only. [Output Only] Reserved for future use.
self_linkcorestringOutput only. [Output Only] Server-defined URL for the resource.
snapshot_typecorestringIndicates the type of the snapshot.
source_diskcorestringThe source disk used to create this snapshot.
source_disk_for_recovery_checkpointcorestringThe source disk whose recovery checkpoint will be used to create this snapshot.
source_disk_idcorestringOutput only. [Output Only] 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.
source_instant_snapshotcorestringThe 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
source_instant_snapshot_idcorestringOutput only. [Output Only] 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 snapshot. For example, if you created the snapshot 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.
source_snapshot_schedule_policycorestringOutput only. [Output Only] URL of the resource policy which created this scheduled snapshot.
source_snapshot_schedule_policy_idcorestringOutput only. [Output Only] ID of the resource policy which created this scheduled snapshot.
storage_bytescoreint64Output only. [Output Only] A size of the storage used by the snapshot. As snapshots share storage, this number is expected to change with snapshot creation/deletion.
storage_bytes_statuscorestringOutput only. [Output Only] 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.
storage_locationscorearray<string>Cloud Storage bucket storage location of the snapshot (regional or multi-regional).
tagscorehstore_csv
zone_idcorestring