Amazonka.WAFRegional.UpdateRule

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 Predicate objects in a Rule. Each Predicate object identifies a predicate, such as a ByteMatchSet or an IPSet, that specifies the web requests that you want to allow, block, or count. If you add more than one predicate to a Rule, a request must match all of the specifications to be allowed, blocked, or counted. For example, suppose that you add the following to a Rule:

• A ByteMatchSet that matches the value BadBot in the User-Agent header
• An IPSet that matches the IP address 192.0.2.44

You then add the Rule to a WebACL and specify that you want to block requests that satisfy the Rule. For a request to be blocked, the User-Agent header in the request must contain the value BadBot and the request must originate from the IP address 192.0.2.44.

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

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

If you want to replace one ByteMatchSet or IPSet 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 UpdateRule

See: newUpdateRule smart constructor.

Constructors

UpdateRule'

Fields

• ruleId :: Text

  The RuleId of the Rule that you want to update. RuleId is returned by CreateRule and by ListRules.

• changeToken :: Text

  The value returned by the most recent call to GetChangeToken.

• updates :: [RuleUpdate]

  An array of RuleUpdate objects that you want to insert into or delete from a Rule. For more information, see the applicable data types:

  • RuleUpdate: Contains Action and Predicate
  • Predicate: Contains DataId, Negated, and Type
  • FieldToMatch: Contains Data and Type

Instances

ToJSON UpdateRule

Defined in Amazonka.WAFRegional.UpdateRule

Methods

toJSON :: UpdateRule -> Value

toEncoding :: UpdateRule -> Encoding

toJSONList :: [UpdateRule] -> Value

toEncodingList :: [UpdateRule] -> Encoding

ToHeaders UpdateRule

Defined in Amazonka.WAFRegional.UpdateRule

Methods

toHeaders :: UpdateRule -> [Header]

ToPath UpdateRule

Defined in Amazonka.WAFRegional.UpdateRule

Methods

toPath :: UpdateRule -> ByteString

ToQuery UpdateRule

Defined in Amazonka.WAFRegional.UpdateRule

Methods

toQuery :: UpdateRule -> QueryString

AWSRequest UpdateRule

Defined in Amazonka.WAFRegional.UpdateRule

Associated Types

type AWSResponse UpdateRule

Methods

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

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

Generic UpdateRule

Defined in Amazonka.WAFRegional.UpdateRule

Associated Types

type Rep UpdateRule :: Type -> Type

Methods

from :: UpdateRule -> Rep UpdateRule x

to :: Rep UpdateRule x -> UpdateRule

Read UpdateRule

Defined in Amazonka.WAFRegional.UpdateRule

Methods

readsPrec :: Int -> ReadS UpdateRule

readList :: ReadS [UpdateRule]

readPrec :: ReadPrec UpdateRule

readListPrec :: ReadPrec [UpdateRule]

Show UpdateRule

Defined in Amazonka.WAFRegional.UpdateRule

Methods

showsPrec :: Int -> UpdateRule -> ShowS

show :: UpdateRule -> String

showList :: [UpdateRule] -> ShowS

NFData UpdateRule

Defined in Amazonka.WAFRegional.UpdateRule

Methods

rnf :: UpdateRule -> ()

Eq UpdateRule

Defined in Amazonka.WAFRegional.UpdateRule

Methods

(==) :: UpdateRule -> UpdateRule -> Bool

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

Hashable UpdateRule

Defined in Amazonka.WAFRegional.UpdateRule

Methods

hashWithSalt :: Int -> UpdateRule -> Int

hash :: UpdateRule -> Int

type AWSResponse UpdateRule

Defined in Amazonka.WAFRegional.UpdateRule

type AWSResponse UpdateRule = UpdateRuleResponse

type Rep UpdateRule

Defined in Amazonka.WAFRegional.UpdateRule

