Package software.amazon.awssdk.services.waf.model

Class LoggingConfiguration

java.lang.Object

software.amazon.awssdk.services.waf.model.LoggingConfiguration

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<LoggingConfiguration.Builder,LoggingConfiguration>

@Generated("software.amazon.awssdk:codegen")
public final class LoggingConfiguration
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<LoggingConfiguration.Builder,LoggingConfiguration>

This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide.

For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.

The Amazon Kinesis Data Firehose, RedactedFields information, and the web ACL Amazon Resource Name (ARN).

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	LoggingConfiguration.Builder

Method Summary

Modifier and Type	Method	Description
static LoggingConfiguration.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasLogDestinationConfigs()	For responses, this returns true if the service returned a value for the LogDestinationConfigs property.
boolean	hasRedactedFields()	For responses, this returns true if the service returned a value for the RedactedFields property.
List<String>	logDestinationConfigs()	An array of Amazon Kinesis Data Firehose ARNs.
List<FieldToMatch>	redactedFields()	The parts of the request that you want redacted from the logs.
String	resourceArn()	The Amazon Resource Name (ARN) of the web ACL that you want to associate with LogDestinationConfigs.
List<SdkField<?>>	sdkFields()
static Class<? extends LoggingConfiguration.Builder>	serializableBuilderClass()
LoggingConfiguration.Builder	toBuilder()
String	toString()	Returns a string representation of this object.

Methods inherited from class java.lang.Object

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

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

resourceArn

public final String 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 the isEmpty() 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

public final List<String> logDestinationConfigs()

An array of Amazon Kinesis Data Firehose ARNs.

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:

An array of Amazon Kinesis Data Firehose ARNs.

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 the isEmpty() 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

public final List<FieldToMatch> redactedFields()

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

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 redacted from the logs. For example, if you redact the cookie field, the cookie field in the firehose will be xxx.

toBuilder

public LoggingConfiguration.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<LoggingConfiguration.Builder,LoggingConfiguration>

builder

public static LoggingConfiguration.Builder builder()

serializableBuilderClass

public static Class<? extends LoggingConfiguration.Builder> serializableBuilderClass()

hashCode

public final int hashCode()

Overrides:

hashCode in class Object

equals

public final boolean equals(Object obj)

Overrides:

equals in class Object

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

toString

public final 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

getValueForField

public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo