Class: Aws::WAFV2::Types::RateBasedStatementCustomKey

Inherits:

Struct

• Object
• Struct
• Aws::WAFV2::Types::RateBasedStatementCustomKey

Includes:

Structure

Defined in:

lib/aws-sdk-wafv2/types.rb

Overview

Specifies a single custom aggregate key for a rate-base rule.

<note markdown=“1”> Web requests that are missing any of the components specified in the aggregation keys are omitted from the rate-based rule evaluation and handling.

</note>

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #cookie ⇒ Types::RateLimitCookie

  Use the value of a cookie in the request as an aggregate key.

• #forwarded_ip ⇒ Types::RateLimitForwardedIP

  Use the first IP address in an HTTP header as an aggregate key.

• #header ⇒ Types::RateLimitHeader

  Use the value of a header in the request as an aggregate key.

• #http_method ⇒ Types::RateLimitHTTPMethod

  Use the request’s HTTP method as an aggregate key.

• #ip ⇒ Types::RateLimitIP

  Use the request’s originating IP address as an aggregate key.

• #label_namespace ⇒ Types::RateLimitLabelNamespace

  Use the specified label namespace as an aggregate key.

• #query_argument ⇒ Types::RateLimitQueryArgument

  Use the specified query argument as an aggregate key.

• #query_string ⇒ Types::RateLimitQueryString

  Use the request’s query string as an aggregate key.

• #uri_path ⇒ Types::RateLimitUriPath

  Use the request’s URI path as an aggregate key.

Instance Attribute Details

#cookie ⇒ Types::RateLimitCookie

Use the value of a cookie in the request as an aggregate key. Each distinct value in the cookie contributes to the aggregation instance. If you use a single cookie as your custom key, then each value fully defines an aggregation instance.

Returns:

• (Types::RateLimitCookie)

# File 'lib/aws-sdk-wafv2/types.rb', line 6549

class RateBasedStatementCustomKey < Struct.new(
  :header,
  :cookie,
  :query_argument,
  :query_string,
  :http_method,
  :forwarded_ip,
  :ip,
  :label_namespace,
  :uri_path)
  SENSITIVE = []
  include Aws::Structure
end

#forwarded_ip ⇒ Types::RateLimitForwardedIP

Use the first IP address in an HTTP header as an aggregate key. Each distinct forwarded IP address contributes to the aggregation instance.

When you specify an IP or forwarded IP in the custom key settings, you must also specify at least one other key to use. You can aggregate on only the forwarded IP address by specifying ‘FORWARDED_IP` in your rate-based statement’s ‘AggregateKeyType`.

