AWS Elastic Beanstalk
开发人员指南
AWS 文档中描述的 AWS 服务或功能可能因区域而异。要查看适用于中国区域的差异,请参阅中国的 AWS 服务入门

操作

注意

此工具、Elastic Beanstalk API CLI 及其文档已由 AWS CLI 取代。请参阅 AWS CLI 用户指南以开始使用 AWS CLI。另请尝试 EB CLI 以获取简化的高级命令行体验。

elastic-beanstalk-check-dns-availability

描述

检查指定的别名记录是否可用。

语法

elastic-beanstalk-check-dns-availability -c [CNAMEPrefix]

选项

名称 说明 必需

-c

--cname-prefix CNAMEPrefix

要检查的别名记录的名称。

类型:字符串

默认值:无

输出

该命令会返回包含以下信息的表:

  • Available — 如果别名记录处于可用状态,则显示 true;否则,显示 false

  • FullyQualifiedCNAME — 如果处于可用状态,会显示完全限定的别名记录;否则,显示 N/A。

示例

检查别名记录的可用性

此示例介绍了如何查看前缀为“myapp23”的别名记录是否可用。

PROMPT> elastic-beanstalk-check-dns-availability -c myapp23

elastic–beanstalk–create–application

描述

创建具有一个名为 default 的配置模板但无应用程序版本的应用程序。

注意

default 配置模板适用于运行 Tomcat 6 应用程序容器的 32 位版本的 Amazon Linux 操作系统。

语法

elastic-beanstalk-create-application -a [name] -d [desc]

选项

名称 说明 必需

-a

--application-name name

应用程序名称。

约束:此名称在您的账户中必须具有唯一性。如果指定的名称已存在,此操作会返回 InvalidParameterValue 错误。

类型:字符串

默认值:无

-d

--description desc

关于应用程序的描述。

类型:字符串

默认值:无

输出

该命令会返回包含以下信息的表:

  • ApplicationName — 应用程序的名称。如果未找到具有此名称的应用程序,且 AutoCreateApplicationfalse,Elastic Beanstalk 会返回 InvalidParameterValue 错误。

  • ConfigurationTemplates — 用于创建应用程序的配置模板列表。

  • DateCreated — 应用程序的创建日期。

  • DateUpdated — 应用程序的最后更新日期。

  • Description — 关于应用程序的描述。

  • Versions — 应用程序的版本。

示例

创建应用程序

此示例介绍了如何创建应用程序。

PROMPT> elastic-beanstalk-create-application -a MySampleApp -d "My description"

elastic–beanstalk–create–application–version

描述

为指定的应用程序创建应用程序版本。

注意

在使用指定的 Amazon S3 存储桶和密钥位置创建应用程序版本后,您不能再更改该 Amazon S3 位置。如果更改了 Amazon S3 位置,当您尝试从应用程序版本中启动环境时,会收到异常信息。

语法

elastic-beanstalk-create-application-version -a [name] -l [label] -c -d [desc] -s [location]

选项

名称 说明 必需

-a

--application-name name

应用程序名称。如果未找到具有此名称的应用程序,且 AutoCreateApplicationfalse,Elastic Beanstalk 会返回 InvalidParameterValue 错误。

类型:字符串

默认值:无

长度约束:最小值为 1。最大值为 100。

-c

--auto-create

在不存在此版本的指定应用程序时,确定系统应如何运行:

  • true:自动创建此版本的指定应用程序 (如果尚不存在)。

  • false:如果尚不存在此版本的指定应用程序,则发出 InvalidParameterValue

类型:布尔值

有效值:true | false

默认值:false

-d

--description desc

关于版本的描述。

类型:字符串

默认值:无

长度约束:最小值为 0。最大值为 200。

-l

--version-label label

标识此版本的标签。

类型:字符串

默认值:无

约束:必须对每个应用程序唯一。对于指定的应用程序,如果已存在具有此标签的应用程序版本,Elastic Beanstalk 会返回 InvalidParameterValue 错误。

长度约束:最小值为 1。最大值为 100。

-s

--source-location location

Amazon S3 存储桶的名称和密钥,用于标识此版本的源包位置,格式为 bucketname/key

如果在 Amazon S3 位置查找到的数据超出了允许的最大源包大小,Elastic Beanstalk 会返回 InvalidParameterCombination 错误。

类型:字符串

默认:如果未指定,Elastic Beanstalk 会使用示例应用程序。如果仅指定了一部分(例如,提供了存储桶但未提供密钥)或如果在 Amazon S3 位置未查找到数据,Elastic Beanstalk 会返回 InvalidParameterCombination 错误。

输出

该命令会返回包含以下信息的表:

  • ApplicationName — 应用程序的名称。

  • DateCreated — 应用程序的创建日期。

  • DateUpdated — 应用程序的最后更新日期。

  • Description — 关于应用程序的描述。

  • SourceBundle — 此版本中的源包位置。

  • VersionLabel — 唯一地标识已关联应用程序版本的标签。

示例

从源位置创建版本

此示例介绍了如何从源位置创建版本。

PROMPT> elastic-beanstalk-create-application-version -a MySampleApp -d "My version" -l "TestVersion 1" -s amazonaws.com.cn/sample.war

elastic–beanstalk–create–configuration–template

描述

创建配置模板。模板与特定的应用程序相关联,用于通过相同配置设置部署不同版本的应用程序。

语法

elastic-beanstalk-create-configuration-template -a [name] -t [name] -E [id] -d [desc] -s [stack] -f [filename] -A [name] -T [name]

选项

名称 说明 必需

-a

--application-name name

要与此配置模板建立关联的应用程序名称。如果未找到具有此名称的应用程序,Elastic Beanstalk 会返回 InvalidParameterValue 错误。

类型:字符串

默认值:无

-t

--template-name name

配置模板名称。如果已存在具有此名称的配置模板,Elastic Beanstalk 会返回 InvalidParameterValue 错误。

类型:字符串

默认值:无

约束:必须对此应用程序唯一。

长度约束:最小值为 1。最大值为 100。

-E

--environment-id id

配置模板的环境 ID。

类型:字符串

默认值:无

-d

--description desc

关于配置的描述。

类型:字符串

默认值:无

-s

