Alibaba Cloud v3.76.0, Apr 8 25

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

alicloud.hbr.getOssBackupPlans

Explore with Pulumi AI

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

Example Usage

Basic Usage

TypeScript
Python
Go
C#
Java
YAML

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

const ids = alicloud.hbr.getOssBackupPlans({
    nameRegex: "^my-OssBackupPlan",
});
export const hbrOssBackupPlanId = ids.then(ids => ids.plans?.[0]?.id);

import pulumi
import pulumi_alicloud as alicloud

ids = alicloud.hbr.get_oss_backup_plans(name_regex="^my-OssBackupPlan")
pulumi.export("hbrOssBackupPlanId", ids.plans[0].id)

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 {
		ids, err := hbr.GetOssBackupPlans(ctx, &hbr.GetOssBackupPlansArgs{
			NameRegex: pulumi.StringRef("^my-OssBackupPlan"),
		}, nil)
		if err != nil {
			return err
		}
		ctx.Export("hbrOssBackupPlanId", ids.Plans[0].Id)
		return nil
	})
}

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

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

    return new Dictionary<string, object?>
    {
        ["hbrOssBackupPlanId"] = ids.Apply(getOssBackupPlansResult => getOssBackupPlansResult.Plans[0]?.Id),
    };
});

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.GetOssBackupPlansArgs;
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.getOssBackupPlans(GetOssBackupPlansArgs.builder()
            .nameRegex("^my-OssBackupPlan")
            .build());

        ctx.export("hbrOssBackupPlanId", ids.applyValue(getOssBackupPlansResult -> getOssBackupPlansResult.plans()[0].id()));
    }
}

variables:
  ids:
    fn::invoke:
      function: alicloud:hbr:getOssBackupPlans
      arguments:
        nameRegex: ^my-OssBackupPlan
outputs:
  hbrOssBackupPlanId: ${ids.plans[0].id}

Using getOssBackupPlans

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.

TypeScript
Python
Go
C#
Java
YAML

function getOssBackupPlans(args: GetOssBackupPlansArgs, opts?: InvokeOptions): Promise<GetOssBackupPlansResult>
function getOssBackupPlansOutput(args: GetOssBackupPlansOutputArgs, opts?: InvokeOptions): Output<GetOssBackupPlansResult>

def get_oss_backup_plans(bucket: Optional[str] = None,
                         ids: Optional[Sequence[str]] = None,
                         name_regex: Optional[str] = None,
                         output_file: Optional[str] = None,
                         vault_id: Optional[str] = None,
                         opts: Optional[InvokeOptions] = None) -> GetOssBackupPlansResult
def get_oss_backup_plans_output(bucket: Optional[pulumi.Input[str]] = None,
                         ids: Optional[pulumi.Input[Sequence[pulumi.Input[str]]]] = None,
                         name_regex: Optional[pulumi.Input[str]] = None,
                         output_file: Optional[pulumi.Input[str]] = None,
                         vault_id: Optional[pulumi.Input[str]] = None,
                         opts: Optional[InvokeOptions] = None) -> Output[GetOssBackupPlansResult]

func GetOssBackupPlans(ctx *Context, args *GetOssBackupPlansArgs, opts ...InvokeOption) (*GetOssBackupPlansResult, error)
func GetOssBackupPlansOutput(ctx *Context, args *GetOssBackupPlansOutputArgs, opts ...InvokeOption) GetOssBackupPlansResultOutput

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

public static class GetOssBackupPlans 
{
    public static Task<GetOssBackupPlansResult> InvokeAsync(GetOssBackupPlansArgs args, InvokeOptions? opts = null)
    public static Output<GetOssBackupPlansResult> Invoke(GetOssBackupPlansInvokeArgs args, InvokeOptions? opts = null)
}

public static CompletableFuture<GetOssBackupPlansResult> getOssBackupPlans(GetOssBackupPlansArgs args, InvokeOptions options)
public static Output<GetOssBackupPlansResult> getOssBackupPlans(GetOssBackupPlansArgs args, InvokeOptions options)

fn::invoke:
  function: alicloud:hbr/getOssBackupPlans:getOssBackupPlans
  arguments:
    # arguments dictionary

The following arguments are supported:

Bucket string: The name of OSS bucket.
Ids List<string>: A list of OssBackupPlan IDs.
NameRegex string: A regex string to filter results by OssBackupPlan name.
OutputFile string: File name where to save data source results (after running pulumi preview).
VaultId string: The ID of backup vault the OssBackupPlan used.

Bucket string: The name of OSS bucket.
Ids []string: A list of OssBackupPlan IDs.
NameRegex string: A regex string to filter results by OssBackupPlan name.
OutputFile string: File name where to save data source results (after running pulumi preview).
VaultId string: The ID of backup vault the OssBackupPlan used.

bucket String: The name of OSS bucket.
ids List<String>: A list of OssBackupPlan IDs.
nameRegex String: A regex string to filter results by OssBackupPlan name.
outputFile String: File name where to save data source results (after running pulumi preview).
vaultId String: The ID of backup vault the OssBackupPlan used.

bucket string: The name of OSS bucket.
ids string[]: A list of OssBackupPlan IDs.
nameRegex string: A regex string to filter results by OssBackupPlan name.
outputFile string: File name where to save data source results (after running pulumi preview).
vaultId string: The ID of backup vault the OssBackupPlan used.

