Safe Haskell | None |
---|---|
Language | Haskell2010 |
Launches an environment for the specified application using the specified configuration.
http://docs.aws.amazon.com/elasticbeanstalk/latest/api/API_CreateEnvironment.html
- data CreateEnvironment
- createEnvironment :: Text -> Text -> CreateEnvironment
- ceApplicationName :: Lens' CreateEnvironment Text
- ceCNAMEPrefix :: Lens' CreateEnvironment (Maybe Text)
- ceDescription :: Lens' CreateEnvironment (Maybe Text)
- ceEnvironmentName :: Lens' CreateEnvironment Text
- ceOptionSettings :: Lens' CreateEnvironment [ConfigurationOptionSetting]
- ceOptionsToRemove :: Lens' CreateEnvironment [OptionSpecification]
- ceSolutionStackName :: Lens' CreateEnvironment (Maybe Text)
- ceTags :: Lens' CreateEnvironment [Tag]
- ceTemplateName :: Lens' CreateEnvironment (Maybe Text)
- ceTier :: Lens' CreateEnvironment (Maybe EnvironmentTier)
- ceVersionLabel :: Lens' CreateEnvironment (Maybe Text)
- data CreateEnvironmentResponse
- createEnvironmentResponse :: CreateEnvironmentResponse
- cerAbortableOperationInProgress :: Lens' CreateEnvironmentResponse (Maybe Bool)
- cerApplicationName :: Lens' CreateEnvironmentResponse (Maybe Text)
- cerCNAME :: Lens' CreateEnvironmentResponse (Maybe Text)
- cerDateCreated :: Lens' CreateEnvironmentResponse (Maybe UTCTime)
- cerDateUpdated :: Lens' CreateEnvironmentResponse (Maybe UTCTime)
- cerDescription :: Lens' CreateEnvironmentResponse (Maybe Text)
- cerEndpointURL :: Lens' CreateEnvironmentResponse (Maybe Text)
- cerEnvironmentId :: Lens' CreateEnvironmentResponse (Maybe Text)
- cerEnvironmentName :: Lens' CreateEnvironmentResponse (Maybe Text)
- cerHealth :: Lens' CreateEnvironmentResponse (Maybe EnvironmentHealth)
- cerResources :: Lens' CreateEnvironmentResponse (Maybe EnvironmentResourcesDescription)
- cerSolutionStackName :: Lens' CreateEnvironmentResponse (Maybe Text)
- cerStatus :: Lens' CreateEnvironmentResponse (Maybe EnvironmentStatus)
- cerTemplateName :: Lens' CreateEnvironmentResponse (Maybe Text)
- cerTier :: Lens' CreateEnvironmentResponse (Maybe EnvironmentTier)
- cerVersionLabel :: Lens' CreateEnvironmentResponse (Maybe Text)
Request
data CreateEnvironment Source
Request constructor
CreateEnvironment
constructor.
The fields accessible through corresponding lenses are:
ceApplicationName
::
Text
ceCNAMEPrefix
::
Maybe
Text
ceDescription
::
Maybe
Text
ceEnvironmentName
::
Text
ceOptionSettings
::
[ConfigurationOptionSetting
]ceOptionsToRemove
::
[OptionSpecification
]ceSolutionStackName
::
Maybe
Text
ceTags
::
[Tag
]ceTemplateName
::
Maybe
Text
ceTier
::
Maybe
EnvironmentTier
ceVersionLabel
::
Maybe
Text
Request lenses
ceApplicationName :: Lens' CreateEnvironment Text Source
The name of the application that contains the version to be deployed.
If no application is found with this name, CreateEnvironment
returns an InvalidParameterValue
error.
ceCNAMEPrefix :: Lens' CreateEnvironment (Maybe Text) Source
If specified, the environment attempts to use this value as the prefix for the CNAME. If not specified, the CNAME is generated automatically by appending a random alphanumeric string to the environment name.
ceDescription :: Lens' CreateEnvironment (Maybe Text) Source
Describes this environment.
ceEnvironmentName :: Lens' CreateEnvironment Text Source
A unique name for the deployment environment. Used in the application URL.
Constraint: Must be from 4 to 23 characters in length. The name can contain
only letters, numbers, and hyphens. It cannot start or end with a hyphen.
This name must be unique in your account. If the specified name already
exists, AWS Elastic Beanstalk returns an InvalidParameterValue
error.
Default: If the CNAME parameter is not specified, the environment name becomes part of the CNAME, and therefore part of the visible URL for your application.
ceOptionSettings :: Lens' CreateEnvironment [ConfigurationOptionSetting] Source
If specified, AWS Elastic Beanstalk sets the specified configuration options to the requested value in the configuration set for the new environment. These override the values obtained from the solution stack or the configuration template.
ceOptionsToRemove :: Lens' CreateEnvironment [OptionSpecification] Source
A list of custom user-defined configuration options to remove from the configuration set for this new environment.
ceSolutionStackName :: Lens' CreateEnvironment (Maybe Text) Source
This is an alternative to specifying a configuration name. If specified, AWS Elastic Beanstalk sets the configuration values to the default values associated with the specified solution stack.
Condition: You must specify either this or a TemplateName
, but not both. If
you specify both, AWS Elastic Beanstalk returns an InvalidParameterCombination
error. If you do not specify either, AWS Elastic Beanstalk returns a MissingRequiredParameter
error.
ceTags :: Lens' CreateEnvironment [Tag] Source
This specifies the tags applied to resources in the environment.
ceTemplateName :: Lens' CreateEnvironment (Maybe Text) Source
The name of the configuration template to use in deployment. If no
configuration template is found with this name, AWS Elastic Beanstalk returns
an InvalidParameterValue
error.
Condition: You must specify either this parameter or a SolutionStackName
,
but not both. If you specify both, AWS Elastic Beanstalk returns an InvalidParameterCombination
error. If you do not specify either, AWS Elastic Beanstalk returns a MissingRequiredParameter
error.
ceTier :: Lens' CreateEnvironment (Maybe EnvironmentTier) Source
This specifies the tier to use for creating this environment.
ceVersionLabel :: Lens' CreateEnvironment (Maybe Text) Source
The name of the application version to deploy.
If the specified application has no associated application versions, AWS
Elastic Beanstalk UpdateEnvironment
returns an InvalidParameterValue
error.
Default: If not specified, AWS Elastic Beanstalk attempts to launch the sample application in the container.
Response
Response constructor
createEnvironmentResponse :: CreateEnvironmentResponse Source
CreateEnvironmentResponse
constructor.
The fields accessible through corresponding lenses are:
cerAbortableOperationInProgress
::
Maybe
Bool
cerApplicationName
::
Maybe
Text
cerCNAME
::
Maybe
Text
cerDateCreated
::
Maybe
UTCTime
cerDateUpdated
::
Maybe
UTCTime
cerDescription
::
Maybe
Text
cerEndpointURL
::
Maybe
Text
cerEnvironmentId
::
Maybe
Text
cerEnvironmentName
::
Maybe
Text
cerHealth
::
Maybe
EnvironmentHealth
cerResources
::
Maybe
EnvironmentResourcesDescription
cerSolutionStackName
::
Maybe
Text
cerStatus
::
Maybe
EnvironmentStatus
cerTemplateName
::
Maybe
Text
cerTier
::
Maybe
EnvironmentTier
cerVersionLabel
::
Maybe
Text
Response lenses
cerAbortableOperationInProgress :: Lens' CreateEnvironmentResponse (Maybe Bool) Source
Lists in-progress environment updates and application version deployments that you can cancel.
cerApplicationName :: Lens' CreateEnvironmentResponse (Maybe Text) Source
The name of the application associated with this environment.
cerCNAME :: Lens' CreateEnvironmentResponse (Maybe Text) Source
The URL to the CNAME for this environment.
cerDateCreated :: Lens' CreateEnvironmentResponse (Maybe UTCTime) Source
The creation date for this environment.
cerDateUpdated :: Lens' CreateEnvironmentResponse (Maybe UTCTime) Source
The last modified date for this environment.
cerDescription :: Lens' CreateEnvironmentResponse (Maybe Text) Source
Describes this environment.
cerEndpointURL :: Lens' CreateEnvironmentResponse (Maybe Text) Source
For load-balanced, autoscaling environments, the URL to the LoadBalancer. For single-instance environments, the IP address of the instance.
cerEnvironmentId :: Lens' CreateEnvironmentResponse (Maybe Text) Source
The ID of this environment.
cerEnvironmentName :: Lens' CreateEnvironmentResponse (Maybe Text) Source
The name of this environment.
cerHealth :: Lens' CreateEnvironmentResponse (Maybe EnvironmentHealth) Source
Describes the health status of the environment. AWS Elastic Beanstalk indicates the failure levels for a running environment:
Red
: Indicates the environment is not working.
Yellow
: Indicates that something is wrong, the application might not be
available, but the instances appear running.
Green
: Indicates the environment is healthy and fully functional.
Red
: Indicates the environment is not responsive. Occurs when three or
more consecutive failures occur for an environment. Yellow
: Indicates that
something is wrong. Occurs when two consecutive failures occur for an
environment. Green
: Indicates the environment is healthy and fully
functional. Grey
: Default health for a new environment. The environment is
not fully launched and health checks have not started or health checks are
suspended during an UpdateEnvironment
or RestartEnvironement
request.
Default: Grey
cerResources :: Lens' CreateEnvironmentResponse (Maybe EnvironmentResourcesDescription) Source
The description of the AWS resources used by this environment.
cerSolutionStackName :: Lens' CreateEnvironmentResponse (Maybe Text) Source
The name of the SolutionStack
deployed with this environment.
cerStatus :: Lens' CreateEnvironmentResponse (Maybe EnvironmentStatus) Source
The current operational status of the environment:
Launching
: Environment is in the process of initial deployment. Updating
: Environment is in the process of updating its configuration settings or application version.
Ready
: Environment is available to have an action performed on it, such as
update or terminate. Terminating
: Environment is in the shut-down process.
Terminated
: Environment is not running.
cerTemplateName :: Lens' CreateEnvironmentResponse (Maybe Text) Source
The name of the configuration template used to originally launch this environment.
cerTier :: Lens' CreateEnvironmentResponse (Maybe EnvironmentTier) Source
Describes the current tier of this environment.
cerVersionLabel :: Lens' CreateEnvironmentResponse (Maybe Text) Source
The application version deployed in this environment.