1. Packages
  2. Alibaba Cloud Provider
  3. API Docs
  4. hbr
  5. getOtsBackupPlans
Alibaba Cloud v3.76.0 published on Tuesday, Apr 8, 2025 by Pulumi

alicloud.hbr.getOtsBackupPlans

Explore with Pulumi AI

Alibaba Cloud v3.76.0 published on Tuesday, Apr 8, 2025 by Pulumi

This data source provides the Hbr OtsBackupPlans of the current Alibaba Cloud user.

NOTE: Available in v1.163.0+.

Example Usage

Basic Usage

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

const ids = alicloud.hbr.getOtsBackupPlans({
    nameRegex: "^my-otsBackupPlan",
});
export const hbrOtsBackupPlanId = plans[0].id;
Copy
import pulumi
import pulumi_alicloud as alicloud

ids = alicloud.hbr.get_ots_backup_plans(name_regex="^my-otsBackupPlan")
pulumi.export("hbrOtsBackupPlanId", plans[0]["id"])
Copy
package main

import (
	"github.com/pulumi/pulumi-alicloud/sdk/v3/go/alicloud/hbr"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := hbr.GetOtsBackupPlans(ctx, &hbr.GetOtsBackupPlansArgs{
			NameRegex: pulumi.StringRef("^my-otsBackupPlan"),
		}, nil)
		if err != nil {
			return err
		}
		ctx.Export("hbrOtsBackupPlanId", plans[0].Id)
		return nil
	})
}
Copy
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using AliCloud = Pulumi.AliCloud;

return await Deployment.RunAsync(() => 
{
    var ids = AliCloud.Hbr.GetOtsBackupPlans.Invoke(new()
    {
        NameRegex = "^my-otsBackupPlan",
    });

    return new Dictionary<string, object?>
    {
        ["hbrOtsBackupPlanId"] = plans[0].Id,
    };
});
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.alicloud.hbr.HbrFunctions;
import com.pulumi.alicloud.hbr.inputs.GetOtsBackupPlansArgs;
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 ids = HbrFunctions.getOtsBackupPlans(GetOtsBackupPlansArgs.builder()
            .nameRegex("^my-otsBackupPlan")
            .build());

        ctx.export("hbrOtsBackupPlanId", plans[0].id());
    }
}
Copy
variables:
  ids:
    fn::invoke:
      function: alicloud:hbr:getOtsBackupPlans
      arguments:
        nameRegex: ^my-otsBackupPlan
outputs:
  hbrOtsBackupPlanId: ${plans[0].id}
Copy

Using getOtsBackupPlans

Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

function getOtsBackupPlans(args: GetOtsBackupPlansArgs, opts?: InvokeOptions): Promise<GetOtsBackupPlansResult>
function getOtsBackupPlansOutput(args: GetOtsBackupPlansOutputArgs, opts?: InvokeOptions): Output<GetOtsBackupPlansResult>
Copy
def get_ots_backup_plans(ids: Optional[Sequence[str]] = None,
                         name_regex: Optional[str] = None,
                         output_file: Optional[str] = None,
                         plan_id: Optional[str] = None,
                         plan_name: Optional[str] = None,
                         vault_id: Optional[str] = None,
                         opts: Optional[InvokeOptions] = None) -> GetOtsBackupPlansResult
def get_ots_backup_plans_output(ids: Optional[pulumi.Input[Sequence[pulumi.Input[str]]]] = None,
                         name_regex: Optional[pulumi.Input[str]] = None,
                         output_file: Optional[pulumi.Input[str]] = None,
                         plan_id: Optional[pulumi.Input[str]] = None,
                         plan_name: Optional[pulumi.Input[str]] = None,
                         vault_id: Optional[pulumi.Input[str]] = None,
                         opts: Optional[InvokeOptions] = None) -> Output[GetOtsBackupPlansResult]
Copy
func GetOtsBackupPlans(ctx *Context, args *GetOtsBackupPlansArgs, opts ...InvokeOption) (*GetOtsBackupPlansResult, error)
func GetOtsBackupPlansOutput(ctx *Context, args *GetOtsBackupPlansOutputArgs, opts ...InvokeOption) GetOtsBackupPlansResultOutput
Copy

> Note: This function is named GetOtsBackupPlans in the Go SDK.

