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 | 否 | 是 | 投遞目標的容錯策略。 | 取值:
|
RetryPolicy | String | 否 | 是 | 投遞目標的重試策略。 | 取值:
|
TargetParam | String | 否 | 是 | 投遞目標的參數。 | 無 |
TargetName | String | 否 | 是 | 投遞目標的名稱。 | 無 |
返回值
Fn::GetAtt
TaskId:投遞任務ID。
示例
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
{
"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"
]
}
}
}
}