class Aws::ElasticBeanstalk::Types::TerminateEnvironmentMessage
Request to terminate an environment.
@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, }
@!attribute [rw] environment_id
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. @return [String]
@!attribute [rw] environment_name
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. @return [String]
@!attribute [rw] terminate_resources
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]: https://docs.aws.amazon.com/elasticbeanstalk/latest/ug/ @return [Boolean]
@!attribute [rw] force_terminate
Terminates the target environment even if another environment in the same group is dependent on it. @return [Boolean]
@see docs.aws.amazon.com/goto/WebAPI/elasticbeanstalk-2010-12-01/TerminateEnvironmentMessage AWS API Documentation
Constants
- SENSITIVE