--solution-stack stack

此配置所用的解决方案堆栈的名称。解决方案堆栈指定了配置模板的操作系统、架构和应用程序服务器。它可确定配置选项的设置以及可能值和默认值。

使用 elastic-beanstalk-list-available-solution-stacks 获取可用的解决方案堆栈列表。

必须指定解决方案堆栈名称或源配置参数;否则,Elastic Beanstalk 会返回 InvalidParameterValue 错误。

如果未指定解决方案堆栈名称但指定了源配置参数,Elastic Beanstalk 会使用与源配置模板相同的解决方案堆栈。

类型:字符串

长度约束:最小值为 0。最大值为 100。

-f

--options-file filename

JSON 文件的名称,该文件包含一组密钥值对,用于定义配置模板的配置选项。新值会覆盖从解决方案堆栈或源配置模板中获取的值。

类型:字符串

-A

--source-application-name name

要用作此配置模板源的应用程序名称。

类型:字符串

默认值:无

-T

--source-template-name name

要用作此配置模板源的模板名称。

类型:字符串

默认值:无

输出

该命令会返回包含以下信息的表:

  • ApplicationName — 与配置集相关联的应用程序的名称。

  • DateCreated — 此配置集的创建日期(UTC 时间)。

  • DateUpdated — 此配置集的最后修改日期(UTC 时间)。

  • DeploymentStatus — 如果此配置集与某一环境相关联,则部署状态参数会指示此配置集的部署状态:

    • null:此配置未与正在运行的环境关联。

    • pending:这表示尚未部署到关联环境但正处于部署过程中的预配置。

    • deployed:这表示已部署到相关联的运行环境中的配置。

    • failed:这表示未能成功部署的预配置。

  • Description — 关于配置集的描述。

  • EnvironmentName — 如果不是 null,则应是此配置集的环境的名称。

  • OptionSettings — 此配置集中的配置选项及其值的列表。

  • SolutionStackName — 此配置集所用的解决方案堆栈的名称。

  • TemplateNamel — 如果不是 null,则应是此配置集的配置模板的名称。

示例

创建基本配置模板

此示例介绍了如何创建基本配置模板。有关配置设置列表,请参阅“配置选项”。

PROMPT> elastic-beanstalk-create-configuration-template -a MySampleApp -t myconfigtemplate -E e-eup272zdrw

elastic–beanstalk–create–environment

描述

使用指定的配置为指定应用程序启动环境。

语法

elastic-beanstalk-create-environment -a [name] -l [label] -e [name] [-t [name] | -s [stack]] -c [prefix] -d [desc] -f[filename] -F [filename]

选项

名称 说明 必需

-a

--application-name name

应用程序 (包含要部署的版本) 的名称。如果未找到具有此名称的应用程序,Elastic Beanstalk 会返回 InvalidParameterValue 错误。

类型:字符串

默认值:无

长度约束:最小值为 1。最大值为 100。

-l

--version-label >label

要部署的应用程序版本的名称。

如果指定的应用程序没有关联的应用程序版本,Elastic Beanstalk UpdateEnvironment 会返回 InvalidParameterValue 错误。

默认:如果未指定,则 Elastic Beanstalk 尝试在容器中启动示例应用程序。

类型:字符串

默认值:无

长度约束:最小值为 1。最大值为 100。

-e

--environment-name name

部署环境的唯一名称。用于应用程序 URL 中。

约束:长度必须在 4 到 23 个字符之间。名称只能包含字母、数字和连字符。开头或结尾处不能是连字符。此名称在您的账户中必须具有唯一性。如果指定的名称已存在,Elastic Beanstalk 会返回 InvalidParameterValue

类型:字符串

默认:如果未指定别名记录参数,环境变量会成为别名记录的一部分,因此它也会成为应用程序的可见 URL 的一部分。

-t

--template-name name

要在部署中使用的配置模板的名称。如果未找到具有此名称的配置模板,Elastic Beanstalk 会返回 InvalidParameterValue 错误。

条件:您必须指定此参数或指定解决方案堆栈名称,但不能同时指定这两项。如果同时指定这两项,Elastic Beanstalk 会返回 InvalidParameterValue 错误。如果两项都未指定,Elastic Beanstalk 会返回 MissingRequiredParameter

类型:字符串

默认值:无

约束:必须对此应用程序唯一。

条件

-s

--solution-stack stack

这是另一种指定配置名称的方法。如已指定,Elastic Beanstalk 会将配置值设置为与指定的解决方案堆栈相关联的默认值。

条件:您必须指定此项或指定 TemplateName,但不能同时指定这两项。如果同时指定这两项,Elastic Beanstalk 会返回 InvalidParameterCombination 错误。如果两项都未指定,Elastic Beanstalk 会返回 MissingRequiredParameter 错误。

类型:字符串

默认值:无

条件

-c

--cname-prefix prefix

如已指定,环境会尝试将此值用作别名记录的前缀。如未指定,环境将使用环境名称。

类型:字符串

默认值:无

长度约束:最小值为 4。最大值为 23。

-d

--description desc

关于环境的描述。

类型:字符串

默认值:无

-f

--options-file filename

JSON 文件的名称,该文件包含一组密钥值对,用于定义新环境的配置选项。这些会覆盖从解决方案堆栈或配置模板中获取的值。

类型:字符串

-F

--options-to-remove-file value

JSON 文件的名称,该文件包含要从新环境配置集中移除的配置选项。

类型:字符串

默认值:无

输出

