BackupVault class

A backup vault is the location where backups are stored. You can only create one backup vault per region. A vault can hold multiple backups for multiple volumes in that region.

To get more information about BackupVault, see:

• API documentation
• How-to Guides
• Documentation

Example Usage

Netapp Backup Vault

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

const testBackupVault = new gcp.netapp.BackupVault("test_backup_vault", {
    name: "test-backup-vault",
    location: "us-west1",
    description: "Terraform created vault",
    labels: {
        creator: "testuser",
    },
});

import pulumi
import pulumi_gcp as gcp

test_backup_vault = gcp.netapp.BackupVault("test_backup_vault",
    name="test-backup-vault",
    location="us-west1",
    description="Terraform created vault",
    labels={
        "creator": "testuser",
    })

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

return await Deployment.RunAsync(() =>
{
    var testBackupVault = new Gcp.Netapp.BackupVault("test_backup_vault", new()
    {
        Name = "test-backup-vault",
        Location = "us-west1",
        Description = "Terraform created vault",
        Labels =
        {
            { "creator", "testuser" },
        },
    });

});

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.NewBackupVault(ctx, "test_backup_vault", &netapp.BackupVaultArgs{
			Name:        pulumi.String("test-backup-vault"),
			Location:    pulumi.String("us-west1"),
			Description: pulumi.String("Terraform created vault"),
			Labels: pulumi.StringMap{
				"creator": pulumi.String("testuser"),
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}

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

resource "gcp_netapp_backupvault" "test_backup_vault" {
  name        = "test-backup-vault"
  location    = "us-west1"
  description = "Terraform created vault"
  labels = {
    "creator" = "testuser"
  }
}

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.gcp.netapp.BackupVault;
import com.pulumi.gcp.netapp.BackupVaultArgs;
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 testBackupVault = new BackupVault("testBackupVault", BackupVaultArgs.builder()
            .name("test-backup-vault")
            .location("us-west1")
            .description("Terraform created vault")
            .labels(Map.of("creator", "testuser"))
            .build());

    }
}

resources:
  testBackupVault:
    type: gcp:netapp:BackupVault
    name: test_backup_vault
    properties:
      name: test-backup-vault
      location: us-west1
      description: Terraform created vault
      labels:
        creator: testuser

Import

BackupVault can be imported using any of these accepted formats:

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

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

$ pulumi import gcp:netapp/backupVault:BackupVault default projects/{{project}}/locations/{{location}}/backupVaults/{{name}}
$ pulumi import gcp:netapp/backupVault:BackupVault default {{project}}/{{location}}/{{name}}
$ pulumi import gcp:netapp/backupVault:BackupVault default {{location}}/{{name}}

Constructors

BackupVault(String name, {BackupVaultArgs? args, CustomResourceOptions? options})

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

BackupVault.reference(String urn)

Creates a typed reference to an existing BackupVault resource.

Properties

backupRegion ↔ Output<String?>

Region in which backup is stored.

late, final

backupRetentionPolicy ↔ Output<BackupVaultBackupRetentionPolicy?>

Backup retention policy defining the retention of the backups. Structure is documented below.

late, final

backupsCryptoKeyVersion ↔ Output<String>

The crypto key version used to encrypt the backup vault. Format: projects/{{project}}/locations/{{location}}/keyRings/{{key_ring}}/cryptoKeys/{{crypto_key}}/cryptoKeyVersions/{{crypto_key_version}}

late, final

backupVaultType ↔ Output<String>

Type of the backup vault to be created. Default is IN_REGION. Possible values are: BACKUP_VAULT_TYPE_UNSPECIFIED, IN_REGION, CROSS_REGION.

late, final

childResources → Set<Resource>

final, inherited

completionSources ↔ Map<String, IOutputCompletionSource>

late, final, inherited

createTime ↔ Output<String>

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

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

destinationBackupVault ↔ Output<String>

Name of the Backup vault created in backup region.

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

encryptionState ↔ Output<String>

Encryption state of customer-managed encryption keys (CMEK) backups.

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

kmsConfig ↔ Output<String?>

Specifies the Key Management System (KMS) configuration to be used for backup encryption. Format: projects/{{project}}/locations/{{location}}/kmsConfigs/{{kms_config}}

late, final

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

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

late, final

location ↔ Output<String>

Location (region) of the backup vault.

late, final

name ↔ Output<String>

The resource name of the backup vault. 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

sourceBackupVault ↔ Output<String>

Name of the Backup vault created in source region.

late, final

sourceRegion ↔ Output<String>

Region in which the backup vault is created.

late, final

state ↔ Output<String>

The state of the Backup Vault.

late, final

transformations → List<ResourceTransformation>

Inherited/explicit legacy transformations.

no setter, inherited

urn ↔ Output<String>

late, final, inherited

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, {BackupVaultState? state, CustomResourceOptions? options}) → BackupVault

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