Up – Package index » awso » Library awso.securityhub » Awso_securityhub » Values » AwsWafRateBasedRuleDetails

Module `Values.AwsWafRateBasedRuleDetails`Source

Details about a rate-based rule for global resources. A rate-based rule provides settings to indicate when to allow, block, or count a request. Rate-based rules include the number of requests that arrive over a specified period of time.

Sourcetype nonrec t = {

metricName : NonEmptyString.t option;
(*
The name of the metrics for the rate-based rule.
*)
name : NonEmptyString.t option;
(*
The name of the rate-based rule.
*)
rateKey : NonEmptyString.t option;
(*
The field that WAF uses to determine whether requests are likely arriving from single source and are subject to rate monitoring.
*)
rateLimit : Long.t option;
(*
The maximum number of requests that have an identical value for the field specified in RateKey that are allowed within a five-minute period. If the number of requests exceeds RateLimit and the other predicates specified in the rule are met, WAF triggers the action for the rule.
*)
ruleId : NonEmptyString.t option;
(*
The unique identifier for the rate-based rule.
*)
matchPredicates : AwsWafRateBasedRuleMatchPredicateList.t option;
(*
The predicates to include in the rate-based rule.
*)

}

Source

val make : 
  ?metricName:??? ->
  ?name:??? ->
  ?rateKey:??? ->
  ?rateLimit:??? ->
  ?ruleId:??? ->
  ?matchPredicates:??? ->
  unit ->
  t

Source

val to_value : 
  t ->
  [> `Structure of
       (string
        * [> `List of
               [> `Structure of
                    (string
                     * [> `Boolean of Boolean.t | `String of NonEmptyString.t ])
                      list ]
                 list
          | `Long of Long.t
          | `String of NonEmptyString.t ])
         list ]

Sourceval to_query : t -> Awso.Client.Query.t

Sourceval of_xml : Awso.Xml.t -> t

Sourceval of_string : string -> t

Sourceval of_json : Yojson.Safe.t -> t

Sourceval to_json : t -> Yojson.Safe.t