AWS Elastic Beanstalk
Developer Guide (API Version 2010-12-01)
AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

Platform Specific Options

Docker Platform Options

Elastic Beanstalk does not provide any Docker-specific configuration options.

Go Platform Options

Map a path in your web application to a directory in the source bundle that contains static files. Each option that you define in this namespace maps a different path.

Namespace: aws:elasticbeanstalk:container:golang:staticfiles

Name Description Default Valid Values

Application path.

Example: /images

Source directory.

Example: myimages

n/a

n/a

Java SE Platform Options

Map a path in your web application to a directory in the source bundle that contains static files. Each option that you define in this namespace maps a different path.

Namespace: aws:elasticbeanstalk:container:java:staticfiles

Name Description Default Valid Values

Application path.

Example: /images

Source directory.

Example: myimages

n/a

n/a

Run the AWS X-Ray daemon to relay trace information from your X-Ray integrated Java 8 application.

Namespace: aws:elasticbeanstalk:xray

Name Description Default Valid Values

XRayEnabled

Set to true to run the AWS X-Ray daemon on the instances in your environment.

false

true

false

Java with Tomcat Platform Options

Namespace: aws:elasticbeanstalk:application:environment

Name Description Default Valid Values

JDBC_CONNECTION_STRING

The connection string to an external database.

n/a

n/a

Note

The combined size of all environment properties defined for an environment is limited to 4096 bytes. The format of environment properties is KEY1=VALUE1, KEY2=VALUE2, which means that both the value and key of each variable are included in the total. When a platform has one or more predefined environment properties, such as JDBC_CONNECTION_STRING, those properties are also included in the total.

Namespace: aws:elasticbeanstalk:container:tomcat:jvmoptions

Name Description Default Valid Values

JVM Options

Pass command-line options to the JVM at startup.

n/a

n/a

Xmx

Maximum JVM heap sizes.

256m

n/a

XX:MaxPermSize

Section of the JVM heap that is used to store class definitions and associated metadata.

64m

n/a

Xms

Initial JVM heap sizes.

256m

n/a

Note

You can extend the number of parameters and specify the parameter names in the aws:elasticbeanstalk:container:tomcat:jvmoptions and aws:elasticbeanstalk:application:environment namespaces.

Namespace: aws:elasticbeanstalk:environment:proxy

Name Description Default Valid Values

GzipCompression

Set to 'false' to disable response compression.

'true'

'true'

'false'

ProxyServer

Set to nginx to use nginx as a proxy instead of Apache 2.2.

apache

apache

nginx

Map a path in your web application to a directory in the source bundle that contains static files. Each option that you define in this namespace maps a different path.

Namespace: aws:elasticbeanstalk:environment:proxy:staticfiles

Name Description Default Valid Values

Application path.

Example: /images

Source directory. If ProxyServer is set to "none", then the static file mappings will not take affect.

Example: myimages

n/a

n/a

Run the AWS X-Ray daemon to relay trace information from your X-Ray integrated Tomcat 8 application.

Namespace: aws:elasticbeanstalk:xray

Name Description Default Valid Values

XRayEnabled

Set to true to run the AWS X-Ray daemon on the instances in your environment.

false

true

false

.NET Platform Options

Namespace: aws:elasticbeanstalk:application:environment

Name Description Default Valid Values

PARAM1 - PARAM5

Pass in key-value pairs.

n/a

n/a

Note

The combined size of all environment properties defined for an environment is limited to 4096 bytes. The format of environment properties is KEY1=VALUE1, KEY2=VALUE2, which means that both the value and key of each variable are included in the total. When a platform has one or more predefined environment properties, such as JDBC_CONNECTION_STRING, those properties are also included in the total.

Namespace: aws:elasticbeanstalk:container:dotnet:apppool

Name Description Default Valid Values

Target Runtime

You can choose the version of .NET Framework for your application.

4.0

2.0

4.0

Enable 32-bit Applications

Enable 32-bit applications.

False

True

False

Run the AWS X-Ray daemon to relay trace information from your X-Ray integrated .NET application.

Namespace: aws:elasticbeanstalk:xray

Name Description Default Valid Values

XRayEnabled

Set to true to run the AWS X-Ray daemon on the instances in your environment.

false

true

false

Node.js Platform Options

Namespace: aws:elasticbeanstalk:container:nodejs

Name Description Default Valid Values

NodeCommand

Command used to start the Node.js application. If an empty string is specified, app.js is used, then server.js, then "npm start" in that order.

""

n/a

NodeVersion

Version of Node.js. For example, 4.4.6

Supported Node.js versions vary between versions of the Node.js platform configuration. See Node.js on the supported platforms page for a list of the currently supported versions.

Note

When support for the version of Node.js that you are using is removed from the platform configuration, you must change or remove the version setting prior to doing a platform upgrade. This may occur when a security vulnerability is identified for one or more versions of Node.js

