Systems Manager コマンド ドキュメント プラグイン参照 - AWS Systems Manager

英語の翻訳が提供されている場合で、内容が矛盾する場合には、英語版がオリジナルとして取り扱われます。翻訳は機械翻訳により提供されています。

Systems Manager コマンド ドキュメント プラグイン参照

このリファレンスでは、 AWS Systems Manager (SSM) コマンド文書。これらのプラグインは、 自動化アクション。情報: AWS Systems Manager 自動化アクション、を参照 Systems Manager Automation actions reference.

Systems Manager コンテンツを読み取ることによって、管理対象インスタンスに対して実行するアクションを決定します。 SSM ドキュメントの です。各文書には、コード実行セクションが含まれています。環境に応じて このコード実行セクションには、1 つ以上の プラグインまたはステップ。このヘルプトピックでは、プラグインとステップが呼び出されます。 プラグイン. このセクションには、 Systems Manager プラグイン。ドキュメントの詳細( ドキュメントの作成およびスキーマ バージョン間の違いについては、を参照してください。 AWS Systems Manager 文書.

注記

ここで説明されているプラグインの一部は、 Windows Server インスタンスまたは Linux インスタンス。プラットフォームの依存関係は、各プラグインに示されます。

aws:アプリケーション

EC2インスタンスにアプリケーションをインストール、修復、アンインストールします。このプラグインのみ 実行日 Windows Server オペレーティングシステム。詳細については、以下を参照してください。 AWS Systems Manager 文書.

Syntax

スキーマ2.2

YAML
--- schemaVersion: '2.2' description: aws:applications plugin parameters: source: description: "(Required) Source of msi." type: String mainSteps: - action: aws:applications name: example inputs: action: Install source: "{{ source }}"
JSON
{ "schemaVersion":"2.2", "description":"aws:applications", "parameters":{ "source":{ "description":"(Required) Source of msi.", "type":"String" } }, "mainSteps":[ { "action":"aws:applications", "name":"example", "inputs":{ "action":"Install", "source":"{{ source }}" } } ] }

スキーマ 1.2

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

Properties

アクション

実行するアクション。

タイプ: 列挙

有効な値: Install | Repair | Uninstall

必須: はい

パラメータ

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

タイプ: 文字列

必須: いいえ

ソース

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

タイプ: 文字列

必須: はい

ソースハッシュソース:ハッシュ

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

タイプ: 文字列

必須: いいえ

aws:cloudWatch

データのエクスポート元 Windows Server へ Amazon CloudWatch または Amazon CloudWatch Logs データの監視を CloudWatch メトリック。このプラグインは、 Windows Server オペレーティングシステム。詳細については、 設定について CloudWatch とのインテグレーション Amazon EC2、を参照 ログ、イベント、および パフォーマンスは、 Amazon CloudWatch. ドキュメントの詳細については、 参照 AWS Systems Manager 文書.

重要

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

以下のデータをエクスポートおよび監視できます。 タイプ:

アプリケーションイベントログ

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

カスタムログ

テキストベースのログファイルを CloudWatch ログに送信します。は CloudWatch プラグイン は、ログ ファイルのフィンガープリントを作成します。次にシステムはデータを関連付けます 各指紋でオフセットします。プラグインは、 オフセットの変更、記録、およびオフセットの関連付けを行います。 指紋。この方法は、ユーザーが プラグインを有効にし、サービスを には多数のファイルが含まれており、システムは ファイル。

警告

アプリケーションがトランケートしたり、クリーンアップを試行したりする場合は、 ポーリング中のログ、 LogDirectoryPath 入力が失われます。例えば、 ログ ファイルのサイズを制限する場合は、新しいログ ファイルを作成します。 制限に達したら、新しい ファイル。

ETW(東部時間)

Windows (ETW) データのイベント追跡を に送信します CloudWatch Logs.

IIS(IIS)

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

パフォーマンスカウンタ

Windows パフォーマンス カウンタを CloudWatch に送信します。以下を選択できます。 アップロード先の異なるカテゴリ CloudWatch メトリックとして。各パフォーマンスについて アップロードしたいカウンタを パフォーマンスカウンタ 一意の ID を持つセクション (たとえば、「PerformanceCounter2」、「PerformanceCounter3」など) および でプロパティを構成します。

注記

_が SSM エージェント または CloudWatch プラグインが停止しています、パフォーマンス カウンタ データはログインしていません CloudWatch この動作はカスタムの動作とは異なります ログまたはWindowsイベント ログ。カスタムログとWindowsイベントログ パフォーマンス カウンタ データを保存し、 CloudWatch 後 SSM エージェント または CloudWatch プラグインが利用可能です。

セキュリティイベントログ

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

システムイベントログ

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

データの次の宛先を定義できます。

CloudWatch(クラウドウォッチ)

パフォーマンス カウンタ メトリック データの送信先。一意の ID を持つセクションを追加できます (たとえば、「CloudWatch2」、 CloudWatch3"など)、新しい ID ごとに異なる地域を指定 同じデータを別の場所に送信する。

CloudWatchLogs(クラウド・ウォッチ・ログ)

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

Syntax

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

設定とプロパティ

アクセスキー

アクセスキーID。このプロパティは、 を起動しない限り、必須です。 インスタンスで IAM 役割。このプロパティは、 SSM。

タイプ: 文字列

必須: いいえ

カテゴリ名

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

タイプ: 文字列

必須: はい

カウンター名

PerformanceのPerformanceカウンタの名前 監視する。

タイプ: 文字列

必須: はい

文化名

タイムスタンプがログされるロケール。次の場合: 文化名 が空白の場合、デフォルトは が現在使用しているロケールと同じロケール Windows Server インスタンス。

タイプ: 文字列

有効な値: サポートされている値のリストについては、以下を参照してください。 National Language Support(NLS) Microsoftの ウェブサイト。注: ディビジョン, ディビジョンMVフー、および フフフ 値はサポートされていません。

必須: いいえ

属性名

あなたの Amazon CloudWatch メトリック。指定する場合 DimensionName、指定する必要があります DimensionValue。 これらのパラメータは、 メトリックをリストするときに表示します。同じディメンションを 複数のメトリックを使用して、 特定寸法。

タイプ: 文字列

必須: いいえ

寸法値

の属性値 Amazon CloudWatch メトリック。

タイプ: 文字列

必須: いいえ

エンコーディング

使用するファイル・エンコーディング (UTF-8 など)。エンコーディングを使用 表示名ではなく名前。

タイプ: 文字列

有効な値: サポートされている値のリストについては、以下を参照してください。 エンコーディングクラス MSDNライブラリで確認してください。

必須: はい

フィルター

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

タイプ: 文字列

有効な値: サポートされている値のリストについては、 FileSystemWatcherFilterプロパティ MSDN の ライブラリ。

必須: いいえ

フロー

アップロードする各データタイプ、およびデータの保存先 (CloudWatch または CloudWatch Logs)。たとえば、パフォーマンス カウンタを 下 "Id": "PerformanceCounter" を CloudWatch で定義された送信先 "Id": "CloudWatch"、入力 PerformanceCounter、CloudWatch. 同様に、 カスタムログ、ETWログ、およびシステムログを CloudWatch Logs で定義された送信先 "Id": "ETW"、入力 (ETW),CloudWatchLogs. さらに、 同じパフォーマンス カウンタまたはログ ファイルを複数の 目的地。たとえば、アプリケーション ログを で定義した異なる送信先 "Id": "CloudWatchLogs" および "Id": "CloudWatchLogs2"、入力 "ApplicationEventLog,(CloudWatchLogs, CloudWatchLogs2)".

タイプ: 文字列

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

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

必須: はい

氏名

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

タイプ: 文字列

必須: はい

ID

データソースまたは転送先を特定します。この識別子は 設定ファイル内で一意です。

タイプ: 文字列

必須: はい

インスタンス名

パフォーマンス カウンタ インスタンスの名前。使用禁止 各パフォーマンスが カウンタ コンポーネントは 1 つのメトリックのみをサポートします。ただし、 _合計.

タイプ: 文字列

必須: はい

組織

送信するメッセージのタイプ Amazon CloudWatch.

タイプ: 文字列

有効な値:

  • 1 - エラーメッセージのみ アップロードされました。

  • 2 - 警告メッセージのみ アップロードされました。

  • 4 - 情報メッセージのみ アップロードされました。

値を追加して、複数の メッセージのタイプ。例えば、 3 すなわち、 エラー メッセージ(1)および警告メッセージ (2)が含まれています。値: 7 エラーメッセージが (1)、警告メッセージ (2)、および情報メッセージ (4)が含まれています。

必須: はい

注記

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

ラインカウント

ログファイルを識別するヘッダーの行数。対象: たとえば、IIS ログ ファイルには実質的に同一のヘッダーがあります。皆さんは Enter(入力) 3最初の3行を読み取る ログファイルのヘッダーの番号を指定します。IIS ログ ファイルでは、3 番目の line は、ログ間で異なる日時スタンプです。 ファイル。

タイプ: 整数

必須: いいえ

LogDirectoryPath (ログディレクトリパス)

CustomLogsの場合、ログがEC2に保存されるパス インスタンス。IIS ログの場合、IIS ログが格納されるフォルダ 個別のサイト(例: C:\\inetpub\\logs\\LogFiles\\W3SVCn)。 IIS ログでは、W3C ログ形式のみがサポートされています。IIS、NCSA、および カスタム形式はサポートされていません。

タイプ: 文字列

必須: はい

ロググループ

ログ グループの名前。この名前は、 ロググループ 画面を CloudWatch コンソール。

タイプ: 文字列

必須: はい

ログ名

ログファイルの名前。

  1. ログの名前を見つけるには、Event Viewer の ナビゲーションペイン、クリック アプリケーションおよびサービス ログ.

  2. ログのリストで、ログを右クリックします。 アップロード(例: Microsoft>Windows>Backup>Operational)、次に クリック カスタムビューの作成.

  3. カスタムビューの作成 ダイアログボックス、 _をクリック XML タブ。は ログ名 <Select(選択) Path=> タグ(例: Microsoft-Windows-Backup)。このテキストをコピー に取り込む ログ名 パラメータ。

タイプ: 文字列

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

必須: はい

ログストリーム

宛先ログ ストリーム。使用している場合 {instance_id}、デフォルト、インスタンスID ログストリーム名として、このインスタンスの が使用されます。

タイプ: 文字列

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

まだ存在しないログストリーム名を入力すると、 CloudWatch Logs 自動的に作成されます。リテラル文字列または 定義済み変数({instance_id}, {ホスト名}, {ip_address}、または3つの組み合わせ ログストリーム名を定義します。

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

必須: はい

メトリック名

は CloudWatch パフォーマンス データを表示するメトリック 下にあります。

注記

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

タイプ: 文字列

必須: はい

名前スペース

パフォーマンス カウンタ データを 記載する。

タイプ: 文字列

必須: はい

ポーリング間隔

新しいパフォーマンス カウンタと ログデータがアップロードされます。

タイプ: 整数

有効な値: 5秒以上に設定します。15秒 (00:00:15)が推奨されます。

必須: はい

地域

ログデータを送信する AWS 地域。でも、 パフォーマンス カウンタを、送信する別の地域に送信する このパラメータを同じ インスタンスが実行されている地域。

タイプ: 文字列

有効な値: AWS リージョンのリージョン ID は、 Systems Manager および CloudWatch Logsなど us-east-2, eu-west-1、および ap-southeast-1。 対象: 各サービスでサポートされているAWSリージョンのリストについては、「 Amazon CloudWatch Logs サービス エンドポイント および アマゾン ウェブ サービス全般のリファレンスの「Systems Manager サービスエンドポイント」.

必須: はい

シークレットキー

秘密のアクセスキー。このプロパティは、 は、 IAM 役割。

タイプ: 文字列

必須: いいえ

開始タイプ

有効または無効 CloudWatch 表示されます。

タイプ: 文字列

有効な値: Enabled | Disabled

必須: はい

タイムスタンプ形式

使用するタイムスタンプ形式。サポートされている 値、を参照 カスタム日付および時間フォーマット文字列 MSDN の ライブラリ。

タイプ: 文字列

必須: はい

タイムゾーンKind

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

タイプ: 文字列

有効な値: Local | UTC

必須: いいえ

単位

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

タイプ: 文字列

有効な値: 秒 | マイクロ秒 | ミリ秒 | バイト | キロバイト | メガバイト | ギガバイト | テラバイト | ビット | キロビット | メガビット | ギガビット | テラビット | パーセント | カウント | バイト/秒 | キロバイト/秒 | メガバイト/秒 | ギガバイト/秒 | テラバイト/秒 | ビット/秒 | キロビット/秒 | メガビット/秒 | ギガビット/秒 | テラビット/秒 | カウント/秒 | なし

必須: はい

aws:設定ドッカー

(Schema バージョン 2.0 以降)コンテナおよび ドッカー。このプラグインは、Linux および Windows Server オペレーティングシステム。詳細はこちら 情報、参照 AWS Systems Manager 文書.

Syntax

スキーマ2.2

YAML
--- schemaVersion: '2.2' description: aws:configureDocker parameters: action: description: "(Required) The type of action to perform." type: String default: Install allowedValues: - Install - Uninstall mainSteps: - action: aws:configureDocker name: configureDocker inputs: action: "{{ action }}"
JSON
{ "schemaVersion": "2.2", "description": "aws:configureDocker plugin", "parameters": { "action": { "description": "(Required) The type of action to perform.", "type": "String", "default": "Install", "allowedValues": [ "Install", "Uninstall" ] } }, "mainSteps": [ { "action": "aws:configureDocker", "name": "configureDocker", "inputs": { "action": "{{ action }}" } } ] }

Inputs

アクション

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

タイプ: 列挙

有効な値: Install | Uninstall

必須: はい

aws:設定パッケージ

(スキーマ バージョン 2.0 以降) ディストリビューター パッケージをインストールまたはアンインストールします。以下が可能です。 最新バージョン、デフォルト バージョン、またはパッケージのバージョンをインストールします。 指定します。AWSが提供するパッケージもサポートされています。このプラグインは、 Windows Server および Linux オペレーティング システム。ただし、すべての使用可能なパッケージが Linux オペレーティング システム。

の利用可能なAWSパッケージ Windows Server 以下を含みます。AWSPVDriver、AWSNVMe、 AwsEnaNetworkDriver、AwsVssComponents、AmazonCloudWatchAgent、 AWSSupport-EC2Rescue。

Linux オペレーティング システムで使用可能な AWS パッケージには、以下が含まれます。AmazonCloudWatchAgentおよびAWSSupport-EC2Rescue。

詳細については、以下を参照してください。 AWS Systems Manager 文書.

Syntax

スキーマ2.2

YAML
--- schemaVersion: '2.2' description: aws:configurePackage parameters: name: description: "(Required) The name of the AWS package to install or uninstall." type: String action: description: "(Required) The type of action to perform." type: String default: Install allowedValues: - Install - Uninstall mainSteps: - action: aws:configurePackage name: configurePackage inputs: name: "{{ name }}" action: "{{ action }}" additionalArguments: SSM_parameter_store_arg: "{{ ssm:parameter_store_arg }}" SSM_custom_arg: "myValue"
JSON
{ "schemaVersion": "2.2", "description": "aws:configurePackage", "parameters": { "name": { "description": "(Required) The name of the AWS package to install or uninstall.", "type": "String" }, "action": { "description": "(Required) The type of action to perform.", "type": "String", "default": "Install", "allowedValues": [ "Install", "Uninstall" ] } }, "mainSteps": [ { "action": "aws:configurePackage", "name": "configurePackage", "inputs": { "name": "{{ name }}", "action": "{{ action }}", "additionalArguments": { "SSM_parameter_store_arg": "{{ ssm:parameter_store_arg }}", "SSM_custom_arg": "myValue" } } } ] }

Inputs

名前

インストールまたはアンインストールする AWS パッケージの名前。利用可能 パッケージには次のものが含まれます。AWSPVDriver、AwsEnaNetworkDriver、 AwsVssComponents、AmazonCloudWatchAgent。

タイプ: 文字列

必須: はい

アクション

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

タイプ: 列挙

有効な値: Install | Uninstall

必須: はい

インストールタイプ

実行するインストールのタイプ。指定する場合 Uninstall and reinstall、パッケージは完全に アンインストールしてから再インストールします。アプリケーションは利用できません 再インストールが完了するまで 指定する場合 In-place update新規または変更されたファイルのみが 既存のインストールは、 更新スクリプト。アプリケーションは、 更新プロセス。は In-place update オプションが AWS 公開パッケージでサポートされています。Uninstall and reinstall はデフォルト値です。

タイプ: 列挙

有効な値: Uninstall and reinstall | In-place update

必須: いいえ

追加引数

インストール、アンインストール、 または更新スクリプト。各パラメータは、先頭に SSM_。 は、 パラメータストア パラメータ 規則を使用して追加の議論を行う {{ssm:parameter-name}}. インストール、アンインストール、または 更新スクリプトの場合、パラメータを環境として参照する必要があります。 オペレーティング システムに適した構文を使用した変数。対象: 例、PowerShellでは、 SSM_arg 引数 $Env:SSM_arg。 以下に制限はありません。 定義している引数の数。ただし、追加の引数入力。 には4096文字の制限があります。この制限には、すべてのキーと 定義します。

タイプ: 文字列マップ

必須: いいえ

バージョン

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

タイプ: 文字列

必須: いいえ

aws:ドメインジョイン

EC2インスタンスをドメインに参加させます。このプラグインは、 Windows Server 動作中 システム。詳細については、以下を参照してください。 AWS Systems Manager 文書.

Syntax

スキーマ2.2

YAML
--- schemaVersion: '2.2' description: aws:domainJoin parameters: directoryId: description: "(Required) The ID of the directory." type: String directoryName: description: "(Required) The name of the domain." type: String mainSteps: - action: aws:domainJoin name: domainJoin inputs: directoryId: "{{ directoryId }}" directoryName: "{{ directoryName }}"
JSON
{ "schemaVersion": "2.2", "description": "aws:domainJoin", "parameters": { "directoryId": { "description": "(Required) The ID of the directory.", "type": "String" }, "directoryName": { "description": "(Required) The name of the domain.", "type": "String" } }, "mainSteps": [ { "action": "aws:domainJoin", "name": "domainJoin", "inputs": { "directoryId": "{{ directoryId }}", "directoryName": "{{ directoryName }}" } } ] }

スキーマ 1.2

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

Properties

ディレクトリID

ディレクトリの ID。

タイプ: 文字列

必須: はい

例:"directoryId":"d-1234567890"

ディレクトリ名

ドメインの名前。

タイプ: 文字列

必須: はい

例:「directoryName」: 「example.com」

ディレクトリOU

組織単位(OU)。

タイプ: 文字列

必須: いいえ

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

dnsIpアドレス

DNSサーバのIPアドレス。

タイプ: アレイ

必須: いいえ

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

Examples

例については、以下を参照してください。 への参加 Windows Server へのインスタンス AWS Directory Service ドメインWindows インスタンスの Amazon EC2 ユーザーガイド.

aws:ダウンロードコンテンツ

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

Syntax

スキーマ2.2

YAML
--- schemaVersion: '2.2' description: aws:downloadContent parameters: sourceType: description: "(Required) The download source." type: String sourceInfo: description: "(Required) The information required to retrieve the content from the required source." type: StringMap mainSteps: - action: aws:downloadContent name: downloadContent inputs: sourceType: "{{ sourceType }}" sourceInfo: "{{ sourceInfo }}"
JSON
{ "schemaVersion": "2.2", "description": "aws:downloadContent", "parameters": { "sourceType": { "description": "(Required) The download source.", "type": "String" }, "sourceInfo": { "description": "(Required) The information required to retrieve the content from the required source.", "type": "StringMap" } }, "mainSteps": [ { "action": "aws:downloadContent", "name": "downloadContent", "inputs": { "sourceType":"{{ sourceType }}", "sourceInfo":"{{ sourceInfo }}" } } ] }

Inputs

ソースタイプ

ダウンロード元。 Systems Manager 現在次のソースをサポートしています スクリプトおよび SSM ドキュメント: GitHubS3、および SSMDocument.

タイプ: 文字列

必須: はい

ソース情報

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

タイプ: 文字列マップ

必須: はい

sourceType GitHubの場合は、 次のようになります。

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

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

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

  • getOptions: コンテンツを取得するための追加オプション マスター以外のブランチ、または リポジトリ。getOptions は、 マスターブランチにおける最新のコミット。

    このパラメータは、次の形式を使用します。

    • ブランチ:branch_name

      デフォルトは master.

      branch パラメータは、SSM 文書が、 master.

    • commitID:commitID

      デフォルトは head.

      SSM ドキュメントのバージョンを 最新以外のコミット、完全 コミットID。例:

      "getOptions": "commitID:bbc1ddb94...b76d3bEXAMPLE",
  • トークン情報: は Systems Manager パラメータ(SecureStringパラメータ) GitHubアクセストークン情報を 形式 {{ssm-secure:secure-string-token-name}}.

    注記

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

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

sourceType S3の場合は、 次のようになります。

  • パス: ファイルまたはディレクトリへの URL ダウンロード元 Amazon S3.

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

sourceType SSMDocumentの場合、指定します 1つ 以下のうち:

  • 名前: ドキュメントの名前とバージョンは、 次の形式: name:version。 バージョンは 任意です。

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

    { "name":"arn:aws:ssm:us-east-2:3344556677:document/MySharedDoc" }
宛先パス

ダウンロードするインスタンス上のオプションのローカル パス ファイル。パスを指定しない場合、コンテンツは コマンド ID に関連するパス。

タイプ: 文字列

必須: いいえ

aws:psモジュール

PowerShellモジュールをEC2インスタンスにインストールします。このプラグインは、 Windows Server オペレーティングシステム。詳細については、以下を参照してください。 AWS Systems Manager 文書.

Syntax

スキーマ2.2

YAML
--- schemaVersion: '2.2' description: aws:psModule parameters: source: description: "(Required) The URL or local path on the instance to the application .zip file." type: String mainSteps: - action: aws:psModule name: psModule inputs: source: "{{ source }}"
JSON
{ "schemaVersion": "2.2", "description": "aws:psModule", "parameters": { "source": { "description": "(Required) The URL or local path on the instance to the application .zip file.", "type": "String" } }, "mainSteps": [ { "action": "aws:psModule", "name": "psModule", "inputs": { "source": "{{ source }}" } } ] }

スキーマ 1.2

YAML
--- runtimeConfig: aws:psModule: properties: - runCommand: "{{ commands }}" source: "{{ source }}" sourceHash: "{{ sourceHash }}" workingDirectory: "{{ workingDirectory }}" timeoutSeconds: "{{ executionTimeout }}"
JSON
{ "runtimeConfig":{ "aws:psModule":{ "properties":[ { "runCommand":"{{ commands }}", "source":"{{ source }}", "sourceHash":"{{ sourceHash }}", "workingDirectory":"{{ workingDirectory }}", "timeoutSeconds":"{{ executionTimeout }}" } ] } } }

Properties

runCommand (コマンドの実行)

モジュールが インストールされています。

タイプ: 文字列リスト

必須: いいえ

ソース

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

タイプ: 文字列

必須: はい

ソースハッシュソース:ハッシュ

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

タイプ: 文字列

必須: いいえ

タイムアウト秒数

コマンドが完了してからコマンドが完了するまでの時間(秒) 失敗と見なされます。

タイプ: 文字列

必須: いいえ

ワーキングディレクトリ

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

タイプ: 文字列

必須: いいえ

aws:リフレッシュアソシエーション[aws:れんれんれーしょん]

(スキーマ バージョン 2.0 以降) 要求に応じて関連付けを更新 (強制適用)。これは アクションは、選択した ターゲットにバインドされているアソシエーションまたはすべてのアソシエーション。このプラグインはLinuxおよび マイクロソフト Windows Server オペレーティングシステム。詳細については、以下を参照してください。 AWS Systems Manager 文書.

Syntax

スキーマ2.2

YAML
--- schemaVersion: '2.2' description: aws:refreshAssociation parameters: associationIds: description: "(Optional) List of association IDs. If empty, all associations bound to the specified target are applied." type: StringList mainSteps: - action: aws:refreshAssociation name: refreshAssociation inputs: associationIds: - "{{ associationIds }}"
JSON
{ "schemaVersion": "2.2", "description": "aws:refreshAssociation", "parameters": { "associationIds": { "description": "(Optional) List of association IDs. If empty, all associations bound to the specified target are applied.", "type": "StringList" } }, "mainSteps": [ { "action": "aws:refreshAssociation", "name": "refreshAssociation", "inputs": { "associationIds": [ "{{ associationIds }}" ] } } ] }

Inputs

アソシエーションID

アソシエーション ID のリスト。空白の場合、すべてのアソシエーションは 指定したターゲットが適用されます。

タイプ: 文字列リスト

必須: いいえ

aws:runDockerAction[aws:runDockerAction]

(Schemaバージョン2.0以降)コンテナのDockerアクションを実行します。このプラグインは LinuxとMicrosoft Windows Server オペレーティングシステム。詳細については、以下を参照してください。 AWS Systems Manager 文書.

Syntax

スキーマ2.2

YAML
--- 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 }}"
JSON
{ "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 }}" } } ] }

