Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Opentelekomcloud Provider
  3. API Docs
  4. VbsBackupPolicyV2
opentelekomcloud 1.36.35 published on Monday, Apr 14, 2025 by opentelekomcloud
opentelekomcloud/terraform-provider-opentelekomcloud

opentelekomcloud.VbsBackupPolicyV2

Explore with Pulumi AI

opentelekomcloud 1.36.35 published on Monday, Apr 14, 2025 by opentelekomcloud
opentelekomcloud/terraform-provider-opentelekomcloud

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

Provides an VBS Backup Policy resource within OpenTelekomCloud.

~> Deprecated, use opentelekomcloud.CbrPolicyV3 resource instead.

Example Usage

Basic Backup Policy

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

const vbsPolicy1 = new opentelekomcloud.VbsBackupPolicyV2("vbsPolicy1", {
    frequency: 1,
    rententionNum: 7,
    retainFirstBackup: "N",
    startTime: "12:00",
    status: "ON",
    tags: [{
        key: "k1",
        value: "v1",
    }],
});
Copy
import pulumi
import pulumi_opentelekomcloud as opentelekomcloud

vbs_policy1 = opentelekomcloud.VbsBackupPolicyV2("vbsPolicy1",
    frequency=1,
    rentention_num=7,
    retain_first_backup="N",
    start_time="12:00",
    status="ON",
    tags=[{
        "key": "k1",
        "value": "v1",
    }])
Copy
package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := opentelekomcloud.NewVbsBackupPolicyV2(ctx, "vbsPolicy1", &opentelekomcloud.VbsBackupPolicyV2Args{
			Frequency:         pulumi.Float64(1),
			RententionNum:     pulumi.Float64(7),
			RetainFirstBackup: pulumi.String("N"),
			StartTime:         pulumi.String("12:00"),
			Status:            pulumi.String("ON"),
			Tags: opentelekomcloud.VbsBackupPolicyV2TagArray{
				&opentelekomcloud.VbsBackupPolicyV2TagArgs{
					Key:   pulumi.String("k1"),
					Value: pulumi.String("v1"),
				},
			},
		})
		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 vbsPolicy1 = new Opentelekomcloud.VbsBackupPolicyV2("vbsPolicy1", new()
    {
        Frequency = 1,
        RententionNum = 7,
        RetainFirstBackup = "N",
        StartTime = "12:00",
        Status = "ON",
        Tags = new[]
        {
            new Opentelekomcloud.Inputs.VbsBackupPolicyV2TagArgs
            {
                Key = "k1",
                Value = "v1",
            },
        },
    });

});
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.opentelekomcloud.VbsBackupPolicyV2;
import com.pulumi.opentelekomcloud.VbsBackupPolicyV2Args;
import com.pulumi.opentelekomcloud.inputs.VbsBackupPolicyV2TagArgs;
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 vbsPolicy1 = new VbsBackupPolicyV2("vbsPolicy1", VbsBackupPolicyV2Args.builder()
            .frequency(1)
            .rententionNum(7)
            .retainFirstBackup("N")
            .startTime("12:00")
            .status("ON")
            .tags(VbsBackupPolicyV2TagArgs.builder()
                .key("k1")
                .value("v1")
                .build())
            .build());

    }
}
Copy
resources:
  vbsPolicy1:
    type: opentelekomcloud:VbsBackupPolicyV2
    properties:
      frequency: 1
      rententionNum: 7
      retainFirstBackup: N
      startTime: 12:00
      status: ON
      tags:
        - key: k1
          value: v1
Copy

Backup Policy with EVS Disks

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

const config = new pulumi.Config();
const volumeId = config.requireObject("volumeId");
const vbsPolicy2 = new opentelekomcloud.VbsBackupPolicyV2("vbsPolicy2", {
    status: "ON",
    startTime: "12:00",
    retainFirstBackup: "N",
    rententionNum: 5,
    frequency: 3,
    resources: [volumeId],
});
Copy
import pulumi
import pulumi_opentelekomcloud as opentelekomcloud

