ROS DeliverTask で ARMS メトリック配信を自動化 - ROS

ALIYUN::ARMS::DeliverTask は、配信タスクを作成するために使用されます。

構文

{
  "Type": "ALIYUN::ARMS::DeliverTask",
  "Properties": {
    "TargetList": List,
    "TaskName": String,
    "DataSourceName": String,
    "DataSourceId": String,
    "ExternalLabel": String,
    "FilterType": Boolean,
    "FilterList": String,
    "TaskDescription": String
  }
}

プロパティ

プロパティ	タイプ	必須	編集可能	説明	制約
TargetList	List	はい	はい	宛先リスト。	詳細については、「TargetList プロパティ」をご参照ください。
TaskName	String	はい	いいえ	配信タスクの名前。	なし。
DataSourceName	String	いいえ	はい	データソースの名前。	なし。
DataSourceId	String	いいえ	はい	データソースの ID。	なし。
ExternalLabel	String	いいえ	はい	配信タスクの外部ラベル。	なし。
FilterType	Boolean	いいえ	いいえ	データフィルタリングにホワイトリストを使用するかどうかを指定します。	デフォルト値は true です。
FilterList	String	いいえ	はい	データフィルタリングに使用されるメトリック。	メトリックは、正規表現、複数改行、および正確な配信のための複数の条件をサポートします。
TaskDescription	String	いいえ	いいえ	配信タスクの説明。	なし。

TargetList 構文

"TargetList": [
  {
    "TargetParam": String,
    "TargetType": String,
    "FaultTolerantPolicy": String,
    "TargetName": String,
    "RetryPolicy": String
  }
]

TargetList プロパティ

プロパティ	タイプ	必須	編集可能	説明	制約
TargetType	String	はい	はい	宛先のタイプ。	なし。
FaultTolerantPolicy	String	いいえ	はい	宛先のフォールトトレランスポリシー。	有効値: ALL（デフォルト）: フォールトトレランスが許可されます。エラーが発生した場合、実行は継続されます。 RetryPolicy プロパティで指定された再試行回数を超えた場合、メッセージはデッドレターキューに配信されるか、直接破棄されます。 NONE: フォールトトレランスは許可されません。エラーが発生し、 RetryPolicy プロパティで指定された再試行回数を超えた場合、実行はブロックされます。
RetryPolicy	String	いいえ	はい	宛先の再試行ポリシー。	有効値: BACKOFF_RETRY: 最大 3 回の再試行が許可されます。再試行間隔は 10 ～ 20 秒の範囲でランダムです。 EXPONENTIAL_DECAY_RETRY（デフォルト）: 最大 176 回の再試行が許可されます。再試行間隔は 1 秒から 512 秒まで指数関数的に増加します。合計再試行期間は 1 日です。
TargetParam	String	いいえ	はい	宛先パラメーター。	なし。
TargetName	String	いいえ	はい	宛先名。	なし。

戻り値

Fn::GetAtt

TasId: 配信タスクの ID。

例

YAML

ROSTemplateFormatVersion: '2015-09-01'
Parameters:
  TargetList:
    AssociationPropertyMetadata:
      Parameters:
        TargetParam:
          Type: String
          Description:
            en: The parameter of the target.
          Required: false
        TargetType:
          Type: String
          Description:
            en: The type of the target.
          Required: true
        FaultTolerantPolicy:
          Type: String
          Description:
            en: |-
              The fault tolerant policy of the target. Valid values:
              - ALL (default): Exception tolerance is allowed. When an exception occurs, the execution will not be blocked, and the message will be delivered to the dead message queue or dropped directly according to the configuration after exceeding the retry policy.
              - NONE: Fault tolerance is not allowed and execution is blocked when an exception occurs and exceeds the retry policy configuration.
          AllowedValues:
            - ALL
            - NONE
          Required: false
          Default: ALL
        TargetName:
          Type: String
          Description:
            en: The name of the target.
          Required: false
        RetryPolicy:
          Type: String
          Description:
            en: |-
              The retry policy of the target. Valid values:
              - BACKOFF_RETRY: retry three times, with a random interval between 10 and 20 seconds
              - EXPONENTIAL_DECAY_RETRY (default): retry 176 times, each retry interval exponentially increased to 512 seconds, total retry time is 1 day; The interval for each retry is: 1,2,4,8,... 512 seconds.
          AllowedValues:
            - BACKOFF_RETRY
            - EXPONENTIAL_DECAY_RETRY
          Required: false
          Default: EXPONENTIAL_DECAY_RETRY
    AssociationProperty: List[Parameters]
    Type: Json
    Description:
      en: The list of the target.
    Required: true
  TaskName:
    Type: String
    Description:
      en: The name of the task.
    AllowedPattern: '[a-zA-Z0-9-]{1,64}'
    Required: true
