Alibaba Cloud

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

getVaults

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

NOTE: Available in v1.129.0+.

Example Usage

using Pulumi;
using AliCloud = Pulumi.AliCloud;

class MyStack : Stack
{
    public MyStack()
    {
        var ids = Output.Create(AliCloud.Hbr.GetVaults.InvokeAsync(new AliCloud.Hbr.GetVaultsArgs
        {
            NameRegex = "^my-Vault",
        }));
        this.HbrVaultId1 = ids.Apply(ids => ids.Vaults?[0]?.Id);
    }

    [Output("hbrVaultId1")]
    public Output<string> HbrVaultId1 { 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.GetVaults(ctx, &hbr.GetVaultsArgs{
			NameRegex: pulumi.StringRef("^my-Vault"),
		}, nil)
		if err != nil {
			return err
		}
		ctx.Export("hbrVaultId1", ids.Vaults[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.GetVaultsArgs;
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.getVaults(GetVaultsArgs.builder()
            .nameRegex("^my-Vault")
            .build());

        ctx.export("hbrVaultId1", ids.applyValue(getVaultsResult -> getVaultsResult.vaults()[0].id()));
    }
}
import pulumi
import pulumi_alicloud as alicloud

ids = alicloud.hbr.get_vaults(name_regex="^my-Vault")
pulumi.export("hbrVaultId1", ids.vaults[0].id)
import * as pulumi from "@pulumi/pulumi";
import * as alicloud from "@pulumi/alicloud";

const ids = alicloud.hbr.getVaults({
    nameRegex: "^my-Vault",
});
export const hbrVaultId1 = ids.then(ids => ids.vaults?[0]?.id);
variables:
  ids:
    Fn::Invoke:
      Function: alicloud:hbr:getVaults
      Arguments:
        nameRegex: ^my-Vault
outputs:
  hbrVaultId1: ${ids.vaults[0].id}

Using getVaults

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 getVaults(args: GetVaultsArgs, opts?: InvokeOptions): Promise<GetVaultsResult>
function getVaultsOutput(args: GetVaultsOutputArgs, opts?: InvokeOptions): Output<GetVaultsResult>
def get_vaults(ids: Optional[Sequence[str]] = None,
               name_regex: Optional[str] = None,
               output_file: Optional[str] = None,
               status: Optional[str] = None,
               vault_type: Optional[str] = None,
               opts: Optional[InvokeOptions] = None) -> GetVaultsResult
def get_vaults_output(ids: Optional[pulumi.Input[Sequence[pulumi.Input[str]]]] = None,
               name_regex: Optional[pulumi.Input[str]] = None,
               output_file: Optional[pulumi.Input[str]] = None,
               status: Optional[pulumi.Input[str]] = None,
               vault_type: Optional[pulumi.Input[str]] = None,
               opts: Optional[InvokeOptions] = None) -> Output[GetVaultsResult]
func GetVaults(ctx *Context, args *GetVaultsArgs, opts ...InvokeOption) (*GetVaultsResult, error)
func GetVaultsOutput(ctx *Context, args *GetVaultsOutputArgs, opts ...InvokeOption) GetVaultsResultOutput

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

public static class GetVaults 
{
    public static Task<GetVaultsResult> InvokeAsync(GetVaultsArgs args, InvokeOptions? opts = null)
    public static Output<GetVaultsResult> Invoke(GetVaultsInvokeArgs args, InvokeOptions? opts = null)
}
public static CompletableFuture<GetVaultsResult> getVaults(GetVaultsArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet
Fn::Invoke:
  Function: alicloud:hbr/getVaults:getVaults
  Arguments:
    # Arguments dictionary

The following arguments are supported:

Ids List<string>

A list of Vault IDs.

NameRegex string

A regex string to filter results by Vault name.

OutputFile string
Status string

The status of Vault. Valid values: CREATED, ERROR, UNKNOWN.

VaultType string

The type of Vault. Valid values: STANDARD,OTS_BACKUP.

Ids []string

A list of Vault IDs.

NameRegex string

A regex string to filter results by Vault name.

OutputFile string
Status string

The status of Vault. Valid values: CREATED, ERROR, UNKNOWN.

VaultType string

The type of Vault. Valid values: STANDARD,OTS_BACKUP.

ids List<String>

A list of Vault IDs.

nameRegex String

A regex string to filter results by Vault name.

outputFile String
status String

The status of Vault. Valid values: CREATED, ERROR, UNKNOWN.

vaultType String

The type of Vault. Valid values: STANDARD,OTS_BACKUP.

ids string[]

A list of Vault IDs.

nameRegex string

A regex string to filter results by Vault name.

outputFile string
status string

The status of Vault. Valid values: CREATED, ERROR, UNKNOWN.

vaultType string

The type of Vault. Valid values: STANDARD,OTS_BACKUP.

ids Sequence[str]

A list of Vault IDs.

name_regex str

A regex string to filter results by Vault name.

output_file str
status str

The status of Vault. Valid values: CREATED, ERROR, UNKNOWN.

vault_type str

The type of Vault. Valid values: STANDARD,OTS_BACKUP.

ids List<String>

A list of Vault IDs.

nameRegex String

A regex string to filter results by Vault name.

outputFile String
status String

The status of Vault. Valid values: CREATED, ERROR, UNKNOWN.

vaultType String

The type of Vault. Valid values: STANDARD,OTS_BACKUP.

getVaults Result

The following output properties are available:

Id string

The provider-assigned unique ID for this managed resource.

Ids List<string>
Names List<string>
Vaults List<Pulumi.AliCloud.Hbr.Outputs.GetVaultsVault>
NameRegex string
OutputFile string
Status string
VaultType string
Id string

The provider-assigned unique ID for this managed resource.

Ids []string
Names []string
Vaults []GetVaultsVault
NameRegex string
OutputFile string
Status string
VaultType string
id String

The provider-assigned unique ID for this managed resource.

ids List<String>
names List<String>
vaults List<GetVaultsVault>
nameRegex String
outputFile String
status String
vaultType String
id string

The provider-assigned unique ID for this managed resource.

ids string[]
names string[]
vaults GetVaultsVault[]
nameRegex string
outputFile string
status string
vaultType string
id str

The provider-assigned unique ID for this managed resource.

ids Sequence[str]
names Sequence[str]
vaults Sequence[GetVaultsVault]
name_regex str
output_file str
status str
vault_type str
id String

The provider-assigned unique ID for this managed resource.

ids List<String>
names List<String>
vaults List<Property Map>
nameRegex String
outputFile String
status String
vaultType String

Supporting Types

GetVaultsVault

BucketName string

The name of the OSS bucket of the Vault.

BytesDone string

The amount of backup data. The unit is Byte.

CreatedTime string

The creation time of the Vault. UNIX time in seconds.

Dedup bool

Whether to enable the deduplication function for the database backup Vault.

Description string

The description of the vault.

Id string

The ID of vault.

IndexAvailable bool

Index available.

IndexLevel string

Index level.

IndexUpdateTime string

Index update time.

LatestReplicationTime string

The time of the last remote backup synchronization.

PaymentType string

Billing model, possible values:

Replication bool

Whether it is a remote backup warehouse. It's a boolean value.

ReplicationSourceRegionId string

The region ID to which the remote backup Vault belongs.

ReplicationSourceVaultId string

The source vault ID of the remote backup Vault.

Retention string

Warehouse-level data retention days, only valid for archive libraries.

SearchEnabled bool

Whether to enable the backup search function.

SourceTypes List<string>
Status string

The status of Vault. Valid values: CREATED, ERROR, UNKNOWN.

StorageSize string

Backup vault storage usage. The unit is Byte.

UpdatedTime string

The update time of the Vault. UNIX time in seconds.

VaultId string

The ID of vault, same as id.

VaultName string

The name of vault.

VaultStatusMessage string

Error status information of Vault. Only valid for remote backup warehouses. Only the remote backup warehouse is valid.

VaultStorageClass string

The storage class of vault. Valid values: STANDARD.

VaultType string

The type of Vault. Valid values: STANDARD,OTS_BACKUP.

BucketName string

The name of the OSS bucket of the Vault.

BytesDone string

The amount of backup data. The unit is Byte.

CreatedTime string

The creation time of the Vault. UNIX time in seconds.

Dedup bool

Whether to enable the deduplication function for the database backup Vault.

Description string

The description of the vault.

Id string

The ID of vault.

IndexAvailable bool

Index available.

IndexLevel string

Index level.

IndexUpdateTime string

Index update time.

LatestReplicationTime string

The time of the last remote backup synchronization.

PaymentType string

Billing model, possible values:

Replication bool

Whether it is a remote backup warehouse. It's a boolean value.

ReplicationSourceRegionId string

The region ID to which the remote backup Vault belongs.

ReplicationSourceVaultId string

The source vault ID of the remote backup Vault.

Retention string

Warehouse-level data retention days, only valid for archive libraries.

SearchEnabled bool

Whether to enable the backup search function.

SourceTypes []string
Status string

The status of Vault. Valid values: CREATED, ERROR, UNKNOWN.

StorageSize string

Backup vault storage usage. The unit is Byte.

UpdatedTime string

The update time of the Vault. UNIX time in seconds.

VaultId string

The ID of vault, same as id.

VaultName string

The name of vault.

VaultStatusMessage string

Error status information of Vault. Only valid for remote backup warehouses. Only the remote backup warehouse is valid.

VaultStorageClass string

The storage class of vault. Valid values: STANDARD.

VaultType string

The type of Vault. Valid values: STANDARD,OTS_BACKUP.

bucketName String

The name of the OSS bucket of the Vault.

bytesDone String

The amount of backup data. The unit is Byte.

createdTime String

The creation time of the Vault. UNIX time in seconds.

dedup Boolean

Whether to enable the deduplication function for the database backup Vault.

description String

The description of the vault.

id String

The ID of vault.

indexAvailable Boolean

Index available.

indexLevel String

Index level.

indexUpdateTime String

Index update time.

latestReplicationTime String

The time of the last remote backup synchronization.

paymentType String

Billing model, possible values:

replication Boolean

Whether it is a remote backup warehouse. It's a boolean value.

replicationSourceRegionId String

The region ID to which the remote backup Vault belongs.

replicationSourceVaultId String

The source vault ID of the remote backup Vault.

retention String

Warehouse-level data retention days, only valid for archive libraries.

searchEnabled Boolean

Whether to enable the backup search function.

sourceTypes List<String>
status String

The status of Vault. Valid values: CREATED, ERROR, UNKNOWN.

storageSize String

Backup vault storage usage. The unit is Byte.

updatedTime String

The update time of the Vault. UNIX time in seconds.

vaultId String

The ID of vault, same as id.

vaultName String

The name of vault.

vaultStatusMessage String

Error status information of Vault. Only valid for remote backup warehouses. Only the remote backup warehouse is valid.

vaultStorageClass String

The storage class of vault. Valid values: STANDARD.

vaultType String

The type of Vault. Valid values: STANDARD,OTS_BACKUP.

bucketName string

The name of the OSS bucket of the Vault.

bytesDone string

The amount of backup data. The unit is Byte.

createdTime string

The creation time of the Vault. UNIX time in seconds.

dedup boolean

Whether to enable the deduplication function for the database backup Vault.

description string

The description of the vault.

id string

The ID of vault.

indexAvailable boolean

Index available.

indexLevel string

Index level.

indexUpdateTime string

Index update time.

latestReplicationTime string

The time of the last remote backup synchronization.

paymentType string

Billing model, possible values:

replication boolean

Whether it is a remote backup warehouse. It's a boolean value.

replicationSourceRegionId string

The region ID to which the remote backup Vault belongs.

replicationSourceVaultId string

The source vault ID of the remote backup Vault.

retention string

Warehouse-level data retention days, only valid for archive libraries.

searchEnabled boolean

Whether to enable the backup search function.

sourceTypes string[]
status string

The status of Vault. Valid values: CREATED, ERROR, UNKNOWN.

storageSize string

Backup vault storage usage. The unit is Byte.

updatedTime string

The update time of the Vault. UNIX time in seconds.

vaultId string

The ID of vault, same as id.

vaultName string

The name of vault.

vaultStatusMessage string

Error status information of Vault. Only valid for remote backup warehouses. Only the remote backup warehouse is valid.

vaultStorageClass string

The storage class of vault. Valid values: STANDARD.

vaultType string

The type of Vault. Valid values: STANDARD,OTS_BACKUP.

bucket_name str

The name of the OSS bucket of the Vault.

bytes_done str

The amount of backup data. The unit is Byte.

created_time str

The creation time of the Vault. UNIX time in seconds.

dedup bool

Whether to enable the deduplication function for the database backup Vault.

description str

The description of the vault.

id str

The ID of vault.

index_available bool

Index available.

index_level str

Index level.

index_update_time str

Index update time.

latest_replication_time str

The time of the last remote backup synchronization.

payment_type str

Billing model, possible values:

replication bool

Whether it is a remote backup warehouse. It's a boolean value.

replication_source_region_id str

The region ID to which the remote backup Vault belongs.

replication_source_vault_id str

The source vault ID of the remote backup Vault.

retention str

Warehouse-level data retention days, only valid for archive libraries.

search_enabled bool

Whether to enable the backup search function.

source_types Sequence[str]
status str

The status of Vault. Valid values: CREATED, ERROR, UNKNOWN.

storage_size str

Backup vault storage usage. The unit is Byte.

updated_time str

The update time of the Vault. UNIX time in seconds.

vault_id str

The ID of vault, same as id.

vault_name str

The name of vault.

vault_status_message str

Error status information of Vault. Only valid for remote backup warehouses. Only the remote backup warehouse is valid.

vault_storage_class str

The storage class of vault. Valid values: STANDARD.

vault_type str

The type of Vault. Valid values: STANDARD,OTS_BACKUP.

bucketName String

The name of the OSS bucket of the Vault.

bytesDone String

The amount of backup data. The unit is Byte.

createdTime String

The creation time of the Vault. UNIX time in seconds.

dedup Boolean

Whether to enable the deduplication function for the database backup Vault.

description String

The description of the vault.

id String

The ID of vault.

indexAvailable Boolean

Index available.

indexLevel String

Index level.

indexUpdateTime String

Index update time.

latestReplicationTime String

The time of the last remote backup synchronization.

paymentType String

Billing model, possible values:

replication Boolean

Whether it is a remote backup warehouse. It's a boolean value.

replicationSourceRegionId String

The region ID to which the remote backup Vault belongs.

replicationSourceVaultId String

The source vault ID of the remote backup Vault.

retention String

Warehouse-level data retention days, only valid for archive libraries.

searchEnabled Boolean

Whether to enable the backup search function.

sourceTypes List<String>
status String

The status of Vault. Valid values: CREATED, ERROR, UNKNOWN.

storageSize String

Backup vault storage usage. The unit is Byte.

updatedTime String

The update time of the Vault. UNIX time in seconds.

vaultId String

The ID of vault, same as id.

vaultName String

The name of vault.

vaultStatusMessage String

Error status information of Vault. Only valid for remote backup warehouses. Only the remote backup warehouse is valid.

vaultStorageClass String

The storage class of vault. Valid values: STANDARD.

vaultType String

The type of Vault. Valid values: STANDARD,OTS_BACKUP.

Package Details

Repository
https://github.com/pulumi/pulumi-alicloud
License
Apache-2.0
Notes

This Pulumi package is based on the alicloud Terraform Provider.