config = pulumi.Config()
volume_id = config.require_object("volumeId")
vbs_policy2 = opentelekomcloud.VbsBackupPolicyV2("vbsPolicy2",
    status="ON",
    start_time="12:00",
    retain_first_backup="N",
    rentention_num=5,
    frequency=3,
    resources=[volume_id])
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, "")
		volumeId := cfg.RequireObject("volumeId")
		_, err := opentelekomcloud.NewVbsBackupPolicyV2(ctx, "vbsPolicy2", &opentelekomcloud.VbsBackupPolicyV2Args{
			Status:            pulumi.String("ON"),
			StartTime:         pulumi.String("12:00"),
			RetainFirstBackup: pulumi.String("N"),
			RententionNum:     pulumi.Float64(5),
			Frequency:         pulumi.Float64(3),
			Resources: pulumi.StringArray{
				volumeId,
			},
		})
		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 volumeId = config.RequireObject<dynamic>("volumeId");
    var vbsPolicy2 = new Opentelekomcloud.VbsBackupPolicyV2("vbsPolicy2", new()
    {
        Status = "ON",
        StartTime = "12:00",
        RetainFirstBackup = "N",
        RententionNum = 5,
        Frequency = 3,
        Resources = new[]
        {
            volumeId,
        },
    });

});
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.opentelekomcloud.VbsBackupPolicyV2;
import com.pulumi.opentelekomcloud.VbsBackupPolicyV2Args;
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 volumeId = config.get("volumeId");
        var vbsPolicy2 = new VbsBackupPolicyV2("vbsPolicy2", VbsBackupPolicyV2Args.builder()
            .status("ON")
            .startTime("12:00")
            .retainFirstBackup("N")
            .rententionNum(5)
            .frequency(3)
            .resources(volumeId)
            .build());

    }
}
Copy
configuration:
  volumeId:
    type: dynamic
resources:
  vbsPolicy2:
    type: opentelekomcloud:VbsBackupPolicyV2
    properties:
      status: ON
      startTime: 12:00
      retainFirstBackup: N
      rententionNum: 5
      frequency: 3
      resources:
        - ${volumeId}
Copy

Create VbsBackupPolicyV2 Resource

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

Constructor syntax

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

@overload
def VbsBackupPolicyV2(resource_name: str,
                      opts: Optional[ResourceOptions] = None,
                      retain_first_backup: Optional[str] = None,
                      start_time: Optional[str] = None,
                      rentention_day: Optional[float] = None,
                      frequency: Optional[float] = None,
                      rentention_num: Optional[float] = None,
                      resources: Optional[Sequence[str]] = None,
                      region: Optional[str] = None,
                      name: Optional[str] = None,
                      status: Optional[str] = None,
                      tags: Optional[Sequence[VbsBackupPolicyV2TagArgs]] = None,
                      timeouts: Optional[VbsBackupPolicyV2TimeoutsArgs] = None,
                      vbs_backup_policy_v2_id: Optional[str] = None,
                      week_frequencies: Optional[Sequence[str]] = None)
func NewVbsBackupPolicyV2(ctx *Context, name string, args VbsBackupPolicyV2Args, opts ...ResourceOption) (*VbsBackupPolicyV2, error)
public VbsBackupPolicyV2(string name, VbsBackupPolicyV2Args args, CustomResourceOptions? opts = null)
public VbsBackupPolicyV2(String name, VbsBackupPolicyV2Args args)
public VbsBackupPolicyV2(String name, VbsBackupPolicyV2Args args, CustomResourceOptions options)

