Copyright	(c) 2013-2021 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay <brendan.g.hay+amazonka@gmail.com>
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	None

Amazonka.NetworkFirewall.Types.LogDestinationConfig

Description

Documentation

data LogDestinationConfig Source #

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.

See: newLogDestinationConfig smart constructor.

Constructors

LogDestinationConfig'

Fields

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.
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.
logDestination :: HashMap Text Text
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" }
```

Instances

Instances details

Eq LogDestinationConfig Source #
Instance details Defined in Amazonka.NetworkFirewall.Types.LogDestinationConfig Methods (==) :: LogDestinationConfig -> LogDestinationConfig -> Bool # (/=) :: LogDestinationConfig -> LogDestinationConfig -> Bool #
Read LogDestinationConfig Source #
Instance details Defined in Amazonka.NetworkFirewall.Types.LogDestinationConfig Methods readsPrec :: Int -> ReadS LogDestinationConfig # readList :: ReadS [LogDestinationConfig] # readPrec :: ReadPrec LogDestinationConfig # readListPrec :: ReadPrec [LogDestinationConfig] #
Show LogDestinationConfig Source #
Instance details Defined in Amazonka.NetworkFirewall.Types.LogDestinationConfig Methods showsPrec :: Int -> LogDestinationConfig -> ShowS # show :: LogDestinationConfig -> String # showList :: [LogDestinationConfig] -> ShowS #
Generic LogDestinationConfig Source #
Instance details Defined in Amazonka.NetworkFirewall.Types.LogDestinationConfig Associated Types type Rep LogDestinationConfig :: Type -> Type # Methods from :: LogDestinationConfig -> Rep LogDestinationConfig x # to :: Rep LogDestinationConfig x -> LogDestinationConfig #
NFData LogDestinationConfig Source #
Instance details Defined in Amazonka.NetworkFirewall.Types.LogDestinationConfig Methods rnf :: LogDestinationConfig -> () #
Hashable LogDestinationConfig Source #
Instance details Defined in Amazonka.NetworkFirewall.Types.LogDestinationConfig Methods hashWithSalt :: Int -> LogDestinationConfig -> Int # hash :: LogDestinationConfig -> Int #
ToJSON LogDestinationConfig Source #
Instance details Defined in Amazonka.NetworkFirewall.Types.LogDestinationConfig Methods toJSON :: LogDestinationConfig -> Value # toEncoding :: LogDestinationConfig -> Encoding # toJSONList :: [LogDestinationConfig] -> Value # toEncodingList :: [LogDestinationConfig] -> Encoding #
FromJSON LogDestinationConfig Source #
Instance details Defined in Amazonka.NetworkFirewall.Types.LogDestinationConfig Methods parseJSON :: Value -> Parser LogDestinationConfig # parseJSONList :: Value -> Parser [LogDestinationConfig] #
type Rep LogDestinationConfig Source #
Instance details Defined in Amazonka.NetworkFirewall.Types.LogDestinationConfig type Rep LogDestinationConfig = D1 ('MetaData "LogDestinationConfig" "Amazonka.NetworkFirewall.Types.LogDestinationConfig" "libZSservicesZSamazonka-network-firewallZSamazonka-network-firewall" 'False) (C1 ('MetaCons "LogDestinationConfig'" 'PrefixI 'True) (S1 ('MetaSel ('Just "logType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 LogType) :: (S1 ('MetaSel ('Just "logDestinationType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 LogDestinationType) :: S1 ('MetaSel ('Just "logDestination") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (HashMap Text Text)))))

newLogDestinationConfig Source #

Arguments

:: LogType	`$sel:logType:LogDestinationConfig'`
-> LogDestinationType	`$sel:logDestinationType:LogDestinationConfig'`
-> LogDestinationConfig

Create a value of LogDestinationConfig with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:logType:LogDestinationConfig', logDestinationConfig_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.

$sel:logDestinationType:LogDestinationConfig', logDestinationConfig_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.

$sel:logDestination:LogDestinationConfig', logDestinationConfig_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" }
```

logDestinationConfig_logType :: Lens' LogDestinationConfig LogType Source #

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.

logDestinationConfig_logDestinationType :: Lens' LogDestinationConfig LogDestinationType Source #

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.

logDestinationConfig_logDestination :: Lens' LogDestinationConfig (HashMap Text Text) Source #

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