共有入力 aws:applications aws:cloudWatch aws:configureDocker aws:configurePackage aws:domainJoin aws:downloadContent aws:psModule aws:refreshAssociation aws:runDockerAction aws:runDocument aws:runPowerShellScript aws:runShellScript aws:softwareInventory aws:updateAgent aws:updateSsmAgent

コマンドドキュメントプラグインリファレンス

このリファレンスでは、AWS Systems Manager (SSM) コマンドドキュメントで指定できるプラグインが説明されています。これらのプラグインは、オートメーションアクションを使用する SSM オートメーションランブックでは使用できません。AWS Systems Manager Automation アクションについては、「Systems Manager Automation アクションのリファレンス」を参照してください。

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

注記

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

macOS 向けの Amazon Elastic Compute Cloud (Amazon EC2) インスタンスでは、以下のドキュメントプラグインがサポートされています。

aws:refreshAssociation
aws:runShellScript
aws:runPowerShellScript
aws:softwareInventory
aws:updateSsmAgent

共有入力

あらゆるプラグインが以下の入力を使用できるのは、SSM Agent バージョン 3.0.502 以降のみです。

finallyStep

ドキュメントに実行させる最後のステップです。この入力がステップに定義されている場合、exit または onFailure 入力で指定されている onSuccess 値よりもこれが優先されます。この入力が定義されたステップを期待どおりに実行するには、このステップをドキュメントの mainSteps で定義されている最後のステップにする必要があります。

タイプ: ブール値

有効な値: true | false

必須: いいえ

onFailure

exit 値を使用するプラグインにこの入力を指定して、ステップが失敗した場合は、ステップのステータスにこの障害が反映され、finallyStep が定義されない限り、ドキュメントは残りのステップを実行しません。successAndExit 値を使用するプラグインにこの入力を値で指定して、ステップが失敗した場合は、ステップのステータスが成功になり、finallyStep が定義されない限り、ドキュメントは残りのステップを実行しません。

型: 文字列

有効な値: exit | successAndExit

必須: いいえ

onSuccess

プラグインにこの入力を指定し、ステップが正常に実行した場合、finallyStep が定義されている場合を除き、ドキュメントは残りのステップを実行しません。

型: 文字列

有効な値: exit

必須: いいえ

YAML


---
schemaVersion: '2.2'
description: Shared inputs example
parameters:
  customDocumentParameter:
    type: String
    description: Example parameter for a custom Command-type document.
mainSteps:
- action: aws:runDocument
  name: runCustomConfiguration
  inputs:
    documentType: SSMDocument
    documentPath: "yourCustomDocument"
    documentParameters: '"documentParameter":{{customDocumentParameter}}'
    onSuccess: exit
- action: aws:runDocument
  name: ifConfigurationFailure
  inputs:
    documentType: SSMDocument
    documentPath: "yourCustomRepairDocument"
    onFailure: exit
- action: aws:runDocument
  name: finalConfiguration
  inputs:
    documentType: SSMDocument
    documentPath: "yourCustomFinalDocument"
    finallyStep: true

JSON


{
   "schemaVersion": "2.2",
   "description": "Shared inputs example",
   "parameters": {
      "customDocumentParameter": {
         "type": "String",
         "description": "Example parameter for a custom Command-type document."
      }
   },
   "mainSteps":[
      {
         "action": "aws:runDocument",
         "name": "runCustomConfiguration",
         "inputs": {
            "documentType": "SSMDocument",
            "documentPath": "yourCustomDocument",
            "documentParameters": "\"documentParameter\":{{customDocumentParameter}}",
            "onSuccess": "exit"
         }
      },
      {
         "action": "aws:runDocument",
         "name": "ifConfigurationFailure",
         "inputs": {
            "documentType": "SSMDocument",
            "documentPath": "yourCustomRepairDocument",
            "onFailure": "exit"
         }
      },
      {
         "action": "aws:runDocument",
         "name":"finalConfiguration",
         "inputs": {
            "documentType": "SSMDocument",
            "documentPath": "yourCustomFinalDocument",
            "finallyStep": true
         }
      }
   ]
}

`aws:applications`

EC2 インスタンスでアプリケーションをインストール、修復、またはアンインストールします。このプラグインは、Windows Server オペレーティングシステムでのみ実行されます。

