BackupPolicy class

A backup policy is used to schedule backups at regular daily, weekly, or monthly intervals. Backup policies allow you to attach a backup schedule to a volume. The policy defines how many backups to retain at daily, weekly, or monthly intervals.

To get more information about BackupPolicy, see:

• API documentation
• How-to Guides
• Documentation

Example Usage

Netapp Backup Policy Full

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

const testBackupPolicyFull = new gcp.netapp.BackupPolicy("test_backup_policy_full", {
    name: "test-backup-policy-full",
    location: "us-central1",
    dailyBackupLimit: 2,
    weeklyBackupLimit: 1,
    monthlyBackupLimit: 1,
    description: "TF test backup schedule",
    enabled: true,
    labels: {
        foo: "bar",
    },
});

import pulumi
import pulumi_gcp as gcp

test_backup_policy_full = gcp.netapp.BackupPolicy("test_backup_policy_full",
    name="test-backup-policy-full",
    location="us-central1",
    daily_backup_limit=2,
    weekly_backup_limit=1,
    monthly_backup_limit=1,
    description="TF test backup schedule",
    enabled=True,
    labels={
        "foo": "bar",
    })

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

return await Deployment.RunAsync(() =>
{
    var testBackupPolicyFull = new Gcp.Netapp.BackupPolicy("test_backup_policy_full", new()
    {
        Name = "test-backup-policy-full",
        Location = "us-central1",
        DailyBackupLimit = 2,
        WeeklyBackupLimit = 1,
        MonthlyBackupLimit = 1,
        Description = "TF test backup schedule",
        Enabled = true,
        Labels =
        {
            { "foo", "bar" },
        },
    });

});

package main

