TerminateEnvironmentCommand

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

TerminateEnvironmentCommandInput

[TerminateEnvironmentCommandInput](@aws-sdk/client-elastic-beanstalk!TerminateEnvironmentCommandInput:Interface)

Terminates the specified environment.

EnvironmentId

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 <code>MissingRequiredParameter</code> error.

EnvironmentName

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 <code>MissingRequiredParameter</code> error.

ForceTerminate

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

TerminateResources

Indicates whether the associated AWS resources should shut down when the environment is terminated: <ul> <li> <code>true</code>: The specified environment as well as the associated AWS resources, such as Auto Scaling group and LoadBalancer, are terminated. </li> <li> <code>false</code>: AWS Elastic Beanstalk resource management is removed from the environment, but the AWS resources continue to operate. </li> </ul> For more information, see the <a href="https://docs.aws.amazon.com/elasticbeanstalk/latest/ug/"> AWS Elastic Beanstalk User Guide. </a> Default: <code>true</code> Valid Values: <code>true</code> | <code>false</code>

The input for [TerminateEnvironmentCommand](@aws-sdk/client-elastic-beanstalk!TerminateEnvironmentCommand:Class).

$metadata

AbortableOperationInProgress

Indicates if there is an in-progress environment configuration update or application version deployment that you can cancel. <code>true:</code> There is an update in progress. <code>false:</code> There are no updates currently in progress.

ApplicationName

The name of the application associated with this environment.

CNAME

The URL to the CNAME for this environment.

DateCreated

The creation date for this environment.

DateUpdated

The last modified date for this environment.

Description

EndpointURL

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

EnvironmentArn

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

EnvironmentLinks

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

Health

Describes the health status of the environment. AWS Elastic Beanstalk indicates the failure levels for a running environment: <ul> <li> <code>Red</code>: Indicates the environment is not responsive. Occurs when three or more consecutive failures occur for an environment. </li> <li> <code>Yellow</code>: Indicates that something is wrong. Occurs when two consecutive failures occur for an environment. </li> <li> <code>Green</code>: Indicates the environment is healthy and fully functional. </li> <li> <code>Grey</code>: 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 <code>UpdateEnvironment</code> or <code>RestartEnvironment</code> request. </li> </ul> Default: <code>Grey</code>

HealthStatus

Returns the health status of the application running in your environment. For more information, see <a href="https://docs.aws.amazon.com/elasticbeanstalk/latest/dg/health-enhanced-status.html">Health Colors and Statuses</a>.

OperationsRole

The Amazon Resource Name (ARN) of the environment's operations role. For more information, see <a href="https://docs.aws.amazon.com/elasticbeanstalk/latest/dg/iam-operationsrole.html">Operations roles</a> in the AWS Elastic Beanstalk Developer Guide.

PlatformArn

Resources

The description of the AWS resources used by this environment.

SolutionStackName

The name of the <code>SolutionStack</code> deployed with this environment.

Status

The current operational status of the environment: <ul> <li> <code>Launching</code>: Environment is in the process of initial deployment. </li> <li> <code>Updating</code>: Environment is in the process of updating its configuration settings or application version. </li> <li> <code>Ready</code>: Environment is available to have an action performed on it, such as update or terminate. </li> <li> <code>Terminating</code>: Environment is in the shut-down process. </li> <li> <code>Terminated</code>: Environment is not running. </li> </ul>

TemplateName

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

Tier

Describes the current tier of this environment.

VersionLabel

The application version deployed in this environment.

TerminateEnvironmentCommandOutput

The output of [TerminateEnvironmentCommand](@aws-sdk/client-elastic-beanstalk!TerminateEnvironmentCommand:Class).

$fault

$response

$retryable

(constructor)

options

Constructs a new instance of the <code>ServiceException</code> class

name

InsufficientPrivilegesException

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.