该命令会返回包含以下信息的表:

  • ApplicationName — 与此环境关联的应用程序的名称。

  • CNAME — 指向此环境别名记录的 URL。

  • DateCreated — 环境的创建日期。

  • DateUpdated — 环境的最后更新日期。

  • Description — 关于环境的描述。

  • EndpointURL — 指向此环境的负载均衡器的 URL。

  • EnvironmentID — 此环境的 ID。

  • EnvironmentName — 此环境的名称。

  • Health — 描述环境的运行状况。Elastic Beanstalk 指示运行环境的失败级别:

    • Red:指示环境没有响应。在环境连续发生三次或更多次故障时,会出现此状况。

    • Yellow:指示某些地方出错。在环境连续发生两次故障时,会出现此状况。

    • Green:指示环境运行状况正常,功能完善。

    • Gray:新环境的默认运行状况。未完全启动环境,且尚未启动运行状况检查,或者在 UpdateEnvironmentRestartEnvironment 请求期间暂停了运行状况检查。

  • Resources — 此环境中使用的 AWS 资源列表。

  • SolutionStackName — 使用此环境部署的解决方案堆栈的名称。

  • Status — 环境的当前运行状态:

    • Launching:环境正处于初始部署过程中。

    • Updating:环境正处于更新配置设置或应用程序版本的过程中。

    • Ready:此时可以对环境执行操作,如更新或终止。

    • Terminating:环境正处于关闭过程中。

    • Terminated:环境未运行。

  • TemplateName — 初始启动此环境时使用的配置模板的名称。

  • VersionLabel — 部署在此环境中的应用程序版本。

示例

使用基本配置模板创建环境

此示例介绍了如何使用基本配置模板创建环境,以及如何传入用于编辑配置设置的文件和用于移除配置设置的文件。有关配置设置列表,请参阅“配置选项”。

$ elastic-beanstalk-create-environment -a MySampleApp -t myconfigtemplate -e MySampleAppEnv -f options.txt -F options_remove.txt

options.txt

[ { "Namespace": "aws:autoscaling:asg", "OptionName": "MinSize", "Value": "2" }, { "Namespace": "aws:autoscaling:asg", "OptionName": "MaxSize", "Value": "3" } ]

options_remove.txt

[ { "Namespace": "aws:elasticbeanstalk:sns:topics", "OptionName": "PARAM4" } ]

elastic-beanstalk-create-storage-location

描述

创建账户的 Amazon S3 存储位置。此位置用于存储用户日志文件,此外,AWS 管理控制台会利用此位置上传应用程序版本。您不需要为了使用 Elastic Beanstalk 而创建此存储桶。

语法

elastic-beanstalk-create-storage-location

示例

创建存储位置

此示例介绍了如何创建存储位置。

PROMPT> elastic-beanstalk-create-storage-location

此命令将输出已创建的 Amazon S3 存储桶的名称。

elastic–beanstalk–delete–application

描述

删除指定的应用程序及所有关联的版本和配置。

注意

您无法删除拥有运行环境的应用程序。

语法

elastic-beanstalk-delete-application -a [name] -f

选项

名称 说明 必需

-a

--application-name name

要删除的应用程序的名称。

类型:字符串

默认值:无

长度约束:最小值为 1。最大值为 100。

-f

--force-terminate-env

确定是否应在删除应用程序前删除所有正在运行的环境。

类型:布尔值

有效值:true | false

默认值:false

输出

该命令将返回字符串 Application deleted.

示例

删除应用程序

此示例介绍了如何删除应用程序。

PROMPT> elastic-beanstalk-delete-application -a MySampleApp

elastic–beanstalk–delete–application–version

描述

删除指定应用程序中的指定版本。

注意

您无法删除与运行环境相关联的应用程序版本。

语法

elastic-beanstalk-delete-application-version -a [name] -l [label] -d

选项

名称 说明 必需

-a

--application-name name

要删除版本的应用程序的名称。

类型:字符串

默认值:无

-l

--version-label

待删除版本的标签。

类型:字符串

默认值:无

长度约束:最小值为 1。最大值为 100。

-d

--delete-source-bundle

指示是否要从 Amazon S3 中删除关联的源包。

true:尝试删除在创建时指定的关联 Amazon S3 源包。

false:未对在创建时指定的 Amazon S3 源包执行任何操作。

类型:布尔值

有效值:true | false

默认值:false

输出

该命令将返回字符串 Application version deleted.

示例

删除应用程序版本

此示例显示了如何删除应用程序版本。

PROMPT> elastic-beanstalk-delete-application-version -a MySampleApp -l MyAppVersion

删除应用程序版本和 Amazon S3 源包

此示例显示了如何删除应用程序版本。

PROMPT> elastic-beanstalk-delete-application-version -a MySampleApp -l MyAppVersion -d

elastic–beanstalk–delete–configuration–template

描述

删除指定的配置模板。

注意

当您使用配置模板启动环境时,环境会获得该模板的一份副本。您可以删除或修改该环境的模板副本,而不会影响正在运行的环境。

语法

elastic-beanstalk-delete-configuration-template -a [name] -t [name]

选项

名称 说明 必需

-a

--application-name name

要删除配置模板的应用程序名称。

类型:字符串

默认值:无

长度约束:最小值为 1。最大值为 100。

-t

--template-name

要删除的配置模板名称。

类型:字符串

默认值:无

长度约束:最小值为 1。最大值为 100。

输出

该命令将返回字符串 Configuration template deleted.

示例

删除配置模板

此示例显示了如何删除配置模板。

PROMPT> elastic-beanstalk-delete-configuration-template -a MySampleApp -t MyConfigTemplate

elastic–beanstalk–delete–environment–configuration

描述

删除与正在运行的环境相关联的预配置。

注意

更新正在运行的具有任何配置更改的环境,即可创建预配置集。进行更新时或者如果更新失败,您可以使用 elastic-beanstalk-describe-configuration-settings 获得该预配置。预配置的部署状态会指示部署正在进行中,还是已失败。预配置会一直存在,直到此操作将它删除为止。

语法

elastic-beanstalk-delete-environment-configuration -a [name] -e [name]

选项

名称 说明 必需

-a

--application-name name

与环境关联的应用程序名称。

类型:字符串

默认值:无

长度约束:最小值为 1。最大值为 100。

-e

--environment-name name

要删除预配置的环境名称。

类型:字符串

默认值:无

长度约束:最小值为 4。最大值为 23。

输出

该命令将返回字符串 Environment configuration deleted.

示例

删除配置模板

此示例显示了如何删除配置模板。

PROMPT> elastic-beanstalk-delete-environment-configuration -a MySampleApp -e MyEnvConfig

elastic–beanstalk–describe–application–versions

描述

返回现有应用程序版本的信息。

语法

elastic-beanstalk-describe-application-versions -a [name] -l [labels [,label..]]

选项

名称 说明 必需

-a

--application-name value