import (
	"github.com/pulumi/pulumi-gcp/sdk/v9/go/gcp/netapp"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := netapp.NewBackupPolicy(ctx, "test_backup_policy_full", &netapp.BackupPolicyArgs{
			Name:               pulumi.String("test-backup-policy-full"),
			Location:           pulumi.String("us-central1"),
			DailyBackupLimit:   pulumi.Int(2),
			WeeklyBackupLimit:  pulumi.Int(1),
			MonthlyBackupLimit: pulumi.Int(1),
			Description:        pulumi.String("TF test backup schedule"),
			Enabled:            pulumi.Bool(true),
			Labels: pulumi.StringMap{
				"foo": pulumi.String("bar"),
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}

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

resource "gcp_netapp_backuppolicy" "test_backup_policy_full" {
  name                 = "test-backup-policy-full"
  location             = "us-central1"
  daily_backup_limit   = 2
  weekly_backup_limit  = 1
  monthly_backup_limit = 1
  description          = "TF test backup schedule"
  enabled              = true
  labels = {
    "foo" = "bar"
  }
}

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.gcp.netapp.BackupPolicy;
import com.pulumi.gcp.netapp.BackupPolicyArgs;
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 testBackupPolicyFull = new BackupPolicy("testBackupPolicyFull", BackupPolicyArgs.builder()
            .name("test-backup-policy-full")
            .location("us-central1")
            .dailyBackupLimit(2)
            .weeklyBackupLimit(1)
            .monthlyBackupLimit(1)
            .description("TF test backup schedule")
            .enabled(true)
            .labels(Map.of("foo", "bar"))
            .build());

    }
}

resources:
  testBackupPolicyFull:
    type: gcp:netapp:BackupPolicy
    name: test_backup_policy_full
    properties:
      name: test-backup-policy-full
      location: us-central1
      dailyBackupLimit: 2
      weeklyBackupLimit: 1
      monthlyBackupLimit: 1
      description: TF test backup schedule
      enabled: true
      labels:
        foo: bar

Import

BackupPolicy can be imported using any of these accepted formats:

• projects/{{project}}/locations/{{location}}/backupPolicies/{{name}}
• {{project}}/{{location}}/{{name}}
• {{location}}/{{name}}

When using the pulumi import command, BackupPolicy can be imported using one of the formats above. For example:

$ pulumi import gcp:netapp/backupPolicy:BackupPolicy default projects/{{project}}/locations/{{location}}/backupPolicies/{{name}}
$ pulumi import gcp:netapp/backupPolicy:BackupPolicy default {{project}}/{{location}}/{{name}}
$ pulumi import gcp:netapp/backupPolicy:BackupPolicy default {{location}}/{{name}}

Constructors

BackupPolicy(String name, {BackupPolicyArgs? args, CustomResourceOptions? options})

Creates a new BackupPolicy. name The Pulumi resource name. args Arguments used to configure this BackupPolicy. The set of arguments for BackupPolicy. options Resource options controlling this resource's behavior.

BackupPolicy.reference(String urn)

Creates a typed reference to an existing BackupPolicy resource.

Properties

assignedVolumeCount ↔ Output<int>

The total number of volumes assigned by this backup policy.

late, final

childResources → Set<Resource>

final, inherited

completionSources ↔ Map<String, IOutputCompletionSource>

late, final, inherited

createTime ↔ Output<String>

Create time of the backup policy. A timestamp in RFC3339 UTC "Zulu" format. Examples: "2023-06-22T09:13:01.617Z".

late, final

dailyBackupLimit ↔ Output<int>

Number of daily backups to keep. Note that the minimum daily backup limit is 2.

late, final

deletionPolicy ↔ Output<String>

Whether Terraform will be prevented from destroying the resource. Defaults to DELETE. When a 'terraform destroy' or 'pulumi up' would delete the resource, the command will fail if this field is set to "PREVENT" in Terraform state. When set to "ABANDON", the command will remove the resource from Terraform management without updating or deleting the resource in the API. When set to "DELETE", deleting the resource is allowed.

late, final

description ↔ Output<String?>

An optional description of this resource.

late, final

effectiveLabels ↔ Output<Map<String, String>>

All of labels (key/value pairs) present on the resource in GCP, including the labels configured through Pulumi, other clients and services.

late, final

enabled ↔ Output<bool?>

If enabled, make backups automatically according to the schedules. This will be applied to all volumes that have this policy attached and enforced on volume level.

late, final

hashCode → int

The hash code for this object.

no setter, inherited

id ↔ Output<String>

getter/setter pair, inherited

isCustom → bool

Returns whether this resource is provider-managed.

no setter, inherited

isProtected → bool

Returns whether this resource is protected from deletion.

no setter, inherited

isRemote → bool

Whether this resource is registered as remote.

no setter, inherited

isResourceReference → bool

Whether this instance represents a resource value returned over RPC.

final, inherited

labels ↔ Output<Map<String, String>?>

Labels as key value pairs. Example: { "owner": "Bob", "department": "finance", "purpose": "testing" }.

late, final

location ↔ Output<String>

Name of the region for the policy to apply to.

late, final

monthlyBackupLimit ↔ Output<int>

Number of monthly backups to keep. Note that the sum of daily, weekly and monthly backups should be greater than 1.

late, final

name ↔ Output<String>

The name of the backup policy. Needs to be unique per location.

late, final

project ↔ Output<String>

The ID of the project in which the resource belongs. If it is not provided, the provider project is used.

late, final

pulumiLabels ↔ Output<Map<String, String>>

The combination of labels configured directly on the resource and default labels configured on the provider.

late, final

resourceTransforms → List<ResourceTransform>

Inherited/explicit async transforms.

no setter, inherited

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

state ↔ Output<String>

The state of the backup policy.

late, final

transformations → List<ResourceTransformation>

Inherited/explicit legacy transformations.

no setter, inherited

urn ↔ Output<String>

late, final, inherited

weeklyBackupLimit ↔ Output<int>

Number of weekly backups to keep. Note that the sum of daily, weekly and monthly backups should be greater than 1.

late, final

Methods

failId(Object error) → void

Completes this resource ID with an error when registration fails.

inherited

failOutputs(Object error) → void

Completes all output properties with error.

inherited

failUrn(Object error) → void

Completes this resource URN with an error when registration fails.

inherited

getProvider(String moduleMember) → ProviderResource?

Returns provider for moduleMember's package, if configured.

inherited

getResourceName() → String

Returns this resource's logical name.

inherited

getResourceType() → String

Returns this resource's Pulumi type token.

inherited

noSuchMethod(Invocation invocation) → dynamic

Invoked when a nonexistent method or property is accessed.

inherited

registerOutput<T>(String propertyName, {Object? decoder(Object?)?, bool isSecret = false}) → Output<T>

Registers a dynamic output property for this resource.

inherited

resolveId(String? value, {required bool isKnown}) → void

Resolves the provider-assigned ID for this resource.

inherited

resolveOutputs(Struct outputs) → void

Resolves all output properties from a monitor response payload.

inherited

resolveUrn(String value) → void

Resolves this resource's URN once assigned by the engine.

inherited

serializeProperties(Map<String, dynamic> properties) → Future<Struct>

Serializes resource properties for RPC transmission.

inherited

toString() → String

A string representation of this object.

inherited

Operators

operator ==(Object other) → bool

The equality operator.

inherited

Static Methods

get(String name, Input<String> id, {BackupPolicyState? state, CustomResourceOptions? options}) → BackupPolicy

Gets an existing BackupPolicy resource's state with the given name and id.