Class: AWSCDK::WAFv2::CfnRuleGroup::IPSetForwardedIPConfigurationProperty

Inherits:

Jsii::Struct

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

Defined in:

wa_fv2/cfn_rule_group.rb

Overview

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 configuration is used only for IPSetReferenceStatement . For GeoMatchStatement and RateBasedStatement , use ForwardedIPConfig instead.

See Also:

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

Instance Attribute Summary

• #fallback_behavior ⇒ String readonly

  The match status to assign to the web request if the request doesn't have a valid IP address in the specified position.

• #header_name ⇒ String readonly

  The name of the HTTP header to use for the IP address.

• #position ⇒ String readonly

  The position in the header to search for the IP address.

Class Method Summary

• .jsii_properties ⇒ Object

Instance Method Summary

• #initialize(fallback_behavior:, header_name:, position:) ⇒ IPSetForwardedIPConfigurationProperty constructor

  A new instance of IPSetForwardedIPConfigurationProperty.

• #to_jsii ⇒ Object

Constructor Details

#initialize(fallback_behavior:, header_name:, position:) ⇒ IPSetForwardedIPConfigurationProperty

Returns a new instance of IPSetForwardedIPConfigurationProperty.

Parameters:

• fallback_behavior (String) —

  The match status to assign to the web request if the request doesn't have a valid IP address in the specified position.

• header_name (String) —

  The name of the HTTP header to use for the IP address.

• position (String) —

  The position in the header to search for the IP address.

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

def initialize(fallback_behavior:, header_name:, position:)
  @fallback_behavior = fallback_behavior
  Jsii::Type.check_type(@fallback_behavior, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "fallbackBehavior")
  @header_name = header_name
  Jsii::Type.check_type(@header_name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "headerName")
  @position = position
  Jsii::Type.check_type(@position, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "position")
end

Instance Attribute Details

#fallback_behavior ⇒ String (readonly)

The match status to assign to the web request if the request doesn't have a valid IP address in the specified position.

If the specified header isn't present in the request, AWS WAF doesn't apply the rule to the web request at all.

You can specify the following fallback behaviors:

• MATCH - Treat the web request as matching the rule statement. AWS WAF applies the rule action to the request.
• NO_MATCH - Treat the web request as not matching the rule statement.

Returns:

• (String)

See Also:

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

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

def fallback_behavior
  @fallback_behavior
end

#header_name ⇒ String (readonly)

The name of the HTTP header to use for the IP address.

For example, to use the X-Forwarded-For (XFF) header, set this to X-Forwarded-For .

If the specified header isn't present in the request, AWS WAF doesn't apply the rule to the web request at all.

Returns:

• (String)

See Also:

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

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

def header_name
  @header_name
end

#position ⇒ String (readonly)

The position in the header to search for the IP address.

The header can contain IP addresses of the original client and also of proxies. For example, the header value could be 10.1.1.1, 127.0.0.0, 10.10.10.10 where the first IP address identifies the original client and the rest identify proxies that the request went through.

The options for this setting are the following:

• FIRST - Inspect the first IP address in the list of IP addresses in the header. This is usually the client's original IP.
• LAST - Inspect the last IP address in the list of IP addresses in the header.
• ANY - Inspect all IP addresses in the header for a match. If the header contains more than 10 IP addresses, AWS WAF inspects the last 10.

Returns:

• (String)

See Also:

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

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

def position
  @position
end

Class Method Details

.jsii_properties ⇒ Object

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

def self.jsii_properties
  {
    :fallback_behavior => "fallbackBehavior",
    :header_name => "headerName",
    :position => "position",
  }
end

Instance Method Details

#to_jsii ⇒ Object

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

def to_jsii
  result = {}
  result.merge!({
    "fallbackBehavior" => @fallback_behavior,
    "headerName" => @header_name,
    "position" => @position,
  })
  result.compact
end