ALIYUN::HBR::ReplicationVault - Resource Orchestration Service

The ALIYUN::HBR::ReplicationVault resource configures a replication vault.

Syntax

{
  "Type": "ALIYUN::HBR::ReplicationVault",
  "Properties": {
    "ReplicationSourceRegionId": String,
    "ReplicationSourceVaultId": String,
    "VaultName": String,
    "Description": String,
    "EncryptType": String,
    "KmsKeyId": String,
    "RedundancyType": String,
    "VaultStorageClass": String
  }
}

Properties

Parameter	Type	Required	Update allowed	Description	Constraints
ReplicationSourceRegionId	String	Yes	No	The region ID of the source vault for replication.	None
ReplicationSourceVaultId	String	Yes	No	The ID of the source vault for replication.	None
VaultName	String	Yes	Yes	The name of the vault.	Length: 1 to 64 characters.
Description	String	No	Yes	The description of the vault.	Length: 0 to 255 characters.
EncryptType	String	No	No	The encryption type of the vault.	Valid values: HBR_PRIVATE KMS
KmsKeyId	String	No	No	The KMS key ID used for encryption. This parameter is required when the EncryptType parameter is KMS.	None
RedundancyType	String	No	No	The redundancy type of the vault.	Valid values: LRS ZRS
VaultStorageClass	String	No	No	The storage class of the vault.	Valid values: STANDARD IA ARCHIVE

Return values

Fn::GetAtt

VaultId: The ID of the vault.

Examples

YAML

ROSTemplateFormatVersion: '2015-09-01'
Parameters:
  Description:
    Type: String
    AssociationProperty: TextArea
    Description:
      en: The description of the vault.
    Required: false
    MinLength: 0
    MaxLength: 255
  EncryptType:
    Type: String
    Description:
      en: The encryption type of the vault.
    AllowedValues:
      - HBR_PRIVATE
      - KMS
    Required: false
  KmsKeyId:
    Type: String
    Description:
      en: The KMS key ID used for encryption.
    Required: false
  VaultName:
    Type: String
    Description:
      en: The name of the vault.
    Required: true
    MinLength: 1
    MaxLength: 64
  VaultStorageClass:
    Type: String
    Description:
      en: The storage class of the vault.
    AllowedValues:
      - STANDARD
      - IA
      - ARCHIVE
    Required: false
  RedundancyType:
    Type: String
    Description:
      en: The redundancy type of the vault.
    AllowedValues:
      - LRS
      - ZRS
    Required: false
  ReplicationSourceRegionId:
    Type: String
    Description:
      en: The region ID of the source vault for replication.
    Required: true
  ReplicationSourceVaultId:
    Type: String
    Description:
      en: The ID of the source vault for replication.
    Required: true
Resources:
  ReplicationVault:
    Type: ALIYUN::HBR::ReplicationVault
    Properties:
      Description:
        Ref: Description
      EncryptType:
        Ref: EncryptType
      KmsKeyId:
        Ref: KmsKeyId
      VaultName:
        Ref: VaultName
      VaultStorageClass:
        Ref: VaultStorageClass
      RedundancyType:
        Ref: RedundancyType
      ReplicationSourceRegionId:
        Ref: ReplicationSourceRegionId
      ReplicationSourceVaultId:
        Ref: ReplicationSourceVaultId
Outputs:
  VaultId:
    Description: The ID of the vault.
    Value:
      Fn::GetAtt:
        - ReplicationVault
        - VaultId

JSON

                        {
  "ROSTemplateFormatVersion": "2015-09-01",
  "Parameters": {
    "Description": {
      "Type": "String",
      "AssociationProperty": "TextArea",
      "Description": {
        "en": "The description of the vault."
      },
      "Required": false,
      "MinLength": 0,
      "MaxLength": 255
    },
    "EncryptType": {
      "Type": "String",
      "Description": {
        "en": "The encryption type of the vault."
      },
      "AllowedValues": [
        "HBR_PRIVATE",
        "KMS"
      ],
      "Required": false
    },
    "KmsKeyId": {
      "Type": "String",
      "Description": {
        "en": "The KMS key ID used for encryption."
      },
      "Required": false
    },
    "VaultName": {
      "Type": "String",
      "Description": {
        "en": "The name of the vault."
      },
      "Required": true,
      "MinLength": 1,
      "MaxLength": 64
    },
    "VaultStorageClass": {
      "Type": "String",
      "Description": {
        "en": "The storage class of the vault."
      },
      "AllowedValues": [
        "STANDARD",
        "IA",
        "ARCHIVE"
      ],
      "Required": false
    },
    "RedundancyType": {
      "Type": "String",
      "Description": {
        "en": "The redundancy type of the vault."
      },
      "AllowedValues": [
        "LRS",
        "ZRS"
      ],
      "Required": false
    },
    "ReplicationSourceRegionId": {
      "Type": "String",
      "Description": {
        "en": "The region ID of the source vault for replication."
      },
      "Required": true
    },
    "ReplicationSourceVaultId": {
      "Type": "String",
      "Description": {
        "en": "The ID of the source vault for replication."
      },
      "Required": true
    }
  },
  "Resources": {
    "ReplicationVault": {
      "Type": "ALIYUN::HBR::ReplicationVault",
      "Properties": {
        "Description": {
          "Ref": "Description"
        },
        "EncryptType": {
          "Ref": "EncryptType"
        },
        "KmsKeyId": {
          "Ref": "KmsKeyId"
        },
        "VaultName": {
          "Ref": "VaultName"
        },
        "VaultStorageClass": {
          "Ref": "VaultStorageClass"
        },
        "RedundancyType": {
          "Ref": "RedundancyType"
        },
        "ReplicationSourceRegionId": {
          "Ref": "ReplicationSourceRegionId"
        },
        "ReplicationSourceVaultId": {
          "Ref": "ReplicationSourceVaultId"
        }
      }
    }
  },
  "Outputs": {
    "VaultId": {
      "Description": "The ID of the vault.",
      "Value": {
        "Fn::GetAtt": [
          "ReplicationVault",
          "VaultId"
        ]
      }
    }
  }
}