Class LoggingConfiguration
- All Implemented Interfaces:
Serializable
,SdkPojo
,ToCopyableBuilder<LoggingConfiguration.Builder,
LoggingConfiguration>
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:
-
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.
- See Also:
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionstatic LoggingConfiguration.Builder
builder()
final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) final int
hashCode()
final boolean
For responses, this returns true if the service returned a value for the LogDestinationConfigs property.final boolean
For responses, this returns true if the service returned a value for the RedactedFields property.The logging destination configuration that you want to associate with the web ACL.final LoggingFilter
Filtering that specifies which web requests are kept in the logs and which are dropped.final Boolean
Indicates whether the logging configuration was created by Firewall Manager, as part of an WAF policy configuration.final List
<FieldToMatch> The parts of the request that you want to keep out of the logs.final String
The Amazon Resource Name (ARN) of the web ACL that you want to associate withLogDestinationConfigs
.static Class
<? extends LoggingConfiguration.Builder> Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
resourceArn
The Amazon Resource Name (ARN) of the web ACL that you want to associate with
LogDestinationConfigs
.- Returns:
- The Amazon Resource Name (ARN) of the web ACL that you want to associate with
LogDestinationConfigs
.
-
hasLogDestinationConfigs
public final boolean hasLogDestinationConfigs()For responses, this returns true if the service returned a value for the LogDestinationConfigs property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()
method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified. -
logDestinationConfigs
The logging destination configuration that you want to associate with the web ACL.
You can associate one logging destination to a web ACL.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the
hasLogDestinationConfigs()
method.- Returns:
- The logging destination configuration that you want to associate with the web ACL.
You can associate one logging destination to a web ACL.
-
hasRedactedFields
public final boolean hasRedactedFields()For responses, this returns true if the service returned a value for the RedactedFields property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()
method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified. -
redactedFields
The parts of the request that you want to keep out of the logs.
For example, if you redact the
SingleHeader
field, theHEADER
field in the logs will beREDACTED
for all rules that use theSingleHeader
FieldToMatch
setting.Redaction applies only to the component that's specified in the rule's
FieldToMatch
setting, so theSingleHeader
redaction doesn't apply to rules that use theHeaders
FieldToMatch
.You can specify only the following fields for redaction:
UriPath
,QueryString
,SingleHeader
, andMethod
.Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the
hasRedactedFields()
method.- Returns:
- The parts of the request that you want to keep out of the logs.
For example, if you redact the
SingleHeader
field, theHEADER
field in the logs will beREDACTED
for all rules that use theSingleHeader
FieldToMatch
setting.Redaction applies only to the component that's specified in the rule's
FieldToMatch
setting, so theSingleHeader
redaction doesn't apply to rules that use theHeaders
FieldToMatch
.You can specify only the following fields for redaction:
UriPath
,QueryString
,SingleHeader
, andMethod
.
-
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.
- Returns:
- 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.
-
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:
- 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.
-
toBuilder
Description copied from interface:ToCopyableBuilder
Take this object and create a builder that contains all of the current property values of this object.- Specified by:
toBuilder
in interfaceToCopyableBuilder<LoggingConfiguration.Builder,
LoggingConfiguration> - Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode() -
equals
-
equalsBySdkFields
Description copied from interface:SdkPojo
Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
toString
Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value. -
getValueForField
-
sdkFields
-