1. Packages
  2. Google Cloud (GCP) Classic
  3. API Docs
  4. netapp
  5. BackupVault
Google Cloud Classic v7.20.0 published on Wednesday, Apr 24, 2024 by Pulumi

gcp.netapp.BackupVault

Explore with Pulumi AI

gcp logo
Google Cloud Classic v7.20.0 published on Wednesday, Apr 24, 2024 by Pulumi

    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:

    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-central1",
        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-central1",
        description="Terraform created vault",
        labels={
            "creator": "testuser",
        })
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-gcp/sdk/v7/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-central1"),
    			Description: pulumi.String("Terraform created vault"),
    			Labels: pulumi.StringMap{
    				"creator": pulumi.String("testuser"),
    			},
    		})
    		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 testBackupVault = new Gcp.Netapp.BackupVault("test_backup_vault", new()
        {
            Name = "test-backup-vault",
            Location = "us-central1",
            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.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 testBackupVault = new BackupVault("testBackupVault", BackupVaultArgs.builder()        
                .name("test-backup-vault")
                .location("us-central1")
                .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-central1
          description: Terraform created vault
          labels:
            creator: testuser
    

    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,
                    location: Optional[str] = None,
                    description: Optional[str] = None,
                    labels: Optional[Mapping[str, str]] = None,
                    name: Optional[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:netapp: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.

    Example

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

    var backupVaultResource = new Gcp.Netapp.BackupVault("backupVaultResource", new()
    {
        Location = "string",
        Description = "string",
        Labels = 
        {
            { "string", "string" },
        },
        Name = "string",
        Project = "string",
    });
    
    example, err := netapp.NewBackupVault(ctx, "backupVaultResource", &netapp.BackupVaultArgs{
    	Location:    pulumi.String("string"),
    	Description: pulumi.String("string"),
    	Labels: pulumi.StringMap{
    		"string": pulumi.String("string"),
    	},
    	Name:    pulumi.String("string"),
    	Project: pulumi.String("string"),
    })
    
    var backupVaultResource = new BackupVault("backupVaultResource", BackupVaultArgs.builder()        
        .location("string")
        .description("string")
        .labels(Map.of("string", "string"))
        .name("string")
        .project("string")
        .build());
    
    backup_vault_resource = gcp.netapp.BackupVault("backupVaultResource",
        location="string",
        description="string",
        labels={
            "string": "string",
        },
        name="string",
        project="string")
    
    const backupVaultResource = new gcp.netapp.BackupVault("backupVaultResource", {
        location: "string",
        description: "string",
        labels: {
            string: "string",
        },
        name: "string",
        project: "string",
    });
    
    type: gcp:netapp:BackupVault
    properties:
        description: string
        labels:
            string: string
        location: string
        name: 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:

    Location string
    Location (region) of the backup vault.
    Description string
    An optional description of this resource.
    Labels Dictionary<string, string>

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

    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.

    Name string
    The resource name of the backup vault. Needs to be unique per location.


    Project string
    The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
    Location string
    Location (region) of the backup vault.
    Description string
    An optional description of this resource.
    Labels map[string]string

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

    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.

    Name string
    The resource name of the backup vault. Needs to be unique per location.


    Project string
    The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
    location String
    Location (region) of the backup vault.
    description String
    An optional description of this resource.
    labels Map<String,String>

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

    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.

    name String
    The resource name of the backup vault. Needs to be unique per location.


    project String
    The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
    location string
    Location (region) of the backup vault.
    description string
    An optional description of this resource.
    labels {[key: string]: string}

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

    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.

    name string
    The resource name of the backup vault. Needs to be unique per location.


    project string
    The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
    location str
    Location (region) of the backup vault.
    description str
    An optional description of this resource.
    labels Mapping[str, str]

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

    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.

    name str
    The resource name of the backup vault. Needs to be unique per location.


    project str
    The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
    location String
    Location (region) of the backup vault.
    description String
    An optional description of this resource.
    labels Map<String>

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

    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.

    name String
    The resource name of the backup vault. Needs to be unique per location.


    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:

    CreateTime string
    Create time of the backup vault. A timestamp in RFC3339 UTC "Zulu" format. Examples: "2023-06-22T09:13:01.617Z".
    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.
    Id string
    The provider-assigned unique ID for this managed resource.
    PulumiLabels Dictionary<string, string>
    The combination of labels configured directly on the resource and default labels configured on the provider.
    State string
    The state of the Backup Vault.
    CreateTime string
    Create time of the backup vault. A timestamp in RFC3339 UTC "Zulu" format. Examples: "2023-06-22T09:13:01.617Z".
    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.
    Id string
    The provider-assigned unique ID for this managed resource.
    PulumiLabels map[string]string
    The combination of labels configured directly on the resource and default labels configured on the provider.
    State string
    The state of the Backup Vault.
    createTime String
    Create time of the backup vault. A timestamp in RFC3339 UTC "Zulu" format. Examples: "2023-06-22T09:13:01.617Z".
    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.
    id String
    The provider-assigned unique ID for this managed resource.
    pulumiLabels Map<String,String>
    The combination of labels configured directly on the resource and default labels configured on the provider.
    state String
    The state of the Backup Vault.
    createTime string
    Create time of the backup vault. A timestamp in RFC3339 UTC "Zulu" format. Examples: "2023-06-22T09:13:01.617Z".
    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.
    id string
    The provider-assigned unique ID for this managed resource.
    pulumiLabels {[key: string]: string}
    The combination of labels configured directly on the resource and default labels configured on the provider.
    state string
    The state of the Backup Vault.
    create_time str
    Create time of the backup vault. A timestamp in RFC3339 UTC "Zulu" format. Examples: "2023-06-22T09:13:01.617Z".
    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.
    id str
    The provider-assigned unique ID for this managed resource.
    pulumi_labels Mapping[str, str]
    The combination of labels configured directly on the resource and default labels configured on the provider.
    state str
    The state of the Backup Vault.
    createTime String
    Create time of the backup vault. A timestamp in RFC3339 UTC "Zulu" format. Examples: "2023-06-22T09:13:01.617Z".
    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.
    id String
    The provider-assigned unique ID for this managed resource.
    pulumiLabels Map<String>
    The combination of labels configured directly on the resource and default labels configured on the provider.
    state String
    The state of the Backup Vault.

    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,
            create_time: Optional[str] = None,
            description: Optional[str] = None,
            effective_labels: Optional[Mapping[str, str]] = 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,
            state: 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:
    CreateTime string
    Create time of the backup vault. A timestamp in RFC3339 UTC "Zulu" format. Examples: "2023-06-22T09:13:01.617Z".
    Description string
    An optional description of this resource.
    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.
    Labels Dictionary<string, string>

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

    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
    Location (region) of the backup vault.
    Name string
    The resource name of the backup vault. Needs to be unique per location.


    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.
    State string
    The state of the Backup Vault.
    CreateTime string
    Create time of the backup vault. A timestamp in RFC3339 UTC "Zulu" format. Examples: "2023-06-22T09:13:01.617Z".
    Description string
    An optional description of this resource.
    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.
    Labels map[string]string

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

    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
    Location (region) of the backup vault.
    Name string
    The resource name of the backup vault. Needs to be unique per location.


    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.
    State string
    The state of the Backup Vault.
    createTime String
    Create time of the backup vault. A timestamp in RFC3339 UTC "Zulu" format. Examples: "2023-06-22T09:13:01.617Z".
    description String
    An optional description of this resource.
    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.
    labels Map<String,String>

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

    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
    Location (region) of the backup vault.
    name String
    The resource name of the backup vault. Needs to be unique per location.


    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.
    state String
    The state of the Backup Vault.
    createTime string
    Create time of the backup vault. A timestamp in RFC3339 UTC "Zulu" format. Examples: "2023-06-22T09:13:01.617Z".
    description string
    An optional description of this resource.
    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.
    labels {[key: string]: string}

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

    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
    Location (region) of the backup vault.
    name string
    The resource name of the backup vault. Needs to be unique per location.


    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.
    state string
    The state of the Backup Vault.
    create_time str
    Create time of the backup vault. A timestamp in RFC3339 UTC "Zulu" format. Examples: "2023-06-22T09:13:01.617Z".
    description str
    An optional description of this resource.
    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.
    labels Mapping[str, str]

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

    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
    Location (region) of the backup vault.
    name str
    The resource name of the backup vault. Needs to be unique per location.


    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.
    state str
    The state of the Backup Vault.
    createTime String
    Create time of the backup vault. A timestamp in RFC3339 UTC "Zulu" format. Examples: "2023-06-22T09:13:01.617Z".
    description String
    An optional description of this resource.
    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.
    labels Map<String>

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

    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
    Location (region) of the backup vault.
    name String
    The resource name of the backup vault. Needs to be unique per location.


    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.
    state String
    The state of the Backup Vault.

    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}}
    

    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 v7.20.0 published on Wednesday, Apr 24, 2024 by Pulumi