Syntax

スキーマ 2.2

スキーマ 1.2

プロパティ

アクション

取るべきアクション｡

タイプ: Enum

有効な値: Install | Repair | Uninstall

必須: はい

パラメータ

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

型: 文字列

必須: いいえ

source

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

型: 文字列

必須: はい

sourceHash

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

型: 文字列

必須: いいえ

`aws:cloudWatch`

Windows Server から Amazon CloudWatch または Amazon CloudWatch Logs にデータをエクスポートし、CloudWatch メトリクスを使用してデータをモニタリングします。このプラグインは、Windows Server オペレーティングシステムでのみ実行されます。CloudWatch と Amazon Elastic Compute Cloud (Amazon EC2)の統合設定の詳細については、「CloudWatch エージェントを使用した Amazon EC2 インスタンスとオンプレミスサーバーからのメトリクスとログの収集」を参照してください。

重要

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

統合された CloudWatch Logs へのノードログの送信 (CloudWatch エージェント)
Windows Server ノードのログ収集を CloudWatch エージェントに移行する
「Amazon CloudWatch ユーザーガイド」の「CloudWatch エージェントを使用して Amazon EC2 インスタンスとオンプレミスサーバーからメトリクスとログを収集する」。

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

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

警告
アプリケーションがポーリング中にログをトランケートまたは消去しようとすると、LogDirectoryPath で指定されたログではエントリが失われることに注意してください。たとえば、ログファイルのサイズを制限する場合は、その制限に達すると新しいログファイルを作成し、新しいファイルにデータを書き続ける必要があります。
ETW: Windows のイベントトレース (ETW) データを CloudWatch Logs に送信します｡
IIS: IIS ログデータを CloudWatch Logs に送信します。
PerformanceCounter: Windows パフォーマンスカウンターを CloudWatch に送信します｡メトリクスとして CloudWatch にアップロードするさまざまなカテゴリを選択できます。アップロードするパフォーマンスカウンタごとに、一意の ID (たとえば、「PerformanceCounter2」、「PerformanceCounter3」など) を持つ[PerformanceCounter] セクションを作成し、そのプロパティを設定します。

注記
AWS Systems Manager SSM Agent または CloudWatch プラグインが停止した場合、パフォーマンスカウンターのデータは、CloudWatch にログ記録されません。この動作は、カスタムログまたは Windows イベントログとは異なります。SSM Agent または CloudWatch プラグインを使用できる場合、カスタムログと Windows イベントログはパフォーマンスカウンタデータを保持し、CloudWatch にアップロードします。
SecurityEventLog: セキュリティイベントログデータを CloudWatch Logs に送信します。
SystemEventLog: システムイベントログデータを CloudWatch Logs に送信します。

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

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

Syntax


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

設定とプロパティ

AccessKey

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

型: 文字列

必須: いいえ

CategoryName

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

型: 文字列

必須: はい

CounterName

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

型: 文字列

必須: はい

CultureName

タイムスタンプが記録されるロケール。CultureName を空白にした場合は、Windows Server インスタンスで使用されているものと同じロケールになります。

型: 文字列

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

必須: いいえ

DimensionName

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

型: 文字列

必須: いいえ

DimensionValue

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

型: 文字列

必須: いいえ

エンコード

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

型: 文字列

有効な値: サポートされる値の一覧については、Microsoft Learn Library の「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)"」と入力します。

型: 文字列

有効な値 (送信先): 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 の場合、EC2 インスタンスにログが保存されるパス。IIS ログの場合、IIS ログが個々のサイト (たとえば、C:\\inetpub\\logs\\LogFiles\\W3SVCn) に保存されるフォルダ。IIS ログの場合、W3C ログ形式のみがサポートされます。IIS、NCSA、カスタム形式はサポートされません。

型: 文字列

必須: はい

LogGroup

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

型: 文字列

必須: はい

LogName

ログファイルの名前。

