1. Packages
  2. Opentelekomcloud Provider
  3. API Docs
  4. VbsBackupShareV2
opentelekomcloud 1.36.35 published on Monday, Apr 14, 2025 by opentelekomcloud

opentelekomcloud.VbsBackupShareV2

Explore with Pulumi AI

Up-to-date reference of API arguments for VBS backup share you can get at documentation portal

Provides an VBS Backup Share resource within OpenTelekomCloud.

~> Deprecated, use opentelekomcloud.CbrVaultV3 resource instead.

Example Usage

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

const config = new pulumi.Config();
const backupId = config.requireObject("backupId");
const toProjectIds = config.requireObject("toProjectIds");
const backupshare = new opentelekomcloud.VbsBackupShareV2("backupshare", {
    backupId: backupId,
    toProjectIds: toProjectIds,
});
Copy
import pulumi
import pulumi_opentelekomcloud as opentelekomcloud

config = pulumi.Config()
backup_id = config.require_object("backupId")
to_project_ids = config.require_object("toProjectIds")
backupshare = opentelekomcloud.VbsBackupShareV2("backupshare",
    backup_id=backup_id,
    to_project_ids=to_project_ids)
Copy
package main

import (
	"github.com/pulumi/pulumi-terraform-provider/sdks/go/opentelekomcloud/opentelekomcloud"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi/config"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		cfg := config.New(ctx, "")
		backupId := cfg.RequireObject("backupId")
		toProjectIds := cfg.RequireObject("toProjectIds")
		_, err := opentelekomcloud.NewVbsBackupShareV2(ctx, "backupshare", &opentelekomcloud.VbsBackupShareV2Args{
			BackupId:     pulumi.Any(backupId),
			ToProjectIds: pulumi.Any(toProjectIds),
		})
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Opentelekomcloud = Pulumi.Opentelekomcloud;

return await Deployment.RunAsync(() => 
{
    var config = new Config();
    var backupId = config.RequireObject<dynamic>("backupId");
    var toProjectIds = config.RequireObject<dynamic>("toProjectIds");
    var backupshare = new Opentelekomcloud.VbsBackupShareV2("backupshare", new()
    {
        BackupId = backupId,
        ToProjectIds = toProjectIds,
    });

});
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.opentelekomcloud.VbsBackupShareV2;
import com.pulumi.opentelekomcloud.VbsBackupShareV2Args;
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 config = ctx.config();
        final var backupId = config.get("backupId");
        final var toProjectIds = config.get("toProjectIds");
        var backupshare = new VbsBackupShareV2("backupshare", VbsBackupShareV2Args.builder()
            .backupId(backupId)
            .toProjectIds(toProjectIds)
            .build());

    }
}
Copy
configuration:
  backupId:
    type: dynamic
  toProjectIds:
    type: dynamic
resources:
  backupshare:
    type: opentelekomcloud:VbsBackupShareV2
    properties:
      backupId: ${backupId}
      toProjectIds: ${toProjectIds}
Copy

Create VbsBackupShareV2 Resource

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

Constructor syntax

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

@overload
def VbsBackupShareV2(resource_name: str,
                     opts: Optional[ResourceOptions] = None,
                     backup_id: Optional[str] = None,
                     to_project_ids: Optional[Sequence[str]] = None,
                     region: Optional[str] = None,
                     timeouts: Optional[VbsBackupShareV2TimeoutsArgs] = None,
                     vbs_backup_share_v2_id: Optional[str] = None)
func NewVbsBackupShareV2(ctx *Context, name string, args VbsBackupShareV2Args, opts ...ResourceOption) (*VbsBackupShareV2, error)
public VbsBackupShareV2(string name, VbsBackupShareV2Args args, CustomResourceOptions? opts = null)
public VbsBackupShareV2(String name, VbsBackupShareV2Args args)
public VbsBackupShareV2(String name, VbsBackupShareV2Args args, CustomResourceOptions options)
type: opentelekomcloud:VbsBackupShareV2
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

