Skip to content

TerminateEnvironmentMessage

Source code in docs_src/capo_elastic_beanstalk/types/terminate_environment_message.py 
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
class TerminateEnvironmentMessage(TypedDict, closed=True):
    environment_id: NotRequired[
        "capo_elastic_beanstalk.types.environment_id.EnvironmentId"
    ]
    """<p>The ID of the environment to terminate.</p> <p> Condition: You must specify either this or an EnvironmentName, or both. If you do not specify either, Elastic Beanstalk returns <code>MissingRequiredParameter</code> error. </p>"""
    environment_name: NotRequired[
        "capo_elastic_beanstalk.types.environment_name.EnvironmentName"
    ]
    """<p>The name of the environment to terminate.</p> <p> Condition: You must specify either this or an EnvironmentId, or both. If you do not specify either, Elastic Beanstalk returns <code>MissingRequiredParameter</code> error. </p>"""
    terminate_resources: NotRequired[
        "capo_elastic_beanstalk.types.terminate_environment_resources.TerminateEnvironmentResources"
    ]
    """<p>Indicates whether the associated Amazon Web Services resources should shut down when the environment is terminated:</p> <ul> <li> <p> <code>true</code>: The specified environment as well as the associated Amazon Web Services resources, such as Auto Scaling group and LoadBalancer, are terminated.</p> </li> <li> <p> <code>false</code>: Elastic Beanstalk resource management is removed from the environment, but the Amazon Web Services resources continue to operate.</p> </li> </ul> <p> For more information, see the <a href="https://docs.aws.amazon.com/elasticbeanstalk/latest/ug/"> Elastic Beanstalk User Guide. </a> </p> <p> Default: <code>true</code> </p> <p> Valid Values: <code>true</code> | <code>false</code> </p>"""
    force_terminate: NotRequired[
        "capo_elastic_beanstalk.types.force_terminate.ForceTerminate"
    ]
    """<p>Terminates the target environment even if another environment in the same group is dependent on it.</p>"""

environment_id instance-attribute 

environment_id: NotRequired[EnvironmentId]

The ID of the environment to terminate.

Condition: You must specify either this or an EnvironmentName, or both. If you do not specify either, Elastic Beanstalk returns MissingRequiredParameter error.

environment_name instance-attribute 

environment_name: NotRequired[EnvironmentName]

The name of the environment to terminate.

Condition: You must specify either this or an EnvironmentId, or both. If you do not specify either, Elastic Beanstalk returns MissingRequiredParameter error.

force_terminate instance-attribute 

force_terminate: NotRequired[ForceTerminate]

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

terminate_resources instance-attribute 

terminate_resources: NotRequired[TerminateEnvironmentResources]

Indicates whether the associated Amazon Web Services resources should shut down when the environment is terminated:

  • true: The specified environment as well as the associated Amazon Web Services resources, such as Auto Scaling group and LoadBalancer, are terminated.

  • false: Elastic Beanstalk resource management is removed from the environment, but the Amazon Web Services resources continue to operate.

For more information, see the Elastic Beanstalk User Guide.

Default: true

Valid Values: true | false