Class: AWSCDK::WAFv2::CfnRuleGroup::RateLimitHeaderProperty

Inherits:

Jsii::Struct

• Object
• Jsii::Struct
• AWSCDK::WAFv2::CfnRuleGroup::RateLimitHeaderProperty

Defined in:

wa_fv2/cfn_rule_group.rb

Overview

Specifies a header as an aggregate key for a rate-based rule.

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.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-ratelimitheader.html

Instance Attribute Summary

• #name ⇒ String readonly

  The name of the header to use.

• #text_transformations ⇒ AWSCDK::IResolvable, Array<AWSCDK::IResolvable, AWSCDK::WAFv2::CfnRuleGroup::TextTransformationProperty> readonly

  Text transformations eliminate some of the unusual formatting that attackers use in web requests in an effort to bypass detection.

Class Method Summary

• .jsii_properties ⇒ Object

Instance Method Summary

• #initialize(name:, text_transformations:) ⇒ RateLimitHeaderProperty constructor

  A new instance of RateLimitHeaderProperty.

• #to_jsii ⇒ Object

Constructor Details

#initialize(name:, text_transformations:) ⇒ RateLimitHeaderProperty

Returns a new instance of RateLimitHeaderProperty.

Parameters:

• name (String) —

  The name of the header to use.

• text_transformations (AWSCDK::IResolvable, Array<AWSCDK::IResolvable, AWSCDK::WAFv2::CfnRuleGroup::TextTransformationProperty>) —

  Text transformations eliminate some of the unusual formatting that attackers use in web requests in an effort to bypass detection.

# File 'wa_fv2/cfn_rule_group.rb', line 3239

def initialize(name:, text_transformations:)
  @name = name
  Jsii::Type.check_type(@name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "name")
  @text_transformations = text_transformations
  Jsii::Type.check_type(@text_transformations, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImNvbGxlY3Rpb24iOnsiZWxlbWVudHR5cGUiOnsidW5pb24iOnsidHlwZXMiOlt7ImZxbiI6ImF3cy1jZGstbGliLklSZXNvbHZhYmxlIn0seyJmcW4iOiJhd3MtY2RrLWxpYi5hd3Nfd2FmdjIuQ2ZuUnVsZUdyb3VwLlRleHRUcmFuc2Zvcm1hdGlvblByb3BlcnR5In1dfX0sImtpbmQiOiJhcnJheSJ9fV19fQ==")), "textTransformations")
end

Instance Attribute Details

#name ⇒ String (readonly)

The name of the header to use.

Returns:

• (String)

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-ratelimitheader.html#cfn-wafv2-rulegroup-ratelimitheader-name

# File 'wa_fv2/cfn_rule_group.rb', line 3250

def name
  @name
end

#text_transformations ⇒ AWSCDK::IResolvable, Array<AWSCDK::IResolvable, AWSCDK::WAFv2::CfnRuleGroup::TextTransformationProperty> (readonly)

Text transformations eliminate some of the unusual formatting that attackers use in web requests in an effort to bypass detection.

Text transformations are used in rule match statements, to transform the FieldToMatch request component before inspecting it, and they're used in rate-based rule statements, to transform request components before using them as custom aggregation keys. If you specify one or more transformations to apply, AWS WAF performs all transformations on the specified content, starting from the lowest priority setting, and then uses the transformed component contents.

Returns:

• (AWSCDK::IResolvable, Array<AWSCDK::IResolvable, AWSCDK::WAFv2::CfnRuleGroup::TextTransformationProperty>)

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-ratelimitheader.html#cfn-wafv2-rulegroup-ratelimitheader-texttransformations

# File 'wa_fv2/cfn_rule_group.rb', line 3257

def text_transformations
  @text_transformations
end

Class Method Details

.jsii_properties ⇒ Object

# File 'wa_fv2/cfn_rule_group.rb', line 3259

def self.jsii_properties
  {
    :name => "name",
    :text_transformations => "textTransformations",
  }
end

Instance Method Details

#to_jsii ⇒ Object

# File 'wa_fv2/cfn_rule_group.rb', line 3266

def to_jsii
  result = {}
  result.merge!({
    "name" => @name,
    "textTransformations" => @text_transformations,
  })
  result.compact
end