pulumi-gcp-kotlin/com.pulumi.gcp.backupdisasterrecovery.kotlin/BackupPlan

BackupPlan

class BackupPlan : KotlinCustomResource

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:

Example Usage

Backup Dr Backup Plan Simple

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,
    backupRules: [{
        ruleId: "rule-1",
        backupRetentionDays: 5,
        standardSchedule: {
            recurrenceType: "HOURLY",
            hourlyFrequency: 6,
            timeZone: "UTC",
            backupWindow: {
                startHourOfDay: 0,
                endHourOfDay: 24,
            },
        },
    }],
});
Content copied to clipboard
import pulumi
import pulumi_gcp as gcp
my_backup_vault = gcp.backupdisasterrecovery.BackupVault("my_backup_vault",
    location="us-central1",
    backup_vault_id="backup-vault-simple-test",
    backup_minimum_enforced_retention_duration="100000s")
my_backup_plan_1 = gcp.backupdisasterrecovery.BackupPlan("my-backup-plan-1",
    location="us-central1",
    backup_plan_id="backup-plan-simple-test",
    resource_type="compute.googleapis.com/Instance",
    backup_vault=my_backup_vault.id,
    backup_rules=[{
        "rule_id": "rule-1",
        "backup_retention_days": 5,
        "standard_schedule": {
            "recurrence_type": "HOURLY",
            "hourly_frequency": 6,
            "time_zone": "UTC",
            "backup_window": {
                "start_hour_of_day": 0,
                "end_hour_of_day": 24,
            },
        },
    }])
Content copied to clipboard
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Gcp = Pulumi.Gcp;
return await Deployment.RunAsync(() =>
{
    var myBackupVault = new Gcp.BackupDisasterRecovery.BackupVault("my_backup_vault", new()
    {
        Location = "us-central1",
        BackupVaultId = "backup-vault-simple-test",
        BackupMinimumEnforcedRetentionDuration = "100000s",
    });
    var my_backup_plan_1 = new Gcp.BackupDisasterRecovery.BackupPlan("my-backup-plan-1", new()
    {
        Location = "us-central1",
        BackupPlanId = "backup-plan-simple-test",
        ResourceType = "compute.googleapis.com/Instance",
        BackupVault = myBackupVault.Id,
        BackupRules = new[]
        {
            new Gcp.BackupDisasterRecovery.Inputs.BackupPlanBackupRuleArgs
            {
                RuleId = "rule-1",
                BackupRetentionDays = 5,
                StandardSchedule = new Gcp.BackupDisasterRecovery.Inputs.BackupPlanBackupRuleStandardScheduleArgs
                {
                    RecurrenceType = "HOURLY",
                    HourlyFrequency = 6,
                    TimeZone = "UTC",
                    BackupWindow = new Gcp.BackupDisasterRecovery.Inputs.BackupPlanBackupRuleStandardScheduleBackupWindowArgs
                    {
                        StartHourOfDay = 0,
                        EndHourOfDay = 24,
                    },
                },
            },
        },
    });
});
Content copied to clipboard
package main
import (
	"github.com/pulumi/pulumi-gcp/sdk/v8/go/gcp/backupdisasterrecovery"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		myBackupVault, err := backupdisasterrecovery.NewBackupVault(ctx, "my_backup_vault", &backupdisasterrecovery.BackupVaultArgs{
			Location:                               pulumi.String("us-central1"),
			BackupVaultId:                          pulumi.String("backup-vault-simple-test"),
			BackupMinimumEnforcedRetentionDuration: pulumi.String("100000s"),
		})
		if err != nil {
			return err
		}
		_, err = backupdisasterrecovery.NewBackupPlan(ctx, "my-backup-plan-1", &backupdisasterrecovery.BackupPlanArgs{
			Location:     pulumi.String("us-central1"),
			BackupPlanId: pulumi.String("backup-plan-simple-test"),
			ResourceType: pulumi.String("compute.googleapis.com/Instance"),
			BackupVault:  myBackupVault.ID(),
			BackupRules: backupdisasterrecovery.BackupPlanBackupRuleArray{
				&backupdisasterrecovery.BackupPlanBackupRuleArgs{
					RuleId:              pulumi.String("rule-1"),
					BackupRetentionDays: pulumi.Int(5),
					StandardSchedule: &backupdisasterrecovery.BackupPlanBackupRuleStandardScheduleArgs{
						RecurrenceType:  pulumi.String("HOURLY"),
						HourlyFrequency: pulumi.Int(6),
						TimeZone:        pulumi.String("UTC"),
						BackupWindow: &backupdisasterrecovery.BackupPlanBackupRuleStandardScheduleBackupWindowArgs{
							StartHourOfDay: pulumi.Int(0),
							EndHourOfDay:   pulumi.Int(24),
						},
					},
				},
			},
		})
		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.backupdisasterrecovery.BackupVault;
import com.pulumi.gcp.backupdisasterrecovery.BackupVaultArgs;
import com.pulumi.gcp.backupdisasterrecovery.BackupPlan;
import com.pulumi.gcp.backupdisasterrecovery.BackupPlanArgs;
import com.pulumi.gcp.backupdisasterrecovery.inputs.BackupPlanBackupRuleArgs;
import com.pulumi.gcp.backupdisasterrecovery.inputs.BackupPlanBackupRuleStandardScheduleArgs;
import com.pulumi.gcp.backupdisasterrecovery.inputs.BackupPlanBackupRuleStandardScheduleBackupWindowArgs;
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) {
        var myBackupVault = new BackupVault("myBackupVault", BackupVaultArgs.builder()
            .location("us-central1")
            .backupVaultId("backup-vault-simple-test")
            .backupMinimumEnforcedRetentionDuration("100000s")
            .build());
        var my_backup_plan_1 = new BackupPlan("my-backup-plan-1", BackupPlanArgs.builder()
            .location("us-central1")
            .backupPlanId("backup-plan-simple-test")
            .resourceType("compute.googleapis.com/Instance")
            .backupVault(myBackupVault.id())
            .backupRules(BackupPlanBackupRuleArgs.builder()
                .ruleId("rule-1")
                .backupRetentionDays(5)
                .standardSchedule(BackupPlanBackupRuleStandardScheduleArgs.builder()
                    .recurrenceType("HOURLY")
                    .hourlyFrequency(6)
                    .timeZone("UTC")
                    .backupWindow(BackupPlanBackupRuleStandardScheduleBackupWindowArgs.builder()
                        .startHourOfDay(0)
                        .endHourOfDay(24)
                        .build())
                    .build())
                .build())
            .build());
    }
}
Content copied to clipboard
resources:
  myBackupVault:
    type: gcp:backupdisasterrecovery:BackupVault
    name: my_backup_vault
    properties:
      location: us-central1
      backupVaultId: backup-vault-simple-test
      backupMinimumEnforcedRetentionDuration: 100000s
  my-backup-plan-1:
    type: gcp:backupdisasterrecovery:BackupPlan
    properties:
      location: us-central1
      backupPlanId: backup-plan-simple-test
      resourceType: compute.googleapis.com/Instance
      backupVault: ${myBackupVault.id}
      backupRules:
        - ruleId: rule-1
          backupRetentionDays: 5
          standardSchedule:
            recurrenceType: HOURLY
            hourlyFrequency: 6
            timeZone: UTC
            backupWindow:
              startHourOfDay: 0
              endHourOfDay: 24
