例: ターゲットをメンテナンスウィンドウに登録する - AWS Systems Manager

例: ターゲットをメンテナンスウィンドウに登録する

ステップ 2: メンテナンスウィンドウでターゲットノードを登録する (AWS CLI) で示すように、ノード ID を使用して、単一のノードをターゲットとして登録できます。このページのコマンド形式を使用すると、複数のノードをターゲットとして登録することもできます。

一般的に、メンテナンスウィンドウのターゲットとして使用するノードを特定する方法は 2 つあります。個々のノードを指定する方法と、リソースタグを使用する方法です。例 2~3 に示すように、リソースタグメソッドには、さらに多くのオプションがあります。

メンテナンスウィンドウのターゲットとして、1 つ以上のリソースグループを指定することもできます。リソースグループには、ノードおよびサポートされている他の多くの種類の AWS リソースを含めることができます。次に、例 4 と 5 で、リソースグループをメンテナンスウィンドウのターゲットに追加する方法を示しています。

注記

1 つのメンテナンスウィンドウタスクが複数のターゲットに登録されている場合、そのタスクの呼び出しは並列ではなく、順番に実行されます。複数のターゲットで同時にタスクを実行する必要がある場合は、各ターゲットでタスクを個別に登録し、各タスクに同じ優先度レベルを割り当てます。

リソースグループの作成と管理の詳細については、AWS Resource Groups ユーザーガイドの「リソースグループとは」およびAWS ニュースブログの「AWS のリソースグループとタグ付け」を参照してください。

AWS Systems Manager の一機能である Maintenance Windows のクォータについては、次の例で指定されているものに加えて、「Amazon Web Services 全般のリファレンス」の「Systems Manager Service Quotas」を参照してください。

例 1: ノード ID を使用して複数のターゲットを登録する

次のコマンドをローカルマシン形式で実行し、ノード ID を使用して複数のノードをターゲットとして登録します。各リソースプレースホルダーの例をユーザー自身の情報に置き換えます。

Linux & macOS
aws ssm register-target-with-maintenance-window \ --window-id "mw-0c50858d01EXAMPLE" \ --resource-type "INSTANCE" \ --target "Key=InstanceIds,Values=i-02573cafcfEXAMPLE,i-0471e04240EXAMPLE,i-07782c72faEXAMPLE"
Windows
aws ssm register-target-with-maintenance-window ^ --window-id "mw-0c50858d01EXAMPLE ^ --resource-type "INSTANCE" ^ --target "Key=InstanceIds,Values=i-02573cafcfEXAMPLE,i-0471e04240EXAMPLE,i-07782c72faEXAMPLE

推奨用途: 最初はメンテナンスウィンドウに一意のノードグループを登録し、共通のノードタグを共有しないのが最も有益です。

クォータ: 各メンテナンスウィンドウターゲットに対して、ノードを合計 50 個まで指定できます。

例 2: ノードに適用されたリソースタグを使用してターゲットを登録する

ローカルマシンで次のコマンドを実行して、割り当てたキーと値のペアで既にすべてがタグ付けされているノードを登録します。各リソースプレースホルダーの例をユーザー自身の情報に置き換えます。

Linux & macOS
aws ssm register-target-with-maintenance-window \ --window-id "mw-0c50858d01EXAMPLE" \ --resource-type "INSTANCE" \ --target "Key=tag:Region,Values=East"
Windows
aws ssm register-target-with-maintenance-window ^ --window-id "mw-0c50858d01EXAMPLE" ^ --resource-type "INSTANCE" ^ --target "Key=tag:Region,Values=East"

推奨用途: 最初はメンテナンスウィンドウに一意のノードグループを登録し、共通のノードタグを共有するのが最も有益です。

クォータ: ターゲットごとにキーと値のペアを合計 5 つまで指定できます。複数のキーと値のペアを指定する場合、ターゲットグループに含めると指定したすべてのタグキーと値でノードをタグ付けする必要があります。

注記

タグキー Patch Group または PatchGroup を使用してノードのグループにタグを付け、ノードに共通のキー値 (my-patch-group) を割り当てることができます。(EC2 インスタンスメタデータでタグを許可している場合は、スペースなしで PatchGroup を使用する必要があります。) Systems Manager 機能の Patch Manager は、ノードで Patch Group または PatchGroup キーを評価し、適用されるパッチベースラインを決定するのに役立ちます。タスクで AWS-RunPatchBaseline SSM ドキュメント (またはレガシー AWS-ApplyPatchBaseline の SSM ドキュメント) が実行される場合は、メンテナンスウィンドウにターゲットを登録する際に、同じ Patch Group または PatchGroup のキーの値を指定することができます。例: --target "Key=tag:PatchGroup,Values=my-patch-group。そうすることで、メンテナンスウィンドウを使用して、同じパッチベースラインにすでに関連付けられているノードグループのパッチを更新できます。詳細については、「パッチグループについて」を参照してください。