name This property is required. string
The unique name of the resource.
args This property is required. VbsBackupShareV2Args
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name This property is required. str
The unique name of the resource.
args This property is required. VbsBackupShareV2Args
The arguments to resource properties.
opts ResourceOptions
Bag of options to control resource's behavior.
ctx Context
Context object for the current deployment.
name This property is required. string
The unique name of the resource.
args This property is required. VbsBackupShareV2Args
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name This property is required. string
The unique name of the resource.
args This property is required. VbsBackupShareV2Args
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name This property is required. String
The unique name of the resource.
args This property is required. VbsBackupShareV2Args
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 vbsBackupShareV2Resource = new Opentelekomcloud.VbsBackupShareV2("vbsBackupShareV2Resource", new()
{
    BackupId = "string",
    ToProjectIds = new[]
    {
        "string",
    },
    Region = "string",
    Timeouts = new Opentelekomcloud.Inputs.VbsBackupShareV2TimeoutsArgs
    {
        Create = "string",
        Delete = "string",
    },
    VbsBackupShareV2Id = "string",
});
Copy
example, err := opentelekomcloud.NewVbsBackupShareV2(ctx, "vbsBackupShareV2Resource", &opentelekomcloud.VbsBackupShareV2Args{
	BackupId: pulumi.String("string"),
	ToProjectIds: pulumi.StringArray{
		pulumi.String("string"),
	},
	Region: pulumi.String("string"),
	Timeouts: &opentelekomcloud.VbsBackupShareV2TimeoutsArgs{
		Create: pulumi.String("string"),
		Delete: pulumi.String("string"),
	},
	VbsBackupShareV2Id: pulumi.String("string"),
})
Copy
var vbsBackupShareV2Resource = new VbsBackupShareV2("vbsBackupShareV2Resource", VbsBackupShareV2Args.builder()
    .backupId("string")
    .toProjectIds("string")
    .region("string")
    .timeouts(VbsBackupShareV2TimeoutsArgs.builder()
        .create("string")
        .delete("string")
        .build())
    .vbsBackupShareV2Id("string")
    .build());
Copy
vbs_backup_share_v2_resource = opentelekomcloud.VbsBackupShareV2("vbsBackupShareV2Resource",
    backup_id="string",
    to_project_ids=["string"],
    region="string",
    timeouts={
        "create": "string",
        "delete": "string",
    },
    vbs_backup_share_v2_id="string")
Copy
const vbsBackupShareV2Resource = new opentelekomcloud.VbsBackupShareV2("vbsBackupShareV2Resource", {
    backupId: "string",
    toProjectIds: ["string"],
    region: "string",
    timeouts: {
        create: "string",
        "delete": "string",
    },
    vbsBackupShareV2Id: "string",
});
Copy
type: opentelekomcloud:VbsBackupShareV2
properties:
    backupId: string
    region: string
    timeouts:
        create: string
        delete: string
    toProjectIds:
        - string
    vbsBackupShareV2Id: string
Copy

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

BackupId This property is required. string
The ID of the backup to be shared. Changing the parameter will create new resource.
ToProjectIds This property is required. List<string>
The IDs of projects with which the backup is shared. Changing the parameter will create new resource.
Region string
Timeouts VbsBackupShareV2Timeouts
VbsBackupShareV2Id string
BackupId This property is required. string
The ID of the backup to be shared. Changing the parameter will create new resource.
ToProjectIds This property is required. []string
The IDs of projects with which the backup is shared. Changing the parameter will create new resource.
Region string
Timeouts VbsBackupShareV2TimeoutsArgs
VbsBackupShareV2Id string
backupId This property is required. String
The ID of the backup to be shared. Changing the parameter will create new resource.
toProjectIds This property is required. List<String>
The IDs of projects with which the backup is shared. Changing the parameter will create new resource.
region String
timeouts VbsBackupShareV2Timeouts
vbsBackupShareV2Id String
backupId This property is required. string
The ID of the backup to be shared. Changing the parameter will create new resource.
toProjectIds This property is required. string[]
The IDs of projects with which the backup is shared. Changing the parameter will create new resource.
region string
timeouts VbsBackupShareV2Timeouts
vbsBackupShareV2Id string
backup_id This property is required. str
The ID of the backup to be shared. Changing the parameter will create new resource.
to_project_ids This property is required. Sequence[str]
The IDs of projects with which the backup is shared. Changing the parameter will create new resource.
region str
timeouts VbsBackupShareV2TimeoutsArgs
vbs_backup_share_v2_id str
backupId This property is required. String
The ID of the backup to be shared. Changing the parameter will create new resource.
toProjectIds This property is required. List<String>
The IDs of projects with which the backup is shared. Changing the parameter will create new resource.
region String
timeouts Property Map
vbsBackupShareV2Id String

Outputs

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

