Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Alibaba Cloud Provider
  3. API Docs
  4. hbr
  5. Vault
Alibaba Cloud v3.76.0 published on Tuesday, Apr 8, 2025 by Pulumi
pulumi/pulumi-alicloud

alicloud.hbr.Vault

Explore with Pulumi AI

alicloud logo
Alibaba Cloud v3.76.0 published on Tuesday, Apr 8, 2025 by Pulumi
pulumi/pulumi-alicloud

    Provides a Hybrid Backup Recovery (HBR) Vault resource.

    Where backup or archived data is stored.

    For information about Hybrid Backup Recovery (HBR) Vault and how to use it, see What is Vault.

    NOTE: Available since v1.129.0.

    Example Usage

    Basic Usage

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

const _default = new random.index.Integer("default", {
    min: 10000,
    max: 99999,
});
const example = new alicloud.hbr.Vault("example", {vaultName: `example_value_${_default.result}`});

    import pulumi
import pulumi_alicloud as alicloud
import pulumi_random as random

default = random.index.Integer("default",
    min=10000,
    max=99999)
example = alicloud.hbr.Vault("example", vault_name=f"example_value_{default['result']}")

    package main

import (
	"fmt"

	"github.com/pulumi/pulumi-alicloud/sdk/v3/go/alicloud/hbr"
	"github.com/pulumi/pulumi-random/sdk/v4/go/random"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_default, err := random.NewInteger(ctx, "default", &random.IntegerArgs{
			Min: 10000,
			Max: 99999,
		})
		if err != nil {
			return err
		}
		_, err = hbr.NewVault(ctx, "example", &hbr.VaultArgs{
			VaultName: pulumi.Sprintf("example_value_%v", _default.Result),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

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

return await Deployment.RunAsync(() => 
{
    var @default = new Random.Index.Integer("default", new()
    {
        Min = 10000,
        Max = 99999,
    });

    var example = new AliCloud.Hbr.Vault("example", new()
    {
        VaultName = $"example_value_{@default.Result}",
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.random.integer;
import com.pulumi.random.IntegerArgs;
import com.pulumi.alicloud.hbr.Vault;
import com.pulumi.alicloud.hbr.VaultArgs;
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 default_ = new Integer("default", IntegerArgs.builder()
            .min(10000)
            .max(99999)
            .build());

        var example = new Vault("example", VaultArgs.builder()
            .vaultName(String.format("example_value_%s", default_.result()))
            .build());

    }
}

    resources:
  default:
    type: random:integer
    properties:
      min: 10000
      max: 99999
  example:
    type: alicloud:hbr:Vault
    properties:
      vaultName: example_value_${default.result}

    Create Vault Resource

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

    Constructor syntax

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

@overload
def Vault(resource_name: str,
          opts: Optional[ResourceOptions] = None,
          vault_name: Optional[str] = None,
          description: Optional[str] = None,
          encrypt_type: Optional[str] = None,
          kms_key_id: Optional[str] = None,
          resource_group_id: Optional[str] = None,
          tags: Optional[Mapping[str, str]] = None,
          vault_storage_class: Optional[str] = None,
          vault_type: Optional[str] = None,
          worm_enabled: Optional[bool] = None)
    func NewVault(ctx *Context, name string, args VaultArgs, opts ...ResourceOption) (*Vault, error)
    public Vault(string name, VaultArgs args, CustomResourceOptions? opts = null)
    public Vault(String name, VaultArgs args)
public Vault(String name, VaultArgs args, CustomResourceOptions options)

    type: alicloud:hbr:Vault
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

    Parameters

    name string
    The unique name of the resource.
    args VaultArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args VaultArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args VaultArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args VaultArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args VaultArgs
    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 vaultResource = new AliCloud.Hbr.Vault("vaultResource", new()
{
    VaultName = "string",
    Description = "string",
    EncryptType = "string",
    KmsKeyId = "string",
    ResourceGroupId = "string",
    Tags = 
    {
        { "string", "string" },
    },
    VaultStorageClass = "string",
    VaultType = "string",
    WormEnabled = false,
});

    example, err := hbr.NewVault(ctx, "vaultResource", &hbr.VaultArgs{
	VaultName:       pulumi.String("string"),
	Description:     pulumi.String("string"),
	EncryptType:     pulumi.String("string"),
	KmsKeyId:        pulumi.String("string"),
	ResourceGroupId: pulumi.String("string"),
	Tags: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
	VaultStorageClass: pulumi.String("string"),
	VaultType:         pulumi.String("string"),
	WormEnabled:       pulumi.Bool(false),
})

    var vaultResource = new Vault("vaultResource", VaultArgs.builder()
    .vaultName("string")
    .description("string")
    .encryptType("string")
    .kmsKeyId("string")
    .resourceGroupId("string")
    .tags(Map.of("string", "string"))
    .vaultStorageClass("string")
    .vaultType("string")
    .wormEnabled(false)
    .build());

    vault_resource = alicloud.hbr.Vault("vaultResource",
    vault_name="string",
    description="string",
    encrypt_type="string",
    kms_key_id="string",
    resource_group_id="string",
    tags={
        "string": "string",
    },
    vault_storage_class="string",
    vault_type="string",
    worm_enabled=False)

    const vaultResource = new alicloud.hbr.Vault("vaultResource", {
    vaultName: "string",
    description: "string",
    encryptType: "string",
    kmsKeyId: "string",
    resourceGroupId: "string",
    tags: {
        string: "string",
    },
    vaultStorageClass: "string",
    vaultType: "string",
    wormEnabled: false,
});

    type: alicloud:hbr:Vault
properties:
    description: string
    encryptType: string
    kmsKeyId: string
    resourceGroupId: string
    tags:
        string: string
    vaultName: string
    vaultStorageClass: string
    vaultType: string
    wormEnabled: false

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

    VaultName string
    The name of Vault.
    Description string
    The description of Vault. Defaults to an empty string.
    EncryptType string
    Source Encryption Type，It is valid only when vault_type is STANDARD or OTS_BACKUP. Default value: HBR_PRIVATE. Valid values:

    • HBR_PRIVATE: HBR is fully hosted, uses the backup service's own encryption method.
    • KMS: Use Alibaba Cloud Kms to encryption.
    KmsKeyId string
    The key id or alias name of Alibaba Cloud Kms. It is required and valid only when encrypt_type is KMS.
    ResourceGroupId string
    The ID of the resource group.
    Tags Dictionary<string, string>
    The tag of the resource.
    VaultStorageClass string
    The storage class of Vault. Valid values: STANDARD.
    VaultType string
    The type of Vault. Valid values: STANDARD, OTS_BACKUP.
    WormEnabled bool
    Indicates whether the immutable backup feature is enabled. Valid values: true, false.
    VaultName string
    The name of Vault.
    Description string
    The description of Vault. Defaults to an empty string.
    EncryptType string
    Source Encryption Type，It is valid only when vault_type is STANDARD or OTS_BACKUP. Default value: HBR_PRIVATE. Valid values:

    • HBR_PRIVATE: HBR is fully hosted, uses the backup service's own encryption method.
    • KMS: Use Alibaba Cloud Kms to encryption.
    KmsKeyId string
    The key id or alias name of Alibaba Cloud Kms. It is required and valid only when encrypt_type is KMS.
    ResourceGroupId string
    The ID of the resource group.
    Tags map[string]string
    The tag of the resource.
    VaultStorageClass string
    The storage class of Vault. Valid values: STANDARD.
    VaultType string
    The type of Vault. Valid values: STANDARD, OTS_BACKUP.
    WormEnabled bool
    Indicates whether the immutable backup feature is enabled. Valid values: true, false.
    vaultName String
    The name of Vault.
    description String
    The description of Vault. Defaults to an empty string.
    encryptType String
    Source Encryption Type，It is valid only when vault_type is STANDARD or OTS_BACKUP. Default value: HBR_PRIVATE. Valid values:

    • HBR_PRIVATE: HBR is fully hosted, uses the backup service's own encryption method.
    • KMS: Use Alibaba Cloud Kms to encryption.
    kmsKeyId String
    The key id or alias name of Alibaba Cloud Kms. It is required and valid only when encrypt_type is KMS.
    resourceGroupId String
    The ID of the resource group.
    tags Map<String,String>
    The tag of the resource.
    vaultStorageClass String
    The storage class of Vault. Valid values: STANDARD.
    vaultType String
    The type of Vault. Valid values: STANDARD, OTS_BACKUP.
    wormEnabled Boolean
    Indicates whether the immutable backup feature is enabled. Valid values: true, false.
    vaultName string
    The name of Vault.
    description string
    The description of Vault. Defaults to an empty string.
    encryptType string
    Source Encryption Type，It is valid only when vault_type is STANDARD or OTS_BACKUP. Default value: HBR_PRIVATE. Valid values:

    • HBR_PRIVATE: HBR is fully hosted, uses the backup service's own encryption method.
    • KMS: Use Alibaba Cloud Kms to encryption.
    kmsKeyId string
    The key id or alias name of Alibaba Cloud Kms. It is required and valid only when encrypt_type is KMS.
    resourceGroupId string
    The ID of the resource group.
    tags {[key: string]: string}
    The tag of the resource.
    vaultStorageClass string
    The storage class of Vault. Valid values: STANDARD.
    vaultType string
    The type of Vault. Valid values: STANDARD, OTS_BACKUP.
    wormEnabled boolean
    Indicates whether the immutable backup feature is enabled. Valid values: true, false.
    vault_name str
    The name of Vault.
    description str
    The description of Vault. Defaults to an empty string.
    encrypt_type str
    Source Encryption Type，It is valid only when vault_type is STANDARD or OTS_BACKUP. Default value: HBR_PRIVATE. Valid values:

    • HBR_PRIVATE: HBR is fully hosted, uses the backup service's own encryption method.
    • KMS: Use Alibaba Cloud Kms to encryption.
    kms_key_id str
    The key id or alias name of Alibaba Cloud Kms. It is required and valid only when encrypt_type is KMS.
    resource_group_id str
    The ID of the resource group.
    tags Mapping[str, str]
    The tag of the resource.
    vault_storage_class str
    The storage class of Vault. Valid values: STANDARD.
    vault_type str
    The type of Vault. Valid values: STANDARD, OTS_BACKUP.
    worm_enabled bool
    Indicates whether the immutable backup feature is enabled. Valid values: true, false.
    vaultName String
    The name of Vault.
    description String
    The description of Vault. Defaults to an empty string.
    encryptType String
    Source Encryption Type，It is valid only when vault_type is STANDARD or OTS_BACKUP. Default value: HBR_PRIVATE. Valid values:

    • HBR_PRIVATE: HBR is fully hosted, uses the backup service's own encryption method.
    • KMS: Use Alibaba Cloud Kms to encryption.
    kmsKeyId String
    The key id or alias name of Alibaba Cloud Kms. It is required and valid only when encrypt_type is KMS.
    resourceGroupId String
    The ID of the resource group.
    tags Map<String>
    The tag of the resource.
    vaultStorageClass String
    The storage class of Vault. Valid values: STANDARD.
    vaultType String
    The type of Vault. Valid values: STANDARD, OTS_BACKUP.
    wormEnabled Boolean
    Indicates whether the immutable backup feature is enabled. Valid values: true, false.

    Outputs

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

    CreateTime string
    (Available since v1.243.0) The time when the backup vault was created.
    Id string
    The provider-assigned unique ID for this managed resource.
    RegionId string
    (Available since v1.243.0) The ID of the region in which the backup vault resides.
    Status string
    The status of the Vault.
    CreateTime string
    (Available since v1.243.0) The time when the backup vault was created.
    Id string
    The provider-assigned unique ID for this managed resource.
    RegionId string
    (Available since v1.243.0) The ID of the region in which the backup vault resides.
    Status string
    The status of the Vault.
    createTime String
    (Available since v1.243.0) The time when the backup vault was created.
    id String
    The provider-assigned unique ID for this managed resource.
    regionId String
    (Available since v1.243.0) The ID of the region in which the backup vault resides.
    status String
    The status of the Vault.
    createTime string
    (Available since v1.243.0) The time when the backup vault was created.
    id string
    The provider-assigned unique ID for this managed resource.
    regionId string
    (Available since v1.243.0) The ID of the region in which the backup vault resides.
    status string
    The status of the Vault.
    create_time str
    (Available since v1.243.0) The time when the backup vault was created.
    id str
    The provider-assigned unique ID for this managed resource.
    region_id str
    (Available since v1.243.0) The ID of the region in which the backup vault resides.
    status str
    The status of the Vault.
    createTime String
    (Available since v1.243.0) The time when the backup vault was created.
    id String
    The provider-assigned unique ID for this managed resource.
    regionId String
    (Available since v1.243.0) The ID of the region in which the backup vault resides.
    status String
    The status of the Vault.

    Look up Existing Vault Resource

    Get an existing Vault 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?: VaultState, opts?: CustomResourceOptions): Vault
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        create_time: Optional[str] = None,
        description: Optional[str] = None,
        encrypt_type: Optional[str] = None,
        kms_key_id: Optional[str] = None,
        region_id: Optional[str] = None,
        resource_group_id: Optional[str] = None,
        status: Optional[str] = None,
        tags: Optional[Mapping[str, str]] = None,
        vault_name: Optional[str] = None,
        vault_storage_class: Optional[str] = None,
        vault_type: Optional[str] = None,
        worm_enabled: Optional[bool] = None) -> Vault
    func GetVault(ctx *Context, name string, id IDInput, state *VaultState, opts ...ResourceOption) (*Vault, error)
    public static Vault Get(string name, Input<string> id, VaultState? state, CustomResourceOptions? opts = null)
    public static Vault get(String name, Output<String> id, VaultState state, CustomResourceOptions options)
    resources:  _:    type: alicloud:hbr:Vault    get:      id: ${id}
    name
    The unique name of the resulting resource.
    id
    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
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    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
    The unique name of the resulting resource.
    id
    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
    The unique name of the resulting resource.
    id
    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:
    CreateTime string
    (Available since v1.243.0) The time when the backup vault was created.
    Description string
    The description of Vault. Defaults to an empty string.
    EncryptType string
    Source Encryption Type，It is valid only when vault_type is STANDARD or OTS_BACKUP. Default value: HBR_PRIVATE. Valid values:

    • HBR_PRIVATE: HBR is fully hosted, uses the backup service's own encryption method.
    • KMS: Use Alibaba Cloud Kms to encryption.
    KmsKeyId string
    The key id or alias name of Alibaba Cloud Kms. It is required and valid only when encrypt_type is KMS.
    RegionId string
    (Available since v1.243.0) The ID of the region in which the backup vault resides.
    ResourceGroupId string
    The ID of the resource group.
    Status string
    The status of the Vault.
    Tags Dictionary<string, string>
    The tag of the resource.
    VaultName string
    The name of Vault.
    VaultStorageClass string
    The storage class of Vault. Valid values: STANDARD.
    VaultType string
    The type of Vault. Valid values: STANDARD, OTS_BACKUP.
    WormEnabled bool
    Indicates whether the immutable backup feature is enabled. Valid values: true, false.
    CreateTime string
    (Available since v1.243.0) The time when the backup vault was created.
    Description string
    The description of Vault. Defaults to an empty string.
    EncryptType string
    Source Encryption Type，It is valid only when vault_type is STANDARD or OTS_BACKUP. Default value: HBR_PRIVATE. Valid values:

    • HBR_PRIVATE: HBR is fully hosted, uses the backup service's own encryption method.
    • KMS: Use Alibaba Cloud Kms to encryption.
    KmsKeyId string
    The key id or alias name of Alibaba Cloud Kms. It is required and valid only when encrypt_type is KMS.
    RegionId string
    (Available since v1.243.0) The ID of the region in which the backup vault resides.
    ResourceGroupId string
    The ID of the resource group.
    Status string
    The status of the Vault.
    Tags map[string]string
    The tag of the resource.
    VaultName string
    The name of Vault.
    VaultStorageClass string
    The storage class of Vault. Valid values: STANDARD.
    VaultType string
    The type of Vault. Valid values: STANDARD, OTS_BACKUP.
    WormEnabled bool
    Indicates whether the immutable backup feature is enabled. Valid values: true, false.
    createTime String
    (Available since v1.243.0) The time when the backup vault was created.
    description String
    The description of Vault. Defaults to an empty string.
    encryptType String
    Source Encryption Type，It is valid only when vault_type is STANDARD or OTS_BACKUP. Default value: HBR_PRIVATE. Valid values:

    • HBR_PRIVATE: HBR is fully hosted, uses the backup service's own encryption method.
    • KMS: Use Alibaba Cloud Kms to encryption.
    kmsKeyId String
    The key id or alias name of Alibaba Cloud Kms. It is required and valid only when encrypt_type is KMS.
    regionId String
    (Available since v1.243.0) The ID of the region in which the backup vault resides.
    resourceGroupId String
    The ID of the resource group.
    status String
    The status of the Vault.
    tags Map<String,String>
    The tag of the resource.
    vaultName String
    The name of Vault.
    vaultStorageClass String
    The storage class of Vault. Valid values: STANDARD.
    vaultType String
    The type of Vault. Valid values: STANDARD, OTS_BACKUP.
    wormEnabled Boolean
    Indicates whether the immutable backup feature is enabled. Valid values: true, false.
    createTime string
    (Available since v1.243.0) The time when the backup vault was created.
    description string
    The description of Vault. Defaults to an empty string.
    encryptType string
    Source Encryption Type，It is valid only when vault_type is STANDARD or OTS_BACKUP. Default value: HBR_PRIVATE. Valid values:

    • HBR_PRIVATE: HBR is fully hosted, uses the backup service's own encryption method.
    • KMS: Use Alibaba Cloud Kms to encryption.
    kmsKeyId string
    The key id or alias name of Alibaba Cloud Kms. It is required and valid only when encrypt_type is KMS.
    regionId string
    (Available since v1.243.0) The ID of the region in which the backup vault resides.
    resourceGroupId string
    The ID of the resource group.
    status string
    The status of the Vault.
    tags {[key: string]: string}
    The tag of the resource.
    vaultName string
    The name of Vault.
    vaultStorageClass string
    The storage class of Vault. Valid values: STANDARD.
    vaultType string
    The type of Vault. Valid values: STANDARD, OTS_BACKUP.
    wormEnabled boolean
    Indicates whether the immutable backup feature is enabled. Valid values: true, false.
    create_time str
    (Available since v1.243.0) The time when the backup vault was created.
    description str
    The description of Vault. Defaults to an empty string.
    encrypt_type str
    Source Encryption Type，It is valid only when vault_type is STANDARD or OTS_BACKUP. Default value: HBR_PRIVATE. Valid values:

    • HBR_PRIVATE: HBR is fully hosted, uses the backup service's own encryption method.
    • KMS: Use Alibaba Cloud Kms to encryption.
    kms_key_id str
    The key id or alias name of Alibaba Cloud Kms. It is required and valid only when encrypt_type is KMS.
    region_id str
    (Available since v1.243.0) The ID of the region in which the backup vault resides.
    resource_group_id str
    The ID of the resource group.
    status str
    The status of the Vault.
    tags Mapping[str, str]
    The tag of the resource.
    vault_name str
    The name of Vault.
    vault_storage_class str
    The storage class of Vault. Valid values: STANDARD.
    vault_type str
    The type of Vault. Valid values: STANDARD, OTS_BACKUP.
    worm_enabled bool
    Indicates whether the immutable backup feature is enabled. Valid values: true, false.
    createTime String
    (Available since v1.243.0) The time when the backup vault was created.
    description String
    The description of Vault. Defaults to an empty string.
    encryptType String
    Source Encryption Type，It is valid only when vault_type is STANDARD or OTS_BACKUP. Default value: HBR_PRIVATE. Valid values:

    • HBR_PRIVATE: HBR is fully hosted, uses the backup service's own encryption method.
    • KMS: Use Alibaba Cloud Kms to encryption.
    kmsKeyId String
    The key id or alias name of Alibaba Cloud Kms. It is required and valid only when encrypt_type is KMS.
    regionId String
    (Available since v1.243.0) The ID of the region in which the backup vault resides.
    resourceGroupId String
    The ID of the resource group.
    status String
    The status of the Vault.
    tags Map<String>
    The tag of the resource.
    vaultName String
    The name of Vault.
    vaultStorageClass String
    The storage class of Vault. Valid values: STANDARD.
    vaultType String
    The type of Vault. Valid values: STANDARD, OTS_BACKUP.
    wormEnabled Boolean
    Indicates whether the immutable backup feature is enabled. Valid values: true, false.

    Import

    Hybrid Backup Recovery (HBR) Vault can be imported using the id, e.g.

    $ pulumi import alicloud:hbr/vault:Vault example <id>

    To learn more about importing existing cloud resources, see Importing resources.

    Package Details

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