type Rep UpdateRule = D1 ('MetaData "UpdateRule" "Amazonka.WAFRegional.UpdateRule" "amazonka-waf-regional-2.0-83dY3vKOuQzAAW7M6EmzRI" 'False) (C1 ('MetaCons "UpdateRule'" 'PrefixI 'True) (S1 ('MetaSel ('Just "ruleId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: (S1 ('MetaSel ('Just "changeToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "updates") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 [RuleUpdate]))))

newUpdateRule

Arguments

:: Text

UpdateRule

-> Text

UpdateRule

-> UpdateRule

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

UpdateRule, updateRule_ruleId - The RuleId of the Rule that you want to update. RuleId is returned by CreateRule and by ListRules.

UpdateRule, updateRule_changeToken - The value returned by the most recent call to GetChangeToken.

$sel:updates:UpdateRule', updateRule_updates - An array of RuleUpdate objects that you want to insert into or delete from a Rule. For more information, see the applicable data types:

• RuleUpdate: Contains Action and Predicate
• Predicate: Contains DataId, Negated, and Type
• FieldToMatch: Contains Data and Type

Request Lenses

updateRule_ruleId :: Lens' UpdateRule Text

The RuleId of the Rule that you want to update. RuleId is returned by CreateRule and by ListRules.

updateRule_changeToken :: Lens' UpdateRule Text

The value returned by the most recent call to GetChangeToken.

updateRule_updates :: Lens' UpdateRule [RuleUpdate]

An array of RuleUpdate objects that you want to insert into or delete from a Rule. For more information, see the applicable data types:

• RuleUpdate: Contains Action and Predicate
• Predicate: Contains DataId, Negated, and Type
• FieldToMatch: Contains Data and Type

Destructuring the Response

data UpdateRuleResponse

See: newUpdateRuleResponse smart constructor.

Constructors

UpdateRuleResponse'

Fields

• changeToken :: Maybe Text

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

Defined in Amazonka.WAFRegional.UpdateRule

Associated Types

type Rep UpdateRuleResponse :: Type -> Type

Methods

from :: UpdateRuleResponse -> Rep UpdateRuleResponse x

to :: Rep UpdateRuleResponse x -> UpdateRuleResponse

Read UpdateRuleResponse

Defined in Amazonka.WAFRegional.UpdateRule

Methods

readsPrec :: Int -> ReadS UpdateRuleResponse

readList :: ReadS [UpdateRuleResponse]

readPrec :: ReadPrec UpdateRuleResponse

readListPrec :: ReadPrec [UpdateRuleResponse]

Show UpdateRuleResponse

Defined in Amazonka.WAFRegional.UpdateRule

Methods

showsPrec :: Int -> UpdateRuleResponse -> ShowS

show :: UpdateRuleResponse -> String

showList :: [UpdateRuleResponse] -> ShowS

NFData UpdateRuleResponse

Defined in Amazonka.WAFRegional.UpdateRule

Methods

rnf :: UpdateRuleResponse -> ()

Eq UpdateRuleResponse

Defined in Amazonka.WAFRegional.UpdateRule

Methods

(==) :: UpdateRuleResponse -> UpdateRuleResponse -> Bool

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

type Rep UpdateRuleResponse

Defined in Amazonka.WAFRegional.UpdateRule

type Rep UpdateRuleResponse = D1 ('MetaData "UpdateRuleResponse" "Amazonka.WAFRegional.UpdateRule" "amazonka-waf-regional-2.0-83dY3vKOuQzAAW7M6EmzRI" 'False) (C1 ('MetaCons "UpdateRuleResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "changeToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newUpdateRuleResponse

Arguments

:: Int

$sel:httpStatus:UpdateRuleResponse'

-> UpdateRuleResponse

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

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

$sel:httpStatus:UpdateRuleResponse', updateRuleResponse_httpStatus - The response's http status code.

Response Lenses

updateRuleResponse_changeToken :: Lens' UpdateRuleResponse (Maybe Text)

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

updateRuleResponse_httpStatus :: Lens' UpdateRuleResponse Int

The response's http status code.