This product is not supported for your selected Datadog site. ().

gcp_compute_snapshot

ancestors

Type: UNORDERED_LIST_STRING

architecture

Type: STRING
Provider name: architecture
Description: [Output Only] The architecture of the snapshot. Valid values are ARM64 or X86_64.
Possible values:

  • ARCHITECTURE_UNSPECIFIED - Default value indicating Architecture is not set.
  • ARM64 - Machines with architecture ARM64
  • X86_64 - Machines with architecture X86_64

auto_created

Type: BOOLEAN
Provider name: autoCreated
Description: [Output Only] Set to true if snapshots are automatically created by applying resource policy on the target disk.

chain_name

Type: STRING
Provider name: chainName
Description: 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.

creation_size_bytes

Type: INT64
Provider name: creationSizeBytes
Description: [Output Only] Size in bytes of the snapshot at creation time.

creation_timestamp

Type: TIMESTAMP
Provider name: creationTimestamp
Description: [Output Only] Creation timestamp in RFC3339 text format.

description

Type: STRING
Provider name: description
Description: An optional description of this resource. Provide this property when you create the resource.

disk_size_gb

Type: INT64
Provider name: diskSizeGb
Description: [Output Only] Size of the source disk, specified in GB.

download_bytes

Type: INT64
Provider name: downloadBytes
Description: [Output Only] Number of bytes downloaded to restore a snapshot to a disk.

enable_confidential_compute

Type: BOOLEAN
Provider name: enableConfidentialCompute
Description: 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_status

Type: STRING
Provider name: status
Description: [Output Only] The status of the snapshot. This can be CREATING, DELETING, FAILED, READY, or UPLOADING.
Possible values:

  • CREATING - Snapshot creation is in progress.
  • DELETING - Snapshot is currently being deleted.
  • FAILED - Snapshot creation failed.
  • READY - Snapshot has been created successfully.
  • UPLOADING - Snapshot is being uploaded.

guest_flush

Type: BOOLEAN
Provider name: guestFlush
Description: [Input Only] Whether to attempt an application consistent snapshot by informing the OS to prepare for the snapshot process.

guest_os_features

