1. Packages
  2. Google Cloud Native
  3. API Docs
  4. compute
  5. compute/alpha
  6. getInstantSnapshot

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

Google Cloud Native v0.32.0 published on Wednesday, Nov 29, 2023 by Pulumi

google-native.compute/alpha.getInstantSnapshot

Explore with Pulumi AI

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

Google Cloud Native v0.32.0 published on Wednesday, Nov 29, 2023 by Pulumi

Returns the specified InstantSnapshot resource in the specified zone.

Using getInstantSnapshot

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 getInstantSnapshot(args: GetInstantSnapshotArgs, opts?: InvokeOptions): Promise<GetInstantSnapshotResult>
function getInstantSnapshotOutput(args: GetInstantSnapshotOutputArgs, opts?: InvokeOptions): Output<GetInstantSnapshotResult>
Copy
def get_instant_snapshot(instant_snapshot: Optional[str] = None,
                         project: Optional[str] = None,
                         zone: Optional[str] = None,
                         opts: Optional[InvokeOptions] = None) -> GetInstantSnapshotResult
def get_instant_snapshot_output(instant_snapshot: Optional[pulumi.Input[str]] = None,
                         project: Optional[pulumi.Input[str]] = None,
                         zone: Optional[pulumi.Input[str]] = None,
                         opts: Optional[InvokeOptions] = None) -> Output[GetInstantSnapshotResult]
Copy
func LookupInstantSnapshot(ctx *Context, args *LookupInstantSnapshotArgs, opts ...InvokeOption) (*LookupInstantSnapshotResult, error)
func LookupInstantSnapshotOutput(ctx *Context, args *LookupInstantSnapshotOutputArgs, opts ...InvokeOption) LookupInstantSnapshotResultOutput
Copy

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

