AWS::NetworkFirewall::LoggingConfiguration LogDestinationConfig
Defines where Amazon Network Firewall sends logs for the firewall for one log type. This is used in AWS::NetworkFirewall::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
.
Syntax
To declare this entity in your Amazon CloudFormation template, use the following syntax:
JSON
{ "LogDestination" :
{
, "LogDestinationType" :Key
:Value
, ...}String
, "LogType" :String
}
YAML
LogDestination:
LogDestinationType:
Key
:Value
String
LogType:String
Properties
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 keyprefix
.The following example specifies an Amazon S3 bucket named
DOC-EXAMPLE-BUCKET
and the prefixalerts
:"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 namedalert-log-group
:"LogDestination": { "logGroup": "alert-log-group" }
-
For a Firehose delivery stream, provide the name of the delivery stream, with key
deliveryStream
. The following example specifies a delivery stream namedalert-delivery-stream
:"LogDestination": { "deliveryStream": "alert-delivery-stream" }
Required: Yes
Type: Object of String
Pattern:
^[0-9A-Za-z.\-_@\/]+$
Minimum:
1
Maximum:
1024
Update requires: No interruption
-
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 Firehose delivery stream.
Required: Yes
Type: String
Allowed values:
S3 | CloudWatchLogs | KinesisDataFirehose
Update requires: No interruption
LogType
-
The type of log to record. You can record the following types of logs from your Network Firewall stateful engine.
-
ALERT
- Logs for traffic that matches your stateful rules and that have an action that sends an alert. A stateful rule sends alerts for the rule actions DROP, ALERT, and REJECT. For more information, see theStatefulRule
property. -
FLOW
- Standard network traffic flow logs. The stateful rules engine records flow logs for all network traffic that it receives. Each flow log record captures the network flow for a specific standard stateless rule group. -
TLS
- Logs for events that are related to TLS inspection. For more information, see Inspecting SSL/TLS traffic with TLS inspection configurations in the Network Firewall Developer Guide.
Required: Yes
Type: String
Allowed values:
ALERT | FLOW | TLS
Update requires: No interruption
-