type: opentelekomcloud:VbsBackupPolicyV2
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. VbsBackupPolicyV2Args
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. VbsBackupPolicyV2Args
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. VbsBackupPolicyV2Args
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. VbsBackupPolicyV2Args
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. VbsBackupPolicyV2Args
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 vbsBackupPolicyV2Resource = new Opentelekomcloud.VbsBackupPolicyV2("vbsBackupPolicyV2Resource", new()
{
    RetainFirstBackup = "string",
    StartTime = "string",
    RententionDay = 0,
    Frequency = 0,
    RententionNum = 0,
    Resources = new[]
    {
        "string",
    },
    Region = "string",
    Name = "string",
    Status = "string",
    Tags = new[]
    {
        new Opentelekomcloud.Inputs.VbsBackupPolicyV2TagArgs
        {
            Key = "string",
            Value = "string",
        },
    },
    Timeouts = new Opentelekomcloud.Inputs.VbsBackupPolicyV2TimeoutsArgs
    {
        Create = "string",
        Delete = "string",
    },
    VbsBackupPolicyV2Id = "string",
    WeekFrequencies = new[]
    {
        "string",
    },
});
Copy
example, err := opentelekomcloud.NewVbsBackupPolicyV2(ctx, "vbsBackupPolicyV2Resource", &opentelekomcloud.VbsBackupPolicyV2Args{
	RetainFirstBackup: pulumi.String("string"),
	StartTime:         pulumi.String("string"),
	RententionDay:     pulumi.Float64(0),
	Frequency:         pulumi.Float64(0),
	RententionNum:     pulumi.Float64(0),
	Resources: pulumi.StringArray{
		pulumi.String("string"),
	},
	Region: pulumi.String("string"),
	Name:   pulumi.String("string"),
	Status: pulumi.String("string"),
	Tags: opentelekomcloud.VbsBackupPolicyV2TagArray{
		&opentelekomcloud.VbsBackupPolicyV2TagArgs{
			Key:   pulumi.String("string"),
			Value: pulumi.String("string"),
		},
	},
	Timeouts: &opentelekomcloud.VbsBackupPolicyV2TimeoutsArgs{
		Create: pulumi.String("string"),
		Delete: pulumi.String("string"),
	},
	VbsBackupPolicyV2Id: pulumi.String("string"),
	WeekFrequencies: pulumi.StringArray{
		pulumi.String("string"),
	},
})
Copy
var vbsBackupPolicyV2Resource = new VbsBackupPolicyV2("vbsBackupPolicyV2Resource", VbsBackupPolicyV2Args.builder()
    .retainFirstBackup("string")
    .startTime("string")
    .rententionDay(0)
    .frequency(0)
    .rententionNum(0)
    .resources("string")
    .region("string")
    .name("string")
    .status("string")
    .tags(VbsBackupPolicyV2TagArgs.builder()
        .key("string")
        .value("string")
        .build())
    .timeouts(VbsBackupPolicyV2TimeoutsArgs.builder()
        .create("string")
        .delete("string")
        .build())
    .vbsBackupPolicyV2Id("string")
    .weekFrequencies("string")
    .build());
Copy
vbs_backup_policy_v2_resource = opentelekomcloud.VbsBackupPolicyV2("vbsBackupPolicyV2Resource",
    retain_first_backup="string",
    start_time="string",
    rentention_day=0,
    frequency=0,
    rentention_num=0,
    resources=["string"],
    region="string",
    name="string",
    status="string",
    tags=[{
        "key": "string",
        "value": "string",
    }],
    timeouts={
        "create": "string",
        "delete": "string",
    },
    vbs_backup_policy_v2_id="string",
    week_frequencies=["string"])
Copy
const vbsBackupPolicyV2Resource = new opentelekomcloud.VbsBackupPolicyV2("vbsBackupPolicyV2Resource", {
    retainFirstBackup: "string",
    startTime: "string",
    rententionDay: 0,
    frequency: 0,
    rententionNum: 0,
    resources: ["string"],
    region: "string",
    name: "string",
    status: "string",
    tags: [{
        key: "string",
        value: "string",
    }],
    timeouts: {
        create: "string",
        "delete": "string",
    },
    vbsBackupPolicyV2Id: "string",
    weekFrequencies: ["string"],
});
Copy
type: opentelekomcloud:VbsBackupPolicyV2
properties:
    frequency: 0
    name: string
    region: string
    rententionDay: 0
    rententionNum: 0
    resources:
        - string
    retainFirstBackup: string
    startTime: string
    status: string
    tags:
        - key: string
          value: string
    timeouts:
        create: string
        delete: string
    vbsBackupPolicyV2Id: string
    weekFrequencies:
        - string
Copy

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