public static class GetInstantSnapshot 
{
    public static Task<GetInstantSnapshotResult> InvokeAsync(GetInstantSnapshotArgs args, InvokeOptions? opts = null)
    public static Output<GetInstantSnapshotResult> Invoke(GetInstantSnapshotInvokeArgs args, InvokeOptions? opts = null)
}
Copy
public static CompletableFuture<GetInstantSnapshotResult> getInstantSnapshot(GetInstantSnapshotArgs args, InvokeOptions options)
public static Output<GetInstantSnapshotResult> getInstantSnapshot(GetInstantSnapshotArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: google-native:compute/alpha:getInstantSnapshot
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

InstantSnapshot This property is required. string
Zone This property is required. string
Project string
InstantSnapshot This property is required. string
Zone This property is required. string
Project string
instantSnapshot This property is required. String
zone This property is required. String
project String
instantSnapshot This property is required. string
zone This property is required. string
project string
instant_snapshot This property is required. str
zone This property is required. str
project str
instantSnapshot This property is required. String
zone This property is required. String
project String

getInstantSnapshot Result

The following output properties are available:

Architecture string
The architecture of the instant snapshot. Valid values are ARM64 or X86_64.
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.
GuestFlush bool
Whether to attempt an application consistent instant snapshot by informing the OS to prepare for the snapshot process.
Kind string
Type of the resource. Always compute#instantSnapshot for InstantSnapshot resources.
LabelFingerprint string
A fingerprint for the labels being applied to this InstantSnapshot, 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 InstantSnapshot.
Labels Dictionary<string, string>
Labels to apply to this InstantSnapshot. These can be later modified by the setLabels method. Label values may be empty.
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.
Region string
URL of the region where the instant snapshot resides. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body.
ResourceStatus Pulumi.GoogleNative.Compute.Alpha.Outputs.InstantSnapshotResourceStatusResponse
Status information for the instant snapshot resource.
SatisfiesPzs bool
Reserved for future use.
SelfLink string
Server-defined URL for the resource.
SelfLinkWithId string
Server-defined URL for this resource's resource id.
SourceDisk string
URL of the source disk used to create this instant snapshot. Note that the source disk must be in the same zone/region as the instant snapshot to be created. This can be a full or valid partial URL. For example, the following are valid values: - https://www.googleapis.com/compute/v1/projects/project/zones/zone /disks/disk - https://www.googleapis.com/compute/v1/projects/project/regions/region /disks/disk - projects/project/zones/zone/disks/disk - projects/project/regions/region/disks/disk - zones/zone/disks/disk - regions/region/disks/disk
SourceDiskId string
The ID value of the disk used to create this InstantSnapshot. This value may be used to determine whether the InstantSnapshot was taken from the current or a previous instance of a given disk name.
Status string
The status of the instantSnapshot. This can be CREATING, DELETING, FAILED, or READY.
Zone string
URL of the zone where the instant snapshot resides. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body.
Architecture string
The architecture of the instant snapshot. Valid values are ARM64 or X86_64.
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.
GuestFlush bool
Whether to attempt an application consistent instant snapshot by informing the OS to prepare for the snapshot process.
Kind string
Type of the resource. Always compute#instantSnapshot for InstantSnapshot resources.
LabelFingerprint string
A fingerprint for the labels being applied to this InstantSnapshot, 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 InstantSnapshot.
Labels map[string]string
Labels to apply to this InstantSnapshot. These can be later modified by the setLabels method. Label values may be empty.
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.
Region string
URL of the region where the instant snapshot resides. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body.
ResourceStatus InstantSnapshotResourceStatusResponse
Status information for the instant snapshot resource.
SatisfiesPzs bool
Reserved for future use.
SelfLink string
Server-defined URL for the resource.
SelfLinkWithId string
Server-defined URL for this resource's resource id.
SourceDisk string
URL of the source disk used to create this instant snapshot. Note that the source disk must be in the same zone/region as the instant snapshot to be created. This can be a full or valid partial URL. For example, the following are valid values: - https://www.googleapis.com/compute/v1/projects/project/zones/zone /disks/disk - https://www.googleapis.com/compute/v1/projects/project/regions/region /disks/disk - projects/project/zones/zone/disks/disk - projects/project/regions/region/disks/disk - zones/zone/disks/disk - regions/region/disks/disk
SourceDiskId string
The ID value of the disk used to create this InstantSnapshot. This value may be used to determine whether the InstantSnapshot was taken from the current or a previous instance of a given disk name.
Status string
The status of the instantSnapshot. This can be CREATING, DELETING, FAILED, or READY.
Zone string
URL of the zone where the instant snapshot resides. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body.
architecture String
The architecture of the instant snapshot. Valid values are ARM64 or X86_64.
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.
guestFlush Boolean
Whether to attempt an application consistent instant snapshot by informing the OS to prepare for the snapshot process.
kind String
Type of the resource. Always compute#instantSnapshot for InstantSnapshot resources.
labelFingerprint String
A fingerprint for the labels being applied to this InstantSnapshot, 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 InstantSnapshot.
labels Map<String,String>
Labels to apply to this InstantSnapshot. These can be later modified by the setLabels method. Label values may be empty.
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.
region String
URL of the region where the instant snapshot resides. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body.
resourceStatus InstantSnapshotResourceStatusResponse
Status information for the instant snapshot resource.
satisfiesPzs Boolean
Reserved for future use.
selfLink String
Server-defined URL for the resource.
selfLinkWithId String
Server-defined URL for this resource's resource id.
sourceDisk String
URL of the source disk used to create this instant snapshot. Note that the source disk must be in the same zone/region as the instant snapshot to be created. This can be a full or valid partial URL. For example, the following are valid values: - https://www.googleapis.com/compute/v1/projects/project/zones/zone /disks/disk - https://www.googleapis.com/compute/v1/projects/project/regions/region /disks/disk - projects/project/zones/zone/disks/disk - projects/project/regions/region/disks/disk - zones/zone/disks/disk - regions/region/disks/disk
sourceDiskId String
The ID value of the disk used to create this InstantSnapshot. This value may be used to determine whether the InstantSnapshot was taken from the current or a previous instance of a given disk name.
status String
The status of the instantSnapshot. This can be CREATING, DELETING, FAILED, or READY.
zone String
URL of the zone where the instant snapshot resides. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body.
architecture string
The architecture of the instant snapshot. Valid values are ARM64 or X86_64.
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.
guestFlush boolean
Whether to attempt an application consistent instant snapshot by informing the OS to prepare for the snapshot process.
kind string
Type of the resource. Always compute#instantSnapshot for InstantSnapshot resources.
labelFingerprint string
A fingerprint for the labels being applied to this InstantSnapshot, 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 InstantSnapshot.
labels {[key: string]: string}
Labels to apply to this InstantSnapshot. These can be later modified by the setLabels method. Label values may be empty.
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.
region string
URL of the region where the instant snapshot resides. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body.
resourceStatus InstantSnapshotResourceStatusResponse
Status information for the instant snapshot resource.
satisfiesPzs boolean
Reserved for future use.
selfLink string
Server-defined URL for the resource.
selfLinkWithId string
Server-defined URL for this resource's resource id.
sourceDisk string
URL of the source disk used to create this instant snapshot. Note that the source disk must be in the same zone/region as the instant snapshot to be created. This can be a full or valid partial URL. For example, the following are valid values: - https://www.googleapis.com/compute/v1/projects/project/zones/zone /disks/disk - https://www.googleapis.com/compute/v1/projects/project/regions/region /disks/disk - projects/project/zones/zone/disks/disk - projects/project/regions/region/disks/disk - zones/zone/disks/disk - regions/region/disks/disk
sourceDiskId string
The ID value of the disk used to create this InstantSnapshot. This value may be used to determine whether the InstantSnapshot was taken from the current or a previous instance of a given disk name.
status string
The status of the instantSnapshot. This can be CREATING, DELETING, FAILED, or READY.
zone string
URL of the zone where the instant snapshot resides. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body.
architecture str
The architecture of the instant snapshot. Valid values are ARM64 or X86_64.
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.
guest_flush bool
Whether to attempt an application consistent instant snapshot by informing the OS to prepare for the snapshot process.
kind str
Type of the resource. Always compute#instantSnapshot for InstantSnapshot resources.
label_fingerprint str
A fingerprint for the labels being applied to this InstantSnapshot, 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 InstantSnapshot.
labels Mapping[str, str]
Labels to apply to this InstantSnapshot. These can be later modified by the setLabels method. Label values may be empty.
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.
region str
URL of the region where the instant snapshot resides. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body.
resource_status InstantSnapshotResourceStatusResponse
Status information for the instant snapshot resource.
satisfies_pzs bool
Reserved for future use.
self_link str
Server-defined URL for the resource.
self_link_with_id str
Server-defined URL for this resource's resource id.
source_disk str
URL of the source disk used to create this instant snapshot. Note that the source disk must be in the same zone/region as the instant snapshot to be created. This can be a full or valid partial URL. For example, the following are valid values: - https://www.googleapis.com/compute/v1/projects/project/zones/zone /disks/disk - https://www.googleapis.com/compute/v1/projects/project/regions/region /disks/disk - projects/project/zones/zone/disks/disk - projects/project/regions/region/disks/disk - zones/zone/disks/disk - regions/region/disks/disk
source_disk_id str
The ID value of the disk used to create this InstantSnapshot. This value may be used to determine whether the InstantSnapshot was taken from the current or a previous instance of a given disk name.
status str
The status of the instantSnapshot. This can be CREATING, DELETING, FAILED, or READY.
zone str
URL of the zone where the instant snapshot resides. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body.
architecture String
The architecture of the instant snapshot. Valid values are ARM64 or X86_64.
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.
guestFlush Boolean
Whether to attempt an application consistent instant snapshot by informing the OS to prepare for the snapshot process.
kind String
Type of the resource. Always compute#instantSnapshot for InstantSnapshot resources.
labelFingerprint String
A fingerprint for the labels being applied to this InstantSnapshot, 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 InstantSnapshot.
labels Map<String>
Labels to apply to this InstantSnapshot. These can be later modified by the setLabels method. Label values may be empty.
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.
region String
URL of the region where the instant snapshot resides. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body.
resourceStatus Property Map
Status information for the instant snapshot resource.
satisfiesPzs Boolean
Reserved for future use.
selfLink String
Server-defined URL for the resource.
selfLinkWithId String
Server-defined URL for this resource's resource id.
sourceDisk String
URL of the source disk used to create this instant snapshot. Note that the source disk must be in the same zone/region as the instant snapshot to be created. This can be a full or valid partial URL. For example, the following are valid values: - https://www.googleapis.com/compute/v1/projects/project/zones/zone /disks/disk - https://www.googleapis.com/compute/v1/projects/project/regions/region /disks/disk - projects/project/zones/zone/disks/disk - projects/project/regions/region/disks/disk - zones/zone/disks/disk - regions/region/disks/disk
sourceDiskId String
The ID value of the disk used to create this InstantSnapshot. This value may be used to determine whether the InstantSnapshot was taken from the current or a previous instance of a given disk name.
status String
The status of the instantSnapshot. This can be CREATING, DELETING, FAILED, or READY.
zone String
URL of the zone where the instant snapshot resides. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body.

Supporting Types

InstantSnapshotResourceStatusResponse

StorageSizeBytes This property is required. string
The storage size of this instant snapshot.
StorageSizeBytes This property is required. string
The storage size of this instant snapshot.
storageSizeBytes This property is required. String
The storage size of this instant snapshot.
storageSizeBytes This property is required. string
The storage size of this instant snapshot.
storage_size_bytes This property is required. str
The storage size of this instant snapshot.
storageSizeBytes This property is required. String
The storage size of this instant snapshot.

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.32.0 published on Wednesday, Nov 29, 2023 by Pulumi