Inputs

アクション

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

タイプ: 文字列

必須: はい

コンテナ

DockerコンテナID。

タイプ: 文字列

必須: いいえ

画像

Dockerイメージ名。

タイプ: 文字列

必須: いいえ

cmd(cmd)

container コマンド。

タイプ: 文字列

必須: いいえ

メモリ

コンテナのメモリ制限。

タイプ: 文字列

必須: いいえ

cpuShares(シェア)

コンテナ CPU は (相対重量) を共有します。

タイプ: 文字列

必須: いいえ

ボリューム

コンテナボリュームがマウントします。

タイプ: 文字列リスト

必須: いいえ

環境

コンテナ環境変数。

タイプ: 文字列

必須: いいえ

ユーザー

コンテナのユーザー名。

タイプ: 文字列

必須: いいえ

公開

コンテナがポートを発行しました。

タイプ: 文字列

必須: いいえ

aws:runDocument[aws:runDocument]

(スキーマ バージョン 2.0 以降) 実行 SSM ドキュメントの保存先: Systems Manager または地元の 共有。このプラグインは、 aws:ダウンロードコンテンツ プラグインを使用して SSM ドキュメント元ドキュメント: ローカル共有へのリモート・ロケーションで実行し、実行します。このプラグインはでサポートされています Linuxおよび Windows Server オペレーティングシステム。

