You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.

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

Inherits:
Struct
  • Object
show all
Defined in:
(unknown)

Overview

Note:

When passing LoggingConfiguration as input to an Aws::Client method, you can use a vanilla 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: {
      },
      method: {
      },
    },
  ],
  managed_by_firewall_manager: false,
}

This is the latest version of AWS WAF, named AWS WAFV2, released in November, 2019. For information, including how to migrate your AWS WAF resources from the prior release, see the AWS WAF Developer Guide.

Defines an association between Amazon Kinesis Data Firehose destinations and a web ACL resource, for logging from AWS WAF. As part of the association, you can specify parts of the standard logging fields to keep out of the logs.

Returned by:

See Also:

Instance Attribute Summary collapse

Instance Attribute Details

#log_destination_configs ⇒ Array<String>

The Amazon Kinesis Data Firehose Amazon Resource Name (ARNs) that you want to associate with the web ACL.

Returns:

  • (Array<String>) —

    The Amazon Kinesis Data Firehose Amazon Resource Name (ARNs) that you want to associate with the web ACL.

#managed_by_firewall_manager ⇒ Boolean

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

Returns:

  • (Boolean) —

    Indicates whether the logging configuration was created by AWS Firewall Manager, as part of an AWS WAF policy configuration.

#redacted_fields ⇒ Array<Types::FieldToMatch>

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

You must use one of the following values: URI, QUERY_STRING, HEADER, or METHOD.

Returns:

  • (Array<Types::FieldToMatch>) —

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

#resource_arn ⇒ String

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

Returns:

  • (String) —

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