オートメーションドキュメントの使用 - AWS Systems Manager

オートメーションドキュメントの使用

Systems Manager オートメーションドキュメントは、オートメーション実行の実行時にマネージドインスタンスおよびその他の AWS リソースで Systems Manager が実行するアクションを定義します。ドキュメントには、順次実行されるステップが 1 つ以上含まれています。各ステップは、1 つのアクションを中心に構築されます。1 つのステップからの出力は、後のステップで入力として使用できます。

これらのアクションとそのステップを実行するプロセスは、オートメーションワークフローと呼ばれます。

オートメーションドキュメントでサポートされているアクションタイプを使用すると、AWS 環境でのさまざまなオペレーションを自動化できます。たとえば、executeScript アクションタイプを使用すると、Python または PowerShell スクリプトをワークフローに直接埋め込むことができます。(カスタムオートメーションドキュメントを作成するときは、スクリプトをインラインで追加するか、S3 バケットまたはローカルマシンからアタッチできます)。 createStack および deleteStack アクションタイプを使用すると、AWS CloudFormation リソースの管理を自動化できます。また、executeAwsApi アクションタイプを使用すると、ステップは AWS リソースの作成または削除、他のプロセスの開始、通知のトリガーなど、任意の AWS のサービスで任意の API オペレーションを実行できます。

オートメーションステップでサポートされている 20 種類のアクションタイプの一覧については、「Systems Manager オートメーションアクションのリファレンス」を参照してください。

AWS Systems Manager オートメーションには、1 つ以上の EC2 インスタンスの再起動や、Amazon マシンイメージ (AMI) の作成といった一般的なタスクを実行する際に使用することができる事前定義されたステップを含むいくつかのオートメーションドキュメントが用意されています。また、独自のオートメーションドキュメントを作成して他の AWS アカウントと共有したり、すべての Automation ユーザーに公開したりすることもできます。

オートメーションドキュメントは、JavaScript オブジェクト表記 (JSON) または YAML を使用して記述されています。ただし、Systems Manager オートメーションコンソールの [Document Builder (ドキュメントビルダー)] を使用すると、ネイティブの JSON または YAML で作成しなくても、オートメーションドキュメントを作成できます。

重要

AWS Identity and Access Management (IAM) サービスロールを使用して他のサービスを呼び出す自動化ワークフローを実行する場合は、それらのサービスを呼び出すためのアクセス許可をサービスロールに設定する必要がある点に注意してください。この要件は、AWS-ConfigureS3BucketLoggingAWS-CreateDynamoDBBackupAWS-RestartEC2Instance ドキュメントをはじめ、すべての AWS 自動化ドキュメント (AWS-* ドキュメント) に適用されます。この要件は、他のサービスを呼び出すアクションを使用して他の AWS のサービスを呼び出すように作成したカスタムオートメーションドキュメントにも適用されます。たとえば、aws:executeAwsApiaws:createStack、または aws:copyImage などのアクションを使用する場合は、それらのサービスを呼び出すためのアクセス許可を持つサービスロールを設定する必要があります。ロールに IAM インラインポリシーを追加することで、他の AWS のサービスへのアクセス許可を有効にできます。詳細については、「(オプション) 他の AWS サービスを呼び出すためのオートメーションインラインポリシーを追加する」を参照してください。

Systems Manager オートメーションドキュメントで指定できるアクションまたはプラグインに関する情報を表示するには、「Systems Manager オートメーションアクションのリファレンス」を参照してください。

スクリプトを実行する AWS マネージドオートメーションドキュメントの詳細については、「スクリプトを実行する Amazon マネージドオートメーションドキュメント」を参照してください。

Visual Studio Code の AWS Toolkit を使用してオートメーションドキュメントを作成する方法については、Visual Studio Code の AWS Toolkit ユーザーガイドの「との作業 Systems Manager 自動化ドキュメント」を参照してください。

ドキュメントビルダーを使用してカスタムオートメーションドキュメントを作成する方法については、「ドキュメントビルダーを使用したオートメーションドキュメントの作成」を参照してください。

スクリプトを実行するカスタムオートメーションドキュメントの作成については、次のトピックを参照してください。