RateBasedRule

public struct RateBasedRule : AWSShape

Undocumented

  • Declaration

    Swift

    public static var _members: [AWSShapeMember]

  • The Predicates object contains one Predicate element for each ByteMatchSet, IPSet, or SqlInjectionMatchSet object that you want to include in a RateBasedRule.

    Declaration

    Swift

    public let matchPredicates: [Predicate]

  • A friendly name or description for the metrics for a RateBasedRule. The name can contain only alphanumeric characters (A-Z, a-z, 0-9), with maximum length 128 and minimum length one. It can’t contain whitespace or metric names reserved for AWS WAF, including “All” and “Default_Action.” You can’t change the name of the metric after you create the RateBasedRule.

    Declaration

    Swift

    public let metricName: String?

  • A friendly name or description for a RateBasedRule. You can’t change the name of a RateBasedRule after you create it.

    Declaration

    Swift

    public let name: String?

  • The field that AWS WAF uses to determine if requests are likely arriving from single source and thus subject to rate monitoring. The only valid value for RateKey is IP. IP indicates that requests arriving from the same IP address are subject to the RateLimit that is specified in the RateBasedRule.

    Declaration

    Swift

    public let rateKey: RateKey

  • The maximum number of requests, which have an identical value in the field specified by the RateKey, allowed in a five-minute period. If the number of requests exceeds the RateLimit and the other predicates specified in the rule are also met, AWS WAF triggers the action that is specified for this rule.

    Declaration

    Swift

    public let rateLimit: Int64

  • A unique identifier for a RateBasedRule. You use RuleId to get more information about a RateBasedRule (see GetRateBasedRule), update a RateBasedRule (see UpdateRateBasedRule), insert a RateBasedRule into a WebACL or delete one from a WebACL (see UpdateWebACL), or delete a RateBasedRule from AWS WAF (see DeleteRateBasedRule).

    Declaration

    Swift

    public let ruleId: String

  • Undocumented

    Declaration

    Swift

    public init(matchPredicates: [Predicate], metricName: String? = nil, name: String? = nil, rateKey: RateKey, rateLimit: Int64, ruleId: String)