Idem.GCP.COMPUTE.SNAPSHOT

Idem.GCP.COMPUTE.SNAPSHOT
Idem.GCP.COMPUTE.SNAPSHOT
JSON Example
{
    "account": "string",
    "chain_name": "string",
    "count": 0,
    "description": "string",
    "label_fingerprint": "string",
    "location_hint": "string",
    "name": "string",
    "project": "string",
    "request_id": "string",
    "resource_id": "string",
    "snapshot_encryption_key": {
        "kms_key_name": "string",
        "kms_key_service_account": "string",
        "raw_key": "string",
        "rsa_encrypted_key": "string"
    },
    "snapshot_type": "string",
    "source_disk": "string",
    "source_disk_encryption_key": {
        "kms_key_name": "string",
        "kms_key_service_account": "string",
        "raw_key": "string",
        "rsa_encrypted_key": "string"
    },
    "storage_locations": [
        "string"
    ]
}
string
account
Required

The name of the vRA cloud account to use during provisioning

string
chain_name
Optional

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. Defaults to None.

integer
count
Optional

The number of resource instances to be created.

string
description
Optional

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

string
label_fingerprint
Optional

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. Defaults to None.

object
labels
Optional

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

string
location_hint
Optional

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. Defaults to None.

string
name
Required

Name of the Snapshot resource to return.

string
project
Optional

Project ID for this request.

string
request_id
Optional

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). Defaults to None.

string
resource_id
Optional

An identifier of the resource in the provider. Defaults to None.

object
snapshot_encryption_key
Optional

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. Defaults to None.

string
snapshot_type
Optional

Indicates the type of the snapshot. Enum type. Allowed values: "ARCHIVE" "STANDARD". Defaults to None.

string
source_disk
Optional

The source disk used to create this snapshot. Defaults to None.

object
source_disk_encryption_key
Optional

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

array of string
storage_locations
Optional

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