AWS Systems Manager
ユーザーガイド

SSM ドキュメントプラグインの参照

このリファレンスでは、AWS Systems Manager (SSM) ドキュメントで指定できるアクションまたはプラグインについて説明します。このリファレンスには、AWS Systems Manager 自動化ドキュメントのプラグインに関する情報は含まれていません。自動化ドキュメントのプラグインについては、「Systems Manager Automation アクションのリファレンス」を参照してください。

Systems Manager は、Systems Manager ドキュメントの内容を読み取ることによって、管理対象インスタンスで実行するアクションを判別します。各ドキュメントにはコード実行セクションが含まれています。ドキュメントのスキーマバージョンに応じて、このコード実行セクションには 1 つ以上のプラグインまたはステップが含まれます。このヘルプトピックの目的上、プラグインとステップはプラグインと呼んでいます。このセクションには、各 Systems Manager プラグインに関する情報が含まれています。ドキュメントの作成に関する情報やスキーマのバージョンの違いなど、ドキュメントの詳細については、「AWS Systems Manager ドキュメント」を参照してください。

注記

ここで説明するプラグインの中には、Windows Server インスタンスまたは Linux インスタンスのいずれかでのみ実行されるものがあります。各プラグインにはプラットフォームの依存関係が記載されています。

最上位の要素

最上位の要素はすべての Systems Manager 文書に共通です。最上位の要素は Systems Manager ドキュメントの構造を提供します。

プロパティ

schemaVersion

スキーマのバージョン。

型: バージョン

必須: はい

description

設定の説明。

型: 文字列

必須: いいえ

パラメータ

parameters は、ドキュメントの処理時に実行する 1 つ以上のパラメータを含む構造です。パラメータは、ランタイムに指定するか、文書内で指定するか、Systems Manager パラメータストア を使用して指定することができます。詳細については、「AWS Systems Manager パラメータストア」を参照してください。

型: 構造

parameters構造は次のフィールドと値を受け入れます。

  • type: (必須) その値として StringStringListBooleanIntegerMapListStringMap を使用できます。各タイプの例を表示するには、次のセクションの「type 例」を参照してください。

  • description: (オプション) パラメータグループの説明。

  • default: (オプション) パラメータストア でのパラメータのデフォルト値またはパラメータへの参照。

  • allowedValues: (オプション) パラメータで使用できる値。

  • allowedPattern: (オプション) パラメータが一致しなければならない正規表現。

  • displayType: (オプション) AWS コンソールの textfield または textarea のいずれかを表示するために使用されます。textfield は 1 行のテキストボックスです。textarea は複数行のテキストエリアです。

  • minItems: (オプション) 許可される項目の最小数。

  • maxItems: (オプション) 許可される項目の最大数。

  • minChars: (オプション) 許可される項目の最小数。

  • maxChars: (オプション) を許可されているパラメータ文字の最大数。

runtimeConfig

(スキーマバージョン 1.2 のみ) 1 つ以上の Systems Manager プラグインによって適用されるインスタンスの構成。プラグインは必ずしも順番に実行されるとは限りません。

型: Dictionary<string,PluginConfiguration>

必須: いいえ

mainSteps

(スキーマバージョン 0.3、2.0、2.2 のみ) 1 つ以上の Systems Manager プラグインによって適用されるインスタンスの構成。プラグインは、ステップ内でアクションとして編成されます。ステップは、ドキュメントに記載されている順番に実行されます。

型: Dictionary<string,PluginConfiguration>

必須: いいえ

type

このセクションでは、各パラメータ type の例を示しています。

type 説明 ユースケースの例

文字列

二重引用符で囲んだ 0 個以上の Unicode 文字のシーケンス。バックスラッシュを使用してエスケープします。

"i-1234567890abcdef0"

"InstanceId":{ "type":"String", "description":"(Required) The target EC2 instance ID." }

StringList

コンマで区切った String 項目のリスト。

["cd ~", "pwd"]

"commands":{ "type":"StringList", "description":"(Required) Specify a shell script or a command to run.", "minItems":1, "displayType":"textarea" },

Boolean

true または false のみを使用できます。"true" または 0 は使用できません。

true

"canRun": { "type": "Boolean", "description": "", "default": true, }

整数

整数。小数 (3.14159 など) や二重引用符で囲んだ数字 ("3" など) は使用できません。

39 または -5

"timeout": { "type": "Integer", "description": "The type of action to perform.", "default": 100 }

StringMap

キーと値のマッピング。キーには文字列のみを使用できます。{ "type": "object" } など。

{ "NotificationType":"Command", "NotificationEvents":[ "Failed" ], "NotificationArn":"$dependency.topicArn" }
"notificationConfig" : { "type" : "StringMap", "description" : "The configuration for events to be notified about", "default" : { "NotificationType" : "Command", "NotificationEvents" : ["Failed"], "NotificationArn" : "$dependency.topicArn" }, "maxChars" : 150 }

MapList

StringMap 項目のリスト。