AvailabilityZone string
The AZ where the backup resides.
BackupName string
The backup name.
BackupStatus string
The status of the VBS backup.
Container string
The container of the backup.
Description string
The status of the VBS backup.
Id string
The provider-assigned unique ID for this managed resource.
ServiceMetadata string
The metadata of the vbs backup.
ShareIds List<string>
The backup share IDs.
Size double
The size of the vbs backup.
SnapshotId string
The ID of the snapshot associated with the backup.
VolumeId string
The ID of the tenant to which the backup belongs.
AvailabilityZone string
The AZ where the backup resides.
BackupName string
The backup name.
BackupStatus string
The status of the VBS backup.
Container string
The container of the backup.
Description string
The status of the VBS backup.
Id string
The provider-assigned unique ID for this managed resource.
ServiceMetadata string
The metadata of the vbs backup.
ShareIds []string
The backup share IDs.
Size float64
The size of the vbs backup.
SnapshotId string
The ID of the snapshot associated with the backup.
VolumeId string
The ID of the tenant to which the backup belongs.
availabilityZone String
The AZ where the backup resides.
backupName String
The backup name.
backupStatus String
The status of the VBS backup.
container String
The container of the backup.
description String
The status of the VBS backup.
id String
The provider-assigned unique ID for this managed resource.
serviceMetadata String
The metadata of the vbs backup.
shareIds List<String>
The backup share IDs.
size Double
The size of the vbs backup.
snapshotId String
The ID of the snapshot associated with the backup.
volumeId String
The ID of the tenant to which the backup belongs.
availabilityZone string
The AZ where the backup resides.
backupName string
The backup name.
backupStatus string
The status of the VBS backup.
container string
The container of the backup.
description string
The status of the VBS backup.
id string
The provider-assigned unique ID for this managed resource.
serviceMetadata string
The metadata of the vbs backup.
shareIds string[]
The backup share IDs.
size number
The size of the vbs backup.
snapshotId string
The ID of the snapshot associated with the backup.
volumeId string
The ID of the tenant to which the backup belongs.
availability_zone str
The AZ where the backup resides.
backup_name str
The backup name.
backup_status str
The status of the VBS backup.
container str
The container of the backup.
description str
The status of the VBS backup.
id str
The provider-assigned unique ID for this managed resource.
service_metadata str
The metadata of the vbs backup.
share_ids Sequence[str]
The backup share IDs.
size float
The size of the vbs backup.
snapshot_id str
The ID of the snapshot associated with the backup.
volume_id str
The ID of the tenant to which the backup belongs.
availabilityZone String
The AZ where the backup resides.
backupName String
The backup name.
backupStatus String
The status of the VBS backup.
container String
The container of the backup.
description String
The status of the VBS backup.
id String
The provider-assigned unique ID for this managed resource.
serviceMetadata String
The metadata of the vbs backup.
shareIds List<String>
The backup share IDs.
size Number
The size of the vbs backup.
snapshotId String
The ID of the snapshot associated with the backup.
volumeId String
The ID of the tenant to which the backup belongs.

Look up Existing VbsBackupShareV2 Resource

Get an existing VbsBackupShareV2 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?: VbsBackupShareV2State, opts?: CustomResourceOptions): VbsBackupShareV2
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        availability_zone: Optional[str] = None,
        backup_id: Optional[str] = None,
        backup_name: Optional[str] = None,
        backup_status: Optional[str] = None,
        container: Optional[str] = None,
        description: Optional[str] = None,
        region: Optional[str] = None,
        service_metadata: Optional[str] = None,
        share_ids: Optional[Sequence[str]] = None,
        size: Optional[float] = None,
        snapshot_id: Optional[str] = None,
        timeouts: Optional[VbsBackupShareV2TimeoutsArgs] = None,
        to_project_ids: Optional[Sequence[str]] = None,
        vbs_backup_share_v2_id: Optional[str] = None,
        volume_id: Optional[str] = None) -> VbsBackupShareV2
