Class: AWSCDK::ObservabilityAdmin::CfnTelemetryRule::WAFLoggingParametersProperty

Inherits:

Jsii::Struct

• Object
• Jsii::Struct
• AWSCDK::ObservabilityAdmin::CfnTelemetryRule::WAFLoggingParametersProperty

Defined in:

observability_admin/cfn_telemetry_rule.rb

Overview

Configuration parameters for WAF logging, including redacted fields and logging filters.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-observabilityadmin-telemetryrule-wafloggingparameters.html

Instance Attribute Summary

• #log_type ⇒ String^? readonly

  The type of WAF logs to collect (currently supports WAF_LOGS).

• #logging_filter ⇒ AWSCDK::IResolvable, ... readonly

  A filter configuration that determines which WAF log records to include or exclude.

• #redacted_fields ⇒ AWSCDK::IResolvable, ... readonly

  The fields to redact from WAF logs to protect sensitive information.

Class Method Summary

• .jsii_properties ⇒ Object

Instance Method Summary

• #initialize(logging_filter: nil, log_type: nil, redacted_fields: nil) ⇒ WAFLoggingParametersProperty constructor

  A new instance of WAFLoggingParametersProperty.

• #to_jsii ⇒ Object

Constructor Details

#initialize(logging_filter: nil, log_type: nil, redacted_fields: nil) ⇒ WAFLoggingParametersProperty

Returns a new instance of WAFLoggingParametersProperty.

Parameters:

• logging_filter (AWSCDK::IResolvable, AWSCDK::ObservabilityAdmin::CfnTelemetryRule::LoggingFilterProperty, nil) (defaults to: nil) —

  A filter configuration that determines which WAF log records to include or exclude.

• log_type (String, nil) (defaults to: nil) —

  The type of WAF logs to collect (currently supports WAF_LOGS).

• redacted_fields (AWSCDK::IResolvable, Array<AWSCDK::IResolvable, AWSCDK::ObservabilityAdmin::CfnTelemetryRule::FieldToMatchProperty>, nil) (defaults to: nil) —

  The fields to redact from WAF logs to protect sensitive information.

# File 'observability_admin/cfn_telemetry_rule.rb', line 1410

def initialize(logging_filter: nil, log_type: nil, redacted_fields: nil)
  @logging_filter = logging_filter.is_a?(Hash) ? ::AWSCDK::ObservabilityAdmin::CfnTelemetryRule::LoggingFilterProperty.new(**logging_filter.transform_keys(&:to_sym)) : logging_filter
  Jsii::Type.check_type(@logging_filter, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19vYnNlcnZhYmlsaXR5YWRtaW4uQ2ZuVGVsZW1ldHJ5UnVsZS5Mb2dnaW5nRmlsdGVyUHJvcGVydHkifV19fQ==")), "loggingFilter") unless @logging_filter.nil?
  @log_type = log_type
  Jsii::Type.check_type(@log_type, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "logType") unless @log_type.nil?
  @redacted_fields = redacted_fields
  Jsii::Type.check_type(@redacted_fields, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImNvbGxlY3Rpb24iOnsiZWxlbWVudHR5cGUiOnsidW5pb24iOnsidHlwZXMiOlt7ImZxbiI6ImF3cy1jZGstbGliLklSZXNvbHZhYmxlIn0seyJmcW4iOiJhd3MtY2RrLWxpYi5hd3Nfb2JzZXJ2YWJpbGl0eWFkbWluLkNmblRlbGVtZXRyeVJ1bGUuRmllbGRUb01hdGNoUHJvcGVydHkifV19fSwia2luZCI6ImFycmF5In19XX19")), "redactedFields") unless @redacted_fields.nil?
end

Instance Attribute Details

#log_type ⇒ String^? (readonly)

The type of WAF logs to collect (currently supports WAF_LOGS).

Returns:

• (String, nil)

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-observabilityadmin-telemetryrule-wafloggingparameters.html#cfn-observabilityadmin-telemetryrule-wafloggingparameters-logtype

# File 'observability_admin/cfn_telemetry_rule.rb', line 1428

def log_type
  @log_type
end

#logging_filter ⇒ AWSCDK::IResolvable, ... (readonly)

A filter configuration that determines which WAF log records to include or exclude.

Returns:

• (AWSCDK::IResolvable, AWSCDK::ObservabilityAdmin::CfnTelemetryRule::LoggingFilterProperty, nil)

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-observabilityadmin-telemetryrule-wafloggingparameters.html#cfn-observabilityadmin-telemetryrule-wafloggingparameters-loggingfilter

# File 'observability_admin/cfn_telemetry_rule.rb', line 1423

def logging_filter
  @logging_filter
end

#redacted_fields ⇒ AWSCDK::IResolvable, ... (readonly)

The fields to redact from WAF logs to protect sensitive information.

Returns:

• (AWSCDK::IResolvable, Array<AWSCDK::IResolvable, AWSCDK::ObservabilityAdmin::CfnTelemetryRule::FieldToMatchProperty>, nil)

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-observabilityadmin-telemetryrule-wafloggingparameters.html#cfn-observabilityadmin-telemetryrule-wafloggingparameters-redactedfields

# File 'observability_admin/cfn_telemetry_rule.rb', line 1433

def redacted_fields
  @redacted_fields
end

Class Method Details

.jsii_properties ⇒ Object

# File 'observability_admin/cfn_telemetry_rule.rb', line 1435

def self.jsii_properties
  {
    :logging_filter => "loggingFilter",
    :log_type => "logType",
    :redacted_fields => "redactedFields",
  }
end

Instance Method Details

#to_jsii ⇒ Object

# File 'observability_admin/cfn_telemetry_rule.rb', line 1443

def to_jsii
  result = {}
  result.merge!({
    "loggingFilter" => @logging_filter,
    "logType" => @log_type,
    "redactedFields" => @redacted_fields,
  })
  result.compact
end