@pulumi/gcp
Version:
A Pulumi package for creating and managing Google Cloud Platform resources.
161 lines • 7.07 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.Backup = void 0;
const pulumi = require("@pulumi/pulumi");
const utilities = require("../utilities");
/**
* A Google Cloud Filestore backup.
*
* To get more information about Backup, see:
*
* * [API documentation](https://cloud.google.com/filestore/docs/reference/rest/v1/projects.locations.instances.backups)
* * How-to Guides
* * [Creating Backups](https://cloud.google.com/filestore/docs/create-backups)
* * [Official Documentation](https://cloud.google.com/filestore/docs/backups)
*
* ## Example Usage
*
* ### Filestore Backup Basic
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as gcp from "@pulumi/gcp";
*
* const instance = new gcp.filestore.Instance("instance", {
* name: "fs-inst",
* location: "us-central1-b",
* tier: "BASIC_HDD",
* fileShares: {
* capacityGb: 1024,
* name: "share1",
* },
* networks: [{
* network: "default",
* modes: ["MODE_IPV4"],
* connectMode: "DIRECT_PEERING",
* }],
* });
* const backup = new gcp.filestore.Backup("backup", {
* name: "fs-bkup",
* location: "us-central1",
* description: "This is a filestore backup for the test instance",
* sourceInstance: instance.id,
* sourceFileShare: "share1",
* labels: {
* files: "label1",
* "other-label": "label2",
* },
* });
* ```
*
* ## Import
*
* Backup can be imported using any of these accepted formats:
*
* * `projects/{{project}}/locations/{{location}}/backups/{{name}}`
*
* * `{{project}}/{{location}}/{{name}}`
*
* * `{{location}}/{{name}}`
*
* When using the `pulumi import` command, Backup can be imported using one of the formats above. For example:
*
* ```sh
* $ pulumi import gcp:filestore/backup:Backup default projects/{{project}}/locations/{{location}}/backups/{{name}}
* ```
*
* ```sh
* $ pulumi import gcp:filestore/backup:Backup default {{project}}/{{location}}/{{name}}
* ```
*
* ```sh
* $ pulumi import gcp:filestore/backup:Backup default {{location}}/{{name}}
* ```
*/
class Backup extends pulumi.CustomResource {
/**
* Get an existing Backup 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 Backup(name, state, Object.assign(Object.assign({}, opts), { id: id }));
}
/**
* Returns true if the given object is an instance of Backup. 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'] === Backup.__pulumiType;
}
constructor(name, argsOrState, opts) {
let resourceInputs = {};
opts = opts || {};
if (opts.id) {
const state = argsOrState;
resourceInputs["capacityGb"] = state ? state.capacityGb : undefined;
resourceInputs["createTime"] = state ? state.createTime : undefined;
resourceInputs["description"] = state ? state.description : undefined;
resourceInputs["downloadBytes"] = state ? state.downloadBytes : undefined;
resourceInputs["effectiveLabels"] = state ? state.effectiveLabels : undefined;
resourceInputs["kmsKeyName"] = state ? state.kmsKeyName : undefined;
resourceInputs["labels"] = state ? state.labels : undefined;
resourceInputs["location"] = state ? state.location : undefined;
resourceInputs["name"] = state ? state.name : undefined;
resourceInputs["project"] = state ? state.project : undefined;
resourceInputs["pulumiLabels"] = state ? state.pulumiLabels : undefined;
resourceInputs["sourceFileShare"] = state ? state.sourceFileShare : undefined;
resourceInputs["sourceInstance"] = state ? state.sourceInstance : undefined;
resourceInputs["sourceInstanceTier"] = state ? state.sourceInstanceTier : undefined;
resourceInputs["state"] = state ? state.state : undefined;
resourceInputs["storageBytes"] = state ? state.storageBytes : undefined;
resourceInputs["tags"] = state ? state.tags : undefined;
}
else {
const args = argsOrState;
if ((!args || args.location === undefined) && !opts.urn) {
throw new Error("Missing required property 'location'");
}
if ((!args || args.sourceFileShare === undefined) && !opts.urn) {
throw new Error("Missing required property 'sourceFileShare'");
}
if ((!args || args.sourceInstance === undefined) && !opts.urn) {
throw new Error("Missing required property 'sourceInstance'");
}
resourceInputs["description"] = args ? args.description : undefined;
resourceInputs["labels"] = args ? args.labels : undefined;
resourceInputs["location"] = args ? args.location : undefined;
resourceInputs["name"] = args ? args.name : undefined;
resourceInputs["project"] = args ? args.project : undefined;
resourceInputs["sourceFileShare"] = args ? args.sourceFileShare : undefined;
resourceInputs["sourceInstance"] = args ? args.sourceInstance : undefined;
resourceInputs["tags"] = args ? args.tags : undefined;
resourceInputs["capacityGb"] = undefined /*out*/;
resourceInputs["createTime"] = undefined /*out*/;
resourceInputs["downloadBytes"] = undefined /*out*/;
resourceInputs["effectiveLabels"] = undefined /*out*/;
resourceInputs["kmsKeyName"] = undefined /*out*/;
resourceInputs["pulumiLabels"] = undefined /*out*/;
resourceInputs["sourceInstanceTier"] = undefined /*out*/;
resourceInputs["state"] = undefined /*out*/;
resourceInputs["storageBytes"] = undefined /*out*/;
}
opts = pulumi.mergeOptions(utilities.resourceOptsDefaults(), opts);
const secretOpts = { additionalSecretOutputs: ["effectiveLabels", "pulumiLabels"] };
opts = pulumi.mergeOptions(opts, secretOpts);
super(Backup.__pulumiType, name, resourceInputs, opts);
}
}
exports.Backup = Backup;
/** @internal */
Backup.__pulumiType = 'gcp:filestore/backup:Backup';
//# sourceMappingURL=backup.js.map