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

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

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

Overview

Note:

When making an API call, you may pass TerminateEnvironmentMessage data as a hash:

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

Request to terminate an environment.

Instance Attribute Summary collapse

Instance Attribute Details

#environment_idString

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)


4006
4007
4008
4009
4010
4011
4012
# File 'gems/aws-sdk-elasticbeanstalk/lib/aws-sdk-elasticbeanstalk/types.rb', line 4006

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

#environment_nameString

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)


4006
4007
4008
4009
4010
4011
4012
# File 'gems/aws-sdk-elasticbeanstalk/lib/aws-sdk-elasticbeanstalk/types.rb', line 4006

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

#force_terminateBoolean

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

Returns:

  • (Boolean)


4006
4007
4008
4009
4010
4011
4012
# File 'gems/aws-sdk-elasticbeanstalk/lib/aws-sdk-elasticbeanstalk/types.rb', line 4006

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

#terminate_resourcesBoolean

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)


4006
4007
4008
4009
4010
4011
4012
# File 'gems/aws-sdk-elasticbeanstalk/lib/aws-sdk-elasticbeanstalk/types.rb', line 4006

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