DATASOURCE::ARMS::SyntheticTask リソースリファレンス - ROS

DATASOURCE::ARMS::SyntheticTask は、スケジュールされた合成監視タスクに関する情報をクエリするために使用されます。

構文

{
  "Type": "DATASOURCE::ARMS::SyntheticTask",
  "Properties": {
    "TaskId": String,
    "RefreshOptions": String
  }
}

プロパティ

プロパティ

タイプ

必須

編集可能

説明

制約

TaskId

String

はい

タスク ID。

なし。

RefreshOptions

String

いいえ

はい

スタックの更新時のデータソースリソースのリフレッシュポリシー。

有効な値:

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

戻り値

Fn::GetAtt

TaskId: タスク ID。
ResourceGroupId: リソースグループ ID。
CustomPeriod: カスタムサイクル。
MonitorConf: タスクの構成。
AvailableAssertions: アサーション。
TaskType: タスクタイプ。
Monitors: 検出ポイント。
Frequency: 合成監視が実行される間隔。
MonitorCategory: 検出ポイントのタイプ。
SyntheticTaskName: タスク名。
Tags: タスクに追加されたタグ。
CommonSetting: 一般設定。

例

YAML

ROSTemplateFormatVersion: '2015-09-01'
Parameters:
  TaskId:
    Type: String
    Description:
      ja: 合成監視タスクの ID。
    Required: true
  RefreshOptions:
    Type: String
    Description:
      ja: |-
        スタックの更新時のデータソースリソースのリフレッシュ方法。有効な値:
        - Never: スタックの更新時にデータソースリソースをリフレッシュしません。
        - Always: スタックの更新時にデータソースリソースをリフレッシュします。
        デフォルトは Never です。
    AllowedValues:
      - Always
      - Never
    Required: false
    Default: Never
Resources:
  ExtensionDataSource:
    Type: DATASOURCE::ARMS::SyntheticTask
    Properties:
      TaskId:
        Ref: TaskId
      RefreshOptions:
        Ref: RefreshOptions
Outputs:
  TaskId:
    Description: 合成監視タスクの ID。
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - TaskId
  ResourceGroupId:
    Description: リソースグループの ID。
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - ResourceGroupId
  CustomPeriod:
    Description: カスタムサイクル。
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - CustomPeriod
  MonitorConf:
    Description: 監視構成。
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - MonitorConf
  AvailableAssertions:
    Description: アサーションのリスト。
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - AvailableAssertions
  TaskType:
    Description: タスクのタイプ。
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - TaskType
  Monitors:
    Description: 監視ポイントのリスト。
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - Monitors
  Frequency:
    Description: '検出頻度。'
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - Frequency
  MonitorCategory:
    Description: '検出ポイントタイプ。1: PC。2: モバイルデバイス。'
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - MonitorCategory
  SyntheticTaskName:
    Description: 合成タスクの名前。
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - SyntheticTaskName
  Tags:
    Description: インスタンスのタグ。
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - Tags
  CommonSetting:
    Description: 一般設定。
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - CommonSetting

JSON

{
  "ROSTemplateFormatVersion": "2015-09-01",
  "Parameters": {
    "TaskId": {
      "Type": "String",
      "Description": {
        "ja": "合成監視タスクの ID。"
      },
      "Required": true
    }
  },
  "Resources": {
    "ExtensionDataSource": {
      "Type": "DATASOURCE::ARMS::SyntheticTask",
      "Properties": {
        "TaskId": {
          "Ref": "TaskId"
        }
      }
    }
  },
  "Outputs": {
    "TaskId": {
      "Description": "合成監視タスクの ID。",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "TaskId"
        ]
      }
    },
    "ResourceGroupId": {
      "Description": "リソースグループの ID。",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "ResourceGroupId"
        ]
      }
    },
    "CustomPeriod": {
      "Description": "カスタムサイクル。",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "CustomPeriod"
        ]
      }
    },
    "MonitorConf": {
      "Description": "監視構成。",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "MonitorConf"
        ]
      }
    },
    "AvailableAssertions": {
      "Description": "アサーションのリスト。",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "AvailableAssertions"
        ]
      }
    },
    "TaskType": {
      "Description": "タスクのタイプ。",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "TaskType"
        ]
      }
    },
    "Monitors": {
      "Description": "監視ポイントのリスト。",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "Monitors"
        ]
      }
    },
    "Frequency": {
      "Description": "検出頻度。",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "Frequency"
        ]
      }
    },
    "MonitorCategory": {
      "Description": "検出ポイントタイプ。 1: PC。 2: モバイル デバイス。",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "MonitorCategory"
        ]
      }
    },
    "SyntheticTaskName": {
      "Description": "合成タスクの名前。",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "SyntheticTaskName"
        ]
      }
    },
    "Tags": {
      "Description": "インスタンスのタグ。",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "Tags"
        ]
      }
    },
    "CommonSetting": {
      "Description": "一般設定。",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "CommonSetting"
        ]
      }
    }
  }
}