RetainFirstBackup This property is required. string
Specifies whether to retain the first backup in the current month. Possible values are Y or N.
StartTime This property is required. string
Specifies the start time(UTC) of the backup job. The value is in the HH:mm format. You need to set the execution time on a full hour. You can set multiple execution times, and use commas (,) to separate one time from another.
Frequency double
Specifies the backup interval. The value is in the range of 1 to 14 days. Either this field or week_frequency must be specified.
Name string
Specifies the policy name. The value is a string of 1 to 64 characters that can contain letters, digits, underscores (_), and hyphens (-). It cannot start with default.
Region string
RententionDay double
Specifies days of retained backups. Minimum value is 2. Either this field or rentention_num must be specified.
RententionNum double
Specifies number of retained backups. Minimum value is 2. Either this field or rentention_day must be specified.
Resources List<string>
Specifies one or more volumes associated with the backup policy. Any previously associated backup policy will no longer apply.
Status string
Specifies the backup policy status. Possible values are ON or OFF. Defaults to ON.
Tags List<VbsBackupPolicyV2Tag>
Represents the list of tags to be configured for the backup policy.
Timeouts VbsBackupPolicyV2Timeouts
VbsBackupPolicyV2Id string
Specifies a backup policy ID.
WeekFrequencies List<string>
Specifies on which days of each week backup jobs are executed. The value can be one or more of the following: "SUN", "MON", "TUE", "WED", "THU", "FRI", "SAT". Either this field or frequency must be specified.
RetainFirstBackup This property is required. string
Specifies whether to retain the first backup in the current month. Possible values are Y or N.
StartTime This property is required. string
Specifies the start time(UTC) of the backup job. The value is in the HH:mm format. You need to set the execution time on a full hour. You can set multiple execution times, and use commas (,) to separate one time from another.
Frequency float64
Specifies the backup interval. The value is in the range of 1 to 14 days. Either this field or week_frequency must be specified.
Name string
Specifies the policy name. The value is a string of 1 to 64 characters that can contain letters, digits, underscores (_), and hyphens (-). It cannot start with default.
Region string
RententionDay float64
Specifies days of retained backups. Minimum value is 2. Either this field or rentention_num must be specified.
RententionNum float64
Specifies number of retained backups. Minimum value is 2. Either this field or rentention_day must be specified.
Resources []string
Specifies one or more volumes associated with the backup policy. Any previously associated backup policy will no longer apply.
Status string
Specifies the backup policy status. Possible values are ON or OFF. Defaults to ON.
Tags []VbsBackupPolicyV2TagArgs
Represents the list of tags to be configured for the backup policy.
Timeouts VbsBackupPolicyV2TimeoutsArgs
VbsBackupPolicyV2Id string
Specifies a backup policy ID.
WeekFrequencies []string
Specifies on which days of each week backup jobs are executed. The value can be one or more of the following: "SUN", "MON", "TUE", "WED", "THU", "FRI", "SAT". Either this field or frequency must be specified.
retainFirstBackup This property is required. String
Specifies whether to retain the first backup in the current month. Possible values are Y or N.
startTime This property is required. String
Specifies the start time(UTC) of the backup job. The value is in the HH:mm format. You need to set the execution time on a full hour. You can set multiple execution times, and use commas (,) to separate one time from another.
frequency Double
Specifies the backup interval. The value is in the range of 1 to 14 days. Either this field or week_frequency must be specified.
name String
Specifies the policy name. The value is a string of 1 to 64 characters that can contain letters, digits, underscores (_), and hyphens (-). It cannot start with default.
region String
rententionDay Double
Specifies days of retained backups. Minimum value is 2. Either this field or rentention_num must be specified.
rententionNum Double
Specifies number of retained backups. Minimum value is 2. Either this field or rentention_day must be specified.
resources List<String>
Specifies one or more volumes associated with the backup policy. Any previously associated backup policy will no longer apply.
status String
Specifies the backup policy status. Possible values are ON or OFF. Defaults to ON.
tags List<VbsBackupPolicyV2Tag>
Represents the list of tags to be configured for the backup policy.
timeouts VbsBackupPolicyV2Timeouts
vbsBackupPolicyV2Id String
Specifies a backup policy ID.
weekFrequencies List<String>
Specifies on which days of each week backup jobs are executed. The value can be one or more of the following: "SUN", "MON", "TUE", "WED", "THU", "FRI", "SAT". Either this field or frequency must be specified.
retainFirstBackup This property is required. string
Specifies whether to retain the first backup in the current month. Possible values are Y or N.
startTime This property is required. string
Specifies the start time(UTC) of the backup job. The value is in the HH:mm format. You need to set the execution time on a full hour. You can set multiple execution times, and use commas (,) to separate one time from another.
frequency number
Specifies the backup interval. The value is in the range of 1 to 14 days. Either this field or week_frequency must be specified.
name string
Specifies the policy name. The value is a string of 1 to 64 characters that can contain letters, digits, underscores (_), and hyphens (-). It cannot start with default.
region string
rententionDay number
Specifies days of retained backups. Minimum value is 2. Either this field or rentention_num must be specified.
rententionNum number
Specifies number of retained backups. Minimum value is 2. Either this field or rentention_day must be specified.
resources string[]
Specifies one or more volumes associated with the backup policy. Any previously associated backup policy will no longer apply.
status string
Specifies the backup policy status. Possible values are ON or OFF. Defaults to ON.
tags VbsBackupPolicyV2Tag[]
Represents the list of tags to be configured for the backup policy.
timeouts VbsBackupPolicyV2Timeouts
vbsBackupPolicyV2Id string
Specifies a backup policy ID.
weekFrequencies string[]
Specifies on which days of each week backup jobs are executed. The value can be one or more of the following: "SUN", "MON", "TUE", "WED", "THU", "FRI", "SAT". Either this field or frequency must be specified.
retain_first_backup This property is required. str
Specifies whether to retain the first backup in the current month. Possible values are Y or N.
start_time This property is required. str
Specifies the start time(UTC) of the backup job. The value is in the HH:mm format. You need to set the execution time on a full hour. You can set multiple execution times, and use commas (,) to separate one time from another.
frequency float
Specifies the backup interval. The value is in the range of 1 to 14 days. Either this field or week_frequency must be specified.
name str
Specifies the policy name. The value is a string of 1 to 64 characters that can contain letters, digits, underscores (_), and hyphens (-). It cannot start with default.
region str
rentention_day float
Specifies days of retained backups. Minimum value is 2. Either this field or rentention_num must be specified.
rentention_num float
Specifies number of retained backups. Minimum value is 2. Either this field or rentention_day must be specified.
resources Sequence[str]
Specifies one or more volumes associated with the backup policy. Any previously associated backup policy will no longer apply.
status str
Specifies the backup policy status. Possible values are ON or OFF. Defaults to ON.
tags Sequence[VbsBackupPolicyV2TagArgs]
Represents the list of tags to be configured for the backup policy.
timeouts VbsBackupPolicyV2TimeoutsArgs
vbs_backup_policy_v2_id str
Specifies a backup policy ID.
week_frequencies Sequence[str]
Specifies on which days of each week backup jobs are executed. The value can be one or more of the following: "SUN", "MON", "TUE", "WED", "THU", "FRI", "SAT". Either this field or frequency must be specified.
retainFirstBackup This property is required. String
Specifies whether to retain the first backup in the current month. Possible values are Y or N.
startTime This property is required. String
Specifies the start time(UTC) of the backup job. The value is in the HH:mm format. You need to set the execution time on a full hour. You can set multiple execution times, and use commas (,) to separate one time from another.
frequency Number
Specifies the backup interval. The value is in the range of 1 to 14 days. Either this field or week_frequency must be specified.
name String
Specifies the policy name. The value is a string of 1 to 64 characters that can contain letters, digits, underscores (_), and hyphens (-). It cannot start with default.
region String
rententionDay Number
Specifies days of retained backups. Minimum value is 2. Either this field or rentention_num must be specified.
rententionNum Number
Specifies number of retained backups. Minimum value is 2. Either this field or rentention_day must be specified.
resources List<String>
Specifies one or more volumes associated with the backup policy. Any previously associated backup policy will no longer apply.
status String
Specifies the backup policy status. Possible values are ON or OFF. Defaults to ON.
tags List<Property Map>
Represents the list of tags to be configured for the backup policy.
timeouts Property Map
vbsBackupPolicyV2Id String
Specifies a backup policy ID.
weekFrequencies List<String>
Specifies on which days of each week backup jobs are executed. The value can be one or more of the following: "SUN", "MON", "TUE", "WED", "THU", "FRI", "SAT". Either this field or frequency must be specified.