Content copied to clipboard

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:

$ pulumi import gcp:backupdisasterrecovery/backupPlan:BackupPlan default projects/{{project}}/locations/{{location}}/backupPlans/{{backup_plan_id}}
Content copied to clipboard
$ pulumi import gcp:backupdisasterrecovery/backupPlan:BackupPlan default {{project}}/{{location}}/{{backup_plan_id}}
Content copied to clipboard
$ pulumi import gcp:backupdisasterrecovery/backupPlan:BackupPlan default {{location}}/{{backup_plan_id}}
Content copied to clipboard

Properties

Link copied to clipboard
val backupPlanId: Output<String>

The ID of the backup plan

Link copied to clipboard
val backupRules: Output<List<BackupPlanBackupRule>>

The backup rules for this BackupPlan. There must be at least one BackupRule message. Structure is documented below.

Link copied to clipboard
val backupVault: Output<String>

Backup vault where the backups gets stored using this Backup plan.

Link copied to clipboard
val backupVaultServiceAccount: Output<String>

The Google Cloud Platform Service Account to be used by the BackupVault for taking backups.

Link copied to clipboard
val createTime: Output<String>

When the BackupPlan was created.

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

The description allows for additional details about 'BackupPlan' and its use cases to be provided.

Link copied to clipboard
val id: Output<String>
Link copied to clipboard
val location: Output<String>

The location for the backup plan

Link copied to clipboard
val name: Output<String>

The name of backup plan resource created

Link copied to clipboard
val project: Output<String>
Link copied to clipboard
val pulumiChildResources: Set<KotlinResource>
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
val resourceType: Output<String>

The resource type to which the BackupPlan will be applied. Examples include, "compute.googleapis.com/Instance" and "storage.googleapis.com/Bucket".

Link copied to clipboard
val updateTime: Output<String>

When the BackupPlan was last updated.

Link copied to clipboard
val urn: Output<String>