例 3: タグキーのグループを使用してターゲットを登録する (タグ値なし)

ローカルマシンで次のコマンドを実行して、キー値に関係なく、複数のタグキーが割り当てられているノードをすべて登録します。各リソースプレースホルダーの例をユーザー自身の情報に置き換えます。

Linux & macOS
aws ssm register-target-with-maintenance-window \ --window-id "mw-0c50858d01EXAMPLE" \ --resource-type "INSTANCE" \ --target "Key=tag-key,Values=Name,Instance-Type,CostCenter"
Windows
aws ssm register-target-with-maintenance-window ^ --window-id "mw-0c50858d01EXAMPLE" ^ --resource-type "INSTANCE" ^ --target "Key=tag-key,Values=Name,Instance-Type,CostCenter"

推奨用途: 1 つのタグキーやタグキーと値のペアではなく、複数のタグキー (値はなし) を指定して、ノードをターゲットにする場合に役立ちます。

クォータ: ターゲットごとにタグキーを合計 5 つまで指定できます。複数のタグキーを指定する場合、ターゲットグループに含めるように指定したすべてのタグキーで、ノードにタグ付けする必要があります。

例 4: リソースグループ名を使用してターゲットを登録する

ローカルマシンで次のコマンドを実行して、指定されたリソースグループを登録します。含まれるリソースのタイプは関係ありません。mw-0c50858d01EXAMPLE を自分の情報に置き換えます。メンテナンスウィンドウに割り当てたタスクが、このリソースグループに含まれるリソースのタイプで動作しない場合は、エラーがレポートされる場合があります。これらのエラーにもかかわらず、サポートされているリソースタイプが検出されたタスクは引き続き実行されます。

Linux & macOS
aws ssm register-target-with-maintenance-window \ --window-id "mw-0c50858d01EXAMPLE" \ --resource-type "RESOURCE_GROUP" \ --target "Key=resource-groups:Name,Values=MyResourceGroup"
Windows
aws ssm register-target-with-maintenance-window ^ --window-id "mw-0c50858d01EXAMPLE" ^ --resource-type "RESOURCE_GROUP" ^ --target "Key=resource-groups:Name,Values=MyResourceGroup"

推奨用途: すべてのリソースタイプがメンテナンスウィンドウのターゲットになるかどうかを評価せずに、リソースグループをターゲットとしてすばやく指定する場合、またはタスクでアクションを実行するリソースタイプのみ、リソースグループに含まれていることがわかっている場合に役立ちます。

制限: 1 つのリソースグループのみをターゲットとして指定できます。

例 5: リソースグループのリソースタイプをフィルタリングしてターゲットを登録する

ローカルマシンで次のコマンドを実行して、指定したリソースグループに属する特定のリソースタイプのみを登録します。mw-0c50858d01EXAMPLE を自分の情報に置き換えます。このオプションを使用すると、リソースグループに属するリソースタイプのタスクを追加した場合でも、リソースタイプをフィルタに明示的に追加していない場合、タスクは実行されません。

Linux & macOS
aws ssm register-target-with-maintenance-window \ --window-id "mw-0c50858d01EXAMPLE" \ --resource-type "RESOURCE_GROUP" \ --target "Key=resource-groups:Name,Values=MyResourceGroup" \ "Key=resource-groups:ResourceTypeFilters,Values=AWS::EC2::Instance,AWS::ECS::Cluster"
Windows
aws ssm register-target-with-maintenance-window ^ --window-id "mw-0c50858d01EXAMPLE" ^ --resource-type "RESOURCE_GROUP" ^ --target "Key=resource-groups:Name,Values=MyResourceGroup" ^ "Key=resource-groups:ResourceTypeFilters,Values=AWS::EC2::Instance,AWS::ECS::Cluster"

推奨用途: メンテナンスウィンドウでアクションを実行できる AWS リソースのタイプを厳密に制御する場合、またはリソースグループに多数のリソースタイプが含まれていて、メンテナンスウィンドウログに不要なエラーレポートを含めない場合に役立ちます。

制限: 1 つのリソースグループのみをターゲットとして指定できます。