Google Cloud Native v0.31.1, Jul 20 23

Google Cloud Native is in preview. Google Cloud Classic is fully supported.

Google Cloud Native v0.31.1 published on Thursday, Jul 20, 2023 by Pulumi

pulumi/pulumi-google-native

google-native.compute/beta.getSnapshot

Explore with Pulumi AI

Google Cloud Native is in preview. Google Cloud Classic is fully supported.

Google Cloud Native v0.31.1 published on Thursday, Jul 20, 2023 by Pulumi

pulumi/pulumi-google-native

Using getSnapshot

Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

function getSnapshot(args: GetSnapshotArgs, opts?: InvokeOptions): Promise<GetSnapshotResult>
function getSnapshotOutput(args: GetSnapshotOutputArgs, opts?: InvokeOptions): Output<GetSnapshotResult>

def get_snapshot(project: Optional[str] = None,
                 snapshot: Optional[str] = None,
                 opts: Optional[InvokeOptions] = None) -> GetSnapshotResult
def get_snapshot_output(project: Optional[pulumi.Input[str]] = None,
                 snapshot: Optional[pulumi.Input[str]] = None,
                 opts: Optional[InvokeOptions] = None) -> Output[GetSnapshotResult]

func LookupSnapshot(ctx *Context, args *LookupSnapshotArgs, opts ...InvokeOption) (*LookupSnapshotResult, error)
func LookupSnapshotOutput(ctx *Context, args *LookupSnapshotOutputArgs, opts ...InvokeOption) LookupSnapshotResultOutput

> Note: This function is named LookupSnapshot in the Go SDK.

public static class GetSnapshot 
{
    public static Task<GetSnapshotResult> InvokeAsync(GetSnapshotArgs args, InvokeOptions? opts = null)
    public static Output<GetSnapshotResult> Invoke(GetSnapshotInvokeArgs args, InvokeOptions? opts = null)
}

public static CompletableFuture<GetSnapshotResult> getSnapshot(GetSnapshotArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet

fn::invoke:
  function: google-native:compute/beta:getSnapshot
  arguments:
    # arguments dictionary

The following arguments are supported:

Snapshot string
Project string

Snapshot string
Project string

snapshot String
project String

snapshot string
project string

snapshot str
project str

snapshot String
project String

getSnapshot Result

The following output properties are available:

Architecture string: The architecture of the snapshot. Valid values are ARM64 or X86_64.
AutoCreated bool: Set to true if snapshots are automatically created by applying resource policy on the target disk.
ChainName 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.
CreationSizeBytes string: Size in bytes of the snapshot at creation time.
CreationTimestamp string: Creation timestamp in RFC3339 text format.
Description string: An optional description of this resource. Provide this property when you create the resource.
DiskSizeGb string: Size of the source disk, specified in GB.
DownloadBytes string: Number of bytes downloaded to restore a snapshot to a disk.
GuestFlush bool: [Input Only] Whether to attempt an application consistent snapshot by informing the OS to prepare for the snapshot process.
Kind string: Type of the resource. Always compute#snapshot for Snapshot resources.
LabelFingerprint string: 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.
Labels Dictionary<string, string>: Labels to apply to this snapshot. These can be later modified by the setLabels method. Label values may be empty.
LicenseCodes List<string>: Integer license codes indicating which licenses are attached to this snapshot.
Licenses 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).
LocationHint 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.
Name 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.
SatisfiesPzs bool: Reserved for future use.
SelfLink string: Server-defined URL for the resource.
SnapshotEncryptionKey Pulumi.GoogleNative.Compute.Beta.Outputs.CustomerEncryptionKeyResponse: 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.
SnapshotType string: Indicates the type of the snapshot.
SourceDisk string: The source disk used to create this snapshot.
SourceDiskEncryptionKey Pulumi.GoogleNative.Compute.Beta.Outputs.CustomerEncryptionKeyResponse: The customer-supplied encryption key of the source disk. Required if the source disk is protected by a customer-supplied encryption key.
SourceDiskId 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.
SourceInstantSnapshot string: 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
SourceInstantSnapshotId string: 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.
SourceSnapshotSchedulePolicy string: URL of the resource policy which created this scheduled snapshot.
SourceSnapshotSchedulePolicyId string: ID of the resource policy which created this scheduled snapshot.
Status string: The status of the snapshot. This can be CREATING, DELETING, FAILED, READY, or UPLOADING.
StorageBytes string: A size of the storage used by the snapshot. As snapshots share storage, this number is expected to change with snapshot creation/deletion.
StorageBytesStatus string: 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.
StorageLocations List<string>: Cloud Storage bucket storage location of the snapshot (regional or multi-regional).
UserLicenses List<string>: A list of user provided licenses represented by a list of URLs to the license resource.

