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

Inherits:
Struct
  • Object
show all
Includes:
Structure
Defined in:
lib/aws-sdk-elasticbeanstalk/types.rb

Overview

Request to terminate an environment.

See Also:

Constant Summary collapse

SENSITIVE = 
[]

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) 


4196
4197
4198
4199
4200
4201
4202
4203
 
# File 'lib/aws-sdk-elasticbeanstalk/types.rb', line 4196

class TerminateEnvironmentMessage < Struct.new(
  :environment_id,
  :environment_name,
  :terminate_resources,
  :force_terminate)
  SENSITIVE = []
  include Aws::Structure
end

#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) 


4196
4197
4198
4199
4200
4201
4202
4203
 
# File 'lib/aws-sdk-elasticbeanstalk/types.rb', line 4196

class TerminateEnvironmentMessage < Struct.new(
  :environment_id,
  :environment_name,
  :terminate_resources,
  :force_terminate)
  SENSITIVE = []
  include Aws::Structure
end

#force_terminate ⇒ Boolean

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

Returns:

  • (Boolean) 


4196
4197
4198
4199
4200
4201
4202
4203
 
# File 'lib/aws-sdk-elasticbeanstalk/types.rb', line 4196

class TerminateEnvironmentMessage < Struct.new(
  :environment_id,
  :environment_name,
  :terminate_resources,
  :force_terminate)
  SENSITIVE = []
  include Aws::Structure
end

#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. ][1]

Default: ‘true`

Valid Values: ‘true` | `false`

[1]: docs.aws.amazon.com/elasticbeanstalk/latest/ug/

Returns:

  • (Boolean) 


4196
4197
4198
4199
4200
4201
4202
4203
 
# File 'lib/aws-sdk-elasticbeanstalk/types.rb', line 4196

class TerminateEnvironmentMessage < Struct.new(
  :environment_id,
  :environment_name,
  :terminate_resources,
  :force_terminate)
  SENSITIVE = []
  include Aws::Structure
end