应用程序名称。如已指定,Elastic Beanstalk 会将返回的描述限制为只包括与指定应用程序关联的描述。

类型:字符串

默认值:无

长度约束:最小值为 1。最大值为 100。

-l

--version-label labels

版本标签的逗点分隔列表。如已指定,将返回的描述限制为只包括那些有指定版本标签的描述。

类型:字符串[]

默认值:无

输出

该命令会返回包含以下信息的表:

  • ApplicationName — 与此版本关联的应用程序的名称。

  • DateCreated — 应用程序的创建日期。

  • DateUpdated — 应用程序版本的最后更新日期。

  • Description — 关于应用程序版本的描述。

  • SourceBundle — 此版本中的源包位置。

  • VersionLabel — 唯一地标识已关联应用程序版本的标签。

示例

描述应用程序版本

此示例显示了如何描述此账户的所有应用程序版本。

PROMPT> elastic-beanstalk-describe-application-versions

描述指定应用程序的应用程序版本

此示例显示了如何描述特定应用程序的应用程序版本。

PROMPT> elastic-beanstalk-describe-application-versions -a MyApplication

描述多个应用程序版本

此示例显示了如何描述多个指定的应用程序版本。

PROMPT> elastic-beanstalk-describe-application-versions -l MyAppVersion1, MyAppVersion2

elastic–beanstalk–describe–applications

描述

返回现有应用程序的描述。

语法

elastic-beanstalk-describe-applications -a [names [,name..]]

选项

名称 说明 必需

-a

--application-names name

一个或多个应用程序的名称,用逗号隔开。如已指定,Elastic Beanstalk 会将返回的描述限制为只包括那些有指定名称的描述。

类型:字符串[]

默认值:无

输出

该命令会返回包含以下信息的表:

  • ApplicationName — 应用程序的名称。

  • ConfigurationTemplates — 用于创建应用程序的配置模板列表。

  • DateCreated — 应用程序的创建日期。

  • DateUpdated — 应用程序的最后更新日期。

  • Description — 关于应用程序的描述。

  • Versions — 此应用程序版本的名称。

示例

描述应用程序

此示例显示了如何描述此账户的所有应用程序。

PROMPT> elastic-beanstalk-describe-applications

描述特定应用程序

此示例显示了如何描述特定应用程序。

PROMPT> elastic-beanstalk-describe-applications -a MyApplication

elastic–beanstalk–describe–configuration–options

描述

描述用于特定配置模板或环境中或者指定解决方案堆栈定义的配置选项。描述包括值、选项、选项默认值以及选项值发生变化时运行环境上的必需操作标志。

语法

elastic-beanstalk-describe-configuration-options -a [name] -t [name] -e [name] -s [stack] -f [filename]

选项

名称 说明 必需

-a

--application-name name

与配置模板或环境相关联的应用程序名称。仅当您要描述与配置模板或环境相关联的配置选项时,才需要提供此名称。

类型:字符串

默认值:无

长度约束:最小值为 1。最大值为 100。

-t

--template-name name

要描述其配置选项的配置模板名称。

类型:字符串

默认值:无

长度约束:最小值为 1。最大值为 100。

-e

--environment-name name

您要为它描述配置选项的环境名称。

类型:字符串

长度约束:最小值为 4。最大值为 23。

-s

--solution-stack stack

您要为它描述配置选项的解决方案堆栈名称。

类型:字符串

默认值:无

长度约束:最小值为 0。最大值为 100。

-f

--options-file filename

包含您要描述选项的 JSON 文件名称。

类型:字符串

输出

该命令会返回包含以下信息的表:

  • Options — 配置选项列表。

  • SolutionStackName — 这些配置选项所属的 SolutionStack 名称。

示例

描述环境的配置选项

此示例显示了如何描述环境的配置选项。

PROMPT> elastic-beanstalk-describe-configuration-options -a MySampleApp -t myconfigtemplate -e MySampleAppEnv

elastic–beanstalk–describe–configuration–settings

描述

返回指定配置集的设置描述,即与运行中的环境相关联的配置模板或配置集。

描述与运行中的环境相关联的配置集设置时,有可能接收到两组设置描述。一组是已部署的配置集,另一组是处于部署过程中或未成功部署的环境的预配置。

语法

elastic-beanstalk-describe-configuration-settings -a [name] [-t [name] | -e [name]]

选项

名称 说明 必需

-a

--application-name name

环境或配置模板的应用程序名称。

类型:字符串

默认值:无

长度约束:最小值为 1。最大值为 100。

-t

--template-name name

要描述的配置模板名称。如果未找到具有此名称的配置模板,Elastic Beanstalk 会返回 InvalidParameterValue 错误。

条件:您必须指定此参数或指定环境的名称,但不能同时指定这两项。如果同时指定这两项,Elastic Beanstalk 会返回 InvalidParameterValue 错误。如果您没有为其中之一指定名称,Elastic Beanstalk 会返回 MissingRequiredParameter 错误。

类型:字符串

默认值:无

长度约束:最小值为 1。最大值为 100。

条件

-e

--environment-name name

待描述的环境名称。

类型:字符串

默认值:无

长度约束:最小值为 4。最大值为 23。

条件

输出

该命令会返回包含以下信息的表:

  • ConfigurationSettings — 配置设置列表。

示例

描述环境的配置设置

此示例显示了如何描述环境的配置选项。

PROMPT> elastic-beanstalk-describe-configuration-settings -a MySampleApp -e MySampleAppEnv

elastic–beanstalk–describe–environment–resources

描述

返回此环境的 AWS 资源。

语法

elastic-beanstalk-describe-environment-resources [-e [name] | -E [id]]

选项

名称 说明 必需

-e

--environment-name name

用于检索 AWS 资源使用数据的环境名称。

类型:字符串

默认值:无

长度约束:最小值为 4。最大值为 23。

条件

-E

--environment-id id

用于检索 AWS 资源使用数据的环境的 ID。

类型:字符串

默认值:无

条件

输出

该命令会返回包含以下信息的表:

  • AutoScalingGroups — 此环境使用的 AutoScaling 组列表。

  • EnvironmentName — 该环境的名称。

  • Instances — 此环境使用的 Amazon EC2 实例。

  • LaunchConfigurations — 此环境使用的 Auto Scaling 启动配置。

  • LoadBalancers — 此环境使用的负载均衡器。

  • Triggers — 此环境使用的 Auto Scaling 触发器。