Syntax

スキーマ2.2

YAML
--- schemaVersion: '2.2' description: aws:runDocument parameters: documentType: description: "(Required) The document type to run." type: String allowedValues: - LocalPath - SSMDocument mainSteps: - action: aws:runDocument name: runDocument inputs: documentType: "{{ documentType }}"
JSON
{ "schemaVersion": "2.2", "description": "aws:runDocument", "parameters": { "documentType": { "description": "(Required) The document type to run.", "type": "String", "allowedValues": [ "LocalPath", "SSMDocument" ] } }, "mainSteps": [ { "action": "aws:runDocument", "name": "runDocument", "inputs": { "documentType": "{{ documentType }}" } } ] }

Inputs

ドキュメントタイプ

実行する文書タイプ。ローカル ドキュメントを実行できます。 (LocalPath)、または Systems Manager (SSMDocument)。

タイプ: 文字列

必須: はい

ドキュメントパスドキュメント: パス

ドキュメントへのパス。次の場合: documentType はです LocalPathでドキュメントへのパスを指定します。 ローカルシェアです 次の場合: documentType はです SSMDocument、次に ドキュメント。

タイプ: 文字列

必須: いいえ

ドキュメントパラメータドキュメント:パラメータ

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

タイプ: 文字列マップ

必須: いいえ

