Copyright | (c) 2013-2023 Brendan Hay |
---|---|
License | Mozilla Public License, v. 2.0. |
Maintainer | Brendan Hay |
Stability | auto-generated |
Portability | non-portable (GHC extensions) |
Safe Haskell | Safe-Inferred |
Language | Haskell2010 |
Synopsis
- data App = App' {
- appId :: Maybe Text
- appSource :: Maybe Source
- attributes :: Maybe (HashMap AppAttributesKeys Text)
- createdAt :: Maybe Text
- dataSources :: Maybe [DataSource]
- description :: Maybe Text
- domains :: Maybe [Text]
- enableSsl :: Maybe Bool
- environment :: Maybe [EnvironmentVariable]
- name :: Maybe Text
- shortname :: Maybe Text
- sslConfiguration :: Maybe SslConfiguration
- stackId :: Maybe Text
- type' :: Maybe AppType
- newApp :: App
- app_appId :: Lens' App (Maybe Text)
- app_appSource :: Lens' App (Maybe Source)
- app_attributes :: Lens' App (Maybe (HashMap AppAttributesKeys Text))
- app_createdAt :: Lens' App (Maybe Text)
- app_dataSources :: Lens' App (Maybe [DataSource])
- app_description :: Lens' App (Maybe Text)
- app_domains :: Lens' App (Maybe [Text])
- app_enableSsl :: Lens' App (Maybe Bool)
- app_environment :: Lens' App (Maybe [EnvironmentVariable])
- app_name :: Lens' App (Maybe Text)
- app_shortname :: Lens' App (Maybe Text)
- app_sslConfiguration :: Lens' App (Maybe SslConfiguration)
- app_stackId :: Lens' App (Maybe Text)
- app_type :: Lens' App (Maybe AppType)
Documentation
A description of the app.
See: newApp
smart constructor.
App' | |
|
Instances
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:appId:App'
, app_appId
- The app ID.
$sel:appSource:App'
, app_appSource
- A Source
object that describes the app repository.
$sel:attributes:App'
, app_attributes
- The stack attributes.
$sel:createdAt:App'
, app_createdAt
- When the app was created.
$sel:dataSources:App'
, app_dataSources
- The app's data sources.
$sel:description:App'
, app_description
- A description of the app.
$sel:domains:App'
, app_domains
- The app vhost settings with multiple domains separated by commas. For
example: 'www.example.com, example.com'
$sel:enableSsl:App'
, app_enableSsl
- Whether to enable SSL for the app.
$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:name:App'
, app_name
- The app name.
$sel:shortname:App'
, app_shortname
- The app's short name.
$sel:sslConfiguration:App'
, app_sslConfiguration
- An SslConfiguration
object with the SSL configuration.
$sel:stackId:App'
, app_stackId
- The app stack ID.
app_appSource :: Lens' App (Maybe Source) Source #
A Source
object that describes the app repository.
app_attributes :: Lens' App (Maybe (HashMap AppAttributesKeys Text)) Source #
The stack attributes.
app_dataSources :: Lens' App (Maybe [DataSource]) Source #
The app's data sources.
app_domains :: Lens' App (Maybe [Text]) Source #
The app vhost settings with multiple domains separated by commas. For
example: 'www.example.com, example.com'
app_environment :: Lens' App (Maybe [EnvironmentVariable]) Source #
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.
app_sslConfiguration :: Lens' App (Maybe SslConfiguration) Source #
An SslConfiguration
object with the SSL configuration.