Skip to content

/AWS1/CL_EBN=>TERMINATEENVIRONMENT()

About TerminateEnvironment

Terminates the specified environment.

Method Signature

IMPORTING

Optional arguments:

IV_ENVIRONMENTID TYPE /AWS1/EBNENVIRONMENTID /AWS1/EBNENVIRONMENTID

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.

IV_ENVIRONMENTNAME TYPE /AWS1/EBNENVIRONMENTNAME /AWS1/EBNENVIRONMENTNAME

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.

IV_TERMINATERESOURCES TYPE /AWS1/EBNTERMINATEENVIRONMEN00 /AWS1/EBNTERMINATEENVIRONMEN00

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

IV_FORCETERMINATE TYPE /AWS1/EBNFORCETERMINATE /AWS1/EBNFORCETERMINATE

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

RETURNING

OO_OUTPUT TYPE REF TO /AWS1/CL_EBNENVIRONMENTDESC /AWS1/CL_EBNENVIRONMENTDESC