Type: UNORDERED_LIST_STRUCT
Provider name: guestOsFeatures
Description: [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.

  • type
    Type: STRING
    Provider name: type
    Description: The ID of a supported feature. To add multiple values, use commas to separate values. Set to one or more of the following values: - VIRTIO_SCSI_MULTIQUEUE - WINDOWS - MULTI_IP_SUBNET - UEFI_COMPATIBLE - GVNIC - SEV_CAPABLE - SUSPEND_RESUME_COMPATIBLE - SEV_LIVE_MIGRATABLE_V2 - SEV_SNP_CAPABLE - TDX_CAPABLE - IDPF - SNP_SVSM_CAPABLE For more information, see Enabling guest operating system features.
    Possible values:
    • FEATURE_TYPE_UNSPECIFIED
    • GVNIC
    • IDPF
    • MULTI_IP_SUBNET
    • SECURE_BOOT
    • SEV_CAPABLE
    • SEV_LIVE_MIGRATABLE
    • SEV_LIVE_MIGRATABLE_V2
    • SEV_SNP_CAPABLE
    • TDX_CAPABLE
    • UEFI_COMPATIBLE
    • VIRTIO_SCSI_MULTIQUEUE
    • WINDOWS

id

Type: STRING
Provider name: id
Description: [Output Only] The unique identifier for the resource. This identifier is defined by the server.

kind

Type: STRING
Provider name: kind
Description: [Output Only] Type of the resource. Always compute#snapshot for Snapshot resources.

labels

Type: UNORDERED_LIST_STRING

license_codes

Type: UNORDERED_LIST_STRING
Provider name: licenseCodes
Description: [Output Only] Integer license codes indicating which licenses are attached to this snapshot.

licenses

Type: UNORDERED_LIST_STRING
Provider name: licenses
Description: [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_hint

Type: STRING
Provider name: locationHint
Description: 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.

name

Type: STRING
Provider name: name
Description: 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.

organization_id

Type: STRING

parent

Type: STRING

project_id

Type: STRING

project_number

Type: STRING

resource_name

Type: STRING

satisfies_pzi

Type: BOOLEAN
Provider name: satisfiesPzi
Description: Output only. Reserved for future use.

satisfies_pzs

Type: BOOLEAN
Provider name: satisfiesPzs
Description: [Output Only] Reserved for future use.

Type: STRING
Provider name: selfLink
Description: [Output Only] Server-defined URL for the resource.

snapshot_encryption_key

Type: STRUCT
Provider name: snapshotEncryptionKey
Description: 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.

  • kms_key_name
    Type: STRING
    Provider name: kmsKeyName
    Description: The name of the encryption key that is stored in Google Cloud KMS. For example: “kmsKeyName”: “projects/kms_project_id/locations/region/keyRings/ key_region/cryptoKeys/key The fully-qualifed key name may be returned for resource GET requests. For example: “kmsKeyName”: “projects/kms_project_id/locations/region/keyRings/ key_region/cryptoKeys/key /cryptoKeyVersions/1
  • kms_key_service_account
    Type: STRING
    Provider name: kmsKeyServiceAccount
    Description: The service account being used for the encryption request for the given KMS key. If absent, the Compute Engine default service account is used. For example: “kmsKeyServiceAccount”: “name@project_id.iam.gserviceaccount.com/
  • raw_key
    Type: STRING
    Provider name: rawKey
    Description: Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource. You can provide either the rawKey or the rsaEncryptedKey. For example: “rawKey”: “SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0="
  • rsa_encrypted_key
    Type: STRING
    Provider name: rsaEncryptedKey
    Description: Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit customer-supplied encryption key to either encrypt or decrypt this resource. You can provide either the rawKey or the rsaEncryptedKey. For example: “rsaEncryptedKey”: “ieCx/NcW06PcT7Ep1X6LUTc/hLvUDYyzSZPPVCVPTVEohpeHASqC8uw5TzyO9U+Fka9JFH z0mBibXUInrC/jEk014kCK/NPjYgEMOyssZ4ZINPKxlUh2zn1bV+MCaTICrdmuSBTWlUUiFoD D6PYznLwh8ZNdaheCeZ8ewEXgFQ8V+sDroLaN3Xs3MDTXQEMMoNUXMCZEIpg9Vtp9x2oe==” The key must meet the following requirements before you can provide it to Compute Engine: 1. The key is wrapped using a RSA public key certificate provided by Google. 2. After being wrapped, the key must be encoded in RFC 4648 base64 encoding. Gets the RSA public key certificate provided by Google at: https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem
  • sha256
    Type: STRING
    Provider name: sha256
    Description: [Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource.

snapshot_type

Type: STRING
Provider name: snapshotType
Description: Indicates the type of the snapshot.
Possible values:

  • ARCHIVE
  • STANDARD

source_disk

Type: STRING
Provider name: sourceDisk
Description: The source disk used to create this snapshot.

source_disk_encryption_key

Type: STRUCT
Provider name: sourceDiskEncryptionKey
Description: The customer-supplied encryption key of the source disk. Required if the source disk is protected by a customer-supplied encryption key.

  • kms_key_name
    Type: STRING
    Provider name: kmsKeyName
    Description: The name of the encryption key that is stored in Google Cloud KMS. For example: “kmsKeyName”: “projects/kms_project_id/locations/region/keyRings/ key_region/cryptoKeys/key The fully-qualifed key name may be returned for resource GET requests. For example: “kmsKeyName”: “projects/kms_project_id/locations/region/keyRings/ key_region/cryptoKeys/key /cryptoKeyVersions/1
  • kms_key_service_account
    Type: STRING
    Provider name: kmsKeyServiceAccount
    Description: The service account being used for the encryption request for the given KMS key. If absent, the Compute Engine default service account is used. For example: “kmsKeyServiceAccount”: “name@project_id.iam.gserviceaccount.com/
  • raw_key
    Type: STRING
    Provider name: rawKey
    Description: Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource. You can provide either the rawKey or the rsaEncryptedKey. For example: “rawKey”: “SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0="
  • rsa_encrypted_key
    Type: STRING
    Provider name: rsaEncryptedKey
    Description: Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit customer-supplied encryption key to either encrypt or decrypt this resource. You can provide either the rawKey or the rsaEncryptedKey. For example: “rsaEncryptedKey”: “ieCx/NcW06PcT7Ep1X6LUTc/hLvUDYyzSZPPVCVPTVEohpeHASqC8uw5TzyO9U+Fka9JFH z0mBibXUInrC/jEk014kCK/NPjYgEMOyssZ4ZINPKxlUh2zn1bV+MCaTICrdmuSBTWlUUiFoD D6PYznLwh8ZNdaheCeZ8ewEXgFQ8V+sDroLaN3Xs3MDTXQEMMoNUXMCZEIpg9Vtp9x2oe==” The key must meet the following requirements before you can provide it to Compute Engine: 1. The key is wrapped using a RSA public key certificate provided by Google. 2. After being wrapped, the key must be encoded in RFC 4648 base64 encoding. Gets the RSA public key certificate provided by Google at: https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem
  • sha256
    Type: STRING
    Provider name: sha256
    Description: [Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource.

source_disk_for_recovery_checkpoint

Type: STRING
Provider name: sourceDiskForRecoveryCheckpoint
Description: The source disk whose recovery checkpoint will be used to create this snapshot.

source_disk_id

Type: STRING
Provider name: sourceDiskId
Description: [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_snapshot

Type: STRING
Provider name: sourceInstantSnapshot
Description: 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

source_instant_snapshot_encryption_key

Type: STRUCT
Provider name: sourceInstantSnapshotEncryptionKey
Description: Customer provided encryption key when creating Snapshot from Instant Snapshot.

  • kms_key_name
    Type: STRING
    Provider name: kmsKeyName
    Description: The name of the encryption key that is stored in Google Cloud KMS. For example: “kmsKeyName”: “projects/kms_project_id/locations/region/keyRings/ key_region/cryptoKeys/key The fully-qualifed key name may be returned for resource GET requests. For example: “kmsKeyName”: “projects/kms_project_id/locations/region/keyRings/ key_region/cryptoKeys/key /cryptoKeyVersions/1
  • kms_key_service_account
    Type: STRING
    Provider name: kmsKeyServiceAccount
    Description: The service account being used for the encryption request for the given KMS key. If absent, the Compute Engine default service account is used. For example: “kmsKeyServiceAccount”: “name@project_id.iam.gserviceaccount.com/
  • raw_key
    Type: STRING
    Provider name: rawKey
    Description: Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource. You can provide either the rawKey or the rsaEncryptedKey. For example: “rawKey”: “SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0="
  • rsa_encrypted_key
    Type: STRING
    Provider name: rsaEncryptedKey
    Description: Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit customer-supplied encryption key to either encrypt or decrypt this resource. You can provide either the rawKey or the rsaEncryptedKey. For example: “rsaEncryptedKey”: “ieCx/NcW06PcT7Ep1X6LUTc/hLvUDYyzSZPPVCVPTVEohpeHASqC8uw5TzyO9U+Fka9JFH z0mBibXUInrC/jEk014kCK/NPjYgEMOyssZ4ZINPKxlUh2zn1bV+MCaTICrdmuSBTWlUUiFoD D6PYznLwh8ZNdaheCeZ8ewEXgFQ8V+sDroLaN3Xs3MDTXQEMMoNUXMCZEIpg9Vtp9x2oe==” The key must meet the following requirements before you can provide it to Compute Engine: 1. The key is wrapped using a RSA public key certificate provided by Google. 2. After being wrapped, the key must be encoded in RFC 4648 base64 encoding. Gets the RSA public key certificate provided by Google at: https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem
  • sha256
    Type: STRING
    Provider name: sha256
    Description: [Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource.

source_instant_snapshot_id

Type: STRING
Provider name: sourceInstantSnapshotId
Description: [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_policy

Type: STRING
Provider name: sourceSnapshotSchedulePolicy
Description: [Output Only] URL of the resource policy which created this scheduled snapshot.

source_snapshot_schedule_policy_id

Type: STRING
Provider name: sourceSnapshotSchedulePolicyId
Description: [Output Only] ID of the resource policy which created this scheduled snapshot.

storage_bytes

Type: INT64
Provider name: storageBytes
Description: [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_status

Type: STRING
Provider name: storageBytesStatus
Description: [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.
Possible values:

  • UPDATING
  • UP_TO_DATE

storage_locations

Type: UNORDERED_LIST_STRING
Provider name: storageLocations
Description: Cloud Storage bucket storage location of the snapshot (regional or multi-regional).

tags

Type: UNORDERED_LIST_STRING