TerminateEnvironmentCommand

Terminates the specified environment.

Example Syntax

Use a bare-bones client and the command you need to make an API call.

import { ElasticBeanstalkClient, TerminateEnvironmentCommand } from "@aws-sdk/client-elastic-beanstalk"; // ES Modules import
// const { ElasticBeanstalkClient, TerminateEnvironmentCommand } = require("@aws-sdk/client-elastic-beanstalk"); // CommonJS import
const client = new ElasticBeanstalkClient(config);
const input = { // TerminateEnvironmentMessage
  EnvironmentId: "STRING_VALUE",
  EnvironmentName: "STRING_VALUE",
  TerminateResources: true || false,
  ForceTerminate: true || false,
};
const command = new TerminateEnvironmentCommand(input);
const response = await client.send(command);
// { // EnvironmentDescription
//   EnvironmentName: "STRING_VALUE",
//   EnvironmentId: "STRING_VALUE",
//   ApplicationName: "STRING_VALUE",
//   VersionLabel: "STRING_VALUE",
//   SolutionStackName: "STRING_VALUE",
//   PlatformArn: "STRING_VALUE",
//   TemplateName: "STRING_VALUE",
//   Description: "STRING_VALUE",
//   EndpointURL: "STRING_VALUE",
//   CNAME: "STRING_VALUE",
//   DateCreated: new Date("TIMESTAMP"),
//   DateUpdated: new Date("TIMESTAMP"),
//   Status: "Aborting" || "Launching" || "Updating" || "LinkingFrom" || "LinkingTo" || "Ready" || "Terminating" || "Terminated",
//   AbortableOperationInProgress: true || false,
//   Health: "Green" || "Yellow" || "Red" || "Grey",
//   HealthStatus: "NoData" || "Unknown" || "Pending" || "Ok" || "Info" || "Warning" || "Degraded" || "Severe" || "Suspended",
//   Resources: { // EnvironmentResourcesDescription
//     LoadBalancer: { // LoadBalancerDescription
//       LoadBalancerName: "STRING_VALUE",
//       Domain: "STRING_VALUE",
//       Listeners: [ // LoadBalancerListenersDescription
//         { // Listener
//           Protocol: "STRING_VALUE",
//           Port: Number("int"),
//         },
//       ],
//     },
//   },
//   Tier: { // EnvironmentTier
//     Name: "STRING_VALUE",
//     Type: "STRING_VALUE",
//     Version: "STRING_VALUE",
//   },
//   EnvironmentLinks: [ // EnvironmentLinks
//     { // EnvironmentLink
//       LinkName: "STRING_VALUE",
//       EnvironmentName: "STRING_VALUE",
//     },
//   ],
//   EnvironmentArn: "STRING_VALUE",
//   OperationsRole: "STRING_VALUE",
// };

Example Usage

 There was an error loading the code editor. Retry

TerminateEnvironmentCommand Input

Parameter
Type
Description
EnvironmentId
string | undefined

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.

EnvironmentName
string | undefined

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.

ForceTerminate
boolean | undefined

Terminates the target environment even if another environment in the same group is dependent on it.

TerminateResources
boolean | undefined

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.

For more information, see the AWS Elastic Beanstalk User Guide.  

Default: true

Valid Values: true | false

TerminateEnvironmentCommand Output

Parameter
Type
Description
$metadata
Required
ResponseMetadata
Metadata pertaining to this request.
AbortableOperationInProgress
boolean | undefined

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.

ApplicationName
string | undefined

The name of the application associated with this environment.

CNAME
string | undefined

The URL to the CNAME for this environment.

DateCreated
Date | undefined

The creation date for this environment.

DateUpdated
Date | undefined

The last modified date for this environment.

Description
string | undefined

Describes this environment.

EndpointURL
string | undefined

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

EnvironmentArn
string | undefined

The environment's Amazon Resource Name (ARN), which can be used in other API requests that require an ARN.

EnvironmentId
string | undefined

The ID of this environment.

EnvironmentLinks
EnvironmentLink[] | undefined

A list of links to other environments in the same group.

EnvironmentName
string | undefined

The name of this environment.

Health
EnvironmentHealth | undefined

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 RestartEnvironment request.

Default: Grey

HealthStatus
EnvironmentHealthStatus | undefined

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

OperationsRole
string | undefined

The Amazon Resource Name (ARN) of the environment's operations role. For more information, see Operations roles  in the AWS Elastic Beanstalk Developer Guide.

PlatformArn
string | undefined

The ARN of the platform version.

Resources
EnvironmentResourcesDescription | undefined

The description of the AWS resources used by this environment.

SolutionStackName
string | undefined

The name of the SolutionStack deployed with this environment.

Status
EnvironmentStatus | undefined

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
string | undefined

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

Tier
EnvironmentTier | undefined

Describes the current tier of this environment.

VersionLabel
string | undefined

The application version deployed in this environment.

Throws

Name
Fault
Details
InsufficientPrivilegesException
client

The specified account does not have sufficient privileges for one or more AWS services.

ElasticBeanstalkServiceException
Base exception class for all service exceptions from ElasticBeanstalk service.