Architecture string: The architecture of the snapshot. Valid values are ARM64 or X86_64.
AutoCreated bool: Set to true if snapshots are automatically created by applying resource policy on the target disk.
ChainName 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.
CreationSizeBytes string: Size in bytes of the snapshot at creation time.
CreationTimestamp string: Creation timestamp in RFC3339 text format.
Description string: An optional description of this resource. Provide this property when you create the resource.
DiskSizeGb string: Size of the source disk, specified in GB.
DownloadBytes string: Number of bytes downloaded to restore a snapshot to a disk.
GuestFlush bool: [Input Only] Whether to attempt an application consistent snapshot by informing the OS to prepare for the snapshot process.
Kind string: Type of the resource. Always compute#snapshot for Snapshot resources.
LabelFingerprint string: 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.
Labels map[string]string: Labels to apply to this snapshot. These can be later modified by the setLabels method. Label values may be empty.
LicenseCodes []string: Integer license codes indicating which licenses are attached to this snapshot.
Licenses []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).
LocationHint 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.
Name 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.
SatisfiesPzs bool: Reserved for future use.
SelfLink string: Server-defined URL for the resource.
SnapshotEncryptionKey CustomerEncryptionKeyResponse: 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.
SnapshotType string: Indicates the type of the snapshot.
SourceDisk string: The source disk used to create this snapshot.
SourceDiskEncryptionKey CustomerEncryptionKeyResponse: The customer-supplied encryption key of the source disk. Required if the source disk is protected by a customer-supplied encryption key.
SourceDiskId 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.
SourceInstantSnapshot string: 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
SourceInstantSnapshotId string: 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.
SourceSnapshotSchedulePolicy string: URL of the resource policy which created this scheduled snapshot.
SourceSnapshotSchedulePolicyId string: ID of the resource policy which created this scheduled snapshot.
Status string: The status of the snapshot. This can be CREATING, DELETING, FAILED, READY, or UPLOADING.
StorageBytes string: A size of the storage used by the snapshot. As snapshots share storage, this number is expected to change with snapshot creation/deletion.
StorageBytesStatus string: 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.
StorageLocations []string: Cloud Storage bucket storage location of the snapshot (regional or multi-regional).
UserLicenses []string: A list of user provided licenses represented by a list of URLs to the license resource.

architecture String: The architecture of the snapshot. Valid values are ARM64 or X86_64.
autoCreated Boolean: Set to true if snapshots are automatically created by applying resource policy on the target disk.
chainName 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.
creationSizeBytes String: Size in bytes of the snapshot at creation time.
creationTimestamp String: Creation timestamp in RFC3339 text format.
description String: An optional description of this resource. Provide this property when you create the resource.
diskSizeGb String: Size of the source disk, specified in GB.
downloadBytes String: Number of bytes downloaded to restore a snapshot to a disk.
guestFlush Boolean: [Input Only] Whether to attempt an application consistent snapshot by informing the OS to prepare for the snapshot process.
kind String: Type of the resource. Always compute#snapshot for Snapshot resources.
labelFingerprint String: 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.
labels Map<String,String>: Labels to apply to this snapshot. These can be later modified by the setLabels method. Label values may be empty.
licenseCodes List<String>: Integer license codes indicating which licenses are attached to this snapshot.
licenses 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).
locationHint 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.
name 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.
satisfiesPzs Boolean: Reserved for future use.
selfLink String: Server-defined URL for the resource.
snapshotEncryptionKey CustomerEncryptionKeyResponse: 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.
snapshotType String: Indicates the type of the snapshot.
sourceDisk String: The source disk used to create this snapshot.
sourceDiskEncryptionKey CustomerEncryptionKeyResponse: The customer-supplied encryption key of the source disk. Required if the source disk is protected by a customer-supplied encryption key.
sourceDiskId 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.
sourceInstantSnapshot String: 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
sourceInstantSnapshotId String: 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.
sourceSnapshotSchedulePolicy String: URL of the resource policy which created this scheduled snapshot.
sourceSnapshotSchedulePolicyId String: ID of the resource policy which created this scheduled snapshot.
status String: The status of the snapshot. This can be CREATING, DELETING, FAILED, READY, or UPLOADING.
storageBytes String: A size of the storage used by the snapshot. As snapshots share storage, this number is expected to change with snapshot creation/deletion.
storageBytesStatus String: 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.
storageLocations List<String>: Cloud Storage bucket storage location of the snapshot (regional or multi-regional).
userLicenses List<String>: A list of user provided licenses represented by a list of URLs to the license resource.