ログの名前を検索するには、イベントビューアーのナビゲーションペインで、[Applications and Services Logs] を選択します。
ログの一覧で、アップロードするログを右クリックし (例えば、[Microsoft] > [Windows] > [Backup] > [Operational] など)、[Create Custom View] を選択します。
[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-2、eu-west-1、ap-southeast-1 など)。各サービスでサポートされる AWS リージョンのリストについては、「Amazon Web Services 全般のリファレンス」の「Amazon CloudWatch Logs サービスエンドポイント」と「Systems Manager サービスエンドポイント」を参照してください。

必須：はい

SecretKey

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

型: 文字列

必須: いいえ

startType

インスタンスで CloudWatch をオンまたはオフにします。

型: 文字列

有効な値: Enabled | Disabled

必須: はい

TimestampFormat

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

型: 文字列

必須: はい

TimeZoneKind

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

型: 文字列

有効な値: Local | UTC

必須: いいえ

単位

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

型: 文字列

必須: はい

`aws:configureDocker`

(スキーマバージョン 2.0 以降) コンテナと Docker と連携するインスタンスを設定します。このプラグインは、Linux および Windows Server オペレーティングシステムでのみサポートされています｡

Syntax

スキーマ 2.2

入力

アクション

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

タイプ: Enum

有効な値: Install | Uninstall

必須：はい

`aws:configurePackage`

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

Windows Server 用の利用できる AWS パッケージには、AWSPVDriver、AWSNVMe、AwsEnaNetworkDriver、AwsVssComponents、AmazonCloudWatchAgent、CodeDeployAgent、AWSSupport-EC2Rescue. などがあります。

Linux オペレーティングシステムで使用できる AWSパッケージには、AmazonCloudWatchAgent、CodeDeployAgent、AWSSupport-EC2Rescue などがあります。

Syntax

スキーマ 2.2

入力

name

インストールまたはアンインストールする AWS パッケージの名前。使用可能なパッケージには AWSPVDriver、AwsEnaNetworkDriver、AwsVssComponents、AmazonCloudWatchAgent などがあります。

型: 文字列

必須: はい

action

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

タイプ: Enum

有効な値: Install | Uninstall

必須: はい

installationType

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

タイプ: Enum

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

必須: いいえ

additionalArguments

インストール、アンインストール、または更新スクリプトに指定する追加パラメータの JSON 文字列。各パラメータには、接頭辞 SSM_ を付ける必要があります。規則 {{ssm:parameter-name}} を使用して、追加の引数で Parameter Store パラメータを参照できます。インストール、アンインストール、または更新スクリプトで追加のパラメータを使用するには、オペレーティングシステムに適した構文を使用して、パラメータを環境変数として参照する必要があります。たとえば、PowerShell では、SSM_arg 引数を $Env:SSM_arg として参照します。定義する引数の数に制限はありませんが、追加の引数の入力には 4,096 文字の制限があります。この制限には、定義するすべてのキーと値が含まれます。

型: StringMap

必須: いいえ

バージョン

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

型: 文字列

必須: いいえ

`aws:domainJoin`

ドメインに EC2 インスタンスを結合します｡このプラグインは、Linux および Windows Server オペレーティングシステムでのみ実行されます。このプラグインは、Linux インスタンスのホスト名を EC2AMAZ-XXXXXXX の形式に変更します。EC2 インスタンスの結合の詳細については、AWS Directory Service 管理ガイドの EC2 インスタンスの AWS Managed Microsoft AD ディレクトリへの結合を参照してください。

Syntax

スキーマ 2.2

スキーマ 1.2

プロパティ

directoryId

ディレクトリの ID。

型: 文字列

必須: はい

例: "directoryId": "d-1234567890"

directoryName

ドメインの名前。

型: 文字列

必須: はい

例: "directoryName": "example.com"

directoryOU

部門単位 (OU)｡

型: 文字列

必須: いいえ

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

dnsIpAddresses

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

タイプ: StringList

必須: はい

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

例

例については、AWS Directory Service 管理ガイドの「Amazon EC2 インスタンスを AWS Managed Microsoft AD に結合する」を参照してください。

`aws:downloadContent`

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

Syntax

スキーマ 2.2

入力

sourceType

ソースをダウンロードします。Systems Manager は、スクリプトおよび SSM ドキュメントのダウンロード用に GitHub、Git、HTTP、S3、および SSMDocument のソースタイプをサポートしています。

型: 文字列

必須: はい

