Menu
AWS Elastic Beanstalk
Developer Guide (API Version 2010-12-01)

General Options for All Environments

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 to prevent Auto Scaling from initiating additional scaling activities before the effects of previous activities are visible.

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 EC2 instances.

Namespace: aws:autoscaling:launchconfiguration

Name Description Default Valid Values

EC2KeyName

A key pair enables you to securely log into your EC2 instance.

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 profile name or the ARN.

Example: ElasticBeanstalkProfile

Example: arn:aws:iam::123456789012:instance-profile/ElasticBeanstalkProfile

None

ImageId

You can override the default Amazon Machine Image (AMI) by specifying your own custom AMI ID.

Example: ami-cbab67a2

None

InstanceType

The instance type used to run your application in an Elastic Beanstalk environment.

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 action in the API, describe-configuration-options command in the AWS 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"

t1.micro

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. If you use Amazon VPC with Elastic Beanstalk so that your instances are launched within a virtual private cloud (VPC), specify security group IDs instead of a security group name.

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

protocol

The protocol for the ingress rule.

fromPort

The starting port number.

toPort

The ending port number.

source_restriction

The CIDR range or the name of a security group to allow traffic from. To specify a security group from another account (EC2-Classic only, must be in the same region), include the account ID prior to the security group name (e.g., other_account_id/security_group_name).

Example: tcp, 22, 22, 54.240.196.185/32

Example: tcp, 22, 22, my-security-group

Example (EC2-Classic): tcp, 22, 22, 0123456789012/their-security-group

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:

  • snapshot ID

  • size, in GB

  • delete on terminate (true or false)

  • storage type (gp2, standard, st1, sc1, or io1)

  • IOPS (only for io1 volumes).

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 privisioned 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 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 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 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, the 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 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

1 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 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.

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

Period

Specifies how frequently Amazon CloudWatch measures the metrics for your trigger.

5

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.

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 launch a full set of instances in a new AutoScaling group.

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 format: PT#H#M#S where each # is the number of hours, minutes, and/or seconds, respectively.

aws:ec2:vpc

Configure your environment to launch resources in a custom 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 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 VPC so that your Elastic Beanstalk application cannot be accessed from outside your VPC.

None

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 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.

None

true

false

aws:elasticbeanstalk:application

Configure a health check path for your application.

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.

None

/ (HTTP GET to root path)

/health

HTTPS:443/

HTTPS:443/health

etc

EB CLI and Elastic Beanstalk console apply recommended values for the preceding options. These settings must be removed if you want to use configuration files to configure the same. See Recommended Values 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 for more information.

aws:elasticbeanstalk:cloudwatch:logs

Configure 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 RetentionDays 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:command

Configure rolling deployments for your application code.

Namespace: aws:elasticbeanstalk:command

Name Description Default Valid Values

DeploymentPolicy

Choose a deployment policy for application version deployments.

AllAtOnce

AllAtOnce

Rolling

RollingWithAdditionalBatch

Immutable

Timeout

Number of seconds to wait for an instance to complete executing commands.

"600"

"1" to "3600"

BatchSizeType

The type of number that is specified in BatchSize.

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.

100

1 to 100 (Percentage).

1 to aws:autoscaling:asg::MaxSize (Fixed)

IgnoreHealthCheck

Do not cancel a deployment due to failed health checks.

false

true

false

HealthCheckSuccessThreshold

Lower the threshold for instances to pass health checks.

Ok

Ok

Warning

Degraded

Severe

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.

For example, aws-elasticbeanstalk-service-role.

None

Any role name.

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 a classic load balancer or 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

HTTP code that indicates that an instance is healthy.

This option is only applicable to environments with a classic load balancer or an application load balancer.

200

200 to 499

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 a classic load balancer or an application load balancer.

'false'

'false'

'true'

StickinessLBCookieDuration

Lifetime, in seconds, of the sticky session cookie.

This option is only applicable to environments with a classic load balancer or an application load balancer.

86400

1 to 604800

StickinessType

Set to lb_cookie to use cookies for sticky sessions.

This option is only applicable to environments with a classic load balancer or 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 a classic load balancer or 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

HTTP code that indicates that an instance is healthy.

This option is only applicable to environments with a classic load balancer or an application load balancer.

200

200 to 499

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 a classic load balancer or an application load balancer.

'false'

'false'

'true'

StickinessLBCookieDuration

Lifetime, in seconds, of the sticky session cookie.

This option is only applicable to environments with a classic load balancer or an application load balancer.

86400

1 to 604800

StickinessType

Set to lb_cookie to use cookies for sticky sessions.

This option is only applicable to environments with a classic load balancer or 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:healthreporting:system

Configure enhanced health reporting for your environment.

Namespace: aws:elasticbeanstalk:healthreporting:system

Name Description Default Valid Values

SystemType

Health reporting system (basic or enhanced). Enhanced health reporting requires a service role and a version 2 platform configuration.

basic

basic

enhanced

ConfigDocument A JSON document describing the environment and instance metrics to publish to CloudWatch. None

aws:elasticbeanstalk:hostmanager

Configure the EC2 instances in your environment to upload rotated logs to Amazon S3.

Namespace: aws:elasticbeanstalk:hostmanager

Name Description Default 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.

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:10:00".

None

Day and time in

day:hour:minute

format.

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.

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.

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

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

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 application

The 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: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 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 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.

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. The same as listener_port. 1 to 65535
InstanceProtocol The protocol that this listener uses to communicate with the EC2 instances.

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 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.

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 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.

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.

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 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

Rules

List of rules to apply to the listener

This option is only applicable to environments with an application load balancer.

None

Comma separated list of rule names.

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 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 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

Add listener rules to an application load balancer.

Note

This namespace isn't applicable to environments with a network load balancer.

Namespace: aws:elbv2:listenerrule:rule_name

Name Description Default Valid Values

PathPatterns

List of path patterns to match. For example, /img/*.

This option is only applicable to environments with an application load balancer.

None

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 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 names 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.

Warning

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

oracle-se

oracle-ee

sqlserver-ee

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 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 in the Amazon Relational Database Service User Guide.

false

true

false