RateBasedStatement

public class RateBasedStatement : AWSShape

Undocumented

  • Declaration

    Swift

    public static var _members: [AWSShapeMember]

  • Setting that indicates how to aggregate the request counts. The options are the following: IP - Aggregate the request counts on the IP address from the web request origin. FORWARDED_IP - Aggregate the request counts on the first IP address in an HTTP header. If you use this, configure the ForwardedIPConfig, to specify the header to use.

    Declaration

    Swift

    public let aggregateKeyType: RateBasedStatementAggregateKeyType

  • The configuration for inspecting IP addresses in an HTTP header that you specify, instead of using the IP address that’s reported by the web request origin. Commonly, this is the X-Forwarded-For (XFF) header, but you can specify any header name. If the specified header isn’t present in the request, AWS WAF doesn’t apply the rule to the web request at all. This is required if AggregateKeyType is set to FORWARDED_IP.

    Declaration

    Swift

    public let forwardedIPConfig: ForwardedIPConfig?

  • The limit on requests per 5-minute period for a single originating IP address. If the statement includes a ScopeDownStatement, this limit is applied only to the requests that match the statement.

    Declaration

    Swift

    public let limit: Int64

  • An optional nested statement that narrows the scope of the rate-based statement to matching web requests. This can be any nestable statement, and you can nest statements at any level below this scope-down statement.

    Declaration

    Swift

    public let scopeDownStatement: Statement?

  • Undocumented

    Declaration

    Swift

    public init(aggregateKeyType: RateBasedStatementAggregateKeyType, forwardedIPConfig: ForwardedIPConfig? = nil, limit: Int64, scopeDownStatement: Statement? = nil)

  • Declaration

    Swift

    public func validate(name: String) throws