バックアップボールトに関する情報を照会する方法について説明します。 - Resource Orchestration Service

DATASOURCE::HBR::Vaults は、バックアップボールトに関する基本情報を照会するために使用されます。

構文

{
  "Type": "DATASOURCE::HBR::Vaults",
  "Properties": {
    "VaultType": String,
    "VaultId": String,
    "RefreshOptions": String
  }
}

プロパティ

プロパティ	タイプ	必須	編集可能	説明	制約
VaultType	String	いいえ	はい	バックアップボールトのタイプ。	有効な値: STANDARD: 標準バックアップボールト OTS_BACKUP: Tablestore 用のバックアップボールト
VaultId	String	いいえ	はい	バックアップボールトの ID。	なし。
RefreshOptions	String	いいえ	はい	スタックが更新されたときのデータソースリソースの更新ポリシー。	有効な値: Never（デフォルト）: スタックが更新されたときにデータソースリソースを更新しません。 Always: スタックが更新されたときにデータソースリソースを更新します。

戻り値

Fn::GetAtt

VaultIds: バックアップボールトの ID。
Vaults: バックアップボールトの詳細。

プロパティ	タイプ	説明	制約
VaultIds	List	バックアップボールトの ID。	なし。
Vaults	List	バックアップボールトの詳細。	なし。
ReplicationSourceVaultId	String	ソースボールトの ID。	なし。
Replication	String	バックアップボールトがリモートバックアップボールトかどうかを示します。	なし。
ReplicationProgress	String	バックアップボールトからミラーボールトへのデータ同期処理の進捗状況。	なし。
ReplicationSourceRegionId	String	ソースボールトのリージョン ID。	なし。
LatestReplicationTime	String	最新のリモートバックアップが同期された時刻。	なし。
Status	String	バックアップボールトのステータス。	なし。
EncryptType	String	ソースデータを暗号化するために使用される方式。	なし。
RedundancyType	String	バックアップボールトのデータ冗長性タイプ。	なし。
BackupPlanStatistics	String	バックアップボールトを使用するバックアッププランの統計情報。	なし。
VaultId	String	バックアップボールトの ID。	なし。
PaymentType	String	課金方式。	なし。
StorageSize	String	バックアップボールトの使用量。	単位：バイト。
VaultStatusMessage	String	バックアップボールトが ERROR 状態のときに返されるステータスメッセージ。	なし。
KmsKeyId	String	Key Management Service（KMS）のカスタムキーまたは KMS キーのエイリアス。	なし。
VaultStorageClass	String	バックアップボールトのストレージクラス。	なし。
VaultType	String	バックアップボールトのタイプ。	なし。
CreateTime	String	バックアップボールトが作成された時刻。	なし。
IndexAvailable	String	インデックスが使用可能かどうかを示します。	なし。
Dedup	String	重複除外機能が有効かどうかを示します。	なし。
ResourceGroupId	String	リソースグループの ID。	なし。
IndexUpdateTime	String	インデックスが更新された時刻。	なし。
TrialInfo	String	無料トライアルに関する情報。	なし。
Tags	String	バックアップボールトのタグ。	なし。
VaultName	String	バックアップボールトの名前。	なし。
IndexLevel	String	インデックスレベル。	なし。
Retention	String	バックアップボールトの保持期間。	なし。
SourceTypes	String	データソースに関する情報。	なし。
Description	String	バックアップボールトの説明。	なし。
BytesDone	String	バックアップされたデータ量。	単位：バイト。
SearchEnabled	String	バックアップ検索機能が有効かどうかを示します。	なし。
RegionId	String	リージョン ID。	なし。
UpdatedTime	String	バックアップボールトが更新された時刻。	なし。

例

YAML

ROSTemplateFormatVersion: '2015-09-01'
Parameters:
  VaultId:
    Description: VaultId.  # VaultId。
    Type: String
Resources:
  ExtensionDataSource:
    Properties:
      VaultId:
        Ref: VaultId
    Type: DATASOURCE::HBR::Vaults
Outputs:
  VaultIds:
    Description: The list of vault IDs. # ボールト ID のリスト。
    Value:
      Fn::GetAtt:
      - ExtensionDataSource
      - VaultIds
  Vaults:
    Description: The list of vaults. # ボールトのリスト。
    Value:
      Fn::GetAtt:
      - ExtensionDataSource
      - Vaults

JSON

{
  "ROSTemplateFormatVersion": "2015-09-01",
  "Parameters": {
    "VaultId": {
      "Type": "String",
      "Description": "VaultId." // VaultId。
    }
  },
  "Resources": {
    "ExtensionDataSource": {
      "Type": "DATASOURCE::HBR::Vaults",
      "Properties": {
        "VaultId": {
          "Ref": "VaultId"
        }
      }
    }
  },
  "Outputs": {
    "VaultIds": {
      "Description": "The list of vault IDs.", // ボールト ID のリスト。
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "VaultIds"
        ]
      }
    },
    "Vaults": {
      "Description": "The list of vaults.", // ボールトのリスト。
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "Vaults"
        ]
      }
    }
  }
}