• AWS Systems Manager CloudWatch ダッシュボードは、2026 年 4 月 30 日以降は利用できなくなります。お客様は、これまでと同様に Amazon CloudWatch コンソールを使用して、Amazon CloudWatch ダッシュボードの表示、作成、管理を継続できます。詳細については、「[Amazon CloudWatch ダッシュボードのドキュメント](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch_Dashboards.html)」を参照してください。
# メンテナンスウィンドウのタスクを登録する際の疑似パラメータの使用
AWS Systems Manager のツールである Maintenance Windows でタスクを登録する際、4 つのタスクタイプのそれぞれに固有のパラメータを指定します。(CLI コマンドでは、これらは `--task-invocation-parameters` オプションを使用して指定されます)。
`{{RESOURCE_ID}}`、`{{TARGET_TYPE}}`、`{{WINDOW_TARGET_ID}}` などの*擬似パラメータ*構文を使用して、特定の値を参照することもできます。メンテナンスウィンドウタスクが実行されると、擬似パラメータプレースホルダーの代わりに正しい値を渡します。使用できる擬似パラメータすべてのリストについては、このトピックの後半の「[サポートされる擬似パラメータ](#pseudo-parameters)」を参照してください。
**重要**
`RESOURCE_GROUP` ターゲットタイプでは、タスクに必要な ID 形式に応じて、タスクの実行時にリソースを参照するために `{{TARGET_ID}}` と `{{RESOURCE_ID}}` を使用するかを選択できます。`{{TARGET_ID}}` は、リソースの完全な ARN を返します。`{{RESOURCE_ID}}` は、これらの例に示すように、リソースの短い名前または ID のみを返します。
`{{TARGET_ID}}` 形式: `arn:aws:ec2:us-east-1:123456789012:instance/i-02573cafcfEXAMPLE`
`{{RESOURCE_ID}}` 形式: `i-02573cafcfEXAMPLE`
`INSTANCE` ターゲットタイプの場合、`{{TARGET_ID}}` パラメータと `{{RESOURCE_ID}}` パラメータの両方がインスタンス ID のみを生成します。詳細については、「」を参照してください[サポートされる擬似パラメータ](#pseudo-parameters)
`{{TARGET_ID}}` および `{{RESOURCE_ID}}` を使用して、AWS リソースの ID を Automation、Lambda、Step Functions のタスクにのみ渡すことができます。これら 2 つの擬似パラメータは、Run Command タスクでは使用できません。
## 擬似パラメータの例
AWS Lambda タスクのペイロードが、ID でインスタンスを参照する必要があるとします。
`INSTANCE` または `RESOURCE_GROUP` メンテナンスウィンドウターゲットを使用しているかどうかに関係なく、これは `{{RESOURCE_ID}}` 擬似パラメータを使用することで実現できます。例:
```
"TaskArn": "arn:aws:lambda:us-east-2:111122223333:function:SSMTestFunction",
"TaskType": "LAMBDA",
"TaskInvocationParameters": {
"Lambda": {
"ClientContext": "ew0KICAi--truncated--0KIEXAMPLE",
"Payload": "{ \"instanceId\": \"{{RESOURCE_ID}}\" }",
"Qualifier": "$LATEST"
}
}
```
Lambda タスクが、Amazon Elastic Compute Cloud (Amazon EC2) インスタンスに加えて、サポートされている別のターゲットタイプ (Amazon DynamoDB テーブルなど) に対して実行することを意図している場合は、同じ構文を使用でき、`{{RESOURCE_ID}}` はテーブルの名前のみを生成します。ただし、テーブルの完全な ARN が必要な場合は、次の例に示すように `{{TARGET_ID}}` を使用します。
```
"TaskArn": "arn:aws:lambda:us-east-2:111122223333:function:SSMTestFunction",
"TaskType": "LAMBDA",
"TaskInvocationParameters": {
"Lambda": {
"ClientContext": "ew0KICAi--truncated--0KIEXAMPLE",
"Payload": "{ \"tableArn\": \"{{TARGET_ID}}\" }",
"Qualifier": "$LATEST"
}
}
```
ターゲットインスタンスやその他のリソースタイプに対しても、同じ構文を使用できます。複数のリソースタイプがリソースグループに追加されている場合、タスクは適切な各リソースに対して実行されます。
**重要**
リソースグループに含まれるすべてのリソースタイプが `{{RESOURCE_ID}}` パラメータの値を生成するわけではありません。サポートされているリソースタイプの一覧については、「[サポートされる擬似パラメータ](#pseudo-parameters)」を参照してください。
別の例として、EC2 インスタンスを停止する Automation タスクを実行するには、`AWS-StopEC2Instance` Systems Manager ドキュメント (SSM ドキュメント) を `TaskArn` 値として指定し、`{{RESOURCE_ID}}` 擬似パラメータを使用します。
```
"TaskArn": "AWS-StopEC2Instance",
"TaskType": "AUTOMATION"
"TaskInvocationParameters": {
"Automation": {
"DocumentVersion": "1",
"Parameters": {
"instanceId": [
"{{RESOURCE_ID}}"
]
}
}
}
```
Amazon Elastic Block Store (Amazon EBS) ボリュームのスナップショットをコピーする Automation タスクを実行するには、`AWS-CopySnapshot` SSM ドキュメントを `TaskArn` 値として指定し、`{{RESOURCE_ID}}` 擬似パラメータを使用します。
```
"TaskArn": "AWS-CopySnapshot",
"TaskType": "AUTOMATION"
"TaskInvocationParameters": {
"Automation": {
"DocumentVersion": "1",
"Parameters": {
"SourceRegion": "us-east-2",
"targetType":"RESOURCE_GROUP",
"SnapshotId": [
"{{RESOURCE_ID}}"
]
}
}
}
```
## サポートされる擬似パラメータ
以下のリストでは、`{{PSEUDO_PARAMETER}}` オプションの `--task-invocation-parameters` 構文を使用して指定できる疑似パラメータについて説明しています。
+ **`WINDOW_ID`**: ターゲットメンテナンスウィンドウの ID。
+ **`WINDOW_TASK_ID`**: 実行されているウィンドウタスクの ID。
+ **`WINDOW_TARGET_ID`**: ターゲット (ターゲット ID) を含むウィンドウターゲットの ID。
+ **`WINDOW_EXECUTION_ID`**: 現在のウィンドウ実行の ID。
+ **`TASK_EXECUTION_ID`**: 現在のタスク実行の ID。
+ **`INVOCATION_ID`**: 現在の呼び出しの ID。
+ **`TARGET_TYPE`**: ターゲットのタイプ。サポートされるタイプには `RESOURCE_GROUP`、`INSTANCE` などがあります。
+ **`TARGET_ID`**:
指定したターゲットタイプが `INSTANCE` の場合、`TARGET_ID`擬似パラメータはインスタンスの ID に置き換えられます。例えば、`i-078a280217EXAMPLE`。
指定したターゲットタイプが `RESOURCE_GROUP` の場合、タスク実行で参照される値は、リソースの完全な ARN になります。例: `arn:aws:ec2:us-east-1:123456789012:instance/i-078a280217EXAMPLE`。次の表に、リソースグループ内の特定のリソースタイプの `TARGET_ID` 値の例を示します。
**注記**
`TARGET_ID` は Run Command タスクではサポートされていません。
[\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/ja_jp/systems-manager/latest/userguide/maintenance-window-tasks-pseudo-parameters.html)
+ **`RESOURCE_ID`**: リソースグループに含まれるリソースタイプの短い ID。次の表に、リソースグループ内の特定のリソースタイプの `RESOURCE_ID` 値の例を示します。
**注記**
`RESOURCE_ID` は Run Command タスクではサポートされていません。
[\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/ja_jp/systems-manager/latest/userguide/maintenance-window-tasks-pseudo-parameters.html)
**注記**
指定した AWS リソースグループに、`RESOURCE_ID` 値を生成しないリソースタイプが含まれており、前述の表にリストされていない場合、`RESOURCE_ID` パラメータは入力されません。そのリソースに対して実行の呼び出しは引き続き発生します。このような場合は、代わりに `TARGET_ID` 擬似パラメータを使用します。このパラメータは、リソースの完全な ARN に置き換えられます。