libZSservicesZSamazonka-fmsZSamazonka-fms
Copyright(c) 2013-2021 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay+amazonka@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone

Amazonka.FMS.DeletePolicy

Description

Permanently deletes an Firewall Manager policy.

Synopsis

Creating a Request

data DeletePolicy Source #

See: newDeletePolicy smart constructor.

Constructors

DeletePolicy' 

Fields

  • deleteAllPolicyResources :: Maybe Bool

    If True, the request performs cleanup according to the policy type.

    For WAF and Shield Advanced policies, the cleanup does the following:

    • Deletes rule groups created by Firewall Manager
    • Removes web ACLs from in-scope resources
    • Deletes web ACLs that contain no rules or rule groups

    For security group policies, the cleanup does the following for each security group in the policy:

    • Disassociates the security group from in-scope resources
    • Deletes the security group if it was created through Firewall Manager and if it's no longer associated with any resources through another policy

    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.

  • policyId :: Text

    The ID of the policy that you want to delete. You can retrieve this ID from PutPolicy and ListPolicies.

Instances

Instances details
Eq DeletePolicy Source # 
Instance details

Defined in Amazonka.FMS.DeletePolicy

Read DeletePolicy Source # 
Instance details

Defined in Amazonka.FMS.DeletePolicy

Show DeletePolicy Source # 
Instance details

Defined in Amazonka.FMS.DeletePolicy

Generic DeletePolicy Source # 
Instance details

Defined in Amazonka.FMS.DeletePolicy

Associated Types

type Rep DeletePolicy :: Type -> Type #

NFData DeletePolicy Source # 
Instance details

Defined in Amazonka.FMS.DeletePolicy

Methods

rnf :: DeletePolicy -> () #

Hashable DeletePolicy Source # 
Instance details

Defined in Amazonka.FMS.DeletePolicy

ToJSON DeletePolicy Source # 
Instance details

Defined in Amazonka.FMS.DeletePolicy

AWSRequest DeletePolicy Source # 
Instance details

Defined in Amazonka.FMS.DeletePolicy

Associated Types

type AWSResponse DeletePolicy #

ToHeaders DeletePolicy Source # 
Instance details

Defined in Amazonka.FMS.DeletePolicy

ToPath DeletePolicy Source # 
Instance details

Defined in Amazonka.FMS.DeletePolicy

ToQuery DeletePolicy Source # 
Instance details

Defined in Amazonka.FMS.DeletePolicy

type Rep DeletePolicy Source # 
Instance details

Defined in Amazonka.FMS.DeletePolicy

type Rep DeletePolicy = D1 ('MetaData "DeletePolicy" "Amazonka.FMS.DeletePolicy" "libZSservicesZSamazonka-fmsZSamazonka-fms" 'False) (C1 ('MetaCons "DeletePolicy'" 'PrefixI 'True) (S1 ('MetaSel ('Just "deleteAllPolicyResources") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :*: S1 ('MetaSel ('Just "policyId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))
type AWSResponse DeletePolicy Source # 
Instance details

Defined in Amazonka.FMS.DeletePolicy

newDeletePolicy Source #

Create a value of DeletePolicy with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:deleteAllPolicyResources:DeletePolicy', deletePolicy_deleteAllPolicyResources - If True, the request performs cleanup according to the policy type.

For WAF and Shield Advanced policies, the cleanup does the following:

  • Deletes rule groups created by Firewall Manager
  • Removes web ACLs from in-scope resources
  • Deletes web ACLs that contain no rules or rule groups

For security group policies, the cleanup does the following for each security group in the policy:

  • Disassociates the security group from in-scope resources
  • Deletes the security group if it was created through Firewall Manager and if it's no longer associated with any resources through another policy

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.

$sel:policyId:DeletePolicy', deletePolicy_policyId - The ID of the policy that you want to delete. You can retrieve this ID from PutPolicy and ListPolicies.

Request Lenses

deletePolicy_deleteAllPolicyResources :: Lens' DeletePolicy (Maybe Bool) Source #

If True, the request performs cleanup according to the policy type.

For WAF and Shield Advanced policies, the cleanup does the following:

  • Deletes rule groups created by Firewall Manager
  • Removes web ACLs from in-scope resources
  • Deletes web ACLs that contain no rules or rule groups

For security group policies, the cleanup does the following for each security group in the policy:

  • Disassociates the security group from in-scope resources
  • Deletes the security group if it was created through Firewall Manager and if it's no longer associated with any resources through another policy

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.

deletePolicy_policyId :: Lens' DeletePolicy Text Source #

The ID of the policy that you want to delete. You can retrieve this ID from PutPolicy and ListPolicies.

Destructuring the Response

data DeletePolicyResponse Source #

See: newDeletePolicyResponse smart constructor.

Constructors

DeletePolicyResponse' 

newDeletePolicyResponse :: DeletePolicyResponse Source #

Create a value of DeletePolicyResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.