Image Builder が AWS Task Orchestrator and Executor アプリケーションを使用してコンポーネントを管理する方法

run

run コマンドを使用して、1 つ以上のコンポーネントドキュメントの YAML ドキュメントスクリプトを実行します。

validate

1 つ以上のコンポーネントドキュメントの YAML ドキュメント構文を検証するために、validateコマンドを実行する。

パラメータ

--config ./config-example.json

ショートフォーム:-c ./config-example.json

設定ファイル (条件付き)。このパラメータには、このコマンドが実行しているコンポーネントの構成設定を含む JSON ファイルの場所が含まれます。設定ファイルで run コマンド設定を指定する場合、--documents パラメータは指定しないでください。入力設定の詳細については、AWSTOE run コマンドの入力を設定するを参照のこと。

有効な場所は以下のとおり:

• ローカルファイルパス (./config-example.json)

• S3 URI (s3://bucket/key)

--cw-ignore-failures

ショートフォーム:N/A

CloudWatch Logs からのロギングエラーは無視してください。

--cw-log-group

ショートフォーム:N/A

CloudWatch Logs の LogGroup の名前。

--cw-log-region

ショートフォーム:N/A

CloudWatch Logs に適用される AWS リージョン。

--cw-log-stream

ショートフォーム:N/A

console.log ファイルのストリーミング AWSTOE 先を指定する CloudWatch Logs LogStreamの名前。

--document-s3-bucket-owner

ショートフォーム:N/A

S3 URI ベースのドキュメントのバケット所有者のアカウントID。

--documents ./doc-1.yaml,./doc-n.yaml

ショートフォーム:-d ./doc-1.yaml,./doc-n

コンポーネント文書 (条件付き)。このパラメータには、実行する YAML コンポーネントドキュメントのファイルロケーションのカンマ区切りリストが含まれます。--documents パラメータを使用してrunコマンドに YAML ドキュメントを指定する場合、--config パラメータを指定してはなりません。

有効な場所は以下のとおり:

• ローカルファイルパス (/component-doc-example.yaml)。

• S3 URI (s3://bucket/key)。

• Image Builder コンポーネントビルドバージョン ARN (arn:aws:imagebuilder:us-west-2:123456789012:component/my-example-component/2021.12.02/1).

注記

リスト内の項目間にはスペースがなく、カンマのみが入ります。

--execution-id

短縮形： -i

これは現在の run コマンドの実行に適用される固有の ID です。この ID は出力ファイル名とログファイル名に含まれ、これらのファイルを一意に識別し、現在のコマンド実行にリンクします。この設定を省略すると、 は GUID AWSTOE を生成します。

--log-directory

短縮形： -l

がこのコマンド実行のすべてのログファイル AWSTOE を保存する送信先ディレクトリ。デフォルトでは、このディレクトリは親ディレクトリ TOE_<DATETIME>_<EXECUTIONID> の中にあります。ログディレクトリを指定しない場合、 は現在の作業ディレクトリ () AWSTOE を使用します.。

--log-s3-bucket-name

短縮形： -b

コンポーネントログが Amazon S3 に保存されている場合 (推奨）、 はこのパラメータで という名前の S3 バケットにコンポーネントアプリケーションログ AWSTOE をアップロードします。

--log-s3-bucket-owner

ショートフォーム:N/A

コンポーネントログが Amazon S3 に保存されている場合 (推奨）、これは がログファイルを AWSTOE 書き込むバケットの所有者アカウント ID です。

--log-s3-key-prefix

短縮形： -k

コンポーネントログが Amazon S3 に保存されている場合（推奨）、これはバケット内のログの場所を示す S3 オブジェクトキーのプレフィックスです。

--parameters name1=value1,name2=value2...

ショートフォーム:N/A

パラメータは、コンポーネントドキュメントで定義される変更可能な変数であり、呼び出し元のアプリケーションが実行時に提供できる設定を持つ。

--phases

ショートフォーム:-p

YAML コンポーネントドキュメントから実行するフェーズを指定するカンマ区切りのリスト。コンポーネントドキュメントに追加のフェーズが含まれている場合、そのフェーズは実行されません。

--state-directory

短縮形： -s

状態追跡ファイルが保存されているファイルパス。

--version

短縮形： -v

コンポーネントアプリケーションのバージョンを指定します。

オプション

--help

短縮形： -h

コンポーネント管理アプリケーションオプションを使用するためのヘルプマニュアルを表示します。

--trace

短縮形： -t

コンソールへの冗長ロギングを有効にする。

パラメータ

--document-s3-bucket-owner

ショートフォーム:N/A

S3 URI ベースのドキュメントのソースアカウント ID が提供されました。

--documents ./doc-1.yaml,./doc-n.yaml

ショートフォーム:-d ./doc-1.yaml,./doc-n

コンポーネントのドキュメント (必須)。このパラメータには、実行する YAML コンポーネントドキュメントのファイルロケーションのカンマ区切りリストが含まれます。有効な場所は以下のとおり:

• ローカルファイルパス (./component-doc-example.yaml)

• S3 URI (s3://bucket/key)

• Image Builder コンポーネントビルドバージョン ARNs (arn:aws:imagebuilder:us-west-2:123456789012:component/my-example-component/2021.12.02/1)

注記

リスト内の項目間にはスペースがなく、カンマのみが入ります。

オプション

--help

短縮形： -h

コンポーネント管理アプリケーションオプションを使用するためのヘルプマニュアルを表示します。

--trace

短縮形： -t

コンソールへの冗長ロギングを有効にする。