DATASOURCE::DBS::BackupPlan 概要 (RDS バックアッププラン用) - ROS

DATASOURCE::DBS::BackupPlan は、バックアップスケジュールの情報をクエリするために使用されます。

構文

{
  "Type": "DATASOURCE::DBS::BackupPlan",
  "Properties": {
    "BackupPlanId": String,
    "RefreshOptions": String
  }
}

プロパティ

プロパティ

タイプ

必須

編集可能

説明

制約

BackupPlanId

String

はい

バックアップスケジュールの ID。

なし。

RefreshOptions

String

いいえ

はい

スタックの更新時にデータソースリソースを更新するポリシー。

有効な値：

Never (デフォルト): スタックの更新時にデータソースリソースを更新しません。
Always: スタックの更新時にデータソースリソースを更新します。

戻り値

Fn::GetAtt

BackupPlanName: バックアップスケジュールの名前。
BackupObjects: バックアップオブジェクト。
ResourceGroupId: リソースグループの ID。
DatabaseType: データベースエンジンのタイプ。
CrossAliyunId: Alibaba Cloud アカウント間でバックアップを実行するために使用されるアカウントのユーザー ID。
SourceEndpointDatabaseName: データベースの名前。
SourceEndpointRegion: データベースのリージョン。
PaymentType: 課金方法。
BackupPlanId: バックアップスケジュールの ID。
BackupGatewayId: バックアップゲートウェイの ID。
SourceEndpointInstanceType: データベースの場所。
SourceEndpointUserName: データベースのアカウント。
BackupStorageType: 組み込みストレージタイプ。
CrossRoleName: Alibaba Cloud アカウント間でバックアップを実行するために使用される RAM ロールの名前。
DuplicationInfrequentAccessPeriod: バックアップデータのストレージタイプが低頻度アクセス (IA) に変更されるまでの日数。
BackupMethod: バックアップ方法。
BackupPeriod: 完全バックアップサイクル。
CreateTime: バックアップスケジュールが作成された日時を示すタイムスタンプ。
SourceEndpointInstanceId: データベースインスタンスの ID。
InstanceClass: バックアップスケジュールのタイプ。
SourceEndpointSid: データベースインスタンスのシステム ID (SID)。
DuplicationArchivePeriod: バックアップデータのストレージタイプがアーカイブに変更されるまでの日数。
BackupStartTime: 完全バックアップの開始時刻。
EnableBackupLog: 増分ログバックアップ機能が有効になっているかどうかを示します。
OssBucketName: Object Storage Service (OSS) バケットの名前。
BackupRetentionPeriod: バックアップデータの保持期間。

例

YAML

ROSTemplateFormatVersion: '2015-09-01'
Parameters:
  BackupPlanId:
    Type: String
    Description:
      en: The ID of the backup plan.
    Required: true
Resources:
  ExtensionDataSource:
    Type: DATASOURCE::DBS::BackupPlan
    Properties:
      BackupPlanId:
        Ref: BackupPlanId
Outputs:
  BackupPlanName:
    Description: The name of the backup plan.
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - BackupPlanName
  BackupObjects:
    Description: The backup object.
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - BackupObjects
  ResourceGroupId:
    Description: The ID of the resource group.
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - ResourceGroupId
  DatabaseType:
    Description: Database type.
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - DatabaseType
  CrossAliyunId:
    Description: The UID that is backed up across Alibaba Cloud accounts.
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - CrossAliyunId
  SourceEndpointDatabaseName:
    Description: The name of the database.
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - SourceEndpointDatabaseName
  SourceEndpointRegion:
    Description: The region of the database.
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - SourceEndpointRegion
  PaymentType:
    Description: The billing method of the resource.
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - PaymentType
  BackupPlanId:
    Description: The ID of the backup plan.
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - BackupPlanId
  BackupGatewayId:
    Description: The ID of the backup gateway.
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - BackupGatewayId
  SourceEndpointInstanceType:
    Description: The location of the database.
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - SourceEndpointInstanceType
  SourceEndpointUserName:
    Description: Database account.
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - SourceEndpointUserName
  BackupStorageType:
    Description: Built-in storage class.
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - BackupStorageType
  CrossRoleName:
    Description: The name of the RAM role that is backed up across Alibaba Cloud accounts.
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - CrossRoleName
  DuplicationInfrequentAccessPeriod:
    Description: The storage time is converted to low-frequency access. The default time is 180 days.
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - DuplicationInfrequentAccessPeriod
  BackupMethod:
    Description: Backup method.
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - BackupMethod
  BackupPeriod:
    Description: Full backup cycle.
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - BackupPeriod
  CreateTime:
    Description: The creation time of the backup plans.
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - CreateTime
  SourceEndpointInstanceId:
    Description: The ID of the database instance.
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - SourceEndpointInstanceId
  InstanceClass:
    Description: Instance class.
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - InstanceClass
  SourceEndpointSid:
    Description: Oracle SID name.
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - SourceEndpointSid
  DuplicationArchivePeriod:
    Description: The storage time for conversion to archive cold standby is 365 days by default.
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - DuplicationArchivePeriod
  BackupStartTime:
    Description: The start time of full backup.
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - BackupStartTime
  EnableBackupLog:
    Description: Whether to enable incremental log backup.
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - EnableBackupLog
  OssBucketName:
    Description: OSS Bucket name.
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - OssBucketName
  BackupRetentionPeriod:
    Description: The retention period of backup data. Valid values: 0 to 1825. Default value: 730 days.
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - BackupRetentionPeriod

