Amazonka.WAF.UpdateRuleGroup

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.

Inserts or deletes ActivatedRule objects in a RuleGroup.

You can only insert REGULAR rules into a rule group.

You can have a maximum of ten rules per rule group.

To create and configure a RuleGroup, perform the following steps:

1. Create and update the Rules that you want to include in the RuleGroup. See CreateRule.
2. Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of an UpdateRuleGroup request.
3. Submit an UpdateRuleGroup request to add Rules to the RuleGroup.
4. Create and update a WebACL that contains the RuleGroup. See CreateWebACL.

If you want to replace one Rule with another, you delete the existing one and add the new one.

For more information about how to use the AWS WAF API to allow or block HTTP requests, see the AWS WAF Developer Guide.

Creating a Request

data UpdateRuleGroup

See: newUpdateRuleGroup smart constructor.

Constructors

UpdateRuleGroup'

Fields

• ruleGroupId :: Text

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

• updates :: NonEmpty RuleGroupUpdate

  An array of RuleGroupUpdate objects that you want to insert into or delete from a RuleGroup.

  You can only insert REGULAR rules into a rule group.

  ActivatedRule|OverrideAction applies only when updating or adding a RuleGroup to a WebACL. In this case you do not use ActivatedRule|Action. For all other update requests, ActivatedRule|Action is used instead of ActivatedRule|OverrideAction.

• changeToken :: Text

  The value returned by the most recent call to GetChangeToken.

Instances

ToJSON UpdateRuleGroup

Defined in Amazonka.WAF.UpdateRuleGroup

Methods

toJSON :: UpdateRuleGroup -> Value

toEncoding :: UpdateRuleGroup -> Encoding

toJSONList :: [UpdateRuleGroup] -> Value

toEncodingList :: [UpdateRuleGroup] -> Encoding

ToHeaders UpdateRuleGroup

Defined in Amazonka.WAF.UpdateRuleGroup

Methods

toHeaders :: UpdateRuleGroup -> [Header]

ToPath UpdateRuleGroup

Defined in Amazonka.WAF.UpdateRuleGroup

Methods

toPath :: UpdateRuleGroup -> ByteString

ToQuery UpdateRuleGroup

Defined in Amazonka.WAF.UpdateRuleGroup

Methods

toQuery :: UpdateRuleGroup -> QueryString

AWSRequest UpdateRuleGroup

Defined in Amazonka.WAF.UpdateRuleGroup

Associated Types

type AWSResponse UpdateRuleGroup

Methods

request :: (Service -> Service) -> UpdateRuleGroup -> Request UpdateRuleGroup

response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy UpdateRuleGroup -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse UpdateRuleGroup)))

Generic UpdateRuleGroup

Defined in Amazonka.WAF.UpdateRuleGroup

Associated Types

type Rep UpdateRuleGroup :: Type -> Type

Methods

from :: UpdateRuleGroup -> Rep UpdateRuleGroup x

to :: Rep UpdateRuleGroup x -> UpdateRuleGroup

Read UpdateRuleGroup

Defined in Amazonka.WAF.UpdateRuleGroup

Methods

readsPrec :: Int -> ReadS UpdateRuleGroup

readList :: ReadS [UpdateRuleGroup]

readPrec :: ReadPrec UpdateRuleGroup

readListPrec :: ReadPrec [UpdateRuleGroup]

Show UpdateRuleGroup

Defined in Amazonka.WAF.UpdateRuleGroup

Methods

showsPrec :: Int -> UpdateRuleGroup -> ShowS

show :: UpdateRuleGroup -> String

showList :: [UpdateRuleGroup] -> ShowS

NFData UpdateRuleGroup

Defined in Amazonka.WAF.UpdateRuleGroup

Methods

rnf :: UpdateRuleGroup -> ()

Eq UpdateRuleGroup

Defined in Amazonka.WAF.UpdateRuleGroup

Methods

(==) :: UpdateRuleGroup -> UpdateRuleGroup -> Bool

(/=) :: UpdateRuleGroup -> UpdateRuleGroup -> Bool

Hashable UpdateRuleGroup

Defined in Amazonka.WAF.UpdateRuleGroup

Methods

hashWithSalt :: Int -> UpdateRuleGroup -> Int

hash :: UpdateRuleGroup -> Int

type AWSResponse UpdateRuleGroup

Defined in Amazonka.WAF.UpdateRuleGroup

type AWSResponse UpdateRuleGroup = UpdateRuleGroupResponse

type Rep UpdateRuleGroup

Defined in Amazonka.WAF.UpdateRuleGroup

