Documentation

A description of the app.

See: newApp smart constructor.

Create a value of App with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:sslConfiguration:App', app_sslConfiguration - An SslConfiguration object with the SSL configuration.

$sel:environment:App', app_environment - An array of EnvironmentVariable objects that specify environment variables to be associated with the app. After you deploy the app, these variables are defined on the associated app server instances. For more information, see Environment Variables.

There is no specific limit on the number of environment variables. However, the size of the associated data structure - which includes the variable names, values, and protected flag values - cannot exceed 20 KB. This limit should accommodate most if not all use cases, but if you do exceed it, you will cause an exception (API) with an "Environment: is too large (maximum is 20 KB)" message.

$sel:enableSsl:App', app_enableSsl - Whether to enable SSL for the app.

$sel:createdAt:App', app_createdAt - When the app was created.

$sel:shortname:App', app_shortname - The app's short name.

$sel:dataSources:App', app_dataSources - The app's data sources.

$sel:appSource:App', app_appSource - A Source object that describes the app repository.

$sel:appId:App', app_appId - The app ID.

$sel:attributes:App', app_attributes - The stack attributes.

$sel:name:App', app_name - The app name.

$sel:type':App', app_type - The app type.

$sel:stackId:App', app_stackId - The app stack ID.

$sel:domains:App', app_domains - The app vhost settings with multiple domains separated by commas. For example: 'www.example.com, example.com'

$sel:description:App', app_description - A description of the app.

An SslConfiguration object with the SSL configuration.

An array of EnvironmentVariable objects that specify environment variables to be associated with the app. After you deploy the app, these variables are defined on the associated app server instances. For more information, see Environment Variables.

There is no specific limit on the number of environment variables. However, the size of the associated data structure - which includes the variable names, values, and protected flag values - cannot exceed 20 KB. This limit should accommodate most if not all use cases, but if you do exceed it, you will cause an exception (API) with an "Environment: is too large (maximum is 20 KB)" message.

Whether to enable SSL for the app.

When the app was created.

The app's short name.

The app's data sources.

A Source object that describes the app repository.

The app ID.

The stack attributes.

The app name.

The app type.

The app stack ID.

The app vhost settings with multiple domains separated by commas. For example: 'www.example.com, example.com'

A description of the app.