Outputs

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

Id string
The provider-assigned unique ID for this managed resource.
PolicyResourceCount double
Specifies the number of volumes associated with the backup policy.
Id string
The provider-assigned unique ID for this managed resource.
PolicyResourceCount float64
Specifies the number of volumes associated with the backup policy.
id String
The provider-assigned unique ID for this managed resource.
policyResourceCount Double
Specifies the number of volumes associated with the backup policy.
id string
The provider-assigned unique ID for this managed resource.
policyResourceCount number
Specifies the number of volumes associated with the backup policy.
id str
The provider-assigned unique ID for this managed resource.
policy_resource_count float
Specifies the number of volumes associated with the backup policy.
id String
The provider-assigned unique ID for this managed resource.
policyResourceCount Number
Specifies the number of volumes associated with the backup policy.

Look up Existing VbsBackupPolicyV2 Resource

Get an existing VbsBackupPolicyV2 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?: VbsBackupPolicyV2State, opts?: CustomResourceOptions): VbsBackupPolicyV2
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        frequency: Optional[float] = None,
        name: Optional[str] = None,
        policy_resource_count: Optional[float] = None,
        region: Optional[str] = None,
        rentention_day: Optional[float] = None,
        rentention_num: Optional[float] = None,
        resources: Optional[Sequence[str]] = None,
        retain_first_backup: Optional[str] = None,
        start_time: Optional[str] = None,
        status: Optional[str] = None,
        tags: Optional[Sequence[VbsBackupPolicyV2TagArgs]] = None,
        timeouts: Optional[VbsBackupPolicyV2TimeoutsArgs] = None,
        vbs_backup_policy_v2_id: Optional[str] = None,
        week_frequencies: Optional[Sequence[str]] = None) -> VbsBackupPolicyV2
