pulumi-gcp-kotlin/com.pulumi.gcp.compute.kotlin/Snapshot

Snapshot

class Snapshot : KotlinCustomResource

Represents a Persistent Disk Snapshot resource. Use snapshots to back up data from your persistent disks. Snapshots are different from public images and custom images, which are used primarily to create instances or configure instance templates. Snapshots are useful for periodic backup of the data on your persistent disks. You can create snapshots from persistent disks even while they are attached to running instances. Snapshots are incremental, so you can create regular snapshots on a persistent disk faster and at a much lower cost than if you regularly created a full image of the disk. To get more information about Snapshot, see:

API documentation
How-to Guides

Official Documentation

Warning: All arguments including the following potentially sensitive values will be stored in the raw state as plain text: snapshot_encryption_key.raw_key, snapshot_encryption_key.rsa_encrypted_key, source_disk_encryption_key.raw_key, source_disk_encryption_key.rsa_encrypted_key.

Example Usage

Snapshot Basic

import * as pulumi from "@pulumi/pulumi";
import * as gcp from "@pulumi/gcp";
const debian = gcp.compute.getImage({
    family: "debian-11",
    project: "debian-cloud",
});
const persistent = new gcp.compute.Disk("persistent", {
    name: "debian-disk",
    image: debian.then(debian => debian.selfLink),
    size: 10,
    type: "pd-ssd",
    zone: "us-central1-a",
});
const snapshot = new gcp.compute.Snapshot("snapshot", {
    name: "my-snapshot",
    sourceDisk: persistent.id,
    zone: "us-central1-a",
    labels: {
        my_label: "value",
    },
    storageLocations: ["us-central1"],
});

import pulumi
import pulumi_gcp as gcp
debian = gcp.compute.get_image(family="debian-11",
    project="debian-cloud")
persistent = gcp.compute.Disk("persistent",
    name="debian-disk",
    image=debian.self_link,
    size=10,
    type="pd-ssd",
    zone="us-central1-a")
snapshot = gcp.compute.Snapshot("snapshot",
    name="my-snapshot",
    source_disk=persistent.id,
    zone="us-central1-a",
    labels={
        "my_label": "value",
    },
    storage_locations=["us-central1"])

using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Gcp = Pulumi.Gcp;
return await Deployment.RunAsync(() =>
{
    var debian = Gcp.Compute.GetImage.Invoke(new()
    {
        Family = "debian-11",
        Project = "debian-cloud",
    });
    var persistent = new Gcp.Compute.Disk("persistent", new()
    {
        Name = "debian-disk",
        Image = debian.Apply(getImageResult => getImageResult.SelfLink),
        Size = 10,
        Type = "pd-ssd",
        Zone = "us-central1-a",
    });
    var snapshot = new Gcp.Compute.Snapshot("snapshot", new()
    {
        Name = "my-snapshot",
        SourceDisk = persistent.Id,
        Zone = "us-central1-a",
        Labels =
        {
            { "my_label", "value" },
        },
        StorageLocations = new[]
        {
            "us-central1",
        },
    });
});

