Class: Aws::WAFV2::Types::LoggingConfiguration
- Inherits:
-
Struct
- Object
- Struct
- Aws::WAFV2::Types::LoggingConfiguration
- Defined in:
- gems/aws-sdk-wafv2/lib/aws-sdk-wafv2/types.rb
Overview
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 access information about the traffic that WAF inspects using the following steps:
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.
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
-
#log_destination_configs ⇒ Array<String>
The logging destination configuration that you want to associate with the web ACL.
-
#logging_filter ⇒ Types::LoggingFilter
Filtering that specifies which web requests are kept in the logs and which are dropped.
-
#managed_by_firewall_manager ⇒ Boolean
Indicates whether the logging configuration was created by Firewall Manager, as part of an WAF policy configuration.
-
#redacted_fields ⇒ 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
.
Instance Attribute Details
#log_destination_configs ⇒ Array<String>
The logging destination configuration that you want to associate with the web ACL.
5084 5085 5086 5087 5088 5089 5090 5091 5092 |
# File 'gems/aws-sdk-wafv2/lib/aws-sdk-wafv2/types.rb', line 5084 class LoggingConfiguration < Struct.new( :resource_arn, :log_destination_configs, :redacted_fields, :managed_by_firewall_manager, :logging_filter) SENSITIVE = [] include Aws::Structure end |
#logging_filter ⇒ Types::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.
5084 5085 5086 5087 5088 5089 5090 5091 5092 |
# File 'gems/aws-sdk-wafv2/lib/aws-sdk-wafv2/types.rb', line 5084 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_manager ⇒ Boolean
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.
5084 5085 5086 5087 5088 5089 5090 5091 5092 |
# File 'gems/aws-sdk-wafv2/lib/aws-sdk-wafv2/types.rb', line 5084 class LoggingConfiguration < Struct.new( :resource_arn, :log_destination_configs, :redacted_fields, :managed_by_firewall_manager, :logging_filter) SENSITIVE = [] include Aws::Structure end |
#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 SingleHeader
field, the HEADER
field in the logs will be REDACTED
for all rules that use the
SingleHeader
FieldToMatch
setting.
Redaction applies only to the component that's specified in the
rule's FieldToMatch
setting, so the SingleHeader
redaction
doesn't apply to rules that use the Headers
FieldToMatch
.
UriPath
,
QueryString
, SingleHeader
, and Method
.
5084 5085 5086 5087 5088 5089 5090 5091 5092 |
# File 'gems/aws-sdk-wafv2/lib/aws-sdk-wafv2/types.rb', line 5084 class LoggingConfiguration < Struct.new( :resource_arn, :log_destination_configs, :redacted_fields, :managed_by_firewall_manager, :logging_filter) SENSITIVE = [] include Aws::Structure end |
#resource_arn ⇒ String
The Amazon Resource Name (ARN) of the web ACL that you want to
associate with LogDestinationConfigs
.
5084 5085 5086 5087 5088 5089 5090 5091 5092 |
# File 'gems/aws-sdk-wafv2/lib/aws-sdk-wafv2/types.rb', line 5084 class LoggingConfiguration < Struct.new( :resource_arn, :log_destination_configs, :redacted_fields, :managed_by_firewall_manager, :logging_filter) SENSITIVE = [] include Aws::Structure end |