Skip to content

Sets the logging configuration for the specified firewall

Description

Sets the logging configuration for the specified firewall.

To change the logging configuration, retrieve the LoggingConfiguration by calling describe_logging_configuration, then change it and provide the modified object to this update call. You must change the logging configuration one LogDestinationConfig at a time inside the retrieved LoggingConfiguration object.

You can perform only one of the following actions in any call to update_logging_configuration:

  • Create a new log destination object by adding a single LogDestinationConfig array element to LogDestinationConfigs.
  • Delete a log destination object by removing a single LogDestinationConfig array element from LogDestinationConfigs.
  • Change the LogDestination setting in a single LogDestinationConfig array element.

You can't change the LogDestinationType or LogType in a LogDestinationConfig. To change these settings, delete the existing LogDestinationConfig object and create a new one, using two separate calls to this update operation.

Usage

networkfirewall_update_logging_configuration(FirewallArn, FirewallName,
  LoggingConfiguration, EnableMonitoringDashboard)

Arguments

  • FirewallArn

    The Amazon Resource Name (ARN) of the firewall.

    You must specify the ARN or the name, and you can specify both.

  • FirewallName

    The descriptive name of the firewall. You can't change the name of a firewall after you create it.

    You must specify the ARN or the name, and you can specify both.

  • LoggingConfiguration

    Defines how Network Firewall performs logging for a firewall. If you omit this setting, Network Firewall disables logging for the firewall.

  • EnableMonitoringDashboard

    A boolean that lets you enable or disable the detailed firewall monitoring dashboard on the firewall.

    The monitoring dashboard provides comprehensive visibility into your firewall's flow logs and alert logs. After you enable detailed monitoring, you can access these dashboards directly from the Monitoring page of the Network Firewall console.

    Specify TRUE to enable the the detailed monitoring dashboard on the firewall. Specify FALSE to disable the the detailed monitoring dashboard on the firewall.

Value

A list with the following syntax:

list(
  FirewallArn = "string",
  FirewallName = "string",
  LoggingConfiguration = list(
    LogDestinationConfigs = list(
      list(
        LogType = "ALERT"|"FLOW"|"TLS",
        LogDestinationType = "S3"|"CloudWatchLogs"|"KinesisDataFirehose",
        LogDestination = list(
          "string"
        )
      )
    )
  ),
  EnableMonitoringDashboard = TRUE|FALSE
)

Request syntax

svc$update_logging_configuration(
  FirewallArn = "string",
  FirewallName = "string",
  LoggingConfiguration = list(
    LogDestinationConfigs = list(
      list(
        LogType = "ALERT"|"FLOW"|"TLS",
        LogDestinationType = "S3"|"CloudWatchLogs"|"KinesisDataFirehose",
        LogDestination = list(
          "string"
        )
      )
    )
  ),
  EnableMonitoringDashboard = TRUE|FALSE
)