aws:runPowerShellScript[aws:runPowerShellScript]

PowerShellスクリプトを実行するか、実行するスクリプトへのパスを指定します。このプラグインは、 マイクロソフト Windows Server Linuxオペレーティング・システム。詳細については、以下を参照してください。 AWS Systems Manager 文書.

Syntax

スキーマ2.2

YAML
--- schemaVersion: '2.2' description: aws:runPowerShellScript parameters: commands: type: String description: "(Required) The commands to run or the path to an existing script on the instance." default: Write-Host "Hello World" mainSteps: - action: aws:runPowerShellScript name: runPowerShellScript inputs: timeoutSeconds: '60' runCommand: - "{{ commands }}"
JSON
{ "schemaVersion": "2.2", "description": "aws:runPowerShellScript", "parameters": { "commands": { "type": "String", "description": "(Required) The commands to run or the path to an existing script on the instance.", "default": "Write-Host \"Hello World\"" } }, "mainSteps": [ { "action": "aws:runPowerShellScript", "name": "runPowerShellScript", "inputs": { "timeoutSeconds": "60", "runCommand": [ "{{ commands }}" ] } } ] }

スキーマ 1.2

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

Properties

runCommand (コマンドの実行)

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

タイプ: 文字列リスト

必須: はい

タイムアウト秒数

