libZSservicesZSamazonka-securityhubZSamazonka-securityhub
Copyright(c) 2013-2021 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay+amazonka@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone

Amazonka.SecurityHub.Types.AwsWafRateBasedRuleDetails

Description

 
Synopsis

Documentation

data 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.

See: newAwsWafRateBasedRuleDetails smart constructor.

Constructors

AwsWafRateBasedRuleDetails' 

Fields

  • rateLimit :: Maybe 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.

  • rateKey :: Maybe Text

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

  • metricName :: Maybe Text

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

  • ruleId :: Maybe Text

    The unique identifier for the rate-based rule.

  • name :: Maybe Text

    The name of the rate-based rule.

  • matchPredicates :: Maybe [AwsWafRateBasedRuleMatchPredicate]

    The predicates to include in the rate-based rule.

Instances

Instances details
Eq AwsWafRateBasedRuleDetails Source # 
Instance details

Defined in Amazonka.SecurityHub.Types.AwsWafRateBasedRuleDetails

Read AwsWafRateBasedRuleDetails Source # 
Instance details

Defined in Amazonka.SecurityHub.Types.AwsWafRateBasedRuleDetails

Show AwsWafRateBasedRuleDetails Source # 
Instance details

Defined in Amazonka.SecurityHub.Types.AwsWafRateBasedRuleDetails

Generic AwsWafRateBasedRuleDetails Source # 
Instance details

Defined in Amazonka.SecurityHub.Types.AwsWafRateBasedRuleDetails

Associated Types

type Rep AwsWafRateBasedRuleDetails :: Type -> Type #

NFData AwsWafRateBasedRuleDetails Source # 
Instance details

Defined in Amazonka.SecurityHub.Types.AwsWafRateBasedRuleDetails

Hashable AwsWafRateBasedRuleDetails Source # 
Instance details

Defined in Amazonka.SecurityHub.Types.AwsWafRateBasedRuleDetails

ToJSON AwsWafRateBasedRuleDetails Source # 
Instance details

Defined in Amazonka.SecurityHub.Types.AwsWafRateBasedRuleDetails

FromJSON AwsWafRateBasedRuleDetails Source # 
Instance details

Defined in Amazonka.SecurityHub.Types.AwsWafRateBasedRuleDetails

type Rep AwsWafRateBasedRuleDetails Source # 
Instance details

Defined in Amazonka.SecurityHub.Types.AwsWafRateBasedRuleDetails

type Rep AwsWafRateBasedRuleDetails = D1 ('MetaData "AwsWafRateBasedRuleDetails" "Amazonka.SecurityHub.Types.AwsWafRateBasedRuleDetails" "libZSservicesZSamazonka-securityhubZSamazonka-securityhub" 'False) (C1 ('MetaCons "AwsWafRateBasedRuleDetails'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "rateLimit") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Integer)) :*: (S1 ('MetaSel ('Just "rateKey") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "metricName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :*: (S1 ('MetaSel ('Just "ruleId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "matchPredicates") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [AwsWafRateBasedRuleMatchPredicate]))))))

newAwsWafRateBasedRuleDetails :: AwsWafRateBasedRuleDetails Source #

Create a value of AwsWafRateBasedRuleDetails with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:rateLimit:AwsWafRateBasedRuleDetails', awsWafRateBasedRuleDetails_rateLimit - 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.

$sel:rateKey:AwsWafRateBasedRuleDetails', awsWafRateBasedRuleDetails_rateKey - The field that WAF uses to determine whether requests are likely arriving from single source and are subject to rate monitoring.

$sel:metricName:AwsWafRateBasedRuleDetails', awsWafRateBasedRuleDetails_metricName - The name of the metrics for the rate-based rule.

$sel:ruleId:AwsWafRateBasedRuleDetails', awsWafRateBasedRuleDetails_ruleId - The unique identifier for the rate-based rule.

$sel:name:AwsWafRateBasedRuleDetails', awsWafRateBasedRuleDetails_name - The name of the rate-based rule.

$sel:matchPredicates:AwsWafRateBasedRuleDetails', awsWafRateBasedRuleDetails_matchPredicates - The predicates to include in the rate-based rule.

awsWafRateBasedRuleDetails_rateLimit :: Lens' AwsWafRateBasedRuleDetails (Maybe Integer) Source #

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.

awsWafRateBasedRuleDetails_rateKey :: Lens' AwsWafRateBasedRuleDetails (Maybe Text) Source #

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

awsWafRateBasedRuleDetails_metricName :: Lens' AwsWafRateBasedRuleDetails (Maybe Text) Source #

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

awsWafRateBasedRuleDetails_ruleId :: Lens' AwsWafRateBasedRuleDetails (Maybe Text) Source #

The unique identifier for the rate-based rule.