Network.AWS.ElasticBeanstalk.TerminateEnvironment

Terminates the specified environment.

See: AWS API Reference for TerminateEnvironment.

Creating a Request

terminateEnvironment :: TerminateEnvironment

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:

• teTerminateResources
• teEnvironmentName
• teEnvironmentId

data TerminateEnvironment

This documentation target is not reported in the API reference.

See: terminateEnvironment smart constructor.

Instances

Eq TerminateEnvironment

Data TerminateEnvironment

Read TerminateEnvironment

Show TerminateEnvironment

Generic TerminateEnvironment

AWSRequest TerminateEnvironment

ToPath TerminateEnvironment

ToHeaders TerminateEnvironment

ToQuery TerminateEnvironment

Typeable * TerminateEnvironment

type Rep TerminateEnvironment

type Sv TerminateEnvironment = ElasticBeanstalk

type Rs TerminateEnvironment = EnvironmentDescription

Request Lenses

teTerminateResources :: Lens' TerminateEnvironment (Maybe Bool)

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)

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)

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

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:

• eCNAME
• eStatus
• eTemplateName
• eAbortableOperationInProgress
• eEndpointURL
• eDateUpdated
• eResources
• eHealth
• eVersionLabel
• eDateCreated
• eTier
• eEnvironmentName
• eApplicationName
• eHealthStatus
• eEnvironmentId
• eSolutionStackName
• eDescription

data EnvironmentDescription

Describes the properties of an environment.

See: environmentDescription smart constructor.

Instances

Eq EnvironmentDescription

Data EnvironmentDescription

Read EnvironmentDescription

Show EnvironmentDescription

Generic EnvironmentDescription

FromXML EnvironmentDescription

Typeable * EnvironmentDescription

type Rep EnvironmentDescription

Response Lenses

eCNAME :: Lens' EnvironmentDescription (Maybe Text)

The URL to the CNAME for this environment.

eStatus :: Lens' EnvironmentDescription (Maybe EnvironmentStatus)

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)

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

eAbortableOperationInProgress :: Lens' EnvironmentDescription (Maybe Bool)

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)

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)

The last modified date for this environment.

eResources :: Lens' EnvironmentDescription (Maybe EnvironmentResourcesDescription)

The description of the AWS resources used by this environment.

eHealth :: Lens' EnvironmentDescription (Maybe EnvironmentHealth)

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)

The application version deployed in this environment.

eDateCreated :: Lens' EnvironmentDescription (Maybe UTCTime)

The creation date for this environment.

eTier :: Lens' EnvironmentDescription (Maybe EnvironmentTier)

Describes the current tier of this environment.

eEnvironmentName :: Lens' EnvironmentDescription (Maybe Text)

The name of this environment.

eApplicationName :: Lens' EnvironmentDescription (Maybe Text)

The name of the application associated with this environment.

eHealthStatus :: Lens' EnvironmentDescription (Maybe EnvironmentHealthStatus)

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

eEnvironmentId :: Lens' EnvironmentDescription (Maybe Text)

The ID of this environment.

eSolutionStackName :: Lens' EnvironmentDescription (Maybe Text)

The name of the SolutionStack deployed with this environment.

eDescription :: Lens' EnvironmentDescription (Maybe Text)

Describes this environment.