@pulumi/gcp
Version:
A Pulumi package for creating and managing Google Cloud Platform resources.
192 lines • 8.21 kB
JavaScript
;
// *** WARNING: this file was generated by the Pulumi Terraform Bridge (tfgen) Tool. ***
// *** Do not edit by hand unless you're certain you know what you are doing! ***
Object.defineProperty(exports, "__esModule", { value: true });
exports.Snapshot = void 0;
const pulumi = require("@pulumi/pulumi");
const utilities = require("../utilities");
/**
* 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](https://cloud.google.com/compute/docs/reference/rest/v1/snapshots)
* * How-to Guides
* * [Official Documentation](https://cloud.google.com/compute/docs/disks/create-snapshots)
*
* ## Example Usage
*
* ### Snapshot Basic
*
* ```typescript
* 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"],
* });
* ```
* ### Snapshot Chainname
*
* ```typescript
* 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
*
* 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:
*
* ```sh
* $ pulumi import gcp:compute/snapshot:Snapshot default projects/{{project}}/global/snapshots/{{name}}
* ```
*
* ```sh
* $ pulumi import gcp:compute/snapshot:Snapshot default {{project}}/{{name}}
* ```
*
* ```sh
* $ pulumi import gcp:compute/snapshot:Snapshot default {{name}}
* ```
*/
class Snapshot extends pulumi.CustomResource {
/**
* Get an existing Snapshot resource's state with the given name, ID, and optional extra
* properties used to qualify the lookup.
*
* @param name The _unique_ name of the resulting resource.
* @param id The _unique_ provider ID of the resource to lookup.
* @param state Any extra arguments used during the lookup.
* @param opts Optional settings to control the behavior of the CustomResource.
*/
static get(name, id, state, opts) {
return new Snapshot(name, state, Object.assign(Object.assign({}, opts), { id: id }));
}
/**
* Returns true if the given object is an instance of Snapshot. This is designed to work even
* when multiple copies of the Pulumi SDK have been loaded into the same process.
*/
static isInstance(obj) {
if (obj === undefined || obj === null) {
return false;
}
return obj['__pulumiType'] === Snapshot.__pulumiType;
}
constructor(name, argsOrState, opts) {
let resourceInputs = {};
opts = opts || {};
if (opts.id) {
const state = argsOrState;
resourceInputs["chainName"] = state ? state.chainName : undefined;
resourceInputs["creationTimestamp"] = state ? state.creationTimestamp : undefined;
resourceInputs["description"] = state ? state.description : undefined;
resourceInputs["diskSizeGb"] = state ? state.diskSizeGb : undefined;
resourceInputs["effectiveLabels"] = state ? state.effectiveLabels : undefined;
resourceInputs["labelFingerprint"] = state ? state.labelFingerprint : undefined;
resourceInputs["labels"] = state ? state.labels : undefined;
resourceInputs["licenses"] = state ? state.licenses : undefined;
resourceInputs["name"] = state ? state.name : undefined;
resourceInputs["project"] = state ? state.project : undefined;
resourceInputs["pulumiLabels"] = state ? state.pulumiLabels : undefined;
resourceInputs["selfLink"] = state ? state.selfLink : undefined;
resourceInputs["snapshotEncryptionKey"] = state ? state.snapshotEncryptionKey : undefined;
resourceInputs["snapshotId"] = state ? state.snapshotId : undefined;
resourceInputs["sourceDisk"] = state ? state.sourceDisk : undefined;
resourceInputs["sourceDiskEncryptionKey"] = state ? state.sourceDiskEncryptionKey : undefined;
resourceInputs["storageBytes"] = state ? state.storageBytes : undefined;
resourceInputs["storageLocations"] = state ? state.storageLocations : undefined;
resourceInputs["zone"] = state ? state.zone : undefined;
}
else {
const args = argsOrState;
if ((!args || args.sourceDisk === undefined) && !opts.urn) {
throw new Error("Missing required property 'sourceDisk'");
}
resourceInputs["chainName"] = args ? args.chainName : undefined;
resourceInputs["description"] = args ? args.description : undefined;
resourceInputs["labels"] = args ? args.labels : undefined;
resourceInputs["name"] = args ? args.name : undefined;
resourceInputs["project"] = args ? args.project : undefined;
resourceInputs["snapshotEncryptionKey"] = args ? args.snapshotEncryptionKey : undefined;
resourceInputs["sourceDisk"] = args ? args.sourceDisk : undefined;
resourceInputs["sourceDiskEncryptionKey"] = args ? args.sourceDiskEncryptionKey : undefined;
resourceInputs["storageLocations"] = args ? args.storageLocations : undefined;
resourceInputs["zone"] = args ? args.zone : undefined;
resourceInputs["creationTimestamp"] = undefined /*out*/;
resourceInputs["diskSizeGb"] = undefined /*out*/;
resourceInputs["effectiveLabels"] = undefined /*out*/;
resourceInputs["labelFingerprint"] = undefined /*out*/;
resourceInputs["licenses"] = undefined /*out*/;
resourceInputs["pulumiLabels"] = undefined /*out*/;
resourceInputs["selfLink"] = undefined /*out*/;
resourceInputs["snapshotId"] = undefined /*out*/;
resourceInputs["storageBytes"] = undefined /*out*/;
}
opts = pulumi.mergeOptions(utilities.resourceOptsDefaults(), opts);
const secretOpts = { additionalSecretOutputs: ["effectiveLabels", "pulumiLabels"] };
opts = pulumi.mergeOptions(opts, secretOpts);
super(Snapshot.__pulumiType, name, resourceInputs, opts);
}
}
exports.Snapshot = Snapshot;
/** @internal */
Snapshot.__pulumiType = 'gcp:compute/snapshot:Snapshot';
//# sourceMappingURL=snapshot.js.map