public static class GetOtsBackupPlans 
{
    public static Task<GetOtsBackupPlansResult> InvokeAsync(GetOtsBackupPlansArgs args, InvokeOptions? opts = null)
    public static Output<GetOtsBackupPlansResult> Invoke(GetOtsBackupPlansInvokeArgs args, InvokeOptions? opts = null)
}
Copy
public static CompletableFuture<GetOtsBackupPlansResult> getOtsBackupPlans(GetOtsBackupPlansArgs args, InvokeOptions options)
public static Output<GetOtsBackupPlansResult> getOtsBackupPlans(GetOtsBackupPlansArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: alicloud:hbr/getOtsBackupPlans:getOtsBackupPlans
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

Ids Changes to this property will trigger replacement. List<string>
A list of OtsBackupPlan IDs.
NameRegex Changes to this property will trigger replacement. string
A regex string to filter results by OtsBackupPlan name.
OutputFile string
File name where to save data source results (after running pulumi preview).
PlanId Changes to this property will trigger replacement. string
The ID of the backup plan.
PlanName Changes to this property will trigger replacement. string
The ID of the backup plan.
VaultId Changes to this property will trigger replacement. string
The ID of backup vault the OtsBackupPlan used.
Ids Changes to this property will trigger replacement. []string
A list of OtsBackupPlan IDs.
NameRegex Changes to this property will trigger replacement. string
A regex string to filter results by OtsBackupPlan name.
OutputFile string
File name where to save data source results (after running pulumi preview).
PlanId Changes to this property will trigger replacement. string
The ID of the backup plan.
PlanName Changes to this property will trigger replacement. string
The ID of the backup plan.
VaultId Changes to this property will trigger replacement. string
The ID of backup vault the OtsBackupPlan used.
ids Changes to this property will trigger replacement. List<String>
A list of OtsBackupPlan IDs.
nameRegex Changes to this property will trigger replacement. String
A regex string to filter results by OtsBackupPlan name.
outputFile String
File name where to save data source results (after running pulumi preview).
planId Changes to this property will trigger replacement. String
The ID of the backup plan.
planName Changes to this property will trigger replacement. String
The ID of the backup plan.
vaultId Changes to this property will trigger replacement. String
The ID of backup vault the OtsBackupPlan used.
ids Changes to this property will trigger replacement. string[]
A list of OtsBackupPlan IDs.
nameRegex Changes to this property will trigger replacement. string
A regex string to filter results by OtsBackupPlan name.
outputFile string
File name where to save data source results (after running pulumi preview).
planId Changes to this property will trigger replacement. string
The ID of the backup plan.
planName Changes to this property will trigger replacement. string
The ID of the backup plan.
vaultId Changes to this property will trigger replacement. string
The ID of backup vault the OtsBackupPlan used.
ids Changes to this property will trigger replacement. Sequence[str]
A list of OtsBackupPlan IDs.
name_regex Changes to this property will trigger replacement. str
A regex string to filter results by OtsBackupPlan name.
output_file str
File name where to save data source results (after running pulumi preview).
plan_id Changes to this property will trigger replacement. str
The ID of the backup plan.
plan_name Changes to this property will trigger replacement. str
The ID of the backup plan.
vault_id Changes to this property will trigger replacement. str
The ID of backup vault the OtsBackupPlan used.
ids Changes to this property will trigger replacement. List<String>
A list of OtsBackupPlan IDs.
nameRegex Changes to this property will trigger replacement. String
A regex string to filter results by OtsBackupPlan name.
outputFile String
File name where to save data source results (after running pulumi preview).
planId Changes to this property will trigger replacement. String
The ID of the backup plan.
planName Changes to this property will trigger replacement. String
The ID of the backup plan.
vaultId Changes to this property will trigger replacement. String
The ID of backup vault the OtsBackupPlan used.

getOtsBackupPlans Result

The following output properties are available:

Id string
The provider-assigned unique ID for this managed resource.
Ids List<string>
Names List<string>
Plans List<Pulumi.AliCloud.Hbr.Outputs.GetOtsBackupPlansPlan>
NameRegex string
OutputFile string
PlanId string
PlanName string
VaultId string
Id string
The provider-assigned unique ID for this managed resource.
Ids []string
Names []string
Plans []GetOtsBackupPlansPlan
NameRegex string
OutputFile string
PlanId string
PlanName string
VaultId string
id String
The provider-assigned unique ID for this managed resource.
ids List<String>
names List<String>
plans List<GetOtsBackupPlansPlan>
nameRegex String
outputFile String
planId String
planName String
vaultId String
id string
The provider-assigned unique ID for this managed resource.
ids string[]
names string[]
plans GetOtsBackupPlansPlan[]
nameRegex string
outputFile string
planId string
planName string
vaultId string
id str
The provider-assigned unique ID for this managed resource.
ids Sequence[str]
names Sequence[str]
plans Sequence[GetOtsBackupPlansPlan]
name_regex str
output_file str
plan_id str
plan_name str
vault_id str
id String
The provider-assigned unique ID for this managed resource.
ids List<String>
names List<String>
plans List<Property Map>
nameRegex String
outputFile String
planId String
planName String
vaultId String

Supporting Types

GetOtsBackupPlansPlan

BackupType This property is required. string
The Backup type. Valid values: COMPLETE.
CreatedTime This property is required. string
The creation time of the backup plan. UNIX time in seconds.
Disabled This property is required. bool
Whether to be suspended. Valid values: true, false.
Id This property is required. string
The ID of ots backup plan.
OtsBackupPlanId This property is required. string
The ID of ots backup plan.
OtsBackupPlanName This property is required. string
The name of the backup plan. 1~64 characters, the backup plan name of each data source type in a single warehouse required to be unique.
OtsDetails This property is required. List<Pulumi.AliCloud.Hbr.Inputs.GetOtsBackupPlansPlanOtsDetail>
Retention This property is required. string
The Backup retention days, the minimum is 1.
Schedule This property is required. string
The Backup strategy. Optional format: I|{startTime}|{interval}. It means to execute a backup task every {interval} starting from {startTime}. The backup task for the elapsed time will not be compensated. If the last backup task is not completed yet, the next backup task will not be triggered.

  • startTime Backup start time, UNIX time seconds.
SourceType This property is required. string
The type of the data source.
UpdatedTime This property is required. string
The update time of the backup plan. UNIX time in seconds. *ots_detail - The details about the Tablestore instance.
VaultId This property is required. string
The ID of backup vault.
BackupType This property is required. string
The Backup type. Valid values: COMPLETE.
CreatedTime This property is required. string
The creation time of the backup plan. UNIX time in seconds.
Disabled This property is required. bool
Whether to be suspended. Valid values: true, false.
Id This property is required. string
The ID of ots backup plan.
OtsBackupPlanId This property is required. string
The ID of ots backup plan.
OtsBackupPlanName This property is required. string
The name of the backup plan. 1~64 characters, the backup plan name of each data source type in a single warehouse required to be unique.
OtsDetails This property is required. []GetOtsBackupPlansPlanOtsDetail
Retention This property is required. string
The Backup retention days, the minimum is 1.
Schedule This property is required. string
The Backup strategy. Optional format: I|{startTime}|{interval}. It means to execute a backup task every {interval} starting from {startTime}. The backup task for the elapsed time will not be compensated. If the last backup task is not completed yet, the next backup task will not be triggered.

  • startTime Backup start time, UNIX time seconds.
SourceType This property is required. string
The type of the data source.
UpdatedTime This property is required. string
The update time of the backup plan. UNIX time in seconds. *ots_detail - The details about the Tablestore instance.
VaultId This property is required. string
The ID of backup vault.
backupType This property is required. String
The Backup type. Valid values: COMPLETE.
createdTime This property is required. String
The creation time of the backup plan. UNIX time in seconds.
disabled This property is required. Boolean
Whether to be suspended. Valid values: true, false.
id This property is required. String
The ID of ots backup plan.
otsBackupPlanId This property is required. String
The ID of ots backup plan.
otsBackupPlanName This property is required. String
The name of the backup plan. 1~64 characters, the backup plan name of each data source type in a single warehouse required to be unique.
otsDetails This property is required. List<GetOtsBackupPlansPlanOtsDetail>
retention This property is required. String
The Backup retention days, the minimum is 1.
schedule This property is required. String
The Backup strategy. Optional format: I|{startTime}|{interval}. It means to execute a backup task every {interval} starting from {startTime}. The backup task for the elapsed time will not be compensated. If the last backup task is not completed yet, the next backup task will not be triggered.

  • startTime Backup start time, UNIX time seconds.
sourceType This property is required. String
The type of the data source.
updatedTime This property is required. String
The update time of the backup plan. UNIX time in seconds. *ots_detail - The details about the Tablestore instance.
vaultId This property is required. String
The ID of backup vault.
backupType This property is required. string
The Backup type. Valid values: COMPLETE.
createdTime This property is required. string
The creation time of the backup plan. UNIX time in seconds.
disabled This property is required. boolean
Whether to be suspended. Valid values: true, false.
id This property is required. string
The ID of ots backup plan.
otsBackupPlanId This property is required. string
The ID of ots backup plan.
otsBackupPlanName This property is required. string
The name of the backup plan. 1~64 characters, the backup plan name of each data source type in a single warehouse required to be unique.
otsDetails This property is required. GetOtsBackupPlansPlanOtsDetail[]
retention This property is required. string
The Backup retention days, the minimum is 1.
schedule This property is required. string
The Backup strategy. Optional format: I|{startTime}|{interval}. It means to execute a backup task every {interval} starting from {startTime}. The backup task for the elapsed time will not be compensated. If the last backup task is not completed yet, the next backup task will not be triggered.

  • startTime Backup start time, UNIX time seconds.
sourceType This property is required. string
The type of the data source.
updatedTime This property is required. string
The update time of the backup plan. UNIX time in seconds. *ots_detail - The details about the Tablestore instance.
vaultId This property is required. string
The ID of backup vault.
backup_type This property is required. str
The Backup type. Valid values: COMPLETE.
created_time This property is required. str
The creation time of the backup plan. UNIX time in seconds.
disabled This property is required. bool
Whether to be suspended. Valid values: true, false.
id This property is required. str
The ID of ots backup plan.
ots_backup_plan_id This property is required. str
The ID of ots backup plan.
ots_backup_plan_name This property is required. str
The name of the backup plan. 1~64 characters, the backup plan name of each data source type in a single warehouse required to be unique.
ots_details This property is required. Sequence[GetOtsBackupPlansPlanOtsDetail]
retention This property is required. str
The Backup retention days, the minimum is 1.
schedule This property is required. str
The Backup strategy. Optional format: I|{startTime}|{interval}. It means to execute a backup task every {interval} starting from {startTime}. The backup task for the elapsed time will not be compensated. If the last backup task is not completed yet, the next backup task will not be triggered.

  • startTime Backup start time, UNIX time seconds.
source_type This property is required. str
The type of the data source.
updated_time This property is required. str
The update time of the backup plan. UNIX time in seconds. *ots_detail - The details about the Tablestore instance.
vault_id This property is required. str
The ID of backup vault.
backupType This property is required. String
The Backup type. Valid values: COMPLETE.
createdTime This property is required. String
The creation time of the backup plan. UNIX time in seconds.
disabled This property is required. Boolean
Whether to be suspended. Valid values: true, false.
id This property is required. String
The ID of ots backup plan.
otsBackupPlanId This property is required. String
The ID of ots backup plan.
otsBackupPlanName This property is required. String
The name of the backup plan. 1~64 characters, the backup plan name of each data source type in a single warehouse required to be unique.
otsDetails This property is required. List<Property Map>
retention This property is required. String
The Backup retention days, the minimum is 1.
schedule This property is required. String
The Backup strategy. Optional format: I|{startTime}|{interval}. It means to execute a backup task every {interval} starting from {startTime}. The backup task for the elapsed time will not be compensated. If the last backup task is not completed yet, the next backup task will not be triggered.

  • startTime Backup start time, UNIX time seconds.
sourceType This property is required. String
The type of the data source.
updatedTime This property is required. String
The update time of the backup plan. UNIX time in seconds. *ots_detail - The details about the Tablestore instance.
vaultId This property is required. String
The ID of backup vault.

GetOtsBackupPlansPlanOtsDetail

TableNames This property is required. List<string>
TableNames This property is required. []string
tableNames This property is required. List<String>
tableNames This property is required. string[]
table_names This property is required. Sequence[str]
tableNames This property is required. List<String>

Package Details

Repository
Alibaba Cloud pulumi/pulumi-alicloud
License
Apache-2.0
Notes
This Pulumi package is based on the alicloud Terraform Provider.
Alibaba Cloud v3.76.0 published on Tuesday, Apr 8, 2025 by Pulumi