AWS::NetworkFirewall::LoggingConfiguration LogDestinationConfig - Amazon CloudFormation
SyntaxProperties
Services or capabilities described in Amazon Web Services documentation might vary by Region. To see the differences applicable to the China Regions, see Getting Started with Amazon Web Services in China (PDF).

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" : {Key: Value, ...},
  "LogDestinationType" : String,
  "LogType" : String
}

YAML

  LogDestination: 
    Key: Value
  LogDestinationType: 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 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 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" }

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 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.

Required: Yes

Type: String

Allowed values: ALERT | FLOW

Update requires: No interruption