libZSservicesZSamazonka-waf-regionalZSamazonka-waf-regional
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.WAFRegional.DeleteRuleGroup

Description

This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide.

For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.

Permanently deletes a RuleGroup. You can't delete a RuleGroup if it's still used in any WebACL objects or if it still includes any rules.

If you just want to remove a RuleGroup from a WebACL, use UpdateWebACL.

To permanently delete a RuleGroup from AWS WAF, perform the following steps:

  1. Update the RuleGroup to remove rules, if any. For more information, see UpdateRuleGroup.
  2. Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of a DeleteRuleGroup request.
  3. Submit a DeleteRuleGroup request.
Synopsis

Creating a Request

data DeleteRuleGroup Source #

See: newDeleteRuleGroup smart constructor.

Constructors

DeleteRuleGroup' 

Fields

  • ruleGroupId :: Text

    The RuleGroupId of the RuleGroup that you want to delete. RuleGroupId is returned by CreateRuleGroup and by ListRuleGroups.

  • changeToken :: Text

    The value returned by the most recent call to GetChangeToken.

Instances

Instances details
Eq DeleteRuleGroup Source # 
Instance details

Defined in Amazonka.WAFRegional.DeleteRuleGroup

Read DeleteRuleGroup Source # 
Instance details

Defined in Amazonka.WAFRegional.DeleteRuleGroup

Show DeleteRuleGroup Source # 
Instance details

Defined in Amazonka.WAFRegional.DeleteRuleGroup

Generic DeleteRuleGroup Source # 
Instance details

Defined in Amazonka.WAFRegional.DeleteRuleGroup

Associated Types

type Rep DeleteRuleGroup :: Type -> Type #

NFData DeleteRuleGroup Source # 
Instance details

Defined in Amazonka.WAFRegional.DeleteRuleGroup

Methods

rnf :: DeleteRuleGroup -> () #

Hashable DeleteRuleGroup Source # 
Instance details

Defined in Amazonka.WAFRegional.DeleteRuleGroup

ToJSON DeleteRuleGroup Source # 
Instance details

Defined in Amazonka.WAFRegional.DeleteRuleGroup

AWSRequest DeleteRuleGroup Source # 
Instance details

Defined in Amazonka.WAFRegional.DeleteRuleGroup

Associated Types

type AWSResponse DeleteRuleGroup #

ToHeaders DeleteRuleGroup Source # 
Instance details

Defined in Amazonka.WAFRegional.DeleteRuleGroup

ToPath DeleteRuleGroup Source # 
Instance details

Defined in Amazonka.WAFRegional.DeleteRuleGroup

ToQuery DeleteRuleGroup Source # 
Instance details

Defined in Amazonka.WAFRegional.DeleteRuleGroup

type Rep DeleteRuleGroup Source # 
Instance details

Defined in Amazonka.WAFRegional.DeleteRuleGroup

type Rep DeleteRuleGroup = D1 ('MetaData "DeleteRuleGroup" "Amazonka.WAFRegional.DeleteRuleGroup" "libZSservicesZSamazonka-waf-regionalZSamazonka-waf-regional" 'False) (C1 ('MetaCons "DeleteRuleGroup'" 'PrefixI 'True) (S1 ('MetaSel ('Just "ruleGroupId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "changeToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))
type AWSResponse DeleteRuleGroup Source # 
Instance details

Defined in Amazonka.WAFRegional.DeleteRuleGroup

newDeleteRuleGroup Source #

Create a value of DeleteRuleGroup 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:ruleGroupId:DeleteRuleGroup', deleteRuleGroup_ruleGroupId - The RuleGroupId of the RuleGroup that you want to delete. RuleGroupId is returned by CreateRuleGroup and by ListRuleGroups.

$sel:changeToken:DeleteRuleGroup', deleteRuleGroup_changeToken - The value returned by the most recent call to GetChangeToken.

Request Lenses

deleteRuleGroup_ruleGroupId :: Lens' DeleteRuleGroup Text Source #

The RuleGroupId of the RuleGroup that you want to delete. RuleGroupId is returned by CreateRuleGroup and by ListRuleGroups.

deleteRuleGroup_changeToken :: Lens' DeleteRuleGroup Text Source #

The value returned by the most recent call to GetChangeToken.

Destructuring the Response

data DeleteRuleGroupResponse Source #

See: newDeleteRuleGroupResponse smart constructor.

Constructors

DeleteRuleGroupResponse' 

Fields

  • changeToken :: Maybe Text

    The ChangeToken that you used to submit the DeleteRuleGroup request. You can also use this value to query the status of the request. For more information, see GetChangeTokenStatus.

  • httpStatus :: Int

    The response's http status code.

Instances

Instances details
Eq DeleteRuleGroupResponse Source # 
Instance details

Defined in Amazonka.WAFRegional.DeleteRuleGroup

Read DeleteRuleGroupResponse Source # 
Instance details

Defined in Amazonka.WAFRegional.DeleteRuleGroup

Show DeleteRuleGroupResponse Source # 
Instance details

Defined in Amazonka.WAFRegional.DeleteRuleGroup

Generic DeleteRuleGroupResponse Source # 
Instance details

Defined in Amazonka.WAFRegional.DeleteRuleGroup

Associated Types

type Rep DeleteRuleGroupResponse :: Type -> Type #

NFData DeleteRuleGroupResponse Source # 
Instance details

Defined in Amazonka.WAFRegional.DeleteRuleGroup

Methods

rnf :: DeleteRuleGroupResponse -> () #

type Rep DeleteRuleGroupResponse Source # 
Instance details

Defined in Amazonka.WAFRegional.DeleteRuleGroup

type Rep DeleteRuleGroupResponse = D1 ('MetaData "DeleteRuleGroupResponse" "Amazonka.WAFRegional.DeleteRuleGroup" "libZSservicesZSamazonka-waf-regionalZSamazonka-waf-regional" 'False) (C1 ('MetaCons "DeleteRuleGroupResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "changeToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newDeleteRuleGroupResponse Source #

Create a value of DeleteRuleGroupResponse 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:changeToken:DeleteRuleGroup', deleteRuleGroupResponse_changeToken - The ChangeToken that you used to submit the DeleteRuleGroup request. You can also use this value to query the status of the request. For more information, see GetChangeTokenStatus.

$sel:httpStatus:DeleteRuleGroupResponse', deleteRuleGroupResponse_httpStatus - The response's http status code.

Response Lenses

deleteRuleGroupResponse_changeToken :: Lens' DeleteRuleGroupResponse (Maybe Text) Source #

The ChangeToken that you used to submit the DeleteRuleGroup request. You can also use this value to query the status of the request. For more information, see GetChangeTokenStatus.