With this option, you must specify the header to use in the rate-based rule’s ‘ForwardedIPConfig` property.

Returns:

• (Types::RateLimitForwardedIP)

# File 'lib/aws-sdk-wafv2/types.rb', line 6549

class RateBasedStatementCustomKey < Struct.new(
  :header,
  :cookie,
  :query_argument,
  :query_string,
  :http_method,
  :forwarded_ip,
  :ip,
  :label_namespace,
  :uri_path)
  SENSITIVE = []
  include Aws::Structure
end

#header ⇒ Types::RateLimitHeader

Use the value of a header in the request as an aggregate key. Each distinct value in the header contributes to the aggregation instance. If you use a single header as your custom key, then each value fully defines an aggregation instance.

Returns:

• (Types::RateLimitHeader)

# File 'lib/aws-sdk-wafv2/types.rb', line 6549

class RateBasedStatementCustomKey < Struct.new(
  :header,
  :cookie,
  :query_argument,
  :query_string,
  :http_method,
  :forwarded_ip,
  :ip,
  :label_namespace,
  :uri_path)
  SENSITIVE = []
  include Aws::Structure
end

#http_method ⇒ Types::RateLimitHTTPMethod

Use the request’s HTTP method as an aggregate key. Each distinct HTTP method contributes to the aggregation instance. If you use just the HTTP method as your custom key, then each method fully defines an aggregation instance.

Returns:

• (Types::RateLimitHTTPMethod)

# File 'lib/aws-sdk-wafv2/types.rb', line 6549

class RateBasedStatementCustomKey < Struct.new(
  :header,
  :cookie,
  :query_argument,
  :query_string,
  :http_method,
  :forwarded_ip,
  :ip,
  :label_namespace,
  :uri_path)
  SENSITIVE = []
  include Aws::Structure
end

#ip ⇒ Types::RateLimitIP

Use the request’s originating IP address as an aggregate key. Each distinct IP address contributes to the aggregation instance.

When you specify an IP or forwarded IP in the custom key settings, you must also specify at least one other key to use. You can aggregate on only the IP address by specifying ‘IP` in your rate-based statement’s ‘AggregateKeyType`.

Returns:

• (Types::RateLimitIP)

# File 'lib/aws-sdk-wafv2/types.rb', line 6549

class RateBasedStatementCustomKey < Struct.new(
  :header,
  :cookie,
  :query_argument,
  :query_string,
  :http_method,
  :forwarded_ip,
  :ip,
  :label_namespace,
  :uri_path)
  SENSITIVE = []
  include Aws::Structure
end

#label_namespace ⇒ Types::RateLimitLabelNamespace

Use the specified label namespace as an aggregate key. Each distinct fully qualified label name that has the specified label namespace contributes to the aggregation instance. If you use just one label namespace as your custom key, then each label name fully defines an aggregation instance.

This uses only labels that have been added to the request by rules that are evaluated before this rate-based rule in the web ACL.

For information about label namespaces and names, see [Label syntax and naming requirements] in the *WAF Developer Guide*.

[1]: docs.aws.amazon.com/waf/latest/developerguide/waf-rule-label-requirements.html

Returns:

• (Types::RateLimitLabelNamespace)

# File 'lib/aws-sdk-wafv2/types.rb', line 6549

class RateBasedStatementCustomKey < Struct.new(
  :header,
  :cookie,
  :query_argument,
  :query_string,
  :http_method,
  :forwarded_ip,
  :ip,
  :label_namespace,
  :uri_path)
  SENSITIVE = []
  include Aws::Structure
end

#query_argument ⇒ Types::RateLimitQueryArgument

Use the specified query argument as an aggregate key. Each distinct value for the named query argument contributes to the aggregation instance. If you use a single query argument as your custom key, then each value fully defines an aggregation instance.

Returns:

• (Types::RateLimitQueryArgument)

# File 'lib/aws-sdk-wafv2/types.rb', line 6549

class RateBasedStatementCustomKey < Struct.new(
  :header,
  :cookie,
  :query_argument,
  :query_string,
  :http_method,
  :forwarded_ip,
  :ip,
  :label_namespace,
  :uri_path)
  SENSITIVE = []
  include Aws::Structure
end

#query_string ⇒ Types::RateLimitQueryString

Use the request’s query string as an aggregate key. Each distinct string contributes to the aggregation instance. If you use just the query string as your custom key, then each string fully defines an aggregation instance.

Returns:

• (Types::RateLimitQueryString)

# File 'lib/aws-sdk-wafv2/types.rb', line 6549

class RateBasedStatementCustomKey < Struct.new(
  :header,
  :cookie,
  :query_argument,
  :query_string,
  :http_method,
  :forwarded_ip,
  :ip,
  :label_namespace,
  :uri_path)
  SENSITIVE = []
  include Aws::Structure
end

#uri_path ⇒ Types::RateLimitUriPath

Use the request’s URI path as an aggregate key. Each distinct URI path contributes to the aggregation instance. If you use just the URI path as your custom key, then each URI path fully defines an aggregation instance.

Returns:

• (Types::RateLimitUriPath)

# File 'lib/aws-sdk-wafv2/types.rb', line 6549

class RateBasedStatementCustomKey < Struct.new(
  :header,
  :cookie,
  :query_argument,
  :query_string,
  :http_method,
  :forwarded_ip,
  :ip,
  :label_namespace,
  :uri_path)
  SENSITIVE = []
  include Aws::Structure
end