ALIYUN::HBR::Vault - Criar cofre de backup do HBR - Resource Orchestration Service: Central de Documentação do Alibaba Cloud

Sintaxe

{
  "Type": "ALIYUN::HBR::Vault",
  "Properties": {
    "VaultType": String,
    "Description": String,
    "EncryptType": String,
    "ResourceGroupId": String,
    "KmsKeyId": String,
    "VaultName": String,
    "RedundancyType": String,
    "VaultStorageClass": String,
    "Tags": List
  }
}

Propriedades

Propriedade	Tipo	Obrigatório	Editável	Descrição	Restrição
VaultType	String	Sim	Não	Tipo do cofre.	Valores válidos: STANDARD: Cofre de backup padrão. OTS_BACKUP: Cofre de backup do Tablestore.
Description	String	Não	Sim	Descrição do cofre.	Máximo de 255 caracteres.
EncryptType	String	Não	Não	Método de criptografia dos dados de source.	Valores válidos: HBR_PRIVATE: Criptografia nativa do HBR. KMS: Criptografia com chave KMS personalizada. Aplica-se apenas quando VaultType é STANDARD ou OTS_BACKUP.
ResourceGroupId	String	Não	Sim	ID do grupo de recursos.	Nenhuma.
KmsKeyId	String	Não	Não	ID ou alias da chave KMS.	Obrigatório quando EncryptType é KMS.
VaultName	String	Sim	Sim	Nome do cofre.	De 1 a 64 caracteres.
RedundancyType	String	Não	Não	Tipo de redundância de dados.	Valores válidos: LRS: Armazenamento localmente redundante. O HBR armazena cópias de cada objeto em vários dispositivos de instalações diferentes na mesma zona para garantir durabilidade e disponibilidade. ZRS: Armazenamento com redundância de zona. O HBR distribui os dados entre três zonas na mesma região. Se uma zona falhar, os dados nas outras duas zonas permanecerão acessíveis.
VaultStorageClass	String	Não	Não	Classe de armazenamento do cofre.	Somente STANDARD (armazenamento padrão) é compatível.
Tags	List	Não	Sim	Tags do cofre.	Até 20 tags.

Sintaxe de Tags

"Tags": [
  {
    "Value": String,
    "Key": String
  }
]

Propriedades de Tags

Propriedade	Tipo	Obrigatório	Editável	Descrição	Restrição
Value	String	Não	Não	Valor da tag.	Máximo de 128 caracteres. Não pode conter `http://` ou `https://`. Não pode começar com `aliyun` ou `acs:`.
Key	String	Sim	Não	Chave da tag.	De 1 a 128 caracteres. Não pode conter http:// ou https://. Não pode começar com aliyun ou acs:.

Valores de retorno

Fn::GetAtt

Description: Descrição do cofre.
ResourceGroupId: ID do grupo de recursos.
TrialInfo: Informações sobre o período de avaliação gratuito.
ReplicationSourceRegionId: ID da região do cofre de source.
IndexUpdateTime: Hora da última atualização do índice.
VaultId: ID do cofre.
Retention: Período de retenção do cofre.
Dedup: Indica se a deduplicação está ativada.
VaultStatusMessage: Mensagem de status retornada quando o cofre está no estado ERROR.
BytesDone: Quantidade de dados de backup, em bytes.
ReplicationProgress: Progresso da sincronização de dados para o cofre espelho.
PaymentType: Método de faturamento do cofre.
BackupPlanStatistics: Estatísticas dos planos de backup que utilizam este cofre.
Tags: Tags do cofre.
VaultName: Nome do cofre.
RedundancyType: Tipo de redundância de dados do cofre.
VaultStorageClass: Classe de armazenamento do cofre.
CreateTime: Hora de criação do cofre, como timestamp UNIX em segundos.
StorageSize: Uso de armazenamento do cofre, em bytes.
ReplicationSourceVaultId: ID do cofre de source.
VaultType: Tipo do cofre.
LatestReplicationTime: Hora do último backup remoto bem-sucedido.
Replication: Indica se este é um cofre de backup remoto.
IndexLevel: Nível do índice.
UpdatedTime: Hora da última atualização do cofre.
SourceTypes: Tipos de fonte de dados.
IndexAvailable: Indica se os índices estão disponíveis.
SearchEnabled: Indica se a busca de backup está ativada.

