本文属于机器翻译版本。若本译文内容与英语原文存在差异,则一律以英文原文为准。
面向所有环境的常规选项
命名空间
- aws:autoscaling:asg
- aws:autoscaling:launchconfiguration
- aws:autoscaling:scheduledaction
- aws:autoscaling:trigger
- aws:autoscaling:updatepolicy:rollingupdate
- aws:ec2:instances
- aws:ec2:vpc
- aws:elasticbeanstalk:application
- aws:elasticbeanstalk:application:environment
- aws:elasticbeanstalk:cloudwatch:logs
- aws:elasticbeanstalk:cloudwatch:logs:health
- aws:elasticbeanstalk:command
- aws:elasticbeanstalk:environment
- aws:elasticbeanstalk:environment:process:default
- aws:elasticbeanstalk:environment:process:process_name
- aws:elasticbeanstalk:environment:proxy:staticfiles
- aws:elasticbeanstalk:healthreporting:system
- aws:elasticbeanstalk:hostmanager
- aws:elasticbeanstalk:managedactions
- aws:elasticbeanstalk:managedactions:platformupdate
- aws:elasticbeanstalk:monitoring
- aws:elasticbeanstalk:sns:topics
- aws:elasticbeanstalk:sqsd
- aws:elasticbeanstalk:trafficsplitting
- aws:elasticbeanstalk:xray
- aws:elb:healthcheck
- aws:elb:loadbalancer
- aws:elb:listener
- aws:elb:listener:listener_port
- aws:elb:policies
- aws:elb:policies:policy_name
- aws:elbv2:listener:default
- aws:elbv2:listener:listener_port
- aws:elbv2:listenerrule:rule_name
- aws:elbv2:loadbalancer
- aws:rds:dbinstance
aws:autoscaling:asg
配置环境的 Auto Scaling 组。有关更多信息,请参阅自动缩放您的 Elastic Beanstalk 环境实例。
名称 | 描述 | 默认 | 有效值 |
---|---|---|---|
Availability Zones |
可用区 (AZs) 是一个 AWS 区域内的不同位置,经过精心设计,可与其他区域的故障隔离开来 AZs。它们为同一地区的其他人提供低成本、低延迟 AZs 的网络连接。 AZs 为您的实例选择数量。 |
|
|
Cooldown |
冷却时间有助于防止 Amazon A EC2 uto Scaling 在之前活动的影响显现之前启动额外的扩展活动。冷却时间是一个调整活动完成后、另一个调整活动开始前的时长(秒)。 |
|
|
Custom Availability Zones |
AZs 为您的实例定义。 |
无 |
|
EnableCapacityRebalancing |
指定是否为 Auto Scaling 组中的 Spot 实例启用容量再平衡功能。有关更多信息,请参阅 Amazon A EC2 uto Scaling 用户指南中的容量重新平衡。 只有在 aws:ec2:instances 命名空间里将 |
|
|
MinSize |
您希望 Auto Scaling 组中拥有的最小实例数。 |
|
|
MaxSize |
您希望 Auto Scaling 组中拥有的最大实例数。 |
|
|
aws:autoscaling:launchconfiguration
为您的环境配置亚马逊弹性计算云 (Amazon EC2) 实例。
用于您的环境的实例是使用 Amazon EC2 启动模板或 Auto Scaling 群组启动配置资源创建的。以下选项适用于这两种资源类型。
有关更多信息,请参阅 你的 Elastic Beanstalk 环境的亚马逊 EC2 实例。您还可以在亚马逊用户指南的亚马逊 EBS 章节中参考有关亚马逊弹性区块存储 (EBS) 的更多信息。 EC2
名称 | 描述 | 默认 | 有效值 |
---|---|---|---|
DisableIMDSv1 |
设置为 设置为 根据平台操作系统,您的环境的实例默认如下所示:
有关更多信息,请参阅配置实例元数据服务。 重要此选项设置可能导致 Elastic Beanstalk 使用启动模板创建环境,或者将现有环境从启动配置更新为启动模板。这样做需要管理启动模板所需的权限。这些权限包含在我们的托管策略中。如果您使用自定义策略而不是我们的托管策略,则当您为环境启用竞价型实例时,环境创建或更新可能会失败。有关更多信息和其他注意事项,请参阅为你的 Elastic Beanstalk 环境启动模板。 |
|
|
EC2KeyName |
您可以使用 key pair 安全地登录您的 EC2 实例。 |
无 |
|
IamInstanceProfile |
实例配置文件允许 AWS Identity and Access Management (IAM) 用户和 AWS 服务访问临时安全证书以进行 AWS API 调用。指定实例配置文件的名称或其 ARN。 示例:
|
无 |
实例配置文件名称或 ARN。 |
ImageId |
通过指定自定义 AMI ID,您可以覆盖默认的 Amazon Machine Image(AMI)。 示例: |
无 |
|
InstanceType |
用于在 Elastic Beanstalk 环境中运行您的应用程序的实例类型。 重要
可用的实例类型取决于使用的可用区和区域。如果您选择子网,则包含该子网的可用区将决定可用的实例类型。 |
因账户和区域而异。 |
一种 EC2 实例类型。 因账户、区域和可用区而异。您可以获得按这些值筛选的 Amazon EC2 实例类型列表。有关更多信息,请参阅 Amazon EC2 用户指南中的可用实例类型。 |
LaunchTemplateTagPropagationEnabled |
设置为 Elastic Beanstalk 只能将标签传播到以下资源的启动模板:
之所以存在此限制,是因为 CloudFormation 仅允许在为特定资源创建模板时使用标签。有关更多信息,请参阅TagSpecification《AWS CloudFormation 用户指南》。 重要
有关启动模板的更多信息,请参阅以下内容:
有关此选项的更多信息,请参阅 标签传播到启动模板。 |
|
|
MonitoringInterval |
您希望返回 Amazon CloudWatch 指标的时间间隔(以分钟为单位)。 |
|
|
SecurityGroups |
列出 IDs 要分配给 Auto Scaling 组中 EC2 实例的 Amazon EC2 安全组,以便为实例定义防火墙规则。 您可以提供一串以逗号分隔的值,其中包含现有的 Amazon EC2 安全组 IDs 或对模板中创建的 AWS::EC2::SecurityGroup 资源的引用。 |
|
|
SSHSourceRestriction |
用于锁定 SSH 对环境的访问权限。例如,您可以锁定对 EC2 实例的 SSH 访问权限,这样只有堡垒主机才能访问私有子网中的实例。 该字符串采用以下形式:
示例:
|
无 |
|
BlockDeviceMappings |
在 Auto Scaling 组中的所有实例上挂载其他 Amazon EBS 卷或实例存储卷。 重要此选项设置可能导致 Elastic Beanstalk 使用启动模板创建环境,或者将现有环境从启动配置更新为启动模板。这样做需要管理启动模板所需的权限。这些权限包含在我们的托管策略中。如果您使用自定义策略而不是我们的托管策略,则当您为环境启用竞价型实例时,环境创建或更新可能会失败。有关更多信息和其他注意事项,请参阅为你的 Elastic Beanstalk 环境启动模板。 映射实例存储卷时,您只需将设备名称映射到卷名称。但是,我们建议在映射 Amazon EBS 卷时,另外指定以下部分或全部字段(每个字段必须用冒号分隔):
下面的示例附加三个 Amazon EBS 卷:一个空白 100GB gp2 卷和一个快照、一个具有 2000 个预配置 IOPS 的空白 20GB io1 卷以及一个实例存储卷
|
无 |
|
RootVolumeType |
用于连接到您的环境 EC2 实例的 Amazon EBS 根卷的卷类型(磁性、通用型 SSD 或预配置 IOPS 固态硬盘)。 重要此选项设置可能导致 Elastic Beanstalk 使用启动模板创建环境,或者将现有环境从启动配置更新为启动模板。这样做需要管理启动模板所需的权限。这些权限包含在我们的托管策略中。如果您使用自定义策略而不是我们的托管策略,则当您为环境启用竞价型实例时,环境创建或更新可能会失败。有关更多信息和其他注意事项,请参阅为你的 Elastic Beanstalk 环境启动模板。 |
因平台而异。 |
对于机械硬盘存储,为 对于通用型 SSD,为 对于预配置的 IOPS SSD,为 |
RootVolumeSize |
根 Amazon EBS 卷的存储容量(以完整 GB 为单位)。 如果将 例如, |
对于机械硬盘存储和通用型 SSD,因平台而异。 对于预配置的 IOPS SSD,为“无”。 |
对于通用型和预配置的 IOPS SSD,为 对于机械硬盘存储,为 |
RootVolumeIOPS |
预置 IOPS SSD 根卷或通用型 IOPS 与卷大小的最大比率为 500:1。例如,IOPS 为 3000 的卷至少必须为 6 GiB。 |
无 |
对于 io1 预置 IOPS 固态硬盘根卷,范围为 对于通用型 |
RootVolumeThroughput |
为连接到您的环境实例的 Amazon EBS 根卷预配置所需的吞吐量,即兆字节每秒 (MiB/s)。 EC2 注意此选项仅适用于 |
无 |
|
aws:autoscaling:scheduledaction
为环境的 Auto Scaling 组配置计划操作。对于每个操作,除了指定选项名称、命名空间和每个设置的值之外,还要指定 resource_name
。有关示例,请参阅 aws:autoscaling:scheduledaction 命名空间。
名称 | 描述 | 默认 | 有效值 |
---|---|---|---|
StartTime |
对于一次性操作,请选择运行操作的日期和时间。对于重复操作,请选择激活操作的时间。 |
无 |
跨所有计划的扩展操作的唯一 ISO-8601 时间戳 |
EndTime |
您希望计划的扩展操作停止重复的将来日期和时间(采用 UTC/GMT 时区)。如果未指定 EndTime,则操作将根据 示例: 计划操作结束后,Amazon A EC2 uto Scaling 不会自动恢复到之前的设置。配置第二个计划操作,以根据需要返回原始设置。 |
无 |
跨所有计划的扩展操作的唯一 ISO-8601 时间戳 |
MaxSize |
运行操作时要应用的最大实例计数。 |
无 |
|
MinSize |
运行操作时要应用的最小实例计数。 |
无 |
|
DesiredCapacity |
为 Auto Scaling 组设置初始所需容量。在应用计划的操作后,触发器将根据其设置调整所需容量。 |
无 |
|
Recurrence |
您希望计划操作发生的频率。如果不指定循环,则扩展操作仅发生一次,如 |
无 |
Cron |
Suspend |
设置为 |
|
|
aws:autoscaling:trigger
为环境的 Auto Scaling 组配置扩展触发器。
注意
此命名空间中的三个选项确定在触发器启用之前触发器指标可超出其定义的限制多长时间。这些选项具有相关性,如下所述:
BreachDuration = Period * EvaluationPeriods
这些选项的默认值(分别是 5、5 和 1)满足此等式。如果您指定不一致的值,Elastic Beanstalk 可能会修改其中某个值,以便等式仍然成立。
名称 | 描述 | 默认 | 有效值 |
---|---|---|---|
BreachDuration |
调用触发器前,指标可以超出所定义限制(如 |
|
|
LowerBreachScaleIncrement |
执行扩展活动时要移除多少 EC2 个 Amazon 实例。 |
|
|
LowerThreshold |
如果测量值低于该违例持续时间值,则会调用触发器。 |
|
|
MeasureName |
用于 Auto Scaling 触发器的指标。 注意
|
|
|
Period |
指定 Amazon CloudWatch 衡量触发器指标的频率。此值是两个连续时间段之间的分钟数。 |
|
|
EvaluationPeriods |
用于确定是否违例的连续评估期的数量。 |
|
|
Statistic |
触发器使用的统计数据,例如 |
|
|
Unit |
触发器度量单位,例如 |
|
|
UpperBreachScaleIncrement |
指定在执行扩展活动时要添加多少 EC2 个 Amazon 实例。 |
|
|
UpperThreshold |
如果测量值高于该违例持续时间值,则会调用触发器。 |
|
|
aws:autoscaling:updatepolicy:rollingupdate
为您环境的 Auto Scaling 组配置滚动更新。
名称 | 描述 | 默认 | 有效值 |
---|---|---|---|
MaxBatchSize |
滚动更新的每个批次中包含的实例数。 |
Auto Scaling 组的最小大小的三分之一(舍入到下一个最大整数) |
|
MinInstancesInService |
终止其他实例时,Auto Scaling 组中必须处于运行中的最小实例数。 |
Auto Scaling 组的最小大小,或 Auto Scaling 组的最大大小减一(取二者中的较小值)。 |
|
RollingUpdateEnabled |
如果为 将此值设置为 true 会自动启用 |
|
|
RollingUpdateType |
其中包括三种类型:基于时间的滚动更新、基于运行状况的滚动更新和不可变更新。 基于时间的滚动更新在批次 PauseTime 之间应用。基于运行状况的滚动更新会等新实例通过运行状况检查后再继续下一个批次。不可变更新将启动新 Auto Scaling 组中的一整组实例。 |
|
|
PauseTime |
Elastic Beanstalk 服务在完成一批实例更新之后到开始下一批实例更新之前要等待的时长(以秒、分钟或小时为单位)。 |
基于实例类型和容器自动计算。 |
|
Timeout |
在取消更新之前,等待一个实例批次中的所有实例通过运行状况检查的最长时间(以分钟或小时为单位)。 |
|
* ISO8601 持续时间 |
aws:ec2:instances
配置环境的实例,包括 Spot 选项。此命名空间是 aws:autoscaling:launchconfiguration 和 aws:autoscaling:asg 的补充。
有关更多信息,请参阅 自动缩放您的 Elastic Beanstalk 环境实例。
名称 | 描述 | 默认 | 有效值 |
---|---|---|---|
EnableSpot |
为您的环境启用 Spot 实例请求。如果为 重要此选项设置可能导致 Elastic Beanstalk 使用启动模板创建环境,或者将现有环境从启动配置更新为启动模板。这样做需要管理启动模板所需的权限。这些权限包含在我们的托管策略中。如果您使用自定义策略而不是我们的托管策略,则当您为环境启用竞价型实例时,环境创建或更新可能会失败。有关更多信息和其他注意事项,请参阅为你的 Elastic Beanstalk 环境启动模板。 |
|
|
InstanceTypes |
您希望环境使用的实例类型的逗号分隔列表(例如, 如果设置 当未激活 Spot 实例( 此选项的列表中的第一个实例类型等同于 InstanceType 命名空间中的 可用的实例类型取决于使用的可用区和区域。如果您选择子网,则包含该子网的可用区将决定可用的实例类型。 注意一些较旧的 AWS 账户可能会为 Elastic Beanstalk 提供不支持竞价型实例的默认实例类型(例如 t1.micro)。如果激活 Spot 实例请求,并收到不支持 Spot 的实例类型的相关错误,请务必配置支持 Spot 的实例类型。要选择 Spot 实例类型,请使用 Spot Instance Advisor 当您更新环境配置并从 |
两种实例类型的列表。 因账户和区域而异。 |
一到四十种 EC2 实例类型。我们建议至少两种。 因账户、区域和可用区而异。您可以获得按这些值筛选的 Amazon EC2 实例类型列表。有关更多信息,请参阅 Amazon EC2 用户指南中的可用实例类型。 实例类型必须均属于同一架构(
|
SpotAllocationStrategy |
指定竞价型实例分配策略,该策略决定如何从可用的竞价容量池中分配竞价型实例。 如果设置为 此选项仅在 |
|
|
SpotFleetOnDemandBase |
扩展环境时,在考虑 Spot 实例之前,Auto Scaling 组预配置的最小按需实例数。 此选项仅在 |
|
0 命名空间中 |
SpotFleetOnDemandAboveBasePercentage |
Auto Scaling 组在 此选项仅在 |
|
|
SpotMaxPrice |
您愿意为 Spot 实例支付的每单位小时的最高价(USD)。有关竞价型实例最高价格选项的建议,请参阅 Amazon EC2 用户指南中的竞价型实例定价历史记录。 此选项仅在 |
每种实例类型的按需价格。在这种情况下,该选项的值为 |
|
SupportedArchitectures |
以逗号分隔的 EC2 实例架构类型列表,供您用于您的环境。 Elastic Beanstalk 支持基于以下处理器架构的实例类型:
有关处理器架构和 Amazon EC2 实例类型的更多信息,请参阅亚马逊 EC2 实例类型。 |
无 |
注意大多数 Elastic Beanstalk 平台都不支持 32 位架构 |
aws:ec2:vpc
配置环境以在自定义 Amazon Virtual Private Cloud(Amazon VPC)中启动资源。如果您不在此命名空间中配置设置,Elastic Beanstalk 将在默认 VPC 中启动资源。
名称 | 描述 | 默认 | 有效值 |
---|---|---|---|
VPCId |
您的 Amazon VPC 的 ID。 |
无 |
|
Subnets |
Auto Scaling 组 IDs 的一个或多个子网中的一个或多个子网。如果您有多个子网,请将该值指定为单个以逗号分隔的子网字符串 IDs (例如)。 |
无 |
|
ELBSubnets |
弹性负载均衡器 IDs 的一个或多个子网的。如果您有多个子网,请将该值指定为单个以逗号分隔的子网字符串 IDs (例如)。 |
无 |
|
ELBScheme |
如果您要在 Amazon VPC 中创建一个内部负载均衡器,请指定 |
|
|
DBSubnets |
包含数据库 IDs 子网的。这仅可用于以下情况:需要将 Amazon RDS 数据库实例添加到应用程序中。如果您有多个子网,请将该值指定为单个以逗号分隔的子网字符串 IDs (例如)。 |
无 |
|
AssociatePublicIpAddress |
指定是否在您的 Amazon VPC 中启动具有公有 IP 地址的实例。具有公有 IP 地址的实例无需 NAT 设备即可与 Internet 通信。如果要在单个公有子网中包含您的负载均衡器和实例,则必须将值设置为 此选项对单实例环境没有影响,单实例环境中始终有一个带有弹性 IP 地址的 Amazon EC2 实例。该选项与负载平衡、可扩展的环境相关。 |
无 |
|
aws:elasticbeanstalk:application
为您的应用程序配置运行状况检查路径。有关更多信息,请参阅 基本运行状况报告。
名称 | 描述 | 默认 | 有效值 |
---|---|---|---|
应用程序运行状况检查 URL |
运行状况检查请求发送到的路径。如果未设置此路径,负载均衡器将尝试在端口 80 上建立一个 TCP 连接,以验证应用程序的运行状况状态。设置为以 |
无 |
有效值包括:
|
EB CLI 和 Elastic Beanstalk 控制台会对前面的选项应用建议的值。如果您需要使用配置文件来配置相同的项,则必须删除这些设置。有关更多信息,请参阅 建议值。
aws:elasticbeanstalk:application:environment
为您的应用程序配置环境属性。
名称 | 描述 | 默认 | 有效值 |
---|---|---|---|
任意环境变量名称。 |
传入密钥-值对。 |
无 |
任意环境变量值。 |
请参阅环境属性和其他软件设置了解更多信息。
aws:elasticbeanstalk:cloudwatch:logs
为应用程序配置实例日志流式传输。
名称 | 描述 | 默认 | 有效值 |
---|---|---|---|
StreamLogs |
指定是否在 CloudWatch 日志中为代理和部署日志创建组,以及是否从环境中的每个实例流式传输日志。 |
|
|
DeleteOnTerminate |
指定是否在环境终止后删除日志组。如果为 |
|
|
RetentionInDays |
日志事件在到期前保留的天数。 |
7 |
1、3、5、7、14、30、60、90、120、150、180、365、400、545、731、1827、3653 |
aws:elasticbeanstalk:cloudwatch:logs:health
为应用程序配置环境运行状况日志流式传输。
名称 | 描述 | 默认 | 有效值 |
---|---|---|---|
HealthStreamingEnabled |
对于启用了增强型运行状况报告的环境,指定是否在环境运行状况 CloudWatch 日志中创建群组并存档 Elastic Beanstalk 环境运行状况数据。有关启用增强型运行状况的信息,请参阅 aws:elasticbeanstalk:healthreporting:system。 |
|
|
DeleteOnTerminate |
指定是否在终止环境后删除日志组。如果为 |
|
|
RetentionInDays |
在存档的运行状况数据过期前要保留其的天数。 |
7 |
1、3、5、7、14、30、60、90、120、150、180、365、400、545、731、1827、3653 |
aws:elasticbeanstalk:command
为您的应用程序代码配置部署策略。有关更多信息,请参阅 部署策略和设置。
名称 | 描述 | 默认 | 有效值 |
---|---|---|---|
DeploymentPolicy |
选择应用程序版本部署的部署策略。 |
|
|
Timeout |
等待实例完成执行命令的时间(单位:秒)。 Elastic Beanstalk 内部向 |
|
|
BatchSizeType |
中指定的数字类型BatchSize。 |
|
|
BatchSize |
Auto Scaling 组中要同时执行部署的 Amazon EC2 实例的百分比或固定数量。有效值因使用的BatchSizeType设置而异。 |
|
|
IgnoreHealthCheck |
不要由于运行状况检查失败而取消部署。 |
false
|
|
aws:elasticbeanstalk:environment
配置您的环境的架构和服务角色。
名称 | 描述 | 默认 | 有效值 |
---|---|---|---|
EnvironmentType |
设置 |
|
|
ServiceRole |
一个 IAM 角色的名称,该角色供 Elastic Beanstalk 用来管理环境的资源。指定角色名称(可以选择添加自定义路径作为前缀)或其 ARN。 示例:
|
无 |
IAM 角色名称、路径/名称或 ARN |
LoadBalancerType |
用于环境的负载均衡器的类型。有关更多信息,请参阅 Elastic Beanstalk 环境的负载均衡器。 |
|
|
LoadBalancerIsShared |
指定环境的负载均衡器是专用的还是共享的。只能为 Application Load Balancer 设置此选项。环境创建后无法更改。 当为 |
|
|
aws:elasticbeanstalk:environment:process:default
配置您的环境的默认过程。
名称 | 描述 | 默认 | 有效值 |
---|---|---|---|
DeregistrationDelay |
在取消注册之前等待活动请求完成的时间(单位:秒)。 |
|
|
HealthCheckInterval |
Elastic Load Balancing 检查应用程序的亚马逊 EC2 实例运行状况的时间间隔,以秒为单位。 |
使用 Classic 或应用程序负载均衡器: 使用网络负载均衡器: |
使用 Classic 或应用程序负载均衡器: 使用网络负载均衡器: |
HealthCheckPath |
运行状况检查的 HTTP 请求发送到的路径。 |
|
可路由路径。 |
HealthCheckTimeout |
在运行状况检查期间等待响应的时间(单位:秒)。 此选项仅适用于使用应用程序负载均衡器的环境。 |
|
|
HealthyThresholdCount |
Elastic Load Balancing 更改实例运行状况状态前的连续成功请求数。 |
使用 Classic 或应用程序负载均衡器: 使用网络负载均衡器: |
|
MatcherHTTPCode |
指示实例正常的 HTTP 代码 (以逗号分隔) 的列表。 此选项仅适用于使用网络或应用程序负载均衡器的环境。 |
|
使用应用程序负载均衡器: 使用网络负载均衡器: |
Port |
进程侦听的端口。 |
|
|
Protocol |
进程使用的协议。 使用应用程序负载均衡器时,您只能将此选项设置为 使用网络负载均衡器时,您只能将此选项设置为 |
使用 Classic 或应用程序负载均衡器: 使用网络负载均衡器: |
|
StickinessEnabled |
设置为 true 可启用粘性会话。 此选项仅适用于使用应用程序负载均衡器的环境。 |
|
|
StickinessLBCookieDuration |
粘性会话 Cookie 的生存期(单位:秒) 此选项仅适用于使用应用程序负载均衡器的环境。 |
|
|
StickinessType |
设置为 此选项仅适用于使用应用程序负载均衡器的环境。 |
|
|
UnhealthyThresholdCount |
Elastic Load Balancing 更改实例运行状况状态前的连续失败请求数。 |
|
|
aws:elasticbeanstalk:environment:process:process_name
配置您的环境的其他过程。
名称 | 描述 | 默认 | 有效值 |
---|---|---|---|
DeregistrationDelay |
在取消注册之前等待活动请求完成的时间(单位:秒)。 |
|
|
HealthCheckInterval |
Elastic Load Balancing 检查您的应用程序的亚马逊 EC2 实例运行状况的时间间隔,以秒为单位。 |
使用 Classic 或应用程序负载均衡器: 使用网络负载均衡器: |
使用 Classic 或应用程序负载均衡器: 使用网络负载均衡器: |
HealthCheckPath |
运行状况检查的 HTTP 请求发送到的路径。 |
|
可路由路径。 |
HealthCheckTimeout |
在运行状况检查期间等待响应的时间(单位:秒)。 此选项仅适用于使用应用程序负载均衡器的环境。 |
|
|
HealthyThresholdCount |
Elastic Load Balancing 更改实例运行状况状态前的连续成功请求数。 |
使用 Classic 或应用程序负载均衡器: 使用网络负载均衡器: |
|
MatcherHTTPCode |
指示实例正常的 HTTP 代码(以逗号分隔)的列表。 此选项仅适用于使用网络或应用程序负载均衡器的环境。 |
|
使用应用程序负载均衡器: 使用网络负载均衡器: |
Port |
进程侦听的端口。 |
|
|
Protocol |
进程使用的协议。 使用应用程序负载均衡器时,您只能将此选项设置为 使用网络负载均衡器时,您只能将此选项设置为 |
使用 Classic 或应用程序负载均衡器: 使用网络负载均衡器: |
|
StickinessEnabled |
设置为 true 可启用粘性会话。 此选项仅适用于使用应用程序负载均衡器的环境。 |
|
|
StickinessLBCookieDuration |
粘性会话 Cookie 的生存期(单位:秒) 此选项仅适用于使用应用程序负载均衡器的环境。 |
|
|
StickinessType |
设置为 此选项仅适用于使用应用程序负载均衡器的环境。 |
|
|
UnhealthyThresholdCount |
Elastic Load Balancing 更改实例运行状况状态前的连续失败请求数。 |
|
|
aws:elasticbeanstalk:environment:proxy:staticfiles
您可以使用以下命名空间来配置代理服务器提供静态文件。当代理服务器收到对指定路径下的某个文件的请求时,它将直接提供此文件,而不是将请求路由至您的应用程序。这将减少您的应用程序必须处理的请求的数量。
在源代码中将代理服务器提供的路径映射到包含静态资产的文件夹。在此命名空间中定义的每个选项都映射不同的路径。
注意
此命名空间适用于基于 Amazon Linux 2 的平台分支。如果您的环境使用基于 Amazon Linux AMI(在 Amazon Linux 2 之前)的平台版本,请参阅特定于平台的选项以获取特定于平台的静态文件命名空间。
名称 | 值 |
---|---|
代理服务器提供文件的路径。值以 例如,指定 |
包含文件的文件夹名称。 例如,指定 |
aws:elasticbeanstalk:healthreporting:system
为您的环境配置增强型运行状况报告。
名称 | 描述 | 默认 | 有效值 |
---|---|---|---|
SystemType |
|
|
|
ConfigDocument | 一个 JSON 文档,描述要发布到的环境和实例指标 CloudWatch。 | 无 | |
EnhancedHealthAuthEnabled |
为内部 API 启用授权,Elastic Beanstalk 使用此授权将增强型运行状况信息从您的环境实例传达到 Elastic Beanstalk 服务。 有关更多信息,请参阅 增强型运行状况角色。 注意此选项仅适用于增强型运行状况报告(例如 |
|
|
HealthCheckSuccessThreshold |
降低阈值以便实例能够通过运行状况检查。 |
|
|
aws:elasticbeanstalk:hostmanager
将您的环境中的 EC2 实例配置为将轮换日志上传到 Amazon S3。
名称 | 描述 | 默认 | 有效值 |
---|---|---|---|
LogPublicationControl |
将您的应用程序的 Amazon EC2 实例的日志文件复制到与您的应用程序关联的 Amazon S3 存储桶中。 |
|
|
aws:elasticbeanstalk:managedactions
为您的环境配置托管平台更新。
名称 | 描述 | 默认 | 有效值 |
---|---|---|---|
ManagedActionsEnabled |
启用托管平台更新。 在将此项设置为 |
|
|
PreferredStartTime |
配置托管操作的维护时段 (采用 UTC 表示)。 例如, |
无 |
日期和时间
格式的日期和时间。 |
ServiceRoleForManagedUpdates |
Elastic Beanstalk 用于为您的环境执行托管平台更新的 IAM 角色的名称。 您可以使用为 |
无 |
与 或
|
aws:elasticbeanstalk:managedactions:platformupdate
为您的环境配置托管平台更新。
名称 | 描述 | 默认 | 有效值 |
---|---|---|---|
UpdateLevel |
要通过托管平台更新应用的最高级别的更新。平台已版本化。 |
无 |
|
InstanceRefreshEnabled |
启用每周实例替换。 需要将 |
false |
|
aws:elasticbeanstalk:monitoring
将您的环境配置为终止未通过运行状况检查的 EC2 实例。
名称 | 描述 | 默认 | 有效值 |
---|---|---|---|
Automatically Terminate Unhealthy Instances |
如果实例无法通过运行状况检查,请将其终止。 注意此选项仅在早期环境上受支持。它根据能够达到实例的运行状况及其他基于实例的指标确定了实例的运行状况。 Elastic Beanstalk 不提供根据应用程序运行状况自动终止实例的方法。 |
|
|
aws:elasticbeanstalk:sns:topics
为您的环境配置通知。
名称 | 描述 | 默认 | 有效值 |
---|---|---|---|
Notification Endpoint |
在该端点处,系统会通知您对应用程序产生影响的重要事件。 |
无 |
|
Notification Protocol |
用于向您的端点发送通知的协议。 |
|
|
Notification Topic ARN |
已订阅主题的 Amazon Resource Name (ARN)。 |
无 |
|
Notification Topic Name |
已订阅主题的名称。 |
无 |
aws:elasticbeanstalk:sqsd
为工作线程环境配置 Amazon SQS 队列。
名称 | 描述 | 默认 | 有效值 |
---|---|---|---|
WorkerQueueURL |
队列的 URL,工作线程环境层中的守护程序从该队列读取消息。 |
自动生成 |
如果您不指定值,则 Elastic Beanstalk 会自动创建队列。 |
HttpPath |
将 HTTP POST 消息发送到的应用程序的相对路径。 |
/ |
|
MimeType |
HTTP POST 请求中发送的消息的 MIME 类型。 |
|
自定义 MIME 类型。 |
HttpConnections |
Amazon EC2 实例中所有应用程序的最大并发连接数。 |
|
|
ConnectTimeout |
等待成功连接到应用程序的时长(单位:秒)。 |
|
|
InactivityTimeout |
在与应用程序的现有连接上等待响应的时长(单位:秒)。 消息会重新处理,直到守护程序从工作线程环境层中的应用程序收到 200 (OK) 响应或RetentionPeriod 过期。 |
|
|
VisibilityTimeout |
锁定来自 Amazon SQS 队列的入站消息以进行处理的时长(以秒为单位)。在配置的时长之后,再次使消息在队列中可见,以供任何其他守护程序读取。 |
300 |
|
ErrorVisibilityTimeout |
在处理尝试由于显式错误而失败后,Elastic Beanstalk 将消息返回到 Amazon SQS 队列之前经过的时长(以秒为单位)。 |
|
|
RetentionPeriod |
消息有效和等待主动处理的时长(单位:秒) |
|
|
MaxRetries |
Elastic Beanstalk 在将消息移动到死信队列之前,尝试向处理消息的 Web 应用程序发送消息的最大尝试次数。 |
|
|
aws:elasticbeanstalk:trafficsplitting
为您的环境配置流量拆分部署。
当您将 aws:elasticbeanstalk:command 命名空间的 DeploymentPolicy
选项设置为 TrafficSplitting
时,将应用此命名空间。有关部署策略的更多信息,请参阅部署策略和设置。
名称 | 描述 | 默认 | 有效值 |
---|---|---|---|
NewVersionPercent |
对于运行您正在部署的新应用程序版本的环境实例,Elastic Beanstalk 转移到这些实例的传入客户端流量的初始百分比。 |
|
|
EvaluationTime |
在初始正常部署之后,Elastic Beanstalk 等待的时间段(以分钟为单位),在经过该时间后,会继续将所有传入的客户端流量转移到正在部署的新应用程序版本。 |
|
|
aws:elasticbeanstalk:xray
运行 AWS X-Ray 守护程序以中继来自 X-Ray 集成应用程序的跟踪信息。
名称 | 描述 | 默认 | 有效值 |
---|---|---|---|
|
设为 |
|
|
aws:elb:healthcheck
为经典负载均衡器配置运行状况检查。
名称 | 描述 | 默认 | 有效值 |
---|---|---|---|
HealthyThreshold |
Elastic Load Balancing 更改实例运行状况状态前的连续成功请求数。 |
|
|
Interval |
Elastic Load Balancing 检查应用程序的 Amazon EC2 实例运行状况的时间间隔。 |
|
|
Timeout |
Elastic Load Balancing 在将实例视为无响应之前等待的时间(单位:秒) |
|
|
UnhealthyThreshold |
Elastic Load Balancing 更改实例运行状况状态前的连续失败请求数。 |
|
|
(已弃用) Target |
运行状况检查发送到的后端实例上的目标。请改为在 Application Healthcheck URL 命名空间中使用 |
|
目标格式为 |
aws:elb:loadbalancer
配置您环境的经典负载均衡器。
此命名空间中的多个选项已不再受支持,以支持 aws:elb:listener 命名空间中特定于侦听器的选项。使用这些不再受支持的选项,您只能在标准端口上配置两个侦听器(一个安全一个不安全)。
名称 | 描述 | 默认值 | 有效值 |
---|---|---|---|
CrossZone |
将负载均衡器配置为在所有可用区中的所有实例间 (而不是仅在每个区域中) 均匀地路由流量。 |
|
|
SecurityGroups |
将您创建的一个或多个安全组分配到负载均衡器。 |
无 |
一个或多个安全组 IDs。 |
ManagedSecurityGroup |
将现有安全组分配给环境的负载均衡器,而不是创建一个新安全组。要使用此设置,请更新此命名空间中的 为了允许流量从负载均衡器流向您的环境 EC2 实例,Elastic Beanstalk 向实例的安全组添加了一条规则,允许来自托管安全组的入站流量。 |
无 | 安全组 ID。 |
(已弃用) LoadBalancerHTTPPort |
不安全的侦听器要侦听的端口。 |
|
|
(已弃用) LoadBalancerPortProtocol |
不安全的侦听器上使用的协议。 |
|
|
(已弃用) LoadBalancerHTTPSPort |
安全的侦听器要侦听的端口。 |
|
|
(已弃用) LoadBalancerSSLPortProtocol |
安全的侦听器上使用的协议。 |
|
|
(已弃用) SSLCertificateId |
要绑定到安全的侦听器的 SSL 证书的 Amazon Resource Name (ARN)。 |
无 |
aws:elb:listener
在经典负载均衡器上配置默认侦听器(端口 80)。
名称 | 描述 | 默认值 | 有效值 |
---|---|---|---|
ListenerProtocol | 侦听器使用的协议。 | HTTP
|
|
InstancePort | 此侦听器用于与 EC2 实例通信的端口。 | 80 | 1 到 65535 |
InstanceProtocol |
此侦听器用于与 EC2 实例通信的协议。 它必须位于与 例如,如果 |
|
HTTP 或 HTTPS 当 ListenerProtocol 为 HTTP 或 HTTPS
|
PolicyNames | 应用于该侦听器的端口的策略名称的逗号分隔列表。我们建议您改用aws:elb:policies命名空间 LoadBalancerPorts 选项。 | 无 | |
ListenerEnabled | 指定是否启用该侦听器。如果指定 false ,则此侦听器不包含在负载均衡器中。 |
true |
|
aws:elb:listener:listener_port
在经典负载均衡器上配置其他侦听器。
名称 | 描述 | 默认值 | 有效值 |
---|---|---|---|
ListenerProtocol |
侦听器使用的协议。 |
HTTP
|
|
InstancePort |
此侦听器用于与 EC2 实例通信的端口。 | 与... 相同listener_port 。 |
1 到 65535 |
InstanceProtocol |
此侦听器用于与 EC2 实例通信的协议。 它必须位于与 例如,如果 |
|
HTTP 或 HTTPS 当 ListenerProtocol 为 HTTP 或 HTTPS
|
PolicyNames |
应用于该侦听器的端口的策略名称的逗号分隔列表。我们建议您改用aws:elb:policies命名空间的 LoadBalancerPorts 选项。 | 无 | |
SSLCertificateId |
要绑定到侦听器的 SSL 证书的 Amazon Resource Name (ARN)。 |
无 |
|
ListenerEnabled |
指定是否启用该侦听器。如果指定 false ,则此侦听器不包含在负载均衡器中。 |
如果设置了任何其他选项,则为 true ;否则为 false 。 |
|
aws:elb:policies
修改经典负载均衡器的默认粘性和全局负载均衡器策略。
名称 | 描述 | 默认 | 有效值 |
---|---|---|---|
ConnectionDrainingEnabled |
指定负载均衡器是否维持与已运行状况不佳或取消注册的实例之间的现有连接以完成正在进行的请求。 |
|
|
ConnectionDrainingTimeout |
在强制关闭连接之前,负载均衡器在连接耗尽过程中维持与实例之间的现有连接的最大秒数。 |
|
|
ConnectionSettingIdleTimeout |
负载均衡器等待通过连接发送或接收任何数据的时间(单位:秒)。如果此时段后未发送或接收任何数据,则负载均衡器将关闭连接。 |
|
|
LoadBalancerPorts |
应用默认策略 ( |
无 | 您可以使用 :all 指示所有侦听器端口 |
Stickiness Cookie Expiration |
每个 Cookie 的有效时间,以秒为单位。使用默认策略 ( |
|
|
Stickiness Policy |
将一个用户会话绑定到某一特定的服务器实例,以便系统将用户在此会话期间发出的所有请求都发送到同一服务器实例。使用默认策略 ( |
|
|
aws:elb:policies:policy_name
为经典负载均衡器创建其他负载均衡器策略。
名称 | 描述 | 默认 | 有效值 |
---|---|---|---|
CookieName |
应用程序生成的 Cookie 的名称,用于控制 AppCookieStickinessPolicyType 策略的会话生存期。此策略只能与 HTTP/HTTPS 侦听器关联。 |
无 | |
InstancePorts |
应用此策略的实例端口的逗号分隔列表。 |
无 | 端口列表或 :all |
LoadBalancerPorts |
应用此策略的侦听器端口的逗号分隔列表。 |
无 | 端口列表或 :all |
ProxyProtocol |
对于 |
无 |
|
PublicKey |
对后端服务器进行身份验证时要使用的 |
无 | |
PublicKeyPolicyNames |
控制后端服务器身份验证的 |
无 | |
SSLProtocols |
对 |
无 | |
SSLReferencePolicy |
符合安全最佳实践的预定义 AWS 安全策略的名称,您要为定义负载均衡器接受的密码和协议的 |
无 | |
Stickiness Cookie Expiration |
每个 Cookie 的有效时间,以秒为单位。 |
|
|
Stickiness Policy |
将一个用户会话绑定到某一特定的服务器实例,以便系统将用户在此会话期间发出的所有请求都发送到同一服务器实例。 |
|
|
aws:elbv2:listener:default
在 Application Load Balancer 或 Network Load Balancer 上配置默认侦听器(端口 80)。
此命名空间不适用于使用共享负载均衡器的环境。共享的负载均衡器没有默认侦听器。
名称 | 描述 | 默认 | 有效值 |
---|---|---|---|
DefaultProcess |
无规则匹配时将流量转发到的流程的名称。 |
|
过程名称。 |
ListenerEnabled |
设置为 |
|
|
Protocol |
要处理的流量的协议。 |
使用应用程序负载均衡器: 使用网络负载均衡器: |
使用应用程序负载均衡器: 使用网络负载均衡器: |
Rules |
应用于侦听器的规则的列表 此选项仅适用于带 Application Load Balancer 的环境。 |
无 |
逗号分隔的规则名称列表。 |
SSLCertificateArns |
要绑定到侦听器的 SSL 证书的 Amazon Resource Name (ARN)。 此选项仅适用于带 Application Load Balancer 的环境。 |
无 |
存储在 IAM 或 ACM 中的证书的 ARN。 |
SSLPolicy |
指定要应用于监听器的安全策略。 此选项仅适用于带 Application Load Balancer 的环境。 |
无 (ELB 默认值) |
负载均衡器安全策略的名称。 |
aws:elbv2:listener:listener_port
在 Application Load Balancer 或 Network Load Balancer 上配置其他侦听器。
注意
对于共享 Application Load Balancer,您只能指定 Rule
选项。其他选项不适用于共享的负载均衡器。
名称 | 描述 | 默认 | 有效值 |
---|---|---|---|
DefaultProcess |
无规则匹配时将流量转发到的流程的名称。 |
|
过程名称。 |
ListenerEnabled |
设置为 |
|
|
Protocol |
要处理的流量的协议。 |
使用应用程序负载均衡器: 使用网络负载均衡器: |
使用应用程序负载均衡器: 使用网络负载均衡器: |
Rules |
要应用于侦听器的规则的列表 此选项仅适用于带 Application Load Balancer 的环境。 如果您的环境使用共享的 Application Load Balancer,并且您没有为任何侦听器指定此选项,则 Elastic Beanstalk 自动将 |
无 |
逗号分隔的规则名称列表。 |
SSLCertificateArns |
要绑定到侦听器的 SSL 证书的 Amazon Resource Name (ARN)。 此选项仅适用于带 Application Load Balancer 的环境。 |
无 |
存储在 IAM 或 ACM 中的证书的 ARN。 |
SSLPolicy |
指定要应用于监听器的安全策略。 此选项仅适用于带 Application Load Balancer 的环境。 |
无 (ELB 默认值) |
负载均衡器安全策略的名称。 |
aws:elbv2:listenerrule:rule_name
为 Application Load Balancer 定义侦听器规则。如果请求与规则中的主机名或路径匹配,则负载均衡器将请求转发到指定的进程。要使用规则,请使用 Rules 命名空间中的 aws:elbv2:listener:
选项将其添加到侦听器中。listener_port
注意
此命名空间不适用于使用网络负载均衡器的环境。
名称 | 描述 | 默认 | 有效值 |
---|---|---|---|
HostHeaders |
要匹配的主机名列表。例如, |
专用负载均衡器:无 共享的负载均衡器:环境的 CNAME |
每个名称最多可以包含 128 个字符。模式可包含大写和小写字母、数字、连字符 (–) 以及最多三个通配符( 有关更多信息,请参阅 Application Load Balancer 用户指南中的主机条件。 |
PathPatterns |
要匹配的路径模式(例如, 此选项仅适用于使用应用程序负载均衡器的环境。 |
无 |
每个模式最多可包含 128 个字符。模式可包含大写和小写字母、数字、连字符 (–) 以及最多三个通配符( 有关更多信息,请参阅 Application Load Balancer 用户指南中的路径条件。 |
Priority |
多个规则匹配时此规则的优先顺序。较小的数字优先。任何两个规则的优先级不能相同。 利用共享的负载均衡器,Elastic Beanstalk 将规则优先级视为跨共享环境的相对优先级,并在创建过程中将其映射到绝对优先级。 |
|
|
Process |
此规则与请求匹配时要将流量转发到的流程的名称。 |
|
过程名称。 |
aws:elbv2:loadbalancer
配置 Application Load Balancer。
对于共享的负载均衡器,只有 SharedLoadBalancer
和 SecurityGroups
选项有效。
注意
此命名空间不适用于带 Network Load Balancer 的环境。
名称 | 描述 | 默认 | 有效值 |
---|---|---|---|
AccessLogsS3Bucket |
存储访问日志的 Amazon S3 存储桶。存储桶必须与环境处于同一区域并授予负载均衡器的写入访问权限。 |
无 |
存储桶名称。 |
AccessLogsS3Enabled |
启用访问日志存储。 |
|
|
AccessLogsS3Prefix |
放在访问日志名称前的前缀。默认情况下,负载均衡器会将日志上传到您指定的存储桶 AWSLogs 中名为的目录。指定前缀以将该 AWSLogs 目录放在另一个目录中。 |
无 |
|
IdleTimeout |
在关闭到客户端和实例的连接之前,等待请求完成的时间(单位:秒)。 |
无 |
|
ManagedSecurityGroup |
将现有安全组分配给环境的负载均衡器,而不是创建一个新安全组。要使用此设置,请更新此命名空间中的 为了允许流量从负载均衡器流向您的环境中的 EC2 实例,Elastic Beanstalk 会向您的实例的安全组添加一条规则,允许来自托管安全组的入站流量。 |
Elastic Beanstalks 为您的负载均衡器闯进的安全组。 |
安全组 ID。 |
SecurityGroups |
附加到负载均衡器的安全组的列表。 对于共享的负载均衡器,如果您未指定此值,则 Elastic Beanstalk 将检查其管理的现有安全组是否已连接到负载均衡器。如果没有连接到负载均衡器,Elastic Beanstalk 将创建一个安全组并将其附加到负载均衡器。当最后一个共享负载均衡器的环境终止时,Elastic Beanstalk 将删除此安全组。 负载均衡器安全组用于设置 Amazon EC2 实例安全组入口规则。 |
Elastic Beanstalks 为您的负载均衡器创建的安全组。 |
以逗号分隔的安全组列表。 IDs |
SharedLoadBalancer |
共享负载均衡器的 Amazon Resource Name (ARN)。此选项仅与 Application Load Balancer 相关。当 aws:elasticbeanstalk:environment 命名空间的 有效值的条件:
例如:
|
无 |
符合此处所述全部条件的有效负载均衡器的 ARN。 |
aws:rds:dbinstance
配置连接的 Amazon RDS 数据库实例。
名称 | 描述 | 默认 | 有效值 |
---|---|---|---|
DBAllocatedStorage |
分配的数据库存储大小 (以吉字节为单位来指定)。 |
MySQL: Oracle: sqlserver-se: sqlserver-ex: sqlserver-web: |
MySQL: Oracle: sqlserver:无法修改 |
DBDeletionPolicy |
指定在环境终止时保留、删除或创建数据库实例还是为数据库实例拍摄快照。 此选项与 警告删除数据库实例会导致数据永久丢失。 |
|
|
DBEngine |
要用于此实例的数据库引擎的名称。 |
|
|
DBEngineVersion |
数据库引擎的版本号。 |
|
|
DBInstanceClass |
数据库实例类型。 |
(对于并未在 Amazon VPC 中运行的环境,为 |
有关更多信息,请参阅 Amazon Relational Database Service 用户指南中的数据库实例类。 |
DBPassword |
数据库实例的主用户密码。 |
无 |
|
DBSnapshotIdentifier |
要用来恢复数据库的数据库快照的标识符。 |
无 |
|
DBUser |
数据库实例的主用户名称。 |
ebroot |
|
HasCoupledDatabase |
指定数据库实例是否与环境耦合。如果切换为 此选项与 注意注意:如果在解耦前一个数据库之后将此值切换回 |
|
|
MultiAZDatabase |
指定是否需要创建数据库实例的多可用区部署。有关使用 Amazon Relational Database Service (RDS) 进行多可用区部署的更多信息,请参阅 Amazon Relational Database Service 用户指南中的区域和可用区。 |
|
|