

本文為英文版的機器翻譯版本，如內容有任何歧義或不一致之處，概以英文版為準。

# 適用於所有環境的一般選項
<a name="command-options-general"></a>

**Topics**
+ [aws:autoscaling:asg](#command-options-general-autoscalingasg)
+ [aws:autoscaling:launchconfiguration](#command-options-general-autoscalinglaunchconfiguration)
+ [aws:autoscaling:scheduledaction](#command-options-general-autoscalingscheduledaction)
+ [aws:autoscaling:trigger](#command-options-general-autoscalingtrigger)
+ [aws:autoscaling:updatepolicy:rollingupdate](#command-options-general-autoscalingupdatepolicyrollingupdate)
+ [aws:ec2:instances](#command-options-general-ec2instances)
+ [aws:ec2:vpc](#command-options-general-ec2vpc)
+ [aws:elasticbeanstalk：應用程式](#command-options-general-elasticbeanstalkapplication)
+ [aws:elasticbeanstalk:application:environment](#command-options-general-elasticbeanstalkapplicationenvironment)
+ [aws：elasticbeanstalk：application：environmentsecrets](#command-options-general-elasticbeanstalk-application-environmentsecrets)
+ [aws:elasticbeanstalk:cloudwatch:logs](#command-options-general-cloudwatchlogs)
+ [aws:elasticbeanstalk:cloudwatch:logs:health](#command-options-general-cloudwatchlogs-health)
+ [aws:elasticbeanstalk:command](#command-options-general-elasticbeanstalkcommand)
+ [aws:elasticbeanstalk:environment](#command-options-general-elasticbeanstalkenvironment)
+ [aws:elasticbeanstalk:environment:process:default](#command-options-general-environmentprocess)
+ [aws:elasticbeanstalk:environment:process:process\_name](#command-options-general-environmentprocess-process)
+ [aws:elasticbeanstalk:environment:proxy:staticfiles](#command-options-general-environmentproxystaticfiles)
+ [aws:elasticbeanstalk:healthreporting:system](#command-options-general-elasticbeanstalkhealthreporting)
+ [aws:elasticbeanstalk:hostmanager](#command-options-general-elasticbeanstalkhostmanager)
+ [aws:elasticbeanstalk:managedactions](#command-options-general-elasticbeanstalkmanagedactions)
+ [aws:elasticbeanstalk:managedactions:platformupdate](#command-options-general-elasticbeanstalkmanagedactionsplatformupdate)
+ [aws:elasticbeanstalk:monitoring](#command-options-general-elasticbeanstalkmonitoring)
+ [aws:elasticbeanstalk:sns:topics](#command-options-general-elasticbeanstalksnstopics)
+ [aws:elasticbeanstalk:sqsd](#command-options-general-elasticbeanstalksqsd)
+ [aws:elasticbeanstalk:trafficsplitting](#command-options-general-elasticbeanstalktrafficsplitting)
+ [aws:elasticbeanstalk:xray](#command-options-general-elasticbeanstalkxray)
+ [aws:elb:healthcheck](#command-options-general-elbhealthcheck)
+ [aws:elb:loadbalancer](#command-options-general-elbloadbalancer)
+ [aws:elb:listener](#command-options-general-elblistener)
+ [aws:elb:listener:listener\_port](#command-options-general-elblistener-listener)
+ [aws:elb:policies](#command-options-general-elbpolicies)
+ [aws:elb:policies:policy\_name](#command-options-general-elbpolicies-custom)
+ [aws:elbv2:listener:default](#command-options-general-elbv2-listener-default)
+ [aws:elbv2:listener:listener\_port](#command-options-general-elbv2-listener)
+ [aws:elbv2:listenerrule:rule\_name](#command-options-general-elbv2-listenerrule)
+ [aws:elbv2:loadbalancer](#command-options-general-elbv2)
+ [aws:rds:dbinstance](#command-options-general-rdsdbinstance)

## aws:autoscaling:asg
<a name="command-options-general-autoscalingasg"></a>

設定您環境的 Auto Scaling 群組。如需更多詳細資訊，請參閱 [Auto Scaling 您的 Elastic Beanstalk 環境執行個體](using-features.managing.as.md)。


**命名空間：`aws:autoscaling:asg`**  

| **名稱** | **描述** | **預設** | **有效值** | 
| --- | --- | --- | --- | 
|  Availability Zones  |  可用區域 (AZs) 是 AWS 區域內的不同位置，旨在與其他 AZs 中的故障隔離。它們提供同一區域中其他可用區域的價廉、低延遲網路連線能力。為您的執行個體選擇可用區域數目。  |  `Any`  |  `Any` `Any 1` `Any 2` `Any 3`  | 
|  Cooldown  |  冷卻時間有助於在之前的活動產生影響之前，避免 Amazon EC2 Auto Scaling 啟動額外擴展活動。冷卻時間是指一個擴展活動完成後、另一個擴展活動可開始前的時間量 (以秒為單位)。  |  `360`   |  `0` 至 `10000`  | 
|  Custom Availability Zones  |  為您的執行個體定義可用區域。  |  無  |  `us-east-1a`  `us-east-1b`  `us-east-1c`  `us-east-1d`  `us-east-1e`  `eu-central-1`   | 
|  EnableCapacityRebalancing  |  指定是否為 Auto Scaling 群組中的 Spot 執行個體啟用容量重新平衡功能。如需詳細資訊，請參閱 *Amazon EC2 Auto Scaling 使用者指南*中的[容量重新平衡](https://docs.aws.amazon.com/autoscaling/ec2/userguide/capacity-rebalance.html)。 此選項只有在 `EnableSpot` 於 [`aws:ec2:instances`](#command-options-general-ec2instances) 命名空間中設定為 `true`，且 Auto Scaling 群組中至少有一個 Spot 執行個體時有用。  |  `false`  |  `true` `false`  | 
|  MinSize  |  在 Auto Scaling 群組中您想要的執行個體的最小數量。  |  `1`   |  `1` 至 `10000`  | 
|  MaxSize  |  在 Auto Scaling 群組中您想要的執行個體的最大數量。  |  `4`   |  `1` 至 `10000`  | 

## aws:autoscaling:launchconfiguration
<a name="command-options-general-autoscalinglaunchconfiguration"></a>

為您的環境設定 Amazon Elastic Compute Cloud (Amazon EC2) 執行個體。

用於您環境的執行個體是使用 Amazon EC2 啟動範本或 Auto Scaling 群組啟動組態資源建立。以下選項可與這兩種資源類型搭配使用。

如需詳細資訊，請參閱[您 Elastic Beanstalk 環境的 Amazon EC2 執行個體](using-features.managing.ec2.md)。您也可以參考《Amazon *Amazon EC2*[Amazon EBS 章節中有關 Amazon Elastic Block Store (EBS](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/AmazonEBS.html)) 的詳細資訊。


**命名空間：`aws:autoscaling:launchconfiguration`**  

| **名稱** | **描述** | **預設** | **有效值** | 
| --- | --- | --- | --- | 
|  DisableDefaultEC2SecurityGroup  |  設定為預設值 時`false`，Elastic Beanstalk 會建立預設安全群組，允許來自網際網路或負載平衡器的流量在 HTTP (80) 的標準連接埠上。它會在建立環境時將此安全群組連接到環境的 EC2 執行個體。 設定為 `true` Elastic Beanstalk 時，不會將預設安全群組指派給新環境的 EC2 執行個體。對於現有環境，Elastic Beanstalk 將從您環境的 EC2 執行個體取消指派預設 EC2 安全群組。因此，您還必須設定下列組態： [See the AWS documentation website for more details](http://docs.aws.amazon.com/zh_tw/elasticbeanstalk/latest/dg/command-options-general.html) 如果在已`DisableDefaultEC2SecurityGroup`設為`true`預設安全群組EC2KeyName的環境中為 指定值，則不會與 EC2 執行個體建立關聯。  |  `false`  |  `true` `false`  | 
|  DisableIMDSv1  |  設定為 `true`以停用執行個體中繼資料服務第 1 版 (IMDSv1) 並強制執行 IMDSv2。 設定為 `false`以啟用 IMDSv1 和 IMDSv2。 根據平台作業系統，您環境的執行個體預設如下： [See the AWS documentation website for more details](http://docs.aws.amazon.com/zh_tw/elasticbeanstalk/latest/dg/command-options-general.html) 如需詳細資訊，請參閱[設定執行個體中繼資料服務](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/configuring-instance-metadata-service.html)。  此選項設定可能會導致 Elastic Beanstalk 遷移具有啟動組態的現有環境以啟動範本。這樣做需要必要的許可才能管理啟動範本。這些許可包含在我們的 受管政策中。如果您使用自訂政策，而不是我們的受管政策，當您更新環境組態時，環境建立或更新可能會失敗。如需詳細資訊和其他考量事項，請參閱 [遷移 Elastic Beanstalk 環境以啟動範本](environments-cfg-autoscaling-launch-templates.md)。   |  `false` – 以 Windows 伺服器、Amazon Linux 2 和更早版本為基礎的平台 `true` – 以 Amazon Linux 2023 為基礎的平台  |  `true` `false`  | 
|  EC2KeyName  |  您可以使用金鑰對安全地登入 EC2 執行個體。 如果在`DisableDefaultEC2SecurityGroup`已設為預設安全群組`EC2KeyName`的環境中為 指定值`true`，則不會與 EC2 執行個體建立關聯。  如果使用 Elastic Beanstalk 主控台建立環境，您無法在[組態檔案](ebextensions.md)中設定此選項。主控台會以[建議值](command-options.md#configuration-options-recommendedvalues)覆寫此選項。   |  無  |  | 
|  IamInstanceProfile  |  執行個體描述檔可讓 AWS Identity and Access Management (IAM) 使用者 AWS 和服務存取臨時安全登入資料，以進行 AWS API 呼叫。指定執行個體設定檔的名稱或其 ARN。 範例： [See the AWS documentation website for more details](http://docs.aws.amazon.com/zh_tw/elasticbeanstalk/latest/dg/command-options-general.html)  如果使用 Elastic Beanstalk 主控台或 EB CLI 建立環境，您無法在[組態檔案](ebextensions.md)中設定此選項。主控台和 EB CLI 會以[建議值](command-options.md#configuration-options-recommendedvalues)覆寫此選項。   |  無  |  執行個體描述檔名稱或 ARN。  | 
|  ImageId  |  您可以透過指定您自己的自訂 AMI ID 來覆寫預設的 Amazon Machine Image (AMI)。 範例：`ami-1f316660`  |  無  |    | 
|   InstanceType  |  在 Elastic Beanstalk 環境中用來執行您應用程式的執行個體類型。  `InstanceType` 選項已過時。這個選項會由 [`aws:ec2:instances`](#command-options-general-ec2instances) 命名空間中更新、功能更強的 `InstanceTypes` 選項取代。您可以使用此新選項為環境指定一個或多個執行個體類型的清單。該清單上的第一個值等於這裡所述 `aws:autoscaling:launchconfiguration` 命名空間中包含的 `InstanceType` 選項。我們建議您使用新選項來指定執行個體類型。如果已指定，則新選項會優先於舊選項。如需詳細資訊，請參閱[aws:ec2:instances 命名空間](environments-cfg-autoscaling-configuration-approaches.md#environments-cfg-autoscaling-namespace.instances)。  可用的執行個體類型會依使用的可用區域和區域而定。如果您選擇一個子網路，包含該子網路的可用區域會決定可用的執行個體類型。 [See the AWS documentation website for more details](http://docs.aws.amazon.com/zh_tw/elasticbeanstalk/latest/dg/command-options-general.html)  如果使用 Elastic Beanstalk 主控台或 EB CLI 建立環境，您無法在[組態檔案](ebextensions.md)中設定此選項。主控台和 EB CLI 會以[建議值](command-options.md#configuration-options-recommendedvalues)覆寫此選項。   |  因帳戶和區域而異。  |  一種 EC2 執行個體類型。 因帳戶、區域和可用區域而異。您可以取得依據這些值篩選的 Amazon EC2 執行個體類型清單。如需詳細資訊，請參閱《*Amazon EC2 使用者指南*》中的[可用執行個體類型](https://docs.aws.amazon.com//AWSEC2/latest/UserGuide/instance-types.html#AvailableInstanceTypes)。  | 
|  LaunchTemplateTagPropagationEnabled  |  設定為 `true`，即可啟用對啟動範本傳播佈建至環境的特定資源的標籤。 Elastic Beanstalk 只能將下列資源標籤傳播到啟動範本： [See the AWS documentation website for more details](http://docs.aws.amazon.com/zh_tw/elasticbeanstalk/latest/dg/command-options-general.html) 存在此限制的原因是 CloudFormation 僅允許在建立範本時為資源設定標籤。如需詳細資訊，請參閱《AWS CloudFormation 使用者指南》**中的 [TagSpecification](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-tagspecification.html)。    將現有環境的此選項值從 `false` 變更為 `true` 可能導致現有標籤發生重大變更。   啟用此功能後，標籤的傳播會需要 EC2 替換，這可能會導致停機。您可以啟用*滾動式更新*，批次套用組態變更，從而避免在更新程序期間停機。如需詳細資訊，請參閱[組態變更](environments-updating.md)。    如需有關啟動範本的詳細資訊，請參閱以下內容： [See the AWS documentation website for more details](http://docs.aws.amazon.com/zh_tw/elasticbeanstalk/latest/dg/command-options-general.html) 如需有關此選項的詳細資訊，請參閱 [對啟動範本的標籤傳輸](applications-tagging-resources.launch-templates.md)。  |  `false`  |  `true` `false`  | 
|  MonitoringInterval  |  您希望 Amazon CloudWatch 指標傳回的間隔 (在幾分鐘內)。  |  `5 minute`  |  `1 minute` `5 minute`  | 
|  SecurityGroups  |  列出要指派給 Auto Scaling 群組中 EC2 執行個體的 Amazon EC2 安全群組 IDs，以定義執行個體的防火牆規則。 EC2  使用此選項與 `DisableDefaultEC2SecurityGroup` 來連接您自己的自訂安全群組，以定義 EC2 執行個體的防火牆規則。如需詳細資訊，請參閱[負載平衡 （多執行個體） 環境](using-features.managing.ec2.instances.sg.md#using-features.managing.ec2.instances.sg.load-balancer-security)。  您可能需要完成一些額外的組態，以防止傳入 EC2 執行個體的流量遭到封鎖。這僅適用於具有自訂 EC2 安全群組的多執行個體環境。EC2 安全群組必須包含傳入規則，以授予從負載平衡器路由的流量存取權。如需詳細資訊，請參閱[在多執行個體環境中管理 EC2 安全群組](using-features.managing.ec2.instances.sg.md#using-features.managing.ec2.instances.sg.load-balancer-security)。  您可以提供單一字串的逗號分隔值，其中包含在範本中建立的現有 Amazon EC2 安全群組 IDs 或 AWS::EC2::SecurityGroup 資源參考。 如果此命名空間的 設定為 `DisableDefaultEC2SecurityGroup`，您必須為此選項提供至少一個值`true`。  |  `elasticbeanstalk-default`   |    | 
|   SSHSourceRestriction  |  用於鎖定 SSH 對環境的存取。例如，您可以鎖定 SSH 對 EC2 執行個體的存取，因此只有 Bastion 主機可以存取私有子網路中的執行個體。 此字串的格式如下： `{{protocol}}, {{fromPort}}, {{toPort}}, {{source_restriction}}` [See the AWS documentation website for more details](http://docs.aws.amazon.com/zh_tw/elasticbeanstalk/latest/dg/command-options-general.html) [See the AWS documentation website for more details](http://docs.aws.amazon.com/zh_tw/elasticbeanstalk/latest/dg/command-options-general.html)  |  無  |    | 
|  BlockDeviceMappings  |  將其他 Amazon EBS 磁碟區或執行個體存放區磁碟區連接到 Auto Scaling 群組上的所有執行個體。  此選項設定可能會導致 Elastic Beanstalk 遷移具有啟動組態的現有環境以啟動範本。這樣做需要必要的許可才能管理啟動範本。這些許可包含在我們的 受管政策中。如果您使用自訂政策，而不是我們的受管政策，當您更新環境組態時，環境建立或更新可能會失敗。如需詳細資訊和其他考量事項，請參閱 [遷移 Elastic Beanstalk 環境以啟動範本](environments-cfg-autoscaling-launch-templates.md)。  映射執行個體存放區時，您只需將裝置名稱映射至磁碟區名稱。不過，我們建議在映射 Amazon EBS 磁碟區時，您應另外指定以下部分或全部欄位 (每個欄位必須以冒號分開)： [See the AWS documentation website for more details](http://docs.aws.amazon.com/zh_tw/elasticbeanstalk/latest/dg/command-options-general.html) 以下範例連接三個 Amazon EBS 磁碟區、一個空白 100GB gp2 磁碟區和一個快照，一個佈建了 2000 個 IOPS 的空白 20GB io1 磁碟區，以及執行個體存放區磁碟區 `ephemeral0`。如果該執行個體類型支援的話，則可以連接多個執行個體存放區磁碟區。  `/dev/sdj=:100:true:gp2,/dev/sdh=snap-51eef269,/dev/sdi=:20:true:io1:2000,/dev/sdb=ephemeral0`   |  無  |  [See the AWS documentation website for more details](http://docs.aws.amazon.com/zh_tw/elasticbeanstalk/latest/dg/command-options-general.html)  | 
|  RootVolumeType  |  磁碟區類型 (磁帶、一般用途 SSD 或佈建 IOPS SSD)，以用於連接到您環境的 EC2 執行個體的根 Amazon EBS 磁碟區。  此選項設定可能會導致 Elastic Beanstalk 遷移具有啟動組態的現有環境以啟動範本。這樣做需要必要的許可才能管理啟動範本。這些許可包含在我們的 受管政策中。如果您使用自訂政策，而不是我們的受管政策，當您更新環境組態時，環境建立或更新可能會失敗。如需詳細資訊和其他考量事項，請參閱 [遷移 Elastic Beanstalk 環境以啟動範本](environments-cfg-autoscaling-launch-templates.md)。   |  依平台而有所不同。  |  `standard` 用於磁帶儲存。 `gp2` 或 `gp3` 用於一般用途 SSD。 `io1` 用於佈建 IOPS SSD。  | 
|  RootVolumeSize  |  整個 GB 中根 Amazon EBS 磁碟區的儲存容量。 如果您設定 `RootVolumeType` 為佈建 IOPS SSD，則此為必要。 例如 `"64"`。  |  對磁帶儲存和一般用途 SSD 而言，每個平台都不同。 非用於佈建 IOPS SSD。  |  `10` 以 `16384` GB 為一般用途和佈建 IOPS SSD。 `8` 以 `1024` GB 為磁帶用途。  | 
|  RootVolumeIOPS  |  所需的佈建 IOPS SSD 根磁碟區或一般用途 `gp3` SSD 根磁碟區每秒輸入/輸出操作次數 (IOPS)。 IOPS 與磁碟區大小的最大比例為 500 比 1。例如，有 3000 IOPS 的磁碟區必須至少為 6 GiB。  |  無  |  io1 佈建 IOPS SSD 根磁碟區為 `100` 至 `20000`。 一般用途 `gp3` SSD 根磁碟區為 `3000` 至 `16000`。  | 
|  RootVolumeThroughput  |  要為連接至您環境 EC2 執行個體的 Amazon EBS 根磁碟區佈建的每秒 MiB (MiB/s) 輸送量。  此選項僅適用於 `gp3` 儲存類型。   |  無  |  `125` 至 `1000`  | 

## aws:autoscaling:scheduledaction
<a name="command-options-general-autoscalingscheduledaction"></a>

為您環境的 Auto Scaling 群組設定[排程動作](environments-cfg-autoscaling-scheduledactions.md)。為每個動作的各個設定指定一個除了選項名稱、命名空間與數值的`resource_name`。如需範例，請參閱 [aws:autoscaling:scheduledaction 命名空間](environments-cfg-autoscaling-scheduledactions.md#environments-cfg-autoscaling-scheduledactions-namespace)。


**命名空間：`aws:autoscaling:scheduledaction`**  

| **名稱** | **描述** | **預設** | **有效值** | 
| --- | --- | --- | --- | 
|  StartTime  |  如需一次性動作，選擇執行動作的日期和時間。對於重複的動作，選擇何時要啟動該動作。  |  無  |  [ISO-8601 時間戳記](http://www.w3.org/TR/NOTE-datetime) 在所有已排程擴展動作中都是獨一無二的。  | 
|  EndTime  |  當您希望重複排定的擴展動作在未來的日期和時間 (在 UTC/GMT 時區) 停止重複。如果您沒有指定 **EndTime (結束時間)**，該動作會根據 `Recurrence` 表達式重複執行。 範例：`2015-04-28T04:07:2Z` 當排定的動作結束時，Amazon EC2 Auto Scaling 不會自動還原到之前的設定。設定第二個排定動作並視需要返回原始設定。  |  無  |  [ISO-8601 時間戳記](http://www.w3.org/TR/NOTE-datetime) 在所有已排程擴展動作中都是獨一無二的。  | 
|  MaxSize  |  動作執行時套用最大執行個體計數。  |  無  |  `0` 至 `10000`  | 
|  MinSize  |  動作執行時套用最小執行個體計數。  |  無  |  `0` 至 `10000`  | 
|  DesiredCapacity  |  為 Auto Scaling 群組設定初始所需的容量。在套用排程動作後，觸發會依它們的設定調整所需的容量。  |  無  |  `0` 至 `10000`  | 
|  Recurrence  |  您想要排定之動作發生的頻率。如果您不指定週期，則只會發生一次縮放動作，如 `StartTime`。  |  無  |  [Cron](http://en.wikipedia.org/wiki/Cron) 表達式。  | 
|  Suspend  |  設定以 `true` 暫時停用重複排定的動作。  |   `false`   |   `true`   `false`   | 

## aws:autoscaling:trigger
<a name="command-options-general-autoscalingtrigger"></a>

為您環境的 Auto Scaling 群組設定擴展觸發程式。

**注意**  
此命名空間中的三個選項會決定在超過其定義的限制時，觸發的指標可以維持的時間，在此時間後才啟動觸發條件。這些選項的相關如下所示：  
`BreachDuration = Period * EvaluationPeriods`  
這些選項的預設值 (分別為 5、5 和 1) 可滿足此方程式。如果您指定不一致的數值，Elastic Beanstalk 可能會修改其中一個值，以繼續滿足方程式。


**命名空間：`aws:autoscaling:trigger`**  

| **名稱** | **描述** | **預設** | **有效值** | 
| --- | --- | --- | --- | 
|  BreachDuration  |  所需時間 (以分鐘為單位)，指標可在叫用觸發程序前超出其定義的限制 (如 `UpperThreshold` 和 `LowerThreshold`)。  |  `5`  |  `1` 至 `600`  | 
|  LowerBreachScaleIncrement  |  執行擴展活動時需移除多少個 Amazon EC2 執行個體。  |  `-1`  |    | 
|  LowerThreshold  |  如果違反持續時間的測量低於此數值，則叫用觸發程序。  |  `2000000`  |  `0` 至 `20000000`  | 
|  MeasureName  |  用於 Auto Scaling 觸發條件的指標。  `HealthyHostCount`、`UnhealthyHostCount` 和 `TargetResponseTime` 僅適用於具有專用負載平衡器的環境。對於使用共用負載平衡器設定的環境，這些不是有效的指標值。如需負載平衡器類型的詳細資訊，請參閱[您的 Elastic Beanstalk 環境的負載平衡器](using-features.managing.elb.md)。   |  `NetworkOut`  |  `CPUUtilization` `NetworkIn` `NetworkOut` `DiskWriteOps` `DiskReadBytes` `DiskReadOps` `DiskWriteBytes` `Latency` `RequestCount` `HealthyHostCount` `UnhealthyHostCount` `TargetResponseTime`  | 
|  Period  |  為您的觸發程式指定 Amazon CloudWatch 衡量指標的頻率。此值為兩個連續期間之間的分鐘數。  |  `5`  |  `1` 至 `600`  | 
|  EvaluationPeriods  |  用來判斷是否發生違規的連續評估期間數。  |  `1`  |  `1` 至 `600`  | 
|  Statistic  |  觸發條件應使用的統計數字，例如 `Average`。  |  `Average`  |  `Minimum` `Maximum` `Sum` `Average`  | 
|  Unit  |  觸發程序測量單位，例如 `Bytes`。  |  `Bytes`  |  `Seconds` `Percent` `Bytes`  `Bits`  `Count`  `Bytes/Second`  `Bits/Second`  `Count/Second`  `None`   | 
|  UpperBreachScaleIncrement  |  指定執行縮放活動時需新增多少個 Amazon EC2 執行個體。  |  `1`  |    | 
|  UpperThreshold  |  如果違反持續時間的測量高於此數值，則叫用觸發程序。  |  `6000000`  |  `0` 至 `20000000`  | 

## aws:autoscaling:updatepolicy:rollingupdate
<a name="command-options-general-autoscalingupdatepolicyrollingupdate"></a>

設定輪流更新您環境的 Auto Scaling 群組。


**命名空間：`aws:autoscaling:updatepolicy:rollingupdate`**  

| **名稱** | **描述** | **預設** | **有效值** | 
| --- | --- | --- | --- | 
|  MaxBatchSize  |  包含在每個輪流更新批次的執行個體數量。  |  Auto Scaling 群組最低大小的三分之一，四捨五入到下一個最高整數。  |  `1` 至 `10000`  | 
|  MinInstancesInService  |  在其他執行個體終止時，必須有最少執行個體在 Auto Scaling 群組內服務中。  |  Auto Scaling 群組的規模下限或小於 Auto Scaling 群組的規模上限，以較低者為準。  |  `0` 至 `9999`  | 
|  RollingUpdateEnabled  |  如果 `true`，其會為環境啟用滾動更新。輪流更新有助您為 Elastic Beanstalk 軟體應用程式進行小型、頻繁的更新，也能避免應用程式的停機時間。 將此值設為 true 會自動啟用`MaxBatchSize`、`MinInstancesInService`、和 `PauseTime` 選項。設定這些選項還會自動將 `RollingUpdateEnabled` 選項值設為 `true`。設定此選項 `false` 以停用輪流更新。  如果使用 Elastic Beanstalk 主控台或 EB CLI 建立環境，您無法在[組態檔案](ebextensions.md)中設定此選項。主控台和 EB CLI 會以[建議值](command-options.md#configuration-options-recommendedvalues)覆寫此選項。   |  `false`  |  `true` `false`  | 
|  RollingUpdateType  |  這包括三種類型：以時間為基礎的滾動更新、以運作狀態為基礎的滾動更新，以及不可變的更新。 以時間為基礎的輪流更新會在批次間應用 PauseTime。以運作狀態為基礎的輪流更新，會在移動至下一個批次前等待新的執行個體通過運作狀態檢查。[不可變動的更新](environmentmgmt-updates-immutable.md)，即可在新的 Auto Scaling 群組中啟動完整的執行個體。  如果使用 Elastic Beanstalk 主控台或 EB CLI 建立環境，您無法在[組態檔案](ebextensions.md)中設定此選項。主控台和 EB CLI 會以[建議值](command-options.md#configuration-options-recommendedvalues)覆寫此選項。   |  `Time`  |  `Time` `Health` `Immutable`  | 
|  PauseTime  |  Elastic Beanstalk 服務在完成一個批次執行個體的更新之後，以及繼續進行下一個批次之前等待的時間量 (數秒鐘、數分鐘或數小時)。  |  根據執行個體類型和容器的自動計算。  |  `PT0S`\* (0 秒) 至`PT1H` (1 小時)  | 
|  Timeout  |  取消更新之前，等待一個批次中所有執行個體通過運作狀態檢查的時間上限 (數分鐘或數小時)。  |  `PT30M` (30 分鐘)  |  `PT5M`\* (5 分鐘) 至`PT1H` (1 小時) \* [ISO8601 持續時間](http://en.wikipedia.org/wiki/ISO_8601#Durations)格式：`PT{{#}}H{{#}}M{{#}}S`，其中每個 \# 分別代表小時、分鐘，和/或秒。  | 

## aws:ec2:instances
<a name="command-options-general-ec2instances"></a>

設定您環境的執行個體，包括 Spot 選項。此命名空間與 [`aws:autoscaling:launchconfiguration`](#command-options-general-autoscalinglaunchconfiguration) 及 [`aws:autoscaling:asg`](#command-options-general-autoscalingasg) 相輔相成。

如需詳細資訊，請參閱[Auto Scaling 您的 Elastic Beanstalk 環境執行個體](using-features.managing.as.md)。


**命名空間：`aws:ec2:instances`**  

| **名稱** | **描述** | **預設** | **有效值** | 
| --- | --- | --- | --- | 
|  EnableSpot  |  為您的環境啟用 Spot 執行個體請求。若為 `false`，此命名空間中的某些選項則無法生效。  此選項設定可能會導致 Elastic Beanstalk 遷移具有啟動組態的現有環境以啟動範本。這樣做需要必要的許可才能管理啟動範本。這些許可包含在我們的 受管政策中。如果您使用自訂政策，而不是我們的受管政策，當您更新環境組態時，環境建立或更新可能會失敗。如需詳細資訊和其他考量事項，請參閱 [遷移 Elastic Beanstalk 環境以啟動範本](environments-cfg-autoscaling-launch-templates.md)。   |  `false`  |  `true` `false`  | 
|   InstanceTypes  |  您要讓環境使用的執行個體類型清單，以逗號分隔 (例如 `t2.micro,t3.micro`)。 當 `EnableSpot`為 `true`且 `SpotAllocationStrategy` 設定為 時`capacity-optimized-prioritized`，此選項中指定的值清單會決定 Spot 執行個體配置策略的執行個體類型優先順序。 Spot 執行個體未啟用 (`EnableSpot` 為 `false`) 時，系統只會使用清單上的第一個執行個體類型。 此選項清單上的第一個執行個體類型等於 [`InstanceType`](#command-options-general-autoscalinglaunchconfiguration) 命名空間中 `aws:autoscaling:launchconfiguration` 選項的數值。我們不建議使用後一個選項，因為其已淘汰。如果您同時指定這兩者，則會使用 `InstanceTypes` 選項清單上的第一個執行個體類型，並忽略 `InstanceType`。 可用的執行個體類型會依使用的可用區域和區域而定。如果您選擇一個子網路，包含該子網路的可用區域會決定可用的執行個體類型。 [See the AWS documentation website for more details](http://docs.aws.amazon.com/zh_tw/elasticbeanstalk/latest/dg/command-options-general.html)  有些較舊 AWS 的帳戶可能會為 Elastic Beanstalk 提供不支援 Spot 執行個體的預設執行個體類型 （例如 t1.micro)。如果您啟用 Spot 執行個體請求，並收到執行個體類型不支援 Spot 的錯誤訊息，請務必設定可支援 Spot 的執行個體類型。如要選擇 Spot 執行個體類型，請使用 [Spot Instance Advisor](https://aws.amazon.com/ec2/spot/instance-advisor/)。  當您更新環境資訊並從 `InstanceTypes` 選項中移除一或多個執行個體類型時，Elastic Beanstalk 會終止在已移除的執行個體類型上執行的任何 Amazon EC2 執行個體。然後，您環境的 Auto Scaling 群組會視需要啟動新執行個體，以使用目前指定的執行個體類型來完成所需的容量。  |  包含兩個執行個體類型的清單。 因帳戶和區域而異。  |  一到四十個 EC2 執行個體類型。建議至少使用兩種。 因帳戶、區域和可用區域而異。您可以取得依據這些值篩選的 Amazon EC2 執行個體類型清單。如需詳細資訊，請參閱《*Amazon EC2 使用者指南*》中的[可用執行個體類型](https://docs.aws.amazon.com//AWSEC2/latest/UserGuide/instance-types.html#AvailableInstanceTypes)。 執行個體類型必須全部屬於相同架構 (`arm64`、`x86_64`、`i386`)。 `SupportedArchitectures` 也是這個命名空間的一部分。如果您針對 `SupportedArchitectures` 提供任何值，您為 `InstanceTypes` 輸入的值必須屬於您為 `SupportedArchitectures` 提供的任何一個架構，而且只能屬於這個架構。  | 
|  SpotAllocationStrategy  |  指定 [Spot 執行個體配置策略](environments-cfg-autoscaling-spot-allocation-strategy.md)，以決定 Spot 執行個體如何從可用的 Spot 容量集區配置。 如果設定為 `capacity-optimized-prioritized`， 中值的順序會`InstanceTypes`設定配置的執行個體類型優先順序。 此選項只有在 `EnableSpot` 為 `true` 時有用。  |  `capacity-optimized`  |  `capacity-optimized` `price-capacity-optimized` `capacity-optimized-prioritized` `lowest-price `  | 
|  SpotFleetOnDemandBase  |  隨著環境擴展，Auto Scaling 群組在考量 Spot 執行個體前佈建的最小隨需執行個體數量。 此選項只有在 `EnableSpot` 為 `true` 時有用。  |  `0`  |  [`0`](#command-options-general-autoscalingasg) 命名空間中的 `MaxSize` 至 `aws:autoscaling:asg` 選項  | 
|  SpotFleetOnDemandAboveBasePercentage  |  隨需執行個體百分比 (Auto Scaling 群組超出 `SpotOnDemandBase` 個執行個體數量所怖建的一部分額外容量)。 此選項只有在 `EnableSpot` 為 `true` 時有用。  |  `0`：適用於單一執行個體環境 `70`：適用於負載平衡的環境  |  `0` 至 `100`  | 
|  SpotMaxPrice  |  您願意為 Spot 執行個體支付的每單位小時最高價格 (USD)。如需 Spot 執行個體最高價格選項的建議，請參閱《*Amazon EC2 使用者指南》中的* [Spot 執行個體定價歷史記錄](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/using-spot-instances-history.html)。 此選項只有在 `EnableSpot` 為 `true` 時有用。  |  每個執行個體類型的隨需價格。在此情況下，選項的數值為 `null`。  |  `0.001` 至 `20.0` `null`  | 
|  SupportedArchitectures  |  您要讓環境使用的 EC2 執行個體架構類型清單 (各項間以逗號分隔)。 Elastic Beanstalk 支援以下列處理器架構為基礎的執行個體類型： [See the AWS documentation website for more details](http://docs.aws.amazon.com/zh_tw/elasticbeanstalk/latest/dg/command-options-general.html) 如需處理器架構和 Amazon EC2 執行個體類型的詳細資訊，請參閱[Amazon EC2 執行個體類型](using-features.managing.ec2.instance-types.md)。  |  無  |  `arm64` `x86_64` `i386`  大多數 Elastic Beanstalk 平台皆不支援 32 位元架構 `i386`。建議您改為選擇 `x86_64` 或 `arm64` 架構類型。   | 

## aws:ec2:vpc
<a name="command-options-general-ec2vpc"></a>

設定您的環境以在自訂的 [Amazon Virtual Private Cloud](https://docs.aws.amazon.com/vpc/latest/userguide/) (Amazon VPC) 中啟動資源。如果您不在此命名空間中設定，Elastic Beanstalk 會在預設 VPC 中啟動資源。


**命名空間：`aws:ec2:vpc`**  

| **名稱**  | **描述**  | **預設**  | **有效值**  | 
| --- | --- | --- | --- | 
|  VPCId  |  您的 Amazon VPC 的 ID。  |  無  |    | 
|  Subnets  |  Auto Scaling 群組子網路或子網路的 ID。如果您有多個子網路，指定一個值作為子網路 ID 的一個單一逗號分隔字串 (例如`"subnet-11111111,subnet-22222222"`)。  |  無  |    | 
|  ELBSubnets  |  Elastic Load Balancer 的子網路或子網路 ID。如果您有多個子網路，指定一個值作為子網路 ID 的一個單一逗號分隔字串 (例如`"subnet-11111111,subnet-22222222"`)。  |  無  |    | 
|  ELBScheme  |  如果您想要在 Amazon VPC 中建立一個內部負載平衡器，以讓您的 Elastic Beanstalk 應用程式無法從 Amazon VPC 外部存取，則請指定 `internal`。如果您指定 `public` 或 `internal` 以外的數值，Elastic Beanstalk 會忽略該數值。  |  `public`   |  `public`  `internal`   | 
|  DBSubnets  |  包含資料庫子網路的 ID。這僅適用於當您希望新增 Amazon RDS 資料庫執行個體做為您應用程式的一部分時。如果您有多個子網路，指定一個值作為子網路 ID 的一個單一逗號分隔字串 (例如`"subnet-11111111,subnet-22222222"`)。  |  無  |    | 
|  AssociatePublicIpAddress  |  指定是否要使用公有 IP 地址來啟動 Amazon VPC 中的執行個體。公有 IP 地址執行個體不需藉由 NAT 裝置與網際網路通訊。如果要在單一公有子網路中納入您的負載平衡器與執行個體，您必須將值設為 `true`。 此選項並不會影響單一執行個體環境，該環境一律都有具備彈性 IP 地址的單一 Amazon EC2 執行個體。此選項與有負載平衡且可擴展的環境相關。  |  無  |  `true`  `false`   | 

## aws:elasticbeanstalk：應用程式
<a name="command-options-general-elasticbeanstalkapplication"></a>

為您的應用程式設定運作狀態檢查路徑。如需詳細資訊，請參閱[基礎型運作狀態報告](using-features.healthstatus.md)。


**命名空間：`aws:elasticbeanstalk:application`**  

| **名稱**  | **描述**  | **預設**  | **有效值**  | 
| --- | --- | --- | --- | 
|  應用程式狀況檢查 URL  |  傳送運作狀態檢查請求的路徑。如果未設定此路徑，負載平衡器會嘗試在連接埠 80 上建立 TCP 連線，以確認應用程式的運作狀態。設定開始為 `/` 的路徑，以向該路徑傳送一個 HTTP GET 請求。您也可以在路徑前先包含通訊協定 (HTTP、HTTPS、TCP 或 SSL) 和連接埠，以檢查 HTTPS 連線或使用非預設的連接埠。  如果使用 Elastic Beanstalk 主控台建立環境，您無法在[組態檔案](ebextensions.md)中設定此選項。主控台會以[建議值](command-options.md#configuration-options-recommendedvalues)覆寫此選項。   |  無  |  有效值包含： `/` (HTTP GET 到根路徑) `/{{health}}` `HTTPS:443/` `HTTPS:443/{{health}}`  | 

EB CLI 和 Elastic Beanstalk 主控台會為前述選項套用建議的數值。若您想要使用組態檔進行相同的設定，您必須移除這些設定。如需詳細資訊，請參閱「[建議值](command-options.md#configuration-options-recommendedvalues)」。

## aws:elasticbeanstalk:application:environment
<a name="command-options-general-elasticbeanstalkapplicationenvironment"></a>

為您的應用程式設定環境屬性。


**命名空間：`aws:elasticbeanstalk:application:environment`**  

| **名稱**  | **描述**  | **預設**  | **有效值**  | 
| --- | --- | --- | --- | 
|  任何環境變數名稱。  |  以金鑰數值組通過。  |  無  |  任何環境變數值。  | 

如需詳細資訊，請參閱[環境變數和其他軟體設定](environments-cfg-softwaresettings.md)。

## aws：elasticbeanstalk：application：environmentsecrets
<a name="command-options-general-elasticbeanstalk-application-environmentsecrets"></a>

設定環境變數，做為應用程式*的環境秘密*。環境秘密存放 AWS Secrets Manager 秘密或 AWS Systems Manager 參數存放區參數。


**命名空間：`aws:elasticbeanstalk:application:environmentsecrets`**  

| **名稱**  | **描述**  | **預設**  | **有效值**  | 
| --- | --- | --- | --- | 
|  OptionName  |  指定要保留秘密存放區或參數存放區值的環境變數名稱。  |  無  | 任何環境變數名稱。 | 
|  Value  |  指定存放在 AWS Secrets Manager 或 AWS Systems Manager 參數存放區之值的 ARN。在執行個體引導期間，Elastic Beanstalk 會將環境變數啟動為此 ARN 資源中存放的值。  確保您環境的 EC2 執行個體描述檔角色具有存取秘密和參數 ARNs所需的許可。如需詳細資訊，請參閱[所需的 IAM 許可](AWSHowTo.secrets.IAM-permissions.md)。   |  無  |   AWS Secrets Manager 秘密或 AWS Systems Manager 參數存放區參數值的有效 ARN 值。  | 

如需詳細資訊，請參閱[將秘密設定為環境變數](AWSHowTo.secrets.env-vars.md)。

## aws:elasticbeanstalk:cloudwatch:logs
<a name="command-options-general-cloudwatchlogs"></a>

為您的應用程式設定執行個體日誌串流。


**命名空間：`aws:elasticbeanstalk:cloudwatch:logs`**  

| **名稱**  | **描述**  | **預設**  | **有效值**  | 
| --- | --- | --- | --- | 
|  StreamLogs  |  指定是否要在 CloudWatch Logs 中建立 Proxy 和部署日誌的群組，以及在您環境中的各個執行個體串流日誌。  |  `false`  |  `true` `false`  | 
|  DeleteOnTerminate  |  指定是否在環境終止時刪除日誌群組。若為 `false`，日誌將保留 `RetentionInDays` 日。  |  `false`  |  `true` `false`  | 
|  RetentionInDays  |  在保留日誌事件過期之前的天數。  |  7  |  1、3、5、7、14、30、60、90、120、150、180、365、400、545、731、1827、3653  | 

## aws:elasticbeanstalk:cloudwatch:logs:health
<a name="command-options-general-cloudwatchlogs-health"></a>

為您的應用程式設定環境運作狀態日誌串流。


**命名空間：`aws:elasticbeanstalk:cloudwatch:logs:health`**  

| **名稱**  | **描述**  | **預設**  | **有效值**  | 
| --- | --- | --- | --- | 
|  HealthStreamingEnabled  |  對於啟用了增強運作狀態回報的環境，請指定是否在 CloudWatch Logs 為環境運作狀態建立群組並對 Elastic Beanstalk 環境運作狀態資料進行封存。如需啟動增強運作狀態的相關資訊，請參閱 [`aws:elasticbeanstalk:healthreporting:system`](#command-options-general-elasticbeanstalkhealthreporting)。  |  `false`  |  `true` `false`  | 
|  DeleteOnTerminate  |  指定是否在環境終止時刪除日誌群組。若為 `false`，運作狀態資料會保留 `RetentionInDays` 天。  |  `false`  |  `true` `false`  | 
|  RetentionInDays  |  在過期前保留已封存運作資料的天數。  |  7  |  1、3、5、7、14、30、60、90、120、150、180、365、400、545、731、1827、3653  | 

## aws:elasticbeanstalk:command
<a name="command-options-general-elasticbeanstalkcommand"></a>

設定應用程式程式碼的部署原則。如需詳細資訊，請參閱[部署政策和設定](using-features.rolling-version-deploy.md)。


**命名空間：`aws:elasticbeanstalk:command`**  

| **名稱**  | **描述**  | **預設**  | **有效值**  | 
| --- | --- | --- | --- | 
|  DeploymentPolicy  |  為應用程式版本部署選擇 [ 部署原則](using-features.rolling-version-deploy.md)。  如果使用 Elastic Beanstalk 主控台建立環境，您無法在[組態檔案](ebextensions.md)中設定此選項。主控台會以[建議值](command-options.md#configuration-options-recommendedvalues)覆寫此選項。   |  `AllAtOnce`  |  `AllAtOnce` `Rolling` `RollingWithAdditionalBatch` `Immutable` `TrafficSplitting`  | 
|  Timeout  |  等待執行個體完成執行命令的時間 (以秒為單位)。 Elastic Beanstalk 會在內部對 `Timeout` 值增加 240 秒 (四分鐘)。例如，預設的有效逾時是 840 秒 (600 \+ 240) 或 14 分鐘。  |  `600`   |  `1` 至 `3600`  | 
|  BatchSizeType  |  在 **BatchSize** (批次大小) 中指定的數量類型。  如果使用 Elastic Beanstalk 主控台或 EB CLI 建立環境，您無法在[組態檔案](ebextensions.md)中設定此選項。主控台和 EB CLI 會以[建議值](command-options.md#configuration-options-recommendedvalues)覆寫此選項。   |  `Percentage`   |  `Percentage`  `Fixed`   | 
|  BatchSize  |  Auto Scaling 群組中可同時執行部署的 Amazon EC2 執行個體百分比或固定數目。有效值會因使用的 **BatchSizeType** (批次大小類型) 設定而有所不同。  如果使用 Elastic Beanstalk 主控台或 EB CLI 建立環境，您無法在[組態檔案](ebextensions.md)中設定此選項。主控台和 EB CLI 會以[建議值](command-options.md#configuration-options-recommendedvalues)覆寫此選項。   |  `100`   |  `1` 至 `100` (`Percentage`)。 `1` 至 [aws:autoscaling:asg::MaxSize](#command-options-general-autoscalingasg) (`Fixed`)  | 
|  IgnoreHealthCheck  |  不要因為失敗的運作狀態檢查而取消部署。  | false  |  `true`  `false`   | 

## aws:elasticbeanstalk:environment
<a name="command-options-general-elasticbeanstalkenvironment"></a>

設定您的環境架構和服務角色。


**命名空間：`aws:elasticbeanstalk:environment`**  

| **名稱**  | **描述**  | **預設**  | **有效值**  | 
| --- | --- | --- | --- | 
|  EnvironmentType  |  設定 `SingleInstance` 以在不使用負載平衡器的情況下啟動一個 EC2 執行個體。  |  `LoadBalanced`   |  `SingleInstance`  `LoadBalanced`   | 
|  ServiceRole  |  Elastic Beanstalk 用來為環境管理資源的 IAM 角色名稱。指定角色名稱 (選擇性地在字首加上自訂路徑) 或其 ARN。 範例： [See the AWS documentation website for more details](http://docs.aws.amazon.com/zh_tw/elasticbeanstalk/latest/dg/command-options-general.html)  如果使用 Elastic Beanstalk 主控台或 EB CLI 建立環境，您無法在[組態檔案](ebextensions.md)中設定此選項。主控台和 EB CLI 會以[建議值](command-options.md#configuration-options-recommendedvalues)覆寫此選項。   |  無  |  IAM 角色名稱、路徑/名稱或 ARN  | 
|  LoadBalancerType  |  您環境的負載平衡器類型。如需詳細資訊，請參閱[您的 Elastic Beanstalk 環境的負載平衡器](using-features.managing.elb.md)。  |  `classic`  |  `classic` `application` `network`  | 
|  LoadBalancerIsShared  |  指定環境的負載平衡器是專用還是共用。此選項僅能針對 Application Load Balancer 設定。其無法在建立環境後更改。 `false` 時，環境有自己的專用負載平衡器，由 Elastic Beanstalk 建立和管理。使用 `true` 時，環境會使用由您建立的共享負載平衡器，並在 [aws:elbv2:loadbalancer](#command-options-general-elbv2) 命名空間的 `SharedLoadBalancer` 選項中指定。  |   `false`   |   `true`   `false`   | 

## aws:elasticbeanstalk:environment:process:default
<a name="command-options-general-environmentprocess"></a>

設定您環境的預設程序。


**命名空間：`aws:elasticbeanstalk:environment:process:default`**  

| **名稱**  | **描述**  | **預設**  | **有效值**  | 
| --- | --- | --- | --- | 
|  DeregistrationDelay  |  取消註冊之前等待作用中請求完成的時間 (以秒為單位)。  |  `20`  |  `0` 至 `3600`  | 
|  HealthCheckInterval  |  Elastic Load Balancing 會檢查應用程式 Amazon EC2 執行個體之運作狀態的時間間隔 (以秒為單位)。  |  使用傳統或 Application Load Balancer：`15` 使用 Network Load Balancer：`30`  |  使用傳統或 Application Load Balancer：`5`到`300` 使用 Network Load Balancer：`10`、`30`  | 
|  HealthCheckPath  |  運作狀態檢查 HTTP 請求傳送的路徑。  |  `/`   |  可路由路徑。  | 
|  HealthCheckTimeout  |  運作狀態檢查期間等待回應的時間，以秒為單位。 此選項只適用於 Application Load Balancer 的環境。  |  `5`  |  `1` 至 `60`  | 
|  HealthyThresholdCount  |  在 Elastic Load Balancing 變更執行個體運作狀態之前的連續成功請求數目。  |  使用傳統或 Application Load Balancer：`3` 使用 Network Load Balancer：`5`  |  `2` 至 `10`  | 
|  MatcherHTTPCode  |  以逗號分隔的 HTTP 程式碼清單，表示執行個體正常運作。 此選項只適用於具有 Network Load Balancer 或 Application Load Balancer 的環境。  |  `200`  |  使用 Application Load Balancer：`200` 至 `499` 使用 Network Load Balancer：`200` 至 `399`  | 
|  Port  |  接聽處理程序的連接埠。  |  `80`  |  `1` 至 `65535`  | 
|  Protocol  |  處理程序使用的通訊協定。 透過 Application Load Balancer，您僅能將此選項設為`HTTP`或`HTTPS`。 透過 Network Load Balancer，您僅能將此選項設為`TCP`。  |  使用傳統或 Application Load Balancer：`HTTP` 使用 Network Load Balancer：`TCP`  |  `TCP` `HTTP` `HTTPS`  | 
|  StickinessEnabled  |  設定為 true，以啟用黏性工作階段。 此選項只適用於 Application Load Balancer 的環境。  |  `'false'`  |  `'false'` `'true'`  | 
|  StickinessLBCookieDuration  |  黏性工作階段 Cookie 的生命週期 (以秒為單位)。 此選項只適用於 Application Load Balancer 的環境。  |  `86400` (一天)  |  `1` 至 `604800`  | 
|  StickinessType  |  設定為 `lb_cookie`以為黏性工作階段使用 cookies。 此選項只適用於 Application Load Balancer 的環境。  |  `lb_cookie`  |  `lb_cookie`  | 
|  UnhealthyThresholdCount  |  在 Elastic Load Balancing 變更執行個體運作狀態之前的連續不成功請求數目。  |  `5`  |  `2` 至 `10`  | 

## aws:elasticbeanstalk:environment:process:process\_name
<a name="command-options-general-environmentprocess-process"></a>

為您的環境設定額外的程序。


**命名空間：`aws:elasticbeanstalk:environment:process:{{process_name}}`**  

| **名稱**  | **描述**  | **預設**  | **有效值**  | 
| --- | --- | --- | --- | 
|  DeregistrationDelay  |  取消註冊之前等待作用中請求完成的時間 (以秒為單位)。  |  `20`  |  `0` 至 `3600`  | 
|  HealthCheckInterval  |  Elastic Load Balancing 會檢查應用程式的 Amazon EC2 執行個體運作狀態的間隔 (以秒為單位)。  |  使用傳統或 Application Load Balancer：`15` 使用 Network Load Balancer：`30`  |  使用傳統或 Application Load Balancer：`5`到`300` 使用 Network Load Balancer：`10`、`30`  | 
|  HealthCheckPath  |  運作狀態檢查 HTTP 請求傳送的路徑。  |  `/`   |  可路由路徑。  | 
|  HealthCheckTimeout  |  運作狀態檢查期間等待回應的時間，以秒為單位。 此選項只適用於 Application Load Balancer 的環境。  |  `5`  |  `1` 至 `60`  | 
|  HealthyThresholdCount  |  在 Elastic Load Balancing 變更執行個體運作狀態之前的連續成功請求數目。  |  使用傳統或 Application Load Balancer：`3` 使用 Network Load Balancer：`5`  |  `2` 至 `10`  | 
|  MatcherHTTPCode  |  以逗號分隔的 HTTP 程式碼清單，表示執行個體正常運作。 此選項只適用於具有 Network Load Balancer 或 Application Load Balancer 的環境。  |  `200`  |  使用 Application Load Balancer：`200` 至 `499` 使用 Network Load Balancer：`200` 至 `399`  | 
|  Port  |  接聽處理程序的連接埠。  |  `80`  |  `1` 至 `65535`  | 
|  Protocol  |  處理程序使用的通訊協定。 透過 Application Load Balancer，您僅能將此選項設為`HTTP`或`HTTPS`。 透過 Network Load Balancer，您僅能將此選項設為`TCP`。  |  使用傳統或 Application Load Balancer：`HTTP` 使用 Network Load Balancer：`TCP`  |  `TCP` `HTTP` `HTTPS`  | 
|  StickinessEnabled  |  設定為 true，以啟用黏性工作階段。 此選項只適用於 Application Load Balancer 的環境。  |  `'false'`  |  `'false'` `'true'`  | 
|  StickinessLBCookieDuration  |  黏性工作階段 Cookie 的生命週期 (以秒為單位)。 此選項只適用於 Application Load Balancer 的環境。  |  `86400` (一天)  |  `1` 至 `604800`  | 
|  StickinessType  |  設定為 `lb_cookie`以為黏性工作階段使用 cookies。 此選項只適用於 Application Load Balancer 的環境。  |  `lb_cookie`  |  `lb_cookie`  | 
|  UnhealthyThresholdCount  |  在 Elastic Load Balancing 變更執行個體運作狀態之前的連續不成功請求數目。  |  `5`  |  `2` 至 `10`  | 

## aws:elasticbeanstalk:environment:proxy:staticfiles
<a name="command-options-general-environmentproxystaticfiles"></a>

您可以使用以下命名空間，設定代理伺服器以提供靜態檔案。代理伺服器收到位於指定路徑下的檔案請求時，會直接提供檔案而非將請求路由至您的應用程式。這可減少應用程式必須處理的請求數量。

將代理伺服器提供的路徑對應至包含靜態資產之原始程式碼中的資料夾。您在此命名空間中定義的每個選項都會對應至不同路徑。

**注意**  
此命名空間適用於以 Amazon Linux 2 和更新版本為基礎的平台分支。如果您的環境會使用以 Amazon Linux AMI 為基礎的平台版本 (Amazon Linux 2 之前的版本)，請參閱 [平台特定選項](command-options-specific.md) 以取得平台特定的靜態檔案命名空間。


**命名空間：`aws:elasticbeanstalk:environment:proxy:staticfiles`**  

| **名稱**  | **Value**  | 
| --- | --- | 
|  代理伺服器提供檔案的路徑。以 `/` 啟動值。 例如，指定 `/images` 以在 `{{subdomain}}.eleasticbeanstalk.com/images` 提供檔案。  |  內含檔案的資料夾名稱。 例如，指定 `staticimages` 以從原始碼套件最上層名為 `staticimages` 的資料夾提供檔案。  | 

## aws:elasticbeanstalk:healthreporting:system
<a name="command-options-general-elasticbeanstalkhealthreporting"></a>

為您的環境設定增強的執行狀況報告。


**命名空間：`aws:elasticbeanstalk:healthreporting:system`**  

| **名稱**  | **描述**  | **預設**  | **有效值**  | 
| --- | --- | --- | --- | 
|  SystemType  |  運作狀態報告系統 ([基本](using-features.healthstatus.md)或[增強](health-enhanced.md))。增強式運作狀態報告需要一個[服務角色](concepts-roles-service.md)和第 2 版或更新版本的[平台版本](concepts.platforms.md)。  如果使用 Elastic Beanstalk 主控台或 EB CLI 建立環境，您無法在[組態檔案](ebextensions.md)中設定此選項。主控台和 EB CLI 會以[建議值](command-options.md#configuration-options-recommendedvalues)覆寫此選項。   |  `basic`   |  `basic`  `enhanced`   | 
| ConfigDocument | JSON 文件，其中描述了要發佈到 CloudWatch 的環境和執行個體指標。 | 無 |  | 
|  EnhancedHealthAuthEnabled  |  啟用內部 API 的授權，Elastic Beanstalk 會將其用於將增強型運作狀態資訊從您的環境執行個體傳送至 Elastic Beanstalk 服務。 如需詳細資訊，請參閱[增強型運作狀態角色](health-enhanced.md#health-enhanced-roles)。  此選項僅適用於增強型運作狀態報告 (例如 `SystemType` 設為 `enhanced` 時)。   |  `true`   |  `true`  `false`   | 
|  HealthCheckSuccessThreshold  |  為執行個體降低閾值以通過運作狀態檢查。  如果使用 Elastic Beanstalk 主控台建立環境，您無法在[組態檔案](ebextensions.md)中設定此選項。主控台會以[建議值](command-options.md#configuration-options-recommendedvalues)覆寫此選項。   |  `Ok`  |  `Ok` `Warning` `Degraded` `Severe`  | 

## aws:elasticbeanstalk:hostmanager
<a name="command-options-general-elasticbeanstalkhostmanager"></a>

在您的環境設定 EC2 執行個體以上傳 Amazon S3 輪換日誌。


**命名空間：`aws:elasticbeanstalk:hostmanager`**  

| **名稱**  | **描述**  | **預設**  | 有效值 | 
| --- | --- | --- | --- | 
|  LogPublicationControl  |  將應用程式的 Amazon EC2 執行個體日誌檔案複製到與您的應用程式相關聯的 Amazon S3 儲存貯體。  |  `false`   |  `true`  `false`   | 

## aws:elasticbeanstalk:managedactions
<a name="command-options-general-elasticbeanstalkmanagedactions"></a>

為您的環境設定受管平台更新。


**命名空間：`aws:elasticbeanstalk:managedactions`**  

| **名稱**  | **描述**  | **預設**  | **有效值**  | 
| --- | --- | --- | --- | 
|  ManagedActionsEnabled  |  啟用[受管平台更新](environment-platform-update-managed.md#environment-platform-update-managed-namespace)。 當您將此設定為 `true`，您還必須指定 `PreferredStartTime` 和 `UpdateLevel`。  |  `false`   |  `true`  `false`   | 
|  PreferredStartTime  |  在 UTC 中設定受管動作的維護時段。 例如 `"Tue:09:00"`。  |  無  |  日期和時間格式：  {{天}}：{{小時}}：{{分鐘}}  格式。  | 
|  ServiceRoleForManagedUpdates  |  Elastic Beanstalk 用來執行您環境的受管平台更新的 IAM 角色名稱。 您可以使用與針對 `ServiceRole` 命名空間之 `aws:elasticbeanstalk:environment` 選項所指定相同的角色，或使用您帳戶的[受管更新服務連結角色](using-service-linked-roles-managedupdates.md)。在後者的情況中，如果帳戶還沒有受管更新服務連結角色，則 Elastic Beanstalk 會建立。  |  無  |  與 `ServiceRole` 相同 或 `AWSServiceRoleForElasticBeanstalkManagedUpdates`  | 

## aws:elasticbeanstalk:managedactions:platformupdate
<a name="command-options-general-elasticbeanstalkmanagedactionsplatformupdate"></a>

為您的環境設定受管平台更新。


**命名空間：`aws:elasticbeanstalk:managedactions:platformupdate`**  

| **名稱**  | **描述**  | **預設**  | **有效值**  | 
| --- | --- | --- | --- | 
|  UpdateLevel  |  使用受管平台更新套用最高層級的更新。平台的版本命名方式為 {{major}}.{{minor}}.{{patch}}。例如，2.0.8 有 2 主要版本、無次要版本，和 8 修補程式版本。  |  無  |  僅 `patch`適用於修補程式版本更新。 `minor` 次要和修補程式版本更新。  | 
|  InstanceRefreshEnabled  |  啟用每週執行個體替換。 這需要將 `ManagedActionsEnabled` 設定為 `true`。  | false |  `true`  `false`   | 

## aws:elasticbeanstalk:monitoring
<a name="command-options-general-elasticbeanstalkmonitoring"></a>

設定您的環境以終止運作狀態檢查失敗的 EC2 執行個體。


**命名空間：`aws:elasticbeanstalk:monitoring`**  

| **名稱**  | **描述**  | **預設**  | **有效值**  | 
| --- | --- | --- | --- | 
|  Automatically Terminate Unhealthy Instances  |  如果執行個體的運作狀態檢查失敗即終止該執行個體。  只有[舊式環境](using-features.migration.md)支援此選項。它根據能否達到以及以其他執行個體為基礎的指標，來判斷執行個體的運作狀態。 Elastic Beanstalk 並未提供自動根據應用程式運作狀態來終止執行個體的功能。   |  `true`   |  `true`  `false`   | 

## aws:elasticbeanstalk:sns:topics
<a name="command-options-general-elasticbeanstalksnstopics"></a>

為您的環境設定通知。


**命名空間：`aws:elasticbeanstalk:sns:topics`**  

| **名稱**  | **描述**  | **預設**  | **有效值**  | 
| --- | --- | --- | --- | 
|  Notification Endpoint  |  通知影響您應用程式的重要事件端點。  如果使用 Elastic Beanstalk 主控台建立環境，您無法在[組態檔案](ebextensions.md)中設定此選項。主控台會以[建議值](command-options.md#configuration-options-recommendedvalues)覆寫此選項。   |  無  |    | 
|  Notification Protocol  |  用於傳送通知給端點的通訊協定。  |  `email`   |  `http`  `https`  `email`  `email-json`  `sqs`   | 
|  Notification Topic ARN  |  您訂閱主題的 Amazon Resource Name (ARN)。  |  無  |    | 
|  Notification Topic Name  |  您訂閱的主題名稱。  |  無  |    | 

## aws:elasticbeanstalk:sqsd
<a name="command-options-general-elasticbeanstalksqsd"></a>

為工作者環境設定 Amazon SQS 佇列。


**命名空間：`aws:elasticbeanstalk:sqsd`**  

| **名稱**  | **描述**  | **預設**  | **有效值**  | 
| --- | --- | --- | --- | 
|  WorkerQueueURL  |  在工作者環境方案讀取訊息的協助程式佇列 URL。  當您未指定值的時候，Elastic Beanstalk 自動建立的佇列將為[標準](https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/standard-queues.html) Amazon SQS 佇列。當您提供值的時候，您可以提供標準或 [FIFO](https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/FIFO-queues.html) Amazon SQS 佇列的 URL。請注意，如果您提供了 FIFO 佇列，則不支援[週期性任務](using-features-managing-env-tiers.md#worker-periodictasks)。   |  自動產生  |  如果您不指定數值，則 Elastic Beanstalk 會自動建立佇列。  | 
|  HttpPath  |  HTTP POST 訊息傳送到的應用程式相對路徑。  |  /  |   | 
|  MimeType  |  在 HTTP POST 請求中所傳送訊息的 MIME 類型。  |  `application/json`   |  `application/json`  `application/x-www-form-urlencoded`  `application/xml`  `text/plain`  自訂 MIME 類型。  | 
|  HttpConnections  |  並行連線到任何 Amazon EC2 執行個體內應用程式的最大上限數。  如果使用 Elastic Beanstalk 主控台建立環境，您無法在[組態檔案](ebextensions.md)中設定此選項。主控台會以[建議值](command-options.md#configuration-options-recommendedvalues)覆寫此選項。   |  `50`   |  `1` 至 `100`  | 
|  ConnectTimeout  |  等待成功連線到應用程式所需的時間 (以秒為單位)。  |  `5`   |  `1` 至 `60`  | 
|  InactivityTimeout  | 等待現有連線回應到應用程式所需的時間 (以秒為單位)。訊息會重新處理，直到協助程式從工作者環境方案中的應用程式接收到 200 (OK) 回應或 RetentionPeriod 過期。 |  `299`   |  `1` 至 `36000`  | 
|  VisibilityTimeout  |  從 Amazon SQS 佇列內送的訊息所需的時間 (秒) 是被鎖定以進行處理的。在設定的時間數過後，該則訊息才能在佇列中被任何其他協助程式再次讀取。  |  300  |  `0` 至 `43200`  | 
|  ErrorVisibilityTimeout  |  在處理嘗試因明確錯誤而失敗之後，Elastic Beanstalk 傳回訊息給 Amazon SQS 佇列之前經過的時間 (秒)。  |  `2` 秒  |  `0`到`43200`秒  | 
|  RetentionPeriod  |  訊息有效並主動處理所需的時間 (以秒為單位)。  |  `345600`   |  `60` 至 `1209600`  | 
|  MaxRetries  |  Elastic Beanstalk 嘗試傳送訊息到 Web 應用程式的次數上限，將在該訊息移動到無效字母佇列之前處裡。  |   `10`   |  `1` 至 `100`  | 

## aws:elasticbeanstalk:trafficsplitting
<a name="command-options-general-elasticbeanstalktrafficsplitting"></a>

設定您環境的流量分割部署。

當您將 [aws:elasticbeanstalk:command](#command-options-general-elasticbeanstalkcommand) 命名空間的 `DeploymentPolicy` 選項設為 `TrafficSplitting` 時，便會套用此命名空間。如需部署原則的詳細資訊，請參閱 [部署政策和設定](using-features.rolling-version-deploy.md)。


**命名空間：`aws:elasticbeanstalk:trafficsplitting`**  

| **名稱**  | **描述**  | **預設**  | **有效值**  | 
| --- | --- | --- | --- | 
|  NewVersionPercent  |  Elastic Beanstalk 移動到執行您正在部署新應用程式版本環境用戶端的傳入用戶端流量初始百分比。  |   `10`   |  `1` 至 `100`  | 
|  EvaluationTime  |  時間間隔 (分鐘)，Elastic Beanstalk 會在初始運作狀態良好的部署之後等待這段時間，再繼續將所有傳入用戶端流量移動到您正在部署的新應用程式版本。  |   `5`   |  `3` 至 `600`  | 

## aws:elasticbeanstalk:xray
<a name="command-options-general-elasticbeanstalkxray"></a>

執行 協助程式，從 X-Ray AWS X-Ray 整合應用程式轉送追蹤資訊。 [設定 AWS X-Ray 偵錯](environment-configuration-debugging.md)


**命名空間：`aws:elasticbeanstalk:xray`**  

| **名稱**  | **描述**  | **預設**  | **有效值**  | 
| --- | --- | --- | --- | 
|  `XRayEnabled`  |  設定為 `true` 以在您環境的執行個體執行 X-Ray 協助程式。  |  `false`  |  `true` `false`  | 

## aws:elb:healthcheck
<a name="command-options-general-elbhealthcheck"></a>

為 Classic Load Balancer 設定運作狀態檢查。


**命名空間：`aws:elb:healthcheck`**  

| **名稱**  | **描述**  | **預設**  | **有效值**  | 
| --- | --- | --- | --- | 
|  HealthyThreshold  |  在 Elastic Load Balancing 變更執行個體運作狀態之前的連續成功請求數目。  |  `3`   |  `2` 至 `10`  | 
|  Interval  |  Elastic Load Balancing 檢查應用程式 Amazon EC2 執行個體運作狀態的間隔。  |  `10`   |  `5` 至 `300`  | 
|  Timeout  |  Elastic Load Balancing 在將執行個體視為沒有回應之前等待回應的時間 (以秒為單位)。  |  `5`   |  `2` 至 `60`  | 
|  UnhealthyThreshold  |  在 Elastic Load Balancing 變更執行個體運作狀態之前的連續不成功請求數目。  |  `5`   |  `2` 至 `10`  | 
|  (已廢除) Target  |  運作狀態檢查傳送至後端執行個體的目的地。使用 `Application Healthcheck URL` 在 [`aws:elasticbeanstalk:application`](#command-options-general-elasticbeanstalkapplication) 命名空間。  |  `TCP:80`   |  格式內目標{{ PROTOCOL }}：{{PORT }}{{/PATH}}  | 

## aws:elb:loadbalancer
<a name="command-options-general-elbloadbalancer"></a>

設定您環境的 Classic Load Balancer。

在這個命名空間的數個選項已不再受到支援，以便使用 [aws:elb:listener](#command-options-general-elblistener) 命名空間中的接聽程式特定選項。若使用這些不再支援的選項，您只能在標準連接埠上設定兩個接聽程式 (一個安全，一個不安全)。


**命名空間：`aws:elb:loadbalancer`**  

| 名稱 | 描述 | 預設 | 有效值 | 
| --- | --- | --- | --- | 
|  CrossZone  |  在所有可用區域的所有執行個體平均設定負載平衡器至路由流量，而不是只在每個區域內設定。  如果使用 Elastic Beanstalk 主控台或 EB CLI 建立環境，您無法在[組態檔案](ebextensions.md)中設定此選項。主控台和 EB CLI 會以[建議值](command-options.md#configuration-options-recommendedvalues)覆寫此選項。   |  `false`   |  `true`  `false`   | 
|  SecurityGroups  |  指派一或多個安全群組，讓您建立負載平衡器。 如果 `DisableDefaultEC2SecurityGroup`([aws:autoscaling:launchconfiguration](#command-options-general-autoscalinglaunchconfiguration)) 設定為 ，則為必要`true`。已選擇退出預設 Elastic Beanstalk EC2 安全群組的負載平衡環境，必須使用此選項提供一或多個安全群組。如需詳細資訊，請參閱 [管理 EC2 安全群組](using-features.managing.ec2.instances.sg.md)。  |  無  |  一或多個安全群組 ID。  | 
| ManagedSecurityGroup |  為您環境的負載平衡器指派現有的安全群組，而不用建立新的。若要使用此設定，請更新此命名空間中的 `SecurityGroups` 設定以包含安全群組的 ID，並移除自動建立之安全群組的 ID (如果已建立)。 若要允許流量從負載平衡器到您環境的 EC2 執行個體，Elastic Beanstalk 會將規則新增至執行個體的安全群組，允許從受管安全群組的傳入流量。  | 無 | 一個安全群組 ID。 | 
|  (已廢除) LoadBalancerHTTPPort  | 不安全接聽程式的接聽連接埠。 |  `80`   |  `OFF`  `80`   | 
|  (已廢除) LoadBalancerPortProtocol  |  用於不安全接聽程式的通訊協定。  |  `HTTP`   |  `HTTP`  `TCP`   | 
|  (已廢除) LoadBalancerHTTPSPort  | 安全接聽程式的接聽連接埠。 |  `OFF`   |  `OFF`  `443`  `8443`   | 
|  (已廢除) LoadBalancerSSLPortProtocol  | 用於安全接聽程式的通訊協定。 |  `HTTPS`   |  `HTTPS`  `SSL`   | 
|  (已廢除) SSLCertificateId  | 要繫結至安全接聽程式的 SSL 憑證的 Amazon Resource Name (ARN)。 |  無  |    | 

## aws:elb:listener
<a name="command-options-general-elblistener"></a>

在 Classic Load Balancer 上設定預設接聽程式 (連接埠 80)。


**命名空間：`aws:elb:listener`**  

| 名稱 | 描述 | 預設 | 有效值 | 
| --- | --- | --- | --- | 
| ListenerProtocol | 接聽程式使用的通訊協定。 | HTTP  | HTTP TCP  | 
| InstancePort | 此接聽程式與 EC2 執行個體溝通所使用的連接埠。 | 80 | 1 至 65535 | 
| InstanceProtocol |  此接聽程式與 EC2 執行個體溝通所使用的通訊協定。 需與 `ListenerProtocol` 有相同的網際網路通訊協定。也必須與任何其他接聽程式有相同的安全性等級，使用 `InstancePort` 作為此接聽程式。 例如，如果 `ListenerProtocol` 是 `HTTPS` (應用程式層級，使用安全連線)，您可以將 `InstanceProtocol` 設為 `HTTP` (也在應用程式層級，使用不安全的連線)。此外，若您將 `InstancePort` 設為 `80`，必須在所有 `InstanceProtocol` 設為 `HTTP` 的其他接聽程式中將 `InstancePort` 設為 `80`。  |  `HTTP`，當 `ListenerProtocol` 是 `HTTP` 時 `TCP`，當 `ListenerProtocol` 是 `TCP` 時  | HTTP 或 HTTPS，當 ListenerProtocol 是 HTTP 或 HTTPS 時 `TCP` 或 `SSL`，當 `ListenerProtocol` 是 `TCP` 或 `SSL` 時 | 
| PolicyNames | 套用至此接聽程式連接埠，原則名稱以逗號分隔的清單。我們建議您為 [aws:elb:policies](#command-options-general-elbpolicies) 命名空間改用 LoadBalancerPorts 選項。 | 無 |  | 
| ListenerEnabled | 指定這個接聽程式是否已啟用。若您指定 false，則接聽程式不會包含在負載平衡器中。 | true |  `true` `false`  | 

## aws:elb:listener:listener\_port
<a name="command-options-general-elblistener-listener"></a>

Classic Load Balancer 上設定額外的接聽程式。


**命名空間：`aws:elb:listener:{{listener_port}}`**  

| 名稱 | 描述 | 預設 | 有效值 | 
| --- | --- | --- | --- | 
|  ListenerProtocol  | 接聽程式使用的通訊協定。 |  HTTP  |  HTTP HTTPS TCP SSL  | 
|  InstancePort  | 此接聽程式與 EC2 執行個體溝通所使用的連接埠。 | 與{{listener\_port}}相同。 | 1 至 65535 | 
|  InstanceProtocol  |  此接聽程式與 EC2 執行個體溝通所使用的通訊協定。 需與 `ListenerProtocol` 有相同的網際網路通訊協定。也必須與任何其他接聽程式有相同的安全性等級，使用 `InstancePort` 作為此接聽程式。 例如，如果 `ListenerProtocol` 是 `HTTPS` (應用程式層級，使用安全連線)，您可以將 `InstanceProtocol` 設為 `HTTP` (也在應用程式層級，使用不安全的連線)。此外，若您將 `InstancePort` 設為 `80`，必須在所有 `InstanceProtocol` 設為 `HTTP` 的其他接聽程式中將 `InstancePort` 設為 `80`。  |  `HTTP`，當 `ListenerProtocol` 是 `HTTP` 或 `HTTPS` 時 `TCP`，當 `ListenerProtocol` 是 `TCP` 或 `SSL` 時  | HTTP 或 HTTPS，當 ListenerProtocol 是 HTTP 或 HTTPS 時 `TCP` 或 `SSL`，當 `ListenerProtocol` 是 `TCP` 或 `SSL` 時 | 
|  PolicyNames  | 套用至此接聽程式連接埠，原則名稱以逗號分隔的清單。我們建議您為 [aws:elb:policies](#command-options-general-elbpolicies) 命名空間改用 LoadBalancerPorts 選項。 | 無 |  | 
|  SSLCertificateId  | 要繫結至接聽程式的 SSL 憑證的 Amazon Resource Name (ARN)。 |  無  |  | 
|  ListenerEnabled  | 指定這個接聽程式是否已啟用。若您指定 false，則接聽程式不會包含在負載平衡器中。 | 若有設定任何其他選項即為 true，否則為 false。 |  true false  | 

## aws:elb:policies
<a name="command-options-general-elbpolicies"></a>

為 Classic Load Balancer 修改預設黏著性和全球負載平衡器原則。


**命名空間：`aws:elb:policies`**  

| **名稱**  | **描述**  | **預設**  | **有效值**  | 
| --- | --- | --- | --- | 
|  ConnectionDrainingEnabled  |  指定負載平衡器維持現有連結至已變為狀態不佳或取消註冊的執行個體，以完成正在進行的請求。  如果使用 Elastic Beanstalk 主控台或 EB CLI 建立環境，您無法在[組態檔案](ebextensions.md)中設定此選項。主控台和 EB CLI 會以[建議值](command-options.md#configuration-options-recommendedvalues)覆寫此選項。   |  `false`   |  `true`  `false`   | 
|  ConnectionDrainingTimeout  |  在強制關閉連接之前，負載平衡器在連接耗盡期間維持與執行個體的現有連接最大秒數。  如果使用 Elastic Beanstalk 主控台建立環境，您無法在[組態檔案](ebextensions.md)中設定此選項。主控台會以[建議值](command-options.md#configuration-options-recommendedvalues)覆寫此選項。   |  `20`   |  `1` 至 `3600`  | 
|  ConnectionSettingIdleTimeout  |  負載平衡器等待透過連線傳送或接收任何資料的時間 (以秒為單位)。如果在此段時間過後沒有資料已傳送或接收，則負載平衡器關閉連線。  |  `60`   |  `1` 至 `3600`  | 
| LoadBalancerPorts |  預設原則 (`AWSEB-ELB-StickinessPolicy`) 適用的接聽程式連接埠的逗號分隔清單。  | 無 | 您可以使用 :all 以表示所有接聽程式連接埠 | 
|  Stickiness Cookie Expiration  |  每個 Cookie 有效所需的時間 (秒)。使用預設原則 (`AWSEB-ELB-StickinessPolicy`)。  |   `0`   |  `0` 至 `1000000`  | 
|  Stickiness Policy  |  將使用者會話繫結到特定的伺服器執行個體，以便會話期間來自使用者的所有請求都發送到相同的伺服器執行個體。使用預設原則 (`AWSEB-ELB-StickinessPolicy`)。  |   `false`   |  true false  | 

## aws:elb:policies:policy\_name
<a name="command-options-general-elbpolicies-custom"></a>

為 Classic Load Balancer 建立額外的負載平衡器原則。


**命名空間：`aws:elb:policies:{{policy_name}}`**  

| **名稱**  | **描述**  | **預設**  | **有效值**  | 
| --- | --- | --- | --- | 
|  CookieName  | 應用程式產生的 cookie 名稱，用於控制 AppCookieStickinessPolicyType原則的工作階段生命週期。此原則僅可與 HTTP/HTTPS 接聽程式關聯。 | 無 |  | 
|  InstancePorts  |  此原則適用的執行個體連接埠的逗號分隔清單。  | 無 | 連接埠清單，或 :all | 
|  LoadBalancerPorts  |  此原則適用的接聽程式連接埠的逗號分隔清單。  | 無 | 連接埠清單，或 :all | 
|  ProxyProtocol  |  對於 `ProxyProtocolPolicyType` 原則，指定是否包含 IP 地址和連接埠的原始請求 TCP 訊息。此原則僅可與 TCP/SSL 接聽程式關聯。  | 無 | true false  | 
|  PublicKey  |  在身分驗證後端伺服器或伺服器時，`PublicKeyPolicyType` 政策所使用的公有金鑰內容。此政策無法直接套用至後端伺服器或接聽程式。它必須是 `BackendServerAuthenticationPolicyType` 政策的一部分。  | 無 |  | 
|  PublicKeyPolicyNames  |  以逗號分隔清單政策名稱 (從 `PublicKeyPolicyType` 政策) 的 `BackendServerAuthenticationPolicyType` 政策，控制身分驗證到後端伺服器或伺服器。此政策僅可與使用 HTTPS/SSL 的後端伺服器相關聯。  | 無 |  | 
|  SSLProtocols  |  為 `SSLNegotiationPolicyType` 政策啟用以逗號分隔的 SSL 通訊協定，以定義負載平衡器可接受的加密方式和通訊協定。此原則僅可與 HTTPS/SSL 接聽程式關聯。  | 無 |  | 
|  SSLReferencePolicy  |  預先定義安全政策的名稱，該政策遵循 AWS 安全最佳實務，並且您想要為定義負載平衡器接受的密碼和通訊協定的政策啟用該`SSLNegotiationPolicyType`政策。此原則僅可與 HTTPS/SSL 接聽程式關聯。  | 無 |  | 
|  Stickiness Cookie Expiration  |  每個 Cookie 有效所需的時間 (秒)。  |  `0`   |  `0` 至 `1000000`  | 
|  Stickiness Policy  |  將使用者會話繫結到特定的伺服器執行個體，以便會話期間來自使用者的所有請求都發送到相同的伺服器執行個體。  |  `false`   | true false  | 

## aws:elbv2:listener:default
<a name="command-options-general-elbv2-listener-default"></a>

在 Application Load Balancer 或 Network Load Balancer 設定預設接聽程式 (連接埠 80)。

此命名空間不適用於使用共享負載平衡器的環境。共享負載平衡器沒有預設接聽程式。


**命名空間：`aws:elbv2:listener:default`**  

| **名稱**  | **描述**  | **預設**  | **有效值**  | 
| --- | --- | --- | --- | 
|  DefaultProcess  |  當沒有相符的規則時，轉送流量至該[處理程序](#command-options-general-environmentprocess)的名稱。  |  `default`  |  程序名稱。  | 
|  ListenerEnabled  |  設定為`false`以停用接聽程式。您可以使用此選項，停用連接埠 80 上的預設接聽程式。  |  `true`  |  `true` `false`  | 
|  Protocol  |  要處理的流量通訊協定。  |  使用 Application Load Balancer：`HTTP` 使用 Network Load Balancer：`TCP`  |  使用 Application Load Balancer：`HTTP`、`HTTPS` 使用 Network Load Balancer：`TCP`  | 
|  Rules  |  套用至接聽程式的[規則](#command-options-general-elbv2-listenerrule)清單 此選項只適用於 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
<a name="command-options-general-elbv2-listener"></a>

在 Application Load Balancer 或 Network Load Balancer 設定額外接聽程式。

**注意**  
如果是共享 Application Load Balancer，您只能指定 `Rule` 選項。其他選項不適用於共享負載平衡器。


**命名空間：`aws:elbv2:listener:{{listener_port}}`**  

| **名稱**  | **描述**  | **預設**  | **有效值**  | 
| --- | --- | --- | --- | 
|  DefaultProcess  |  當沒有相符的規則時流量被轉發之[處理程序](#command-options-general-environmentprocess)的名稱。  |  `default`  |  程序名稱。  | 
|  ListenerEnabled  |  設定為`false`以停用接聽程式。您可以使用此選項，停用連接埠 80 上的預設接聽程式。  |  `true`  |  `true` `false`  | 
|  Protocol  |  要處理的流量通訊協定。  |  使用 Application Load Balancer：`HTTP` 使用 Network Load Balancer：`TCP`  |  使用 Application Load Balancer：`HTTP`、`HTTPS` 使用 Network Load Balancer：`TCP`  | 
|  Rules  |  套用至接聽程式的[規則](#command-options-general-elbv2-listenerrule)清單 此選項只適用於 Application Load Balancer 的環境。 如果您的環境使用共享 Application Load Balancer，而且您沒有為任何接聽程式指定此選項，則 Elastic Beanstalk 會自動將 `default` 規則與連線埠 80 接聽程式產生關聯。  |  無  |  以逗號分隔的規則名稱清單。  | 
|  SSLCertificateArns  |  要繫結至接聽程式的 SSL 憑證的 Amazon Resource Name (ARN)。 此選項只適用於 Application Load Balancer 的環境。  |  無  |  存放在 IAM 或 ACM 憑證的 ARN。  | 
|  SSLPolicy  |  指定安全原則以套用到接聽程式。 此選項只適用於 Application Load Balancer 的環境。  | 無 (ELB 預設) |  負載平衡器安全原則名稱。  | 

## aws:elbv2:listenerrule:rule\_name
<a name="command-options-general-elbv2-listenerrule"></a>

定義 Application Load Balancer 的接聽程式規則。如果請求符合規則中的主機名稱或路徑，負載平衡器會將請求轉發到指定的程序中。若要使用規則，將其新增到 [`Rules`](#command-options-general-elbv2-listener) 命名空間中的 `aws:elbv2:listener:{{listener_port}}` 選項。

**注意**  
這個命名空間不適用於使用 Network Load Balancer 的環境。


**命名空間：`aws:elbv2:listenerrule:{{rule_name}}`**  

| **名稱**  | **描述**  | **預設**  | **有效值**  | 
| --- | --- | --- | --- | 
|  HostHeaders  |  要比對的主機名稱清單。例如，`my.example.com`。  |  專用負載平衡器：無 共享負載平衡器：環境的 CNAME  |  每個名稱最多可包含 128 個字元。模式可包含大寫和小寫字母、數字、連字號 (–)，以及最多三個萬用字元 (`*` 等同於零個或多個字元，`?` 等同於一個字元)。您可列出多個名稱，且以逗號分隔各個名稱。Application Load Balancer 最多支援五個合併的 `HostHeader` 和 `PathPattern` 規則。 如需詳細資訊，請參閱 *Application Load Balancer 使用者指南*中的[主機條件](https://docs.aws.amazon.com/elasticloadbalancing/latest/application/load-balancer-listeners.html#host-conditions)。  | 
|  PathPatterns  |  要匹配的路徑模式 (例如 `/img/*`)。 此選項只適用於 Application Load Balancer 的環境。  |  無  |  每個模式最多可包含 128 個字元。模式可包含大寫和小寫字母、數字、連字號 (–)，以及最多三個萬用字元 (`*` 等同於零個或多個字元，`?` 等同於一個字元)。您可以新增多個以逗號分隔的路徑模式。Application Load Balancer 最多支援五個合併的 `HostHeader` 和 `PathPattern` 規則。 如需詳細資訊，請參閱 *Application Load Balancer 使用者指南*中的[路徑條件](https://docs.aws.amazon.com/elasticloadbalancing/latest/application/load-balancer-listeners.html#path-conditions)。  | 
|  Priority  |  多個規則相符時，此規則的優先順序。數量較低的優先。不會同時有兩個規則有相同的優先順序。 使用共享負載平衡器時，Elastic Beanstalk 將規則優先順序視為共享環境中的相對優先順序，並在建立期間將其對應至絕對優先順序。  |  `1`  |  `1` 至 `1000`  | 
|  Process  |  當此規則符合要求時，要轉送流量至該[處理程序](#command-options-general-environmentprocess)的名稱。  |  `default`  |  程序名稱。  | 

## aws:elbv2:loadbalancer
<a name="command-options-general-elbv2"></a>

設定一個 Application Load Balancer。

對於共享負載平衡器，只有 `SharedLoadBalancer` 和 `SecurityGroups` 選項有效。

**注意**  
這個命名空間不適用於使用 Network Load Balancer 的環境。


**命名空間：`aws:elbv2:loadbalancer`**  

| **名稱**  | **描述**  | **預設**  | **有效值**  | 
| --- | --- | --- | --- | 
|  AccessLogsS3Bucket  |  存放存取日誌的 Amazon S3 儲存貯體。儲存貯體必須與環境位於同一個區域中，並允許負載平衡器寫入存取。  |  無  |  儲存貯體名稱。  | 
|  AccessLogsS3Enabled  |  啟用存取日誌儲存。  |  `false`  |  `true` `false`  | 
|  AccessLogsS3Prefix  |  用於存取日誌名稱的前綴。在預設情況下，負載平衡器上傳日誌到您指定在儲存貯體中名為 AWSLogs 的目錄。指定一個前綴，以將 AWSLogs 目錄放在另一個目錄中。  |  無  |    | 
|  IdleTimeout  |  在關閉與用戶端和執行個體的連線之前等待請求完成的時間 (以秒為單位)。  |  無  |  `1` 至 `3600`  | 
|  IpAddressType  | 指定環境負載平衡器的 IP 地址格式組態。使用*雙堆疊*選項來啟用 IPv6 通訊協定，以及 IPv4 通訊協定。 只有 Application Load Balancer 和 Network Load Balancer 支援*雙堆疊*選項。使用 Classic Load Balancer 的單一執行個體環境和環境不支援它。 您必須將環境的 VPC 和所有 VPC 子網路與 IPv6 CIDR 區塊建立關聯，以支援*雙堆疊*選項。 如需詳細資訊，請參閱[設定雙堆疊 Elastic Beanstalk 負載平衡器](environments-cfg-elbv2-ipv6-dualstack.md)。  | ipv4 | ipv4、雙堆疊 | 
|  ManagedSecurityGroup  |  為您環境的負載平衡器指派現有的安全群組，而不用建立新的。若要使用此設定，請在這個命名空間包含您的安全群組 ID 以更新`SecurityGroups`設定，並移除自動建立的安全群組 ID (若有的話)。 若要允許流量從負載平衡器到您環境的 EC2 執行個體，Elastic Beanstalk 會將規則新增至執行個體的安全群組，允許從受管安全群組的傳入流量。  |  Elastic Beanstalks 為您的負載平衡器建立的安全群組。  |  一個安全群組 ID。  | 
|  SecurityGroups  |  連接到負載平衡器的安全群組清單。 如果 `DisableDefaultEC2SecurityGroup`([aws:autoscaling:launchconfiguration](#command-options-general-autoscalinglaunchconfiguration)) 設定為 ，則為必要`true`。已選擇退出預設 Elastic Beanstalk EC2 安全群組的負載平衡環境，必須使用此選項提供一或多個安全群組。如需詳細資訊，請參閱 [管理 EC2 安全群組](using-features.managing.ec2.instances.sg.md)。 對於共享負載平衡器，如果您未指定此值，Elastic Beanstalk 會檢查其管理的現有安全群組是否已連接至負載平衡器。如果沒有連接到負載平衡器，Elastic Beanstalk 會建立安全群組並將其連接到負載平衡器。當共享負載平衡器的最後一個環境終止時，Elastic Beanstalk 會刪除此安全群組。 負載平衡器安全群組用於設定 Amazon EC2 執行個體安全群組輸入規則。  |  Elastic Beanstalk 為您的負載平衡器建立的安全群組。  |  以逗號分隔的安全群組 ID 清單。  | 
|  SharedLoadBalancer  |  共用負載平衡器的 Amazon Resource Name (ARN)。此選項僅與 Application Load Balancer 相關。當 [aws:elasticbeanstalk:environment](#command-options-general-elasticbeanstalkenvironment) 命名空間的 `LoadBalancerIsShared` 選項設為 `true` 時，這為必要項目。建立環境後，您無法變更共用負載平衡器 ARN。 有效值的條件： [See the AWS documentation website for more details](http://docs.aws.amazon.com/zh_tw/elasticbeanstalk/latest/dg/command-options-general.html) 範例： `arn:aws:elasticloadbalancing:us-east-2:123456789012:loadbalancer/app/FrontEndLB/0dbf78d8ad96abbc`  |  無  |  符合此處所述全部準則的有效負載平衡器 ARN。  | 

## aws:rds:dbinstance
<a name="command-options-general-rdsdbinstance"></a>

設定連接的 Amazon RDS 資料庫執行個體。


**命名空間：`aws:rds:dbinstance`**  

| **名稱**  | **描述**  | **預設**  | **有效值**  | 
| --- | --- | --- | --- | 
|  DBAllocatedStorage  |  分配的資料庫儲存大小，以 GB 為單位。  |  MySQL: `5` Oracle: `10` sqlserver-se：`200` sqlserver-ex：`30` sqlserver-web：`30`  |  MySQL: `5`-`1024` Oracle: `10`-`1024` sqlserver：不能修改  | 
|  DBDeletionPolicy  |  指定在環境終止時，是否要保留、刪除或建立資料庫執行個體的快照。 此選項適合搭配 `HasCoupledDatabase` 使用，也是此命名空間的一個選項。  刪除資料庫執行個體會產生永久性資料遺失。   |  `Delete`   |  `Delete`  `Retain`  `Snapshot`   | 
|  DBEngine  |  要為此執行個體使用的資料庫引擎名稱。  |  `mysql`   |  `mysql`  `oracle-se1`  `sqlserver-ex`  `sqlserver-web`  `sqlserver-se`  `postgres`   | 
|  DBEngineVersion  |  資料庫引擎版本編號。  |  `5.5`   |    | 
|  DBInstanceClass  |  資料庫執行個體類型。  |  `db.t2.micro`  (`db.m1.large` 適用於不在 Amazon VPC 中執行的環境)   |  如需詳細資訊，請參閱 *Amazon Relational Database Service 使用者指南*中的[資料庫執行個體類別](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Concepts.DBInstanceClass.html)。  | 
|  DBPassword  |  要為此資料庫執行個體使用的主要使用者密碼名稱。  |  無  |    | 
|  DBSnapshotIdentifier  |  恢復資料庫快照的識別碼。  |  無  |    | 
|  DBUser  |  此資料庫執行個體的主要使用者名稱。  |  **ebroot**   |    | 
|  HasCoupledDatabase  |  指定資料庫執行個體是否要與環境耦合。如果切換為 `true`，Elastic Beanstalk 會建立與您環境耦合的新資料庫執行個體。如果切換為 `false`，Elastic Beanstalk 會從您的環境啟動資料庫執行個體的解耦。 此選項適合搭配 `DBDeletionPolicy` 使用，也是此命名空間的一個選項。  注意：如果您在解耦舊有資料庫後，將此值切換回 `true`，則 Elastic Beanstalk 會使用舊有資料庫選項設定來建立新資料庫。不過，為了維護環境的安全性，其不會保留現有的 `DBUser` 和 `DBPassword` 設定。您需要再次指定 `DBUser` 和 `DBPassword`。   |  `false`   |  `true`  `false`   | 
|  MultiAZDatabase  |  指定是否需要建立資料庫執行個體異地同步備份部署。如需使用 Amazon Relational Database Service (RDS) 進行異地同步備份部署的詳細資訊，請參閱 *Amazon Relational Database Service 使用者指南*中的[區域與可用區域](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Concepts.RegionsAndAvailabilityZones.html)。  |  `false`   |  `true`  `false`   | 