type Rep UpdateRuleGroup = D1 ('MetaData "UpdateRuleGroup" "Amazonka.WAF.UpdateRuleGroup" "amazonka-waf-2.0-7D7QOxIEZeF1ayfX9AzEZC" 'False) (C1 ('MetaCons "UpdateRuleGroup'" 'PrefixI 'True) (S1 ('MetaSel ('Just "ruleGroupId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: (S1 ('MetaSel ('Just "updates") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (NonEmpty RuleGroupUpdate)) :*: S1 ('MetaSel ('Just "changeToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))

newUpdateRuleGroup

Arguments

:: Text

UpdateRuleGroup

-> NonEmpty RuleGroupUpdate

$sel:updates:UpdateRuleGroup'

-> Text

UpdateRuleGroup

-> UpdateRuleGroup

Create a value of UpdateRuleGroup 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:

UpdateRuleGroup, updateRuleGroup_ruleGroupId - The RuleGroupId of the RuleGroup that you want to update. RuleGroupId is returned by CreateRuleGroup and by ListRuleGroups.

$sel:updates:UpdateRuleGroup', updateRuleGroup_updates - An array of RuleGroupUpdate objects that you want to insert into or delete from a RuleGroup.

You can only insert REGULAR rules into a rule group.

ActivatedRule|OverrideAction applies only when updating or adding a RuleGroup to a WebACL. In this case you do not use ActivatedRule|Action. For all other update requests, ActivatedRule|Action is used instead of ActivatedRule|OverrideAction.

UpdateRuleGroup, updateRuleGroup_changeToken - The value returned by the most recent call to GetChangeToken.

Request Lenses

updateRuleGroup_ruleGroupId :: Lens' UpdateRuleGroup Text

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

updateRuleGroup_updates :: Lens' UpdateRuleGroup (NonEmpty RuleGroupUpdate)

An array of RuleGroupUpdate objects that you want to insert into or delete from a RuleGroup.

You can only insert REGULAR rules into a rule group.

ActivatedRule|OverrideAction applies only when updating or adding a RuleGroup to a WebACL. In this case you do not use ActivatedRule|Action. For all other update requests, ActivatedRule|Action is used instead of ActivatedRule|OverrideAction.

updateRuleGroup_changeToken :: Lens' UpdateRuleGroup Text

The value returned by the most recent call to GetChangeToken.

Destructuring the Response

data UpdateRuleGroupResponse

See: newUpdateRuleGroupResponse smart constructor.

Constructors

UpdateRuleGroupResponse'

Fields

• changeToken :: Maybe Text

  The ChangeToken that you used to submit the UpdateRuleGroup 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

Generic UpdateRuleGroupResponse

Defined in Amazonka.WAF.UpdateRuleGroup

Associated Types

type Rep UpdateRuleGroupResponse :: Type -> Type

Methods

from :: UpdateRuleGroupResponse -> Rep UpdateRuleGroupResponse x

to :: Rep UpdateRuleGroupResponse x -> UpdateRuleGroupResponse

Read UpdateRuleGroupResponse

Defined in Amazonka.WAF.UpdateRuleGroup

Methods

readsPrec :: Int -> ReadS UpdateRuleGroupResponse

readList :: ReadS [UpdateRuleGroupResponse]

readPrec :: ReadPrec UpdateRuleGroupResponse

readListPrec :: ReadPrec [UpdateRuleGroupResponse]

Show UpdateRuleGroupResponse

Defined in Amazonka.WAF.UpdateRuleGroup

Methods

showsPrec :: Int -> UpdateRuleGroupResponse -> ShowS

show :: UpdateRuleGroupResponse -> String

showList :: [UpdateRuleGroupResponse] -> ShowS

NFData UpdateRuleGroupResponse

Defined in Amazonka.WAF.UpdateRuleGroup

Methods

rnf :: UpdateRuleGroupResponse -> ()

Eq UpdateRuleGroupResponse

Defined in Amazonka.WAF.UpdateRuleGroup

Methods

(==) :: UpdateRuleGroupResponse -> UpdateRuleGroupResponse -> Bool

(/=) :: UpdateRuleGroupResponse -> UpdateRuleGroupResponse -> Bool

type Rep UpdateRuleGroupResponse

Defined in Amazonka.WAF.UpdateRuleGroup

type Rep UpdateRuleGroupResponse = D1 ('MetaData "UpdateRuleGroupResponse" "Amazonka.WAF.UpdateRuleGroup" "amazonka-waf-2.0-7D7QOxIEZeF1ayfX9AzEZC" 'False) (C1 ('MetaCons "UpdateRuleGroupResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "changeToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newUpdateRuleGroupResponse

Arguments

:: Int

$sel:httpStatus:UpdateRuleGroupResponse'

-> UpdateRuleGroupResponse

Create a value of UpdateRuleGroupResponse 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:

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

$sel:httpStatus:UpdateRuleGroupResponse', updateRuleGroupResponse_httpStatus - The response's http status code.

Response Lenses

updateRuleGroupResponse_changeToken :: Lens' UpdateRuleGroupResponse (Maybe Text)

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

updateRuleGroupResponse_httpStatus :: Lens' UpdateRuleGroupResponse Int

The response's http status code.