Exemplos

YAML format

ROSTemplateFormatVersion: '2015-09-01'
Parameters:
  VaultName:
    Description: The name of the backup vault. The name must be 1 to 64 characters
      in length.
    MaxLength: 64
    MinLength: 1
    Type: String
    Default: test-valut
Resources:
  ExtensionResource:
    Properties:
      VaultName:
        Ref: VaultName
      VaultType: STANDARD
    Type: ALIYUN::HBR::Vault
Outputs:
  BackupPlanStatistics:
    Description: The statistics of backup plans that use the backup vault.
    Value:
      Fn::GetAtt:
      - ExtensionResource
      - BackupPlanStatistics
  BytesDone:
    Description: 'The amount of data that is backed up. Unit: bytes.'
    Value:
      Fn::GetAtt:
      - ExtensionResource
      - BytesDone
  CreateTime:
    Description: 'The time when the backup vault was created. This value is a UNIX
      timestamp. Unit: seconds.'
    Value:
      Fn::GetAtt:
      - ExtensionResource
      - CreateTime
  Dedup:
    Description: Indicates whether the deduplication feature is enabled.
    Value:
      Fn::GetAtt:
      - ExtensionResource
      - Dedup
  Description:
    Description: The description of the backup vault.
    Value:
      Fn::GetAtt:
      - ExtensionResource
      - Description
  IndexAvailable:
    Description: Indicates whether indexes are available. Indexes are available when
      they are not being updated.
    Value:
      Fn::GetAtt:
      - ExtensionResource
      - IndexAvailable
  IndexLevel:
    Description: 'The index level.

      - **OFF**: No indexes are created.

      - **META**: Metadata indexes are created.

      - **ALL**: Full-text indexes are created.'
    Value:
      Fn::GetAtt:
      - ExtensionResource
      - IndexLevel
  IndexUpdateTime:
    Description: The time when the index was updated.
    Value:
      Fn::GetAtt:
      - ExtensionResource
      - IndexUpdateTime
  LatestReplicationTime:
    Description: 'The time when the last remote backup was synchronized. This value
      is a UNIX timestamp. Unit: seconds.'
    Value:
      Fn::GetAtt:
      - ExtensionResource
      - LatestReplicationTime
  PaymentType:
    Description: PaymentType.
    Value:
      Fn::GetAtt:
      - ExtensionResource
      - PaymentType
  RedundancyType:
    Description: 'The data redundancy type of the backup vault. Valid values:

      - **LRS**: Locally redundant storage (LRS) is enabled for the backup vault.
      HBR stores the copies of each object on multiple devices of different facilities
      in the same zone. This way, HBR ensures data durability and availability even
      if hardware failures occur.

      - **ZRS**: Zone-redundant storage (ZRS) is enabled for the backup vault. HBR
      uses the multi-zone mechanism to distribute data across three zones within the
      same region. If a zone fails, the data that is stored in the other two zones
      is still accessible.'
    Value:
      Fn::GetAtt:
      - ExtensionResource
      - RedundancyType
  Replication:
    Description: 'Indicates whether the backup vault is a remote backup vault. Valid
      values:

      - **true**: The backup vault is a remote backup vault.

      - **false**: The backup vault is an on-premises backup vault.'
    Value:
      Fn::GetAtt:
      - ExtensionResource
      - Replication
  ReplicationProgress:
    Description: The progress of data synchronization from the backup vault to the
      mirror vault.
    Value:
      Fn::GetAtt:
      - ExtensionResource
      - ReplicationProgress
  ReplicationSourceRegionId:
    Description: The ID of the region where the remote backup vault resides.
    Value:
      Fn::GetAtt:
      - ExtensionResource
      - ReplicationSourceRegionId
  ReplicationSourceVaultId:
    Description: The ID of the source vault that corresponds to the remote backup
      vault.
    Value:
      Fn::GetAtt:
      - ExtensionResource
      - ReplicationSourceVaultId
  ResourceGroupId:
    Description: The ID of the resource group.
    Value:
      Fn::GetAtt:
      - ExtensionResource
      - ResourceGroupId
  Retention:
    Description: 'The retention period of the backup vault. Unit: days.'
    Value:
      Fn::GetAtt:
      - ExtensionResource
      - Retention
  SearchEnabled:
    Description: Indicates whether the backup search feature is enabled.
    Value:
      Fn::GetAtt:
      - ExtensionResource
      - SearchEnabled
  SourceTypes:
    Description: The information about the data source.
    Value:
      Fn::GetAtt:
      - ExtensionResource
      - SourceTypes
  StorageSize:
    Description: 'The usage of the backup vault. Unit: bytes.'
    Value:
      Fn::GetAtt:
      - ExtensionResource
      - StorageSize
  Tags:
    Description: The tags of the backup vault.
    Value:
      Fn::GetAtt:
      - ExtensionResource
      - Tags
  TrialInfo:
    Description: The free trial information.
    Value:
      Fn::GetAtt:
      - ExtensionResource
      - TrialInfo
  UpdatedTime:
    Description: 'The time when the backup vault was updated. This value is a UNIX
      timestamp. Unit: seconds.'
    Value:
      Fn::GetAtt:
      - ExtensionResource
      - UpdatedTime
  VaultId:
    Description: The ID of the backup vault.
    Value:
      Fn::GetAtt:
      - ExtensionResource
      - VaultId
  VaultName:
    Description: The name of the backup vault.
    Value:
      Fn::GetAtt:
      - ExtensionResource
      - VaultName
  VaultStatusMessage:
    Description: 'The status message that is returned when the backup vault is in
      the ERROR state. This parameter is available only for remote backup vaults.
      Valid values:

      - **UNKNOWN_ERROR*: An unknown error occurs.

      - **SOURCE_VAULT_ALREADY_HAS_REPLICATION**: A mirror vault is configured for
      the source vault.'
    Value:
      Fn::GetAtt:
      - ExtensionResource
      - VaultStatusMessage
  VaultStorageClass:
    Description: 'The storage type of the backup vault. Valid value: **STANDARD**,
      which indicates standard storage.'
    Value:
      Fn::GetAtt:
      - ExtensionResource
      - VaultStorageClass
  VaultType:
    Description: 'The type of the backup vault. Valid value: **STANDARD**, which indicates
      a standard backup vault.'
    Value:
      Fn::GetAtt:
      - ExtensionResource
      - VaultType

