Alibaba Cloud

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

Vault

Provides a HBR Backup vault resource.

For information about HBR Backup vault and how to use it, see What is Backup vault.

NOTE: Available in v1.129.0+.

Example Usage

using Pulumi;
using AliCloud = Pulumi.AliCloud;

class MyStack : Stack
{
    public MyStack()
    {
        var example = new AliCloud.Hbr.Vault("example", new AliCloud.Hbr.VaultArgs
        {
            VaultName = "example_value",
        });
    }

}
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.NewVault(ctx, "example", &hbr.VaultArgs{
			VaultName: pulumi.String("example_value"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
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 example = new Vault("example", VaultArgs.builder()        
            .vaultName("example_value")
            .build());

    }
}
import pulumi
import pulumi_alicloud as alicloud

example = alicloud.hbr.Vault("example", vault_name="example_value")
import * as pulumi from "@pulumi/pulumi";
import * as alicloud from "@pulumi/alicloud";

const example = new alicloud.hbr.Vault("example", {
    vaultName: "example_value",
});
resources:
  example:
    type: alicloud:hbr:Vault
    properties:
      vaultName: example_value

Create a Vault Resource

new Vault(name: string, args: VaultArgs, opts?: CustomResourceOptions);
@overload
def Vault(resource_name: str,
          opts: Optional[ResourceOptions] = None,
          description: Optional[str] = None,
          encrypt_type: Optional[str] = None,
          kms_key_id: Optional[str] = None,
          redundancy_type: Optional[str] = None,
          vault_name: Optional[str] = None,
          vault_storage_class: Optional[str] = None,
          vault_type: Optional[str] = None)
@overload
def Vault(resource_name: str,
          args: VaultArgs,
          opts: Optional[ResourceOptions] = 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.

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.

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

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. Valid values: HBR_PRIVATE,KMS. Defaults to HBR_PRIVATE.

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

RedundancyType string

The redundancy type of the vault. Valid values: LRS, and ZRS. Defaults to LRS.

  • LRS: means locally redundant storage, data will be stored on different storage devices in the same zone.
  • ZRS: means zone-redundant storage, the data will be replicated across three storage clusters in a single region. Each storage cluster is physically separated but within the same region.
VaultStorageClass string

The storage class of Vault. Valid values: STANDARD.

VaultType string

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

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. Valid values: HBR_PRIVATE,KMS. Defaults to HBR_PRIVATE.

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

RedundancyType string

The redundancy type of the vault. Valid values: LRS, and ZRS. Defaults to LRS.

  • LRS: means locally redundant storage, data will be stored on different storage devices in the same zone.
  • ZRS: means zone-redundant storage, the data will be replicated across three storage clusters in a single region. Each storage cluster is physically separated but within the same region.
VaultStorageClass string

The storage class of Vault. Valid values: STANDARD.

VaultType string

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

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. Valid values: HBR_PRIVATE,KMS. Defaults to HBR_PRIVATE.

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

redundancyType String

The redundancy type of the vault. Valid values: LRS, and ZRS. Defaults to LRS.

  • LRS: means locally redundant storage, data will be stored on different storage devices in the same zone.
  • ZRS: means zone-redundant storage, the data will be replicated across three storage clusters in a single region. Each storage cluster is physically separated but within the same region.
vaultStorageClass String

The storage class of Vault. Valid values: STANDARD.

vaultType String

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

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. Valid values: HBR_PRIVATE,KMS. Defaults to HBR_PRIVATE.

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

redundancyType string

The redundancy type of the vault. Valid values: LRS, and ZRS. Defaults to LRS.

  • LRS: means locally redundant storage, data will be stored on different storage devices in the same zone.
  • ZRS: means zone-redundant storage, the data will be replicated across three storage clusters in a single region. Each storage cluster is physically separated but within the same region.
vaultStorageClass string

The storage class of Vault. Valid values: STANDARD.

vaultType string

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

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. Valid values: HBR_PRIVATE,KMS. Defaults to HBR_PRIVATE.

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

redundancy_type str

The redundancy type of the vault. Valid values: LRS, and ZRS. Defaults to LRS.

  • LRS: means locally redundant storage, data will be stored on different storage devices in the same zone.
  • ZRS: means zone-redundant storage, the data will be replicated across three storage clusters in a single region. Each storage cluster is physically separated but within the same region.
vault_storage_class str

The storage class of Vault. Valid values: STANDARD.

vault_type str

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

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. Valid values: HBR_PRIVATE,KMS. Defaults to HBR_PRIVATE.

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

redundancyType String

The redundancy type of the vault. Valid values: LRS, and ZRS. Defaults to LRS.

  • LRS: means locally redundant storage, data will be stored on different storage devices in the same zone.
  • ZRS: means zone-redundant storage, the data will be replicated across three storage clusters in a single region. Each storage cluster is physically separated but within the same region.
vaultStorageClass String

The storage class of Vault. Valid values: STANDARD.

vaultType String

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

Outputs

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

Id string

The provider-assigned unique ID for this managed resource.

Status string

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

Id string

The provider-assigned unique ID for this managed resource.

Status string

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

id String

The provider-assigned unique ID for this managed resource.

status String

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

id string

The provider-assigned unique ID for this managed resource.

status string

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

id str

The provider-assigned unique ID for this managed resource.

status str

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

id String

The provider-assigned unique ID for this managed resource.

status String

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

Look up an 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,
        description: Optional[str] = None,
        encrypt_type: Optional[str] = None,
        kms_key_id: Optional[str] = None,
        redundancy_type: Optional[str] = None,
        status: Optional[str] = None,
        vault_name: Optional[str] = None,
        vault_storage_class: Optional[str] = None,
        vault_type: Optional[str] = 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)
Resource lookup is not supported in YAML
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:
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. Valid values: HBR_PRIVATE,KMS. Defaults to HBR_PRIVATE.

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

RedundancyType string

The redundancy type of the vault. Valid values: LRS, and ZRS. Defaults to LRS.

  • LRS: means locally redundant storage, data will be stored on different storage devices in the same zone.
  • ZRS: means zone-redundant storage, the data will be replicated across three storage clusters in a single region. Each storage cluster is physically separated but within the same region.
Status string

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

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.

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. Valid values: HBR_PRIVATE,KMS. Defaults to HBR_PRIVATE.

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

RedundancyType string

The redundancy type of the vault. Valid values: LRS, and ZRS. Defaults to LRS.

  • LRS: means locally redundant storage, data will be stored on different storage devices in the same zone.
  • ZRS: means zone-redundant storage, the data will be replicated across three storage clusters in a single region. Each storage cluster is physically separated but within the same region.
Status string

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

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.

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. Valid values: HBR_PRIVATE,KMS. Defaults to HBR_PRIVATE.

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

redundancyType String

The redundancy type of the vault. Valid values: LRS, and ZRS. Defaults to LRS.

  • LRS: means locally redundant storage, data will be stored on different storage devices in the same zone.
  • ZRS: means zone-redundant storage, the data will be replicated across three storage clusters in a single region. Each storage cluster is physically separated but within the same region.
status String

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

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.

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. Valid values: HBR_PRIVATE,KMS. Defaults to HBR_PRIVATE.

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

redundancyType string

The redundancy type of the vault. Valid values: LRS, and ZRS. Defaults to LRS.

  • LRS: means locally redundant storage, data will be stored on different storage devices in the same zone.
  • ZRS: means zone-redundant storage, the data will be replicated across three storage clusters in a single region. Each storage cluster is physically separated but within the same region.
status string

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

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.

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. Valid values: HBR_PRIVATE,KMS. Defaults to HBR_PRIVATE.

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

redundancy_type str

The redundancy type of the vault. Valid values: LRS, and ZRS. Defaults to LRS.

  • LRS: means locally redundant storage, data will be stored on different storage devices in the same zone.
  • ZRS: means zone-redundant storage, the data will be replicated across three storage clusters in a single region. Each storage cluster is physically separated but within the same region.
status str

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

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.

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. Valid values: HBR_PRIVATE,KMS. Defaults to HBR_PRIVATE.

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

redundancyType String

The redundancy type of the vault. Valid values: LRS, and ZRS. Defaults to LRS.

  • LRS: means locally redundant storage, data will be stored on different storage devices in the same zone.
  • ZRS: means zone-redundant storage, the data will be replicated across three storage clusters in a single region. Each storage cluster is physically separated but within the same region.
status String

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

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.

Import

HBR Vault can be imported using the id, e.g.

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

Package Details

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

This Pulumi package is based on the alicloud Terraform Provider.