AWS SDK for C++  1.9.66
AWS SDK for C++
Public Member Functions | List of all members
Aws::NetworkFirewall::Model::LogDestinationConfig Class Reference

#include <LogDestinationConfig.h>

Public Member Functions

 LogDestinationConfig ()
 
 LogDestinationConfig (Aws::Utils::Json::JsonView jsonValue)
 
LogDestinationConfigoperator= (Aws::Utils::Json::JsonView jsonValue)
 
Aws::Utils::Json::JsonValue Jsonize () const
 
const LogTypeGetLogType () const
 
bool LogTypeHasBeenSet () const
 
void SetLogType (const LogType &value)
 
void SetLogType (LogType &&value)
 
LogDestinationConfigWithLogType (const LogType &value)
 
LogDestinationConfigWithLogType (LogType &&value)
 
const LogDestinationTypeGetLogDestinationType () const
 
bool LogDestinationTypeHasBeenSet () const
 
void SetLogDestinationType (const LogDestinationType &value)
 
void SetLogDestinationType (LogDestinationType &&value)
 
LogDestinationConfigWithLogDestinationType (const LogDestinationType &value)
 
LogDestinationConfigWithLogDestinationType (LogDestinationType &&value)
 
const Aws::Map< Aws::String, Aws::String > & GetLogDestination () const
 
bool LogDestinationHasBeenSet () const
 
void SetLogDestination (const Aws::Map< Aws::String, Aws::String > &value)
 
void SetLogDestination (Aws::Map< Aws::String, Aws::String > &&value)
 
LogDestinationConfigWithLogDestination (const Aws::Map< Aws::String, Aws::String > &value)
 
LogDestinationConfigWithLogDestination (Aws::Map< Aws::String, Aws::String > &&value)
 
LogDestinationConfigAddLogDestination (const Aws::String &key, const Aws::String &value)
 
LogDestinationConfigAddLogDestination (Aws::String &&key, const Aws::String &value)
 
LogDestinationConfigAddLogDestination (const Aws::String &key, Aws::String &&value)
 
LogDestinationConfigAddLogDestination (Aws::String &&key, Aws::String &&value)
 
LogDestinationConfigAddLogDestination (const char *key, Aws::String &&value)
 
LogDestinationConfigAddLogDestination (Aws::String &&key, const char *value)
 
LogDestinationConfigAddLogDestination (const char *key, const char *value)
 

Detailed Description

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 Also:

AWS API Reference

Definition at line 41 of file LogDestinationConfig.h.

Constructor & Destructor Documentation

◆ LogDestinationConfig() [1/2]

Aws::NetworkFirewall::Model::LogDestinationConfig::LogDestinationConfig ( )

◆ LogDestinationConfig() [2/2]

Aws::NetworkFirewall::Model::LogDestinationConfig::LogDestinationConfig ( Aws::Utils::Json::JsonView  jsonValue)

Member Function Documentation

◆ AddLogDestination() [1/7]

LogDestinationConfig& Aws::NetworkFirewall::Model::LogDestinationConfig::AddLogDestination ( Aws::String &&  key,
Aws::String &&  value 
)
inline

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

Definition at line 324 of file LogDestinationConfig.h.

◆ AddLogDestination() [2/7]

LogDestinationConfig& Aws::NetworkFirewall::Model::LogDestinationConfig::AddLogDestination ( Aws::String &&  key,
const Aws::String value 
)
inline

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

Definition at line 286 of file LogDestinationConfig.h.

◆ AddLogDestination() [3/7]

LogDestinationConfig& Aws::NetworkFirewall::Model::LogDestinationConfig::AddLogDestination ( Aws::String &&  key,
const char *  value 
)
inline

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

Definition at line 362 of file LogDestinationConfig.h.

◆ AddLogDestination() [4/7]

LogDestinationConfig& Aws::NetworkFirewall::Model::LogDestinationConfig::AddLogDestination ( const Aws::String key,
Aws::String &&  value 
)
inline

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

Definition at line 305 of file LogDestinationConfig.h.

◆ AddLogDestination() [5/7]

LogDestinationConfig& Aws::NetworkFirewall::Model::LogDestinationConfig::AddLogDestination ( const Aws::String key,
const Aws::String value 
)
inline

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

Definition at line 267 of file LogDestinationConfig.h.

◆ AddLogDestination() [6/7]

LogDestinationConfig& Aws::NetworkFirewall::Model::LogDestinationConfig::AddLogDestination ( const char *  key,
Aws::String &&  value 
)
inline

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

Definition at line 343 of file LogDestinationConfig.h.

◆ AddLogDestination() [7/7]

LogDestinationConfig& Aws::NetworkFirewall::Model::LogDestinationConfig::AddLogDestination ( const char *  key,
const char *  value 
)
inline

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

Definition at line 381 of file LogDestinationConfig.h.