コマンドが完了してからコマンドが完了するまでの時間(秒) 失敗と見なされます。タイムアウトになると、 Systems Manager 停止 コマンドの実行。

タイプ: 文字列

必須: いいえ

ワーキングディレクトリ

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

タイプ: 文字列

必須: いいえ

aws:runShellScript

Linuxシェル スクリプトを実行するか、実行するスクリプトへのパスを指定します。このプラグインのみ はLinuxオペレーティングシステム上で動作します。詳細については、以下を参照してください。 AWS Systems Manager 文書.

Syntax

スキーマ2.2

YAML
--- schemaVersion: '2.2' description: aws:runShellScript parameters: commands: type: String description: "(Required) The commands to run or the path to an existing script on the instance." default: echo Hello World mainSteps: - action: aws:runShellScript name: runShellScript inputs: timeoutSeconds: '60' runCommand: - "{{ commands }}"
JSON
{ "schemaVersion": "2.2", "description": "aws:runShellScript", "parameters": { "commands": { "type": "String", "description": "(Required) The commands to run or the path to an existing script on the instance.", "default": "echo Hello World" } }, "mainSteps": [ { "action": "aws:runShellScript", "name": "runShellScript", "inputs": { "timeoutSeconds": "60", "runCommand": [ "{{ commands }}" ] } } ] }