package main
import (
	"github.com/pulumi/pulumi-gcp/sdk/v8/go/gcp/compute"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		debian, err := compute.LookupImage(ctx, &compute.LookupImageArgs{
			Family:  pulumi.StringRef("debian-11"),
			Project: pulumi.StringRef("debian-cloud"),
		}, nil)
		if err != nil {
			return err
		}
		persistent, err := compute.NewDisk(ctx, "persistent", &compute.DiskArgs{
			Name:  pulumi.String("debian-disk"),
			Image: pulumi.String(debian.SelfLink),
			Size:  pulumi.Int(10),
			Type:  pulumi.String("pd-ssd"),
			Zone:  pulumi.String("us-central1-a"),
		})
		if err != nil {
			return err
		}
		_, err = compute.NewSnapshot(ctx, "snapshot", &compute.SnapshotArgs{
			Name:       pulumi.String("my-snapshot"),
			SourceDisk: persistent.ID(),
			Zone:       pulumi.String("us-central1-a"),
			Labels: pulumi.StringMap{
				"my_label": pulumi.String("value"),
			},
			StorageLocations: pulumi.StringArray{
				pulumi.String("us-central1"),
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}

package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.gcp.compute.ComputeFunctions;
import com.pulumi.gcp.compute.inputs.GetImageArgs;
import com.pulumi.gcp.compute.Disk;
import com.pulumi.gcp.compute.DiskArgs;
import com.pulumi.gcp.compute.Snapshot;
import com.pulumi.gcp.compute.SnapshotArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;
public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }
    public static void stack(Context ctx) {
        final var debian = ComputeFunctions.getImage(GetImageArgs.builder()
            .family("debian-11")
            .project("debian-cloud")
            .build());
        var persistent = new Disk("persistent", DiskArgs.builder()
            .name("debian-disk")
            .image(debian.selfLink())
            .size(10)
            .type("pd-ssd")
            .zone("us-central1-a")
            .build());
        var snapshot = new Snapshot("snapshot", SnapshotArgs.builder()
            .name("my-snapshot")
            .sourceDisk(persistent.id())
            .zone("us-central1-a")
            .labels(Map.of("my_label", "value"))
            .storageLocations("us-central1")
            .build());
    }
}

resources:
  snapshot:
    type: gcp:compute:Snapshot
    properties:
      name: my-snapshot
      sourceDisk: ${persistent.id}
      zone: us-central1-a
      labels:
        my_label: value
      storageLocations:
        - us-central1
  persistent:
    type: gcp:compute:Disk
    properties:
      name: debian-disk
      image: ${debian.selfLink}
      size: 10
      type: pd-ssd
      zone: us-central1-a
variables:
  debian:
    fn::invoke:
      function: gcp:compute:getImage
      arguments:
        family: debian-11
        project: debian-cloud

Snapshot Chainname

import * as pulumi from "@pulumi/pulumi";
import * as gcp from "@pulumi/gcp";
const debian = gcp.compute.getImage({
    family: "debian-11",
    project: "debian-cloud",
});
const persistent = new gcp.compute.Disk("persistent", {
    name: "debian-disk",
    image: debian.then(debian => debian.selfLink),
    size: 10,
    type: "pd-ssd",
    zone: "us-central1-a",
});
const snapshot = new gcp.compute.Snapshot("snapshot", {
    name: "my-snapshot",
    sourceDisk: persistent.id,
    zone: "us-central1-a",
    chainName: "snapshot-chain",
    labels: {
        my_label: "value",
    },
    storageLocations: ["us-central1"],
});

import pulumi
import pulumi_gcp as gcp
debian = gcp.compute.get_image(family="debian-11",
    project="debian-cloud")
persistent = gcp.compute.Disk("persistent",
    name="debian-disk",
    image=debian.self_link,
    size=10,
    type="pd-ssd",
    zone="us-central1-a")
snapshot = gcp.compute.Snapshot("snapshot",
    name="my-snapshot",
    source_disk=persistent.id,
    zone="us-central1-a",
    chain_name="snapshot-chain",
    labels={
        "my_label": "value",
    },
    storage_locations=["us-central1"])

using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Gcp = Pulumi.Gcp;
return await Deployment.RunAsync(() =>
{
    var debian = Gcp.Compute.GetImage.Invoke(new()
    {
        Family = "debian-11",
        Project = "debian-cloud",
    });
    var persistent = new Gcp.Compute.Disk("persistent", new()
    {
        Name = "debian-disk",
        Image = debian.Apply(getImageResult => getImageResult.SelfLink),
        Size = 10,
        Type = "pd-ssd",
        Zone = "us-central1-a",
    });
    var snapshot = new Gcp.Compute.Snapshot("snapshot", new()
    {
        Name = "my-snapshot",
        SourceDisk = persistent.Id,
        Zone = "us-central1-a",
        ChainName = "snapshot-chain",
        Labels =
        {
            { "my_label", "value" },
        },
        StorageLocations = new[]
        {
            "us-central1",
        },
    });
});

package main
import (
	"github.com/pulumi/pulumi-gcp/sdk/v8/go/gcp/compute"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		debian, err := compute.LookupImage(ctx, &compute.LookupImageArgs{
			Family:  pulumi.StringRef("debian-11"),
			Project: pulumi.StringRef("debian-cloud"),
		}, nil)
		if err != nil {
			return err
		}
		persistent, err := compute.NewDisk(ctx, "persistent", &compute.DiskArgs{
			Name:  pulumi.String("debian-disk"),
			Image: pulumi.String(debian.SelfLink),
			Size:  pulumi.Int(10),
			Type:  pulumi.String("pd-ssd"),
			Zone:  pulumi.String("us-central1-a"),
		})
		if err != nil {
			return err
		}
		_, err = compute.NewSnapshot(ctx, "snapshot", &compute.SnapshotArgs{
			Name:       pulumi.String("my-snapshot"),
			SourceDisk: persistent.ID(),
			Zone:       pulumi.String("us-central1-a"),
			ChainName:  pulumi.String("snapshot-chain"),
			Labels: pulumi.StringMap{
				"my_label": pulumi.String("value"),
			},
			StorageLocations: pulumi.StringArray{
				pulumi.String("us-central1"),
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}

package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.gcp.compute.ComputeFunctions;
import com.pulumi.gcp.compute.inputs.GetImageArgs;
import com.pulumi.gcp.compute.Disk;
import com.pulumi.gcp.compute.DiskArgs;
import com.pulumi.gcp.compute.Snapshot;
import com.pulumi.gcp.compute.SnapshotArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;
public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }
    public static void stack(Context ctx) {
        final var debian = ComputeFunctions.getImage(GetImageArgs.builder()
            .family("debian-11")
            .project("debian-cloud")
            .build());
        var persistent = new Disk("persistent", DiskArgs.builder()
            .name("debian-disk")
            .image(debian.selfLink())
            .size(10)
            .type("pd-ssd")
            .zone("us-central1-a")
            .build());
        var snapshot = new Snapshot("snapshot", SnapshotArgs.builder()
            .name("my-snapshot")
            .sourceDisk(persistent.id())
            .zone("us-central1-a")
            .chainName("snapshot-chain")
            .labels(Map.of("my_label", "value"))
            .storageLocations("us-central1")
            .build());
    }
}

resources:
  snapshot:
    type: gcp:compute:Snapshot
    properties:
      name: my-snapshot
      sourceDisk: ${persistent.id}
      zone: us-central1-a
      chainName: snapshot-chain
      labels:
        my_label: value
      storageLocations:
        - us-central1
  persistent:
    type: gcp:compute:Disk
    properties:
      name: debian-disk
      image: ${debian.selfLink}
      size: 10
      type: pd-ssd
      zone: us-central1-a
variables:
  debian:
    fn::invoke:
      function: gcp:compute:getImage
      arguments:
        family: debian-11
        project: debian-cloud

Import

Snapshot can be imported using any of these accepted formats:

projects/{{project}}/global/snapshots/{{name}}
{{project}}/{{name}}
{{name}} When using the pulumi import command, Snapshot can be imported using one of the formats above. For example:

$ pulumi import gcp:compute/snapshot:Snapshot default projects/{{project}}/global/snapshots/{{name}}

$ pulumi import gcp:compute/snapshot:Snapshot default {{project}}/{{name}}

$ pulumi import gcp:compute/snapshot:Snapshot default {{name}}

Properties

chainName

val chainName: Output<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.

creationTimestamp

val creationTimestamp: Output<String>

Creation timestamp in RFC3339 text format.

description

val description: Output<String>?

An optional description of this resource.

diskSizeGb

val diskSizeGb: Output<Int>

Size of the snapshot, specified in GB.

effectiveLabels

val effectiveLabels: Output<Map<String, String>>

All of labels (key/value pairs) present on the resource in GCP, including the labels configured through Pulumi, other clients and services.

val id: Output<String>

labelFingerprint

val labelFingerprint: Output<String>

The fingerprint used for optimistic locking of this resource. Used internally during updates.

labels

val labels: Output<Map<String, String>>?

Labels to apply to this Snapshot. Note: This field is non-authoritative, and will only manage the labels present in your configuration. Please refer to the field effective_labels for all of the labels present on the resource.

licenses

val licenses: Output<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). snapshotEncryptionKey nested object Encrypts the snapshot using a customer-supplied encryption key.

name

val name: Output<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? 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.

project

val project: Output<String>

The ID of the project in which the resource belongs. If it is not provided, the provider project is used.

pulumiChildResources

val pulumiChildResources: Set<KotlinResource>

pulumiLabels

val pulumiLabels: Output<Map<String, String>>

The combination of labels configured directly on the resource and default labels configured on the provider.

pulumiResourceName

val pulumiResourceName: String

pulumiResourceType

val pulumiResourceType: String

selfLink

val selfLink: Output<String>

The URI of the created resource.

snapshotEncryptionKey

val snapshotEncryptionKey: Output<SnapshotSnapshotEncryptionKey>?

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. Structure is documented below.

snapshotId

val snapshotId: Output<Int>

The unique identifier for the resource.

sourceDisk

val sourceDisk: Output<String>

A reference to the disk used to create this snapshot.

sourceDiskEncryptionKey

val sourceDiskEncryptionKey: Output<SnapshotSourceDiskEncryptionKey>?

The customer-supplied encryption key of the source snapshot. Required if the source snapshot is protected by a customer-supplied encryption key. Structure is documented below.

storageBytes

val storageBytes: Output<Int>

A size of the storage used by the snapshot. As snapshots share storage, this number is expected to change with snapshot creation/deletion.

storageLocations

val storageLocations: Output<List<String>>

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

urn

val urn: Output<String>

zone

val zone: Output<String>

A reference to the zone where the disk is hosted.