JSON format

{
  "ROSTemplateFormatVersion": "2015-09-01",
  "Parameters": {
    "VaultName": {
      "Description": "The name of the backup vault. The name must be 1 to 64 characters in length.",
      "MaxLength": 64,
      "MinLength": 1,
      "Type": "String",
      "Default": "test-valut"
    }
  },
  "Resources": {
    "ExtensionResource": {
      "Properties": {
        "VaultName": {
          "Ref": "VaultName"
        },
        "VaultType": "STANDARD"
      },
      "Type": "ALIYUN::HBR::Vault"
    }
  },
  "Outputs": {
    "BackupPlanStatistics": {
      "Description": "The statistics of backup plans that use the backup vault.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionResource",
          "BackupPlanStatistics"
        ]
      }
    },
    "BytesDone": {
      "Description": "The amount of data that is backed up. Unit: bytes.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionResource",
          "BytesDone"
        ]
      }
    },
    "CreateTime": {
      "Description": "The time when the backup vault was created. This value is a UNIX timestamp. Unit: seconds.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionResource",
          "CreateTime"
        ]
      }
    },
    "Dedup": {
      "Description": "Indicates whether the deduplication feature is enabled.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionResource",
          "Dedup"
        ]
      }
    },
    "Description": {
      "Description": "The description of the backup vault.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionResource",
          "Description"
        ]
      }
    },
    "IndexAvailable": {
      "Description": "Indicates whether indexes are available. Indexes are available when they are not being updated.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionResource",
          "IndexAvailable"
        ]
      }
    },
    "IndexLevel": {
      "Description": "The index level.\n- **OFF**: No indexes are created.\n- **META**: Metadata indexes are created.\n- **ALL**: Full-text indexes are created.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionResource",
          "IndexLevel"
        ]
      }
    },
    "IndexUpdateTime": {
      "Description": "The time when the index was updated.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionResource",
          "IndexUpdateTime"
        ]
      }
    },
    "LatestReplicationTime": {
      "Description": "The time when the last remote backup was synchronized. This value is a UNIX timestamp. Unit: seconds.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionResource",
          "LatestReplicationTime"
        ]
      }
    },
    "PaymentType": {
      "Description": "PaymentType.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionResource",
          "PaymentType"
        ]
      }
    },
    "RedundancyType": {
      "Description": "The data redundancy type of the backup vault. Valid values:\n- **LRS**: Locally redundant storage (LRS) is enabled for the backup vault. HBR stores the copies of each object on multiple devices of different facilities in the same zone. This way, HBR ensures data durability and availability even if hardware failures occur.\n- **ZRS**: Zone-redundant storage (ZRS) is enabled for the backup vault. HBR uses the multi-zone mechanism to distribute data across three zones within the same region. If a zone fails, the data that is stored in the other two zones is still accessible.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionResource",
          "RedundancyType"
        ]
      }
    },
    "Replication": {
      "Description": "Indicates whether the backup vault is a remote backup vault. Valid values:\n- **true**: The backup vault is a remote backup vault.\n- **false**: The backup vault is an on-premises backup vault.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionResource",
          "Replication"
        ]
      }
    },
    "ReplicationProgress": {
      "Description": "The progress of data synchronization from the backup vault to the mirror vault.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionResource",
          "ReplicationProgress"
        ]
      }
    },
    "ReplicationSourceRegionId": {
      "Description": "The ID of the region where the remote backup vault resides.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionResource",
          "ReplicationSourceRegionId"
        ]
      }
    },
    "ReplicationSourceVaultId": {
      "Description": "The ID of the source vault that corresponds to the remote backup vault.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionResource",
          "ReplicationSourceVaultId"
        ]
      }
    },
    "ResourceGroupId": {
      "Description": "The ID of the resource group.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionResource",
          "ResourceGroupId"
        ]
      }
    },
    "Retention": {
      "Description": "The retention period of the backup vault. Unit: days.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionResource",
          "Retention"
        ]
      }
    },
    "SearchEnabled": {
      "Description": "Indicates whether the backup search feature is enabled.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionResource",
          "SearchEnabled"
        ]
      }
    },
    "SourceTypes": {
      "Description": "The information about the data source.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionResource",
          "SourceTypes"
        ]
      }
    },
    "StorageSize": {
      "Description": "The usage of the backup vault. Unit: bytes.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionResource",
          "StorageSize"
        ]
      }
    },
    "Tags": {
      "Description": "The tags of the backup vault.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionResource",
          "Tags"
        ]
      }
    },
    "TrialInfo": {
      "Description": "The free trial information.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionResource",
          "TrialInfo"
        ]
      }
    },
    "UpdatedTime": {
      "Description": "The time when the backup vault was updated. This value is a UNIX timestamp. Unit: seconds.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionResource",
          "UpdatedTime"
        ]
      }
    },
    "VaultId": {
      "Description": "The ID of the backup vault.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionResource",
          "VaultId"
        ]
      }
    },
    "VaultName": {
      "Description": "The name of the backup vault.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionResource",
          "VaultName"
        ]
      }
    },
    "VaultStatusMessage": {
      "Description": "The status message that is returned when the backup vault is in the ERROR state. This parameter is available only for remote backup vaults. Valid values:\n- **UNKNOWN_ERROR*: An unknown error occurs.\n- **SOURCE_VAULT_ALREADY_HAS_REPLICATION**: A mirror vault is configured for the source vault.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionResource",
          "VaultStatusMessage"
        ]
      }
    },
    "VaultStorageClass": {
      "Description": "The storage type of the backup vault. Valid value: **STANDARD**, which indicates standard storage.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionResource",
          "VaultStorageClass"
        ]
      }
    },
    "VaultType": {
      "Description": "The type of the backup vault. Valid value: **STANDARD**, which indicates a standard backup vault.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionResource",
          "VaultType"
        ]
      }
    }
  }
}