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

AWS::SSM::MaintenanceWindow

AWS::SSM::MaintenanceWindow リソースは、Amazon EC2 Systems Manager のメンテナンスウィンドウに関する一般情報を表します。メンテナンスウィンドウでは、オペレーティングシステム (OS) のパッチ適用、ドライバーの更新、ソフトウェアのインストールなど、インスタンスで問題を引き起こすおそれのあるアクションを実行するスケジュールを定義できます。各メンテナンスウィンドウには、スケジュール、期間、登録されたターゲットのセット、登録されたタスクのセットがあります。詳細については、『Amazon EC2 Systems Manager ユーザーガイド』の「Systems Manager メンテナンスウィンドウ」と、『Amazon EC2 Systems Manager API リファレンス』の「CreateMaintenanceWindow」を参照してください。

構文

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

JSON

Copy
{ "Type" : "AWS::SSM::MaintenanceWindow", "Properties" : { "Description" : String, "AllowUnassociatedTargets" : Boolean, "Cutoff" : Integer, "Schedule" : String, "Duration" : Integer, "Name" : String } }

YAML

Copy
Type: "AWS::SSM::MaintenanceWindow" Properties: Description: String AllowUnassociatedTargets: Boolean Cutoff: Integer Schedule: String Duration: Integer Name: String

プロパティ

Description

メンテナンスウィンドウの説明。

必須: いいえ

タイプ: 文字列

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

AllowUnassociatedTargets

マネージドインスタンスがターゲットとして登録されていない場合でも、そのインスタンスでのメンテナンスウィンドウタスクの実行を許可します。この設定が有効になったら、タスクをメンテナンスウィンドウに登録する際に、未登録インスタンスを (インスタンス ID で) 指定する必要があります。

必須: はい

タイプ: ブール値

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

Cutoff

メンテナンスウィンドウの終了時間前に Systems Manager によって新しいタスクの実行のスケジュールが停止される時間数。

必須: はい

タイプ: 整数

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

Schedule

CRON 式/レート式の形式のメンテナンスウィンドウのスケジュール。

必須: はい

タイプ: 文字列

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

Duration

メンテナンスウィンドウの期間 (時間単位)

必須: はい

タイプ: 整数

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

Name

メンテナンスウィンドウの名前。

必須: はい

タイプ: 文字列

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

戻り値

参照番号

AWS::SSM::MaintenanceWindow リソースの論理 ID を組み込み Ref 関数に渡すと、関数はリソースの物理 ID (mw-abcde1234567890yz など) を返します。

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

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