スキーマ 1.2

YAML
--- runtimeConfig: aws:runShellScript: properties: - runCommand: "{{ commands }}" workingDirectory: "{{ workingDirectory }}" timeoutSeconds: "{{ executionTimeout }}"
JSON
{ "runtimeConfig":{ "aws:runShellScript":{ "properties":[ { "runCommand":"{{ commands }}", "workingDirectory":"{{ workingDirectory }}", "timeoutSeconds":"{{ executionTimeout }}" } ] } } }

Properties

runCommand (コマンドの実行)

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

タイプ: 文字列リスト

必須: はい

タイムアウト秒数

コマンドが完了してからコマンドが完了するまでの時間(秒) 失敗と見なされます。タイムアウトになると、 Systems Manager 停止 コマンドの実行。

タイプ: 文字列

必須: いいえ

ワーキングディレクトリ

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

タイプ: 文字列

必須: いいえ

aws:softwareInventory[aws:softwareInventory]

(Schemaバージョン2.0以降)アプリケーション、ファイル、 管理インスタンスで構成できます。このプラグインは、Linux および Microsoft Windows Server オペレーティングシステム。インベントリー収集を構成する場合、 作成、 Systems Manager ステートマネージャー 関連付け。 Systems Manager は、 関連付けが実行されます。最初にアソシエーションを作成せずに、 aws:softwareInventoryプラグインを使用すると、次のエラーが返されます。

