← All packages

Alibaba Cloud

Pulumi Official

Package maintained by Pulumi

v3.28.0 published on Tuesday, Aug 16, 2022 by Pulumi

Source code

getOssBackupPlans

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

NOTE: Available in v1.131.0+.

Example Usage

using Pulumi;
using AliCloud = Pulumi.AliCloud;

class MyStack : Stack
{
    public MyStack()
    {
        var ids = Output.Create(AliCloud.Hbr.GetOssBackupPlans.InvokeAsync(new AliCloud.Hbr.GetOssBackupPlansArgs
        {
            NameRegex = "^my-OssBackupPlan",
        }));
        this.HbrOssBackupPlanId = ids.Apply(ids => ids.Plans?[0]?.Id);
    }

    [Output("hbrOssBackupPlanId")]
    public Output<string> HbrOssBackupPlanId { get; set; }
}

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
	})
}

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()));
    }
}

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)

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);

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.

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)
// Output-based functions aren't available in Java yet

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
VaultId string: The ID of backup vault.

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
VaultId string: The ID of backup vault.

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
vaultId String: The ID of backup vault.

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
vaultId string: The ID of backup vault.

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
vault_id str: The ID of backup vault.

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
vaultId String: The ID of backup vault.

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.
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: 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.
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: 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.
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: 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.
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: 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.
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: 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.
updatedTime String: The update time of the backup plan. UNIX time in seconds.
vaultId String: The ID of backup vault.

Package Details

Repository: https://github.com/pulumi/pulumi-alicloud
License: Apache-2.0
Notes: This Pulumi package is based on the alicloud Terraform Provider.