architecture string: The architecture of the snapshot. Valid values are ARM64 or X86_64.
autoCreated boolean: Set to true if snapshots are automatically created by applying resource policy on the target disk.
chainName 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.
creationSizeBytes string: Size in bytes of the snapshot at creation time.
creationTimestamp string: Creation timestamp in RFC3339 text format.
description string: An optional description of this resource. Provide this property when you create the resource.
diskSizeGb string: Size of the source disk, specified in GB.
downloadBytes string: Number of bytes downloaded to restore a snapshot to a disk.
guestFlush boolean: [Input Only] Whether to attempt an application consistent snapshot by informing the OS to prepare for the snapshot process.
kind string: Type of the resource. Always compute#snapshot for Snapshot resources.
labelFingerprint string: 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.
labels {[key: string]: string}: Labels to apply to this snapshot. These can be later modified by the setLabels method. Label values may be empty.
licenseCodes string[]: Integer license codes indicating which licenses are attached to this snapshot.
licenses 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).
locationHint 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.
name 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.
satisfiesPzs boolean: Reserved for future use.
selfLink string: Server-defined URL for the resource.
snapshotEncryptionKey CustomerEncryptionKeyResponse: 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.
snapshotType string: Indicates the type of the snapshot.
sourceDisk string: The source disk used to create this snapshot.
sourceDiskEncryptionKey CustomerEncryptionKeyResponse: The customer-supplied encryption key of the source disk. Required if the source disk is protected by a customer-supplied encryption key.
sourceDiskId 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.
sourceInstantSnapshot string: 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
sourceInstantSnapshotId string: 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.
sourceSnapshotSchedulePolicy string: URL of the resource policy which created this scheduled snapshot.
sourceSnapshotSchedulePolicyId string: ID of the resource policy which created this scheduled snapshot.
status string: The status of the snapshot. This can be CREATING, DELETING, FAILED, READY, or UPLOADING.
storageBytes string: A size of the storage used by the snapshot. As snapshots share storage, this number is expected to change with snapshot creation/deletion.
storageBytesStatus string: 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.
storageLocations string[]: Cloud Storage bucket storage location of the snapshot (regional or multi-regional).
userLicenses string[]: A list of user provided licenses represented by a list of URLs to the license resource.

architecture str: The architecture of the snapshot. Valid values are ARM64 or X86_64.
auto_created bool: Set to true if snapshots are automatically created by applying resource policy on the target disk.
chain_name str: 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 str: Size in bytes of the snapshot at creation time.
creation_timestamp str: Creation timestamp in RFC3339 text format.
description str: An optional description of this resource. Provide this property when you create the resource.
disk_size_gb str: Size of the source disk, specified in GB.
download_bytes str: Number of bytes downloaded to restore a snapshot to a disk.
guest_flush bool: [Input Only] Whether to attempt an application consistent snapshot by informing the OS to prepare for the snapshot process.
kind str: Type of the resource. Always compute#snapshot for Snapshot resources.
label_fingerprint str: 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.
labels Mapping[str, str]: Labels to apply to this snapshot. These can be later modified by the setLabels method. Label values may be empty.
license_codes Sequence[str]: Integer license codes indicating which licenses are attached to this snapshot.
licenses Sequence[str]: 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 str: 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 str: 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.
satisfies_pzs bool: Reserved for future use.
self_link str: Server-defined URL for the resource.
snapshot_encryption_key CustomerEncryptionKeyResponse: 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.
snapshot_type str: Indicates the type of the snapshot.
source_disk str: The source disk used to create this snapshot.
source_disk_encryption_key CustomerEncryptionKeyResponse: The customer-supplied encryption key of the source disk. Required if the source disk is protected by a customer-supplied encryption key.
source_disk_id str: 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 str: 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_id str: 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.
source_snapshot_schedule_policy str: URL of the resource policy which created this scheduled snapshot.
source_snapshot_schedule_policy_id str: ID of the resource policy which created this scheduled snapshot.
status str: The status of the snapshot. This can be CREATING, DELETING, FAILED, READY, or UPLOADING.
storage_bytes str: 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 str: 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_locations Sequence[str]: Cloud Storage bucket storage location of the snapshot (regional or multi-regional).
user_licenses Sequence[str]: A list of user provided licenses represented by a list of URLs to the license resource.

