awstoe run command - EC2 Image Builder
Amazon Web Services 文档中描述的 Amazon Web Services 服务或功能可能因区域而异。要查看适用于中国区域的差异,请参阅 中国的 Amazon Web Services 服务入门 (PDF)

本文属于机器翻译版本。若本译文内容与英语原文存在差异,则一律以英文原文为准。

awstoe run command

该命令按 --config 参数指定的配置文件或 --documents 参数指定的组件文档列表中 YAML 组件文档脚本的内置顺序运行 YAML 组件文档脚本。

注意

您必须准确指定下列参数之一,切勿同时指定两个参数:

config

 文档

语法

awstoe run [--config <file path>] [--cw-ignore-failures <?>] [--cw-log-group <?>] [--cw-log-region us-west-2] [--cw-log-stream <?>] [--document-s3-bucket-owner <owner>] [--documents <file path,file path,...>] [--execution-id <?>] [--log-directory <file path>] [--log-s3-bucket-name <name>] [--log-s3-bucket-owner <owner>] [--log-s3-key-prefix <?>] [--parameters name1=value1,name2=value2...] [--phases <phase name>] [--state-directory <directory path>] [--version <?>] [--help] [--trace]

参数和选项

参数
config./config-example.json

简写形式:-c ./config-example.json

配置文件(条件性)。此参数包含 JSON 文件的文件位置,该文件包含此命令正在运行的组件的配置设置。如果在配置文件中指定 run 命令设置,则不得指定 --documents 参数。有关此配置的更多信息,请参阅配置 EC2 TOE 运行命令的输入

有效操作包括:

  • 本地文件路径 (./config-example.json)

  • 一个 S3; URI。(s3://bucket/key)

--cw-ignore-failures

简写形式:不适用

忽略日志中的 CloudWatch 日志失败。

--cw-log-group

简写形式:不适用

CloudWatch 日志的LogGroup名称。

--cw-log-region

简写形式:不适用

适用于 CloudWatch 日志的 Amazon 区域。

--cw-log-stream

简写形式:不适用

CloudWatch 日志的LogStream名称,用于指示将console.log文件传输到 EC2 TOE 何处。

--document-s3-bucket-owner

简写形式:不适用

基于 S3 URI 的文档的存储桶拥有者账户 ID。

 文档./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/ /2021.12.02/1)。my-example-component

注意

列表中的项目之间没有空格,只有逗号。

--execution-id

简写形式:-i

这是适用于执行当前 run 命令的唯一 ID。此 ID 包含在输出和日志文件名中,用于唯一标识这些文件,并将它们链接到当前的命令执行。如果省略此设置,则 EC2 TOE 生成 GUID。

日志目录

简写形式:-l

EC2 TOE 存储此命令执行的所有日志文件的目标目录。默认情况下,该文件位于以下目录中:TOE_<DATETIME>_<EXECUTIONID>。如果未指定日志目录,则 EC2 TOE 使用当前工作目录 (.)。

--log-s3-bucket-name

简写形式:-b

如果组件日志存储在 Amazon S3 中(推荐),则将组件应用程序日志 EC2 TOE 上传到此参数中命名的 S3 存储桶。

--log-s3-bucket-owner

简写形式:不适用

如果组件日志存储在 Amazon S3 中(推荐),则这是 EC2 TOE 写入日志文件的存储桶的所有者账户 ID。

--log-s3-key-prefix

简写形式:-k

如果组件日志存储在 Amazon S3 中(推荐),则这是存储桶中日志位置的 S3 对象键前缀。

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

简写形式:不适用

参数是在组建文档中定义的可变变量,其设置由调用应用程序在运行时提供。

phases

简写形式:-p

以逗号分隔的列表,它指定要从 YAML 组件文档中运行哪些阶段。如果组件文档包含其他阶段,则这些阶段将无法运行。

--state-directory

简写形式:-s

存储状态跟踪文件的文件路径。

--version

简写形式:-v

指定组件应用程序版本。

Options
--help

简写形式:-h

显示使用组件管理应用程序选项的帮助手册。

跟踪

简写形式:-t

启用对控制台的详细日志记录。