LogDestinationConfig - AWS Network Firewall

LogDestinationConfig

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.

Contents

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

Type: String to string map

Key Length Constraints: Minimum length of 3. Maximum length of 50.

Key Pattern: ^[0-9A-Za-z.\-_@\/]+$

Value Length Constraints: Minimum length of 1. Maximum length of 1024.

Value Pattern: [\s\S]*$

Required: Yes

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.

Type: String

Length Constraints: Minimum length of 2. Maximum length of 30.

Pattern: [0-9A-Za-z]+

Valid Values: S3 | CloudWatchLogs | KinesisDataFirehose

Required: Yes

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.

Type: String

Valid Values: ALERT | FLOW

Required: Yes

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: