AWS Elastic Beanstalk
Developer Guide (API Version 2010-12-01)
AWS Documentation » AWS Elastic Beanstalk » AWS Elastic Beanstalk Developer Guide » Tools » AWS Elastic Beanstalk API Command Line Interface » Operations » elastic-beanstalk-terminate-environment
« PreviousNext »
View the PDF for this guide.Go to the AWS Discussion Forum for this product.Go to the Kindle Store to download this guide in Kindle format.Did this page help you?  Yes | No |  Tell us about it...

elastic-beanstalk-terminate-environment

Description

Terminates the specified environment.

Syntax

elastic-beanstalk-terminate-environment [-e [name] | -E [id]] -t

Options

NameDescriptionRequired

-e

--environment-name name

The name of the environment to terminate.

Type: String

Default: None

Length Constraints: Minimum value of 4. Maximum value of 23.

Conditional

-E

--environment-id id

The ID of the environment to terminate.

Type: String

Default: None

Conditional

-t

--terminate-resources

Indicates whether the associated AWS resources should shut down when the environment is terminated:

  • 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.

Type: Boolean

Valid Values: true | false

Default: true

No

Output

The command returns a table with the following information:

  • ApplicationName—The name of the application associated with this environment.

  • CNAME—The URL to the CNAME for this environment.

  • DateCreated—The date the environment was created.

  • DateUpdated—The date the environment was last updated.

  • Description—The description of the environment.

  • EndpointURL—The URL to the LoadBalancer for this environment.

  • EnvironmentID—The ID of this environment.

  • EnvironmentName—The name of this environment.

  • Health—Describes the health status of the environment. AWS Elastic Beanstalk indicates the failure levels for a running environment:

    • 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 RestartEnvironmentrequest.

  • Resources—A list of AWS resources used in this environment.

  • SolutionStackName—The name of the SolutionStack deployed with this environment.

  • Status—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.

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

  • VersionLabel—The application version deployed in this environment.

Examples

Terminating an Environment

This example shows how to terminate an environment.

PROMPT> elastic-beanstalk-terminate-environment -e MySampleAppEnv
Document Conventions« PreviousNext »
Terms of UseDid this page help you?  Yes | No |  Tell us about it...