示例

描述环境的环境资源

此示例显示了如何描述环境的环境资源。

PROMPT> elastic-beanstalk-describe-environment-resources -e MySampleAppEnv

elastic–beanstalk–describe–environments

描述

返回现有环境的描述。

语法

elastic-beanstalk-describe-environments -e [names [,name...]] -E [ids [,id...]] -a [name] -l [label] -d -D [timestamp]

选项

名称 说明 必需

-e

--environment-names names

环境名称列表。

类型:字符串[]

默认值:无

-E

--environment-ids ids

环境 ID 列表。

类型:字符串[]

默认值:无

-a

--application-name name

与应用程序相关联的描述列表。

类型:字符串

默认值:无

长度约束:最小值为 1。最大值为 100。

-l

--version-label >label

与应用程序版本相关联的描述列表。

类型:字符串

默认值:无

长度约束:最小值为 1。最大值为 100。

-d

--include-deleted

指示是否应包括已删除的环境。

true :在显示 --include-deleted-back-to 后删除的环境。

false :不包括已删除的环境。

类型:布尔值

默认值:true

-D

--include-deleted-back-to timestamp

如果将 ––include–deleted 设置为 true,那么会显示此日期之后删除的环境的列表。

类型:日期时间

默认值:无

输出

该命令会返回包含以下信息的表:

  • ApplicationName — 与此环境关联的应用程序的名称。

  • CNAME — 指向此环境别名记录的 URL。

  • DateCreated — 环境的创建日期。

  • DateUpdated — 环境的最后更新日期。

  • Description — 关于环境的描述。

  • EndpointURL — 指向此环境的负载均衡器的 URL。

  • EnvironmentID — 此环境的 ID。

  • EnvironmentName — 此环境的名称。

  • Health — 描述环境的运行状况。Elastic Beanstalk 指示运行环境的失败级别:

    • Red:指示环境没有响应。在环境连续发生三次或更多次故障时,会出现此状况。

    • Yellow:指示某些地方出错。在环境连续发生两次故障时,会出现此状况。

    • Green:指示环境运行状况正常,功能完善。

    • Gray:新环境的默认运行状况。未完全启动环境,且尚未启动运行状况检查,或者在 UpdateEnvironmentRestartEnvironment 请求期间暂停了运行状况检查。

  • Resources — 此环境中使用的 AWS 资源列表。

  • SolutionStackName — 使用此环境部署的 SolutionStack 的名称。

  • Status — 环境的当前运行状态:

    • Launching:环境正处于初始部署过程中。

    • Updating:环境正处于更新配置设置或应用程序版本的过程中。

    • Ready:此时可以对环境执行操作,如更新或终止。

    • Terminating:环境正处于关闭过程中。

    • Terminated:环境未运行。

  • TemplateName — 初始启动此环境时使用的配置模板的名称。

  • VersionLabel — 部署在此环境中的应用程序版本。

示例

描述环境

此示例显示了如何描述现有环境。

PROMPT> elastic-beanstalk-describe-environments

elastic–beanstalk–describe–events

描述

返回符合标准的事件描述,最早可追溯至 6 周前。

注意

此操作会返回从指定 NextToken 起的最近 1000 个事件。

语法

elastic-beanstalk-describe-events -a [name] -e [name] -E [id] -l [label] -L [timestamp] -m [count] -n [token] -r [id] -s [level] -S [timestamp] -t [name]

选项

名称 说明 必需

-a

--application-name name

应用程序名称。

类型:字符串

默认值:无

长度约束:最小值为 1。最大值为 100。

-e

--environment-name name

环境名称。

类型:字符串

默认值:无

长度约束:最小值为 4。最大值为 23。

-E

--environment-id id

环境 ID。

类型:字符串

默认值:无

-l

--version-label >label

应用程序版本。

类型:字符串

默认值:无

长度约束:最小值为 1。最大值为 100。

-L

--end-time timestamp

如已指定,会返回发生在指定时间之前 (但不包括该时间) 的事件列表。

类型:日期时间

默认值:无

-m

--max-records count

指定可返回事件的最大数量,从最近的事件开始。

类型:整数

默认值:无

-n

--next-token token

分页标记。用于返回下一批结果。

类型:字符串

默认值:无

-r

--request-id id

请求 ID。

类型:字符串

默认值:无

-s

--severity level

如已指定,会返回严重性为指定等级或更高等级的事件列表。

类型:字符串

有效值: TRACE | DEBUG | INFO | WARN | ERROR | FATAL

默认值:无

-S

--start-time timestamp

如已指定,会返回发生在指定时间之后的事件列表。

类型:日期时间

默认值:无

-t

--template-name name

配置模板名称。

类型:字符串

默认值:无

长度约束:最小值为 1。最大值为 100。

输出

该命令会返回包含以下信息的表:

  • ApplicationName — 与事件相关联的应用程序名称。

  • EnvironmentName — 与事件相关联的环境名称。

  • EventDate — 事件日期。

  • Message — 事件的消息。

  • RequestID — 此事件活动的 Web 服务请求 ID。

  • Severity — 事件的严重性等级。

  • TemplateName — 与此事件相关联的配置名称。

  • VersionLabel — 与此事件相关联的应用程序版本的发布标签。

示例

以环境等级描述环境事件

此示例显示了如何描述严重性等级为 WARN 或更高等级的环境事件。

PROMPT> elastic-beanstalk-describe-events -e MySampleAppEnv -s WARN

elastic–beanstalk–list–available–solution–stacks

描述

返回可用的解决方案堆栈名称列表。

语法

elastic-beanstalk-list-available-solution-stacks

输出

该命令会返回可用的解决方案堆栈名称。

示例

列出可用的解决方案堆栈

此示例显示了如何获取可用的解决方案堆栈列表。

PROMPT> elastic-beanstalk-list-available-solution-stacks

elastic–beanstalk–rebuild–environment

描述

删除并重新创建指定环境的所有 AWS 资源(例如:Auto Scaling 组、Elastic Load Balancing 等)并强制重启。

语法

