Class: AWSCDK::WAFv2::CfnWebACL::ResponseInspectionHeaderProperty

Inherits:
Jsii::Struct
  • Object
show all
Defined in:
wa_fv2/cfn_web_acl.rb

Overview

Configures inspection of the response header. This is part of the ResponseInspection configuration for AWSManagedRulesATPRuleSet and AWSManagedRulesACFPRuleSet .

Response inspection is available only in web ACLs that protect Amazon CloudFront distributions.

See Also:

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(failure_values:, name:, success_values:) ⇒ ResponseInspectionHeaderProperty

Returns a new instance of ResponseInspectionHeaderProperty.

Parameters:

  • failure_values (Array<String>) —

    Values in the response header with the specified name that indicate a failed login or account creation attempt.

  • name (String) —

    The name of the header to match against. The name must be an exact match, including case.

  • success_values (Array<String>) —

    Values in the response header with the specified name that indicate a successful login or account creation attempt.



5228
5229
5230
5231
5232
5233
5234
5235
 
# File 'wa_fv2/cfn_web_acl.rb', line 5228

def initialize(failure_values:, name:, success_values:)
  @failure_values = failure_values
  Jsii::Type.check_type(@failure_values, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7InByaW1pdGl2ZSI6InN0cmluZyJ9LCJraW5kIjoiYXJyYXkifX0=")), "failureValues")
  @name = name
  Jsii::Type.check_type(@name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "name")
  @success_values = success_values
  Jsii::Type.check_type(@success_values, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7InByaW1pdGl2ZSI6InN0cmluZyJ9LCJraW5kIjoiYXJyYXkifX0=")), "successValues")
end

Instance Attribute Details

#failure_values ⇒ Array<String> (readonly)

Values in the response header with the specified name that indicate a failed login or account creation attempt.

To be counted as a failure, the value must be an exact match, including case. Each value must be unique among the success and failure values.

JSON examples: "FailureValues": [ "LoginFailed", "Failed login" ] and "FailureValues": [ "AccountCreationFailed" ]

Returns:

  • (Array<String>)

See Also:



5245
5246
5247
 
# File 'wa_fv2/cfn_web_acl.rb', line 5245

def failure_values
  @failure_values
end

#name ⇒ String (readonly)

The name of the header to match against. The name must be an exact match, including case.

JSON example: "Name": [ "RequestResult" ]

Returns:

  • (String)

See Also:



5252
5253
5254
 
# File 'wa_fv2/cfn_web_acl.rb', line 5252

def name
  @name
end

#success_values ⇒ Array<String> (readonly)

Values in the response header with the specified name that indicate a successful login or account creation attempt.

To be counted as a success, the value must be an exact match, including case. Each value must be unique among the success and failure values.

JSON examples: "SuccessValues": [ "LoginPassed", "Successful login" ] and "SuccessValues": [ "AccountCreated", "Successful account creation" ]

Returns:

  • (Array<String>)

See Also:



5261
5262
5263
 
# File 'wa_fv2/cfn_web_acl.rb', line 5261

def success_values
  @success_values
end

Class Method Details

.jsii_properties ⇒ Object 



5263
5264
5265
5266
5267
5268
5269
 
# File 'wa_fv2/cfn_web_acl.rb', line 5263

def self.jsii_properties
  {
    :failure_values => "failureValues",
    :name => "name",
    :success_values => "successValues",
  }
end

Instance Method Details

#to_jsii ⇒ Object 



5271
5272
5273
5274
5275
5276
5277
5278
5279
 
# File 'wa_fv2/cfn_web_acl.rb', line 5271

def to_jsii
  result = {}
  result.merge!({
    "failureValues" => @failure_values,
    "name" => @name,
    "successValues" => @success_values,
  })
  result.compact
end