func GetVbsBackupShareV2(ctx *Context, name string, id IDInput, state *VbsBackupShareV2State, opts ...ResourceOption) (*VbsBackupShareV2, error)
public static VbsBackupShareV2 Get(string name, Input<string> id, VbsBackupShareV2State? state, CustomResourceOptions? opts = null)
public static VbsBackupShareV2 get(String name, Output<String> id, VbsBackupShareV2State state, CustomResourceOptions options)
resources:  _:    type: opentelekomcloud:VbsBackupShareV2    get:      id: ${id}
name This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
name This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
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:
AvailabilityZone string
The AZ where the backup resides.
BackupId string
The ID of the backup to be shared. Changing the parameter will create new resource.
BackupName string
The backup name.
BackupStatus string
The status of the VBS backup.
Container string
The container of the backup.
Description string
The status of the VBS backup.
Region string
ServiceMetadata string
The metadata of the vbs backup.
ShareIds List<string>
The backup share IDs.
Size double
The size of the vbs backup.
SnapshotId string
The ID of the snapshot associated with the backup.
Timeouts VbsBackupShareV2Timeouts
ToProjectIds List<string>
The IDs of projects with which the backup is shared. Changing the parameter will create new resource.
VbsBackupShareV2Id string
VolumeId string
The ID of the tenant to which the backup belongs.
AvailabilityZone string
The AZ where the backup resides.
BackupId string
The ID of the backup to be shared. Changing the parameter will create new resource.
BackupName string
The backup name.
BackupStatus string
The status of the VBS backup.
Container string
The container of the backup.
Description string
The status of the VBS backup.
Region string
ServiceMetadata string
The metadata of the vbs backup.
ShareIds []string
The backup share IDs.
Size float64
The size of the vbs backup.
SnapshotId string
The ID of the snapshot associated with the backup.
Timeouts VbsBackupShareV2TimeoutsArgs
ToProjectIds []string
The IDs of projects with which the backup is shared. Changing the parameter will create new resource.
VbsBackupShareV2Id string
VolumeId string
The ID of the tenant to which the backup belongs.
availabilityZone String
The AZ where the backup resides.
backupId String
The ID of the backup to be shared. Changing the parameter will create new resource.
backupName String
The backup name.
backupStatus String
The status of the VBS backup.
container String
The container of the backup.
description String
The status of the VBS backup.
region String
serviceMetadata String
The metadata of the vbs backup.
shareIds List<String>
The backup share IDs.
size Double
The size of the vbs backup.
snapshotId String
The ID of the snapshot associated with the backup.
timeouts VbsBackupShareV2Timeouts
toProjectIds List<String>
The IDs of projects with which the backup is shared. Changing the parameter will create new resource.
vbsBackupShareV2Id String
volumeId String
The ID of the tenant to which the backup belongs.
availabilityZone string
The AZ where the backup resides.
backupId string
The ID of the backup to be shared. Changing the parameter will create new resource.
backupName string
The backup name.
backupStatus string
The status of the VBS backup.
container string
The container of the backup.
description string
The status of the VBS backup.
region string
serviceMetadata string
The metadata of the vbs backup.
shareIds string[]
The backup share IDs.
size number
The size of the vbs backup.
snapshotId string
The ID of the snapshot associated with the backup.
timeouts VbsBackupShareV2Timeouts
toProjectIds string[]
The IDs of projects with which the backup is shared. Changing the parameter will create new resource.
vbsBackupShareV2Id string
volumeId string
The ID of the tenant to which the backup belongs.
availability_zone str
The AZ where the backup resides.
backup_id str
The ID of the backup to be shared. Changing the parameter will create new resource.
backup_name str
The backup name.
backup_status str
The status of the VBS backup.
container str
The container of the backup.
description str
The status of the VBS backup.
region str
service_metadata str
The metadata of the vbs backup.
share_ids Sequence[str]
The backup share IDs.
size float
The size of the vbs backup.
snapshot_id str
The ID of the snapshot associated with the backup.
timeouts VbsBackupShareV2TimeoutsArgs
to_project_ids Sequence[str]
The IDs of projects with which the backup is shared. Changing the parameter will create new resource.
vbs_backup_share_v2_id str
volume_id str
The ID of the tenant to which the backup belongs.
availabilityZone String
The AZ where the backup resides.
backupId String
The ID of the backup to be shared. Changing the parameter will create new resource.
backupName String
The backup name.
backupStatus String
The status of the VBS backup.
container String
The container of the backup.
description String
The status of the VBS backup.
region String
serviceMetadata String
The metadata of the vbs backup.
shareIds List<String>
The backup share IDs.
size Number
The size of the vbs backup.
snapshotId String
The ID of the snapshot associated with the backup.
timeouts Property Map
toProjectIds List<String>
The IDs of projects with which the backup is shared. Changing the parameter will create new resource.
vbsBackupShareV2Id String
volumeId String
The ID of the tenant to which the backup belongs.

Supporting Types

VbsBackupShareV2Timeouts
, VbsBackupShareV2TimeoutsArgs

Create string
Delete string
Create string
Delete string
create String
delete String
create string
delete string
create str
delete str
create String
delete String

Import

VBS Backup Share can be imported using the backup id, e.g.

$ pulumi import opentelekomcloud:index/vbsBackupShareV2:VbsBackupShareV2 backupshare 4779ab1c-7c1a-44b1-a02e-93dfc361b32d
Copy

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

Package Details

Repository
opentelekomcloud opentelekomcloud/terraform-provider-opentelekomcloud
License
Notes
This Pulumi package is based on the opentelekomcloud Terraform Provider.