elastic-beanstalk-rebuild-environment [-e [name] | -E [id]]

选项

名称 说明 必需

-e

--environment-name name

待重建环境的名称。

类型:字符串

默认值:无

长度约束:最小值为 4。最大值为 23。

条件

-E

--environment-id id

待重建环境的 ID。

类型:字符串

默认值:无

条件

输出

该命令会输出 Rebuilding environment

示例

重建环境

此示例显示了如何重建环境。

PROMPT> elastic-beanstalk-rebuild-environment -e MySampleAppEnv

elastic–beanstalk–request–environment–info

描述

发起请求,以编译已部署环境的信息的指定类型。

将 InfoType 设置为 tail,即可从环境的各 Amazon EC2 实例的应用程序服务器日志文件中编译最后几行。使用 RetrieveEnvironmentInfo 访问已编译信息。

语法

elastic-beanstalk-request-environment-info [-e [name] | -E [id]] -i [type]

选项

名称 说明 必需

-e

--environment-name name

所请求数据的环境名称。

类型:字符串

默认值:无

长度约束:最小值为 4。最大值为 23。

条件

-E

--environment-id id

所请求数据的环境的 ID。

类型:字符串

默认值:无

条件

-i

--info-type type

待请求的信息类型。

类型:字符串

有效值:tail

默认值:无

示例

请求环境信息

此示例显示了如何请求环境信息。

PROMPT> elastic-beanstalk-request-environment-info -e MySampleAppEnv -i tail

elastic–beanstalk–restart–app–server

描述

导致环境重启在各 Amazon EC2 实例上运行的应用程序容器服务器。

语法

elastic-beanstalk-restart-app-server [-e [name] | -E [id]]

选项

名称 说明 必需

-e

--environment-name name

重启服务器的环境的名称。

类型:字符串

默认值:无

长度约束:最小值为 4。最大值为 23。

条件

-E

--environment-id id

重启服务器的环境的 ID。

类型:字符串

默认值:无

条件

示例

重启应用程序服务器

此示例显示了如何重启应用程序服务器。

PROMPT> elastic-beanstalk-restart-app-server -e MySampleAppEnv

elastic–beanstalk–retrieve–environment–info

描述

RequestEnvironmentInfo 请求中检索已编译信息。

语法

elastic-beanstalk-retrieve-environment-info [-e [name] | -E [id]] -i [type]

选项

名称 说明 必需

-e

--environment-name name

数据的环境名称。如果未找到环境,Elastic Beanstalk 会返回 InvalidParameterValue 错误。

类型:字符串

默认值:无

长度约束:最小值为 4。最大值为 23。

条件

-E

--environment-id id

数据的环境 ID。

数据的环境名称。如果未找到环境,Elastic Beanstalk 会返回 InvalidParameterValue 错误。

类型:字符串

默认值:无

条件

-i

--info-type type

待检索的信息类型。

类型:字符串

有效值:tail

默认值:无

输出

该命令会返回包含以下信息的表:

  • EC2InstanceId — 此信息的 Amazon EC2 实例 ID。

  • InfoType — 已检索信息的类型。

  • Message — 已检索信息。

  • SampleTimestamp — 检索此信息时的时间戳。

示例

检索环境信息

此示例显示了如何检索环境信息。

PROMPT> elastic-beanstalk-retrieve-environment-info -e MySampleAppEnv -i tail

elastic–beanstalk–swap–environment–cnames

描述

交换两个环境的别名记录。

语法

elastic-beanstalk-swap-environment-cnames [-s [name] | -S [desc]] [-d [desc] | -D [desc]]

选项

名称 说明 必需

-s

--source-environment-name name

源环境名称。

类型:字符串

默认值:无

条件

-S

--source-environment-id id

源环境 ID。

类型:字符串

默认值:无

条件

-d

--destination-environment-name name

目标环境名称。

类型:字符串

默认值:无

条件

-D

--destination-environment-id id

目标环境 ID。

类型:字符串

默认值:无

条件

示例

交换环境别名记录

此示例显示了如何交换两个环境的别名记录。

PROMPT> elastic-beanstalk-swap-environment-cnames -s MySampleAppEnv -d MySampleAppEnv2

elastic–beanstalk–terminate–environment

描述

终止指定环境。

语法

elastic-beanstalk-terminate-environment [-e [name] | -E [id]] -t

选项

名称 说明 必需

-e

--environment-name name

待终止的环境名称。

类型:字符串

默认值:无

长度约束:最小值为 4。最大值为 23。

条件

-E

--environment-id id

待终止环境的 ID。

类型:字符串

默认值:无

条件

-t

--terminate-resources

指示是否应当在环境终止时关闭已关联的 AWS 资源:

  • true:将终止指定的环境及关联的 AWS 资源,如 Auto Scaling 组和 Elastic Load Balancing。

  • false:从环境中移除了 Elastic Beanstalk 资源管理,但 AWS 资源会继续执行操作。

类型:布尔值

有效值:true | false

默认值:True

注意

只能对早期环境指定此参数 (-t),因为只有早期环境才能在您终止环境时有正在运行的资源。

输出

该命令会返回包含以下信息的表:

  • ApplicationName — 与此环境关联的应用程序的名称。

  • CNAME — 指向此环境别名记录的 URL。

  • DateCreated — 环境的创建日期。

  • DateUpdated — 环境的最后更新日期。

  • Description — 关于环境的描述。

  • EndpointURL — 指向此环境的负载均衡器的 URL。

  • EnvironmentID — 此环境的 ID。

  • EnvironmentName — 此环境的名称。

  • Health — 描述环境的运行状况。Elastic Beanstalk 指示运行环境的失败级别:

    • Red:指示环境没有响应。在环境连续发生三次或更多次故障时,会出现此状况。

    • Yellow:指示某些地方出错。在环境连续发生两次故障时,会出现此状况。

    • Green:指示环境运行状况正常,功能完善。

    • Gray:新环境的默认运行状况。未完全启动环境,且尚未启动运行状况检查,或者在 UpdateEnvironmentRestartEnvironment 请求期间暂停了运行状况检查。

  • Resources — 此环境中使用的 AWS 资源列表。

  • SolutionStackName — 使用此环境部署的 SolutionStack 的名称。

  • Status — 环境的当前运行状态:

    • Launching:环境正处于初始部署过程中。

    • Updating:环境正处于更新配置设置或应用程序版本的过程中。

    • Ready:此时可以对环境执行操作,如更新或终止。

    • Terminating:环境正处于关闭过程中。

    • Terminated:环境未运行。

  • TemplateName — 初始启动此环境时使用的配置模板的名称。

  • VersionLabel — 部署在此环境中的应用程序版本。