func GetVbsBackupPolicyV2(ctx *Context, name string, id IDInput, state *VbsBackupPolicyV2State, opts ...ResourceOption) (*VbsBackupPolicyV2, error)
public static VbsBackupPolicyV2 Get(string name, Input<string> id, VbsBackupPolicyV2State? state, CustomResourceOptions? opts = null)
public static VbsBackupPolicyV2 get(String name, Output<String> id, VbsBackupPolicyV2State state, CustomResourceOptions options)
resources:  _:    type: opentelekomcloud:VbsBackupPolicyV2    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:
Frequency double
Specifies the backup interval. The value is in the range of 1 to 14 days. Either this field or week_frequency must be specified.
Name string
Specifies the policy name. The value is a string of 1 to 64 characters that can contain letters, digits, underscores (_), and hyphens (-). It cannot start with default.
PolicyResourceCount double
Specifies the number of volumes associated with the backup policy.
Region string
RententionDay double
Specifies days of retained backups. Minimum value is 2. Either this field or rentention_num must be specified.
RententionNum double
Specifies number of retained backups. Minimum value is 2. Either this field or rentention_day must be specified.
Resources List<string>
Specifies one or more volumes associated with the backup policy. Any previously associated backup policy will no longer apply.
RetainFirstBackup string
Specifies whether to retain the first backup in the current month. Possible values are Y or N.
StartTime string
Specifies the start time(UTC) of the backup job. The value is in the HH:mm format. You need to set the execution time on a full hour. You can set multiple execution times, and use commas (,) to separate one time from another.
Status string
Specifies the backup policy status. Possible values are ON or OFF. Defaults to ON.
Tags List<VbsBackupPolicyV2Tag>
Represents the list of tags to be configured for the backup policy.
Timeouts VbsBackupPolicyV2Timeouts
VbsBackupPolicyV2Id string
Specifies a backup policy ID.
WeekFrequencies List<string>
Specifies on which days of each week backup jobs are executed. The value can be one or more of the following: "SUN", "MON", "TUE", "WED", "THU", "FRI", "SAT". Either this field or frequency must be specified.
Frequency float64
Specifies the backup interval. The value is in the range of 1 to 14 days. Either this field or week_frequency must be specified.
Name string
Specifies the policy name. The value is a string of 1 to 64 characters that can contain letters, digits, underscores (_), and hyphens (-). It cannot start with default.
PolicyResourceCount float64
Specifies the number of volumes associated with the backup policy.
Region string
RententionDay float64
Specifies days of retained backups. Minimum value is 2. Either this field or rentention_num must be specified.
RententionNum float64
Specifies number of retained backups. Minimum value is 2. Either this field or rentention_day must be specified.
Resources []string
Specifies one or more volumes associated with the backup policy. Any previously associated backup policy will no longer apply.
RetainFirstBackup string
Specifies whether to retain the first backup in the current month. Possible values are Y or N.
StartTime string
Specifies the start time(UTC) of the backup job. The value is in the HH:mm format. You need to set the execution time on a full hour. You can set multiple execution times, and use commas (,) to separate one time from another.
Status string
Specifies the backup policy status. Possible values are ON or OFF. Defaults to ON.
Tags []VbsBackupPolicyV2TagArgs
Represents the list of tags to be configured for the backup policy.
Timeouts VbsBackupPolicyV2TimeoutsArgs
VbsBackupPolicyV2Id string
Specifies a backup policy ID.
WeekFrequencies []string
Specifies on which days of each week backup jobs are executed. The value can be one or more of the following: "SUN", "MON", "TUE", "WED", "THU", "FRI", "SAT". Either this field or frequency must be specified.
frequency Double
Specifies the backup interval. The value is in the range of 1 to 14 days. Either this field or week_frequency must be specified.
name String
Specifies the policy name. The value is a string of 1 to 64 characters that can contain letters, digits, underscores (_), and hyphens (-). It cannot start with default.
policyResourceCount Double
Specifies the number of volumes associated with the backup policy.
region String
rententionDay Double
Specifies days of retained backups. Minimum value is 2. Either this field or rentention_num must be specified.
rententionNum Double
Specifies number of retained backups. Minimum value is 2. Either this field or rentention_day must be specified.
resources List<String>
Specifies one or more volumes associated with the backup policy. Any previously associated backup policy will no longer apply.
retainFirstBackup String
Specifies whether to retain the first backup in the current month. Possible values are Y or N.
startTime String
Specifies the start time(UTC) of the backup job. The value is in the HH:mm format. You need to set the execution time on a full hour. You can set multiple execution times, and use commas (,) to separate one time from another.
status String
Specifies the backup policy status. Possible values are ON or OFF. Defaults to ON.
tags List<VbsBackupPolicyV2Tag>
Represents the list of tags to be configured for the backup policy.
timeouts VbsBackupPolicyV2Timeouts
vbsBackupPolicyV2Id String
Specifies a backup policy ID.
weekFrequencies List<String>
Specifies on which days of each week backup jobs are executed. The value can be one or more of the following: "SUN", "MON", "TUE", "WED", "THU", "FRI", "SAT". Either this field or frequency must be specified.
frequency number
Specifies the backup interval. The value is in the range of 1 to 14 days. Either this field or week_frequency must be specified.
name string
Specifies the policy name. The value is a string of 1 to 64 characters that can contain letters, digits, underscores (_), and hyphens (-). It cannot start with default.
policyResourceCount number
Specifies the number of volumes associated with the backup policy.
region string
rententionDay number
Specifies days of retained backups. Minimum value is 2. Either this field or rentention_num must be specified.
rententionNum number
Specifies number of retained backups. Minimum value is 2. Either this field or rentention_day must be specified.
resources string[]
Specifies one or more volumes associated with the backup policy. Any previously associated backup policy will no longer apply.
retainFirstBackup string
Specifies whether to retain the first backup in the current month. Possible values are Y or N.
startTime string
Specifies the start time(UTC) of the backup job. The value is in the HH:mm format. You need to set the execution time on a full hour. You can set multiple execution times, and use commas (,) to separate one time from another.
status string
Specifies the backup policy status. Possible values are ON or OFF. Defaults to ON.
tags VbsBackupPolicyV2Tag[]
Represents the list of tags to be configured for the backup policy.
timeouts VbsBackupPolicyV2Timeouts
vbsBackupPolicyV2Id string
Specifies a backup policy ID.
weekFrequencies string[]
Specifies on which days of each week backup jobs are executed. The value can be one or more of the following: "SUN", "MON", "TUE", "WED", "THU", "FRI", "SAT". Either this field or frequency must be specified.
frequency float
Specifies the backup interval. The value is in the range of 1 to 14 days. Either this field or week_frequency must be specified.
name str
Specifies the policy name. The value is a string of 1 to 64 characters that can contain letters, digits, underscores (_), and hyphens (-). It cannot start with default.
policy_resource_count float
Specifies the number of volumes associated with the backup policy.
region str
rentention_day float
Specifies days of retained backups. Minimum value is 2. Either this field or rentention_num must be specified.
rentention_num float
Specifies number of retained backups. Minimum value is 2. Either this field or rentention_day must be specified.
resources Sequence[str]
Specifies one or more volumes associated with the backup policy. Any previously associated backup policy will no longer apply.
retain_first_backup str
Specifies whether to retain the first backup in the current month. Possible values are Y or N.
start_time str
Specifies the start time(UTC) of the backup job. The value is in the HH:mm format. You need to set the execution time on a full hour. You can set multiple execution times, and use commas (,) to separate one time from another.
status str
Specifies the backup policy status. Possible values are ON or OFF. Defaults to ON.
tags Sequence[VbsBackupPolicyV2TagArgs]
Represents the list of tags to be configured for the backup policy.
timeouts VbsBackupPolicyV2TimeoutsArgs
vbs_backup_policy_v2_id str
Specifies a backup policy ID.
week_frequencies Sequence[str]
Specifies on which days of each week backup jobs are executed. The value can be one or more of the following: "SUN", "MON", "TUE", "WED", "THU", "FRI", "SAT". Either this field or frequency must be specified.
frequency Number
Specifies the backup interval. The value is in the range of 1 to 14 days. Either this field or week_frequency must be specified.
name String
Specifies the policy name. The value is a string of 1 to 64 characters that can contain letters, digits, underscores (_), and hyphens (-). It cannot start with default.
policyResourceCount Number
Specifies the number of volumes associated with the backup policy.
region String
rententionDay Number
Specifies days of retained backups. Minimum value is 2. Either this field or rentention_num must be specified.
rententionNum Number
Specifies number of retained backups. Minimum value is 2. Either this field or rentention_day must be specified.
resources List<String>
Specifies one or more volumes associated with the backup policy. Any previously associated backup policy will no longer apply.
retainFirstBackup String
Specifies whether to retain the first backup in the current month. Possible values are Y or N.
startTime String
Specifies the start time(UTC) of the backup job. The value is in the HH:mm format. You need to set the execution time on a full hour. You can set multiple execution times, and use commas (,) to separate one time from another.
status String
Specifies the backup policy status. Possible values are ON or OFF. Defaults to ON.
tags List<Property Map>
Represents the list of tags to be configured for the backup policy.
timeouts Property Map
vbsBackupPolicyV2Id String
Specifies a backup policy ID.
weekFrequencies List<String>
Specifies on which days of each week backup jobs are executed. The value can be one or more of the following: "SUN", "MON", "TUE", "WED", "THU", "FRI", "SAT". Either this field or frequency must be specified.

