aws_sdk_appconfig/client/
delete_environment.rs

1// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
2impl super::Client {
3    /// Constructs a fluent builder for the [`DeleteEnvironment`](crate::operation::delete_environment::builders::DeleteEnvironmentFluentBuilder) operation.
4    ///
5    /// - The fluent builder is configurable:
6    ///   - [`environment_id(impl Into<String>)`](crate::operation::delete_environment::builders::DeleteEnvironmentFluentBuilder::environment_id) / [`set_environment_id(Option<String>)`](crate::operation::delete_environment::builders::DeleteEnvironmentFluentBuilder::set_environment_id):<br>required: **true**<br><p>The ID of the environment that you want to delete.</p><br>
7    ///   - [`application_id(impl Into<String>)`](crate::operation::delete_environment::builders::DeleteEnvironmentFluentBuilder::application_id) / [`set_application_id(Option<String>)`](crate::operation::delete_environment::builders::DeleteEnvironmentFluentBuilder::set_application_id):<br>required: **true**<br><p>The application ID that includes the environment that you want to delete.</p><br>
8    ///   - [`deletion_protection_check(DeletionProtectionCheck)`](crate::operation::delete_environment::builders::DeleteEnvironmentFluentBuilder::deletion_protection_check) / [`set_deletion_protection_check(Option<DeletionProtectionCheck>)`](crate::operation::delete_environment::builders::DeleteEnvironmentFluentBuilder::set_deletion_protection_check):<br>required: **false**<br><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><br>
9    /// - On success, responds with [`DeleteEnvironmentOutput`](crate::operation::delete_environment::DeleteEnvironmentOutput)
10    /// - On failure, responds with [`SdkError<DeleteEnvironmentError>`](crate::operation::delete_environment::DeleteEnvironmentError)
11    pub fn delete_environment(&self) -> crate::operation::delete_environment::builders::DeleteEnvironmentFluentBuilder {
12        crate::operation::delete_environment::builders::DeleteEnvironmentFluentBuilder::new(self.handle.clone())
13    }
14}