Class: Aws::WAFV2::Types::LoggingConfiguration

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-wafv2/lib/aws-sdk-wafv2/types.rb

Overview

Note:

When making an API call, you may pass LoggingConfiguration data as a hash:

{
  resource_arn: "ResourceArn", # required
  log_destination_configs: ["ResourceArn"], # required
  redacted_fields: [
    {
      single_header: {
        name: "FieldToMatchData", # required
      },
      single_query_argument: {
        name: "FieldToMatchData", # required
      },
      all_query_arguments: {
      },
      uri_path: {
      },
      query_string: {
      },
      body: {
        oversize_handling: "CONTINUE", # accepts CONTINUE, MATCH, NO_MATCH
      },
      method: {
      },
      json_body: {
        match_pattern: { # required
          all: {
          },
          included_paths: ["JsonPointerPath"],
        },
        match_scope: "ALL", # required, accepts ALL, KEY, VALUE
        invalid_fallback_behavior: "MATCH", # accepts MATCH, NO_MATCH, EVALUATE_AS_STRING
        oversize_handling: "CONTINUE", # accepts CONTINUE, MATCH, NO_MATCH
      },
      headers: {
        match_pattern: { # required
          all: {
          },
          included_headers: ["FieldToMatchData"],
          excluded_headers: ["FieldToMatchData"],
        },
        match_scope: "ALL", # required, accepts ALL, KEY, VALUE
        oversize_handling: "CONTINUE", # required, accepts CONTINUE, MATCH, NO_MATCH
      },
      cookies: {
        match_pattern: { # required
          all: {
          },
          included_cookies: ["SingleCookieName"],
          excluded_cookies: ["SingleCookieName"],
        },
        match_scope: "ALL", # required, accepts ALL, KEY, VALUE
        oversize_handling: "CONTINUE", # required, accepts CONTINUE, MATCH, NO_MATCH
      },
    },
  ],
  managed_by_firewall_manager: false,
  logging_filter: {
    filters: [ # required
      {
        behavior: "KEEP", # required, accepts KEEP, DROP
        requirement: "MEETS_ALL", # required, accepts MEETS_ALL, MEETS_ANY
        conditions: [ # required
          {
            action_condition: {
              action: "ALLOW", # required, accepts ALLOW, BLOCK, COUNT, CAPTCHA, EXCLUDED_AS_COUNT
            },
            label_name_condition: {
              label_name: "LabelName", # required
            },
          },
        ],
      },
    ],
    default_behavior: "KEEP", # required, accepts KEEP, DROP
  },
}

Defines an association between logging destinations and a web ACL resource, for logging from WAF. As part of the association, you can specify parts of the standard logging fields to keep out of the logs and you can specify filters so that you log only a subset of the logging records.

You can define one logging destination per web ACL.

You can access information about the traffic that WAF inspects using the following steps:

  1. Create your logging destination. You can use an Amazon CloudWatch Logs log group, an Amazon Simple Storage Service (Amazon S3) bucket, or an Amazon Kinesis Data Firehose. For information about configuring logging destinations and the permissions that are required for each, see Logging web ACL traffic information in the WAF Developer Guide.

  2. Associate your logging destination to your web ACL using a PutLoggingConfiguration request.

When you successfully enable logging using a PutLoggingConfiguration request, WAF creates an additional role or policy that is required to write logs to the logging destination. For an Amazon CloudWatch Logs log group, WAF creates a resource policy on the log group. For an Amazon S3 bucket, WAF creates a bucket policy. For an Amazon Kinesis Data Firehose, WAF creates a service-linked role.

For additional information about web ACL logging, see Logging web ACL traffic information in the WAF Developer Guide.

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#log_destination_configsArray<String>

The logging destination configuration that you want to associate with the web ACL.

You can associate one logging destination to a web ACL.

Returns:

  • (Array<String>)


6856
6857
6858
6859
6860
6861
6862
6863
6864
# File 'gems/aws-sdk-wafv2/lib/aws-sdk-wafv2/types.rb', line 6856

class LoggingConfiguration < Struct.new(
  :resource_arn,
  :log_destination_configs,
  :redacted_fields,
  :managed_by_firewall_manager,
  :logging_filter)
  SENSITIVE = []
  include Aws::Structure
end

#logging_filterTypes::LoggingFilter

Filtering that specifies which web requests are kept in the logs and which are dropped. You can filter on the rule action and on the web request labels that were applied by matching rules during web ACL evaluation.



6856
6857
6858
6859
6860
6861
6862
6863
6864
# File 'gems/aws-sdk-wafv2/lib/aws-sdk-wafv2/types.rb', line 6856

class LoggingConfiguration < Struct.new(
  :resource_arn,
  :log_destination_configs,
  :redacted_fields,
  :managed_by_firewall_manager,
  :logging_filter)
  SENSITIVE = []
  include Aws::Structure
end

#managed_by_firewall_managerBoolean

Indicates whether the logging configuration was created by Firewall Manager, as part of an WAF policy configuration. If true, only Firewall Manager can modify or delete the configuration.

Returns:

  • (Boolean)


6856
6857
6858
6859
6860
6861
6862
6863
6864
# File 'gems/aws-sdk-wafv2/lib/aws-sdk-wafv2/types.rb', line 6856

class LoggingConfiguration < Struct.new(
  :resource_arn,
  :log_destination_configs,
  :redacted_fields,
  :managed_by_firewall_manager,
  :logging_filter)
  SENSITIVE = []
  include Aws::Structure
end

#redacted_fieldsArray<Types::FieldToMatch>

The parts of the request that you want to keep out of the logs. For example, if you redact the SingleHeader field, the HEADER field in the logs will be xxx.

You can specify only the following fields for redaction: UriPath, QueryString, SingleHeader, Method, and JsonBody.

Returns:



6856
6857
6858
6859
6860
6861
6862
6863
6864
# File 'gems/aws-sdk-wafv2/lib/aws-sdk-wafv2/types.rb', line 6856

class LoggingConfiguration < Struct.new(
  :resource_arn,
  :log_destination_configs,
  :redacted_fields,
  :managed_by_firewall_manager,
  :logging_filter)
  SENSITIVE = []
  include Aws::Structure
end

#resource_arnString

The Amazon Resource Name (ARN) of the web ACL that you want to associate with LogDestinationConfigs.

Returns:

  • (String)


6856
6857
6858
6859
6860
6861
6862
6863
6864
# File 'gems/aws-sdk-wafv2/lib/aws-sdk-wafv2/types.rb', line 6856

class LoggingConfiguration < Struct.new(
  :resource_arn,
  :log_destination_configs,
  :redacted_fields,
  :managed_by_firewall_manager,
  :logging_filter)
  SENSITIVE = []
  include Aws::Structure
end