Sign in Dashboard Get started
  1. Packages
  2. Packages
  3. OVH
  4. API Docs
  5. CloudStorageBlockVolumeBackup
Viewing docs for OVHCloud v2.14.0
published on Monday, Jun 15, 2026 by OVHcloud
Schema (JSON)
ovh/pulumi-ovh

ovh.CloudStorageBlockVolumeBackup

ovh logo
Viewing docs for OVHCloud v2.14.0
published on Monday, Jun 15, 2026 by OVHcloud
Schema (JSON)
ovh/pulumi-ovh

    Creates a block storage volume backup in a public cloud project.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
import * as ovh from "@ovhcloud/pulumi-ovh";

const backup = new ovh.CloudStorageBlockVolumeBackup("backup", {
    serviceName: "xxxxxxxxx",
    name: "my-backup",
    description: "Daily backup",
    region: "GRA9",
    volumeId: volume.id,
});

    import pulumi
import pulumi_ovh as ovh

backup = ovh.CloudStorageBlockVolumeBackup("backup",
    service_name="xxxxxxxxx",
    name="my-backup",
    description="Daily backup",
    region="GRA9",
    volume_id=volume["id"])

    package main

import (
	"github.com/ovh/pulumi-ovh/sdk/v2/go/ovh"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := ovh.NewCloudStorageBlockVolumeBackup(ctx, "backup", &ovh.CloudStorageBlockVolumeBackupArgs{
			ServiceName: pulumi.String("xxxxxxxxx"),
			Name:        pulumi.String("my-backup"),
			Description: pulumi.String("Daily backup"),
			Region:      pulumi.String("GRA9"),
			VolumeId:    pulumi.Any(volume.Id),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

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

return await Deployment.RunAsync(() => 
{
    var backup = new Ovh.CloudStorageBlockVolumeBackup("backup", new()
    {
        ServiceName = "xxxxxxxxx",
        Name = "my-backup",
        Description = "Daily backup",
        Region = "GRA9",
        VolumeId = volume.Id,
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.ovhcloud.pulumi.ovh.CloudStorageBlockVolumeBackup;
import com.ovhcloud.pulumi.ovh.CloudStorageBlockVolumeBackupArgs;
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 = new CloudStorageBlockVolumeBackup("backup", CloudStorageBlockVolumeBackupArgs.builder()
            .serviceName("xxxxxxxxx")
            .name("my-backup")
            .description("Daily backup")
            .region("GRA9")
            .volumeId(volume.id())
            .build());

    }
}

    resources:
  backup:
    type: ovh:CloudStorageBlockVolumeBackup
    properties:
      serviceName: xxxxxxxxx
      name: my-backup
      description: Daily backup
      region: GRA9
      volumeId: ${volume.id}

    Example coming soon!

    Restore a volume from a backup

    Example coming soon!

    Example coming soon!

    Example coming soon!

    Example coming soon!

    Example coming soon!

    resources:
  restored:
    type: ovh:CloudStorageBlockVolume
    properties:
      serviceName: xxxxxxxxx
      name: restored-volume
      size: 10
      region: GRA9
      volumeType: CLASSIC
      createFrom:
        backup_id: ${backup.id}

    Example coming soon!

    Create CloudStorageBlockVolumeBackup Resource

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

    Constructor syntax

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

@overload
def CloudStorageBlockVolumeBackup(resource_name: str,
                                  opts: Optional[ResourceOptions] = None,
                                  region: Optional[str] = None,
                                  service_name: Optional[str] = None,
                                  volume_id: Optional[str] = None,
                                  description: Optional[str] = None,
                                  name: Optional[str] = None)
    func NewCloudStorageBlockVolumeBackup(ctx *Context, name string, args CloudStorageBlockVolumeBackupArgs, opts ...ResourceOption) (*CloudStorageBlockVolumeBackup, error)
    public CloudStorageBlockVolumeBackup(string name, CloudStorageBlockVolumeBackupArgs args, CustomResourceOptions? opts = null)
    public CloudStorageBlockVolumeBackup(String name, CloudStorageBlockVolumeBackupArgs args)
public CloudStorageBlockVolumeBackup(String name, CloudStorageBlockVolumeBackupArgs args, CustomResourceOptions options)

    type: ovh:CloudStorageBlockVolumeBackup
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.


    resource "ovh_cloudstorageblockvolumebackup" "name" {
    # resource properties
}

    Parameters

    name string
    The unique name of the resource.
    args CloudStorageBlockVolumeBackupArgs
    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 CloudStorageBlockVolumeBackupArgs
    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 CloudStorageBlockVolumeBackupArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args CloudStorageBlockVolumeBackupArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args CloudStorageBlockVolumeBackupArgs
    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 cloudStorageBlockVolumeBackupResource = new Ovh.CloudStorageBlockVolumeBackup("cloudStorageBlockVolumeBackupResource", new()
{
    Region = "string",
    ServiceName = "string",
    VolumeId = "string",
    Description = "string",
    Name = "string",
});

    example, err := ovh.NewCloudStorageBlockVolumeBackup(ctx, "cloudStorageBlockVolumeBackupResource", &ovh.CloudStorageBlockVolumeBackupArgs{
	Region:      pulumi.String("string"),
	ServiceName: pulumi.String("string"),
	VolumeId:    pulumi.String("string"),
	Description: pulumi.String("string"),
	Name:        pulumi.String("string"),
})

    resource "ovh_cloudstorageblockvolumebackup" "cloudStorageBlockVolumeBackupResource" {
  region       = "string"
  service_name = "string"
  volume_id    = "string"
  description  = "string"
  name         = "string"
}

    var cloudStorageBlockVolumeBackupResource = new CloudStorageBlockVolumeBackup("cloudStorageBlockVolumeBackupResource", CloudStorageBlockVolumeBackupArgs.builder()
    .region("string")
    .serviceName("string")
    .volumeId("string")
    .description("string")
    .name("string")
    .build());

    cloud_storage_block_volume_backup_resource = ovh.CloudStorageBlockVolumeBackup("cloudStorageBlockVolumeBackupResource",
    region="string",
    service_name="string",
    volume_id="string",
    description="string",
    name="string")

    const cloudStorageBlockVolumeBackupResource = new ovh.CloudStorageBlockVolumeBackup("cloudStorageBlockVolumeBackupResource", {
    region: "string",
    serviceName: "string",
    volumeId: "string",
    description: "string",
    name: "string",
});

    type: ovh:CloudStorageBlockVolumeBackup
properties:
    description: string
    name: string
    region: string
    serviceName: string
    volumeId: string

    CloudStorageBlockVolumeBackup Resource Properties

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

    Inputs

    In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

    The CloudStorageBlockVolumeBackup resource accepts the following input properties:

    Region string
    The region where the backup will be created. Changing this value recreates the resource.
    ServiceName string
    The id of the public cloud project. Changing this value recreates the resource.
    VolumeId string
    The ID of the volume to back up. Changing this value recreates the resource.
    Description string
    A description for the backup.
    Name string
    The name of the backup.
    Region string
    The region where the backup will be created. Changing this value recreates the resource.
    ServiceName string
    The id of the public cloud project. Changing this value recreates the resource.
    VolumeId string
    The ID of the volume to back up. Changing this value recreates the resource.
    Description string
    A description for the backup.
    Name string
    The name of the backup.
    region string
    The region where the backup will be created. Changing this value recreates the resource.
    service_name string
    The id of the public cloud project. Changing this value recreates the resource.
    volume_id string
    The ID of the volume to back up. Changing this value recreates the resource.
    description string
    A description for the backup.
    name string
    The name of the backup.
    region String
    The region where the backup will be created. Changing this value recreates the resource.
    serviceName String
    The id of the public cloud project. Changing this value recreates the resource.
    volumeId String
    The ID of the volume to back up. Changing this value recreates the resource.
    description String
    A description for the backup.
    name String
    The name of the backup.
    region string
    The region where the backup will be created. Changing this value recreates the resource.
    serviceName string
    The id of the public cloud project. Changing this value recreates the resource.
    volumeId string
    The ID of the volume to back up. Changing this value recreates the resource.
    description string
    A description for the backup.
    name string
    The name of the backup.
    region str
    The region where the backup will be created. Changing this value recreates the resource.
    service_name str
    The id of the public cloud project. Changing this value recreates the resource.
    volume_id str
    The ID of the volume to back up. Changing this value recreates the resource.
    description str
    A description for the backup.
    name str
    The name of the backup.
    region String
    The region where the backup will be created. Changing this value recreates the resource.
    serviceName String
    The id of the public cloud project. Changing this value recreates the resource.
    volumeId String
    The ID of the volume to back up. Changing this value recreates the resource.
    description String
    A description for the backup.
    name String
    The name of the backup.

    Outputs

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

    Checksum string
    Computed hash representing the current target specification value.
    CreatedAt string
    Creation date of the backup.
    CurrentState CloudStorageBlockVolumeBackupCurrentState
    Current state of the backup:
    Id string
    The provider-assigned unique ID for this managed resource.
    ResourceStatus string
    Backup readiness in the system (CREATING, DELETING, ERROR, OUT_OF_SYNC, READY, UPDATING).
    UpdatedAt string
    Last update date of the backup.
    Checksum string
    Computed hash representing the current target specification value.
    CreatedAt string
    Creation date of the backup.
    CurrentState CloudStorageBlockVolumeBackupCurrentState
    Current state of the backup:
    Id string
    The provider-assigned unique ID for this managed resource.
    ResourceStatus string
    Backup readiness in the system (CREATING, DELETING, ERROR, OUT_OF_SYNC, READY, UPDATING).
    UpdatedAt string
    Last update date of the backup.
    checksum string
    Computed hash representing the current target specification value.
    created_at string
    Creation date of the backup.
    current_state object
    Current state of the backup:
    id string
    The provider-assigned unique ID for this managed resource.
    resource_status string
    Backup readiness in the system (CREATING, DELETING, ERROR, OUT_OF_SYNC, READY, UPDATING).
    updated_at string
    Last update date of the backup.
    checksum String
    Computed hash representing the current target specification value.
    createdAt String
    Creation date of the backup.
    currentState CloudStorageBlockVolumeBackupCurrentState
    Current state of the backup:
    id String
    The provider-assigned unique ID for this managed resource.
    resourceStatus String
    Backup readiness in the system (CREATING, DELETING, ERROR, OUT_OF_SYNC, READY, UPDATING).
    updatedAt String
    Last update date of the backup.
    checksum string
    Computed hash representing the current target specification value.
    createdAt string
    Creation date of the backup.
    currentState CloudStorageBlockVolumeBackupCurrentState
    Current state of the backup:
    id string
    The provider-assigned unique ID for this managed resource.
    resourceStatus string
    Backup readiness in the system (CREATING, DELETING, ERROR, OUT_OF_SYNC, READY, UPDATING).
    updatedAt string
    Last update date of the backup.
    checksum str
    Computed hash representing the current target specification value.
    created_at str
    Creation date of the backup.
    current_state CloudStorageBlockVolumeBackupCurrentState
    Current state of the backup:
    id str
    The provider-assigned unique ID for this managed resource.
    resource_status str
    Backup readiness in the system (CREATING, DELETING, ERROR, OUT_OF_SYNC, READY, UPDATING).
    updated_at str
    Last update date of the backup.
    checksum String
    Computed hash representing the current target specification value.
    createdAt String
    Creation date of the backup.
    currentState Property Map
    Current state of the backup:
    id String
    The provider-assigned unique ID for this managed resource.
    resourceStatus String
    Backup readiness in the system (CREATING, DELETING, ERROR, OUT_OF_SYNC, READY, UPDATING).
    updatedAt String
    Last update date of the backup.

    Look up Existing CloudStorageBlockVolumeBackup Resource

    Get an existing CloudStorageBlockVolumeBackup 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?: CloudStorageBlockVolumeBackupState, opts?: CustomResourceOptions): CloudStorageBlockVolumeBackup
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        checksum: Optional[str] = None,
        created_at: Optional[str] = None,
        current_state: Optional[CloudStorageBlockVolumeBackupCurrentStateArgs] = None,
        description: Optional[str] = None,
        name: Optional[str] = None,
        region: Optional[str] = None,
        resource_status: Optional[str] = None,
        service_name: Optional[str] = None,
        updated_at: Optional[str] = None,
        volume_id: Optional[str] = None) -> CloudStorageBlockVolumeBackup
    func GetCloudStorageBlockVolumeBackup(ctx *Context, name string, id IDInput, state *CloudStorageBlockVolumeBackupState, opts ...ResourceOption) (*CloudStorageBlockVolumeBackup, error)
    public static CloudStorageBlockVolumeBackup Get(string name, Input<string> id, CloudStorageBlockVolumeBackupState? state, CustomResourceOptions? opts = null)
    public static CloudStorageBlockVolumeBackup get(String name, Output<String> id, CloudStorageBlockVolumeBackupState state, CustomResourceOptions options)
    resources:  _:    type: ovh:CloudStorageBlockVolumeBackup    get:      id: ${id}
    import {
  to = ovh_cloudstorageblockvolumebackup.example
  id = "${id}"
}
    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:
    Checksum string
    Computed hash representing the current target specification value.
    CreatedAt string
    Creation date of the backup.
    CurrentState CloudStorageBlockVolumeBackupCurrentState
    Current state of the backup:
    Description string
    A description for the backup.
    Name string
    The name of the backup.
    Region string
    The region where the backup will be created. Changing this value recreates the resource.
    ResourceStatus string
    Backup readiness in the system (CREATING, DELETING, ERROR, OUT_OF_SYNC, READY, UPDATING).
    ServiceName string
    The id of the public cloud project. Changing this value recreates the resource.
    UpdatedAt string
    Last update date of the backup.
    VolumeId string
    The ID of the volume to back up. Changing this value recreates the resource.
    Checksum string
    Computed hash representing the current target specification value.
    CreatedAt string
    Creation date of the backup.
    CurrentState CloudStorageBlockVolumeBackupCurrentStateArgs
    Current state of the backup:
    Description string
    A description for the backup.
    Name string
    The name of the backup.
    Region string
    The region where the backup will be created. Changing this value recreates the resource.
    ResourceStatus string
    Backup readiness in the system (CREATING, DELETING, ERROR, OUT_OF_SYNC, READY, UPDATING).
    ServiceName string
    The id of the public cloud project. Changing this value recreates the resource.
    UpdatedAt string
    Last update date of the backup.
    VolumeId string
    The ID of the volume to back up. Changing this value recreates the resource.
    checksum string
    Computed hash representing the current target specification value.
    created_at string
    Creation date of the backup.
    current_state object
    Current state of the backup:
    description string
    A description for the backup.
    name string
    The name of the backup.
    region string
    The region where the backup will be created. Changing this value recreates the resource.
    resource_status string
    Backup readiness in the system (CREATING, DELETING, ERROR, OUT_OF_SYNC, READY, UPDATING).
    service_name string
    The id of the public cloud project. Changing this value recreates the resource.
    updated_at string
    Last update date of the backup.
    volume_id string
    The ID of the volume to back up. Changing this value recreates the resource.
    checksum String
    Computed hash representing the current target specification value.
    createdAt String
    Creation date of the backup.
    currentState CloudStorageBlockVolumeBackupCurrentState
    Current state of the backup:
    description String
    A description for the backup.
    name String
    The name of the backup.
    region String
    The region where the backup will be created. Changing this value recreates the resource.
    resourceStatus String
    Backup readiness in the system (CREATING, DELETING, ERROR, OUT_OF_SYNC, READY, UPDATING).
    serviceName String
    The id of the public cloud project. Changing this value recreates the resource.
    updatedAt String
    Last update date of the backup.
    volumeId String
    The ID of the volume to back up. Changing this value recreates the resource.
    checksum string
    Computed hash representing the current target specification value.
    createdAt string
    Creation date of the backup.
    currentState CloudStorageBlockVolumeBackupCurrentState
    Current state of the backup:
    description string
    A description for the backup.
    name string
    The name of the backup.
    region string
    The region where the backup will be created. Changing this value recreates the resource.
    resourceStatus string
    Backup readiness in the system (CREATING, DELETING, ERROR, OUT_OF_SYNC, READY, UPDATING).
    serviceName string
    The id of the public cloud project. Changing this value recreates the resource.
    updatedAt string
    Last update date of the backup.
    volumeId string
    The ID of the volume to back up. Changing this value recreates the resource.
    checksum str
    Computed hash representing the current target specification value.
    created_at str
    Creation date of the backup.
    current_state CloudStorageBlockVolumeBackupCurrentStateArgs
    Current state of the backup:
    description str
    A description for the backup.
    name str
    The name of the backup.
    region str
    The region where the backup will be created. Changing this value recreates the resource.
    resource_status str
    Backup readiness in the system (CREATING, DELETING, ERROR, OUT_OF_SYNC, READY, UPDATING).
    service_name str
    The id of the public cloud project. Changing this value recreates the resource.
    updated_at str
    Last update date of the backup.
    volume_id str
    The ID of the volume to back up. Changing this value recreates the resource.
    checksum String
    Computed hash representing the current target specification value.
    createdAt String
    Creation date of the backup.
    currentState Property Map
    Current state of the backup:
    description String
    A description for the backup.
    name String
    The name of the backup.
    region String
    The region where the backup will be created. Changing this value recreates the resource.
    resourceStatus String
    Backup readiness in the system (CREATING, DELETING, ERROR, OUT_OF_SYNC, READY, UPDATING).
    serviceName String
    The id of the public cloud project. Changing this value recreates the resource.
    updatedAt String
    Last update date of the backup.
    volumeId String
    The ID of the volume to back up. Changing this value recreates the resource.

    Supporting Types

    CloudStorageBlockVolumeBackupCurrentState, CloudStorageBlockVolumeBackupCurrentStateArgs

    Description string
    A description for the backup.
    Location CloudStorageBlockVolumeBackupCurrentStateLocation
    Current location:
    Name string
    The name of the backup.
    Size int
    Size of the backup in GB.
    VolumeId string
    The ID of the volume to back up. Changing this value recreates the resource.
    Description string
    A description for the backup.
    Location CloudStorageBlockVolumeBackupCurrentStateLocation
    Current location:
    Name string
    The name of the backup.
    Size int
    Size of the backup in GB.
    VolumeId string
    The ID of the volume to back up. Changing this value recreates the resource.
    description string
    A description for the backup.
    location object
    Current location:
    name string
    The name of the backup.
    size number
    Size of the backup in GB.
    volume_id string
    The ID of the volume to back up. Changing this value recreates the resource.
    description String
    A description for the backup.
    location CloudStorageBlockVolumeBackupCurrentStateLocation
    Current location:
    name String
    The name of the backup.
    size Integer
    Size of the backup in GB.
    volumeId String
    The ID of the volume to back up. Changing this value recreates the resource.
    description string
    A description for the backup.
    location CloudStorageBlockVolumeBackupCurrentStateLocation
    Current location:
    name string
    The name of the backup.
    size number
    Size of the backup in GB.
    volumeId string
    The ID of the volume to back up. Changing this value recreates the resource.
    description str
    A description for the backup.
    location CloudStorageBlockVolumeBackupCurrentStateLocation
    Current location:
    name str
    The name of the backup.
    size int
    Size of the backup in GB.
    volume_id str
    The ID of the volume to back up. Changing this value recreates the resource.
    description String
    A description for the backup.
    location Property Map
    Current location:
    name String
    The name of the backup.
    size Number
    Size of the backup in GB.
    volumeId String
    The ID of the volume to back up. Changing this value recreates the resource.

    CloudStorageBlockVolumeBackupCurrentStateLocation, CloudStorageBlockVolumeBackupCurrentStateLocationArgs

    Region string
    The region where the backup will be created. Changing this value recreates the resource.
    Region string
    The region where the backup will be created. Changing this value recreates the resource.
    region string
    The region where the backup will be created. Changing this value recreates the resource.
    region String
    The region where the backup will be created. Changing this value recreates the resource.
    region string
    The region where the backup will be created. Changing this value recreates the resource.
    region str
    The region where the backup will be created. Changing this value recreates the resource.
    region String
    The region where the backup will be created. Changing this value recreates the resource.

    Import

    A block storage volume backup can be imported using the service_name and id separated by a /:

    bash

    $ pulumi import ovh:index/cloudStorageBlockVolumeBackup:CloudStorageBlockVolumeBackup backup service_name/backup_id

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

    Package Details

    Repository
    ovh ovh/pulumi-ovh
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the ovh Terraform Provider.
    ovh logo
    Viewing docs for OVHCloud v2.14.0
    published on Monday, Jun 15, 2026 by OVHcloud
    Schema (JSON)
    ovh/pulumi-ovh

      Try Pulumi Cloud free.
      Your team will thank you.

      Start free trial