DATASOURCE::DBS::BackupPlans - ROS

DATASOURCE::DBS::BackupPlans は、バックアップスケジュールに関する情報を照会するために使用されます。

構文

{
  "Type": "DATASOURCE::DBS::BackupPlans",
  "Properties": {
    "BackupPlanName": String, // バックアップスケジュールの名前。
    "ResourceGroupId": String, // リソースグループ ID。
    "BackupPlanId": String, // バックアップスケジュール ID。
    "RefreshOptions": String // スタックの更新時のデータソースリソースのリフレッシュポリシー。
  }
}

プロパティ

プロパティ	タイプ	必須	編集可能	説明	制約
BackupPlanName	String	いいえ	はい	バックアップスケジュールの名前。	なし。
ResourceGroupId	String	いいえ	はい	リソースグループの ID。	なし。
BackupPlanId	String	いいえ	はい	バックアップスケジュールの ID。	なし。
RefreshOptions	String	いいえ	はい	スタックの更新時のデータソースリソースのリフレッシュポリシー。	有効な値: Never（デフォルト）: スタックの更新時にデータソースリソースをリフレッシュしません。 Always: スタックの更新時にデータソースリソースをリフレッシュします。

戻り値

Fn::GetAtt

BackupPlanIds: バックアップスケジュールの ID。
BackupPlans: バックアップスケジュールの詳細。

プロパティ	タイプ	説明	制約
BackupPlanIds	List	バックアップスケジュールの ID。	なし。
BackupPlans	List	バックアップスケジュールの詳細。	なし。
SourceEndpointUserName	String	データベースアカウント。	なし。
BackupObjects	String	バックアップされるオブジェクト。	なし。
EnableBackupLog	String	増量ログバックアップが有効かどうかを示します。	なし。
DuplicationArchivePeriod	String	バックアップデータのストレージクラスがアーカイブに変更されるまでの日数。	なし。
CrossAliyunId	String	Alibaba Cloud アカウント間で実行されるバックアップに使用されるアカウントの一意の識別子（UID）。	なし。
BackupStorageType	String	組み込みストレージタイプ。	なし。
SourceEndpointInstanceId	String	データベースインスタンスの ID。	なし。
BackupPlanId	String	バックアップスケジュールの ID。	なし。
Status	String	バックアップスケジュールのステータス。	なし。
OssBucketName	String	オブジェクトストレージサービス（OSS）バケットの名前。	なし。
SourceEndpointDatabaseName	String	データベース名。	なし。
ResourceGroupId	String	リソースグループの ID。	なし。
InstanceClass	String	バックアップスケジュールタイプ。	なし。
SourceEndpointRegion	String	データベースのリージョン。	なし。
CrossRoleName	String	Alibaba Cloud アカウント間で実行されるバックアップに使用されるResource Access Management（RAM）ロールの名前。	なし。
BackupRetentionPeriod	String	バックアップデータの保存期間。	有効な値: 0 ～ 1825。単位: 日。
BackupMethod	String	バックアップ方法。	なし。
BackupPeriod	String	フルバックアップサイクル。	なし。
BackupGatewayId	String	バックアップゲートウェイの ID。	なし。
SourceEndpointSid	String	データベースインスタンスのシステム ID（SID）。	なし。
DuplicationInfrequentAccessPeriod	String	バックアップデータのストレージクラスが低頻度アクセス（IA）に変更されるまでの日数。	単位: 日。
SourceEndpointInstanceType	String	データベースの場所。	なし。
BackupStartTime	String	フルバックアップの開始時刻。	時刻は ISO 8601 標準の HH:mm 形式に従います。
DatabaseType	String	データベースエンジンのタイプ。	なし。
BackupPlanName	String	バックアップスケジュールの名前。	なし。
CreateTime	String	バックアップスケジュールが作成された時刻。	なし。

例

`YAML` 形式

ROSTemplateFormatVersion: '2015-09-01'
Parameters:
  BackupPlanName:
    Description: バックアップスケジュールの名前。
    Type: String
Resources:
  ExtensionDataSource:
    Properties:
      BackupPlanName:
        Ref: BackupPlanName
    Type: DATASOURCE::DBS::BackupPlans
Outputs:
  BackupPlanIds:
    Description: バックアッププラン ID のリスト。
    Value:
      Fn::GetAtt:
      - ExtensionDataSource
      - BackupPlanIds
  BackupPlans:
    Description: バックアッププランのリスト。
    Value:
      Fn::GetAtt:
      - ExtensionDataSource
      - BackupPlans

`JSON` 形式

{
  "ROSTemplateFormatVersion": "2015-09-01",
  "Parameters": {
    "BackupPlanName": {
      "Type": "String",
      "Description": "バックアップスケジュールの名前。" // The name of the backup schedule.
    }
  },
  "Resources": {
    "ExtensionDataSource": {
      "Type": "DATASOURCE::DBS::BackupPlans",
      "Properties": {
        "BackupPlanName": {
          "Ref": "BackupPlanName"
        }
      }
    }
  },
  "Outputs": {
    "BackupPlanIds": {
      "Description": "バックアッププラン ID のリスト。", // The list of backup plan IDs.
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "BackupPlanIds"
        ]
      }
    },
    "BackupPlans": {
      "Description": "バックアッププランのリスト。", // The list of backup plans.
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "BackupPlans"
        ]
      }
    }
  }
}

構文

プロパティ

戻り値

例

YAML 形式

JSON 形式

`YAML` 形式

`JSON` 形式