sourceInfo

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

型: StringMap

必須: はい

sourceType が GitHub, の場合は以下を指定します。

所有者: リポジトリ所有者。
リポジトリ: リポジトリの名前。
パス: ダウンロードするファイルまたはディレクトリのパス。
getOptions: マスター以外のブランチまたはリポジトリ内の特定のコミットからコンテンツを取得するための追加オプション。マスターブランチで最新のコミットを使用している場合は、getOptions を省略できます。2020 年 10 月 1 日以降にリポジトリが作成された場合、デフォルトのブランチの名前は master ではなく main になる場合があります。この場合、getOptions パラメータの値を指定する必要があります。

このパラメータは次の形式を使用します｡
- ブランチ: refs/heads/branch_name
  
  デフォルト: master。
  
  デフォルト以外のブランチを指定するには、次の形式を使用します。
  
  ブランチ: refs/heads/branch_name
- commitID:commitID
  
  デフォルト: head。
  
  最新ではないコミットにあるバージョンの SSM ドキュメントを使用するには、完全なコミット ID を指定します。例:
```
"getOptions": "commitID:bbc1ddb94...b76d3bEXAMPLE",
```
tokenInfo: GitHub アクセストークン情報を {{ssm-secure:secure-string-token-name}} 形式で保存する先の Systems Manager パラメータ (SecureString パラメータ)。

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


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

sourceType Git には、以下を指定する必要があります。

repository

ダウンロードするファイルまたはディレクトリへの Git リポジトリの URL です。

型: 文字列

さらに、以下のオプションのパラメータを指定できます。

getOptions

マスター以外のブランチ、またはリポジトリ内の特定のコミットからコンテンツを取得するための追加オプションです。マスターブランチで最新のコミットを使用している場合は、getOptions を省略できます。

型: 文字列

このパラメータは次の形式を使用します｡
- ブランチ: refs/heads/branch_name
  
  デフォルト: master。
  
  "branch" は、SSM ドキュメントが以外のブランチに保存されている場合にのみ必要です。master例:
```
"getOptions": "branch:refs/head/main"
```
- commitID:commitID
  
  デフォルト: head。
  
  最新ではないコミットにあるバージョンの SSM ドキュメントを使用するには、完全なコミット ID を指定します。以下に例を示します。
```
"getOptions": "commitID:bbc1ddb94...b76d3bEXAMPLE",
```
privateSSHKey

指定した repository への接続時に使用する SSH キーです。SSH キーの値に対する SecureString パラメータを参照するには、{{ssm-secure:your-secure-string-parameter}} の形式を使用できます。

型: 文字列
skipHostKeyChecking

指定した repository に接続するときの stricthOstKeyChecking オプションの値を決定します。デフォルト値は false です。

タイプ: ブール値
username

HTTP を使用して指定した repository への接続時に使用するユーザー名です。ユーザー名の値に対する SecureStringパラメータを参照するには、{{ssm-secure:your-secure-string-parameter}} の形式を使用できます。

型: 文字列
password

HTTP を使用して指定した repository への接続時に使用するパスワードです。パスワードの値に対する SecureStringパラメータを参照するには、{{ssm-secure:your-secure-string-parameter}} の形式を使用できます。

型: 文字列

sourceType HTTP には、以下を指定する必要があります。

url

ダウンロードするファイルまたはディレクトリの URL です。

型: 文字列

さらに、以下のオプションのパラメータを指定できます。

allowInsecureDownload

Secure Socket Layer (SSL) または Transport Layer Security (TLS) で暗号化されていない接続経由でダウンロードを実行できるかどうかを決定します。デフォルト値は false です。暗号化を使用せずにダウンロードを実行することは推奨されません。このようなダウンロードの実行を選択する場合は、ユーザーが関連するすべてのリスクに対する責任を負います。セキュリティは、AWS とお客様の間の共有責任です。これは、責任共有モデルと説明されます。詳細については、責任共有モデルを参照してください。

タイプ: ブール値
authMethod

指定した url への接続時の認証にユーザー名とパスワードを使用するかどうかを決定します。Basic または Digest を指定する場合は、username および password パラメータの値を入力する必要があります。Digest メソッドを使用するには、SSM Agent バージョン 3.0.1181.0 以降がインスタンスにインストールされている必要があります。Digest メソッドは、MD5 および SHA256 暗号化をサポートします。