◆ GetLogDestination()

const Aws::Map<Aws::String, Aws::String>& Aws::NetworkFirewall::Model::LogDestinationConfig::GetLogDestination ( ) const
inline

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

Definition at line 153 of file LogDestinationConfig.h.

◆ GetLogDestinationType()

const LogDestinationType& Aws::NetworkFirewall::Model::LogDestinationConfig::GetLogDestinationType ( ) const
inline

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.

Definition at line 98 of file LogDestinationConfig.h.

◆ GetLogType()

const LogType& Aws::NetworkFirewall::Model::LogDestinationConfig::GetLogType ( ) const
inline

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.

Definition at line 55 of file LogDestinationConfig.h.

◆ Jsonize()

Aws::Utils::Json::JsonValue Aws::NetworkFirewall::Model::LogDestinationConfig::Jsonize ( ) const

◆ LogDestinationHasBeenSet()

bool Aws::NetworkFirewall::Model::LogDestinationConfig::LogDestinationHasBeenSet ( ) const
inline

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

Definition at line 172 of file LogDestinationConfig.h.

◆ LogDestinationTypeHasBeenSet()

bool Aws::NetworkFirewall::Model::LogDestinationConfig::LogDestinationTypeHasBeenSet ( ) const
inline

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.

Definition at line 105 of file LogDestinationConfig.h.

◆ LogTypeHasBeenSet()

bool Aws::NetworkFirewall::Model::LogDestinationConfig::LogTypeHasBeenSet ( ) const
inline

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.

Definition at line 62 of file LogDestinationConfig.h.

◆ operator=()

LogDestinationConfig& Aws::NetworkFirewall::Model::LogDestinationConfig::operator= ( Aws::Utils::Json::JsonView  jsonValue)

◆ SetLogDestination() [1/2]

void Aws::NetworkFirewall::Model::LogDestinationConfig::SetLogDestination ( Aws::Map< Aws::String, Aws::String > &&  value)
inline

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

Definition at line 210 of file LogDestinationConfig.h.

◆ SetLogDestination() [2/2]

void Aws::NetworkFirewall::Model::LogDestinationConfig::SetLogDestination ( const Aws::Map< Aws::String, Aws::String > &  value)
inline

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

Definition at line 191 of file LogDestinationConfig.h.

◆ SetLogDestinationType() [1/2]

void Aws::NetworkFirewall::Model::LogDestinationConfig::SetLogDestinationType ( const LogDestinationType value)
inline

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.

Definition at line 112 of file LogDestinationConfig.h.

◆ SetLogDestinationType() [2/2]

void Aws::NetworkFirewall::Model::LogDestinationConfig::SetLogDestinationType ( LogDestinationType &&  value)
inline

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.

Definition at line 119 of file LogDestinationConfig.h.

◆ SetLogType() [1/2]

void Aws::NetworkFirewall::Model::LogDestinationConfig::SetLogType ( const LogType value)
inline

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.

Definition at line 69 of file LogDestinationConfig.h.

◆ SetLogType() [2/2]

void Aws::NetworkFirewall::Model::LogDestinationConfig::SetLogType ( LogType &&  value)
inline

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.

Definition at line 76 of file LogDestinationConfig.h.

◆ WithLogDestination() [1/2]

LogDestinationConfig& Aws::NetworkFirewall::Model::LogDestinationConfig::WithLogDestination ( Aws::Map< Aws::String, Aws::String > &&  value)
inline

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

Definition at line 248 of file LogDestinationConfig.h.

◆ WithLogDestination() [2/2]

LogDestinationConfig& Aws::NetworkFirewall::Model::LogDestinationConfig::WithLogDestination ( const Aws::Map< Aws::String, Aws::String > &  value)
inline

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

Definition at line 229 of file LogDestinationConfig.h.

◆ WithLogDestinationType() [1/2]

LogDestinationConfig& Aws::NetworkFirewall::Model::LogDestinationConfig::WithLogDestinationType ( const LogDestinationType value)
inline

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.

Definition at line 126 of file LogDestinationConfig.h.

◆ WithLogDestinationType() [2/2]

LogDestinationConfig& Aws::NetworkFirewall::Model::LogDestinationConfig::WithLogDestinationType ( LogDestinationType &&  value)
inline

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.

Definition at line 133 of file LogDestinationConfig.h.

◆ WithLogType() [1/2]

LogDestinationConfig& Aws::NetworkFirewall::Model::LogDestinationConfig::WithLogType ( const LogType value)
inline

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.

Definition at line 83 of file LogDestinationConfig.h.

◆ WithLogType() [2/2]

LogDestinationConfig& Aws::NetworkFirewall::Model::LogDestinationConfig::WithLogType ( LogType &&  value)
inline

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.

Definition at line 90 of file LogDestinationConfig.h.


The documentation for this class was generated from the following file: