Documentation

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.

   The name that you give the destination must start with aws-waf-logs-. Depending on the type of destination, you might need to configure additional settings or permissions.

   For configuration requirements and pricing information for each destination type, see Logging web ACL traffic 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.

See: newLoggingConfiguration smart constructor.

Create a value of LoggingConfiguration with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:loggingFilter:LoggingConfiguration', loggingConfiguration_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.

$sel:managedByFirewallManager:LoggingConfiguration', loggingConfiguration_managedByFirewallManager - 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.

$sel:redactedFields:LoggingConfiguration', loggingConfiguration_redactedFields - 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.

$sel:resourceArn:LoggingConfiguration', loggingConfiguration_resourceArn - The Amazon Resource Name (ARN) of the web ACL that you want to associate with LogDestinationConfigs.

$sel:logDestinationConfigs:LoggingConfiguration', loggingConfiguration_logDestinationConfigs - The logging destination configuration that you want to associate with the web ACL.

You can associate one logging destination to a web ACL.

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.

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.

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.

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

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

You can associate one logging destination to a web ACL.