You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.

Class: Aws::ElasticBeanstalk::Types::TerminateEnvironmentMessage

Inherits:
Struct
  • Object
show all
Defined in:
(unknown)

Overview

Note:

When passing TerminateEnvironmentMessage as input to an Aws::Client method, you can use a vanilla Hash:

{
  environment_id: "EnvironmentId",
  environment_name: "EnvironmentName",
  terminate_resources: false,
  force_terminate: false,
}

Request to terminate an environment.

See Also:

Instance Attribute Summary collapse

Instance Attribute Details

#environment_id ⇒ String

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.

Returns:

  • (String) —

    The ID of the environment to terminate.

#environment_name ⇒ String

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.

Returns:

  • (String) —

    The name of the environment to terminate.

#force_terminate ⇒ Boolean

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

Returns:

  • (Boolean) —

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

#terminate_resources ⇒ Boolean

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

Returns:

  • (Boolean) —

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