JSON

{
  "ROSTemplateFormatVersion": "2015-09-01",
  "Parameters": {
    "BackupPlanId": {
      "Type": "String",
      "Description": {
        "ja": "バックアッププランの ID。"
      },
      "Required": true
    }
  },
  "Resources": {
    "ExtensionDataSource": {
      "Type": "DATASOURCE::DBS::BackupPlan",
      "Properties": {
        "BackupPlanId": {
          "Ref": "BackupPlanId"
        }
      }
    }
  },
  "Outputs": {
    "BackupPlanName": {
      "Description": "バックアッププランの名前。",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "BackupPlanName"
        ]
      }
    },
    "BackupObjects": {
      "Description": "バックアップオブジェクト。",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "BackupObjects"
        ]
      }
    },
    "ResourceGroupId": {
      "Description": "リソースグループの ID。",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "ResourceGroupId"
        ]
      }
    },
    "DatabaseType": {
      "Description": "データベースタイプ。",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "DatabaseType"
        ]
      }
    },
    "CrossAliyunId": {
      "Description": "Alibaba Cloud アカウント間でバックアップされる UID。",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "CrossAliyunId"
        ]
      }
    },
    "SourceEndpointDatabaseName": {
      "Description": "データベースの名前。",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "SourceEndpointDatabaseName"
        ]
      }
    },
    "SourceEndpointRegion": {
      "Description": "データベースのリージョン。",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "SourceEndpointRegion"
        ]
      }
    },
    "PaymentType": {
      "Description": "リソースの課金方法。",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "PaymentType"
        ]
      }
    },
    "BackupPlanId": {
      "Description": "バックアッププランの ID。",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "BackupPlanId"
        ]
      }
    },
    "BackupGatewayId": {
      "Description": "バックアップゲートウェイの ID。",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "BackupGatewayId"
        ]
      }
    },
    "SourceEndpointInstanceType": {
      "Description": "データベースの場所。",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "SourceEndpointInstanceType"
        ]
      }
    },
    "SourceEndpointUserName": {
      "Description": "データベースアカウント。",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "SourceEndpointUserName"
        ]
      }
    },
    "BackupStorageType": {
      "Description": "組み込みストレージクラス。",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "BackupStorageType"
        ]
      }
    },
    "CrossRoleName": {
      "Description": "Alibaba Cloud アカウント間でバックアップされる RAM ロールの名前。",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "CrossRoleName"
        ]
      }
    },
    "DuplicationInfrequentAccessPeriod": {
      "Description": "ストレージ時間が低頻度アクセスに変換されます。デフォルト時間は 180 日です。",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "DuplicationInfrequentAccessPeriod"
        ]
      }
    },
    "BackupMethod": {
      "Description": "バックアップ方法。",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "BackupMethod"
        ]
      }
    },
    "BackupPeriod": {
      "Description": "完全バックアップサイクル。",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "BackupPeriod"
        ]
      }
    },
    "CreateTime": {
      "Description": "バックアッププランの作成時間。",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "CreateTime"
        ]
      }
    },
    "SourceEndpointInstanceId": {
      "Description": "データベースインスタンスの ID。",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "SourceEndpointInstanceId"
        ]
      }
    },
    "InstanceClass": {
      "Description": "インスタンスクラス。",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "InstanceClass"
        ]
      }
    },
    "SourceEndpointSid": {
      "Description": "Oracle SID 名。",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "SourceEndpointSid"
        ]
      }
    },
    "DuplicationArchivePeriod": {
      "Description": "アーカイブコールドスタンバイへの変換のストレージ時間は、デフォルトで 365 日です。",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "DuplicationArchivePeriod"
        ]
      }
    },
    "BackupStartTime": {
      "Description": "完全バックアップの開始時刻。",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "BackupStartTime"
        ]
      }
    },
    "EnableBackupLog": {
      "Description": "増分ログバックアップを有効にするかどうか。",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "EnableBackupLog"
        ]
      }
    },
    "OssBucketName": {
      "Description": "OSS バケット名。",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "OssBucketName"
        ]
      }
    },
    "BackupRetentionPeriod": {
      "Description": "バックアップデータの保持期間。有効な値: 0 ～ 1825。デフォルト値: 730 日。",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "BackupRetentionPeriod"
        ]
      }
    }
  }
}