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

Inherits:
Struct
  • Object
show all
Includes:
Structure
Defined in:
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.

<note markdown=“1”> You can define one logging destination per web ACL.

</note>

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*.

[1]: docs.aws.amazon.com/waf/latest/developerguide/logging.html

See Also:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#log_destination_configs ⇒ Array<String>

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

<note markdown=“1”> You can associate one logging destination to a web ACL.

</note>

Returns:

  • (Array<String>) 


5210
5211
5212
5213
5214
5215
5216
5217
5218
5219
5220
 
# File 'lib/aws-sdk-wafv2/types.rb', line 5210

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

#log_scope ⇒ String

The owner of the logging configuration, which must be set to ‘CUSTOMER` for the configurations that you manage.

The log scope ‘SECURITY_LAKE` indicates a configuration that is managed through Amazon Security Lake. You can use Security Lake to collect log and event data from various sources for normalization, analysis, and management. For information, see [Collecting data from Amazon Web Services services] in the *Amazon Security Lake user guide*.

Default: ‘CUSTOMER`

[1]: docs.aws.amazon.com/security-lake/latest/userguide/internal-sources.html

Returns:

  • (String) 


5210
5211
5212
5213
5214
5215
5216
5217
5218
5219
5220
 
# File 'lib/aws-sdk-wafv2/types.rb', line 5210

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

#log_type ⇒ String

Used to distinguish between various logging options. Currently, there is one option.

Default: ‘WAF_LOGS`

Returns:

  • (String) 


5210
5211
5212
5213
5214
5215
5216
5217
5218
5219
5220
 
# File 'lib/aws-sdk-wafv2/types.rb', line 5210

class LoggingConfiguration < Struct.new(
  :resource_arn,
  :log_destination_configs,
  :redacted_fields,
  :managed_by_firewall_manager,
  :logging_filter,
  :log_type,
  :log_scope)
  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.

Returns:



5210
5211
5212
5213
5214
5215
5216
5217
5218
5219
5220
 
# File 'lib/aws-sdk-wafv2/types.rb', line 5210

class LoggingConfiguration < Struct.new(
  :resource_arn,
  :log_destination_configs,
  :redacted_fields,
  :managed_by_firewall_manager,
  :logging_filter,
  :log_type,
  :log_scope)
  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.

The logging configuration can be created by Firewall Manager for use with any web ACL that Firewall Manager is using for an WAF policy. Web ACLs that Firewall Manager creates and uses have their ‘ManagedByFirewallManager` property set to true. Web ACLs that were created by a customer account and then retrofitted by Firewall Manager for use by a policy have their `RetrofittedByFirewallManager` property set to true. For either case, any corresponding logging configuration will indicate `ManagedByFirewallManager`.

Returns:

  • (Boolean) 


5210
5211
5212
5213
5214
5215
5216
5217
5218
5219
5220
 
# File 'lib/aws-sdk-wafv2/types.rb', line 5210

class LoggingConfiguration < Struct.new(
  :resource_arn,
  :log_destination_configs,
  :redacted_fields,
  :managed_by_firewall_manager,
  :logging_filter,
  :log_type,
  :log_scope)
  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`.

<note markdown=“1”> You can specify only the following fields for redaction: ‘UriPath`, `QueryString`, `SingleHeader`, and `Method`.

</note>

<note markdown=“1”> This setting has no impact on request sampling. With request sampling, the only way to exclude fields is by disabling sampling in the web ACL visibility configuration.

</note>

Returns:



5210
5211
5212
5213
5214
5215
5216
5217
5218
5219
5220
 
# File 'lib/aws-sdk-wafv2/types.rb', line 5210

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

#resource_arn ⇒ String

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

Returns:

  • (String) 


5210
5211
5212
5213
5214
5215
5216
5217
5218
5219
5220
 
# File 'lib/aws-sdk-wafv2/types.rb', line 5210

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