aws_sdk_fms/operation/delete_policy/

_delete_policy_input.rs

// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
#[allow(missing_docs)] // documentation missing in model
#[non_exhaustive]
#[derive(::std::clone::Clone, ::std::cmp::PartialEq, ::std::fmt::Debug)]
pub struct DeletePolicyInput {
    /// <p>The ID of the policy that you want to delete. You can retrieve this ID from <code>PutPolicy</code> and <code>ListPolicies</code>.</p>
    pub policy_id: ::std::option::Option<::std::string::String>,
    /// <p>If <code>True</code>, the request performs cleanup according to the policy type.</p>
    /// <p>For WAF and Shield Advanced policies, the cleanup does the following:</p>
    /// <ul>
    /// <li>
    /// <p>Deletes rule groups created by Firewall Manager</p></li>
    /// <li>
    /// <p>Removes web ACLs from in-scope resources</p></li>
    /// <li>
    /// <p>Deletes web ACLs that contain no rules or rule groups</p></li>
    /// </ul>
    /// <p>For security group policies, the cleanup does the following for each security group in the policy:</p>
    /// <ul>
    /// <li>
    /// <p>Disassociates the security group from in-scope resources</p></li>
    /// <li>
    /// <p>Deletes the security group if it was created through Firewall Manager and if it's no longer associated with any resources through another policy</p></li>
    /// </ul><note>
    /// <p>For security group common policies, even if set to <code>False</code>, Firewall Manager deletes all security groups created by Firewall Manager that aren't associated with any other resources through another policy.</p>
    /// </note>
    /// <p>After the cleanup, in-scope resources are no longer protected by web ACLs in this policy. Protection of out-of-scope resources remains unchanged. Scope is determined by tags that you create and accounts that you associate with the policy. When creating the policy, if you specify that only resources in specific accounts or with specific tags are in scope of the policy, those accounts and resources are handled by the policy. All others are out of scope. If you don't specify tags or accounts, all resources are in scope.</p>
    pub delete_all_policy_resources: ::std::option::Option<bool>,
}
impl DeletePolicyInput {
    /// <p>The ID of the policy that you want to delete. You can retrieve this ID from <code>PutPolicy</code> and <code>ListPolicies</code>.</p>
    pub fn policy_id(&self) -> ::std::option::Option<&str> {
        self.policy_id.as_deref()
    }
    /// <p>If <code>True</code>, the request performs cleanup according to the policy type.</p>
    /// <p>For WAF and Shield Advanced policies, the cleanup does the following:</p>
    /// <ul>
    /// <li>
    /// <p>Deletes rule groups created by Firewall Manager</p></li>
    /// <li>
    /// <p>Removes web ACLs from in-scope resources</p></li>
    /// <li>
    /// <p>Deletes web ACLs that contain no rules or rule groups</p></li>
    /// </ul>
    /// <p>For security group policies, the cleanup does the following for each security group in the policy:</p>
    /// <ul>
    /// <li>
    /// <p>Disassociates the security group from in-scope resources</p></li>
    /// <li>
    /// <p>Deletes the security group if it was created through Firewall Manager and if it's no longer associated with any resources through another policy</p></li>
    /// </ul><note>
    /// <p>For security group common policies, even if set to <code>False</code>, Firewall Manager deletes all security groups created by Firewall Manager that aren't associated with any other resources through another policy.</p>
    /// </note>
    /// <p>After the cleanup, in-scope resources are no longer protected by web ACLs in this policy. Protection of out-of-scope resources remains unchanged. Scope is determined by tags that you create and accounts that you associate with the policy. When creating the policy, if you specify that only resources in specific accounts or with specific tags are in scope of the policy, those accounts and resources are handled by the policy. All others are out of scope. If you don't specify tags or accounts, all resources are in scope.</p>
    pub fn delete_all_policy_resources(&self) -> ::std::option::Option<bool> {
        self.delete_all_policy_resources
    }
}
impl DeletePolicyInput {
    /// Creates a new builder-style object to manufacture [`DeletePolicyInput`](crate::operation::delete_policy::DeletePolicyInput).
    pub fn builder() -> crate::operation::delete_policy::builders::DeletePolicyInputBuilder {
        crate::operation::delete_policy::builders::DeletePolicyInputBuilder::default()
    }
}

