Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. Google Cloud (GCP) Classic
  3. API Docs
  4. backupdisasterrecovery
  5. BackupVault
Google Cloud Classic v8.3.1 published on Wednesday, Sep 25, 2024 by Pulumi
pulumi/pulumi-gcp

gcp.backupdisasterrecovery.BackupVault

Explore with Pulumi AI

gcp logo
Google Cloud Classic v8.3.1 published on Wednesday, Sep 25, 2024 by Pulumi
pulumi/pulumi-gcp

    Example Usage

    Backup Dr Backup Vault Full

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

const backup_vault_test = new gcp.backupdisasterrecovery.BackupVault("backup-vault-test", {
    location: "us-central1",
    backupVaultId: "backup-vault-test",
    description: "This is a second backup vault built by Terraform.",
    backupMinimumEnforcedRetentionDuration: "100000s",
    labels: {
        foo: "bar1",
        bar: "baz1",
    },
    annotations: {
        annotations1: "bar1",
        annotations2: "baz1",
    },
    forceUpdate: true,
    forceDelete: true,
    allowMissing: true,
});

    import pulumi
import pulumi_gcp as gcp

backup_vault_test = gcp.backupdisasterrecovery.BackupVault("backup-vault-test",
    location="us-central1",
    backup_vault_id="backup-vault-test",
    description="This is a second backup vault built by Terraform.",
    backup_minimum_enforced_retention_duration="100000s",
    labels={
        "foo": "bar1",
        "bar": "baz1",
    },
    annotations={
        "annotations1": "bar1",
        "annotations2": "baz1",
    },
    force_update=True,
    force_delete=True,
    allow_missing=True)

    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 {
		_, err := backupdisasterrecovery.NewBackupVault(ctx, "backup-vault-test", &backupdisasterrecovery.BackupVaultArgs{
			Location:                               pulumi.String("us-central1"),
			BackupVaultId:                          pulumi.String("backup-vault-test"),
			Description:                            pulumi.String("This is a second backup vault built by Terraform."),
			BackupMinimumEnforcedRetentionDuration: pulumi.String("100000s"),
			Labels: pulumi.StringMap{
				"foo": pulumi.String("bar1"),
				"bar": pulumi.String("baz1"),
			},
			Annotations: pulumi.StringMap{
				"annotations1": pulumi.String("bar1"),
				"annotations2": pulumi.String("baz1"),
			},
			ForceUpdate:  pulumi.Bool(true),
			ForceDelete:  pulumi.Bool(true),
			AllowMissing: pulumi.Bool(true),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

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

return await Deployment.RunAsync(() => 
{
    var backup_vault_test = new Gcp.BackupDisasterRecovery.BackupVault("backup-vault-test", new()
    {
        Location = "us-central1",
        BackupVaultId = "backup-vault-test",
        Description = "This is a second backup vault built by Terraform.",
        BackupMinimumEnforcedRetentionDuration = "100000s",
        Labels = 
        {
            { "foo", "bar1" },
            { "bar", "baz1" },
        },
        Annotations = 
        {
            { "annotations1", "bar1" },
            { "annotations2", "baz1" },
        },
        ForceUpdate = true,
        ForceDelete = true,
        AllowMissing = true,
    });

});

    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 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 backup_vault_test = new BackupVault("backup-vault-test", BackupVaultArgs.builder()
            .location("us-central1")
            .backupVaultId("backup-vault-test")
            .description("This is a second backup vault built by Terraform.")
            .backupMinimumEnforcedRetentionDuration("100000s")
            .labels(Map.ofEntries(
                Map.entry("foo", "bar1"),
                Map.entry("bar", "baz1")
            ))
            .annotations(Map.ofEntries(
                Map.entry("annotations1", "bar1"),
                Map.entry("annotations2", "baz1")
            ))
            .forceUpdate("true")
            .forceDelete("true")
            .allowMissing("true")
            .build());

    }
}

    resources:
  backup-vault-test:
    type: gcp:backupdisasterrecovery:BackupVault
    properties:
      location: us-central1
      backupVaultId: backup-vault-test
      description: This is a second backup vault built by Terraform.
      backupMinimumEnforcedRetentionDuration: 100000s
      labels:
        foo: bar1
        bar: baz1
      annotations:
        annotations1: bar1
        annotations2: baz1
      forceUpdate: 'true'
      forceDelete: 'true'
      allowMissing: 'true'

    Create BackupVault Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new BackupVault(name: string, args: BackupVaultArgs, opts?: CustomResourceOptions);
    @overload
def BackupVault(resource_name: str,
                args: BackupVaultArgs,
                opts: Optional[ResourceOptions] = None)

@overload
def BackupVault(resource_name: str,
                opts: Optional[ResourceOptions] = None,
                backup_minimum_enforced_retention_duration: Optional[str] = None,
                backup_vault_id: Optional[str] = None,
                location: Optional[str] = None,
                allow_missing: Optional[bool] = None,
                annotations: Optional[Mapping[str, str]] = None,
                description: Optional[str] = None,
                effective_time: Optional[str] = None,
                force_delete: Optional[bool] = None,
                force_update: Optional[bool] = None,
                labels: Optional[Mapping[str, str]] = None,
                project: Optional[str] = None)
    func NewBackupVault(ctx *Context, name string, args BackupVaultArgs, opts ...ResourceOption) (*BackupVault, error)
    public BackupVault(string name, BackupVaultArgs args, CustomResourceOptions? opts = null)
    public BackupVault(String name, BackupVaultArgs args)
public BackupVault(String name, BackupVaultArgs args, CustomResourceOptions options)

    type: gcp:backupdisasterrecovery:BackupVault
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

    Parameters

    name string
    The unique name of the resource.
    args BackupVaultArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args BackupVaultArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args BackupVaultArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args BackupVaultArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args BackupVaultArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Constructor example

    The following reference example uses placeholder values for all input properties.

    var backupVaultResource = new Gcp.BackupDisasterRecovery.BackupVault("backupVaultResource", new()
{
    BackupMinimumEnforcedRetentionDuration = "string",
    BackupVaultId = "string",
    Location = "string",
    AllowMissing = false,
    Annotations = 
    {
        { "string", "string" },
    },
    Description = "string",
    EffectiveTime = "string",
    ForceDelete = false,
    ForceUpdate = false,
    Labels = 
    {
        { "string", "string" },
    },
    Project = "string",
});

    example, err := backupdisasterrecovery.NewBackupVault(ctx, "backupVaultResource", &backupdisasterrecovery.BackupVaultArgs{
	BackupMinimumEnforcedRetentionDuration: pulumi.String("string"),
	BackupVaultId:                          pulumi.String("string"),
	Location:                               pulumi.String("string"),
	AllowMissing:                           pulumi.Bool(false),
	Annotations: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
	Description:   pulumi.String("string"),
	EffectiveTime: pulumi.String("string"),
	ForceDelete:   pulumi.Bool(false),
	ForceUpdate:   pulumi.Bool(false),
	Labels: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
	Project: pulumi.String("string"),
})

    var backupVaultResource = new BackupVault("backupVaultResource", BackupVaultArgs.builder()
    .backupMinimumEnforcedRetentionDuration("string")
    .backupVaultId("string")
    .location("string")
    .allowMissing(false)
    .annotations(Map.of("string", "string"))
    .description("string")
    .effectiveTime("string")
    .forceDelete(false)
    .forceUpdate(false)
    .labels(Map.of("string", "string"))
    .project("string")
    .build());

    backup_vault_resource = gcp.backupdisasterrecovery.BackupVault("backupVaultResource",
    backup_minimum_enforced_retention_duration="string",
    backup_vault_id="string",
    location="string",
    allow_missing=False,
    annotations={
        "string": "string",
    },
    description="string",
    effective_time="string",
    force_delete=False,
    force_update=False,
    labels={
        "string": "string",
    },
    project="string")

    const backupVaultResource = new gcp.backupdisasterrecovery.BackupVault("backupVaultResource", {
    backupMinimumEnforcedRetentionDuration: "string",
    backupVaultId: "string",
    location: "string",
    allowMissing: false,
    annotations: {
        string: "string",
    },
    description: "string",
    effectiveTime: "string",
    forceDelete: false,
    forceUpdate: false,
    labels: {
        string: "string",
    },
    project: "string",
});

    type: gcp:backupdisasterrecovery:BackupVault
properties:
    allowMissing: false
    annotations:
        string: string
    backupMinimumEnforcedRetentionDuration: string
    backupVaultId: string
    description: string
    effectiveTime: string
    forceDelete: false
    forceUpdate: false
    labels:
        string: string
    location: string
    project: string

    BackupVault Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    The BackupVault resource accepts the following input properties:

    BackupMinimumEnforcedRetentionDuration string
    Required. The default and minimum enforced retention for each backup within the backup vault. The enforced retention for each backup can be extended.
    BackupVaultId string
    Required. ID of the requesting object.

    Location string
    The GCP location for the backup vault.
    AllowMissing bool
    Allow idempotent deletion of backup vault. The request will still succeed in case the backup vault does not exist.
    Annotations Dictionary<string, string>
    Optional. User annotations. See https://google.aip.dev/128#annotations Stores small amounts of arbitrary data. Note: This field is non-authoritative, and will only manage the annotations present in your configuration. Please refer to the field effective_annotations for all of the annotations present on the resource.
    Description string
    Optional. The description of the BackupVault instance (2048 characters or less).
    EffectiveTime string
    Optional. Time after which the BackupVault resource is locked.
    ForceDelete bool
    If set, the following restrictions against deletion of the backup vault instance can be overridden:

    • deletion of a backup vault instance containing no backups, but still containing empty datasources.
    • deletion of a backup vault instance that is being referenced by an active backup plan.
    ForceUpdate bool
    If set, allow update to extend the minimum enforced retention for backup vault. This overrides the restriction against conflicting retention periods. This conflict may occur when the expiration schedule defined by the associated backup plan is shorter than the minimum retention set by the backup vault.
    Labels Dictionary<string, string>
    Optional. Resource labels to represent user provided metadata. Note: This field is non-authoritative, and will only manage the labels present in your configuration. Please refer to the field effective_labels for all of the labels present on the resource.
    Project string
    The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
    BackupMinimumEnforcedRetentionDuration string
    Required. The default and minimum enforced retention for each backup within the backup vault. The enforced retention for each backup can be extended.
    BackupVaultId string
    Required. ID of the requesting object.

    Location string
    The GCP location for the backup vault.
    AllowMissing bool
    Allow idempotent deletion of backup vault. The request will still succeed in case the backup vault does not exist.
    Annotations map[string]string
    Optional. User annotations. See https://google.aip.dev/128#annotations Stores small amounts of arbitrary data. Note: This field is non-authoritative, and will only manage the annotations present in your configuration. Please refer to the field effective_annotations for all of the annotations present on the resource.
    Description string
    Optional. The description of the BackupVault instance (2048 characters or less).
    EffectiveTime string
    Optional. Time after which the BackupVault resource is locked.
    ForceDelete bool
    If set, the following restrictions against deletion of the backup vault instance can be overridden:

    • deletion of a backup vault instance containing no backups, but still containing empty datasources.
    • deletion of a backup vault instance that is being referenced by an active backup plan.
    ForceUpdate bool
    If set, allow update to extend the minimum enforced retention for backup vault. This overrides the restriction against conflicting retention periods. This conflict may occur when the expiration schedule defined by the associated backup plan is shorter than the minimum retention set by the backup vault.
    Labels map[string]string
    Optional. Resource labels to represent user provided metadata. Note: This field is non-authoritative, and will only manage the labels present in your configuration. Please refer to the field effective_labels for all of the labels present on the resource.
    Project string
    The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
    backupMinimumEnforcedRetentionDuration String
    Required. The default and minimum enforced retention for each backup within the backup vault. The enforced retention for each backup can be extended.
    backupVaultId String
    Required. ID of the requesting object.

    location String
    The GCP location for the backup vault.
    allowMissing Boolean
    Allow idempotent deletion of backup vault. The request will still succeed in case the backup vault does not exist.
    annotations Map<String,String>
    Optional. User annotations. See https://google.aip.dev/128#annotations Stores small amounts of arbitrary data. Note: This field is non-authoritative, and will only manage the annotations present in your configuration. Please refer to the field effective_annotations for all of the annotations present on the resource.
    description String
    Optional. The description of the BackupVault instance (2048 characters or less).
    effectiveTime String
    Optional. Time after which the BackupVault resource is locked.
    forceDelete Boolean
    If set, the following restrictions against deletion of the backup vault instance can be overridden:

    • deletion of a backup vault instance containing no backups, but still containing empty datasources.
    • deletion of a backup vault instance that is being referenced by an active backup plan.
    forceUpdate Boolean
    If set, allow update to extend the minimum enforced retention for backup vault. This overrides the restriction against conflicting retention periods. This conflict may occur when the expiration schedule defined by the associated backup plan is shorter than the minimum retention set by the backup vault.
    labels Map<String,String>
    Optional. Resource labels to represent user provided metadata. Note: This field is non-authoritative, and will only manage the labels present in your configuration. Please refer to the field effective_labels for all of the labels present on the resource.
    project String
    The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
    backupMinimumEnforcedRetentionDuration string
    Required. The default and minimum enforced retention for each backup within the backup vault. The enforced retention for each backup can be extended.
    backupVaultId string
    Required. ID of the requesting object.

    location string
    The GCP location for the backup vault.
    allowMissing boolean
    Allow idempotent deletion of backup vault. The request will still succeed in case the backup vault does not exist.
    annotations {[key: string]: string}
    Optional. User annotations. See https://google.aip.dev/128#annotations Stores small amounts of arbitrary data. Note: This field is non-authoritative, and will only manage the annotations present in your configuration. Please refer to the field effective_annotations for all of the annotations present on the resource.
    description string
    Optional. The description of the BackupVault instance (2048 characters or less).
    effectiveTime string
    Optional. Time after which the BackupVault resource is locked.
    forceDelete boolean
    If set, the following restrictions against deletion of the backup vault instance can be overridden:

    • deletion of a backup vault instance containing no backups, but still containing empty datasources.
    • deletion of a backup vault instance that is being referenced by an active backup plan.
    forceUpdate boolean
    If set, allow update to extend the minimum enforced retention for backup vault. This overrides the restriction against conflicting retention periods. This conflict may occur when the expiration schedule defined by the associated backup plan is shorter than the minimum retention set by the backup vault.
    labels {[key: string]: string}
    Optional. Resource labels to represent user provided metadata. Note: This field is non-authoritative, and will only manage the labels present in your configuration. Please refer to the field effective_labels for all of the labels present on the resource.
    project string
    The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
    backup_minimum_enforced_retention_duration str
    Required. The default and minimum enforced retention for each backup within the backup vault. The enforced retention for each backup can be extended.
    backup_vault_id str
    Required. ID of the requesting object.

    location str
    The GCP location for the backup vault.
    allow_missing bool
    Allow idempotent deletion of backup vault. The request will still succeed in case the backup vault does not exist.
    annotations Mapping[str, str]
    Optional. User annotations. See https://google.aip.dev/128#annotations Stores small amounts of arbitrary data. Note: This field is non-authoritative, and will only manage the annotations present in your configuration. Please refer to the field effective_annotations for all of the annotations present on the resource.
    description str
    Optional. The description of the BackupVault instance (2048 characters or less).
    effective_time str
    Optional. Time after which the BackupVault resource is locked.
    force_delete bool
    If set, the following restrictions against deletion of the backup vault instance can be overridden:

    • deletion of a backup vault instance containing no backups, but still containing empty datasources.
    • deletion of a backup vault instance that is being referenced by an active backup plan.
    force_update bool
    If set, allow update to extend the minimum enforced retention for backup vault. This overrides the restriction against conflicting retention periods. This conflict may occur when the expiration schedule defined by the associated backup plan is shorter than the minimum retention set by the backup vault.
    labels Mapping[str, str]
    Optional. Resource labels to represent user provided metadata. Note: This field is non-authoritative, and will only manage the labels present in your configuration. Please refer to the field effective_labels for all of the labels present on the resource.
    project str
    The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
    backupMinimumEnforcedRetentionDuration String
    Required. The default and minimum enforced retention for each backup within the backup vault. The enforced retention for each backup can be extended.
    backupVaultId String
    Required. ID of the requesting object.

    location String
    The GCP location for the backup vault.
    allowMissing Boolean
    Allow idempotent deletion of backup vault. The request will still succeed in case the backup vault does not exist.
    annotations Map<String>
    Optional. User annotations. See https://google.aip.dev/128#annotations Stores small amounts of arbitrary data. Note: This field is non-authoritative, and will only manage the annotations present in your configuration. Please refer to the field effective_annotations for all of the annotations present on the resource.
    description String
    Optional. The description of the BackupVault instance (2048 characters or less).
    effectiveTime String
    Optional. Time after which the BackupVault resource is locked.
    forceDelete Boolean
    If set, the following restrictions against deletion of the backup vault instance can be overridden:

    • deletion of a backup vault instance containing no backups, but still containing empty datasources.
    • deletion of a backup vault instance that is being referenced by an active backup plan.
    forceUpdate Boolean
    If set, allow update to extend the minimum enforced retention for backup vault. This overrides the restriction against conflicting retention periods. This conflict may occur when the expiration schedule defined by the associated backup plan is shorter than the minimum retention set by the backup vault.
    labels Map<String>
    Optional. Resource labels to represent user provided metadata. Note: This field is non-authoritative, and will only manage the labels present in your configuration. Please refer to the field effective_labels for all of the labels present on the resource.
    project String
    The ID of the project in which the resource belongs. If it is not provided, the provider project is used.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the BackupVault resource produces the following output properties:

    BackupCount string
    Output only. The number of backups in this backup vault.
    CreateTime string
    Output only. The time when the instance was created.
    Deletable bool
    Output only. Set to true when there are no backups nested under this resource.
    EffectiveAnnotations Dictionary<string, string>
    EffectiveLabels Dictionary<string, string>
    All of labels (key/value pairs) present on the resource in GCP, including the labels configured through Pulumi, other clients and services.
    Etag string
    Optional. Server specified ETag for the backup vault resource to prevent simultaneous updates from overwiting each other.
    Id string
    The provider-assigned unique ID for this managed resource.
    Name string
    Output only. Identifier. The resource name.
    PulumiLabels Dictionary<string, string>
    The combination of labels configured directly on the resource and default labels configured on the provider.
    ServiceAccount string
    Output only. Service account used by the BackupVault Service for this BackupVault. The user should grant this account permissions in their workload project to enable the service to run backups and restores there.
    State string
    Output only. The BackupVault resource instance state. Possible values: STATE_UNSPECIFIED CREATING ACTIVE DELETING ERROR
    TotalStoredBytes string
    Output only. Total size of the storage used by all backup resources.
    Uid string
    Output only. Output only Immutable after resource creation until resource deletion.
    UpdateTime string
    Output only. The time when the instance was updated.
    BackupCount string
    Output only. The number of backups in this backup vault.
    CreateTime string
    Output only. The time when the instance was created.
    Deletable bool
    Output only. Set to true when there are no backups nested under this resource.
    EffectiveAnnotations map[string]string
    EffectiveLabels 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.
    Etag string
    Optional. Server specified ETag for the backup vault resource to prevent simultaneous updates from overwiting each other.
    Id string
    The provider-assigned unique ID for this managed resource.
    Name string
    Output only. Identifier. The resource name.
    PulumiLabels map[string]string
    The combination of labels configured directly on the resource and default labels configured on the provider.
    ServiceAccount string
    Output only. Service account used by the BackupVault Service for this BackupVault. The user should grant this account permissions in their workload project to enable the service to run backups and restores there.
    State string
    Output only. The BackupVault resource instance state. Possible values: STATE_UNSPECIFIED CREATING ACTIVE DELETING ERROR
    TotalStoredBytes string
    Output only. Total size of the storage used by all backup resources.
    Uid string
    Output only. Output only Immutable after resource creation until resource deletion.
    UpdateTime string
    Output only. The time when the instance was updated.
    backupCount String
    Output only. The number of backups in this backup vault.
    createTime String
    Output only. The time when the instance was created.
    deletable Boolean
    Output only. Set to true when there are no backups nested under this resource.
    effectiveAnnotations Map<String,String>
    effectiveLabels 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.
    etag String
    Optional. Server specified ETag for the backup vault resource to prevent simultaneous updates from overwiting each other.
    id String
    The provider-assigned unique ID for this managed resource.
    name String
    Output only. Identifier. The resource name.
    pulumiLabels Map<String,String>
    The combination of labels configured directly on the resource and default labels configured on the provider.
    serviceAccount String
    Output only. Service account used by the BackupVault Service for this BackupVault. The user should grant this account permissions in their workload project to enable the service to run backups and restores there.
    state String
    Output only. The BackupVault resource instance state. Possible values: STATE_UNSPECIFIED CREATING ACTIVE DELETING ERROR
    totalStoredBytes String
    Output only. Total size of the storage used by all backup resources.
    uid String
    Output only. Output only Immutable after resource creation until resource deletion.
    updateTime String
    Output only. The time when the instance was updated.
    backupCount string
    Output only. The number of backups in this backup vault.
    createTime string
    Output only. The time when the instance was created.
    deletable boolean
    Output only. Set to true when there are no backups nested under this resource.
    effectiveAnnotations {[key: string]: string}
    effectiveLabels {[key: string]: string}
    All of labels (key/value pairs) present on the resource in GCP, including the labels configured through Pulumi, other clients and services.
    etag string
    Optional. Server specified ETag for the backup vault resource to prevent simultaneous updates from overwiting each other.
    id string
    The provider-assigned unique ID for this managed resource.
    name string
    Output only. Identifier. The resource name.
    pulumiLabels {[key: string]: string}
    The combination of labels configured directly on the resource and default labels configured on the provider.
    serviceAccount string
    Output only. Service account used by the BackupVault Service for this BackupVault. The user should grant this account permissions in their workload project to enable the service to run backups and restores there.
    state string
    Output only. The BackupVault resource instance state. Possible values: STATE_UNSPECIFIED CREATING ACTIVE DELETING ERROR
    totalStoredBytes string
    Output only. Total size of the storage used by all backup resources.
    uid string
    Output only. Output only Immutable after resource creation until resource deletion.
    updateTime string
    Output only. The time when the instance was updated.
    backup_count str
    Output only. The number of backups in this backup vault.
    create_time str
    Output only. The time when the instance was created.
    deletable bool
    Output only. Set to true when there are no backups nested under this resource.
    effective_annotations Mapping[str, str]
    effective_labels Mapping[str, str]
    All of labels (key/value pairs) present on the resource in GCP, including the labels configured through Pulumi, other clients and services.
    etag str
    Optional. Server specified ETag for the backup vault resource to prevent simultaneous updates from overwiting each other.
    id str
    The provider-assigned unique ID for this managed resource.
    name str
    Output only. Identifier. The resource name.
    pulumi_labels Mapping[str, str]
    The combination of labels configured directly on the resource and default labels configured on the provider.
    service_account str
    Output only. Service account used by the BackupVault Service for this BackupVault. The user should grant this account permissions in their workload project to enable the service to run backups and restores there.
    state str
    Output only. The BackupVault resource instance state. Possible values: STATE_UNSPECIFIED CREATING ACTIVE DELETING ERROR
    total_stored_bytes str
    Output only. Total size of the storage used by all backup resources.
    uid str
    Output only. Output only Immutable after resource creation until resource deletion.
    update_time str
    Output only. The time when the instance was updated.
    backupCount String
    Output only. The number of backups in this backup vault.
    createTime String
    Output only. The time when the instance was created.
    deletable Boolean
    Output only. Set to true when there are no backups nested under this resource.
    effectiveAnnotations Map<String>
    effectiveLabels Map<String>
    All of labels (key/value pairs) present on the resource in GCP, including the labels configured through Pulumi, other clients and services.
    etag String
    Optional. Server specified ETag for the backup vault resource to prevent simultaneous updates from overwiting each other.
    id String
    The provider-assigned unique ID for this managed resource.
    name String
    Output only. Identifier. The resource name.
    pulumiLabels Map<String>
    The combination of labels configured directly on the resource and default labels configured on the provider.
    serviceAccount String
    Output only. Service account used by the BackupVault Service for this BackupVault. The user should grant this account permissions in their workload project to enable the service to run backups and restores there.
    state String
    Output only. The BackupVault resource instance state. Possible values: STATE_UNSPECIFIED CREATING ACTIVE DELETING ERROR
    totalStoredBytes String
    Output only. Total size of the storage used by all backup resources.
    uid String
    Output only. Output only Immutable after resource creation until resource deletion.
    updateTime String
    Output only. The time when the instance was updated.

    Look up Existing BackupVault Resource

    Get an existing BackupVault resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

    public static get(name: string, id: Input<ID>, state?: BackupVaultState, opts?: CustomResourceOptions): BackupVault
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        allow_missing: Optional[bool] = None,
        annotations: Optional[Mapping[str, str]] = None,
        backup_count: Optional[str] = None,
        backup_minimum_enforced_retention_duration: Optional[str] = None,
        backup_vault_id: Optional[str] = None,
        create_time: Optional[str] = None,
        deletable: Optional[bool] = None,
        description: Optional[str] = None,
        effective_annotations: Optional[Mapping[str, str]] = None,
        effective_labels: Optional[Mapping[str, str]] = None,
        effective_time: Optional[str] = None,
        etag: Optional[str] = None,
        force_delete: Optional[bool] = None,
        force_update: Optional[bool] = None,
        labels: Optional[Mapping[str, str]] = None,
        location: Optional[str] = None,
        name: Optional[str] = None,
        project: Optional[str] = None,
        pulumi_labels: Optional[Mapping[str, str]] = None,
        service_account: Optional[str] = None,
        state: Optional[str] = None,
        total_stored_bytes: Optional[str] = None,
        uid: Optional[str] = None,
        update_time: Optional[str] = None) -> BackupVault
    func GetBackupVault(ctx *Context, name string, id IDInput, state *BackupVaultState, opts ...ResourceOption) (*BackupVault, error)
    public static BackupVault Get(string name, Input<string> id, BackupVaultState? state, CustomResourceOptions? opts = null)
    public static BackupVault get(String name, Output<String> id, BackupVaultState state, CustomResourceOptions options)
    Resource lookup is not supported in YAML
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    resource_name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    The following state arguments are supported:
    AllowMissing bool
    Allow idempotent deletion of backup vault. The request will still succeed in case the backup vault does not exist.
    Annotations Dictionary<string, string>
    Optional. User annotations. See https://google.aip.dev/128#annotations Stores small amounts of arbitrary data. Note: This field is non-authoritative, and will only manage the annotations present in your configuration. Please refer to the field effective_annotations for all of the annotations present on the resource.
    BackupCount string
    Output only. The number of backups in this backup vault.
    BackupMinimumEnforcedRetentionDuration string
    Required. The default and minimum enforced retention for each backup within the backup vault. The enforced retention for each backup can be extended.
    BackupVaultId string
    Required. ID of the requesting object.

    CreateTime string
    Output only. The time when the instance was created.
    Deletable bool
    Output only. Set to true when there are no backups nested under this resource.
    Description string
    Optional. The description of the BackupVault instance (2048 characters or less).
    EffectiveAnnotations Dictionary<string, string>
    EffectiveLabels Dictionary<string, string>
    All of labels (key/value pairs) present on the resource in GCP, including the labels configured through Pulumi, other clients and services.
    EffectiveTime string
    Optional. Time after which the BackupVault resource is locked.
    Etag string
    Optional. Server specified ETag for the backup vault resource to prevent simultaneous updates from overwiting each other.
    ForceDelete bool
    If set, the following restrictions against deletion of the backup vault instance can be overridden:

    • deletion of a backup vault instance containing no backups, but still containing empty datasources.
    • deletion of a backup vault instance that is being referenced by an active backup plan.
    ForceUpdate bool
    If set, allow update to extend the minimum enforced retention for backup vault. This overrides the restriction against conflicting retention periods. This conflict may occur when the expiration schedule defined by the associated backup plan is shorter than the minimum retention set by the backup vault.
    Labels Dictionary<string, string>
    Optional. Resource labels to represent user provided metadata. Note: This field is non-authoritative, and will only manage the labels present in your configuration. Please refer to the field effective_labels for all of the labels present on the resource.
    Location string
    The GCP location for the backup vault.
    Name string
    Output only. Identifier. The resource name.
    Project string
    The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
    PulumiLabels Dictionary<string, string>
    The combination of labels configured directly on the resource and default labels configured on the provider.
    ServiceAccount string
    Output only. Service account used by the BackupVault Service for this BackupVault. The user should grant this account permissions in their workload project to enable the service to run backups and restores there.
    State string
    Output only. The BackupVault resource instance state. Possible values: STATE_UNSPECIFIED CREATING ACTIVE DELETING ERROR
    TotalStoredBytes string
    Output only. Total size of the storage used by all backup resources.
    Uid string
    Output only. Output only Immutable after resource creation until resource deletion.
    UpdateTime string
    Output only. The time when the instance was updated.
    AllowMissing bool
    Allow idempotent deletion of backup vault. The request will still succeed in case the backup vault does not exist.
    Annotations map[string]string
    Optional. User annotations. See https://google.aip.dev/128#annotations Stores small amounts of arbitrary data. Note: This field is non-authoritative, and will only manage the annotations present in your configuration. Please refer to the field effective_annotations for all of the annotations present on the resource.
    BackupCount string
    Output only. The number of backups in this backup vault.
    BackupMinimumEnforcedRetentionDuration string
    Required. The default and minimum enforced retention for each backup within the backup vault. The enforced retention for each backup can be extended.
    BackupVaultId string
    Required. ID of the requesting object.

    CreateTime string
    Output only. The time when the instance was created.
    Deletable bool
    Output only. Set to true when there are no backups nested under this resource.
    Description string
    Optional. The description of the BackupVault instance (2048 characters or less).
    EffectiveAnnotations map[string]string
    EffectiveLabels 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.
    EffectiveTime string
    Optional. Time after which the BackupVault resource is locked.
    Etag string
    Optional. Server specified ETag for the backup vault resource to prevent simultaneous updates from overwiting each other.
    ForceDelete bool
    If set, the following restrictions against deletion of the backup vault instance can be overridden:

    • deletion of a backup vault instance containing no backups, but still containing empty datasources.
    • deletion of a backup vault instance that is being referenced by an active backup plan.
    ForceUpdate bool
    If set, allow update to extend the minimum enforced retention for backup vault. This overrides the restriction against conflicting retention periods. This conflict may occur when the expiration schedule defined by the associated backup plan is shorter than the minimum retention set by the backup vault.
    Labels map[string]string
    Optional. Resource labels to represent user provided metadata. Note: This field is non-authoritative, and will only manage the labels present in your configuration. Please refer to the field effective_labels for all of the labels present on the resource.
    Location string
    The GCP location for the backup vault.
    Name string
    Output only. Identifier. The resource name.
    Project string
    The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
    PulumiLabels map[string]string
    The combination of labels configured directly on the resource and default labels configured on the provider.
    ServiceAccount string
    Output only. Service account used by the BackupVault Service for this BackupVault. The user should grant this account permissions in their workload project to enable the service to run backups and restores there.
    State string
    Output only. The BackupVault resource instance state. Possible values: STATE_UNSPECIFIED CREATING ACTIVE DELETING ERROR
    TotalStoredBytes string
    Output only. Total size of the storage used by all backup resources.
    Uid string
    Output only. Output only Immutable after resource creation until resource deletion.
    UpdateTime string
    Output only. The time when the instance was updated.
    allowMissing Boolean
    Allow idempotent deletion of backup vault. The request will still succeed in case the backup vault does not exist.
    annotations Map<String,String>
    Optional. User annotations. See https://google.aip.dev/128#annotations Stores small amounts of arbitrary data. Note: This field is non-authoritative, and will only manage the annotations present in your configuration. Please refer to the field effective_annotations for all of the annotations present on the resource.
    backupCount String
    Output only. The number of backups in this backup vault.
    backupMinimumEnforcedRetentionDuration String
    Required. The default and minimum enforced retention for each backup within the backup vault. The enforced retention for each backup can be extended.
    backupVaultId String
    Required. ID of the requesting object.

    createTime String
    Output only. The time when the instance was created.
    deletable Boolean
    Output only. Set to true when there are no backups nested under this resource.
    description String
    Optional. The description of the BackupVault instance (2048 characters or less).
    effectiveAnnotations Map<String,String>
    effectiveLabels 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.
    effectiveTime String
    Optional. Time after which the BackupVault resource is locked.
    etag String
    Optional. Server specified ETag for the backup vault resource to prevent simultaneous updates from overwiting each other.
    forceDelete Boolean
    If set, the following restrictions against deletion of the backup vault instance can be overridden:

    • deletion of a backup vault instance containing no backups, but still containing empty datasources.
    • deletion of a backup vault instance that is being referenced by an active backup plan.
    forceUpdate Boolean
    If set, allow update to extend the minimum enforced retention for backup vault. This overrides the restriction against conflicting retention periods. This conflict may occur when the expiration schedule defined by the associated backup plan is shorter than the minimum retention set by the backup vault.
    labels Map<String,String>
    Optional. Resource labels to represent user provided metadata. Note: This field is non-authoritative, and will only manage the labels present in your configuration. Please refer to the field effective_labels for all of the labels present on the resource.
    location String
    The GCP location for the backup vault.
    name String
    Output only. Identifier. The resource name.
    project String
    The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
    pulumiLabels Map<String,String>
    The combination of labels configured directly on the resource and default labels configured on the provider.
    serviceAccount String
    Output only. Service account used by the BackupVault Service for this BackupVault. The user should grant this account permissions in their workload project to enable the service to run backups and restores there.
    state String
    Output only. The BackupVault resource instance state. Possible values: STATE_UNSPECIFIED CREATING ACTIVE DELETING ERROR
    totalStoredBytes String
    Output only. Total size of the storage used by all backup resources.
    uid String
    Output only. Output only Immutable after resource creation until resource deletion.
    updateTime String
    Output only. The time when the instance was updated.
    allowMissing boolean
    Allow idempotent deletion of backup vault. The request will still succeed in case the backup vault does not exist.
    annotations {[key: string]: string}
    Optional. User annotations. See https://google.aip.dev/128#annotations Stores small amounts of arbitrary data. Note: This field is non-authoritative, and will only manage the annotations present in your configuration. Please refer to the field effective_annotations for all of the annotations present on the resource.
    backupCount string
    Output only. The number of backups in this backup vault.
    backupMinimumEnforcedRetentionDuration string
    Required. The default and minimum enforced retention for each backup within the backup vault. The enforced retention for each backup can be extended.
    backupVaultId string
    Required. ID of the requesting object.

    createTime string
    Output only. The time when the instance was created.
    deletable boolean
    Output only. Set to true when there are no backups nested under this resource.
    description string
    Optional. The description of the BackupVault instance (2048 characters or less).
    effectiveAnnotations {[key: string]: string}
    effectiveLabels {[key: string]: string}
    All of labels (key/value pairs) present on the resource in GCP, including the labels configured through Pulumi, other clients and services.
    effectiveTime string
    Optional. Time after which the BackupVault resource is locked.
    etag string
    Optional. Server specified ETag for the backup vault resource to prevent simultaneous updates from overwiting each other.
    forceDelete boolean
    If set, the following restrictions against deletion of the backup vault instance can be overridden:

    • deletion of a backup vault instance containing no backups, but still containing empty datasources.
    • deletion of a backup vault instance that is being referenced by an active backup plan.
    forceUpdate boolean
    If set, allow update to extend the minimum enforced retention for backup vault. This overrides the restriction against conflicting retention periods. This conflict may occur when the expiration schedule defined by the associated backup plan is shorter than the minimum retention set by the backup vault.
    labels {[key: string]: string}
    Optional. Resource labels to represent user provided metadata. Note: This field is non-authoritative, and will only manage the labels present in your configuration. Please refer to the field effective_labels for all of the labels present on the resource.
    location string
    The GCP location for the backup vault.
    name string
    Output only. Identifier. The resource name.
    project string
    The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
    pulumiLabels {[key: string]: string}
    The combination of labels configured directly on the resource and default labels configured on the provider.
    serviceAccount string
    Output only. Service account used by the BackupVault Service for this BackupVault. The user should grant this account permissions in their workload project to enable the service to run backups and restores there.
    state string
    Output only. The BackupVault resource instance state. Possible values: STATE_UNSPECIFIED CREATING ACTIVE DELETING ERROR
    totalStoredBytes string
    Output only. Total size of the storage used by all backup resources.
    uid string
    Output only. Output only Immutable after resource creation until resource deletion.
    updateTime string
    Output only. The time when the instance was updated.
    allow_missing bool
    Allow idempotent deletion of backup vault. The request will still succeed in case the backup vault does not exist.
    annotations Mapping[str, str]
    Optional. User annotations. See https://google.aip.dev/128#annotations Stores small amounts of arbitrary data. Note: This field is non-authoritative, and will only manage the annotations present in your configuration. Please refer to the field effective_annotations for all of the annotations present on the resource.
    backup_count str
    Output only. The number of backups in this backup vault.
    backup_minimum_enforced_retention_duration str
    Required. The default and minimum enforced retention for each backup within the backup vault. The enforced retention for each backup can be extended.
    backup_vault_id str
    Required. ID of the requesting object.

    create_time str
    Output only. The time when the instance was created.
    deletable bool
    Output only. Set to true when there are no backups nested under this resource.
    description str
    Optional. The description of the BackupVault instance (2048 characters or less).
    effective_annotations Mapping[str, str]
    effective_labels Mapping[str, str]
    All of labels (key/value pairs) present on the resource in GCP, including the labels configured through Pulumi, other clients and services.
    effective_time str
    Optional. Time after which the BackupVault resource is locked.
    etag str
    Optional. Server specified ETag for the backup vault resource to prevent simultaneous updates from overwiting each other.
    force_delete bool
    If set, the following restrictions against deletion of the backup vault instance can be overridden:

    • deletion of a backup vault instance containing no backups, but still containing empty datasources.
    • deletion of a backup vault instance that is being referenced by an active backup plan.
    force_update bool
    If set, allow update to extend the minimum enforced retention for backup vault. This overrides the restriction against conflicting retention periods. This conflict may occur when the expiration schedule defined by the associated backup plan is shorter than the minimum retention set by the backup vault.
    labels Mapping[str, str]
    Optional. Resource labels to represent user provided metadata. Note: This field is non-authoritative, and will only manage the labels present in your configuration. Please refer to the field effective_labels for all of the labels present on the resource.
    location str
    The GCP location for the backup vault.
    name str
    Output only. Identifier. The resource name.
    project str
    The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
    pulumi_labels Mapping[str, str]
    The combination of labels configured directly on the resource and default labels configured on the provider.
    service_account str
    Output only. Service account used by the BackupVault Service for this BackupVault. The user should grant this account permissions in their workload project to enable the service to run backups and restores there.
    state str
    Output only. The BackupVault resource instance state. Possible values: STATE_UNSPECIFIED CREATING ACTIVE DELETING ERROR
    total_stored_bytes str
    Output only. Total size of the storage used by all backup resources.
    uid str
    Output only. Output only Immutable after resource creation until resource deletion.
    update_time str
    Output only. The time when the instance was updated.
    allowMissing Boolean
    Allow idempotent deletion of backup vault. The request will still succeed in case the backup vault does not exist.
    annotations Map<String>
    Optional. User annotations. See https://google.aip.dev/128#annotations Stores small amounts of arbitrary data. Note: This field is non-authoritative, and will only manage the annotations present in your configuration. Please refer to the field effective_annotations for all of the annotations present on the resource.
    backupCount String
    Output only. The number of backups in this backup vault.
    backupMinimumEnforcedRetentionDuration String
    Required. The default and minimum enforced retention for each backup within the backup vault. The enforced retention for each backup can be extended.
    backupVaultId String
    Required. ID of the requesting object.

    createTime String
    Output only. The time when the instance was created.
    deletable Boolean
    Output only. Set to true when there are no backups nested under this resource.
    description String
    Optional. The description of the BackupVault instance (2048 characters or less).
    effectiveAnnotations Map<String>
    effectiveLabels Map<String>
    All of labels (key/value pairs) present on the resource in GCP, including the labels configured through Pulumi, other clients and services.
    effectiveTime String
    Optional. Time after which the BackupVault resource is locked.
    etag String
    Optional. Server specified ETag for the backup vault resource to prevent simultaneous updates from overwiting each other.
    forceDelete Boolean
    If set, the following restrictions against deletion of the backup vault instance can be overridden:

    • deletion of a backup vault instance containing no backups, but still containing empty datasources.
    • deletion of a backup vault instance that is being referenced by an active backup plan.
    forceUpdate Boolean
    If set, allow update to extend the minimum enforced retention for backup vault. This overrides the restriction against conflicting retention periods. This conflict may occur when the expiration schedule defined by the associated backup plan is shorter than the minimum retention set by the backup vault.
    labels Map<String>
    Optional. Resource labels to represent user provided metadata. Note: This field is non-authoritative, and will only manage the labels present in your configuration. Please refer to the field effective_labels for all of the labels present on the resource.
    location String
    The GCP location for the backup vault.
    name String
    Output only. Identifier. The resource name.
    project String
    The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
    pulumiLabels Map<String>
    The combination of labels configured directly on the resource and default labels configured on the provider.
    serviceAccount String
    Output only. Service account used by the BackupVault Service for this BackupVault. The user should grant this account permissions in their workload project to enable the service to run backups and restores there.
    state String
    Output only. The BackupVault resource instance state. Possible values: STATE_UNSPECIFIED CREATING ACTIVE DELETING ERROR
    totalStoredBytes String
    Output only. Total size of the storage used by all backup resources.
    uid String
    Output only. Output only Immutable after resource creation until resource deletion.
    updateTime String
    Output only. The time when the instance was updated.

    Import

    BackupVault can be imported using any of these accepted formats:

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

    • {{project}}/{{location}}/{{backup_vault_id}}

    • {{location}}/{{backup_vault_id}}

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

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

    $ pulumi import gcp:backupdisasterrecovery/backupVault:BackupVault default {{project}}/{{location}}/{{backup_vault_id}}

    $ pulumi import gcp:backupdisasterrecovery/backupVault:BackupVault default {{location}}/{{backup_vault_id}}

    To learn more about importing existing cloud resources, see Importing resources.

    Package Details

    Repository
    Google Cloud (GCP) Classic pulumi/pulumi-gcp
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the google-beta Terraform Provider.
    gcp logo
    Google Cloud Classic v8.3.1 published on Wednesday, Sep 25, 2024 by Pulumi
    pulumi/pulumi-gcp