Package software.amazon.awssdk.services.networkfirewall.model

Class LogDestinationConfig

java.lang.Object

software.amazon.awssdk.services.networkfirewall.model.LogDestinationConfig

All Implemented Interfaces:

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

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

Defines where Network Firewall sends logs for the firewall for one log type. This is used in LoggingConfiguration. You can send each type of log to an Amazon S3 bucket, a CloudWatch log group, or a Kinesis Data Firehose delivery stream.

Network Firewall generates logs for stateful rule groups. You can save alert and flow log types. The stateful rules engine records flow logs for all network traffic that it receives. It records alert logs for traffic that matches stateful rules that have the rule action set to DROP or ALERT.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	LogDestinationConfig.Builder

Method Summary

Modifier and Type	Method	Description
static LogDestinationConfig.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasLogDestination()	For responses, this returns true if the service returned a value for the LogDestination property.
Map<String,String>	logDestination()	The named location for the logs, provided in a key:value mapping that is specific to the chosen destination type.
LogDestinationType	logDestinationType()	The type of storage destination to send these logs to.
String	logDestinationTypeAsString()	The type of storage destination to send these logs to.
LogType	logType()	The type of log to send.
String	logTypeAsString()	The type of log to send.
List<SdkField<?>>	sdkFields()
static Class<? extends LogDestinationConfig.Builder>	serializableBuilderClass()
LogDestinationConfig.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

logType

public final LogType logType()

The type of log to send. Alert logs report traffic that matches a StatefulRule with an action setting that sends an alert log message. Flow logs are standard network traffic flow logs.

If the service returns an enum value that is not available in the current SDK version, logType will return LogType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from logTypeAsString().

Returns:

The type of log to send. Alert logs report traffic that matches a StatefulRule with an action setting that sends an alert log message. Flow logs are standard network traffic flow logs.

See Also:

LogType

logTypeAsString

public final String logTypeAsString()

The type of log to send. Alert logs report traffic that matches a StatefulRule with an action setting that sends an alert log message. Flow logs are standard network traffic flow logs.

If the service returns an enum value that is not available in the current SDK version, logType will return LogType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from logTypeAsString().

Returns:

The type of log to send. Alert logs report traffic that matches a StatefulRule with an action setting that sends an alert log message. Flow logs are standard network traffic flow logs.

See Also:

LogType

logDestinationType

public final LogDestinationType logDestinationType()

The type of storage destination to send these logs to. You can send logs to an Amazon S3 bucket, a CloudWatch log group, or a Kinesis Data Firehose delivery stream.

If the service returns an enum value that is not available in the current SDK version, logDestinationType will return LogDestinationType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from logDestinationTypeAsString().

Returns:

The type of storage destination to send these logs to. You can send logs to an Amazon S3 bucket, a CloudWatch log group, or a Kinesis Data Firehose delivery stream.

See Also:

LogDestinationType

logDestinationTypeAsString

public final String logDestinationTypeAsString()

The type of storage destination to send these logs to. You can send logs to an Amazon S3 bucket, a CloudWatch log group, or a Kinesis Data Firehose delivery stream.

If the service returns an enum value that is not available in the current SDK version, logDestinationType will return LogDestinationType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from logDestinationTypeAsString().

Returns:

The type of storage destination to send these logs to. You can send logs to an Amazon S3 bucket, a CloudWatch log group, or a Kinesis Data Firehose delivery stream.

See Also:

LogDestinationType

hasLogDestination

public final boolean hasLogDestination()

For responses, this returns true if the service returned a value for the LogDestination 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.

logDestination

public final Map<String,String> logDestination()

The named location for the logs, provided in a key:value mapping that is specific to the chosen destination type.

• For an Amazon S3 bucket, provide the name of the bucket, with key bucketName, and optionally provide a prefix, with key prefix. The following example specifies an Amazon S3 bucket named DOC-EXAMPLE-BUCKET and the prefix alerts:

  "LogDestination": { "bucketName": "DOC-EXAMPLE-BUCKET", "prefix": "alerts" }

• For a CloudWatch log group, provide the name of the CloudWatch log group, with key logGroup. The following example specifies a log group named alert-log-group:

  "LogDestination": { "logGroup": "alert-log-group" }

• For a Kinesis Data Firehose delivery stream, provide the name of the delivery stream, with key deliveryStream. The following example specifies a delivery stream named alert-delivery-stream:

  "LogDestination": { "deliveryStream": "alert-delivery-stream" }

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 hasLogDestination() method.

Returns:

The named location for the logs, provided in a key:value mapping that is specific to the chosen destination type.

• For an Amazon S3 bucket, provide the name of the bucket, with key bucketName, and optionally provide a prefix, with key prefix. The following example specifies an Amazon S3 bucket named DOC-EXAMPLE-BUCKET and the prefix alerts:

  "LogDestination": { "bucketName": "DOC-EXAMPLE-BUCKET", "prefix": "alerts" }

• For a CloudWatch log group, provide the name of the CloudWatch log group, with key logGroup. The following example specifies a log group named alert-log-group:

  "LogDestination": { "logGroup": "alert-log-group" }

• For a Kinesis Data Firehose delivery stream, provide the name of the delivery stream, with key deliveryStream. The following example specifies a delivery stream named alert-delivery-stream:

  "LogDestination": { "deliveryStream": "alert-delivery-stream" }

toBuilder

public LogDestinationConfig.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<LogDestinationConfig.Builder,LogDestinationConfig>

builder

public static LogDestinationConfig.Builder builder()

serializableBuilderClass

public static Class<? extends LogDestinationConfig.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