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

SnapshotArgs

data class SnapshotArgs(val chainName: Output<String>? = null, val description: Output<String>? = null, val labels: Output<Map<String, String>>? = null, val name: Output<String>? = null, val project: Output<String>? = null, val snapshotEncryptionKey: Output<SnapshotSnapshotEncryptionKeyArgs>? = null, val sourceDisk: Output<String>? = null, val sourceDiskEncryptionKey: Output<SnapshotSourceDiskEncryptionKeyArgs>? = null, val storageLocations: Output<List<String>>? = null, val zone: Output<String>? = null) : ConvertibleToJava<SnapshotArgs>

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:

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"],
});
Content copied to clipboard
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"])
Content copied to clipboard
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",
        },
    });
});
Content copied to clipboard
package main
import (
	"github.com/pulumi/pulumi-gcp/sdk/v7/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
	})
}
Content copied to clipboard
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.applyValue(getImageResult -> getImageResult.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());
    }
}
Content copied to clipboard
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
Content copied to clipboard

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"],
});
Content copied to clipboard
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"])
Content copied to clipboard
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",
        },
    });
});
Content copied to clipboard
package main
import (
	"github.com/pulumi/pulumi-gcp/sdk/v7/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
	})
}
Content copied to clipboard
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.applyValue(getImageResult -> getImageResult.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());
    }
}
Content copied to clipboard
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
Content copied to clipboard

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}}
Content copied to clipboard
$ pulumi import gcp:compute/snapshot:Snapshot default {{project}}/{{name}}
Content copied to clipboard
$ pulumi import gcp:compute/snapshot:Snapshot default {{name}}
Content copied to clipboard

Constructors

Link copied to clipboard
constructor(chainName: Output<String>? = null, description: Output<String>? = null, labels: Output<Map<String, String>>? = null, name: Output<String>? = null, project: Output<String>? = null, snapshotEncryptionKey: Output<SnapshotSnapshotEncryptionKeyArgs>? = null, sourceDisk: Output<String>? = null, sourceDiskEncryptionKey: Output<SnapshotSourceDiskEncryptionKeyArgs>? = null, storageLocations: Output<List<String>>? = null, zone: Output<String>? = null)

Properties

Link copied to clipboard
val chainName: Output<String>? = null

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.

Link copied to clipboard
val description: Output<String>? = null

An optional description of this resource.

Link copied to clipboard
val labels: Output<Map<String, String>>? = null

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.

Link copied to clipboard
val name: Output<String>? = null

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.

Link copied to clipboard
val project: Output<String>? = null

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

Link copied to clipboard
val snapshotEncryptionKey: Output<SnapshotSnapshotEncryptionKeyArgs>? = null

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.

Link copied to clipboard
val sourceDisk: Output<String>? = null

A reference to the disk used to create this snapshot.

Link copied to clipboard
val sourceDiskEncryptionKey: Output<SnapshotSourceDiskEncryptionKeyArgs>? = null

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.

Link copied to clipboard
val storageLocations: Output<List<String>>? = null

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

Link copied to clipboard
val zone: Output<String>? = null

A reference to the zone where the disk is hosted.

Functions

Link copied to clipboard
open override fun toJava(): SnapshotArgs