示例

终止环境

此示例显示了终止环境的方法。

PROMPT> elastic-beanstalk-terminate-environment -e MySampleAppEnv

elastic–beanstalk–update–application

描述

更新指定的应用程序,使其具有指定的属性。

注意

例如,如果缺乏某项属性description,则该值保持不变。要清除这些属性,请指定空字符串。

语法

elastic-beanstalk-update-application -a [name] -d [desc]

选项

名称 说明 必需

-a

--application-name name

待更新的应用程序名称。如果未找到此类应用程序,Elastic Beanstalk 返回 InvalidParameterValue 错误。

类型:字符串

默认值:无

长度约束:最小值为 1。最大值为 100。

-d

--description desc

关于此应用程序的新描述。

类型:字符串

默认:如果未指定,Elastic Beanstalk 不会更新此描述。

长度约束:最小值为 0。最大值为 200。

输出

该命令会返回包含以下信息的表:

  • ApplicationName — 应用程序的名称。

  • ConfigurationTemplate — 与此应用程序关联的配置模板名称。

  • DateCreated — 环境的创建日期。

  • DateUpdated — 环境的最后更新日期。

  • Description — 关于环境的描述。

  • Versions — 此应用程序版本的名称。

示例

更新应用程序

此示例显示了更新应用程序的方法。

PROMPT> elastic-beanstalk-update-application -a MySampleApp -d "My new description"

elastic–beanstalk–update–application–version

描述

更新指定的应用程序版本,使其具有指定的属性。

注意

例如,如果缺乏某项属性description,则该值保持不变。要清除这些属性,请指定空字符串。

语法

elastic-beanstalk-update-application-version -a [name] -l [label] -d [desc]

选项

名称 说明 必需

-a

--application-name name

与此版本相关联的应用程序名称。如果未找到此类应用程序,Elastic Beanstalk 返回 InvalidParameterValue 错误。

类型:字符串

默认值:无

长度约束:最小值为 1。最大值为 100。

-l

--version-label

待更新的版本名称。

如在此标签上未找到应用程序版本,Elastic Beanstalk 返回 InvalidParaemterValue 错误。

类型:字符串

长度约束:最小值为 1。最大值为 100。

-d

--description

对此次发行的新描述。

类型:字符串

默认:如果未指定,Elastic Beanstalk 不会更新此描述。

长度约束:最小值为 0。最大值为 200。

输出

该命令会返回包含以下信息的表:

  • ApplicationName — 与此版本关联的应用程序的名称。

  • DateCreated — 应用程序版本的创建日期。

  • DateUpdated — 应用程序版本的最后修改日期。

  • Description — 关于此应用程序版本的描述。

  • SourceBundle — 此版本中的源包位置。

  • VersionLabel — 标识已关联应用程序版本的标签。

示例

更新应用程序版本

此示例显示了更新应用程序版本的方法。

PROMPT> elastic-beanstalk-update-application-version -a MySampleApp -d "My new version" -l "TestVersion 1"

elastic–beanstalk–update–configuration–template

描述

更新指定的配置模板,使其具有指定的属性或配置选项值。

注意

例如,如果缺乏某项属性 ApplicationName,则其值保持不变。要清除此类属性,请指定空字符串。

语法

elastic-beanstalk-update-configuration-template -a [name] -t [name] -d [desc] -f [filename] -F [filename]

选项

名称 说明 必需

-a

--application-name name

与待更新的配置模板相关联的应用程序名称。如果未找到具有此名称的应用程序,Elastic Beanstalk 会返回 InvalidParameterValue 错误。

类型:字符串

默认值:无

长度约束:最小值为 1。最大值为 100。

-t

--template-name name

要更新的配置模板名称。如果未找到具有此名称的配置模板,UpdateConfigurationTemplate 会返回 InvalidParameterValue 错误。

类型:字符串

默认值:无

长度约束:最小值为 1。最大值为 100。

-d

--description desc

关于此配置的新描述。

类型:字符串

默认值:无

长度约束:最小值为 0。最大值为 200。

-f

--options-file filename

包含选项设置的 JSON 文件的名称,可随新指定的选项值一起更新。

类型:字符串

-F

--options-to-remove-file value

包含待移除配置选项的 JSON 文件的名称。

类型:字符串

默认值:无

输出

该命令会返回包含以下信息的表:

  • ApplicationName — 与此配置集相关联的应用程序的名称。

  • DateCreated — 此配置集的创建日期(UTC 时间)。

  • DateUpdated — 此配置集的最后修改日期(UTC 时间)。

  • DeploymentStatus — 如果此配置集与某一环境相关联,则 DeploymentStatus 参数会指示此配置集的部署状态:

    • null:此配置未与正在运行的环境关联。

    • pending:这表示尚未部署到关联环境但正处于部署过程中的预配置。

    • deployed:这表示已部署到相关联的运行环境中的配置。

    • failed:这表示未能成功部署的预配置。

  • Description — 关于配置集的描述。

  • EnvironmentName — 如果不是 null,则应是此配置集的环境的名称。

  • OptionSettings — 此配置集中的配置选项及其值的列表。

  • SolutionStackName — 此配置集所用的解决方案堆栈的名称。

  • TemplateName — 如果不是 null,则是此配置集的配置模板的名称。

示例

更新配置模板

此示例显示了如何更新配置模板。有关配置设置列表,请参阅“配置选项”。

PROMPT> elastic-beanstalk-update-configuration-template -a MySampleApp -t myconfigtemplate -d "My updated configuration template" -f "options.txt"

options.txt

[ { "Namespace": "aws:elasticbeanstalk:application:environment", "OptionName": "my_custom_param_1", "Value": "firstvalue" }, { "Namespace": "aws:elasticbeanstalk:application:environment", "OptionName": "my_custom_param_2", "Value": "secondvalue" } ]