architecture String: The architecture of the snapshot. Valid values are ARM64 or X86_64.
autoCreated Boolean: Set to true if snapshots are automatically created by applying resource policy on the target disk.
chainName 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.
creationSizeBytes String: Size in bytes of the snapshot at creation time.
creationTimestamp String: Creation timestamp in RFC3339 text format.
description String: An optional description of this resource. Provide this property when you create the resource.
diskSizeGb String: Size of the source disk, specified in GB.
downloadBytes String: Number of bytes downloaded to restore a snapshot to a disk.
guestFlush Boolean: [Input Only] Whether to attempt an application consistent snapshot by informing the OS to prepare for the snapshot process.
kind String: Type of the resource. Always compute#snapshot for Snapshot resources.
labelFingerprint String: 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.
labels Map<String>: Labels to apply to this snapshot. These can be later modified by the setLabels method. Label values may be empty.
licenseCodes List<String>: Integer license codes indicating which licenses are attached to this snapshot.
licenses 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).
locationHint 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.
name 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.
satisfiesPzs Boolean: Reserved for future use.
selfLink String: Server-defined URL for the resource.
snapshotEncryptionKey Property Map: 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.
snapshotType String: Indicates the type of the snapshot.
sourceDisk String: The source disk used to create this snapshot.
sourceDiskEncryptionKey Property Map: The customer-supplied encryption key of the source disk. Required if the source disk is protected by a customer-supplied encryption key.
sourceDiskId 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.
sourceInstantSnapshot String: 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
sourceInstantSnapshotId String: 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.
sourceSnapshotSchedulePolicy String: URL of the resource policy which created this scheduled snapshot.
sourceSnapshotSchedulePolicyId String: ID of the resource policy which created this scheduled snapshot.
status String: The status of the snapshot. This can be CREATING, DELETING, FAILED, READY, or UPLOADING.
storageBytes String: A size of the storage used by the snapshot. As snapshots share storage, this number is expected to change with snapshot creation/deletion.
storageBytesStatus String: 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.
storageLocations List<String>: Cloud Storage bucket storage location of the snapshot (regional or multi-regional).
userLicenses List<String>: A list of user provided licenses represented by a list of URLs to the license resource.

Supporting Types

CustomerEncryptionKeyResponse

KmsKeyName string: 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
KmsKeyServiceAccount string: 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/
RawKey string: 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="
RsaEncryptedKey string: 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 string: [Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource.

KmsKeyName string: 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
KmsKeyServiceAccount string: 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/
RawKey string: 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="
RsaEncryptedKey string: 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 string: [Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource.

kmsKeyName String: 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
kmsKeyServiceAccount String: 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/
rawKey String: 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="
rsaEncryptedKey String: 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 String: [Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource.

kmsKeyName string: 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
kmsKeyServiceAccount string: 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/
rawKey string: 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="
rsaEncryptedKey string: 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 string: [Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource.

kms_key_name str: 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
kms_key_service_account str: 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 str: 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 str: 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 str: [Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource.

kmsKeyName String: 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
kmsKeyServiceAccount String: 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/
rawKey String: 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="
rsaEncryptedKey String: 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 String: [Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource.

Package Details

Repository: Google Cloud Native pulumi/pulumi-google-native
License: Apache-2.0

Google Cloud Native is in preview. Google Cloud Classic is fully supported.

Google Cloud Native v0.31.1 published on Thursday, Jul 20, 2023 by Pulumi

pulumi/pulumi-google-native

google-native.compute/beta.getSnapshot

On this page

On this page

Using getSnapshot

getSnapshot Result

Supporting Types

CustomerEncryptionKeyResponse

Package Details

On this page

On this page