Safe Haskell | None |
---|---|
Language | Haskell2010 |
Terminates the specified environment.
http://docs.aws.amazon.com/elasticbeanstalk/latest/api/API_TerminateEnvironment.html
- data TerminateEnvironment
- terminateEnvironment :: TerminateEnvironment
- teEnvironmentId :: Lens' TerminateEnvironment (Maybe Text)
- teEnvironmentName :: Lens' TerminateEnvironment (Maybe Text)
- teTerminateResources :: Lens' TerminateEnvironment (Maybe Bool)
- data TerminateEnvironmentResponse
- terminateEnvironmentResponse :: TerminateEnvironmentResponse
- terApplicationName :: Lens' TerminateEnvironmentResponse (Maybe Text)
- terCNAME :: Lens' TerminateEnvironmentResponse (Maybe Text)
- terDateCreated :: Lens' TerminateEnvironmentResponse (Maybe UTCTime)
- terDateUpdated :: Lens' TerminateEnvironmentResponse (Maybe UTCTime)
- terDescription :: Lens' TerminateEnvironmentResponse (Maybe Text)
- terEndpointURL :: Lens' TerminateEnvironmentResponse (Maybe Text)
- terEnvironmentId :: Lens' TerminateEnvironmentResponse (Maybe Text)
- terEnvironmentName :: Lens' TerminateEnvironmentResponse (Maybe Text)
- terHealth :: Lens' TerminateEnvironmentResponse (Maybe EnvironmentHealth)
- terResources :: Lens' TerminateEnvironmentResponse (Maybe EnvironmentResourcesDescription)
- terSolutionStackName :: Lens' TerminateEnvironmentResponse (Maybe Text)
- terStatus :: Lens' TerminateEnvironmentResponse (Maybe EnvironmentStatus)
- terTemplateName :: Lens' TerminateEnvironmentResponse (Maybe Text)
- terTier :: Lens' TerminateEnvironmentResponse (Maybe EnvironmentTier)
- terVersionLabel :: Lens' TerminateEnvironmentResponse (Maybe Text)
Request
data TerminateEnvironment Source
Request constructor
terminateEnvironment :: TerminateEnvironment Source
TerminateEnvironment
constructor.
The fields accessible through corresponding lenses are:
Request lenses
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.
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.
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 AWSElastic Beanstalk User Guide.
Default: true
Valid Values: true
| false
Response
Response constructor
terminateEnvironmentResponse :: TerminateEnvironmentResponse Source
TerminateEnvironmentResponse
constructor.
The fields accessible through corresponding lenses are:
terApplicationName
::
Maybe
Text
terCNAME
::
Maybe
Text
terDateCreated
::
Maybe
UTCTime
terDateUpdated
::
Maybe
UTCTime
terDescription
::
Maybe
Text
terEndpointURL
::
Maybe
Text
terEnvironmentId
::
Maybe
Text
terEnvironmentName
::
Maybe
Text
terHealth
::
Maybe
EnvironmentHealth
terResources
::
Maybe
EnvironmentResourcesDescription
terSolutionStackName
::
Maybe
Text
terStatus
::
Maybe
EnvironmentStatus
terTemplateName
::
Maybe
Text
terTier
::
Maybe
EnvironmentTier
terVersionLabel
::
Maybe
Text
Response lenses
terApplicationName :: Lens' TerminateEnvironmentResponse (Maybe Text) Source
The name of the application associated with this environment.
terCNAME :: Lens' TerminateEnvironmentResponse (Maybe Text) Source
The URL to the CNAME for this environment.
terDateCreated :: Lens' TerminateEnvironmentResponse (Maybe UTCTime) Source
The creation date for this environment.
terDateUpdated :: Lens' TerminateEnvironmentResponse (Maybe UTCTime) Source
The last modified date for this environment.
terDescription :: Lens' TerminateEnvironmentResponse (Maybe Text) Source
Describes this environment.
terEndpointURL :: Lens' TerminateEnvironmentResponse (Maybe Text) Source
For load-balanced, autoscaling environments, the URL to the LoadBalancer. For single-instance environments, the IP address of the instance.
terEnvironmentId :: Lens' TerminateEnvironmentResponse (Maybe Text) Source
The ID of this environment.
terEnvironmentName :: Lens' TerminateEnvironmentResponse (Maybe Text) Source
The name of this environment.
terHealth :: Lens' TerminateEnvironmentResponse (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
terResources :: Lens' TerminateEnvironmentResponse (Maybe EnvironmentResourcesDescription) Source
The description of the AWS resources used by this environment.
terSolutionStackName :: Lens' TerminateEnvironmentResponse (Maybe Text) Source
The name of the SolutionStack
deployed with this environment.
terStatus :: Lens' TerminateEnvironmentResponse (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.
terTemplateName :: Lens' TerminateEnvironmentResponse (Maybe Text) Source
The name of the configuration template used to originally launch this environment.
terTier :: Lens' TerminateEnvironmentResponse (Maybe EnvironmentTier) Source
Describes the current tier of this environment.
terVersionLabel :: Lens' TerminateEnvironmentResponse (Maybe Text) Source
The application version deployed in this environment.