Resources:
  DeliverTask:
    Type: ALIYUN::ARMS::DeliverTask
    Properties:
      TargetList:
        Ref: TargetList
      TaskName:
        Ref: TaskName
Outputs:
  TaskId:
    Description: The ID of the task.
    Value:
      Fn::GetAtt:
        - DeliverTask
        - TaskId

JSON

{
  "ROSTemplateFormatVersion": "2015-09-01",
  "Parameters": {
    "TargetList": {
      "AssociationPropertyMetadata": {
        "Parameters": {
          "TargetParam": {
            "Type": "String",
            "Description": {
              "en": "The parameter of the target."
            },
            "Required": false
          },
          "TargetType": {
            "Type": "String",
            "Description": {
              "en": "The type of the target."
            },
            "Required": true
          },
          "FaultTolerantPolicy": {
            "Type": "String",
            "Description": {
              "en": "The fault tolerant policy of the target. Valid values:\n- ALL (default): Exception tolerance is allowed. When an exception occurs, the execution will not be blocked, and the message will be delivered to the dead message queue or dropped directly according to the configuration after exceeding the retry policy.\n- NONE: Fault tolerance is not allowed and execution is blocked when an exception occurs and exceeds the retry policy configuration."
            },
            "AllowedValues": [
              "ALL",
              "NONE"
            ],
            "Required": false,
            "Default": "ALL"
          },
          "TargetName": {
            "Type": "String",
            "Description": {
              "en": "The name of the target."
            },
            "Required": false
          },
          "RetryPolicy": {
            "Type": "String",
            "Description": {
              "en": "The retry policy of the target. Valid values:\n- BACKOFF_RETRY: retry three times, with a random interval between 10 and 20 seconds\n- EXPONENTIAL_DECAY_RETRY (default): retry 176 times, each retry interval exponentially increased to 512 seconds, total retry time is 1 day; The interval for each retry is: 1,2,4,8,... 512 seconds."
            },
            "AllowedValues": [
              "BACKOFF_RETRY",
              "EXPONENTIAL_DECAY_RETRY"
            ],
            "Required": false,
            "Default": "EXPONENTIAL_DECAY_RETRY"
          }
        }
      },
      "AssociationProperty": "List[Parameters]",
      "Type": "Json",
      "Description": {
        "en": "The list of the target."
      },
      "Required": true
    },
    "TaskName": {
      "Type": "String",
      "Description": {
        "en": "The name of the task."
      },
      "AllowedPattern": "[a-zA-Z0-9-]{1,64}",
      "Required": true
    }
  },
  "Resources": {
    "DeliverTask": {
      "Type": "ALIYUN::ARMS::DeliverTask",
      "Properties": {
        "TargetList": {
          "Ref": "TargetList"
        },
        "TaskName": {
          "Ref": "TaskName"
        }
      }
    }
  },
  "Outputs": {
    "TaskId": {
      "Description": "The ID of the task.",
      "Value": {
        "Fn::GetAtt": [
          "DeliverTask",
          "TaskId"
        ]
      }
    }
  }
}