elastic–beanstalk–update–environment

描述

更新环境描述,部署新的应用程序版本,将配置设置更新为全新的配置模板,或在运行环境中更新选定的配置选项值。

不允许尝试更新该版本和配置,且 Elastic Beanstalk 会返回 InvalidParameterCombination 错误。

将配置设置更新为新模板或个人设置时,会创建一个预配置,且此环境的 DescribeConfigurationSettings 会返回两个具有不同 DeploymentStatus 值的设置描述。

语法

elastic-beanstalk-update-environment [-e [name] | -E [id]] -l [label] -t [name] -d [desc] -f [filename] -F [filename]

选项

名称 说明 必需

-e

--environment-name name

待更新的环境名称。如果不存在具有此名称的环境,Elastic Beanstalk 会返回 InvalidParameterValue 错误。

类型:字符串

默认值:无

长度约束:最小值为 4。最大值为 23。

条件

-E

--environment-id id

待更新环境的 ID。如果不存在具有此 ID 的环境,Elastic Beanstalk 会返回 InvalidParameterValue 错误。

类型:字符串

默认值:无

条件

-l

--version-label >label

如果指定了此参数,Elastic Beanstalk 会将指定的应用程序版本部署到此环境中。如果未找到该应用程序版本,Elastic Beanstalk 会返回 InvalidParameterValue 错误。

类型:字符串

默认值:无

长度约束:最小值为 1。最大值为 100。

-t

--template-name name

如果指定了此参数,Elastic Beanstalk 会将此配置模板部署到此环境中。如果未找到该配置模板,Elastic Beanstalk 会返回 InvalidParameterValue 错误。

类型:字符串

默认值:无

长度约束:最小值为 1。最大值为 100。

-d

--description desc

如果指定了此参数,Elastic Beanstalk 会更新此环境的描述。

类型:字符串

默认值:无

长度约束:最小值为 0。最大值为 200。

-f

--options-file filename

包含待更新的选项设置的文件。如已指定,Elastic Beanstalk 会更新与运行环境相关联的配置设置,并根据请求值设置指定的配置选项。

类型:字符串

默认值:无

-F

--options-to-remove-file filename

包含要删除的选项设置的文件。如已指定,Elastic Beanstalk 会从与运行环境相关联的配置设置中移除该选项设置。

类型:字符串

默认值:无

输出

该命令会返回包含以下信息的表:

  • ApplicationName — 与此环境关联的应用程序的名称。

  • CNAME — 指向此环境别名记录的 URL。

  • DateCreated — 环境的创建日期。

  • DateUpdated — 环境的最后更新日期。

  • Description — 关于环境的描述。

  • EndpointURL — 指向此环境的负载均衡器的 URL。

  • EnvironmentID — 此环境的 ID。

  • EnvironmentName — 此环境的名称。

  • Health — 描述环境的运行状况。Elastic Beanstalk 指示运行环境的失败级别:

    • Red:指示环境没有响应。在环境连续发生三次或更多次故障时,会出现此状况。

    • Yellow:指示某些地方出错。在环境连续发生两次故障时,会出现此状况。

    • Green:指示环境运行状况正常,功能完善。

    • Gray:新环境的默认运行状况。未完全启动环境,且尚未启动运行状况检查,或者在 UpdateEnvironmentRestartEnvironment 请求期间暂停了运行状况检查。

  • Resources — 此环境中使用的 AWS 资源列表。

  • SolutionStackName — 使用此环境部署的 SolutionStack 的名称。

  • Status — 环境的当前运行状态:

    • Launching:环境正处于初始部署过程中。

    • Updating:环境正处于更新配置设置或应用程序版本的过程中。

    • Ready:此时可以对环境执行操作,如更新或终止。

    • Terminating:环境正处于关闭过程中。

    • Terminated:环境未运行。

  • TemplateName — 初始启动此环境时使用的配置模板的名称。

  • VersionLabel — 部署在此环境中的应用程序版本。

示例

更新现有环境

此示例显示了更新现有环境的方法。它传入名为 options.txt 的文件,该文件将实例大小更新为 t1.micro,并设置两个环境变量。有关可能的配置设置列表,请参阅 配置选项

PROMPT> elastic-beanstalk-update-environment -e MySampleAppEnv -f "options.txt"

options.txt

[ { "Namespace": "aws:autoscaling:launchconfiguration", "OptionName": "InstanceType", "Value": "t1.micro" }, { "Namespace": "aws:elasticbeanstalk:application:environment", "OptionName": "my_custom_param_1", "Value": "firstvalue" }, { "Namespace": "aws:elasticbeanstalk:application:environment", "OptionName": "my_custom_param_2", "Value": "secondvalue" } ]

elastic–beanstalk–validate–configuration–settings

描述

取一组配置设置和一个配置模板或环境,并确定那些值是否有效。

此操作会返回一个消息列表,指出与所选的选项值相关联的所有错误或警告。

语法

elastic-beanstalk-validate-configuration-settings -a [name] -t [name] -e [name] -f [filename]

选项

名称 说明 必需

-a

--application-name name

配置模板或环境所属的应用程序名称。

类型:字符串

默认值:无

长度约束:最小值为 1。最大值为 100。

-t

--template-name name

用于验证设置的配置模板名称。

条件:不能同时指定配置模板名称和环境名称。

类型:字符串

默认值:无

长度约束:最小值为 1。最大值为 100。

-e

--environment-name name

用于验证设置的环境名称。

类型:字符串

默认值:无

长度约束:最小值为 4。最大值为 23。

-f

--options-file >filename

包含选项和待评估指定值列表的 JSON 文件的名称。

类型:字符串

输出

该命令会返回包含以下信息的表:

  • Message — 描述错误或警告的消息。

  • Namespace

  • OptionName

  • Severity — 指示此消息的严重性:

    • error:此消息表明这不是有效的选项设置。

    • warning:此消息提供的是您应予以考虑的信息。

示例

验证针对环境的配置设置

此示例显示了如何验证针对环境的配置集。

PROMPT> elastic-beanstalk-validate-configuration-settings -a MySampleApp -e MySampleAppEnv -f MyOptionSettingsFile.json