調用ALIYUN::ESS::ScheduledTask根據指定參數建立定時任務 -

ALIYUN::ESS::ScheduledTask類型用於根據指定參數建立定時任務。

文法

{
  "Type": "ALIYUN::ESS::ScheduledTask",
  "Properties": {
    "TaskEnabled": Boolean,
    "Description": String,
    "ScheduledTaskName": String,
    "LaunchExpirationTime": Integer,
    "LaunchTime": String,
    "RecurrenceEndTime": String,
    "RecurrenceType": String,
    "RecurrenceValue": String,
    "ScheduledAction": String,
    "MaxValue": Integer,
    "MinValue": Integer,
    "DesiredCapacity": Integer,
    "ScalingGroupId": String
  }
}

屬性

屬性名稱	類型	必須	允許更新	描述	約束
TaskEnabled	Boolean	否	是	是否啟動定時任務	取值： true（預設值）：啟動任務 false：停止任務
Description	String	否	是	定時任務的描述資訊	長度為2~200個字元
ScheduledTaskName	String	否	是	定時任務的顯示名稱	長度為2~40個字元，以數字、字母或中文字元開頭，可包含數字、字母、中文字元、底線（_）、短劃線（-）或英文句點（.）。同一使用者帳號同一地區內唯一。如果沒有指定該參數，預設為ScheduledScalingTaskId。
LaunchExpirationTime	Integer	否	是	定時任務觸發操作失敗後，在此時間內重試	取值範圍：0~21600。單位：秒。預設值：600。
LaunchTime	String	是	是	定時任務觸發的時間點	格式為：`YYYY-MM-DDThh:mmZ`。按照ISO8601標準表示，並需要使用UTC時間。如果指定了RecurrenceType，則此屬性指定的時間點，預設為迴圈執行的時間點。如果未指定RecurrenceType，則按指定的日期和時間執行一次。不能填寫自建立或修改當天起90日後的時間。
RecurrenceEndTime	String	否	是	重複執行定時任務的結束時間	格式為：`YYYY-MM-DDThh:mmZ`。按照ISO8601標準表示，並需要使用UTC時間。不能填寫自建立或修改當天起90日後的時間。 RecurrenceType、RecurrenceValue和RecurrenceEndTime需要同時指定。
RecurrenceType	String	否	是	重複執行定時任務的類型	取值： Daily：每多少天重複執行一次定時任務。 Weekly：每周指定幾天重複執行一次定時任務。 Monthly：每月內指定幾天重複執行一次定時任務。 Cron：按照指定的Cron運算式執行定時任務。 RecurrenceType、RecurrenceValue和RecurrenceEndTime需要同時指定。
RecurrenceValue	String	否	是	重複執行定時任務的數值	取值： Daily：只能填一個值。取值範圍：1~31。 Weekly：可以填入多個值。周日、周一……周六的值依次為：0, 1,2,…, 6，多天使用半形逗號（,）分隔。 Monthly：格式為A-B。A、B的取值範圍為1~31，並且B必須大於等於A。 Cron：表示UTC時間，支援分、時、日、月、星期的5域運算式，支援半形逗號（,）、半形問號（?）、連字號（-）、星號（*）、井號（#）、正斜線（/）、L和W。 RecurrenceType、RecurrenceValue和RecurrenceEndTime需要同時指定。
ScheduledAction	String	否	是	定時任務觸發時需要執行的操作	最大支援200個字元。此處填寫伸縮規則的唯一識別碼。
MaxValue	Integer	否	是	定時任務的伸縮方式為設定伸縮組內執行個體數量時，指定伸縮組內執行個體的最大數量。	無
MinValue	Integer	否	是	定時任務的伸縮方式為設定伸縮組內執行個體數量時，指定伸縮組內執行個體的最小數量。	無
DesiredCapacity	Integer	否	是	定時任務的伸縮方式為設定伸縮組內執行個體數量時，指定伸縮組內執行個體的期望執行個體數。	伸縮組必須支援設定期望執行個體數，即在建立該伸縮組時指定了`DesiredCapacity`。
ScalingGroupId	String	否	是	定時任務觸發時需要修改執行個體數量的伸縮組，填寫伸縮組ID。	指定`ScalingGroupId`後，定時任務的伸縮方式為設定伸縮組內執行個體數量，您需要為`MinValue`、`MaxValue`和`DesiredCapacity`中至少一個參數指定數量。說明不支援同時設定`ScheduledAction`和`ScalingGroupId`。

傳回值

Fn::GetAtt

ScheduledTaskId：定時任務的ID，由系統產生，全域唯一。

樣本

YAML格式

ROSTemplateFormatVersion: '2015-09-01'
Resources:
  ScheduledTask:
    Type: ALIYUN::ESS::ScheduledTask
    Properties:
      TaskEnabled: 'true'
      Description: scheduledtask
      ScheduledTaskName: task1
      LaunchTime: 2014-08-17T16:52Z
      RecurrenceEndTime: 2014-08-17T16:55Z
      RecurrenceType: Daily
      RecurrenceValue: '1'
      ScheduledAction: ari:acs:ess:cn-qingdao:1344371:scalingRule/cCBpdYdQuBe2cUxOdu6piOk
Outputs:
  ScheduledTaskId:
    Value:
      FN::GetAtt:
        - ScheduledTask
        - ScheduledTaskId

JSON格式

{
  "ROSTemplateFormatVersion": "2015-09-01",
  "Resources": {
    "ScheduledTask": {
      "Type": "ALIYUN::ESS::ScheduledTask",
      "Properties": {
        "TaskEnabled": "true",
        "Description": "scheduledtask",
        "ScheduledTaskName": "task1",
        "LaunchTime": "2014-08-17T16:52Z",
        "RecurrenceEndTime": "2014-08-17T16:55Z",
        "RecurrenceType": "Daily",
        "RecurrenceValue": "1",
        "ScheduledAction": "ari:acs:ess:cn-qingdao:1344371:scalingRule/cCBpdYdQuBe2cUxOdu6piOk"
      }
    }
  },
  "Outputs": {
    "ScheduledTaskId": {
      "Value": {
        "FN::GetAtt": [
          "ScheduledTask",
          "ScheduledTaskId"
        ]
      }
    }
  }
}