amazonka-elasticbeanstalk-1.3.0: Amazon Elastic Beanstalk SDK.

Copyright(c) 2013-2015 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone
LanguageHaskell2010

Network.AWS.ElasticBeanstalk.CreateEnvironment

Contents

Description

Launches an environment for the specified application using the specified configuration.

See: AWS API Reference for CreateEnvironment.

Synopsis

Creating a Request

Request Lenses

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.

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.

ceOptionsToRemove :: Lens' CreateEnvironment [OptionSpecification] Source

A list of custom user-defined configuration options to remove from the configuration set for this new environment.

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.

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.

ceTier :: Lens' CreateEnvironment (Maybe EnvironmentTier) Source

This specifies the tier to use for creating this 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.

ceDescription :: Lens' CreateEnvironment (Maybe Text) Source

Describes this environment.

ceTags :: Lens' CreateEnvironment [Tag] Source

This specifies the tags applied to resources in the environment.

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.

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.

Destructuring the Response

Response Lenses

eStatus :: Lens' EnvironmentDescription (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.

eCNAME :: Lens' EnvironmentDescription (Maybe Text) Source

The URL to the CNAME for this environment.

eTemplateName :: Lens' EnvironmentDescription (Maybe Text) Source

The name of the configuration template used to originally launch this environment.

eAbortableOperationInProgress :: Lens' EnvironmentDescription (Maybe Bool) Source

Indicates if there is an in-progress environment configuration update or application version deployment that you can cancel.

'true:' There is an update in progress.

'false:' There are no updates currently in progress.

eEndpointURL :: Lens' EnvironmentDescription (Maybe Text) Source

For load-balanced, autoscaling environments, the URL to the LoadBalancer. For single-instance environments, the IP address of the instance.

eResources :: Lens' EnvironmentDescription (Maybe EnvironmentResourcesDescription) Source

The description of the AWS resources used by this environment.

eDateUpdated :: Lens' EnvironmentDescription (Maybe UTCTime) Source

The last modified date for this environment.

eDateCreated :: Lens' EnvironmentDescription (Maybe UTCTime) Source

The creation date for this environment.

eHealth :: Lens' EnvironmentDescription (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

eVersionLabel :: Lens' EnvironmentDescription (Maybe Text) Source

The application version deployed in this environment.

eTier :: Lens' EnvironmentDescription (Maybe EnvironmentTier) Source

Describes the current tier of this environment.

eEnvironmentName :: Lens' EnvironmentDescription (Maybe Text) Source

The name of this environment.

eApplicationName :: Lens' EnvironmentDescription (Maybe Text) Source

The name of the application associated with this environment.

eSolutionStackName :: Lens' EnvironmentDescription (Maybe Text) Source

The name of the SolutionStack deployed with this environment.

eHealthStatus :: Lens' EnvironmentDescription (Maybe EnvironmentHealthStatus) Source

Returns the health status of the application running in your environment. For more information, see Health Colors and Statuses.

eDescription :: Lens' EnvironmentDescription (Maybe Text) Source

Describes this environment.