When this occurs, attempting to upgrade to a new version of the platform that does not support the configured NodeVersion fails. To avoid needing to create a new environment, change the NodeVersion configuration option to a version that is supported by both the old configuration version and the new one, or remove the option setting, and then perform the platform upgrade.

varies varies

GzipCompression

Specifies if gzip compression is enabled. If ProxyServer is set to "none", then gzip compression will be disabled.

false

true

false

ProxyServer

Specifies which web server should be used to proxy connections to Node.js. If ProxyServer is set to "none", then static file mappings will not take affect and gzip compression will be disabled.

nginx

apache

nginx

none

Map a path in your web application to a directory in the source bundle that contains static files. Each option that you define in this namespace maps a different path.

Namespace: aws:elasticbeanstalk:container:nodejs:staticfiles

Name Description Default Valid Values

Application path.

Example: /images

Source directory. If ProxyServer is set to "none", then the static file mappings will not take affect.

Example: myimages

n/a

n/a

Run the AWS X-Ray daemon to relay trace information from your X-Ray integrated Node.js application.

Namespace: aws:elasticbeanstalk:xray

Name Description Default Valid Values

XRayEnabled

Set to true to run the AWS X-Ray daemon on the instances in your environment.

false

true

false

PHP Platform Options

Namespace: aws:elasticbeanstalk:container:php:phpini

Name Description Default Valid Values

document_root

Specify the child directory of your project that is treated as the public-facing web root.

/

A blank string is treated as /, or specify a string starting with /

memory_limit

Amount of memory allocated to the PHP environment.

256M

n/a

zlib.output_compression

Specifies whether or not PHP should use compression for output.

Off

On

Off

allow_url_fopen

Specifies if PHP's file functions are allowed to retrieve data from remote locations, such as websites or FTP servers.

On

On

Off

display_errors

Specifies if error messages should be part of the output.

Off

On

Off

max_execution_time

Sets the maximum time, in seconds, a script is allowed to run before it is terminated by the environment.

60

0 to 9223372036854775807 (PHP_INT_MAX)

composer_options

Sets custom options to use when installing dependencies using Composer through composer.phar install. For more information including available options, go to http://getcomposer.org/doc/03-cli.md#install.

n/a

n/a

Python Platform Options

Namespace: aws:elasticbeanstalk:application:environment

Name Description Default Valid Values

DJANGO_SETTINGS_MODULE

Specifies which settings file to use.

n/a

n/a

Note

The combined size of all environment properties defined for an environment is limited to 4096 bytes. The format of environment properties is KEY1=VALUE1, KEY2=VALUE2, which means that both the value and key of each variable are included in the total. When a platform has one or more predefined environment properties, such as JDBC_CONNECTION_STRING, those properties are also included in the total.

Namespace: aws:elasticbeanstalk:container:python

Name Description Default Valid Values

WSGIPath

The file that contains the WSGI application. This file must have an "application" callable.

application.py

n/a

NumProcesses

The number of daemon processes that should be started for the process group when running WSGI applications.

1

n/a

NumThreads

The number of threads to be created to handle requests in each daemon process within the process group when running WSGI applications.

15

n/a

Map a path in your web application to a directory in the source bundle that contains static files. Each option that you define in this namespace maps a different path.

Namespace: aws:elasticbeanstalk:container:python:staticfiles

Name Description Default Valid Values

Application path.

Example: /images

Source directory.

Example: myimages

n/a

n/a

Run the AWS X-Ray daemon to relay trace information from your X-Ray integrated Python application.

Namespace: aws:elasticbeanstalk:xray

Name Description Default Valid Values

XRayEnabled

Set to true to run the AWS X-Ray daemon on the instances in your environment.

false

true

false

Ruby Platform Options

Namespace: aws:elasticbeanstalk:application:environment

Name Description Default Valid Values

RAILS_SKIP_MIGRATIONS

Specifies whether to run `rake db:migrate` on behalf of the users' applications; or whether it should be skipped. This is only applicable to Rails 3 applications.

false

true

false

RAILS_SKIP_ASSET_COMPILATION

Specifies whether the container should run `rake assets:precompile` on behalf of the users' applications; or whether it should be skipped. This is also only applicable to Rails 3 applications.

false

true

false

BUNDLE_WITHOUT

A colon (:) separated list of groups to ignore when installing dependencies from a Gemfile.

test:development

n/a

RACK_ENV

Specifies what environment stage an application can be run in. Examples of common environments include development, production, test.

production

n/a

RAILS_ENV

Specifies what environment stage an application can be run in. Examples of common environments include development, production, test.

production

n/a

Note

The combined size of all environment properties defined for an environment is limited to 4096 bytes. The format of environment properties is KEY1=VALUE1, KEY2=VALUE2, which means that both the value and key of each variable are included in the total. When a platform has one or more predefined environment properties, such as JDBC_CONNECTION_STRING, those properties are also included in the total.