Skip to content

DeleteEnvironmentRequest

Source code in docs_src/capo_appconfig/types/delete_environment_request.py 
12
13
14
15
16
17
18
19
20
class DeleteEnvironmentRequest(TypedDict, closed=True):
    environment_id: "capo_appconfig.types.name.Name"
    """<p>The ID of the environment that you want to delete.</p>"""
    application_id: "capo_appconfig.types.name.Name"
    """<p>The application ID that includes the environment that you want to delete.</p>"""
    deletion_protection_check: NotRequired[
        "capo_appconfig.types.deletion_protection_check.DeletionProtectionCheck"
    ]
    """<p>A parameter to configure deletion protection. Deletion protection prevents a user from deleting an environment if your application called either <a href="https://docs.aws.amazon.com/appconfig/2019-10-09/APIReference/API_appconfigdata_GetLatestConfiguration.html">GetLatestConfiguration</a> or in the environment during the specified interval. </p> <p>This parameter supports the following values:</p> <ul> <li> <p> <code>BYPASS</code>: Instructs AppConfig to bypass the deletion protection check and delete a configuration profile even if deletion protection would have otherwise prevented it. </p> </li> <li> <p> <code>APPLY</code>: Instructs the deletion protection check to run, even if deletion protection is disabled at the account level. <code>APPLY</code> also forces the deletion protection check to run against resources created in the past hour, which are normally excluded from deletion protection checks.</p> </li> <li> <p> <code>ACCOUNT_DEFAULT</code>: The default setting, which instructs AppConfig to implement the deletion protection value specified in the <code>UpdateAccountSettings</code> API.</p> </li> </ul>"""

application_id instance-attribute 

application_id: Name

The application ID that includes the environment that you want to delete.

deletion_protection_check instance-attribute 

deletion_protection_check: NotRequired[DeletionProtectionCheck]

A parameter to configure deletion protection. Deletion protection prevents a user from deleting an environment if your application called either GetLatestConfiguration or in the environment during the specified interval.

This parameter supports the following values:

  • BYPASS: Instructs AppConfig to bypass the deletion protection check and delete a configuration profile even if deletion protection would have otherwise prevented it.

  • APPLY: Instructs the deletion protection check to run, even if deletion protection is disabled at the account level. APPLY also forces the deletion protection check to run against resources created in the past hour, which are normally excluded from deletion protection checks.

  • ACCOUNT_DEFAULT: The default setting, which instructs AppConfig to implement the deletion protection value specified in the UpdateAccountSettings API.

environment_id instance-attribute 

environment_id: Name

The ID of the environment that you want to delete.