com.amazonaws.services.wafv2.model

Class LoggingConfiguration

java.lang.Object

com.amazonaws.services.wafv2.model.LoggingConfiguration

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class LoggingConfiguration
extends Object
implements Serializable, Cloneable, StructuredPojo

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.

See Also:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors

Constructor and Description
LoggingConfiguration()

Method Summary

Modifier and Type	Method and Description
LoggingConfiguration	clone()
boolean	equals(Object obj)
List<String>	getLogDestinationConfigs() The Amazon Kinesis Data Firehose Amazon Resource Name (ARNs) that you want to associate with the web ACL.
List<FieldToMatch>	getRedactedFields() The parts of the request that you want to keep out of the logs.
String	getResourceArn() The Amazon Resource Name (ARN) of the web ACL that you want to associate with LogDestinationConfigs.
int	hashCode()
void	marshall(ProtocolMarshaller protocolMarshaller)
void	setLogDestinationConfigs(Collection<String> logDestinationConfigs) The Amazon Kinesis Data Firehose Amazon Resource Name (ARNs) that you want to associate with the web ACL.
void	setRedactedFields(Collection<FieldToMatch> redactedFields) The parts of the request that you want to keep out of the logs.
void	setResourceArn(String resourceArn) The Amazon Resource Name (ARN) of the web ACL that you want to associate with LogDestinationConfigs.
String	toString() Returns a string representation of this object.
LoggingConfiguration	withLogDestinationConfigs(Collection<String> logDestinationConfigs) The Amazon Kinesis Data Firehose Amazon Resource Name (ARNs) that you want to associate with the web ACL.
LoggingConfiguration	withLogDestinationConfigs(String... logDestinationConfigs) The Amazon Kinesis Data Firehose Amazon Resource Name (ARNs) that you want to associate with the web ACL.
LoggingConfiguration	withRedactedFields(Collection<FieldToMatch> redactedFields) The parts of the request that you want to keep out of the logs.
LoggingConfiguration	withRedactedFields(FieldToMatch... redactedFields) The parts of the request that you want to keep out of the logs.
LoggingConfiguration	withResourceArn(String resourceArn) The Amazon Resource Name (ARN) of the web ACL that you want to associate with LogDestinationConfigs.

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

LoggingConfiguration

public LoggingConfiguration()

Method Detail

setResourceArn

public void setResourceArn(String resourceArn)

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

Parameters:

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

getResourceArn

public String getResourceArn()

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.

withResourceArn

public LoggingConfiguration withResourceArn(String resourceArn)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

getLogDestinationConfigs

public List<String> getLogDestinationConfigs()

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

Returns:

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

setLogDestinationConfigs

public void setLogDestinationConfigs(Collection<String> logDestinationConfigs)

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

Parameters:

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

withLogDestinationConfigs

public LoggingConfiguration withLogDestinationConfigs(String... logDestinationConfigs)

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

NOTE: This method appends the values to the existing list (if any). Use setLogDestinationConfigs(java.util.Collection) or withLogDestinationConfigs(java.util.Collection) if you want to override the existing values.

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

withLogDestinationConfigs

public LoggingConfiguration withLogDestinationConfigs(Collection<String> logDestinationConfigs)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

getRedactedFields

public List<FieldToMatch> getRedactedFields()

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

Returns:

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

setRedactedFields

public void setRedactedFields(Collection<FieldToMatch> redactedFields)

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

Parameters:

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

withRedactedFields

public LoggingConfiguration withRedactedFields(FieldToMatch... redactedFields)

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

NOTE: This method appends the values to the existing list (if any). Use setRedactedFields(java.util.Collection) or withRedactedFields(java.util.Collection) if you want to override the existing values.

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

withRedactedFields

public LoggingConfiguration withRedactedFields(Collection<FieldToMatch> redactedFields)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

toString

public String 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.

Overrides:

toString in class Object

Returns:

A string representation of this object.

See Also:

Object.toString()

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

clone

public LoggingConfiguration clone()

Overrides:

clone in class Object

marshall

public void marshall(ProtocolMarshaller protocolMarshaller)

Specified by:

marshall in interface StructuredPojo