software.amazon.awscdk.services.networkfirewall

Interface CfnLoggingConfiguration.LogDestinationConfigProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnLoggingConfiguration.LogDestinationConfigProperty.Jsii$Proxy

Enclosing class:

CfnLoggingConfiguration

@Stability(value=Stable)
public static interface CfnLoggingConfiguration.LogDestinationConfigProperty
extends software.amazon.jsii.JsiiSerializable

Defines where AWS 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 .

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.networkfirewall.*;
 LogDestinationConfigProperty logDestinationConfigProperty = LogDestinationConfigProperty.builder()
         .logDestination(Map.of(
                 "logDestinationKey", "logDestination"))
         .logDestinationType("logDestinationType")
         .logType("logType")
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	CfnLoggingConfiguration.LogDestinationConfigProperty.Builder A builder for CfnLoggingConfiguration.LogDestinationConfigProperty
static class	CfnLoggingConfiguration.LogDestinationConfigProperty.Jsii$Proxy An implementation for CfnLoggingConfiguration.LogDestinationConfigProperty

Method Summary

Modifier and Type	Method and Description
static CfnLoggingConfiguration.LogDestinationConfigProperty.Builder	builder()
Object	getLogDestination() The named location for the logs, provided in a key:value mapping that is specific to the chosen destination type.
String	getLogDestinationType() The type of storage destination to send these logs to.
String	getLogType() The type of log to send.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getLogDestination

@Stability(value=Stable)
 @NotNull
Object getLogDestination()

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" }

getLogDestinationType

@Stability(value=Stable)
 @NotNull
String getLogDestinationType()

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.

getLogType

@Stability(value=Stable)
 @NotNull
String getLogType()

The type of log to send.

Alert logs report traffic that matches a stateful rule with an action setting that sends an alert log message. Flow logs are standard network traffic flow logs.

builder

@Stability(value=Stable)
static CfnLoggingConfiguration.LogDestinationConfigProperty.Builder builder()

Returns:

a CfnLoggingConfiguration.LogDestinationConfigProperty.Builder of CfnLoggingConfiguration.LogDestinationConfigProperty