Copyright | (c) 2013-2015 Brendan Hay |
---|---|
License | Mozilla Public License, v. 2.0. |
Maintainer | Brendan Hay <brendan.g.hay@gmail.com> |
Stability | auto-generated |
Portability | non-portable (GHC extensions) |
Safe Haskell | None |
Language | Haskell2010 |
Terminates the specified environment.
See: AWS API Reference for TerminateEnvironment.
- terminateEnvironment :: TerminateEnvironment
- data TerminateEnvironment
- teTerminateResources :: Lens' TerminateEnvironment (Maybe Bool)
- teEnvironmentName :: Lens' TerminateEnvironment (Maybe Text)
- teEnvironmentId :: Lens' TerminateEnvironment (Maybe Text)
- environmentDescription :: EnvironmentDescription
- data EnvironmentDescription
- eCNAME :: Lens' EnvironmentDescription (Maybe Text)
- eStatus :: Lens' EnvironmentDescription (Maybe EnvironmentStatus)
- eTemplateName :: Lens' EnvironmentDescription (Maybe Text)
- eAbortableOperationInProgress :: Lens' EnvironmentDescription (Maybe Bool)
- eEndpointURL :: Lens' EnvironmentDescription (Maybe Text)
- eDateUpdated :: Lens' EnvironmentDescription (Maybe UTCTime)
- eResources :: Lens' EnvironmentDescription (Maybe EnvironmentResourcesDescription)
- eHealth :: Lens' EnvironmentDescription (Maybe EnvironmentHealth)
- eVersionLabel :: Lens' EnvironmentDescription (Maybe Text)
- eDateCreated :: Lens' EnvironmentDescription (Maybe UTCTime)
- eTier :: Lens' EnvironmentDescription (Maybe EnvironmentTier)
- eEnvironmentName :: Lens' EnvironmentDescription (Maybe Text)
- eApplicationName :: Lens' EnvironmentDescription (Maybe Text)
- eHealthStatus :: Lens' EnvironmentDescription (Maybe EnvironmentHealthStatus)
- eEnvironmentId :: Lens' EnvironmentDescription (Maybe Text)
- eSolutionStackName :: Lens' EnvironmentDescription (Maybe Text)
- eDescription :: Lens' EnvironmentDescription (Maybe Text)
Creating a Request
terminateEnvironment :: TerminateEnvironment Source
Creates a value of TerminateEnvironment
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
data TerminateEnvironment Source
This documentation target is not reported in the API reference.
See: terminateEnvironment
smart constructor.
Request Lenses
teTerminateResources :: Lens' TerminateEnvironment (Maybe Bool) Source
Indicates whether the associated AWS resources should shut down when the environment is terminated:
true
: (default) The user AWS resources (for example, the Auto Scaling
group, LoadBalancer, etc.) are terminated along with the environment.
false
: The environment is removed from the AWS Elastic Beanstalk but
the AWS resources continue to operate.
true
: The specified environment as well as the associated AWS resources, such as Auto Scaling group and LoadBalancer, are terminated.false
: AWS Elastic Beanstalk resource management is removed from the environment, but the AWS resources continue to operate.
For more information, see the AWS Elastic Beanstalk User Guide.
Default: true
Valid Values: true
| false
teEnvironmentName :: Lens' TerminateEnvironment (Maybe Text) Source
The name of the environment to terminate.
Condition: You must specify either this or an EnvironmentId, or both. If
you do not specify either, AWS Elastic Beanstalk returns
MissingRequiredParameter
error.
teEnvironmentId :: Lens' TerminateEnvironment (Maybe Text) Source
The ID of the environment to terminate.
Condition: You must specify either this or an EnvironmentName, or both.
If you do not specify either, AWS Elastic Beanstalk returns
MissingRequiredParameter
error.
Destructuring the Response
environmentDescription :: EnvironmentDescription Source
Creates a value of EnvironmentDescription
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
data EnvironmentDescription Source
Describes the properties of an environment.
See: environmentDescription
smart constructor.
Response Lenses
eCNAME :: Lens' EnvironmentDescription (Maybe Text) Source
The URL to the CNAME for this environment.
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.
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.
eDateUpdated :: Lens' EnvironmentDescription (Maybe UTCTime) Source
The last modified date for this environment.
eResources :: Lens' EnvironmentDescription (Maybe EnvironmentResourcesDescription) Source
The description of the AWS resources used by 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 anUpdateEnvironment
orRestartEnvironement
request.
Default: Grey
eVersionLabel :: Lens' EnvironmentDescription (Maybe Text) Source
The application version deployed in this environment.
eDateCreated :: Lens' EnvironmentDescription (Maybe UTCTime) Source
The creation date for 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.
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.
eEnvironmentId :: Lens' EnvironmentDescription (Maybe Text) Source
The ID of this environment.
eSolutionStackName :: Lens' EnvironmentDescription (Maybe Text) Source
The name of the SolutionStack
deployed with this environment.
eDescription :: Lens' EnvironmentDescription (Maybe Text) Source
Describes this environment.