型: 文字列

有効な値: None | Basic | Digest
username

指定した url に Basic 認証を使用して接続するときに使用するユーザー名です。ユーザー名の値に対する SecureStringパラメータを参照するには、{{ssm-secure:your-secure-string-parameter}} の形式を使用できます。

型: 文字列
password

指定した url に Basic 認証を使用して接続するときに使用するパスワードです。パスワードの値に対する SecureStringパラメータを参照するには、{{ssm-secure:your-secure-string-parameter}} の形式を使用できます。

型: 文字列

sourceType S3 では以下を指定します。

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


{
    "path": "https://s3.amazonaws.com/doc-example-bucket/powershell/helloPowershell.ps1" 
}

sourceType SSMDocument では、以下のいずれかを指定します。

名前: name:version の形式のドキュメントの名前とバージョン。バージョンは省略できます。
```
{
    "name": "Example-RunPowerShellScript:3" 
}
```
name: arn:aws:ssm:region:account_id:document/document_name の形式のドキュメントの ARN。
```
{
   "name":"arn:aws:ssm:us-east-2:3344556677:document/MySharedDoc"
}
```

destinationPath

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

型: 文字列

必須: いいえ

`aws:psModule`

Amazon EC2 インスタンスに PowerShell モジュールをインストールします。このプラグインは、Windows Server オペレーティングシステムでのみ実行されます。

Syntax

スキーマ 2.2

スキーマ 1.2

プロパティ

runCommand

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

タイプ: StringList

必須: いいえ

source

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

型: 文字列

必須: はい

sourceHash

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

型: 文字列

必須: いいえ

timeoutSeconds

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

型: 文字列

必須: いいえ

workingDirectory

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

型: 文字列

必須: いいえ

`aws:refreshAssociation`

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

Syntax

スキーマ 2.2

入力

associationIds

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

タイプ: StringList

必須: いいえ

`aws:runDockerAction`

(スキーマバージョン 2.0 以降) コンテナで Docker アクションを実行します。このプラグインは、Linux および Microsoft Windows Server オペレーティングシステムでのみ実行されます。

Syntax

スキーマ 2.2

入力

アクション

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

型: 文字列

必須: はい

コンテナ

Docker コンテナ ID｡

型: 文字列

必須: いいえ

イメージ

Docker イメージ名。

型: 文字列

必須: いいえ

cmd

コンテナコマンド｡

型: 文字列

必須: いいえ

メモリ

コンテナメモリの制限｡

型: 文字列

必須: いいえ

cpuShares

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

型: 文字列

必須: いいえ

ボリューム

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

タイプ: StringList

必須: いいえ

env

コンテナ環境変数。

型: 文字列

必須: いいえ

ユーザー

コンテナユーザー名｡

型: 文字列

必須: いいえ

publish

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

型: 文字列

必須: いいえ

`aws:runDocument`

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

Syntax

スキーマ 2.2

入力

documentType

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

型: 文字列

必須: はい

documentPath

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

型: 文字列

必須: いいえ

documentParameters

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

型: StringMap

必須: いいえ

`aws:runPowerShellScript`

PowerShell スクリプトを実行するか、またはスクリプトを実行するパスを指定します。このプラグインは、Microsoft Windows Server および Linux オペレーティングシステムでのみ実行されます。

Syntax

スキーマ 2.2

スキーマ 1.2

プロパティ

runCommand

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

タイプ: StringList

必須: はい

timeoutSeconds

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

型: 文字列

必須: いいえ

workingDirectory

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

型: 文字列

必須: いいえ

`aws:runShellScript`

Linux シェルスクリプトを実行するか、またはスクリプトを実行するパスを指定します。このプラグインは、Linux オペレーティングシステム上のみで実行されます。

Syntax

スキーマ 2.2

スキーマ 1.2

プロパティ

runCommand

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

タイプ: StringList

必須: はい

timeoutSeconds

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

型: 文字列

必須: いいえ

workingDirectory

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

型: 文字列

必須: いいえ

`aws:softwareInventory`

