メニュー
AWS CloudFormation
ユーザーガイド (API Version 2010-05-15)

AWS::SSM::MaintenanceWindowTask

AWS::SSM::MaintenanceWindowTask リソースは、Amazon EC2 Systems Manager のメンテナンスウィンドウのタスクに関する情報を定義します。詳細については、『Amazon EC2 Systems Manager API リファレンス』の「RegisterTaskWithMaintenanceWindow」を参照してください。

構文

AWS CloudFormation テンプレートでこのエンティティを宣言するには、次の構文を使用します。

JSON

{ "Type" : "AWS::SSM::MaintenanceWindowTask", "Properties" : { "MaxErrors" : String, "Description" : String, "ServiceRoleArn" : String, "Priority" : Integer, "MaxConcurrency" : String, "Targets" : [ Target, ... ], "Name" : String, "TaskArn" : String, "TaskInvocationParameters" : TaskInvocationParameters, "WindowId" : String, "TaskParameters" : JSON object, "TaskType" : String, "LoggingInfo" : LoggingInfo } }

YAML

Type: "AWS::SSM::MaintenanceWindowTask" Properties: MaxErrors: String Description: String ServiceRoleArn: String Priority: Integer MaxConcurrency: String Targets: - Target Name: String TaskArn: String TaskInvocationParameters: TaskInvocationParameters WindowId: String TaskParameters: JSON object TaskType: String LoggingInfo: LoggingInfo

プロパティ

MaxErrors

このタスクが停止するまでに許容されているエラーの最大数。

必須: はい

タイプ: 文字列

更新に伴う要件: 中断はありません。

Description

タスクの説明。

必須: いいえ

タイプ: 文字列

更新に伴う要件: 中断はありません。

ServiceRoleArn

タスク実行時に使用されるロール。

必須: はい

タイプ: 文字列

更新に伴う要件: 中断はありません。

Priority

メンテナンスウィンドウのタスクの優先度。数値が小さいほど、優先度が高くなります。優先度が同じタスクは並行してスケジュールされます。

必須: はい

タイプ: 整数

更新に伴う要件: 中断はありません。

MaxConcurrency

このタスクを並列に実行することができるターゲットの最大数。

必須: はい

タイプ: 文字列

更新に伴う要件: 中断はありません。

Targets

ターゲット (インスタンスまたはタグ)

  • インスタンスは Key=instanceids,Values=instanceid1,instanceid2 を使用して指定します。

  • タグは Key=tag name,Values=tag value を使用して指定します。

必須: はい

: SSM MaintenanceWindowTask ターゲット のリスト

更新に伴う要件: 中断はありません。

Name

タスク名。

必須: いいえ

タイプ: 文字列

更新に伴う要件: 中断はありません。

TaskArn

実行時にタスクで使用されるリソース。

タスクタイプが RUN_COMMAND または AUTOMATION の場合、TaskArn は SSM ドキュメント名または Amazon リソースネーム (ARN) になります。

LAMBDA タスクでは、TaskArn は関数名または ARN です。

STEP_FUNCTION タスクでは、TaskArn は、ステートマシンの ARN です。

必須: はい

タイプ: 文字列

更新に伴う要件: 中断はありません。

TaskInvocationParameters

タスクの実行に必要なパラメータ。

必須: いいえ

タイプ: SSM MaintenanceWindowTask TaskInvocationParameters

更新に伴う要件: 中断はありません。

WindowId

タスクが登録されているメンテナンスウィンドウの ID。

必須: いいえ

タイプ: 文字列

更新に伴う要件: 置換。

TaskParameters

実行時にタスクに渡されるパラメータ。

必須: いいえ

タイプ: JSON オブジェクト

更新に伴う要件: 中断はありません。

TaskType

タスクのタイプ。有効な値: RUN_COMMAND, AUTOMATION, LAMBDA, STEP_FUNCTION.

必須: はい

タイプ: 文字列

更新に伴う要件: 中断はありません。

LoggingInfo

タスクレベルのログを書き込む Amazon S3 バケットに関する情報。

必須: いいえ

タイプ: SSM MaintenanceWindowTask LoggingInfo

更新に伴う要件: 中断はありません。

戻り値

参照番号

AWS::SSM::MaintenanceWindowTask リソースの論理 ID を組み込み Ref 関数に渡すと、関数はリソースの物理 ID (12a345b6-bbb7-4bb6-90b0-8c9577a2d2b9 など) を返します。

Ref 関数の使用方法の詳細については、「Ref」を参照してください。

以下の資料も参照してください。