Platform specific options
Some Elastic Beanstalk platforms define option namespaces that are specific to the platform. These namespaces and their options are listed below for each platform.
Note
Previously, in platform versions based on Amazon Linux AMI (preceding Amazon Linux 2), the following two features and their respective namespaces were considered to be platform-specific features, and were listed here per platform:
-
Proxy configuration for static files –
aws:elasticbeanstalk:environment:proxy:staticfiles
-
AWS X-Ray support –
aws:elasticbeanstalk:xray
In Amazon Linux 2 platform versions, Elastic Beanstalk implements these features in a consistent way across all supporting platforms. The related namespace are now listed in the General options for all environments page. We only kept mention of them on this page for platforms who had differently-named namespaces.
Platforms
Docker platform options
The following Docker-specific configuration options apply to the Docker and Preconfigured Docker platforms.
Note
These configuration options do not apply to
Docker platform (Amazon Linux 2) with Docker Compose
Multicontainer Docker platform (Amazon Linux AMI AL1) - this platform is retired
Name | Description | Default | Valid values |
---|---|---|---|
ProxyServer |
Specifies the web server to use as a proxy. |
|
|
Go platform options
Amazon Linux AMI (pre-Amazon Linux 2) platform options
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.
Name | Value |
---|---|
Path where the proxy server will serve the files. Example: |
Name of the folder containing the files. Example: |
Java SE platform options
Amazon Linux AMI (pre-Amazon Linux 2) platform options
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.
Name | Value |
---|---|
Path where the proxy server will serve the files. Example: |
Name of the folder containing the files. Example: |
Java with Tomcat platform options
Name | Description | Default | Valid values |
---|---|---|---|
JDBC_CONNECTION_STRING |
The connection string to an external database. |
n/a |
n/a |
See Environment properties and other software settings for more information.
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. |
|
n/a |
XX:MaxPermSize |
Section of the JVM heap that is used to store class definitions and associated metadata. NoteThis option only applies to Java versions earlier than Java 8, and isn't supported on Elastic Beanstalk Tomcat platforms based on Amazon Linux 2 and later. |
|
n/a |
Xms |
Initial JVM heap sizes. |
|
n/a |
|
Specify arbitrary JVM options in addition to the those defined by the Tomcat platform. |
n/a |
n/a |
Name | Description | Default | Valid values |
---|---|---|---|
GzipCompression |
Set to Only valid on Amazon Linux AMI (preceding Amazon Linux 2) platform versions. |
|
|
ProxyServer |
Set the proxy to use on your environment's instances. If you set this option to Set to Set to For more information, see Configuring the proxy server. |
|
|
.NET Core on Linux platform options
Name | Description | Default | Valid values |
---|---|---|---|
ProxyServer |
Specifies the web server to use as a proxy. |
|
|
.NET platform options
Name | Description | Default | Valid values |
---|---|---|---|
Target Runtime |
Choose the version of .NET Framework for your application. |
|
|
Enable 32-bit Applications |
Set to |
|
|
Node.js platform options
Name | Description | Default | Valid values |
---|---|---|---|
ProxyServer |
Set the proxy to use on your environment's instances. |
|
|
Amazon Linux AMI (pre-Amazon Linux 2) platform options
Name | Description | Default | Valid values |
---|---|---|---|
NodeCommand |
Command used to start the Node.js application. If an empty string is specified, |
"" |
n/a |
NodeVersion |
Version of Node.js. For example, Supported Node.js versions vary between Node.js platform versions. See Node.js in the AWS Elastic Beanstalk Platforms document for a list of the currently supported versions. NoteWhen support for the version of Node.js that you are using is removed from the platform, you must change or remove the version setting prior to doing a platform update. This might occur when a security vulnerability is identified for one or more versions of Node.js. When this happens, attempting to update to a new version of the platform that doesn't support the configured NodeVersion fails. To avoid needing to create a new environment, change the NodeVersion configuration option to a Node.js version that is supported by both the old platform version and the new one, or remove the option setting, and then perform the platform update. |
varies | varies |
GzipCompression |
Specifies if gzip compression is enabled. If ProxyServer is set to |
|
|
ProxyServer |
Specifies which web server should be used to proxy connections to Node.js. If ProxyServer is set to |
|
|
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
Static file settings do not apply if aws:elasticbeanstalk:container:nodejs::ProxyFiles
is set to none
.
Name | Value |
---|---|
Path where the proxy server will serve the files. Example: |
Name of the folder containing the files. Example: |
PHP platform options
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 |
memory_limit |
Amount of memory allocated to the PHP environment. |
|
n/a |
zlib.output_compression |
Specifies whether or not PHP should use compression for output. |
|
|
allow_url_fopen |
Specifies if PHP's file functions are allowed to retrieve data from remote locations, such as websites or FTP servers. |
|
|
display_errors |
Specifies if error messages should be part of the output. |
|
|
max_execution_time |
Sets the maximum time, in seconds, a script is allowed to run before it is terminated by the environment. |
|
|
composer_options |
Sets custom options to use when installing dependencies using Composer through the composer.phar install command. For
more information, see install |
n/a |
n/a |
Name | Description | Default | Valid values |
---|---|---|---|
ProxyServer |
Set the proxy to use on your environment's instances. |
|
|
Note
For more information about the PHP platform, see Using the Elastic Beanstalk PHP platform.
Python platform options
Name | Description | Default | Valid values |
---|---|---|---|
DJANGO_SETTINGS_MODULE |
Specifies which settings file to use. |
n/a |
n/a |
See Environment properties and other software settings for more information.
Name | Description | Default | Valid values |
---|---|---|---|
WSGIPath |
The file that contains the WSGI application. This file must have an |
On Amazon Linux 2 Python platform versions: On Amazon Linux AMI Python platform versions: |
n/a |
NumProcesses |
The number of daemon processes that should be started for the process group when running WSGI applications. |
|
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. |
|
n/a |
Name | Description | Default | Valid values |
---|---|---|---|
ProxyServer |
Set the proxy to use on your environment's instances. |
|
|
Amazon Linux AMI (pre-Amazon Linux 2) platform options
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.
By default, the proxy server in a Python environment serves any files in a folder named
static
at the /static
path.
Name | Value |
---|---|
Path where the proxy server will serve the files. Example: |
Name of the folder containing the files. Example: |
Ruby platform options
Name | Description | Default | Valid values |
---|---|---|---|
RAILS_SKIP_MIGRATIONS |
Specifies whether to run |
|
|
RAILS_SKIP_ASSET_COMPILATION |
Specifies whether the container should run |
|
|
BUNDLE_WITHOUT |
A colon ( |
|
n/a |
RACK_ENV |
Specifies what environment stage an application can be run in. Examples of common environments include development, production, test. |
|
n/a |
See Environment properties and other software settings for more information.