(スキーマバージョン 2.0 以降) マネージドインスタンスのアプリケーション、ファイル、および設定に関するメタデータを収集します。このプラグインは、Linux および Microsoft Windows Server オペレーティングシステムでのみ実行されます。インベントリ収集を設定する際は、まず AWS Systems Manager State Manager の関連付けを作成します。関連付けが実行されると、Systems Manager はインベントリデータを収集します。最初に関連付けを作成せずに、aws:softwareInventory プラグインを呼び出そうとすると、システムは次のエラーを返します。

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

インスタンスには、一度に 1 つのインベントリのみ関連付けることができます。インスタンスに 2 つ以上関連付けを設定した場合、そのインベントリの関連付けは実行されず、インベントリデータは収集されません。インベントリの収集の詳細については、「AWS Systems Manager インベントリ」を参照してください。

Syntax

スキーマ 2.2

入力

applications

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

型: 文字列

必須: いいえ

awsComponents

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

型: 文字列

必須: いいえ

ファイル

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

型: 文字列

必須: いいえ

networkConfig

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

型: 文字列

必須: いいえ

windowsUpdates

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

型: 文字列

必須: いいえ

InstanceDetailedInformation

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

型: 文字列

必須: いいえ

サービス

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

タイプ: 文字列

必須: いいえ

windowsRegistry

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

型: 文字列

必須: いいえ

windowsRoles

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

タイプ: 文字列

必須: いいえ

customInventory

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

型: 文字列

必須: いいえ

`aws:updateAgent`

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

Syntax

スキーマ 2.2

スキーマ 1.2

プロパティ

agentName

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

型: 文字列

必須: はい

allowDowngrade

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

タイプ: ブール値

必須: いいえ

source

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

型: 文字列

必須: はい

targetVersion

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

型: 文字列

必須: いいえ

`aws:updateSsmAgent`

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

Syntax

スキーマ 2.2

スキーマ 1.2

プロパティ

agentName

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

型: 文字列

必須: はい

allowDowngrade

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

タイプ: ブール値

必須: はい

ソース

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

型: 文字列

必須: はい

targetVersion

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

型: 文字列

必須: いいえ

ブラウザで JavaScript が無効になっているか、使用できません。

AWS ドキュメントを使用するには、JavaScript を有効にする必要があります。手順については、使用するブラウザのヘルプページを参照してください。

ドキュメントの表記規則

データ要素とパラメータ

SSM ドキュメントコンテンツを作成する

コマンドドキュメントプラグインリファレンス

注記

目次

共有入力

aws:applications

Syntax

スキーマ 2.2

スキーマ 1.2

プロパティ

aws:cloudWatch

重要

警告

注記

Syntax

設定とプロパティ

注記

注記

aws:configureDocker

Syntax

スキーマ 2.2

入力

aws:configurePackage

Syntax

スキーマ 2.2

入力

aws:domainJoin

Syntax

スキーマ 2.2

スキーマ 1.2

プロパティ

例

aws:downloadContent

Syntax

スキーマ 2.2

入力

注記

aws:psModule

Syntax

スキーマ 2.2

スキーマ 1.2

プロパティ

aws:refreshAssociation

Syntax

スキーマ 2.2

入力

aws:runDockerAction

Syntax

スキーマ 2.2

入力

aws:runDocument

Syntax

スキーマ 2.2

入力

aws:runPowerShellScript

Syntax

スキーマ 2.2

スキーマ 1.2

プロパティ

aws:runShellScript

Syntax

スキーマ 2.2

スキーマ 1.2

プロパティ

aws:softwareInventory

Syntax

スキーマ 2.2

入力

aws:updateAgent

Syntax

スキーマ 2.2

スキーマ 1.2

プロパティ

aws:updateSsmAgent

Syntax

スキーマ 2.2

スキーマ 1.2

プロパティ

`aws:applications`

`aws:cloudWatch`

`aws:configureDocker`

`aws:configurePackage`

`aws:domainJoin`

`aws:downloadContent`

`aws:psModule`

`aws:refreshAssociation`

`aws:runDockerAction`

`aws:runDocument`

`aws:runPowerShellScript`

`aws:runShellScript`

`aws:softwareInventory`

`aws:updateAgent`

`aws:updateSsmAgent`