Plan class

Provides an AWS Backup plan resource.

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";

const example = new aws.backup.Plan("example", {
    advancedBackupSettings: [{
        backupOptions: {
            WindowsVSS: "enabled",
        },
        resourceType: "EC2",
    }],
    rules: [{
        lifecycle: {
            deleteAfter: 14,
        },
        ruleName: "my_example_backup_rule",
        targetVaultName: test.name,
        schedule: "cron(0 12 * * ? *)",
    }],
    name: "my_example_backup_plan",
});

import pulumi
import pulumi_aws as aws

example = aws.backup.Plan("example",
    advanced_backup_settings=[{
        "backup_options": {
            "WindowsVSS": "enabled",
        },
        "resource_type": "EC2",
    }],
    rules=[{
        "lifecycle": {
            "delete_after": 14,
        },
        "rule_name": "my_example_backup_rule",
        "target_vault_name": test["name"],
        "schedule": "cron(0 12 * * ? *)",
    }],
    name="my_example_backup_plan")

using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;

return await Deployment.RunAsync(() =>
{
    var example = new Aws.Backup.Plan("example", new()
    {
        AdvancedBackupSettings = new[]
        {
            new Aws.Backup.Inputs.PlanAdvancedBackupSettingArgs
            {
                BackupOptions =
                {
                    { "WindowsVSS", "enabled" },
                },
                ResourceType = "EC2",
            },
        },
        Rules = new[]
        {
            new Aws.Backup.Inputs.PlanRuleArgs
            {
                Lifecycle = new Aws.Backup.Inputs.PlanRuleLifecycleArgs
                {
                    DeleteAfter = 14,
                },
                RuleName = "my_example_backup_rule",
                TargetVaultName = test.Name,
                Schedule = "cron(0 12 * * ? *)",
            },
        },
        Name = "my_example_backup_plan",
    });

});

package main

import (
	"github.com/pulumi/pulumi-aws/sdk/v7/go/aws/backup"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := backup.NewPlan(ctx, "example", &backup.PlanArgs{
			AdvancedBackupSettings: backup.PlanAdvancedBackupSettingArray{
				&backup.PlanAdvancedBackupSettingArgs{
					BackupOptions: pulumi.StringMap{
						"WindowsVSS": pulumi.String("enabled"),
					},
					ResourceType: pulumi.String("EC2"),
				},
			},
			Rules: backup.PlanRuleArray{
				&backup.PlanRuleArgs{
					Lifecycle: &backup.PlanRuleLifecycleArgs{
						DeleteAfter: pulumi.Int(14),
					},
					RuleName:        pulumi.String("my_example_backup_rule"),
					TargetVaultName: pulumi.Any(test.Name),
					Schedule:        pulumi.String("cron(0 12 * * ? *)"),
				},
			},
			Name: pulumi.String("my_example_backup_plan"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

pulumi {
  required_providers {
    aws = {
      source = "pulumi/aws"
    }
  }
}

resource "aws_backup_plan" "example" {
  advanced_backup_settings {
    backup_options = {
      "WindowsVSS" = "enabled"
    }
    resource_type = "EC2"
  }
  rules {
    lifecycle = {
      delete_after = 14
    }
    rule_name         = "my_example_backup_rule"
    target_vault_name = test.name
    schedule          = "cron(0 12 * * ? *)"
  }
  name = "my_example_backup_plan"
}

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.backup.Plan;
import com.pulumi.aws.backup.PlanArgs;
import com.pulumi.aws.backup.inputs.PlanAdvancedBackupSettingArgs;
import com.pulumi.aws.backup.inputs.PlanRuleArgs;
import com.pulumi.aws.backup.inputs.PlanRuleLifecycleArgs;
import java.util.ArrayList;
import java.util.Arrays;
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 example = new Plan("example", PlanArgs.builder()
            .advancedBackupSettings(PlanAdvancedBackupSettingArgs.builder()
                .backupOptions(Map.of("WindowsVSS", "enabled"))
                .resourceType("EC2")
                .build())
            .rules(PlanRuleArgs.builder()
                .lifecycle(PlanRuleLifecycleArgs.builder()
                    .deleteAfter(14)
                    .build())
                .ruleName("my_example_backup_rule")
                .targetVaultName(test.name())
                .schedule("cron(0 12 * * ? *)")
                .build())
            .name("my_example_backup_plan")
            .build());

    }
}

resources:
  example:
    type: aws:backup:Plan
    properties:
      advancedBackupSettings:
        - backupOptions:
            WindowsVSS: enabled
          resourceType: EC2
      rules:
        - lifecycle:
            deleteAfter: 14
          ruleName: my_example_backup_rule
          targetVaultName: ${test.name}
          schedule: cron(0 12 * * ? *)
      name: my_example_backup_plan

Import

Identity Schema

Required

• id (String) Backup Plan ID.

Optional

• accountId (String) AWS Account where this resource is managed.
• region (String) Region where this resource is managed.

Using pulumi import, import Backup Plan using the id. For example:

$ pulumi import aws:backup/plan:Plan example abc123