すべてのプロダクト
Search

このプロダクト

    Resource Orchestration Service:ALIYUN::ESS::ScheduledTask

    ドキュメントセンター

    Resource Orchestration Service:ALIYUN::ESS::ScheduledTask

    最終更新日:Jan 16, 2025

    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 形式の ISO 8601 標準で時刻を指定します。

    時刻は UTC でなければなりません。

    • RecurrenceType を指定した場合、スケジュールされたタスクはデフォルトで LaunchTime で指定された時刻に繰り返し実行されます。

    • RecurrenceType を指定しない場合、スケジュールされたタスクは LaunchTime で指定された時刻に 1 回だけ実行されます。

    スケジュールされたタスクが作成または変更された日から 90 日より後の時点を指定することはできません。

    RecurrenceEndTime

    String

    いいえ

    はい

    繰り返し実行されるスケジュールされたタスクの終了時刻。

    YYYY-MM-DDThh:mmZ 形式の ISO 8601 標準で時刻を指定します。

    時刻は UTC でなければなりません。

    スケジュールされたタスクが作成または変更された日から 90 日より後の時点を指定することはできません。

    リクエストで次のプロパティを指定する必要があります：RecurrenceType、RecurrenceValue、および RecurrenceEndTime。

    RecurrenceType

    String

    いいえ

    はい

    スケジュールされたタスクが繰り返し実行される間隔。

    有効な値：

    • Daily：スケジュールされたタスクは指定された日数ごとに繰り返し実行されます。

    • Weekly：スケジュールされたタスクは毎週指定された曜日に繰り返し実行されます。

    • Monthly：スケジュールされたタスクは毎月指定された日に繰り返し実行されます。

    • Cron：スケジュールされたタスクは指定された CRON 式に基づいて繰り返し実行されます。

    リクエストで次のプロパティを指定する必要があります：RecurrenceType、RecurrenceValue、および RecurrenceEndTime。

    RecurrenceValue

    String

    いいえ

    はい

    繰り返し実行されるスケジュールされたタスクの繰り返し値。

    有効な値：

    • RecurrenceType を Daily に設定した場合、RecurrenceValue を 1 ～ 31 の範囲の値に設定する必要があります。

    • RecurrenceType を Weekly に設定した場合、RecurrenceValue を 0 ～ 6 の範囲の 1 つ以上の値に設定する必要があります。0 ～ 6 の範囲の整数は、日曜日から土曜日までの曜日を個別に指定します。複数の値はコンマ（,）で区切ります。

    • RecurrenceType を Monthly に設定した場合、RecurrenceValue を A-B 形式の 2 つの値に設定する必要があります。A と B は 1 ～ 31 の範囲です。B は A 以上である必要があります。

    • RecurrenceType を Cron に設定した場合、RecurrenceValue を CRON 式に設定する必要があります。CRON 式は UTC 時刻を示し、分、時、日、月、曜日というフィールドをサポートしています。CRON 式は、L および W の文字と、, ? - * # / という特殊文字をサポートしています。

    リクエストで次のプロパティを指定する必要があります：RecurrenceType、RecurrenceValue、および RecurrenceEndTime。

    ScheduledAction

    String

    いいえ

    はい

    スケジュールされたタスクがトリガーされたときに実行される操作。

    値は最大 200 文字の長さにすることができます。

    スケーリングルールの固有識別子を値に設定します。

    MaxValue

    Integer

    いいえ

    はい

    ScalingGroupId を指定した場合のスケーリンググループの最大インスタンス数。

    なし。

    MinValue

    Integer

    いいえ

    はい

    ScalingGroupId を指定した場合のスケーリンググループの最小インスタンス数。

    なし。

    DesiredCapacity

    Integer

    いいえ

    はい

    ScalingGroupId を指定した場合のスケーリンググループの想定インスタンス数。

    スケーリンググループを作成するときに DesiredCapacity を指定する必要があります。

    ScalingGroupId

    String

    いいえ

    はい

    スケジュールされたタスクがトリガーされたときにインスタンス数が変更される必要があるスケーリンググループの ID。

    ScalingGroupId を指定した場合、スケジュールされたタスクはスケーリンググループで指定されたインスタンス数に基づいてスケーリングを実行します。この場合、MinValue、MaxValue、DesiredCapacity のうち少なくとも 1 つのプロパティを指定する必要があります。

    説明

    ScheduledAction と ScalingGroupId の両方を指定することはできません。

    戻り値

    Fn::GetAtt

    ScheduledTaskId：スケジュールされたタスクの ID。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"
        ]
      }
    }
  }
}