@pulumi/gcp
Version:
A Pulumi package for creating and managing Google Cloud Platform resources.
274 lines • 11.6 kB
JavaScript
;
// *** WARNING: this file was generated by pulumi-language-nodejs. ***
// *** Do not edit by hand unless you're certain you know what you are doing! ***
var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
if (k2 === undefined) k2 = k;
var desc = Object.getOwnPropertyDescriptor(m, k);
if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
desc = { enumerable: true, get: function() { return m[k]; } };
}
Object.defineProperty(o, k2, desc);
}) : (function(o, m, k, k2) {
if (k2 === undefined) k2 = k;
o[k2] = m[k];
}));
var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
Object.defineProperty(o, "default", { enumerable: true, value: v });
}) : function(o, v) {
o["default"] = v;
});
var __importStar = (this && this.__importStar) || function (mod) {
if (mod && mod.__esModule) return mod;
var result = {};
if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
__setModuleDefault(result, mod);
return result;
};
Object.defineProperty(exports, "__esModule", { value: true });
exports.BackupPlan = void 0;
const pulumi = __importStar(require("@pulumi/pulumi"));
const utilities = __importStar(require("../utilities"));
/**
* A backup plan defines when and how to back up a resource, including the backup's schedule, retention, and location.
*
* To get more information about BackupPlan, see:
*
* * [API documentation](https://cloud.google.com/backup-disaster-recovery/docs/reference/rest)
* * How-to Guides
* * [Official Documentation](https://cloud.google.com/backup-disaster-recovery/docs)
*
* ## Example Usage
*
* ### Backup Dr Backup Plan Simple
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as gcp from "@pulumi/gcp";
*
* const myBackupVault = new gcp.backupdisasterrecovery.BackupVault("my_backup_vault", {
* location: "us-central1",
* backupVaultId: "backup-vault-simple-test",
* backupMinimumEnforcedRetentionDuration: "100000s",
* });
* const my_backup_plan_1 = new gcp.backupdisasterrecovery.BackupPlan("my-backup-plan-1", {
* location: "us-central1",
* backupPlanId: "backup-plan-simple-test",
* resourceType: "compute.googleapis.com/Instance",
* backupVault: myBackupVault.id,
* maxCustomOnDemandRetentionDays: 30,
* backupRules: [{
* ruleId: "rule-1",
* backupRetentionDays: 5,
* standardSchedule: {
* recurrenceType: "HOURLY",
* hourlyFrequency: 6,
* timeZone: "UTC",
* backupWindow: {
* startHourOfDay: 0,
* endHourOfDay: 24,
* },
* },
* }],
* });
* ```
* ### Backup Dr Backup Plan For Disk Resource
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as gcp from "@pulumi/gcp";
*
* const myBackupVault = new gcp.backupdisasterrecovery.BackupVault("my_backup_vault", {
* location: "us-central1",
* backupVaultId: "backup-vault-disk-test",
* backupMinimumEnforcedRetentionDuration: "100000s",
* });
* const my_disk_backup_plan_1 = new gcp.backupdisasterrecovery.BackupPlan("my-disk-backup-plan-1", {
* location: "us-central1",
* backupPlanId: "backup-plan-disk-test",
* resourceType: "compute.googleapis.com/Disk",
* backupVault: myBackupVault.id,
* maxCustomOnDemandRetentionDays: 30,
* backupRules: [{
* ruleId: "rule-1",
* backupRetentionDays: 5,
* standardSchedule: {
* recurrenceType: "HOURLY",
* hourlyFrequency: 1,
* timeZone: "UTC",
* backupWindow: {
* startHourOfDay: 0,
* endHourOfDay: 6,
* },
* },
* }],
* diskBackupPlanProperties: {
* guestFlush: true,
* },
* });
* ```
* ### Backup Dr Backup Plan For Csql Resource
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as gcp from "@pulumi/gcp";
*
* const myBackupVault = new gcp.backupdisasterrecovery.BackupVault("my_backup_vault", {
* location: "us-central1",
* backupVaultId: "backup-vault-csql-test",
* backupMinimumEnforcedRetentionDuration: "100000s",
* });
* const my_csql_backup_plan_1 = new gcp.backupdisasterrecovery.BackupPlan("my-csql-backup-plan-1", {
* location: "us-central1",
* backupPlanId: "backup-plan-csql-test",
* resourceType: "sqladmin.googleapis.com/Instance",
* backupVault: myBackupVault.id,
* backupRules: [{
* ruleId: "rule-1",
* backupRetentionDays: 5,
* standardSchedule: {
* recurrenceType: "HOURLY",
* hourlyFrequency: 6,
* timeZone: "UTC",
* backupWindow: {
* startHourOfDay: 0,
* endHourOfDay: 6,
* },
* },
* }],
* logRetentionDays: 4,
* });
* ```
* ### Backup Dr Backup Plan For Filestore Resource
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as gcp from "@pulumi/gcp";
*
* const myBackupVault = new gcp.backupdisasterrecovery.BackupVault("my_backup_vault", {
* location: "us-central1",
* backupVaultId: "backup-vault-filestore-test",
* backupMinimumEnforcedRetentionDuration: "100000s",
* });
* const my_filestore_backup_plan_1 = new gcp.backupdisasterrecovery.BackupPlan("my-filestore-backup-plan-1", {
* location: "us-central1",
* backupPlanId: "backup-plan-filestore-test",
* resourceType: "file.googleapis.com/Instance",
* backupVault: myBackupVault.id,
* backupRules: [{
* ruleId: "rule-1",
* backupRetentionDays: 5,
* standardSchedule: {
* recurrenceType: "HOURLY",
* hourlyFrequency: 6,
* timeZone: "UTC",
* backupWindow: {
* startHourOfDay: 0,
* endHourOfDay: 6,
* },
* },
* }],
* });
* ```
*
* ## Import
*
* BackupPlan can be imported using any of these accepted formats:
*
* * `projects/{{project}}/locations/{{location}}/backupPlans/{{backup_plan_id}}`
* * `{{project}}/{{location}}/{{backup_plan_id}}`
* * `{{location}}/{{backup_plan_id}}`
*
* When using the `pulumi import` command, BackupPlan can be imported using one of the formats above. For example:
*
* ```sh
* $ pulumi import gcp:backupdisasterrecovery/backupPlan:BackupPlan default projects/{{project}}/locations/{{location}}/backupPlans/{{backup_plan_id}}
* $ pulumi import gcp:backupdisasterrecovery/backupPlan:BackupPlan default {{project}}/{{location}}/{{backup_plan_id}}
* $ pulumi import gcp:backupdisasterrecovery/backupPlan:BackupPlan default {{location}}/{{backup_plan_id}}
* ```
*/
class BackupPlan extends pulumi.CustomResource {
/**
* Get an existing BackupPlan 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 BackupPlan(name, state, { ...opts, id: id });
}
/** @internal */
static __pulumiType = 'gcp:backupdisasterrecovery/backupPlan:BackupPlan';
/**
* Returns true if the given object is an instance of BackupPlan. 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'] === BackupPlan.__pulumiType;
}
constructor(name, argsOrState, opts) {
let resourceInputs = {};
opts = opts || {};
if (opts.id) {
const state = argsOrState;
resourceInputs["backupPlanId"] = state?.backupPlanId;
resourceInputs["backupRules"] = state?.backupRules;
resourceInputs["backupVault"] = state?.backupVault;
resourceInputs["backupVaultServiceAccount"] = state?.backupVaultServiceAccount;
resourceInputs["computeInstanceBackupPlanProperties"] = state?.computeInstanceBackupPlanProperties;
resourceInputs["createTime"] = state?.createTime;
resourceInputs["deletionPolicy"] = state?.deletionPolicy;
resourceInputs["description"] = state?.description;
resourceInputs["diskBackupPlanProperties"] = state?.diskBackupPlanProperties;
resourceInputs["location"] = state?.location;
resourceInputs["logRetentionDays"] = state?.logRetentionDays;
resourceInputs["maxCustomOnDemandRetentionDays"] = state?.maxCustomOnDemandRetentionDays;
resourceInputs["name"] = state?.name;
resourceInputs["project"] = state?.project;
resourceInputs["resourceType"] = state?.resourceType;
resourceInputs["supportedResourceTypes"] = state?.supportedResourceTypes;
resourceInputs["updateTime"] = state?.updateTime;
}
else {
const args = argsOrState;
if (args?.backupPlanId === undefined && !opts.urn) {
throw new Error("Missing required property 'backupPlanId'");
}
if (args?.backupVault === undefined && !opts.urn) {
throw new Error("Missing required property 'backupVault'");
}
if (args?.location === undefined && !opts.urn) {
throw new Error("Missing required property 'location'");
}
if (args?.resourceType === undefined && !opts.urn) {
throw new Error("Missing required property 'resourceType'");
}
resourceInputs["backupPlanId"] = args?.backupPlanId;
resourceInputs["backupRules"] = args?.backupRules;
resourceInputs["backupVault"] = args?.backupVault;
resourceInputs["computeInstanceBackupPlanProperties"] = args?.computeInstanceBackupPlanProperties;
resourceInputs["deletionPolicy"] = args?.deletionPolicy;
resourceInputs["description"] = args?.description;
resourceInputs["diskBackupPlanProperties"] = args?.diskBackupPlanProperties;
resourceInputs["location"] = args?.location;
resourceInputs["logRetentionDays"] = args?.logRetentionDays;
resourceInputs["maxCustomOnDemandRetentionDays"] = args?.maxCustomOnDemandRetentionDays;
resourceInputs["project"] = args?.project;
resourceInputs["resourceType"] = args?.resourceType;
resourceInputs["backupVaultServiceAccount"] = undefined /*out*/;
resourceInputs["createTime"] = undefined /*out*/;
resourceInputs["name"] = undefined /*out*/;
resourceInputs["supportedResourceTypes"] = undefined /*out*/;
resourceInputs["updateTime"] = undefined /*out*/;
}
opts = pulumi.mergeOptions(utilities.resourceOptsDefaults(), opts);
super(BackupPlan.__pulumiType, name, resourceInputs, opts);
}
}
exports.BackupPlan = BackupPlan;
//# sourceMappingURL=backupPlan.js.map