Class: AWSCDK::WAFv2::CfnLoggingConfiguration::FieldToMatchProperty

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

Overview

The parts of the request that you want to keep out of the logs.

This is used in the logging configuration RedactedFields specification.

Example JSON for a QueryString field to match:

"FieldToMatch": { "QueryString": {} }

Example JSON for a Method field to match specification:

"FieldToMatch": { "Method": { "Name": "DELETE" } }

See Also:

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(json_body: nil, method: nil, query_string: nil, single_header: nil, uri_path: nil) ⇒ FieldToMatchProperty

Returns a new instance of FieldToMatchProperty.

Parameters:

  • json_body (Object, nil) (defaults to: nil)
  • method (Object, nil) (defaults to: nil) —

    Redact the indicated HTTP method.

  • query_string (Object, nil) (defaults to: nil) —

    Redact the query string.

  • single_header (Object, nil) (defaults to: nil) —

    Redact a single header.

  • uri_path (Object, nil) (defaults to: nil) —

    Redact the request URI path.



659
660
661
662
663
664
665
666
667
668
669
670
 
# File 'wa_fv2/cfn_logging_configuration.rb', line 659

def initialize(json_body: nil, method: nil, query_string: nil, single_header: nil, uri_path: nil)
  @json_body = json_body
  Jsii::Type.check_type(@json_body, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJhbnkifQ==")), "jsonBody") unless @json_body.nil?
  @method = method
  Jsii::Type.check_type(@method, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJhbnkifQ==")), "method") unless @method.nil?
  @query_string = query_string
  Jsii::Type.check_type(@query_string, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJhbnkifQ==")), "queryString") unless @query_string.nil?
  @single_header = single_header
  Jsii::Type.check_type(@single_header, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJhbnkifQ==")), "singleHeader") unless @single_header.nil?
  @uri_path = uri_path
  Jsii::Type.check_type(@uri_path, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJhbnkifQ==")), "uriPath") unless @uri_path.nil?
end

Instance Attribute Details

#json_body ⇒ Object? (readonly)

Returns:

  • (Object, nil)

See Also:



674
675
676
 
# File 'wa_fv2/cfn_logging_configuration.rb', line 674

def json_body
  @json_body
end

#method ⇒ Object? (readonly)

Redact the indicated HTTP method.

The method indicates the type of operation that the request is asking the origin to perform.

Returns:

  • (Object, nil)

See Also:



681
682
683
 
# File 'wa_fv2/cfn_logging_configuration.rb', line 681

def method
  @method
end

#query_string ⇒ Object? (readonly)

Redact the query string.

This is the part of a URL that appears after a ? character, if any.

Returns:

  • (Object, nil)

See Also:



688
689
690
 
# File 'wa_fv2/cfn_logging_configuration.rb', line 688

def query_string
  @query_string
end

#single_header ⇒ Object? (readonly)

Redact a single header.

Provide the name of the header to inspect, for example, User-Agent or Referer . This setting isn't case sensitive.

Example JSON: "SingleHeader": { "Name": "haystack" }

Returns:

  • (Object, nil)

See Also:



697
698
699
 
# File 'wa_fv2/cfn_logging_configuration.rb', line 697

def single_header
  @single_header
end

#uri_path ⇒ Object? (readonly)

Redact the request URI path.

This is the part of the web request that identifies a resource, for example, /images/daily-ad.jpg .

Returns:

  • (Object, nil)

See Also:



704
705
706
 
# File 'wa_fv2/cfn_logging_configuration.rb', line 704

def uri_path
  @uri_path
end

Class Method Details

.jsii_properties ⇒ Object 



706
707
708
709
710
711
712
713
714
 
# File 'wa_fv2/cfn_logging_configuration.rb', line 706

def self.jsii_properties
  {
    :json_body => "jsonBody",
    :method => "method",
    :query_string => "queryString",
    :single_header => "singleHeader",
    :uri_path => "uriPath",
  }
end

Instance Method Details

#to_jsii ⇒ Object 



716
717
718
719
720
721
722
723
724
725
726
 
# File 'wa_fv2/cfn_logging_configuration.rb', line 716

def to_jsii
  result = {}
  result.merge!({
    "jsonBody" => @json_body,
    "method" => @method,
    "queryString" => @query_string,
    "singleHeader" => @single_header,
    "uriPath" => @uri_path,
  })
  result.compact
end