1. Packages
  2. Google Cloud (GCP) Classic
  3. API Docs
  4. netapp
  5. Backup
Google Cloud Classic v7.30.2 published on Wednesday, Jul 10, 2024 by Pulumi

gcp.netapp.Backup

Explore with Pulumi AI

gcp logo
Google Cloud Classic v7.30.2 published on Wednesday, Jul 10, 2024 by Pulumi

    NetApp Volumes supports volume backups, which are copies of your volumes stored independently from the volume. Backups are stored in backup vaults, which are containers for backups. If a volume is lost or deleted, you can use backups to restore your data to a new volume.

    When you create the first backup of a volume, all of the volume’s used data is sent to the backup vault. Subsequent backups of the same volume only include data that has changed from the previous backup. This allows for fast incremental-forever backups and reduces the required capacity inside the backup vault.

    You can create manual and scheduled backups. Manual backups can be taken from a volume or from an existing volume snapshot. Scheduled backups require a backup policy.

    To get more information about backup, see:

    Example Usage

    Netapp Backup

    import * as pulumi from "@pulumi/pulumi";
    import * as gcp from "@pulumi/gcp";
    
    const default = gcp.compute.getNetwork({
        name: "",
    });
    const defaultStoragePool = new gcp.netapp.StoragePool("default", {
        name: "backup-pool",
        location: "us-central1",
        serviceLevel: "PREMIUM",
        capacityGib: "2048",
        network: _default.then(_default => _default.id),
    });
    const defaultBackupVault = new gcp.netapp.BackupVault("default", {
        name: "backup-vault",
        location: defaultStoragePool.location,
    });
    const defaultVolume = new gcp.netapp.Volume("default", {
        name: "backup-volume",
        location: defaultStoragePool.location,
        capacityGib: "100",
        shareName: "backup-volume",
        storagePool: defaultStoragePool.name,
        protocols: ["NFSV3"],
        deletionPolicy: "FORCE",
        backupConfig: {
            backupVault: defaultBackupVault.id,
        },
    });
    const testBackup = new gcp.netapp.Backup("test_backup", {
        name: "test-backup",
        location: defaultBackupVault.location,
        vaultName: defaultBackupVault.name,
        sourceVolume: defaultVolume.id,
    });
    
    import pulumi
    import pulumi_gcp as gcp
    
    default = gcp.compute.get_network(name="")
    default_storage_pool = gcp.netapp.StoragePool("default",
        name="backup-pool",
        location="us-central1",
        service_level="PREMIUM",
        capacity_gib="2048",
        network=default.id)
    default_backup_vault = gcp.netapp.BackupVault("default",
        name="backup-vault",
        location=default_storage_pool.location)
    default_volume = gcp.netapp.Volume("default",
        name="backup-volume",
        location=default_storage_pool.location,
        capacity_gib="100",
        share_name="backup-volume",
        storage_pool=default_storage_pool.name,
        protocols=["NFSV3"],
        deletion_policy="FORCE",
        backup_config={
            "backupVault": default_backup_vault.id,
        })
    test_backup = gcp.netapp.Backup("test_backup",
        name="test-backup",
        location=default_backup_vault.location,
        vault_name=default_backup_vault.name,
        source_volume=default_volume.id)
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-gcp/sdk/v7/go/gcp/compute"
    	"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 {
    		_default, err := compute.LookupNetwork(ctx, &compute.LookupNetworkArgs{
    			Name: "",
    		}, nil)
    		if err != nil {
    			return err
    		}
    		defaultStoragePool, err := netapp.NewStoragePool(ctx, "default", &netapp.StoragePoolArgs{
    			Name:         pulumi.String("backup-pool"),
    			Location:     pulumi.String("us-central1"),
    			ServiceLevel: pulumi.String("PREMIUM"),
    			CapacityGib:  pulumi.String("2048"),
    			Network:      pulumi.String(_default.Id),
    		})
    		if err != nil {
    			return err
    		}
    		defaultBackupVault, err := netapp.NewBackupVault(ctx, "default", &netapp.BackupVaultArgs{
    			Name:     pulumi.String("backup-vault"),
    			Location: defaultStoragePool.Location,
    		})
    		if err != nil {
    			return err
    		}
    		defaultVolume, err := netapp.NewVolume(ctx, "default", &netapp.VolumeArgs{
    			Name:        pulumi.String("backup-volume"),
    			Location:    defaultStoragePool.Location,
    			CapacityGib: pulumi.String("100"),
    			ShareName:   pulumi.String("backup-volume"),
    			StoragePool: defaultStoragePool.Name,
    			Protocols: pulumi.StringArray{
    				pulumi.String("NFSV3"),
    			},
    			DeletionPolicy: pulumi.String("FORCE"),
    			BackupConfig: &netapp.VolumeBackupConfigArgs{
    				BackupVault: defaultBackupVault.ID(),
    			},
    		})
    		if err != nil {
    			return err
    		}
    		_, err = netapp.NewBackup(ctx, "test_backup", &netapp.BackupArgs{
    			Name:         pulumi.String("test-backup"),
    			Location:     defaultBackupVault.Location,
    			VaultName:    defaultBackupVault.Name,
    			SourceVolume: defaultVolume.ID(),
    		})
    		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 @default = Gcp.Compute.GetNetwork.Invoke(new()
        {
            Name = "",
        });
    
        var defaultStoragePool = new Gcp.Netapp.StoragePool("default", new()
        {
            Name = "backup-pool",
            Location = "us-central1",
            ServiceLevel = "PREMIUM",
            CapacityGib = "2048",
            Network = @default.Apply(@default => @default.Apply(getNetworkResult => getNetworkResult.Id)),
        });
    
        var defaultBackupVault = new Gcp.Netapp.BackupVault("default", new()
        {
            Name = "backup-vault",
            Location = defaultStoragePool.Location,
        });
    
        var defaultVolume = new Gcp.Netapp.Volume("default", new()
        {
            Name = "backup-volume",
            Location = defaultStoragePool.Location,
            CapacityGib = "100",
            ShareName = "backup-volume",
            StoragePool = defaultStoragePool.Name,
            Protocols = new[]
            {
                "NFSV3",
            },
            DeletionPolicy = "FORCE",
            BackupConfig = new Gcp.Netapp.Inputs.VolumeBackupConfigArgs
            {
                BackupVault = defaultBackupVault.Id,
            },
        });
    
        var testBackup = new Gcp.Netapp.Backup("test_backup", new()
        {
            Name = "test-backup",
            Location = defaultBackupVault.Location,
            VaultName = defaultBackupVault.Name,
            SourceVolume = defaultVolume.Id,
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.gcp.compute.ComputeFunctions;
    import com.pulumi.gcp.compute.inputs.GetNetworkArgs;
    import com.pulumi.gcp.netapp.StoragePool;
    import com.pulumi.gcp.netapp.StoragePoolArgs;
    import com.pulumi.gcp.netapp.BackupVault;
    import com.pulumi.gcp.netapp.BackupVaultArgs;
    import com.pulumi.gcp.netapp.Volume;
    import com.pulumi.gcp.netapp.VolumeArgs;
    import com.pulumi.gcp.netapp.inputs.VolumeBackupConfigArgs;
    import com.pulumi.gcp.netapp.Backup;
    import com.pulumi.gcp.netapp.BackupArgs;
    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) {
            final var default = ComputeFunctions.getNetwork(GetNetworkArgs.builder()
                .name("")
                .build());
    
            var defaultStoragePool = new StoragePool("defaultStoragePool", StoragePoolArgs.builder()
                .name("backup-pool")
                .location("us-central1")
                .serviceLevel("PREMIUM")
                .capacityGib("2048")
                .network(default_.id())
                .build());
    
            var defaultBackupVault = new BackupVault("defaultBackupVault", BackupVaultArgs.builder()
                .name("backup-vault")
                .location(defaultStoragePool.location())
                .build());
    
            var defaultVolume = new Volume("defaultVolume", VolumeArgs.builder()
                .name("backup-volume")
                .location(defaultStoragePool.location())
                .capacityGib("100")
                .shareName("backup-volume")
                .storagePool(defaultStoragePool.name())
                .protocols("NFSV3")
                .deletionPolicy("FORCE")
                .backupConfig(VolumeBackupConfigArgs.builder()
                    .backupVault(defaultBackupVault.id())
                    .build())
                .build());
    
            var testBackup = new Backup("testBackup", BackupArgs.builder()
                .name("test-backup")
                .location(defaultBackupVault.location())
                .vaultName(defaultBackupVault.name())
                .sourceVolume(defaultVolume.id())
                .build());
    
        }
    }
    
    resources:
      defaultStoragePool:
        type: gcp:netapp:StoragePool
        name: default
        properties:
          name: backup-pool
          location: us-central1
          serviceLevel: PREMIUM
          capacityGib: '2048'
          network: ${default.id}
      defaultVolume:
        type: gcp:netapp:Volume
        name: default
        properties:
          name: backup-volume
          location: ${defaultStoragePool.location}
          capacityGib: '100'
          shareName: backup-volume
          storagePool: ${defaultStoragePool.name}
          protocols:
            - NFSV3
          deletionPolicy: FORCE
          backupConfig:
            backupVault: ${defaultBackupVault.id}
      defaultBackupVault:
        type: gcp:netapp:BackupVault
        name: default
        properties:
          name: backup-vault
          location: ${defaultStoragePool.location}
      testBackup:
        type: gcp:netapp:Backup
        name: test_backup
        properties:
          name: test-backup
          location: ${defaultBackupVault.location}
          vaultName: ${defaultBackupVault.name}
          sourceVolume: ${defaultVolume.id}
    variables:
      default:
        fn::invoke:
          Function: gcp:compute:getNetwork
          Arguments:
            name:
    

    Create Backup Resource

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

    Constructor syntax

    new Backup(name: string, args: BackupArgs, opts?: CustomResourceOptions);
    @overload
    def Backup(resource_name: str,
               args: BackupArgs,
               opts: Optional[ResourceOptions] = None)
    
    @overload
    def Backup(resource_name: str,
               opts: Optional[ResourceOptions] = None,
               location: Optional[str] = None,
               vault_name: Optional[str] = None,
               description: Optional[str] = None,
               labels: Optional[Mapping[str, str]] = None,
               name: Optional[str] = None,
               project: Optional[str] = None,
               source_snapshot: Optional[str] = None,
               source_volume: Optional[str] = None)
    func NewBackup(ctx *Context, name string, args BackupArgs, opts ...ResourceOption) (*Backup, error)
    public Backup(string name, BackupArgs args, CustomResourceOptions? opts = null)
    public Backup(String name, BackupArgs args)
    public Backup(String name, BackupArgs args, CustomResourceOptions options)
    
    type: gcp:netapp:Backup
    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 BackupArgs
    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 BackupArgs
    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 BackupArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args BackupArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args BackupArgs
    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 examplebackupResourceResourceFromNetappbackup = new Gcp.Netapp.Backup("examplebackupResourceResourceFromNetappbackup", new()
    {
        Location = "string",
        VaultName = "string",
        Description = "string",
        Labels = 
        {
            { "string", "string" },
        },
        Name = "string",
        Project = "string",
        SourceSnapshot = "string",
        SourceVolume = "string",
    });
    
    example, err := netapp.NewBackup(ctx, "examplebackupResourceResourceFromNetappbackup", &netapp.BackupArgs{
    	Location:    pulumi.String("string"),
    	VaultName:   pulumi.String("string"),
    	Description: pulumi.String("string"),
    	Labels: pulumi.StringMap{
    		"string": pulumi.String("string"),
    	},
    	Name:           pulumi.String("string"),
    	Project:        pulumi.String("string"),
    	SourceSnapshot: pulumi.String("string"),
    	SourceVolume:   pulumi.String("string"),
    })
    
    var examplebackupResourceResourceFromNetappbackup = new Backup("examplebackupResourceResourceFromNetappbackup", BackupArgs.builder()
        .location("string")
        .vaultName("string")
        .description("string")
        .labels(Map.of("string", "string"))
        .name("string")
        .project("string")
        .sourceSnapshot("string")
        .sourceVolume("string")
        .build());
    
    examplebackup_resource_resource_from_netappbackup = gcp.netapp.Backup("examplebackupResourceResourceFromNetappbackup",
        location="string",
        vault_name="string",
        description="string",
        labels={
            "string": "string",
        },
        name="string",
        project="string",
        source_snapshot="string",
        source_volume="string")
    
    const examplebackupResourceResourceFromNetappbackup = new gcp.netapp.Backup("examplebackupResourceResourceFromNetappbackup", {
        location: "string",
        vaultName: "string",
        description: "string",
        labels: {
            string: "string",
        },
        name: "string",
        project: "string",
        sourceSnapshot: "string",
        sourceVolume: "string",
    });
    
    type: gcp:netapp:Backup
    properties:
        description: string
        labels:
            string: string
        location: string
        name: string
        project: string
        sourceSnapshot: string
        sourceVolume: string
        vaultName: string
    

    Backup 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 Backup resource accepts the following input properties:

    Location string
    Location of the backup.
    VaultName string
    Name of the backup vault to store the backup in.
    Description string
    A description of the backup with 2048 characters or less. Requests with longer descriptions will be rejected.
    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. 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.
    SourceSnapshot string
    If specified, backup will be created from the given snapshot. If not specified, there will be a new snapshot taken to initiate the backup creation. Format: `projects/{{projectId}}/locations/{{location}}/volumes/{{volumename}}/snapshots/{{snapshotname}}``
    SourceVolume string
    ID of volumes this backup belongs to. Format: `projects/{{projects_id}}/locations/{{location}}/volumes/{{name}}``
    Location string
    Location of the backup.
    VaultName string
    Name of the backup vault to store the backup in.
    Description string
    A description of the backup with 2048 characters or less. Requests with longer descriptions will be rejected.
    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. 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.
    SourceSnapshot string
    If specified, backup will be created from the given snapshot. If not specified, there will be a new snapshot taken to initiate the backup creation. Format: `projects/{{projectId}}/locations/{{location}}/volumes/{{volumename}}/snapshots/{{snapshotname}}``
    SourceVolume string
    ID of volumes this backup belongs to. Format: `projects/{{projects_id}}/locations/{{location}}/volumes/{{name}}``
    location String
    Location of the backup.
    vaultName String
    Name of the backup vault to store the backup in.
    description String
    A description of the backup with 2048 characters or less. Requests with longer descriptions will be rejected.
    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. 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.
    sourceSnapshot String
    If specified, backup will be created from the given snapshot. If not specified, there will be a new snapshot taken to initiate the backup creation. Format: `projects/{{projectId}}/locations/{{location}}/volumes/{{volumename}}/snapshots/{{snapshotname}}``
    sourceVolume String
    ID of volumes this backup belongs to. Format: `projects/{{projects_id}}/locations/{{location}}/volumes/{{name}}``
    location string
    Location of the backup.
    vaultName string
    Name of the backup vault to store the backup in.
    description string
    A description of the backup with 2048 characters or less. Requests with longer descriptions will be rejected.
    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. 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.
    sourceSnapshot string
    If specified, backup will be created from the given snapshot. If not specified, there will be a new snapshot taken to initiate the backup creation. Format: `projects/{{projectId}}/locations/{{location}}/volumes/{{volumename}}/snapshots/{{snapshotname}}``
    sourceVolume string
    ID of volumes this backup belongs to. Format: `projects/{{projects_id}}/locations/{{location}}/volumes/{{name}}``
    location str
    Location of the backup.
    vault_name str
    Name of the backup vault to store the backup in.
    description str
    A description of the backup with 2048 characters or less. Requests with longer descriptions will be rejected.
    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. 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.
    source_snapshot str
    If specified, backup will be created from the given snapshot. If not specified, there will be a new snapshot taken to initiate the backup creation. Format: `projects/{{projectId}}/locations/{{location}}/volumes/{{volumename}}/snapshots/{{snapshotname}}``
    source_volume str
    ID of volumes this backup belongs to. Format: `projects/{{projects_id}}/locations/{{location}}/volumes/{{name}}``
    location String
    Location of the backup.
    vaultName String
    Name of the backup vault to store the backup in.
    description String
    A description of the backup with 2048 characters or less. Requests with longer descriptions will be rejected.
    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. 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.
    sourceSnapshot String
    If specified, backup will be created from the given snapshot. If not specified, there will be a new snapshot taken to initiate the backup creation. Format: `projects/{{projectId}}/locations/{{location}}/volumes/{{volumename}}/snapshots/{{snapshotname}}``
    sourceVolume String
    ID of volumes this backup belongs to. Format: `projects/{{projects_id}}/locations/{{location}}/volumes/{{name}}``

    Outputs

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

    BackupType string
    Type of backup, manually created or created by a backup policy. Possible Values : [TYPE_UNSPECIFIED, MANUAL, SCHEDULED]
    ChainStorageBytes string
    Backups of a volume build incrementally on top of each other. They form a "backup chain". Total size of all backups in a chain in bytes = baseline backup size + sum(incremental backup size)
    CreateTime string
    Create time of the backup. 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. Possible Values : [STATE_UNSPECIFIED, CREATING, UPLOADING, READY, DELETING, ERROR, UPDATING]
    VolumeUsageBytes string
    Size of the file system when the backup was created. When creating a new volume from the backup, the volume capacity will have to be at least as big.
    BackupType string
    Type of backup, manually created or created by a backup policy. Possible Values : [TYPE_UNSPECIFIED, MANUAL, SCHEDULED]
    ChainStorageBytes string
    Backups of a volume build incrementally on top of each other. They form a "backup chain". Total size of all backups in a chain in bytes = baseline backup size + sum(incremental backup size)
    CreateTime string
    Create time of the backup. 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. Possible Values : [STATE_UNSPECIFIED, CREATING, UPLOADING, READY, DELETING, ERROR, UPDATING]
    VolumeUsageBytes string
    Size of the file system when the backup was created. When creating a new volume from the backup, the volume capacity will have to be at least as big.
    backupType String
    Type of backup, manually created or created by a backup policy. Possible Values : [TYPE_UNSPECIFIED, MANUAL, SCHEDULED]
    chainStorageBytes String
    Backups of a volume build incrementally on top of each other. They form a "backup chain". Total size of all backups in a chain in bytes = baseline backup size + sum(incremental backup size)
    createTime String
    Create time of the backup. 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. Possible Values : [STATE_UNSPECIFIED, CREATING, UPLOADING, READY, DELETING, ERROR, UPDATING]
    volumeUsageBytes String
    Size of the file system when the backup was created. When creating a new volume from the backup, the volume capacity will have to be at least as big.
    backupType string
    Type of backup, manually created or created by a backup policy. Possible Values : [TYPE_UNSPECIFIED, MANUAL, SCHEDULED]
    chainStorageBytes string
    Backups of a volume build incrementally on top of each other. They form a "backup chain". Total size of all backups in a chain in bytes = baseline backup size + sum(incremental backup size)
    createTime string
    Create time of the backup. 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. Possible Values : [STATE_UNSPECIFIED, CREATING, UPLOADING, READY, DELETING, ERROR, UPDATING]
    volumeUsageBytes string
    Size of the file system when the backup was created. When creating a new volume from the backup, the volume capacity will have to be at least as big.
    backup_type str
    Type of backup, manually created or created by a backup policy. Possible Values : [TYPE_UNSPECIFIED, MANUAL, SCHEDULED]
    chain_storage_bytes str
    Backups of a volume build incrementally on top of each other. They form a "backup chain". Total size of all backups in a chain in bytes = baseline backup size + sum(incremental backup size)
    create_time str
    Create time of the backup. 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. Possible Values : [STATE_UNSPECIFIED, CREATING, UPLOADING, READY, DELETING, ERROR, UPDATING]
    volume_usage_bytes str
    Size of the file system when the backup was created. When creating a new volume from the backup, the volume capacity will have to be at least as big.
    backupType String
    Type of backup, manually created or created by a backup policy. Possible Values : [TYPE_UNSPECIFIED, MANUAL, SCHEDULED]
    chainStorageBytes String
    Backups of a volume build incrementally on top of each other. They form a "backup chain". Total size of all backups in a chain in bytes = baseline backup size + sum(incremental backup size)
    createTime String
    Create time of the backup. 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. Possible Values : [STATE_UNSPECIFIED, CREATING, UPLOADING, READY, DELETING, ERROR, UPDATING]
    volumeUsageBytes String
    Size of the file system when the backup was created. When creating a new volume from the backup, the volume capacity will have to be at least as big.

    Look up Existing Backup Resource

    Get an existing Backup 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?: BackupState, opts?: CustomResourceOptions): Backup
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            backup_type: Optional[str] = None,
            chain_storage_bytes: Optional[str] = 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,
            source_snapshot: Optional[str] = None,
            source_volume: Optional[str] = None,
            state: Optional[str] = None,
            vault_name: Optional[str] = None,
            volume_usage_bytes: Optional[str] = None) -> Backup
    func GetBackup(ctx *Context, name string, id IDInput, state *BackupState, opts ...ResourceOption) (*Backup, error)
    public static Backup Get(string name, Input<string> id, BackupState? state, CustomResourceOptions? opts = null)
    public static Backup get(String name, Output<String> id, BackupState 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:
    BackupType string
    Type of backup, manually created or created by a backup policy. Possible Values : [TYPE_UNSPECIFIED, MANUAL, SCHEDULED]
    ChainStorageBytes string
    Backups of a volume build incrementally on top of each other. They form a "backup chain". Total size of all backups in a chain in bytes = baseline backup size + sum(incremental backup size)
    CreateTime string
    Create time of the backup. A timestamp in RFC3339 UTC "Zulu" format. Examples: "2023-06-22T09:13:01.617Z".
    Description string
    A description of the backup with 2048 characters or less. Requests with longer descriptions will be rejected.
    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 of the backup.
    Name string
    The resource name of the backup. 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.
    SourceSnapshot string
    If specified, backup will be created from the given snapshot. If not specified, there will be a new snapshot taken to initiate the backup creation. Format: `projects/{{projectId}}/locations/{{location}}/volumes/{{volumename}}/snapshots/{{snapshotname}}``
    SourceVolume string
    ID of volumes this backup belongs to. Format: `projects/{{projects_id}}/locations/{{location}}/volumes/{{name}}``
    State string
    The state of the Backup Vault. Possible Values : [STATE_UNSPECIFIED, CREATING, UPLOADING, READY, DELETING, ERROR, UPDATING]
    VaultName string
    Name of the backup vault to store the backup in.
    VolumeUsageBytes string
    Size of the file system when the backup was created. When creating a new volume from the backup, the volume capacity will have to be at least as big.
    BackupType string
    Type of backup, manually created or created by a backup policy. Possible Values : [TYPE_UNSPECIFIED, MANUAL, SCHEDULED]
    ChainStorageBytes string
    Backups of a volume build incrementally on top of each other. They form a "backup chain". Total size of all backups in a chain in bytes = baseline backup size + sum(incremental backup size)
    CreateTime string
    Create time of the backup. A timestamp in RFC3339 UTC "Zulu" format. Examples: "2023-06-22T09:13:01.617Z".
    Description string
    A description of the backup with 2048 characters or less. Requests with longer descriptions will be rejected.
    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 of the backup.
    Name string
    The resource name of the backup. 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.
    SourceSnapshot string
    If specified, backup will be created from the given snapshot. If not specified, there will be a new snapshot taken to initiate the backup creation. Format: `projects/{{projectId}}/locations/{{location}}/volumes/{{volumename}}/snapshots/{{snapshotname}}``
    SourceVolume string
    ID of volumes this backup belongs to. Format: `projects/{{projects_id}}/locations/{{location}}/volumes/{{name}}``
    State string
    The state of the Backup Vault. Possible Values : [STATE_UNSPECIFIED, CREATING, UPLOADING, READY, DELETING, ERROR, UPDATING]
    VaultName string
    Name of the backup vault to store the backup in.
    VolumeUsageBytes string
    Size of the file system when the backup was created. When creating a new volume from the backup, the volume capacity will have to be at least as big.
    backupType String
    Type of backup, manually created or created by a backup policy. Possible Values : [TYPE_UNSPECIFIED, MANUAL, SCHEDULED]
    chainStorageBytes String
    Backups of a volume build incrementally on top of each other. They form a "backup chain". Total size of all backups in a chain in bytes = baseline backup size + sum(incremental backup size)
    createTime String
    Create time of the backup. A timestamp in RFC3339 UTC "Zulu" format. Examples: "2023-06-22T09:13:01.617Z".
    description String
    A description of the backup with 2048 characters or less. Requests with longer descriptions will be rejected.
    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 of the backup.
    name String
    The resource name of the backup. 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.
    sourceSnapshot String
    If specified, backup will be created from the given snapshot. If not specified, there will be a new snapshot taken to initiate the backup creation. Format: `projects/{{projectId}}/locations/{{location}}/volumes/{{volumename}}/snapshots/{{snapshotname}}``
    sourceVolume String
    ID of volumes this backup belongs to. Format: `projects/{{projects_id}}/locations/{{location}}/volumes/{{name}}``
    state String
    The state of the Backup Vault. Possible Values : [STATE_UNSPECIFIED, CREATING, UPLOADING, READY, DELETING, ERROR, UPDATING]
    vaultName String
    Name of the backup vault to store the backup in.
    volumeUsageBytes String
    Size of the file system when the backup was created. When creating a new volume from the backup, the volume capacity will have to be at least as big.
    backupType string
    Type of backup, manually created or created by a backup policy. Possible Values : [TYPE_UNSPECIFIED, MANUAL, SCHEDULED]
    chainStorageBytes string
    Backups of a volume build incrementally on top of each other. They form a "backup chain". Total size of all backups in a chain in bytes = baseline backup size + sum(incremental backup size)
    createTime string
    Create time of the backup. A timestamp in RFC3339 UTC "Zulu" format. Examples: "2023-06-22T09:13:01.617Z".
    description string
    A description of the backup with 2048 characters or less. Requests with longer descriptions will be rejected.
    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 of the backup.
    name string
    The resource name of the backup. 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.
    sourceSnapshot string
    If specified, backup will be created from the given snapshot. If not specified, there will be a new snapshot taken to initiate the backup creation. Format: `projects/{{projectId}}/locations/{{location}}/volumes/{{volumename}}/snapshots/{{snapshotname}}``
    sourceVolume string
    ID of volumes this backup belongs to. Format: `projects/{{projects_id}}/locations/{{location}}/volumes/{{name}}``
    state string
    The state of the Backup Vault. Possible Values : [STATE_UNSPECIFIED, CREATING, UPLOADING, READY, DELETING, ERROR, UPDATING]
    vaultName string
    Name of the backup vault to store the backup in.
    volumeUsageBytes string
    Size of the file system when the backup was created. When creating a new volume from the backup, the volume capacity will have to be at least as big.
    backup_type str
    Type of backup, manually created or created by a backup policy. Possible Values : [TYPE_UNSPECIFIED, MANUAL, SCHEDULED]
    chain_storage_bytes str
    Backups of a volume build incrementally on top of each other. They form a "backup chain". Total size of all backups in a chain in bytes = baseline backup size + sum(incremental backup size)
    create_time str
    Create time of the backup. A timestamp in RFC3339 UTC "Zulu" format. Examples: "2023-06-22T09:13:01.617Z".
    description str
    A description of the backup with 2048 characters or less. Requests with longer descriptions will be rejected.
    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 of the backup.
    name str
    The resource name of the backup. 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.
    source_snapshot str
    If specified, backup will be created from the given snapshot. If not specified, there will be a new snapshot taken to initiate the backup creation. Format: `projects/{{projectId}}/locations/{{location}}/volumes/{{volumename}}/snapshots/{{snapshotname}}``
    source_volume str
    ID of volumes this backup belongs to. Format: `projects/{{projects_id}}/locations/{{location}}/volumes/{{name}}``
    state str
    The state of the Backup Vault. Possible Values : [STATE_UNSPECIFIED, CREATING, UPLOADING, READY, DELETING, ERROR, UPDATING]
    vault_name str
    Name of the backup vault to store the backup in.
    volume_usage_bytes str
    Size of the file system when the backup was created. When creating a new volume from the backup, the volume capacity will have to be at least as big.
    backupType String
    Type of backup, manually created or created by a backup policy. Possible Values : [TYPE_UNSPECIFIED, MANUAL, SCHEDULED]
    chainStorageBytes String
    Backups of a volume build incrementally on top of each other. They form a "backup chain". Total size of all backups in a chain in bytes = baseline backup size + sum(incremental backup size)
    createTime String
    Create time of the backup. A timestamp in RFC3339 UTC "Zulu" format. Examples: "2023-06-22T09:13:01.617Z".
    description String
    A description of the backup with 2048 characters or less. Requests with longer descriptions will be rejected.
    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 of the backup.
    name String
    The resource name of the backup. 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.
    sourceSnapshot String
    If specified, backup will be created from the given snapshot. If not specified, there will be a new snapshot taken to initiate the backup creation. Format: `projects/{{projectId}}/locations/{{location}}/volumes/{{volumename}}/snapshots/{{snapshotname}}``
    sourceVolume String
    ID of volumes this backup belongs to. Format: `projects/{{projects_id}}/locations/{{location}}/volumes/{{name}}``
    state String
    The state of the Backup Vault. Possible Values : [STATE_UNSPECIFIED, CREATING, UPLOADING, READY, DELETING, ERROR, UPDATING]
    vaultName String
    Name of the backup vault to store the backup in.
    volumeUsageBytes String
    Size of the file system when the backup was created. When creating a new volume from the backup, the volume capacity will have to be at least as big.

    Import

    backup can be imported using any of these accepted formats:

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

    • {{project}}/{{location}}/{{vault_name}}/{{name}}

    • {{location}}/{{vault_name}}/{{name}}

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

    $ pulumi import gcp:netapp/backup:Backup default projects/{{project}}/locations/{{location}}/backupVaults/{{vault_name}}/backups/{{name}}
    
    $ pulumi import gcp:netapp/backup:Backup default {{project}}/{{location}}/{{vault_name}}/{{name}}
    
    $ pulumi import gcp:netapp/backup:Backup default {{location}}/{{vault_name}}/{{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.30.2 published on Wednesday, Jul 10, 2024 by Pulumi