Class: AWSCDK::NetworkFirewall::CfnLoggingConfiguration::LogDestinationConfigProperty

Inherits:
Jsii::Struct
  • Object
show all
Defined in:
network_firewall/cfn_logging_configuration.rb

Overview

Defines where AWS Network Firewall sends logs for the firewall for one log type.

This is used in logging configuration. 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:

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(log_destination:, log_destination_type:, log_type:) ⇒ LogDestinationConfigProperty

Returns a new instance of LogDestinationConfigProperty.

Parameters:

  • log_destination (AWSCDK::IResolvable, Hash{String => String}) —

    The named location for the logs, provided in a key:value mapping that is specific to the chosen destination type.

  • log_destination_type (String) —

    The type of storage destination to send these logs to.

  • log_type (String) —

    The type of log to record.



546
547
548
549
550
551
552
553
 
# File 'network_firewall/cfn_logging_configuration.rb', line 546

def initialize(log_destination:, log_destination_type:, log_type:)
  @log_destination = log_destination
  Jsii::Type.check_type(@log_destination, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImNvbGxlY3Rpb24iOnsiZWxlbWVudHR5cGUiOnsicHJpbWl0aXZlIjoic3RyaW5nIn0sImtpbmQiOiJtYXAifX1dfX0=")), "logDestination")
  @log_destination_type = log_destination_type
  Jsii::Type.check_type(@log_destination_type, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "logDestinationType")
  @log_type = log_type
  Jsii::Type.check_type(@log_type, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "logType")
end

Instance Attribute Details

#log_destination ⇒ AWSCDK::IResolvable, Hash{String => String} (readonly)

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 bucket_name , 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 log_group . 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 delivery_stream . The following example specifies a delivery stream named alert-delivery-stream :

"LogDestination": { "deliveryStream": "alert-delivery-stream" }

Returns:

See Also:



573
574
575
 
# File 'network_firewall/cfn_logging_configuration.rb', line 573

def log_destination
  @log_destination
end

#log_destination_type ⇒ String (readonly)

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.

Returns:

  • (String)

See Also:



580
581
582
 
# File 'network_firewall/cfn_logging_configuration.rb', line 580

def log_destination_type
  @log_destination_type
end

#log_type ⇒ String (readonly)

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

Returns:

  • (String)

See Also:



591
592
593
 
# File 'network_firewall/cfn_logging_configuration.rb', line 591

def log_type
  @log_type
end

Class Method Details

.jsii_properties ⇒ Object 



593
594
595
596
597
598
599
 
# File 'network_firewall/cfn_logging_configuration.rb', line 593

def self.jsii_properties
  {
    :log_destination => "logDestination",
    :log_destination_type => "logDestinationType",
    :log_type => "logType",
  }
end

Instance Method Details

#to_jsii ⇒ Object 



601
602
603
604
605
606
607
608
609
 
# File 'network_firewall/cfn_logging_configuration.rb', line 601

def to_jsii
  result = {}
  result.merge!({
    "logDestination" => @log_destination,
    "logDestinationType" => @log_destination_type,
    "logType" => @log_type,
  })
  result.compact
end