Class: Aws::SecurityHub::Types::AwsWafRateBasedRuleDetails

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-securityhub/lib/aws-sdk-securityhub/types.rb

Overview

Note:

When making an API call, you may pass AwsWafRateBasedRuleDetails data as a hash:

{
  metric_name: "NonEmptyString",
  name: "NonEmptyString",
  rate_key: "NonEmptyString",
  rate_limit: 1,
  rule_id: "NonEmptyString",
  match_predicates: [
    {
      data_id: "NonEmptyString",
      negated: false,
      type: "NonEmptyString",
    },
  ],
}

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.

See Also:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#match_predicates ⇒ Array<Types::AwsWafRateBasedRuleMatchPredicate>

The predicates to include in the rate-based rule.

Returns:



21430
21431
21432
21433
21434
21435
21436
21437
21438
21439
 
# File 'gems/aws-sdk-securityhub/lib/aws-sdk-securityhub/types.rb', line 21430

class AwsWafRateBasedRuleDetails < Struct.new(
  :metric_name,
  :name,
  :rate_key,
  :rate_limit,
  :rule_id,
  :match_predicates)
  SENSITIVE = []
  include Aws::Structure
end

#metric_name ⇒ String

The name of the metrics for the rate-based rule.

Returns:

  • (String) 


21430
21431
21432
21433
21434
21435
21436
21437
21438
21439
 
# File 'gems/aws-sdk-securityhub/lib/aws-sdk-securityhub/types.rb', line 21430

class AwsWafRateBasedRuleDetails < Struct.new(
  :metric_name,
  :name,
  :rate_key,
  :rate_limit,
  :rule_id,
  :match_predicates)
  SENSITIVE = []
  include Aws::Structure
end

#name ⇒ String

The name of the rate-based rule.

Returns:

  • (String) 


21430
21431
21432
21433
21434
21435
21436
21437
21438
21439
 
# File 'gems/aws-sdk-securityhub/lib/aws-sdk-securityhub/types.rb', line 21430

class AwsWafRateBasedRuleDetails < Struct.new(
  :metric_name,
  :name,
  :rate_key,
  :rate_limit,
  :rule_id,
  :match_predicates)
  SENSITIVE = []
  include Aws::Structure
end

#rate_key ⇒ String

The field that WAF uses to determine whether requests are likely arriving from single source and are subject to rate monitoring.

Returns:

  • (String) 


21430
21431
21432
21433
21434
21435
21436
21437
21438
21439
 
# File 'gems/aws-sdk-securityhub/lib/aws-sdk-securityhub/types.rb', line 21430

class AwsWafRateBasedRuleDetails < Struct.new(
  :metric_name,
  :name,
  :rate_key,
  :rate_limit,
  :rule_id,
  :match_predicates)
  SENSITIVE = []
  include Aws::Structure
end

#rate_limit ⇒ Integer

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.

Returns:

  • (Integer) 


21430
21431
21432
21433
21434
21435
21436
21437
21438
21439
 
# File 'gems/aws-sdk-securityhub/lib/aws-sdk-securityhub/types.rb', line 21430

class AwsWafRateBasedRuleDetails < Struct.new(
  :metric_name,
  :name,
  :rate_key,
  :rate_limit,
  :rule_id,
  :match_predicates)
  SENSITIVE = []
  include Aws::Structure
end

#rule_id ⇒ String

The unique identifier for the rate-based rule.

Returns:

  • (String) 


21430
21431
21432
21433
21434
21435
21436
21437
21438
21439
 
# File 'gems/aws-sdk-securityhub/lib/aws-sdk-securityhub/types.rb', line 21430

class AwsWafRateBasedRuleDetails < Struct.new(
  :metric_name,
  :name,
  :rate_key,
  :rate_limit,
  :rule_id,
  :match_predicates)
  SENSITIVE = []
  include Aws::Structure
end