[ { "DeviceName" : "/dev/sda1", "Ebs" : { "VolumeSize" : "50" } }, { "DeviceName" : "/dev/sdm", "Ebs" : { "VolumeSize" : "100" } } ]
"blockDeviceMappings" : { "type" : "MapList", "description" : "The mappings for the create image inputs", "default" : [{"DeviceName":"/dev/sda1","Ebs":{"VolumeSize":"50"}},{"DeviceName":"/dev/sdm","Ebs":{ "VolumeSize":"100"}}], "maxItems": 2 }

aws:applications

EC2 インスタンスでアプリケーションをインストール、修復、またはアンインストールします。このプラグインは、Microsoft Windows Server オペレーティングシステム上でのみ実行されます。詳細については、「AWS Systems Manager ドキュメント」を参照してください。

構文

"runtimeConfig":{ "aws:applications":{ "properties":[ { "id":"0.aws:applications", "action":"{{ action }}", "parameters":"{{ parameters }}", "source":"{{ source }}", "sourceHash":"{{ sourceHash }}" } ] }

プロパティ

action

取るべきアクション。

タイプ: Enum

有効な値: Install | Repair | Uninstall

必須: はい

パラメータ

インストーラのパラメータ。

型: 文字列

必須: いいえ

source

アプリケーションの .msi ファイルの URL。

型: 文字列

必須: はい

sourceHash

.msi ファイルの SHA256 ハッシュ。

型: 文字列

必須: いいえ

aws:cloudWatch

Windows Server から Amazon CloudWatch または Amazon CloudWatch Logs にデータをエクスポートし、CloudWatch メトリクスを使用してデータを監視します。このプラグインは、Microsoft Windows Server オペレーティングシステム上でのみ実行されます。Amazon EC2 との CloudWatch 統合の構成の詳細については、「Amazon CloudWatch へのログ、イベント、パフォーマンスカウンターの送信」を参照してください。ドキュメントの詳細については、「AWS Systems Manager ドキュメント」を参照してください。

重要

CloudWatch エージェント 統合エージェントによって、ログデータを Amazon CloudWatch Logs に送信するツールとしての SSM エージェント が置き換えられました。SSM エージェントを使用したログデータの送信のサポートは今後廃止されます。ログ収集プロセスには、統合された CloudWatch エージェント のみを使用することをお勧めします。詳細については、以下のトピックを参照してください。

次のデータ型をエクスポートおよび監視できます。

ApplicationEventLog

アプリケーションイベントログデータを CloudWatch Logs に送信します。

CustomLogs

テキストベースのログファイルを CloudWatch ログに送信します。CloudWatch プラグインは、ログファイルのフィンガープリントを作成します。次に、システムは各フィンガープリントにデータオフセットを関連付けます。プラグインは、変更があったときにファイルをアップロードし、オフセットを記録し、オフセットをフィンガープリントに関連付けます。この方法は、ユーザーがプラグインを有効にし、多数のファイルを含むディレクトリにサービスを関連付け、システムがすべてのファイルをアップロードすることを避けるために使用されます。

警告

アプリケーションがポーリング中にログをトランケートまたは消去しようとすると、LogDirectoryPath で指定されたログではエントリが失われることに注意してください。たとえば、ログファイルのサイズを制限する場合は、その制限に達すると新しいログファイルを作成し、新しいファイルにデータを書き続ける必要があります。

ETW

Windows のイベントトレース (ETW) データを CloudWatch Logs に送信します。Microsoft Windows Server 2003 はサポートされていません。

IIS

IIS ログデータを CloudWatch Logs に送信します。

PerformanceCounter

Windows パフォーマンスカウンタを CloudWatch に送信します。メトリクスとして CloudWatch にアップロードするさまざまなカテゴリを選択できます。アップロードするパフォーマンスカウンタごとに、一意の ID (たとえば、「PerformanceCounter2」、「PerformanceCounter3」など) を持つ[PerformanceCounter] セクションを作成し、そのプロパティを設定します。

注記

SSM エージェント エージェントまたは CloudWatch プラグインが停止した場合、パフォーマンスカウンタデータのログは CloudWatch に記録されません。この動作は、カスタムログまたは Windows イベントログとは異なります。SSM エージェント または CloudWatch プラグインが使用可能になると、カスタムログと Windows イベントログはパフォーマンスカウンタデータを保持し、CloudWatch にアップロードします。

SecurityEventLog

セキュリティイベントログデータを CloudWatch Logs に送信します。

SystemEventLog

システムイベントログデータを CloudWatch Logs に送信します。

データの送信先として以下を定義できます。

CloudWatch

パフォーマンスカウンタのメトリクスデータの送信先。同じデータを別の場所に送信するには、一意の ID (例: 「CloudWatch2」、「CloudWatch3」) を使用してセクションを追加し、新しい ID ごとに異なるリージョンを指定します。

CloudWatchLogs

ログデータの送信先。一意の ID (例: 「CloudWatchLogs2」、「CloudWatchLogs3」) を含むセクションを追加し、新しい ID ごとに異なるリージョンを指定して、同じデータを別の場所に送信できます。

構文

"runtimeConfig":{ "aws:cloudWatch":{ "settings":{ "startType":"{{ status }}" }, "properties":"{{ properties }}" } }

設定とプロパティ

AccessKey

お客様のアクセスキー ID。IAM ロールを使用してインスタンスを起動しない限り、このプロパティは必須です。このプロパティは SSM では使用できません。

型: 文字列

必須: いいえ

CategoryName

パフォーマンスモニターのパフォーマンスカウンタカテゴリ。

型: 文字列

必須: はい

CounterName

パフォーマンスモニターのパフォーマンスカウンタの名前。

型: 文字列

必須: はい

CultureName

タイムスタンプが記録されるロケール。[CultureName] が空の場合、Windows Server インスタンスで現在使用されているのと同じロケールがデフォルトになります。

型: 文字列

有効な値: サポートされている値のリストについては、Microsoft ウェブサイトの「National Language Support (NLS)」を参照してください。divdiv-MVhuhu-HU の各値はサポートされません。

必須: いいえ

DimensionName

Amazon CloudWatch メトリクスのディメンション。DimensionName を指定する場合は、DimensionValue を指定する必要があります。これらのパラメータにより、メトリクスが一覧表示される別のビューが表示されます。複数のメトリクスに同じディメンションを使用して、特定のディメンションに属するすべてのメトリクスを表示することができます。

型: 文字列

必須: いいえ

DimensionValue

Amazon CloudWatch メトリクスのディメンション値。

型: 文字列

必須: いいえ

エンコード

使用するファイルエンコード (たとえば、UTF-8)。表示名ではなく、エンコード名を使用します。

型: 文字列

有効な値: サポートされる値の一覧については、MSDN ライブラリのの「Encoding クラス」を参照してください。

必須: はい

フィルタ

ログ名のプレフィックス。すべてのファイルをモニタリングするには、このパラメータを空白のままにします。

型: 文字列

有効な値: サポートされる値の一覧については、MSDN ライブラリの「FileSystemWatcherFilter プロパティ」を参照してください。

必須: いいえ

フロー

アップロードする各データ型とデータの送信先 (CloudWatch または CloudWatch Logs)。たとえば、["Id": "PerformanceCounter"] で定義されたパフォーマンスカウンタを CloudWatch に送信するには、"Id": "CloudWatch" で定義された送信先、["PerformanceCounter,CloudWatch"] を入力します。同様に、カスタムログ、ETW ログ、システムログを "Id": "ETW" で定義された CloudWatch Logs 送信先に送信するには、「"(ETW),CloudWatchLogs"」と入力します。加えて、同じパフォーマンスカウンターまたはログファイルを複数の宛先に送信することもできます。たとえば、アプリケーションログを "Id": "CloudWatchLogs""Id": "CloudWatchLogs2" で定義した 2 つの異なる宛先に送信するには、「"ApplicationEventLog,(CloudWatchLogs, CloudWatchLogs2)"」と入力します。

型: 文字列

有効な値 (ソース): ApplicationEventLog | CustomLogs | ETW | PerformanceCounter | SystemEventLog | SecurityEventLog

有効な値 (送信先): CloudWatch | CloudWatchLogs | CloudWatchn | CloudWatchLogsn

必須: はい

FullName

コンポーネントのフルネーム。

型: 文字列

必須: はい

ID

データソースまたは送信先を識別します。この識別子は、設定ファイル内で一意である必要があります。

型: 文字列

必須: はい

InstanceName

パフォーマンスカウンターインスタンスの名前。各パフォーマンスカウンタコンポーネントではメトリクスが 1 つしかサポートされないため、アスタリスク (*) を使用してすべてのインスタンスを指定しないでください。ただし、_Total は使用できます。

型: 文字列

必須: はい

レベル

Amazon CloudWatch に送信するメッセージの種類。

型: 文字列

有効な値:

  • 1 - エラーメッセージだけがアップロードされます。

  • 2 - 警告メッセージだけがアップロードされます。

  • 4 - 情報メッセージだけがアップロードされます。

値を加算すると、複数の種類のメッセージを含めることができます。たとえば、3 はエラーメッセージ (1) と警告メッセージ (2) が含まれることを意味します。値 7 は、エラーメッセージ (1) 、警告メッセージ (2) 、情報メッセージ (4) が含まれることを意味します。

必須: はい

注記

Windows セキュリティログではレベルを 7 に設定する必要があります。

LineCount

ログファイルを識別するヘッダーの行数。たとえば、IIS のログファイルのヘッダーはほぼ同じです。「3」と入力すると、ログファイルのヘッダーの最初の 3 行が読み取られ、ログファイルを識別できます。IIS のログファイルでは、3 行目は日付と時刻のタイムスタンプで、ログファイル間で異なります。

タイプ: 整数

必須: いいえ

LogDirectoryPath

CustomLogs の場合、Amazon EC2 インスタンスにログが保存されるパス。IIS ログの場合、IIS ログが個々のサイト (たとえば、C:\\inetpub\\logs\\LogFiles\\W3SVCn) に保存されるフォルダ。IIS ログの場合、W3C ログ形式のみがサポートされます。IIS、NCSA、カスタム形式はサポートされません。

型: 文字列

必須: はい

LogGroup

ロググループの名前です。この名前は、CloudWatch コンソールの [ロググループ] 画面に表示されます。

型: 文字列

必須: はい

LogName

ログファイルの名前。

  1. ログの名前を検索するには、イベントビューアーのナビゲーションペインで、[Applications and Services Logs] をクリックします。

  2. ログの一覧で、アップロードするログを右クリックし (たとえば、[Microsoft] > [Windows] > [Backup] > [Operational] など)、[Create Custom View] をクリックします。

  3. [Create Custom View] ダイアログボックスの [XML] タブをクリックします。[LogName] は、<Select Path=> タグにあります (たとえば、Microsoft-Windows-Backup など)。このテキストを [LogName] パラメータにコピーします。

型: 文字列

有効な値: Application | Security | System | Microsoft-Windows-WinINet/Analytic

必須: はい

LogStream

送信先ログストリーム。[{instance_id}] (デフォルト) を使用した場合、このインスタンスのインスタンス ID がログストリーム名として使用されます。

型: 文字列

有効な値: {instance_id} | {hostname} | {ip_address} <log_stream_name>

存在しないログストリーム名を入力すると、CloudWatch Logs によってログストリームが自動的に作成されます。リテラル文字列、定義済み変数({instance_id}{hostname}{ip_address})、またはこれらの組み合わせを使用して、ログストリーム名を定義できます。

このパラメータで指定されたログストリーム名は、CloudWatch コンソールの [Log Groups > Streams for <YourLogStream>] 画面に表示されます。

必須: はい

MetricName

パフォーマンスデータを表示する CloudWatch メトリクス。

注記

名前に特殊文字を使用しないでください。使用した場合、メトリクスおよびその関連付けられたアラームが機能しないことがあります。

型: 文字列

必須: はい

NameSpace

パフォーマンスカウンターデータを書き込むメトリック名前空間。

型: 文字列

必須: はい

PollInterval

新しいパフォーマンスカウンタとログデータがアップロードされるまでに必要な経過秒数。

タイプ: 整数

有効な値: これを 5 秒以上に設定します。15 秒 (00:00: 15) をお勧めします。

必須: はい

サービス対象

ログデータを送信する AWS リージョン。パフォーマンスカウンターは、ログデータの送信元とは異なるリージョンに送信できますが、インスタンスが実行されているのと同じリージョンにこのパラメータを設定することをお勧めします。

型: 文字列

有効な値: Systems Manager と CloudWatch Logs の両方でサポートされている AWS リージョンのリージョン ID (us-east-2eu-west-1ap-southeast-1 など)。各サービスでサポートされている AWS リージョンのリストについては、AWS General Reference の、AWS Systems Manager、および Amazon CloudWatch Logs を参照してください。

必須: はい

SecretKey

お客様のシークレットアクセスキー。IAM ロールを使用してインスタンスを起動しない限り、このプロパティは必須です。

型: 文字列

必須: いいえ

startType

このインスタンスで CloudWatch を有効または無効にします。

型: 文字列

有効な値: Enabled | Disabled

必須: はい

TimestampFormat

使用するタイムスタンプ形式。サポートされる値の一覧については、MSDN ライブラリの「カスタムの日付と時刻の書式指定文字列」を参照してください。

型: 文字列

必須: はい

TimeZoneKind

ログのタイムスタンプにタイムゾーン情報が含まれていない場合にタイムゾーン情報を提供できます。このパラメータが空になっていて、タイムスタンプにタイムゾーン情報が含まれていない場合、CloudWatch Logs ではデフォルトでローカルタイムゾーンが使用されます。タイムスタンプに既にタイムゾーン情報が含まれている場合、このパラメータは無視されます。

型: 文字列

有効な値: Local | UTC

必須: いいえ

単位

メトリクスの適切な測定単位。

型: 文字列

有効な値: Seconds | Microseconds | Milliseconds | Bytes | Kilobytes | Megabytes | Gigabytes | Terabytes | Bits | Kilobits | Megabits | Gigabits | Terabits | Percent | Count | Bytes/Second | Kilobytes/Second | Megabytes/Second | Gigabytes/Second | Terabytes/Second | Bits/Second | Kilobits/Second | Megabits/Second | Gigabits/Second | Terabits/Second | Count/Second | None

必須: はい

aws:configureDocker

(スキーマバージョン 2.0 以降) コンテナと Docker と連携するインスタンスを設定します。このプラグインは、Microsoft Windows Server オペレーティングシステム上でのみ実行されます。詳細については、「AWS Systems Manager ドキュメント」を参照してください。

構文

"mainSteps": [ { "action": "aws:configureDocker", "name": "ConfigureDocker", "inputs": { "action": "{{ action }}" } } ]

入力

action

実行するアクションのタイプ。

タイプ: Enum

有効な値: Install | Uninstall

必須: はい

aws:configurePackage

(スキーマバージョン 2.0 以降) AWS パッケージをインストールまたはアンインストールします。このプラグインは、Microsoft Windows Server および Linux オペレーティングシステムで実行されますが、すべての利用可能なパッケージが Linux オペレーティングシステムでサポートされているわけではありません。

Microsoft Windows Server で使用できるパッケージは、AWSPVDriver、AwsEnaNetworkDriver、IntelSriovDriver、AwsVssComponents、AmazonCloudWatchAgent、AWSSupport-EC2Rescue などです。

Linux オペレーティングシステムで使用できるパッケージは、AmazonCloudWatchAgent、および AWSSupport-EC2Rescue などです。

詳細については、「AWS Systems Manager ドキュメント」を参照してください。

構文

"mainSteps": [ { "action": "aws:configurePackage", "name": "configurePackage", "inputs": { "name": "{{ name }}", "action": "{{ action }}", "version": "{{ version }}" } } ]

入力

name

インストールまたはアンインストールする AWS パッケージの名前。使用できるパッケージは、AWSPVDriver、AwsEnaNetworkDriver、IntelSriovDriver、AwsVssComponents、AmazonCloudWatchAgent です。

型: 文字列

必須: はい

action

パッケージをインストールまたはアンインストールします。

タイプ: Enum

有効な値: Install | Uninstall

必須: はい

バージョン

インストールまたはアンインストールするパッケージの特定のバージョン。インストールする場合、デフォルトで最新の公開バージョンがインストールされます。アンインストールすると、デフォルトで現在インストールされているバージョンがアンインストールされます。インストールされているバージョンが見つからない場合は、最新の公開バージョンがダウンロードされ、アンインストール処理が実行されます。

型: 文字列

必須: いいえ

aws:domainJoin

ドメインに Amazon EC2 インスタンスを結合します。このプラグインは、Microsoft Windows Server オペレーティングシステム上でのみ実行されます。詳細については、「AWS Systems Manager ドキュメント」を参照してください。

構文

"runtimeConfig":{ "aws:domainJoin":{ "properties":{ "directoryId":"{{ directoryId }}", "directoryName":"{{ directoryName }}", "directoryOU":"{{ directoryOU }}", "dnsIpAddresses":"{{ dnsIpAddresses }}" } }

プロパティ

directoryId

ディレクトリの ID。

型: 文字列

必須: はい

例: "directoryId": "d-1234567890"

directoryName

ドメインの名前。

型: 文字列

必須: はい

例: "directoryName": "example.com"

directoryOU

部門単位 (OU)。

型: 文字列

必須: いいえ

例: "directoryOU": "OU=test,DC=example,DC=com"

dnsIpAddresses

DNS サーバーの IP アドレス。

型: 配列

必須: いいえ

例: "dnsIpAddresses": ["198.51.100.1","198.51.100.2"]

例については、Amazon EC2 User Guide for Windows Instances の「Windows Server インスタンスの AWS Directory Service ドメインへの結合」を参照してください。

aws:downloadContent

(スキーマバージョン 2.0 以降) リモートの場所からら SSM ドキュメントとスクリプトをダウンロードします。このプラグインは、Linux オペレーティングシステムおよび Windows Server オペレーティングシステムでのみサポートされています。

構文

"mainSteps": [ { "action":"aws:downloadContent", "name":"downloadContent", "inputs":{ "sourceType":"{{ sourceType }}", "sourceInfo":"{{ sourceInfo }}", "destinationPath":"{{ destinationPath }}" } }

入力

sourceType

ソースをダウンロードします。Systems Manager は、現在、スクリプトと SSM ドキュメントをダウンロードするための次のソースタイプとして、GitHubS3、および SSMDocument をサポートしています。

型: 文字列

必須: はい

sourceInfo

必須ソースからコンテンツを取得するために必要な情報。

型: StringMap

必須: はい

sourceType GitHubの場合、次を指定します。

  • 所有者: リポジトリ所有者。

  • リポジトリ: リポジトリの名前。

  • パス: ダウンロードするファイルまたはディレクトリのパス。

  • getOptions: 別のブランチや異なるコミットからコンテンツを取得するためのオプション。このパラメータは次の形式を使用します。

    • ブランチ: branch_name

      デフォルト: master

    • commitID:commitID

      デフォルト: head

  • tokenInfo: アクセストークン情報を保存する {{ssm-secure:secure-string-token}} 形式の、Systems Manager パラメータ(SecureString パラメータ)。

    注記

    この tokenInfo フィールドは、SecureString パラメータをサポートする唯一の SSM ドキュメントプラグインフィールドです。SecureString パラメータは、他のフィールドや他の SSM ドキュメントプラグインではサポートされません。

Example syntax: { "owner":"TestUser", "repository":"GitHubTest", "path": "scripts/python/test-script", "getOptions" : "branch:master", "tokenInfo":"{{ssm-secure:secure-string-token}}" }

sourceType S3 の場合、次を指定します。

  • パス: Amazon S3 からダウンロードするファイルまたはディレクトリの URL。

Example syntax: { "path": "https://s3.amazonaws.com/aws-executecommand-test/powershell/helloPowershell.ps1" }

sourceType SSMDocument の場合、次のいずれかを指定します。

  • 名前: name:version の形式のドキュメントの名前とバージョン。バージョンは省略できます。

    Example syntax: { "name": "Example-RunPowerShellScript:3" }
  • 名前: 次の形式のドキュメントの ARN: arn:aws:ssm:region:account_id:document/document_name

    { "name":"arn:aws:ssm:us-east-2:3344556677:document/MySharedDoc" }
destinationPath

ファイルのダウンロード先としてオプションで指定する、インスタンス上のローカルパス。パスを指定しない場合、コンテンツは、コマンド ID に相対的なパスにダウンロードされます。

型: 文字列

必須: いいえ

aws:psModule

EC2 インスタンスに PowerShell モジュールをインストールします。このプラグインは、Microsoft Windows Server オペレーティングシステム上でのみ実行されます。詳細については、「AWS Systems Manager ドキュメント」を参照してください。

構文

"runtimeConfig":{ "aws:psModule":{ "properties":[ { "id":"0.aws:psModule", "runCommand":"{{ commands }}", "source":"{{ source }}", "sourceHash":"{{ sourceHash }}", "workingDirectory":"{{ workingDirectory }}", "timeoutSeconds":"{{ executionTimeout }}" } ]

プロパティ

runCommand

モジュールのインストール後に実行する PowerShell コマンド。

型: リストまたは配列

必須: いいえ

source

アプリケーション.zip ファイルへのインスタンスの URL またはローカルパス。

型: 文字列

必須: いいえ

sourceHash

.zip ファイルの SHA256 ハッシュ。

型: 文字列

必須: いいえ

timeoutSeconds

コマンドが失敗したとみなされるまでの経過時間 (秒)。

型: 文字列

必須: いいえ

workingDirectory

インスタンスの作業ディレクトリへのパス。

型: 文字列

必須: いいえ

aws:refreshAssociation

(スキーマ バージョン 2.0 以降) 必要に応じて関連付けを更新 (強制適用) します。このアクションは、選択された関連付けで定義されている内容またはターゲットにバインドされているすべての関連付けに基づいてシステム状態を変更します。このプラグインは、Linux および Microsoft Windows Server オペレーティングシステム上でのみ実行されます。詳細については、「AWS Systems Manager ドキュメント」を参照してください。

構文

"action":"aws:refreshAssociation", "name":"refreshAssociation", "inputs": { "associationIds": "{{ associationIds }}" }

入力

associationIds

関連付け ID の一覧。空の場合、指定されたターゲットにバインドされたすべての関連付けが適用されます。

タイプ: StringList

必須: いいえ

aws:runDockerAction

(スキーマバージョン 2.0 以降) コンテナで Docker アクションを実行します。このプラグインは、Linux および Microsoft Windows Server オペレーティングシステム上でのみ実行されます。詳細については、「AWS Systems Manager ドキュメント」を参照してください。

構文

"mainSteps": [ { "action": "aws:runDockerAction", "name": "RunDockerAction", "inputs": { "action": "{{ action }}", "container": "{{ container }}", "image": "{{ image }}", "memory": "{{ memory }}", "cpuShares": "{{ cpuShares }}", "volume": "{{ volume }}", "cmd": "{{ cmd }}", "env": "{{ env }}", "user": "{{ user }}", "publish": "{{ publish }}" }

入力

action

実行するアクションのタイプ。

型: 文字列

必須: はい

コンテナ

Docker コンテナ ID。

型: 文字列

必須: いいえ

イメージ

Docker イメージ名。

型: 文字列

必須: いいえ

cmd

コンテナコマンド。

型: 文字列

必須: いいえ

メモリ

コンテナメモリの制限。

型: 文字列

必須: いいえ

cpuShares

コンテナの CPU シェア (相対重み)。

型: 文字列

必須: いいえ

ボリューム

コンテナボリュームのマウント。

タイプ: StringList

必須: いいえ

env

コンテナ環境変数。

型: 文字列

必須: いいえ

ユーザー

コンテナユーザー名。

型: 文字列

必須: いいえ

publish

コンテナ公開されたポート。

型: 文字列

必須: いいえ

aws:runDocument

(スキーマバージョン 2.0 以降) Systems Manager またはローカル共有で保存されている SSM ドキュメントを実行します。このプラグインと aws:downloadContent プラグインを使用して、リモートの場所から SSM ドキュメントをローカル共有にダウンロードして実行できます。このプラグインは、Linux オペレーティングシステムおよび Windows Server オペレーティングシステムでのみサポートされています。

構文

"mainSteps": [ { "action":"aws:runDocument", "name":"runDocument", "inputs":{ "documentType":"{{ documentType }}", "documentPath":"{{ documentPath }}", "documentParameters":"{{ documentParameters }}" } }

入力

documentType

実行するドキュメントタイプ。ローカルドキュメント (LocalPath) または Systems Manager (SSMDocument) に保存されているドキュメントを実行できます。

型: 文字列

必須: はい

documentPath

ドキュメントへのパス。documentTypeLocalPath の場合は、ローカル共有上のドキュメントへのパスを指定します。documentTypeSSMDocument の場合は、ドキュメントの名前を指定します。

型: 文字列

必須: いいえ

documentParameters

ドキュメントのパラメータ。

型: StringMap

必須: いいえ

aws:runPowerShellScript

PowerShell スクリプトを実行するか、またはスクリプトを実行するパスを指定します。このプラグインは、Microsoft Windows オペレーティングシステムおよび Linux オペレーティングシステムでのみ実行されます。詳細については、「AWS Systems Manager ドキュメント」を参照してください。

構文

1.2 SSM ドキュメントの構文

"runtimeConfig":{ "aws:runPowerShellScript":{ "properties":[ { "id":"0.aws:runPowerShellScript", "runCommand":"{{ commands }}", "workingDirectory":"{{ workingDirectory }}", "timeoutSeconds":"{{ executionTimeout }}" } ]

2.2 SSM ドキュメントの構文

"mainSteps": [ { "action":"aws:runPowerShellScript", "name":"step name", "inputs":{ "timeoutSeconds":"Timeout in seconds", "runCommand":"[Command to run]" } } ]

schemaVersion 2.2 の例は以下のとおりです。

{ "schemaVersion":"2.2", "description":"Simple test document using the aws:runPowerShellScript plugin.", "parameters":{ "Salutation":{ "type":"String", "description":"(Optional) This is an optional parameter that will be displayed in the output of the command if specified.", "allowedPattern":"[a-zA-Z]", "default":"World" } }, "mainSteps":[ { "action":"aws:runPowerShellScript", "name":"DisplaySalutation", "inputs":{ "timeoutSeconds":60, "runCommand":[ "$salutation = '{{ Salutation }}'", "", "if ( [String]::IsNullOrWhitespace( $salutation ) )", "{", " $salutation = 'anonymous'", "}", "", "Write-Host ('Hello {0}' -f $salutation)" ] } } ] }

プロパティ

runCommand

実行するコマンド、またはインスタンス上の既存のスクリプトへのパスを指定します。

型: リストまたは配列

必須: はい

timeoutSeconds

コマンドが失敗したとみなされるまでの経過時間 (秒)。タイムアウトに達すると、Systems Manager はコマンド実行を停止します。

型: 文字列

必須: いいえ

workingDirectory

インスタンスの作業ディレクトリへのパス。

型: 文字列

必須: いいえ

aws:runShellScript

Linux シェルスクリプトを実行するか、またはスクリプトを実行するパスを指定します。このプラグインは、Linux オペレーティングシステム上のみで実行されます。詳細については、「AWS Systems Manager ドキュメント」を参照してください。

構文

1.2 SSM ドキュメントの構文

"runtimeConfig":{ "aws:runShellScript":{ "properties":[ { "id":"0.aws:runShellScript", "runCommand":"{{ commands }}", "workingDirectory":"{{ workingDirectory }}", "timeoutSeconds":"{{ executionTimeout }}" } ]

2.2 SSM ドキュメントの構文

"mainSteps": [ { "action":"aws:runShellScript", "name":"step name", "inputs":{ "timeoutSeconds":"Timeout in seconds", "runCommand":"[Command to run]" } } ]

schemaVersion 2.2 の例は以下のとおりです。

{ "schemaVersion": "2.2", "description": "Simple test document using the aws:runShellScript plugin.", "parameters": { "salutation": { "type": "String", "description": "(Optional) This is an optional parameter that will be displayed in the output of the command if specified.", "default": "Hello World" } }, "mainSteps": [ { "action": "aws:runShellScript", "name": "DisplaySalutation", "inputs": { "timeoutSeconds": 60, "runCommand": [ "echo {{ salutation }}" ] } } ] }

プロパティ

runCommand

実行するコマンド、またはインスタンス上の既存のスクリプトへのパスを指定します。

型: リストまたは配列

必須: はい

timeoutSeconds

コマンドが失敗したとみなされるまでの経過時間 (秒)。タイムアウトに達すると、Systems Manager はコマンド実行を停止します。

型: 文字列

必須: いいえ

workingDirectory

インスタンスの作業ディレクトリへのパス。

型: 文字列

必須: いいえ

aws:softwareInventory

(スキーマバージョン 2.0 以降) マネージドインスタンスのアプリケーション、ファイル、および設定に関するメタデータを収集します。このプラグインは、Linux および Microsoft Windows Server オペレーティングシステム上でのみ実行されます。インベントリの収集の詳細については、「AWS Systems Manager インベントリ」を参照してください。

構文

"mainSteps": [ { "action": "aws:softwareInventory", "name": "collectSoftwareInventoryItems", "inputs": { "applications": "{{ applications }}", "awsComponents": "{{ awsComponents }}", "networkConfig": "{{ networkConfig }}", "files": "{{ files }}", "services": "{{ services }}", "windowsRoles": "{{ windowsRoles }}", "windowsRegistry": "{{ windowsRegistry}}", "windowsUpdates": "{{ windowsUpdates }}", "instanceDetailedInformation": "{{ instanceDetailedInformation }}", "customInventory": "{{ customInventory }}" } } ]

入力

applications

(オプション) インストールされているアプリケーションのメタデータを収集します。

型: 文字列

必須: いいえ

awsComponents

(オプション) amazon-ssm-agent などの AWS コンポーネントのメタデータを収集します。

型: 文字列

必須: いいえ

files

(オプション、SSM エージェントバージョン 2.2.64.0 以降が必要) ファイル名、ファイル作成時間、ファイルの最終変更時間および最新アクセス時間、およびファイルサイズを含むファイルのメタデータを収集します (これらはほんの数例です)。ファイルインベントリの収集の詳細については、「ファイルと Windows レジストリインベントリで作業する」を参照してください。

型: 文字列

必須: いいえ

networkConfig

(オプション) ネットワーク設定のメタデータを収集します。

型: 文字列

必須: いいえ

windowsUpdates

(オプション) すべての Windows アップデートのメタデータを収集します。

型: 文字列

必須: いいえ

InstanceDetailedInformation

(オプション) CPU モデル、速度、コア数を含む、デフォルトのインベントリプラグイン (aws:instanceInformation) によって提供されるよりも多くのインスタンス情報を収集します (これらはほんの数例です)。

型: 文字列

必須: いいえ

サービス

(オプション、Windows OS のみ、SSM エージェントバージョン 2.2.64.0 以降が必要) サービス設定のメタデータを収集します。

型: 文字列

必須: いいえ

windowsRegistry

(オプション、Windows OS のみ、SSM エージェントバージョン 2.2.64.0 以降が必要) Windows レジストリキーと値を収集します。キーパスを選択して、すべてのキーと値を再帰的に収集できます。指定するパスで指定するレジストリキーおよびその値を収集することもできます。インベントリは、キーパス、名前、タイプ、値を収集します。Windows レジストリインベントリの収集についての詳細は、「ファイルと Windows レジストリインベントリで作業する」を参照してください。

型: 文字列

必須: いいえ

windowsRoles

(オプション、Windows OS のみ、SSM エージェントバージョン 2.2.64.0 以降が必要) Microsoft Windows ロール設定のメタデータを収集します。

型: 文字列

必須: いいえ

customInventory

(オプション) カスタムインベントリのデータを収集します。カスタムインベントリの詳細については、「カスタムインベントリの操作」を参照してください

型: 文字列

必須: いいえ

aws:updateAgent

EC2Config サービスを最新バージョンに更新するか、または古いバージョンを指定します。このプラグインは、Microsoft Windows Server オペレーティングシステム上でのみ実行されます。EC2Config サービスの詳細については、「EC2Config サービスを使用した Windows インスタンスの設定」を参照してください。ドキュメントの詳細については、「AWS Systems Manager ドキュメント」を参照してください。

構文

"runtimeConfig": { "aws:updateAgent": { "properties": { "agentName": "Ec2Config", "source": "https://s3.region.amazonaws.com/aws-ssm-region/manifest.json", "allowDowngrade": "{{ allowDowngrade }}", "targetVersion": "{{ version }}" } } }

プロパティ

agentName

EC2Config.これは、EC2Config サービスを実行するエージェントの名前です。

型: 文字列

必須: はい

allowDowngrade

EC2Config サービスを以前のバージョンにダウングレードできるようにします。false に設定すると、サービスは新しいバージョンにのみアップグレードできます (デフォルト)。true に設定すると、以前のバージョンを指定します。

タイプ: ブール値

必須: いいえ

送信元

Systems Manager がインストールする EC2Config のバージョンをコピーする場所。この場所は変更できません。

型: 文字列

必須: はい

targetVersion

インストールする EC2Config サービスの特定のバージョン。指定しない場合、サービスは最新バージョンに更新されます。

型: 文字列

必須: いいえ

aws:updateSSMAgent

SSM エージェント を最新バージョンに更新するか、以前のバージョンを指定します。このプラグインは、Linux オペレーティングシステムおよび Windows Server オペレーティングシステムでのみ実行されます。詳細については、「SSM エージェント の使用」を参照してください。ドキュメントの詳細については、「AWS Systems Manager ドキュメント」を参照してください。

構文

"runtimeConfig": { "aws:updateSsmAgent": { "properties": [ { "agentName": "amazon-ssm-agent", "source": "https://s3.region.amazonaws.com/aws-ssm-region/manifest.json", "allowDowngrade": "{{ allowDowngrade }}", "targetVersion": "{{ version }}" } ] } }

プロパティ

agentName

amazon-ssm-agent。これは、リクエストを処理してインスタンス上でコマンドを実行する Systems Manager エージェントの名前です。

型: 文字列

必須: はい

allowDowngrade

SSM エージェント を以前のバージョンにダウングレードできます。false に設定すると、エージェントは新しいバージョンにのみアップグレードできます (デフォルト)。true に設定すると、以前のバージョンを指定します。

タイプ: ブール値

必須: いいえ

送信元

Systems Manager がインストールする SSM エージェント のバージョンをコピーする場所。この場所は変更できません。

型: 文字列

必須: はい

targetVersion

インストールする SSM エージェント の特定のバージョン。指定しない場合、エージェントは最新バージョンに更新されます。

型: 文字列

必須: いいえ