The aws:softwareInventory plugin can only be invoked via ssm-associate.

また、インスタンスは1つのインベントリの関連付けしか構成できません。 1回に 2つ以上の関連付けを持つインスタンスを構成すると、インベントリは 関連付けが実行されず、インベントリ データが収集されません。詳細については、 在庫の回収については、 AWS Systems Manager 在庫.

Syntax

スキーマ2.2

YAML
--- 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 }}"
JSON
{ "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 }}" } } ] }

Inputs

アプリケーション

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

タイプ: 文字列

必須: いいえ

awsコンポーネント

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

タイプ: 文字列

必須: いいえ

ファイル

(オプション。SSM Agentバージョン2.2.64.0以降が必要) Collect ファイルのメタデータ(ファイル名、時間ファイルを含む) 作成、ファイルの最終変更およびアクセス、ファイル いくつか例を挙げます ファイルの収集の詳細については、 在庫、を参照 ファイルとWindowsでの作業 レジストリインベントリ.

タイプ: 文字列

必須: いいえ

ネットワーク設定

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

タイプ: 文字列

必須: いいえ

windows更新

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

タイプ: 文字列

必須: いいえ

インスタンス詳細情報

(オプション) が提供するものより多くのインスタンス情報を収集します。 デフォルトインベントリプラグイン(aws:instanceInformation)、 CPUモデル、速度、コア数などが挙げられます。

