# General options for all environments **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:application](#command-options-general-elasticbeanstalkapplication) + [aws:elasticbeanstalk:application:environment](#command-options-general-elasticbeanstalkapplicationenvironment) + [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 Configure your environment's Auto Scaling group\. **Namespace: `aws:autoscaling:asg`** | **Name** | **Description** | **Default** | **Valid values** | | --- | --- | --- | --- | | Availability Zones | Availability Zones $AZs$ are distinct locations within a region that are engineered to be isolated from failures in other AZs and provide inexpensive, low\-latency network connectivity to other AZs in the same region\. Choose the number of AZs for your instances\. | `Any` | `Any` `Any 1` `Any 2` `Any 3` | | Cooldown | Cooldown periods help prevent Amazon EC2 Auto Scaling from initiating additional scaling activities before the effects of previous activities are visible\. A cooldown period is the amount of time, in seconds, after a scaling activity completes before another scaling activity can start\. | `360` | `0` to `10000` | | Custom Availability Zones | Define the AZs for your instances\. | None | `us-east-1a` `us-east-1b` `us-east-1c` `us-east-1d` `us-east-1e` `eu-central-1` | | MinSize | Minimum number of instances you want in your Auto Scaling group\. | `1` | `1` to `10000` | | MaxSize | Maximum number of instances you want in your Auto Scaling group\. | `4` | `1` to `10000` | ## aws:autoscaling:launchconfiguration Configure your environment's Amazon Elastic Compute Cloud $Amazon EC2$ instances\. Your environment's instances are created using either an Amazon EC2 launch template or an Auto Scaling group launch configuration resource\. These options work with both of these resource types\. For more information, see [Your Elastic Beanstalk environment's Amazon EC2 instances](using-features.managing.ec2.md)\. **Namespace: `aws:autoscaling:launchconfiguration`** | **Name** | **Description** | **Default** | **Valid values** | | --- | --- | --- | --- | | DisableIMDSv1 | Set to `true` to disable Instance Metadata Service Version 1 $IMDSv1$\. By default, your environment's instances enable both IMDSv1 and IMDSv2\. For more information, see [Configuring the instance metadata service](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/configuring-instance-metadata-service.html)\. | `false` | `true` `false` | | EC2KeyName | A key pair enables you to securely log into your EC2 instance\. If you use the Elastic Beanstalk console to create an environment, you can't set this option in a [configuration file](ebextensions.md)\. The console overrides this option with a [recommended value](command-options.md#configuration-options-recommendedvalues)\. | None | | | IamInstanceProfile | An instance profile enables AWS Identity and Access Management $IAM$ users and AWS services to access temporary security credentials to make AWS API calls\. Specify the instance profile's name or its ARN\. Examples: [\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/elasticbeanstalk/latest/dg/command-options-general.html) If you use the Elastic Beanstalk console or EB CLI to create an environment, you can't set this option in a [configuration file](ebextensions.md)\. The console and EB CLI override this option with a [recommended value](command-options.md#configuration-options-recommendedvalues)\. | None | Instance profile name or ARN | | ImageId | You can override the default Amazon Machine Image $AMI$ by specifying your own custom AMI ID\. Example: `ami-1f316660` | None | | | InstanceType | The instance type used to run your application in an Elastic Beanstalk environment\. The `InstanceType` option is obsolete\. It's replaced by the newer and more powerful `InstanceTypes` option in the [`aws:ec2:instances`](#command-options-general-ec2instances) namespace\. The new option allows you to specify a list of one or more instance types for your environment\. The first value on that list is equivalent to the value of the `InstanceType` option included in the `aws:autoscaling:launchconfiguration` namespace described here\. The recommended way to specify instance types is by using the new option\. If specified, the new option takes precedence over the old one\. For more information, see [The aws:ec2:instances namespace](using-features.managing.as.md#environments-cfg-autoscaling-namespace.instances)\. The instance types available depend on platform, solution stack $configuration$ and region\. To get a list of available instance types for your solution stack of choice, use the [DescribeConfigurationOptions ](https://docs.aws.amazon.com/elasticbeanstalk/latest/api/API_DescribeConfigurationOptions.html)action in the API, [describe\-configuration\-options](https://docs.aws.amazon.com/cli/latest/reference/elasticbeanstalk/describe-configuration-options.html) command in the [AWS CLI](https://aws.amazon.com/cli/)\. For example, the following command lists the available instance types for version 1\.4\.3 of the PHP 5\.6 stack in the current region: $ `aws elasticbeanstalk describe-configuration-options --options Namespace=aws:autoscaling:launchconfiguration,OptionName=InstanceType --solution-stack-name "64bit Amazon Linux 2015.03 v1.4.3 running PHP 5.6"` If you use the Elastic Beanstalk console or EB CLI to create an environment, you can't set this option in a [configuration file](ebextensions.md)\. The console and EB CLI override this option with a [recommended value](command-options.md#configuration-options-recommendedvalues)\. | Region dependent | | | MonitoringInterval | Interval at which you want Amazon CloudWatch metrics returned\. | `5 minute` | `1 minute` `5 minute` | | SecurityGroups | Lists the Amazon EC2 security groups to assign to the EC2 instances in the Auto Scaling group in order to define firewall rules for the instances\. You can provide a single string of comma\-separated values that contain the name of existing Amazon EC2 security groups or references to AWS::EC2::SecurityGroup resources created in the template\. Security group names are case sensitive\. If you use [Amazon Virtual Private Cloud](https://docs.aws.amazon.com/vpc/latest/userguide/) $Amazon VPC$ with Elastic Beanstalk so that your instances are launched within a virtual private cloud $VPC$, specify security group IDs instead of security group names\. | `elasticbeanstalk-default` | | | SSHSourceRestriction | Used to lock down SSH access to an environment\. For instance, you can lock down SSH access to the EC2 instances so that only a bastion host can access the instances in the private subnet\. This string takes the following form: `protocol, fromPort, toPort, source_restriction` [\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/elasticbeanstalk/latest/dg/command-options-general.html) Example: `tcp, 22, 22, 54.240.196.185/32` Example: `tcp, 22, 22, my-security-group` Example $EC2\-Classic$: `tcp, 22, 22, 123456789012/their-security-group` Example $VPC$: `tcp, 22, 22, sg-903004f8` | None | | | BlockDeviceMappings | Attach additional Amazon EBS volumes or instance store volumes on all of the instances in the autoscaling group\. When you map instance store volumes you only map the device name to a volume name; when you map Amazon EBS volumes, you can specify the following fields, separated by a colon: [\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/elasticbeanstalk/latest/dg/command-options-general.html) The following example attaches three Amazon EBS volumes, one blank 100GB gp2 volume and one snapshot, one blank 20GB io1 volume with 2000 provisioned IOPS, and an instance store volume `ephemeral0`\. Multiple instance store volumes can be attached if the instance type supports it\. `/dev/sdj=:100:true:gp2,/dev/sdh=snap-51eef269,/dev/sdi=:20:true:io1:2000,/dev/sdb=ephemeral0` | None | | | RootVolumeType | Volume type $magnetic, general purpose SSD or provisioned IOPS SSD$ to use for the root Amazon EBS volume attached to your environment's EC2 instances\. | Varies per platform\. | `standard` for magnetic storage `gp2` for general purpose SSD `io1` for provisioned IOPS SSD | | RootVolumeSize | Storage capacity of the root Amazon EBS volume in whole GB\. Required if you set `RootVolumeType` to provisioned IOPS SSD\. For example, `"64"`\. | Varies per platform for magnetic storage and general purpose SSD\. None for provisioned IOPS SSD\. | `10` to `16384` GB for general purpose and provisioned IOPS SSD\. `8` to `1024` GB for magnetic\. | | RootVolumeIOPS | Desired input/output operations per second $IOPS$ for a provisioned IOPS SSD root volume\. The maximum ratio of IOPS to volume size is 30 to 1\. For example, a volume with 3000 IOPS must be at least 100 GB\. | None | `100` to `20000` | ## aws:autoscaling:scheduledaction Configure [scheduled actions](environments-cfg-autoscaling-scheduledactions.md) for your environment's Auto Scaling group\. For each action, specify a `resource_name` in addition to the option name, namespace, and value for each setting\. See [The aws:autoscaling:scheduledaction namespace](environments-cfg-autoscaling-scheduledactions.md#environments-cfg-autoscaling-scheduledactions-namespace) for examples\. **Namespace: `aws:autoscaling:scheduledaction`** | **Name** | **Description** | **Default** | **Valid values** | | --- | --- | --- | --- | | StartTime | For one\-time actions, choose the date and time to run the action\. For recurrent actions, choose when to activate the action\. | None | A [ISO\-8601 timestamp](http://www.w3.org/TR/NOTE-datetime) unique across all scheduled scaling actions\. | | EndTime | A date and time in the future $in the UTC/GMT time zone$ when you want the scheduled scaling action to stop repeating\. If you don't specify an **EndTime**, the action recurs according to the `Recurrence` expression\. Example: `2015-04-28T04:07:2Z` When a scheduled action ends, Amazon EC2 Auto Scaling does not automatically go back to its previous settings\. Configure a second scheduled action to return to the original settings as needed\. | None | A [ISO\-8601 timestamp](http://www.w3.org/TR/NOTE-datetime) unique across all scheduled scaling actions\. | | MaxSize | The maximum instance count to apply when the action runs\. | None | `0` to `10000` | | MinSize | The minimum instance count to apply when the action runs\. | None | `0` to `10000` | | DesiredCapacity | Set the initial desired capacity for the Auto Scaling group\. After the scheduled action is applied, triggers will adjust the desired capacity based on their settings\. | None | `0` to `10000` | | Recurrence | The frequency with which you want the scheduled action to occur\. If you do not specify a recurrence, then the scaling action will occur only once, as specified by the `StartTime`\. | None | A [Cron](http://en.wikipedia.org/wiki/Cron) expression\. | | Suspend | Set to `true` to deactivate a recurrent scheduled action temporarily\. | `false` | `true` `false` | ## aws:autoscaling:trigger Configure scaling triggers for your environment's Auto Scaling group\. **Note** Three options in this namespace determine how long a trigger's metric can remain beyond its defined limits before the trigger fires\. These options are related as follows: `BreachDuration = Period * EvaluationPeriods` The default values for these options $5, 5, and 1, respectively$ satisfy this equation\. If you specify inconsistent values, Elastic Beanstalk might modify one of the values so that the equation is still satisfied\. **Namespace: `aws:autoscaling:trigger`** | **Name** | **Description** | **Default** | **Valid values** | | --- | --- | --- | --- | | BreachDuration | Amount of time, in minutes, a metric can be beyond its defined limit $as specified in the `UpperThreshold` and `LowerThreshold`$ before the trigger fires\. | `5` | `1` to `600` | | LowerBreachScaleIncrement | How many Amazon EC2 instances to remove when performing a scaling activity\. | `-1` | | | LowerThreshold | If the measurement falls below this number for the breach duration, a trigger is fired\. | `2000000` | `0` to `20000000` | | MeasureName | Metric used for your Auto Scaling trigger\. | `NetworkOut` | `CPUUtilization` `NetworkIn` `NetworkOut` `DiskWriteOps` `DiskReadBytes` `DiskReadOps` `DiskWriteBytes` `Latency` `RequestCount` `HealthyHostCount` `UnhealthyHostCount` `TargetResponseTime` | | Period | Specifies how frequently Amazon CloudWatch measures the metrics for your trigger\. The value is the number of minutes between two consecutive periods\. | `5` | `1` to `600` | | EvaluationPeriods | The number of consecutive evaluation periods used to determine if a breach is occurring\. | `1` | `1` to `600` | | Statistic | Statistic the trigger should use, such as `Average`\. | `Average` | `Minimum` `Maximum` `Sum` `Average` | | Unit | Unit for the trigger measurement, such as `Bytes`\. | `Bytes` | `Seconds` `Percent` `Bytes` `Bits` `Count` `Bytes/Second` `Bits/Second` `Count/Second` `None` | | UpperBreachScaleIncrement | How many Amazon EC2 instances to add when performing a scaling activity\. | `1` | | | UpperThreshold | If the measurement is higher than this number for the breach duration, a trigger is fired\. | `6000000` | `0` to `20000000` | ## aws:autoscaling:updatepolicy:rollingupdate Configure rolling updates your environment's Auto Scaling group\. **Namespace: `aws:autoscaling:updatepolicy:rollingupdate`** | **Name** | **Description** | **Default** | **Valid values** | | --- | --- | --- | --- | | MaxBatchSize | The number of instances included in each batch of the rolling update\. | One\-third of the minimum size of the autoscaling group, rounded to the next highest integer\. | `1` to `10000` | | MinInstancesInService | The minimum number of instances that must be in service within the autoscaling group while other instances are terminated\. | The minimum size of the AutoScaling group or one less than the maximum size of the autoscaling group, whichever is lower\. | `0` to `9999` | | RollingUpdateEnabled | If `true`, enables rolling updates for an environment\. Rolling updates are useful when you need to make small, frequent updates to your Elastic Beanstalk software application and you want to avoid application downtime\. Setting this value to true automatically enables the `MaxBatchSize`, `MinInstancesInService`, and `PauseTime` options\. Setting any of those options also automatically sets the `RollingUpdateEnabled` option value to `true`\. Setting this option to `false` disables rolling updates\. If you use the Elastic Beanstalk console or EB CLI to create an environment, you can't set this option in a [configuration file](ebextensions.md)\. The console and EB CLI override this option with a [recommended value](command-options.md#configuration-options-recommendedvalues)\. | `false` | `true` `false` | | RollingUpdateType | Time\-based rolling updates apply a PauseTime between batches\. Health\-based rolling updates wait for new instances to pass health checks before moving on to the next batch\. [Immutable updates](environmentmgmt-updates-immutable.md) launch a full set of instances in a new AutoScaling group\. If you use the Elastic Beanstalk console or EB CLI to create an environment, you can't set this option in a [configuration file](ebextensions.md)\. The console and EB CLI override this option with a [recommended value](command-options.md#configuration-options-recommendedvalues)\. | `Time` | `Time` `Health` `Immutable` | | PauseTime | The amount of time the Elastic Beanstalk service will wait after it has completed updates to one batch of instances before it continues on to the next batch\. | Automatically computed based on instance type and container\. | `PT0S`\* $0 seconds$ to `PT1H` $1 hour$ | | Timeout | Maximum amount of time to wait for all instances in a batch of instances to pass health checks before canceling the update\. | `PT30M` $30 minutes$ | `PT5M`\* $5 minutes$ to `PT1H` $1 hour$ \*[ISO8601 duration](http://en.wikipedia.org/wiki/ISO_8601#Durations) format: `PT#H#M#S` where each \# is the number of hours, minutes, and/or seconds, respectively\. | ## aws:ec2:instances Configure your environment's instances, including Spot options\. This namespace complements [`aws:autoscaling:launchconfiguration`](#command-options-general-autoscalinglaunchconfiguration) and [`aws:autoscaling:asg`](#command-options-general-autoscalingasg)\. For more information, see [Auto Scaling group for your Elastic Beanstalk environment](using-features.managing.as.md)\. **Namespace: `aws:ec2:instances`** | **Name** | **Description** | **Default** | **Valid values** | | --- | --- | --- | --- | | EnableSpot | Enable Spot Instance requests for your environment\. When `false`, some options in this namespace don't take effect\. | `false` | `true` `false` | | InstanceTypes | A comma\-separated list of instance types you want your environment to use\. For example: `t2.micro,t3.micro` When Spot Instances are disabled $`EnableSpot` is `false`$, only the first instance type on the list is used\. The first instance type on the list in this option is equivalent to the value of the `InstanceType` option in the [`aws:autoscaling:launchconfiguration`](#command-options-general-autoscalinglaunchconfiguration) namespace\. The latter is obsolete, and we don't recommend using it\. If you specify both, the first instance type on the list in the `InstanceTypes` option is used, and `InstanceType` is ignored\. Some older AWS accounts might provide Elastic Beanstalk with default instance types that don't support Spot Instances $for example, t1\.micro$\. If you enable Spot Instance requests and you get an error about an instance type that doesn’t support Spot, be sure to configure instance types that support Spot\. To choose Spot Instance types, use the [Spot Instance Advisor](https://aws.amazon.com/ec2/spot/instance-advisor/)\. When you update your environment configuration and remove one or more instance types from the `InstanceTypes` option, Elastic Beanstalk terminates any Amazon EC2 instances running on any of the removed instance types\. Your environment's Auto Scaling group then launches new instances, as necessary to complete the desired capacity, using your current specified instance types\. | A list of two instance types\. Varies by account, region, and platform\. | `1` to `10` EC2 instance types $at least two recommended$ | | SpotFleetOnDemandBase | The minimum number of On\-Demand Instances that your Auto Scaling group provisions before considering Spot Instances as your environment scales up\. This option is relevant only when `EnableSpot` is `true`\. | `0` | `0` to `MaxSize` option in [`aws:autoscaling:asg`](#command-options-general-autoscalingasg) namespace | | SpotFleetOnDemandAboveBasePercentage | The percentage of On\-Demand Instances as part of additional capacity that your Auto Scaling group provisions beyond the `SpotOnDemandBase` instances\. This option is relevant only when `EnableSpot` is `true`\. | `0` for a Single Instance environment `70` for a Load Balanced environment | `0` to `100` | | SpotMaxPrice | The maximum price per unit hour, in US$, that you're willing to pay for a Spot Instance\. This option is relevant only when `EnableSpot` is `true`\. | On\-Demand price, per instance type\. The option's value in this case is `null`\. | `0.001` to `20.0` `null` | ## aws:ec2:vpc Configure your environment to launch resources in a custom [Amazon Virtual Private Cloud](https://docs.aws.amazon.com/vpc/latest/userguide/) $Amazon VPC$\. If you don't configure settings in this namespace, Elastic Beanstalk launches resources in the default VPC\. **Namespace: `aws:ec2:vpc`** | **Name** | **Description** | **Default** | **Valid values** | | --- | --- | --- | --- | | VPCId | The ID for your Amazon VPC\. | None | | | Subnets | The IDs of the Auto Scaling group subnet or subnets\. If you have multiple subnets, specify the value as a single comma\-delimited string of subnet IDs $for example, `"subnet-11111111,subnet-22222222"`$\. | None | | | ELBSubnets | The IDs of the subnet or subnets for the elastic load balancer\. If you have multiple subnets, specify the value as a single comma\-delimited string of subnet IDs $for example, `"subnet-11111111,subnet-22222222"`$\. | None | | | ELBScheme | Specify `internal` if you want to create an internal load balancer in your Amazon VPC so that your Elastic Beanstalk application cannot be accessed from outside your Amazon VPC\. If you specify a value other than `public` or `internal`, Elastic Beanstalk will ignore the value\. | `public` | `public` `internal` | | DBSubnets | Contains the IDs of the database subnets\. This is only used if you want to add an Amazon RDS DB Instance as part of your application\. If you have multiple subnets, specify the value as a single comma\-delimited string of subnet IDs $for example, `"subnet-11111111,subnet-22222222"`$\. | None | | | AssociatePublicIpAddress | Specifies whether to launch instances with public IP addresses in your Amazon VPC\. Instances with public IP addresses do not require a NAT device to communicate with the Internet\. You must set the value to `true` if you want to include your load balancer and instances in a single public subnet\. This option has no effect on a single\-instance environment, which always has a single Amazon EC2 instance with an Elastic IP address\. The option is relevant to load\-balancing, autoscaling environments\. | None | `true` `false` | ## aws:elasticbeanstalk:application Configure a health check path for your application\. For more information, see [Basic health reporting](using-features.healthstatus.md)\. **Namespace: `aws:elasticbeanstalk:application`** | **Name** | **Description** | **Default** | **Valid values** | | --- | --- | --- | --- | | Application Healthcheck URL | The path to which to send health check requests\. If not set, the load balancer attempts to make a TCP connection on port 80 to verify health\. Set to a path starting with `/` to send an HTTP GET request to that path\. You can also include a protocol $HTTP, HTTPS, TCP, or SSL$ and port prior to the path to check HTTPS connectivity or use a non\-default port\. If you use the Elastic Beanstalk console to create an environment, you can't set this option in a [configuration file](ebextensions.md)\. The console overrides this option with a [recommended value](command-options.md#configuration-options-recommendedvalues)\. | None | `/` $HTTP GET to root path$ `/health` `HTTPS:443/` `HTTPS:443/health` etc | The EB CLI and Elastic Beanstalk console apply recommended values for the preceding options\. You must remove these settings if you want to use configuration files to configure the same\. See [Recommended values](command-options.md#configuration-options-recommendedvalues) for details\. ## aws:elasticbeanstalk:application:environment Configure environment properties for your application\. **Namespace: `aws:elasticbeanstalk:application:environment`** | **Name** | **Description** | **Default** | **Valid values** | | --- | --- | --- | --- | | Any environment variable name\. | Pass in key\-value pairs\. | None | Any environment variable value\. | See [Environment properties and other software settings](environments-cfg-softwaresettings.md) for more information\. ## aws:elasticbeanstalk:cloudwatch:logs Configure instance log streaming for your application\. **Namespace: `aws:elasticbeanstalk:cloudwatch:logs`** | **Name** | **Description** | **Default** | **Valid values** | | --- | --- | --- | --- | | StreamLogs | Whether to create groups in CloudWatch Logs for proxy and deployment logs, and stream logs from each instance in your environment\. | `false` | `true` `false` | | DeleteOnTerminate | Whether to delete the log groups when the environment is terminated\. If `false`, the logs are kept `RetentionInDays` days\. | `false` | `true` `false` | | RetentionInDays | The number of days to keep log events before they expire\. | 7 | 1, 3, 5, 7, 14, 30, 60, 90, 120, 150, 180, 365, 400, 545, 731, 1827, 3653 | ## aws:elasticbeanstalk:cloudwatch:logs:health Configure environment health log streaming for your application\. **Namespace: `aws:elasticbeanstalk:cloudwatch:logs:health`** | **Name** | **Description** | **Default** | **Valid values** | | --- | --- | --- | --- | | HealthStreamingEnabled | For environments with enhanced health reporting enabled, whether to create a group in CloudWatch Logs for environment health and archive Elastic Beanstalk environment health data\. For information about enabling enhanced health, see [`aws:elasticbeanstalk:healthreporting:system`](#command-options-general-elasticbeanstalkhealthreporting)\. | `false` | `true` `false` | | DeleteOnTerminate | Whether to delete the log group when the environment is terminated\. If `false`, the health data is kept `RetentionInDays` days\. | `false` | `true` `false` | | RetentionInDays | The number of days to keep the archived health data before it expires\. | 7 | 1, 3, 5, 7, 14, 30, 60, 90, 120, 150, 180, 365, 400, 545, 731, 1827, 3653 | ## aws:elasticbeanstalk:command Configure the deployment policy for your application code\. For more information, see [Deployment policies and settings](using-features.rolling-version-deploy.md)\. **Namespace: `aws:elasticbeanstalk:command`** | **Name** | **Description** | **Default** | **Valid values** | | --- | --- | --- | --- | | DeploymentPolicy | Choose a [deployment policy](using-features.rolling-version-deploy.md) for application version deployments\. If you use the Elastic Beanstalk console to create an environment, you can't set this option in a [configuration file](ebextensions.md)\. The console overrides this option with a [recommended value](command-options.md#configuration-options-recommendedvalues)\. | `AllAtOnce` | `AllAtOnce` `Rolling` `RollingWithAdditionalBatch` `Immutable` `TrafficSplitting` | | Timeout | Number of seconds to wait for an instance to complete executing commands\. Elastic Beanstalk internally adds 240 seconds $four minutes$ to the `Timeout` value\. For example, the effective timeout by default is 840 seconds $600 \+ 240$, or 14 minutes\. | `600` | `1` to `3600` | | BatchSizeType | The type of number that is specified in **BatchSize**\. If you use the Elastic Beanstalk console or EB CLI to create an environment, you can't set this option in a [configuration file](ebextensions.md)\. The console and EB CLI override this option with a [recommended value](command-options.md#configuration-options-recommendedvalues)\. | `Percentage` | `Percentage` `Fixed` | | BatchSize | Percentage or fixed number of Amazon EC2 instances in the Auto Scaling group on which to simultaneously perform deployments\. Valid values vary per **BatchSizeType** setting\. If you use the Elastic Beanstalk console or EB CLI to create an environment, you can't set this option in a [configuration file](ebextensions.md)\. The console and EB CLI override this option with a [recommended value](command-options.md#configuration-options-recommendedvalues)\. | `100` | `1` to `100` $`Percentage`$\. `1` to [aws:autoscaling:asg::MaxSize](#command-options-general-autoscalingasg) $`Fixed`$ | | IgnoreHealthCheck | Do not cancel a deployment due to failed health checks\. | false | `true` `false` | ## aws:elasticbeanstalk:environment Configure your environment's architecture and service role\. **Namespace: `aws:elasticbeanstalk:environment`** | **Name** | **Description** | **Default** | **Valid values** | | --- | --- | --- | --- | | EnvironmentType | Set to `SingleInstance` to launch one EC2 instance with no load balancer\. | `LoadBalanced` | `SingleInstance` `LoadBalanced` | | ServiceRole | The name of an IAM role that Elastic Beanstalk uses to manage resources for the environment\. Specify a role name $optionally prefixed with a custom path$ or its ARN\. Examples: [\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/elasticbeanstalk/latest/dg/command-options-general.html) If you use the Elastic Beanstalk console or EB CLI to create an environment, you can't set this option in a [configuration file](ebextensions.md)\. The console and EB CLI override this option with a [recommended value](command-options.md#configuration-options-recommendedvalues)\. | None | IAM role name, path/name, or ARN | | LoadBalancerType | The type of load balancer for your environment\. | `classic` | `classic` `application` `network` | ## aws:elasticbeanstalk:environment:process:default Configure your environment's default process\. **Namespace: `aws:elasticbeanstalk:environment:process:default`** | **Name** | **Description** | **Default** | **Valid values** | | --- | --- | --- | --- | | DeregistrationDelay | Time, in seconds, to wait for active requests to complete before deregistering\. | `20` | `0` to `3600` | | HealthCheckInterval | The interval, in seconds, at which Elastic Load Balancing will check the health of your application's Amazon EC2 instances\. | With classic or application load balancer: `15` With network load balancer: `30` | With classic or application load balancer: `5` to `300` With network load balancer: `10`, `30` | | HealthCheckPath | Path to which to send HTTP requests for health checks\. | `/` | A routable path\. | | HealthCheckTimeout | Time, in seconds, to wait for a response during a health check\. This option is only applicable to environments with an application load balancer\. | `5` | `1` to `60` | | HealthyThresholdCount | Consecutive successful requests before Elastic Load Balancing changes the instance health status\. | With classic or application load balancer: `3` With network load balancer: `5` | `2` to `10` | | MatcherHTTPCode | A comma\-separated list of HTTP code$s$ that indicate that an instance is healthy\. This option is only applicable to environments with a network or application load balancer\. | `200` | With application load balancer: `200` to `499` With network load balancer: `200` to `399` | | Port | Port on which the process listens\. | `80` | `1` to `65535` | | Protocol | Protocol that the process uses\. With an application load balancer, you can only set this option to `HTTP` or `HTTPS`\. With a network load balancer, you can only set this option to `TCP`\. | With classic or application load balancer: `HTTP` With network load balancer: `TCP` | `TCP` `HTTP` `HTTPS` | | StickinessEnabled | Set to true to enable sticky sessions\. This option is only applicable to environments with an application load balancer\. | `'false'` | `'false'` `'true'` | | StickinessLBCookieDuration | Lifetime, in seconds, of the sticky session cookie\. This option is only applicable to environments with an application load balancer\. | `86400` $one day$ | `1` to `604800` | | StickinessType | Set to `lb_cookie` to use cookies for sticky sessions\. This option is only applicable to environments with an application load balancer\. | `lb_cookie` | `lb_cookie` | | UnhealthyThresholdCount | Consecutive unsuccessful requests before Elastic Load Balancing changes the instance health status\. | `5` | `2` to `10` | ## aws:elasticbeanstalk:environment:process:process\_name Configure additional processes for your environment\. **Namespace: `aws:elasticbeanstalk:environment:process:process_name`** | **Name** | **Description** | **Default** | **Valid values** | | --- | --- | --- | --- | | DeregistrationDelay | Time, in seconds, to wait for active requests to complete before deregistering\. | `20` | `0` to `3600` | | HealthCheckInterval | The interval, in seconds, at which Elastic Load Balancing will check the health of your application's Amazon EC2 instances\. | With classic or application load balancer: `15` With network load balancer: `30` | With classic or application load balancer: `5` to `300` With network load balancer: `10`, `30` | | HealthCheckPath | Path to which to send HTTP requests for health checks\. | `/` | A routable path\. | | HealthCheckTimeout | Time, in seconds, to wait for a response during a health check\. This option is only applicable to environments with an application load balancer\. | `5` | `1` to `60` | | HealthyThresholdCount | Consecutive successful requests before Elastic Load Balancing changes the instance health status\. | With classic or application load balancer: `3` With network load balancer: `5` | `2` to `10` | | MatcherHTTPCode | A comma\-separated list of HTTP code$s$ that indicate that an instance is healthy\. This option is only applicable to environments with a network or application load balancer\. | `200` | With application load balancer: `200` to `499` With network load balancer: `200` to `399` | | Port | Port on which the process listens\. | `80` | `1` to `65535` | | Protocol | Protocol that the process uses\. With an application load balancer, you can only set this option to `HTTP` or `HTTPS`\. With a network load balancer, you can only set this option to `TCP`\. | With classic or application load balancer: `HTTP` With network load balancer: `TCP` | `TCP` `HTTP` `HTTPS` | | StickinessEnabled | Set to true to enable sticky sessions\. This option is only applicable to environments with an application load balancer\. | `'false'` | `'false'` `'true'` | | StickinessLBCookieDuration | Lifetime, in seconds, of the sticky session cookie\. This option is only applicable to environments with an application load balancer\. | `86400` $one day$ | `1` to `604800` | | StickinessType | Set to `lb_cookie` to use cookies for sticky sessions\. This option is only applicable to environments with an application load balancer\. | `lb_cookie` | `lb_cookie` | | UnhealthyThresholdCount | Consecutive unsuccessful requests before Elastic Load Balancing changes the instance health status\. | `5` | `2` to `10` | ## aws:elasticbeanstalk:environment:proxy:staticfiles You can use the following namespace to configure the proxy server to serve static files\. When the proxy server receives a request for a file under the specified path, it serves the file directly instead of routing the request to your application\. This reduces the number of requests that your application has to process\. Map a path served by the proxy server to a folder in your source code that contains static assets\. Each option that you define in this namespace maps a different path\. **Note** This namespace applies to platform branches based on Amazon Linux 2\. If your environment uses a platform version based on Amazon Linux AMI $preceding Amazon Linux 2$, refer to [Platform specific options](command-options-specific.md) for platform\-specific static file namespaces\. **Namespace: `aws:elasticbeanstalk:environment:proxy:staticfiles`** | **Name** | **Value** | | --- | --- | | Path where the proxy server will serve the files\. Start the value with `/`\. Example: Specify `/images` to serve files at `subdomain.eleasticbeanstalk.com/images`\. | Name of the folder containing the files\. Example: Specify `staticimages` to serve files from a folder named `staticimages` at the top level of your source bundle\. | ## aws:elasticbeanstalk:healthreporting:system Configure enhanced health reporting for your environment\. **Namespace: `aws:elasticbeanstalk:healthreporting:system`** | **Name** | **Description** | **Default** | **Valid values** | | --- | --- | --- | --- | | SystemType | Health reporting system $[basic](using-features.healthstatus.md) or [enhanced](health-enhanced.md)$\. Enhanced health reporting requires a [service role](concepts-roles-service.md) and a version 2 or newer [platform version](concepts.platforms.md)\. If you use the Elastic Beanstalk console or EB CLI to create an environment, you can't set this option in a [configuration file](ebextensions.md)\. The console and EB CLI override this option with a [recommended value](command-options.md#configuration-options-recommendedvalues)\. | `basic` | `basic` `enhanced` | | ConfigDocument | A JSON document describing the environment and instance metrics to publish to CloudWatch\. | None | | | HealthCheckSuccessThreshold | Lower the threshold for instances to pass health checks\. If you use the Elastic Beanstalk console to create an environment, you can't set this option in a [configuration file](ebextensions.md)\. The console overrides this option with a [recommended value](command-options.md#configuration-options-recommendedvalues)\. | `Ok` | `Ok` `Warning` `Degraded` `Severe` | ## aws:elasticbeanstalk:hostmanager Configure the EC2 instances in your environment to upload rotated logs to Amazon S3\. **Namespace: `aws:elasticbeanstalk:hostmanager`** | **Name** | **Description** | **Default** | proxy:staticfiles **Valid values** | | --- | --- | --- | --- | | LogPublicationControl | Copy the log files for your application's Amazon EC2 instances to the Amazon S3 bucket associated with your application\. | `false` | `true` `false` | ## aws:elasticbeanstalk:managedactions Configure managed platform updates for your environment\. **Namespace: `aws:elasticbeanstalk:managedactions`** | **Name** | **Description** | **Default** | **Valid values** | | --- | --- | --- | --- | | ManagedActionsEnabled | Enable [managed platform updates](environment-platform-update-managed.md#environment-platform-update-managed-namespace)\. When you set this to `true`, you must also specify a `PreferredStartTime` and `UpdateLevel`\. | `true` | `true` `false` | | PreferredStartTime | Configure a maintenance window for managed actions in UTC\. For example, `"Tue:09:00"`\. | None | Day and time in *day*:*hour*:*minute* format\. | | ServiceRoleForManagedUpdates | The name of an IAM role that Elastic Beanstalk uses to perform managed platform updates for your environment\. You can use either the same role that you specified for the `ServiceRole` option of the `aws:elasticbeanstalk:environment` namespace, or your account's [managed updates service\-linked role](using-service-linked-roles-managedupdates.md)\. In the latter case, if the account doesn't have a managed\-updates service\-linked role yet, Elastic Beanstalk creates it\. | None | Same as `ServiceRole` or `AWSServiceRoleForElasticBeanstalkManagedUpdates` | ## aws:elasticbeanstalk:managedactions:platformupdate Configure managed platform updates for your environment\. **Namespace: `aws:elasticbeanstalk:managedactions:platformupdate`** | **Name** | **Description** | **Default** | **Valid values** | | --- | --- | --- | --- | | UpdateLevel | The highest level of update to apply with managed platform updates\. Platforms are versioned *major*\.*minor*\.*patch*\. For example, 2\.0\.8 has a major version of 2, a minor version of 0, and a patch version of 8\. | None | `patch` for patch version updates only\. `minor` for both minor and patch version updates\. | | InstanceRefreshEnabled | Enable weekly instance replacement\. Requires `ManagedActionsEnabled` to be set to `true`\. | false | `true` `false` | ## aws:elasticbeanstalk:monitoring Configure your environment to terminate EC2 instances that fail health checks\. **Namespace: `aws:elasticbeanstalk:monitoring`** | **Name** | **Description** | **Default** | **Valid values** | | --- | --- | --- | --- | | Automatically Terminate Unhealthy Instances | Terminate an instance if it fails health checks\. This option was only supported on [legacy environments](using-features.migration.md)\. It determined the health of an instance based on being able to reach it and on other instance\-based metrics\. Elastic Beanstalk doesn't provide a way to automatically terminate instances based on application health\. | `true` | `true` `false` | ## aws:elasticbeanstalk:sns:topics Configure notifications for your environment\. **Namespace: `aws:elasticbeanstalk:sns:topics`** | **Name** | **Description** | **Default** | **Valid values** | | --- | --- | --- | --- | | Notification Endpoint | Endpoint where you want to be notified of important events affecting your application\. If you use the Elastic Beanstalk console to create an environment, you can't set this option in a [configuration file](ebextensions.md)\. The console overrides this option with a [recommended value](command-options.md#configuration-options-recommendedvalues)\. | None | | | Notification Protocol | Protocol used to send notifications to your endpoint\. | `email` | `http` `https` `email` `email-json` `sqs` | | Notification Topic ARN | Amazon Resource Name for the topic you subscribed to\. | None | | | Notification Topic Name | Name of the topic you subscribed to\. | None | | ## aws:elasticbeanstalk:sqsd Configure the Amazon SQS queue for a worker environment\. **Namespace: `aws:elasticbeanstalk:sqsd`** | **Name** | **Description** | **Default** | **Valid values** | | --- | --- | --- | --- | | WorkerQueueURL | The URL of the queue from which the daemon in the worker environment tier reads messages When you don't specify a value, the queue that Elastic Beanstalk automatically creates is a [standard](https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/standard-queues.html) Amazon SQS queue\. When you provide a value, you can provide the URL of either a standard or a [FIFO](https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/FIFO-queues.html) Amazon SQS queue\. Be aware that if you provide a FIFO queue, [periodic tasks](using-features-managing-env-tiers.md#worker-periodictasks) aren't supported\. | automatically generated | If you don't specify a value, then Elastic Beanstalk automatically creates a queue\. | | HttpPath | The relative path to the application to which HTTP POST messages are sent | / | | | MimeType | The MIME type of the message sent in the HTTP POST request | `application/json` | `application/json` `application/x-www-form-urlencoded` `application/xml` `text/plain` Custom MIME type\. | | HttpConnections | The maximum number of concurrent connections to any application$s$ within an Amazon EC2 instance If you use the Elastic Beanstalk console to create an environment, you can't set this option in a [configuration file](ebextensions.md)\. The console overrides this option with a [recommended value](command-options.md#configuration-options-recommendedvalues)\. | `50` | `1` to `100` | | ConnectTimeout | The amount of time, in seconds, to wait for successful connections to an application | `5` | `1` to `60` | | InactivityTimeout | The amount of time, in seconds, to wait for a response on an existing connection to an applicationThe message is reprocessed until the daemon receives a 200 OK response from the application in the worker environment tier or the RetentionPeriod expires\. | `299` | `1` to `36000` | | VisibilityTimeout | The amount of time, in seconds, an incoming message from the Amazon SQS queue is locked for processing\. After the configured amount of time has passed, then the message is again made visible in the queue for any other daemon to read\. | 300 | `0` to `43200` | | ErrorVisibilityTimeout | The amount of time, in seconds, that elapses before Elastic Beanstalk returns a message to the Amazon SQS queue after a processing attempt fails with an explicit error\. | `2` seconds | `0` to `43200` seconds | | RetentionPeriod | The amount of time, in seconds, a message is valid and will be actively processed | `345600` | `60` to `1209600` | | MaxRetries | The maximum number of attempts that Elastic Beanstalk attempts to send the message to the web application that will process it before moving the message to the dead\-letter queue\. | `10` | `1` to `100` | ## aws:elasticbeanstalk:trafficsplitting Configure traffic\-splitting deployments for your environment\. This namespace applies when you set the `DeploymentPolicy` option of the [aws:elasticbeanstalk:command](#command-options-general-elasticbeanstalkcommand) namespace to `TrafficSplitting`\. For more information about deployment policies, see [Deployment policies and settings](using-features.rolling-version-deploy.md)\. **Namespace: `aws:elasticbeanstalk:trafficsplitting`** | **Name** | **Description** | **Default** | **Valid values** | | --- | --- | --- | --- | | NewVersionPercent | The initial percentage of incoming client traffic that Elastic Beanstalk shifts to environment instances running the new application version you're deploying\. | `10` | `1` to `100` | | EvaluationTime | The time period, in minutes, that Elastic Beanstalk waits after an initial healthy deployment before proceeding to shift all incoming client traffic to the new application version that you're deploying\. | `5` | `3` to `600` | ## aws:elasticbeanstalk:xray Run the AWS X\-Ray daemon to relay trace information from your [X\-Ray integrated](environment-configuration-debugging.md) application\. **Namespace: `aws:elasticbeanstalk:xray`** | **Name** | **Description** | **Default** | **Valid values** | | --- | --- | --- | --- | | `XRayEnabled` | Set to `true` to run the X\-Ray daemon on the instances in your environment\. | `false` | `true` `false` | ## aws:elb:healthcheck Configure healthchecks for a classic load balancer\. **Namespace: `aws:elb:healthcheck`** | **Name** | **Description** | **Default** | **Valid values** | | --- | --- | --- | --- | | HealthyThreshold | Consecutive successful requests before Elastic Load Balancing changes the instance health status\. | `3` | `2` to `10` | | Interval | The interval at which Elastic Load Balancing will check the health of your application's Amazon EC2 instances\. | `10` | `5` to `300` | | Timeout | Number of seconds Elastic Load Balancing will wait for a response before it considers the instance nonresponsive\. | `5` | `2` to `60` | | UnhealthyThreshold | Consecutive unsuccessful requests before Elastic Load Balancing changes the instance health status\. | `5` | `2` to `10` | | $deprecated$ Target | Destination on backend instance to which to send health checks\. Use `Application Healthcheck URL` in the [`aws:elasticbeanstalk:application`](#command-options-general-elasticbeanstalkapplication) namespace instead\. | `TCP:80` | Target in the format *PROTOCOL*:*PORT**/PATH* | ## aws:elb:loadbalancer Configure your environment's classic load balancer\. Several of the options in this namespace have been deprecated in favor of listener\-specific options in the [aws:elb:listener](#command-options-general-elblistener) namespace\. The deprecated options only let you configure two listeners $one secure and one unsecure$ on standard ports\. **Namespace: `aws:elb:loadbalancer`** | Name | Description | Default | Valid values | | --- | --- | --- | --- | | CrossZone | Configure the load balancer to route traffic evenly across all instances in all Availability Zones rather than only within each zone\. If you use the Elastic Beanstalk console or EB CLI to create an environment, you can't set this option in a [configuration file](ebextensions.md)\. The console and EB CLI override this option with a [recommended value](command-options.md#configuration-options-recommendedvalues)\. | `false` | `true` `false` | | SecurityGroups | Assign one or more security groups that you created to the load balancer\. | None | One or more security group IDs\. | | ManagedSecurityGroup | Assign an existing security group to your environment’s load balancer, instead of creating a new one\. To use this setting, update the `SecurityGroups` setting in this namespace to include your security group’s ID, and remove the automatically created security group’s ID, if one exists\. To allow traffic from the load balancer to your environment’s EC2 instances, Elastic Beanstalk adds a rule to the instances’ security group that allows inbound traffic from the managed security group\. | None | A security group ID\. | | $deprecated$ LoadBalancerHTTPPort | Port to listen on for the unsecure listener\. | `80` | `OFF` `80` | | $deprecated$ LoadBalancerPortProtocol | Protocol to use on the unsecure listener\. | `HTTP` | `HTTP` `TCP` | | $deprecated$ LoadBalancerHTTPSPort | Port to listen on for the secure listener\. | `OFF` | `OFF` `443` `8443` | | $deprecated$ LoadBalancerSSLPortProtocol | Protocol to use on the secure listener\. | `HTTPS` | `HTTPS` `SSL` | | $deprecated$ SSLCertificateId | ARN of an SSL certificate to bind to the secure listener\. | None | | ## aws:elb:listener Configure the default listener $port 80$ on a classic load balancer\. **Namespace: `aws:elb:listener`** | Name | Description | Default | Valid values | | --- | --- | --- | --- | | ListenerProtocol | The protocol used by the listener\. | HTTP | HTTP TCP | | InstancePort | The port that this listener uses to communicate with the EC2 instances\. | 80 | 1 to 65535 | | InstanceProtocol | The protocol that this listener uses to communicate with the EC2 instances\. It must be at the same internet protocol layer as the `ListenerProtocol`\. It also must have the same security level as any other listener using the same `InstancePort` as this listener\. For example, if `ListenerProtocol` is `HTTPS` $application layer, using a secure connection$, you can set `InstanceProtocol` to `HTTP` $also at the application layer, using an insecure connection$\. If, in addition, you set `InstancePort` to `80`, you must set `InstanceProtocol` to `HTTP` in all other listeners with `InstancePort` set to `80`\. | `HTTP` when `ListenerProtocol` is `HTTP` `TCP` when `ListenerProtocol` is `TCP` | HTTP or HTTPS when ListenerProtocol is HTTP or HTTPS `TCP` or `SSL` when `ListenerProtocol` is `TCP` or `SSL` | | PolicyNames | A comma\-separated list of policy names to apply to the port for this listener\. We suggest that you use the LoadBalancerPorts option of the [aws:elb:policies](#command-options-general-elbpolicies) namespace instead\. | None | | | ListenerEnabled | Specifies whether this listener is enabled\. If you specify false, the listener is not included in the load balancer\. | true | `true` `false` | ## aws:elb:listener:listener\_port Configure additional listeners on a classic load balancer\. **Namespace: `aws:elb:listener:listener_port`** | Name | Description | Default | Valid values | | --- | --- | --- | --- | | ListenerProtocol | The protocol used by the listener\. | HTTP | HTTP HTTPS TCP SSL | | InstancePort | The port that this listener uses to communicate with the EC2 instances\. | The same as listener\_port\. | 1 to 65535 | | InstanceProtocol | The protocol that this listener uses to communicate with the EC2 instances\. It must be at the same internet protocol layer as the `ListenerProtocol`\. It also must have the same security level as any other listener using the same `InstancePort` as this listener\. For example, if `ListenerProtocol` is `HTTPS` $application layer, using a secure connection$, you can set `InstanceProtocol` to `HTTP` $also at the application layer, using an insecure connection$\. If, in addition, you set `InstancePort` to `80`, you must set `InstanceProtocol` to `HTTP` in all other listeners with `InstancePort` set to `80`\. | `HTTP` when `ListenerProtocol` is `HTTP` or `HTTPS` `TCP` when `ListenerProtocol` is `TCP` or `SSL` | HTTP or HTTPS when ListenerProtocol is HTTP or HTTPS `TCP` or `SSL` when `ListenerProtocol` is `TCP` or `SSL` | | PolicyNames | A comma\-separated list of policy names to apply to the port for this listener\. We suggest that you use the LoadBalancerPorts option of the [aws:elb:policies](#command-options-general-elbpolicies) namespace instead\. | None | | | SSLCertificateId | ARN of an SSL certificate to bind to the listener\. | None | | | ListenerEnabled | Specifies whether this listener is enabled\. If you specify false, the listener is not included in the load balancer\. | true if any other option is set\. false otherwise\. | true false | ## aws:elb:policies Modify the default stickiness and global load balancer policies for a classic load balancer\. **Namespace: `aws:elb:policies`** | **Name** | **Description** | **Default** | **Valid values** | | --- | --- | --- | --- | | ConnectionDrainingEnabled | Specifies whether the load balancer maintains existing connections to instances that have become unhealthy or deregistered to complete in\-progress requests\. If you use the Elastic Beanstalk console or EB CLI to create an environment, you can't set this option in a [configuration file](ebextensions.md)\. The console and EB CLI override this option with a [recommended value](command-options.md#configuration-options-recommendedvalues)\. | `false` | `true` `false` | | ConnectionDrainingTimeout | The maximum number of seconds that the load balancer maintains existing connections to an instance during connection draining before forcibly closing the connections\. If you use the Elastic Beanstalk console to create an environment, you can't set this option in a [configuration file](ebextensions.md)\. The console overrides this option with a [recommended value](command-options.md#configuration-options-recommendedvalues)\. | `20` | `1` to `3600` | | ConnectionSettingIdleTimeout | Number of seconds that the load balancer waits for any data to be sent or received over the connection\. If no data has been sent or received after this time period elapses, the load balancer closes the connection\. | `60` | `1` to `3600` | | LoadBalancerPorts | A comma\-separated list of the listener ports that the default policy $`AWSEB-ELB-StickinessPolicy`$ applies to\. | None | You can use :all to indicate all listener ports | | Stickiness Cookie Expiration | The amount of time, in seconds, that each cookie is valid\. Uses the default policy $`AWSEB-ELB-StickinessPolicy`$ \. | `0` | `0` to `1000000` | | Stickiness Policy | Binds a user's session to a specific server instance so that all requests coming from the user during the session are sent to the same server instance\. Uses the default policy $`AWSEB-ELB-StickinessPolicy`$ \. | `false` | true false | ## aws:elb:policies:policy\_name Create additional load balancer policies for a classic load balancer\. **Namespace: `aws:elb:policies:policy_name`** | **Name** | **Description** | **Default** | **Valid values** | | --- | --- | --- | --- | | CookieName | The name of the application\-generated cookie that controls the session lifetimes of a AppCookieStickinessPolicyType policy\. This policy can be associated only with HTTP/HTTPS listeners\. | None | | | InstancePorts | A comma\-separated list of the instance ports that this policy applies to\. | None | A list of ports, or :all | | LoadBalancerPorts | A comma\-separated list of the listener ports that this policy applies to\. | None | A list of ports, or :all | | ProxyProtocol | For a `ProxyProtocolPolicyType` policy, specifies whether to include the IP address and port of the originating request for TCP messages\. This policy can be associated only with TCP/SSL listeners\. | None | true false | | PublicKey | The contents of a public key for a `PublicKeyPolicyType` policy to use when authenticating the back\-end server or servers\. This policy cannot be applied directly to back\-end servers or listeners; it must be part of a `BackendServerAuthenticationPolicyType` policy\. | None | | | PublicKeyPolicyNames | A comma\-separated list of policy names $from the `PublicKeyPolicyType` policies$ for a `BackendServerAuthenticationPolicyType` policy that controls authentication to a back\-end server or servers\. This policy can be associated only with back\-end servers that are using HTTPS/SSL\. | None | | | SSLProtocols | A comma\-separated list of SSL protocols to be enabled for a `SSLNegotiationPolicyType` policy that defines the ciphers and protocols that will be accepted by the load balancer\. This policy can be associated only with HTTPS/SSL listeners\. | None | | | SSLReferencePolicy | The name of a predefined security policy that adheres to AWS security best practices and that you want to enable for a `SSLNegotiationPolicyType` policy that defines the ciphers and protocols that will be accepted by the load balancer\. This policy can be associated only with HTTPS/SSL listeners\. | None | | | Stickiness Cookie Expiration | The amount of time, in seconds, that each cookie is valid\. | `0` | `0` to `1000000` | | Stickiness Policy | Binds a user's session to a specific server instance so that all requests coming from the user during the session are sent to the same server instance\. | `false` | true false | ## aws:elbv2:listener:default Configure the default listener $port 80$ on an application load balancer or a network load balancer\. **Namespace: `aws:elbv2:listener:default`** | **Name** | **Description** | **Default** | **Valid values** | | --- | --- | --- | --- | | DefaultProcess | Name of the [process](#command-options-general-environmentprocess) to which to forward traffic when no rules match\. | `default` | A process name\. | | ListenerEnabled | Set to `false` to disable the listener\. You can use this option to disable the default listener on port 80\. | `true` | `true` `false` | | Protocol | Protocol of traffic to process\. | With application load balancer: `HTTP` With network load balancer: `TCP` | With application load balancer: `HTTP`, `HTTPS` With network load balancer: `TCP` | | Rules | List of [rules](#command-options-general-elbv2-listenerrule) to apply to the listener This option is only applicable to environments with an application load balancer\. | None | Comma separated list of rule names\. | | SSLCertificateArns | The ARN of the SSL certificate to bind to the listener\. This option is only applicable to environments with an application load balancer\. | None | The ARN of a certificate stored in IAM or ACM\. | | SSLPolicy | Specify a security policy to apply to the listener\. This option is only applicable to environments with an application load balancer\. | None $ELB default$ | The name of a load balancer security policy\. | ## aws:elbv2:listener:listener\_port Configure additional listeners on an application load balancer or a network load balancer\. **Namespace: `aws:elbv2:listener:listener_port`** | **Name** | **Description** | **Default** | **Valid values** | | --- | --- | --- | --- | | DefaultProcess | Name of the [process](#command-options-general-environmentprocess) where traffic is forwarded when no rules match\. | `default` | A process name\. | | ListenerEnabled | Set to `false` to disable the listener\. You can use this option to disable the default listener on port 80\. | `true` | `true` `false` | | Protocol | Protocol of traffic to process\. | With application load balancer: `HTTP` With network load balancer: `TCP` | With application load balancer: `HTTP`, `HTTPS` With network load balancer: `TCP` | | Rules | List of [rules](#command-options-general-elbv2-listenerrule) to apply to the listener This option is only applicable to environments with an application load balancer\. | None | Comma separated list of rule names\. | | SSLCertificateArns | The ARN of the SSL certificate to bind to the listener\. This option is only applicable to environments with an application load balancer\. | None | The ARN of a certificate stored in IAM or ACM\. | | SSLPolicy | Specify a security policy to apply to the listener\. This option is only applicable to environments with an application load balancer\. | None $ELB default$ | The name of a load balancer security policy\. | ## aws:elbv2:listenerrule:rule\_name Define listener rules for an application load balancer\. If a request matches the host names or paths in a rule, the load balancer forwards it to the specified process\. To use a rule, add it to a listener with the `Rules` option in the [`aws:elbv2:listener:listener_port`](#command-options-general-elbv2-listener) namespace\. **Note** This namespace isn't applicable to environments with a network load balancer\. **Namespace: `aws:elbv2:listenerrule:rule_name`** | **Name** | **Description** | **Default** | **Valid values** | | --- | --- | --- | --- | | HostHeaders | List of host names to match\. For example, `my.example.com`\. | None | Each name can have up to 128 characters $A\-Z, a\-z, 0\-9, –$ and can include up to three wildcard characters $`*` matches zero or more characters; `?` matches exactly one character$\. You can add multiple comma\-separated names\. | | PathPatterns | Path patterns to match\. For example, `/img/*`\. This option is only applicable to environments with an application load balancer\. | None | Each pattern can have up to 128 characters $A\-Z, a\-z, 0\-9, –$ and can include up to three wildcard characters $`*` matches zero or more characters; `?` matches exactly one character$\. You can add multiple comma\-separated path patterns\. | | Priority | Precedence of this rule when multiple rules match\. The lower number takes precedence\. No two rules can have the same priority\. | `1` | `1` to `1000` | | Process | Name of the [process](#command-options-general-environmentprocess) to which to forward traffic when this rule matches the request\. | `default` | A process name\. | ## aws:elbv2:loadbalancer Configure an application load balancer\. **Note** This namespace isn't applicable to environments with a network load balancer\. **Namespace: `aws:elbv2:loadbalancer`** | **Name** | **Description** | **Default** | **Valid values** | | --- | --- | --- | --- | | AccessLogsS3Bucket | Amazon S3 bucket in which to store access logs\. The bucket must be in the same region as the environment and allow the load balancer write access\. | None | A bucket name\. | | AccessLogsS3Enabled | Enable access log storage\. | `false` | `true` `false` | | AccessLogsS3Prefix | Prefix to prepend to access log names\. By default, the load balancer uploads logs to a directory named AWSLogs in the bucket you specify\. Specify a prefix to place the AWSLogs directory inside another directory\. | None | | | IdleTimeout | Time to wait for a request to complete before closing connections to client and instance\. | None | `1` to `3600` | | ManagedSecurityGroup | Assign an existing security group to your environment’s load balancer, instead of creating a new one\. To use this setting, update the `SecurityGroups` setting in this namespace to include your security group’s ID, and remove the automatically created security group’s ID, if one exists\. To allow traffic from the load balancer to your environment’s EC2 instances, Elastic Beanstalk adds a rule to the instances’ security group that allows inbound traffic from the managed security group\. | The security group that Elastic Beanstalks creates for your load balancer\. | A security group ID\. | | SecurityGroups | List of security groups to attach to the load balancer\. | The security group that Elastic Beanstalks creates for your load balancer\. | Comma separated list of security group IDs\. | ## aws:rds:dbinstance Configure an attached Amazon RDS DB instance\. **Namespace: `aws:rds:dbinstance`** | **Name** | **Description** | **Default** | **Valid values** | | --- | --- | --- | --- | | DBAllocatedStorage | The allocated database storage size, specified in gigabytes\. | MySQL: `5` Oracle: `10` sqlserver\-se: `200` sqlserver\-ex: `30` sqlserver\-web: `30` | MySQL: `5`\-`1024` Oracle: `10`\-`1024` sqlserver: cannot be modified | | DBDeletionPolicy | Decides whether to delete or snapshot the DB instance on environment termination\. Deleting a DB instance results in permanent data loss\. | `Delete` | `Delete` `Snapshot` | | DBEngine | The name of the database engine to use for this instance\. | `mysql` | `mysql` `oracle-se1` `sqlserver-ex` `sqlserver-web` `sqlserver-se` `postgres` | | DBEngineVersion | The version number of the database engine\. | `5.5` | | | DBInstanceClass | The database instance type\. | `db.t2.micro` $`db.m1.large` for an environment not running in an Amazon VPC$ | Go to [DB Instance Class](http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Concepts.DBInstanceClass.html) in the * Amazon Relational Database Service User Guide*\. | | DBPassword | The name of master user password for the database instance\. | None | | | DBSnapshotIdentifier | The identifier for the DB snapshot to restore from\. | None | | | DBUser | The name of master user for the DB Instance\. | ebroot | | | MultiAZDatabase | Specifies whether a database instance Multi\-AZ deployment needs to be created\. For more information about Multi\-AZ deployments with Amazon Relational Database Service $RDS$, go to [Regions and Availability Zones](http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Concepts.RegionsAndAvailabilityZones.html) in the * Amazon Relational Database Service User Guide*\. | `false` | `true` `false` |