Supporting Types

VbsBackupPolicyV2Tag
, VbsBackupPolicyV2TagArgs

Key This property is required. string
Specifies the tag key. A tag key consists of up to 36 characters, chosen from letters, digits, hyphens (-), and underscores (_).
Value This property is required. string
Specifies the tag value. A tag value consists of 0 to 43 characters, chosen from letters, digits, hyphens (-), and underscores (_).
Key This property is required. string
Specifies the tag key. A tag key consists of up to 36 characters, chosen from letters, digits, hyphens (-), and underscores (_).
Value This property is required. string
Specifies the tag value. A tag value consists of 0 to 43 characters, chosen from letters, digits, hyphens (-), and underscores (_).
key This property is required. String
Specifies the tag key. A tag key consists of up to 36 characters, chosen from letters, digits, hyphens (-), and underscores (_).
value This property is required. String
Specifies the tag value. A tag value consists of 0 to 43 characters, chosen from letters, digits, hyphens (-), and underscores (_).
key This property is required. string
Specifies the tag key. A tag key consists of up to 36 characters, chosen from letters, digits, hyphens (-), and underscores (_).
value This property is required. string
Specifies the tag value. A tag value consists of 0 to 43 characters, chosen from letters, digits, hyphens (-), and underscores (_).
key This property is required. str
Specifies the tag key. A tag key consists of up to 36 characters, chosen from letters, digits, hyphens (-), and underscores (_).
value This property is required. str
Specifies the tag value. A tag value consists of 0 to 43 characters, chosen from letters, digits, hyphens (-), and underscores (_).
key This property is required. String
Specifies the tag key. A tag key consists of up to 36 characters, chosen from letters, digits, hyphens (-), and underscores (_).
value This property is required. String
Specifies the tag value. A tag value consists of 0 to 43 characters, chosen from letters, digits, hyphens (-), and underscores (_).

VbsBackupPolicyV2Timeouts
, VbsBackupPolicyV2TimeoutsArgs

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

Backup Policy can be imported using the id, e.g.

$ pulumi import opentelekomcloud:index/vbsBackupPolicyV2:VbsBackupPolicyV2 vbs 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.
opentelekomcloud 1.36.35 published on Monday, Apr 14, 2025 by opentelekomcloud
opentelekomcloud/terraform-provider-opentelekomcloud