タイプ: 文字列

必須: いいえ

サービス

(オプション、Windows OS のみ、SSM Agent バージョン 2.2.64.0 または 後で) サービス構成のメタデータを収集します。

タイプ: 文字列

必須: いいえ

windowsレジストリ

(オプション、Windows OS のみ、SSM Agent バージョン 2.2.64.0 または 後で)Windowsレジストリキーと値を収集します。選択できるのは すべてのキーと値を再帰的に収集します。また、 特定のレジストリキーとその値を特定のパスに対して収集します。インベントリは、キーパス、名前、タイプ、値を収集します。詳細はこちら Windowsレジストリ インベントリの収集に関する情報については、を参照してください。 ファイルとWindowsでの作業 レジストリインベントリ.

タイプ: 文字列

必須: いいえ

windowsRoles (ウィンドウロール)

(オプション、Windows OS のみ、SSM Agent バージョン 2.2.64.0 または 後で)Microsoft Windowsの役割のメタデータを収集する 構成。

タイプ: 文字列

必須: いいえ

カスタム在庫

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

タイプ: 文字列

必須: いいえ

aws:updateAgent[aws:updateAgent]

EC2Config サービスを最新バージョンに更新するか、古いバージョンを指定します。このプラグインはMicrosoft Windows Server オペレーティングシステム。詳細については、 EC2Configサービスについて、 Windowsインスタンスの構成 EC2Config サービスの使用. ドキュメントの詳細は、以下を参照してください。 AWS Systems Manager 文書.

Syntax

スキーマ2.2

YAML
--- schemaVersion: '2.2' description: aws:updateAgent mainSteps: - action: aws:updateAgent name: updateAgent inputs: agentName: Ec2Config source: https://s3.{Region}.amazonaws.com/aws-ssm-{Region}/manifest.json
JSON
{ "schemaVersion": "2.2", "description": "aws:updateAgent", "mainSteps": [ { "action": "aws:updateAgent", "name": "updateAgent", "inputs": { "agentName": "Ec2Config", "source": "https://s3.{Region}.amazonaws.com/aws-ssm-{Region}/manifest.json" } } ] }

スキーマ 1.2

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

Properties

エージェント名

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

タイプ: 文字列

必須: はい

ダウングレードを許可

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

タイプ: ブール値

必須: いいえ

ソース

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

タイプ: 文字列

必須: はい

ターゲットバージョンターゲット:バージョン

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

タイプ: 文字列

必須: いいえ

aws:updateSsmAgent[aws:updateSsmAgent]

更新 SSM エージェント を最新バージョンにするか、または古いバージョンを指定します。このプラグイン Linux上で実行し、 Windows Server オペレーティングシステム。詳細については、以下を参照してください。 との共同作業 SSM エージェント. 詳細については、以下を参照してください。 ドキュメント、参照 AWS Systems Manager 文書.

Syntax

スキーマ2.2

YAML
--- schemaVersion: '2.2' description: aws:updateSsmAgent parameters: allowDowngrade: default: 'false' description: "(Optional) Allow the Amazon SSM Agent service to be downgraded to an earlier version. If set to false, the service can be upgraded to newer versions only (default). If set to true, specify the earlier version." type: String allowedValues: - 'true' - 'false' mainSteps: - action: aws:updateSsmAgent name: updateSSMAgent inputs: agentName: amazon-ssm-agent source: https://s3.{Region}.amazonaws.com/amazon-ssm-{Region}/ssm-agent-manifest.json allowDowngrade: "{{ allowDowngrade }}"
JSON
{ "schemaVersion": "2.2", "description": "aws:updateSsmAgent", "parameters": { "allowDowngrade": { "default": "false", "description": "(Required) Allow the Amazon SSM Agent service to be downgraded to an earlier version. If set to false, the service can be upgraded to newer versions only (default). If set to true, specify the earlier version.", "type": "String", "allowedValues": [ "true", "false" ] } }, "mainSteps": [ { "action": "aws:updateSsmAgent", "name": "updateSSMAgent", "inputs": { "agentName": "amazon-ssm-agent", "source": "https://s3.{Region}.amazonaws.com/amazon-ssm-{Region}/ssm-agent-manifest.json", "allowDowngrade": "{{ allowDowngrade }}" } } ] }

スキーマ 1.2

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

Properties

エージェント名

amazon-ssm-agent。これは、 Systems Manager 販売する リクエストを処理し、インスタンス上でコマンドを実行します。

タイプ: 文字列

必須: はい

ダウングレードを許可

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

タイプ: ブール値

必須: はい

ソース

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

タイプ: 文字列

必須: はい

ターゲットバージョンターゲット:バージョン

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

タイプ: 文字列

必須: いいえ