bucket str: The name of OSS bucket.
ids Sequence[str]: A list of OssBackupPlan IDs.
name_regex str: A regex string to filter results by OssBackupPlan name.
output_file str: File name where to save data source results (after running pulumi preview).
vault_id str: The ID of backup vault the OssBackupPlan used.

bucket String: The name of OSS bucket.
ids List<String>: A list of OssBackupPlan IDs.
nameRegex String: A regex string to filter results by OssBackupPlan name.
outputFile String: File name where to save data source results (after running pulumi preview).
vaultId String: The ID of backup vault the OssBackupPlan used.

getOssBackupPlans 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.GetOssBackupPlansPlan>
Bucket string
NameRegex string
OutputFile string
VaultId string

Id string: The provider-assigned unique ID for this managed resource.
Ids []string
Names []string
Plans []GetOssBackupPlansPlan
Bucket string
NameRegex string
OutputFile string
VaultId string

id String: The provider-assigned unique ID for this managed resource.
ids List<String>
names List<String>
plans List<GetOssBackupPlansPlan>
bucket String
nameRegex String
outputFile String
vaultId String

id string: The provider-assigned unique ID for this managed resource.
ids string[]
names string[]
plans GetOssBackupPlansPlan[]
bucket string
nameRegex string
outputFile string
vaultId string

id str: The provider-assigned unique ID for this managed resource.
ids Sequence[str]
names Sequence[str]
plans Sequence[GetOssBackupPlansPlan]
bucket str
name_regex str
output_file 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>
bucket String
nameRegex String
outputFile String
vaultId String

Supporting Types

GetOssBackupPlansPlan

BackupType string

Backup type. Valid values: COMPLETE.

Bucket string

The name of OSS bucket.

CreatedTime string

The creation time of the backup plan. UNIX time in seconds.

Disabled bool

Whether to be suspended. Valid values: true, false.

Id string

The ID of Oss backup plan.

OssBackupPlanId string

The ID of Oss backup plan.

OssBackupPlanName 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.

Prefix string

Backup prefix.

Retention string

Backup retention days, the minimum is 1.

Schedule string

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.

UpdatedTime string

The update time of the backup plan. UNIX time in seconds.

VaultId string

The ID of backup vault.

BackupType string

Backup type. Valid values: COMPLETE.

Bucket string

The name of OSS bucket.

CreatedTime string

The creation time of the backup plan. UNIX time in seconds.

Disabled bool

Whether to be suspended. Valid values: true, false.

Id string

The ID of Oss backup plan.

OssBackupPlanId string

The ID of Oss backup plan.

OssBackupPlanName 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.

Prefix string

Backup prefix.

Retention string

Backup retention days, the minimum is 1.

Schedule string

startTime Backup start time, UNIX time seconds.

UpdatedTime string

The update time of the backup plan. UNIX time in seconds.

VaultId string

The ID of backup vault.

backupType String

Backup type. Valid values: COMPLETE.

bucket String

The name of OSS bucket.

createdTime String

The creation time of the backup plan. UNIX time in seconds.

disabled Boolean

Whether to be suspended. Valid values: true, false.

id String

The ID of Oss backup plan.

ossBackupPlanId String

The ID of Oss backup plan.

ossBackupPlanName 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.

prefix String

Backup prefix.

retention String

Backup retention days, the minimum is 1.

schedule String

startTime Backup start time, UNIX time seconds.

updatedTime String

The update time of the backup plan. UNIX time in seconds.

vaultId String

The ID of backup vault.

backupType string

Backup type. Valid values: COMPLETE.

bucket string

The name of OSS bucket.

createdTime string

The creation time of the backup plan. UNIX time in seconds.

disabled boolean

Whether to be suspended. Valid values: true, false.

id string

The ID of Oss backup plan.

ossBackupPlanId string

The ID of Oss backup plan.

ossBackupPlanName 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.

prefix string

Backup prefix.

retention string

Backup retention days, the minimum is 1.

schedule string

startTime Backup start time, UNIX time seconds.

updatedTime string

The update time of the backup plan. UNIX time in seconds.

vaultId string

The ID of backup vault.

backup_type str

Backup type. Valid values: COMPLETE.

bucket str

The name of OSS bucket.

created_time str

The creation time of the backup plan. UNIX time in seconds.

disabled bool

Whether to be suspended. Valid values: true, false.

id str

The ID of Oss backup plan.

oss_backup_plan_id str

The ID of Oss backup plan.

oss_backup_plan_name 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.

prefix str

Backup prefix.

retention str

Backup retention days, the minimum is 1.

schedule str

startTime Backup start time, UNIX time seconds.

updated_time str

The update time of the backup plan. UNIX time in seconds.

vault_id str

The ID of backup vault.

backupType String

Backup type. Valid values: COMPLETE.

bucket String

The name of OSS bucket.

createdTime String

The creation time of the backup plan. UNIX time in seconds.

disabled Boolean

Whether to be suspended. Valid values: true, false.

id String

The ID of Oss backup plan.

ossBackupPlanId String

The ID of Oss backup plan.

ossBackupPlanName 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.

prefix String

Backup prefix.

retention String

Backup retention days, the minimum is 1.

schedule String

startTime Backup start time, UNIX time seconds.

updatedTime String

The update time of the backup plan. UNIX time in seconds.

vaultId String

The ID of backup vault.

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

pulumi/pulumi-alicloud

alicloud.hbr.getOssBackupPlans

On this page

On this page

Example Usage

Using getOssBackupPlans

getOssBackupPlans Result

Supporting Types

GetOssBackupPlansPlan

Package Details

On this page

On this page