/// A builder for [`DeletePolicyInput`](crate::operation::delete_policy::DeletePolicyInput).
#[derive(::std::clone::Clone, ::std::cmp::PartialEq, ::std::default::Default, ::std::fmt::Debug)]
#[non_exhaustive]
pub struct DeletePolicyInputBuilder {
    pub(crate) policy_id: ::std::option::Option<::std::string::String>,
    pub(crate) delete_all_policy_resources: ::std::option::Option<bool>,
}
impl DeletePolicyInputBuilder {
    /// <p>The ID of the policy that you want to delete. You can retrieve this ID from <code>PutPolicy</code> and <code>ListPolicies</code>.</p>
    /// This field is required.
    pub fn policy_id(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
        self.policy_id = ::std::option::Option::Some(input.into());
        self
    }
    /// <p>The ID of the policy that you want to delete. You can retrieve this ID from <code>PutPolicy</code> and <code>ListPolicies</code>.</p>
    pub fn set_policy_id(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
        self.policy_id = input;
        self
    }
    /// <p>The ID of the policy that you want to delete. You can retrieve this ID from <code>PutPolicy</code> and <code>ListPolicies</code>.</p>
    pub fn get_policy_id(&self) -> &::std::option::Option<::std::string::String> {
        &self.policy_id
    }
    /// <p>If <code>True</code>, the request performs cleanup according to the policy type.</p>
    /// <p>For WAF and Shield Advanced policies, the cleanup does the following:</p>
    /// <ul>
    /// <li>
    /// <p>Deletes rule groups created by Firewall Manager</p></li>
    /// <li>
    /// <p>Removes web ACLs from in-scope resources</p></li>
    /// <li>
    /// <p>Deletes web ACLs that contain no rules or rule groups</p></li>
    /// </ul>
    /// <p>For security group policies, the cleanup does the following for each security group in the policy:</p>
    /// <ul>
    /// <li>
    /// <p>Disassociates the security group from in-scope resources</p></li>
    /// <li>
    /// <p>Deletes the security group if it was created through Firewall Manager and if it's no longer associated with any resources through another policy</p></li>
    /// </ul><note>
    /// <p>For security group common policies, even if set to <code>False</code>, Firewall Manager deletes all security groups created by Firewall Manager that aren't associated with any other resources through another policy.</p>
    /// </note>
    /// <p>After the cleanup, in-scope resources are no longer protected by web ACLs in this policy. Protection of out-of-scope resources remains unchanged. Scope is determined by tags that you create and accounts that you associate with the policy. When creating the policy, if you specify that only resources in specific accounts or with specific tags are in scope of the policy, those accounts and resources are handled by the policy. All others are out of scope. If you don't specify tags or accounts, all resources are in scope.</p>
    pub fn delete_all_policy_resources(mut self, input: bool) -> Self {
        self.delete_all_policy_resources = ::std::option::Option::Some(input);
        self
    }
    /// <p>If <code>True</code>, the request performs cleanup according to the policy type.</p>
    /// <p>For WAF and Shield Advanced policies, the cleanup does the following:</p>
    /// <ul>
    /// <li>
    /// <p>Deletes rule groups created by Firewall Manager</p></li>
    /// <li>
    /// <p>Removes web ACLs from in-scope resources</p></li>
    /// <li>
    /// <p>Deletes web ACLs that contain no rules or rule groups</p></li>
    /// </ul>
    /// <p>For security group policies, the cleanup does the following for each security group in the policy:</p>
    /// <ul>
    /// <li>
    /// <p>Disassociates the security group from in-scope resources</p></li>
    /// <li>
    /// <p>Deletes the security group if it was created through Firewall Manager and if it's no longer associated with any resources through another policy</p></li>
    /// </ul><note>
    /// <p>For security group common policies, even if set to <code>False</code>, Firewall Manager deletes all security groups created by Firewall Manager that aren't associated with any other resources through another policy.</p>
    /// </note>
    /// <p>After the cleanup, in-scope resources are no longer protected by web ACLs in this policy. Protection of out-of-scope resources remains unchanged. Scope is determined by tags that you create and accounts that you associate with the policy. When creating the policy, if you specify that only resources in specific accounts or with specific tags are in scope of the policy, those accounts and resources are handled by the policy. All others are out of scope. If you don't specify tags or accounts, all resources are in scope.</p>
    pub fn set_delete_all_policy_resources(mut self, input: ::std::option::Option<bool>) -> Self {
        self.delete_all_policy_resources = input;
        self
    }
    /// <p>If <code>True</code>, the request performs cleanup according to the policy type.</p>
    /// <p>For WAF and Shield Advanced policies, the cleanup does the following:</p>
    /// <ul>
    /// <li>
    /// <p>Deletes rule groups created by Firewall Manager</p></li>
    /// <li>
    /// <p>Removes web ACLs from in-scope resources</p></li>
    /// <li>
    /// <p>Deletes web ACLs that contain no rules or rule groups</p></li>
    /// </ul>
    /// <p>For security group policies, the cleanup does the following for each security group in the policy:</p>
    /// <ul>
    /// <li>
    /// <p>Disassociates the security group from in-scope resources</p></li>
    /// <li>
    /// <p>Deletes the security group if it was created through Firewall Manager and if it's no longer associated with any resources through another policy</p></li>
    /// </ul><note>
    /// <p>For security group common policies, even if set to <code>False</code>, Firewall Manager deletes all security groups created by Firewall Manager that aren't associated with any other resources through another policy.</p>
    /// </note>
    /// <p>After the cleanup, in-scope resources are no longer protected by web ACLs in this policy. Protection of out-of-scope resources remains unchanged. Scope is determined by tags that you create and accounts that you associate with the policy. When creating the policy, if you specify that only resources in specific accounts or with specific tags are in scope of the policy, those accounts and resources are handled by the policy. All others are out of scope. If you don't specify tags or accounts, all resources are in scope.</p>
    pub fn get_delete_all_policy_resources(&self) -> &::std::option::Option<bool> {
        &self.delete_all_policy_resources
    }
    /// Consumes the builder and constructs a [`DeletePolicyInput`](crate::operation::delete_policy::DeletePolicyInput).
    pub fn build(
        self,
    ) -> ::std::result::Result<crate::operation::delete_policy::DeletePolicyInput, ::aws_smithy_types::error::operation::BuildError> {
        ::std::result::Result::Ok(crate::operation::delete_policy::DeletePolicyInput {
            policy_id: self.policy_id,
            delete_all_policy_resources: self.delete_all_policy_resources,
        })
    }
}