logging_configurations

Creates, updates, deletes, gets or lists a logging_configurations resource.

Overview

Name	logging_configurations
Type	Resource
Id	aws.network_firewall.logging_configurations

Fields

The following fields are returned by SELECT queries:

describe_logging_configuration

Name	Datatype	Description
enable_monitoring_dashboard	boolean	A boolean that reflects whether or not the firewall monitoring dashboard is enabled on a firewall. Returns TRUE when the firewall monitoring dashboard is enabled on the firewall. Returns FALSE when the firewall monitoring dashboard is not enabled on the firewall.
firewall_arn	string	The Amazon Resource Name (ARN) of the firewall. (pattern: <code>^arn:aws.*</code>)
logging_configuration	object	Defines how Network Firewall performs logging for a Firewall.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
describe_logging_configuration	select	region		Returns the logging configuration for the specified firewall.
update_logging_configuration	update	region		Sets the logging configuration for the specified firewall. To change the logging configuration, retrieve the LoggingConfiguration by calling DescribeLoggingConfiguration, 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 UpdateLoggingConfiguration: 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.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
region	string	AWS region (default: us-east-1)

SELECT examples

describe_logging_configuration

Returns the logging configuration for the specified firewall.

SELECT
enable_monitoring_dashboard,
firewall_arn,
logging_configuration
FROM aws.network_firewall.logging_configurations
WHERE region = '{{ region }}' -- required
;

UPDATE examples

update_logging_configuration

Sets the logging configuration for the specified firewall. To change the logging configuration, retrieve the LoggingConfiguration by calling DescribeLoggingConfiguration, 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 UpdateLoggingConfiguration: 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.

UPDATE aws.network_firewall.logging_configurations
SET 
FirewallArn = '{{ FirewallArn }}',
FirewallName = '{{ FirewallName }}',
LoggingConfiguration = '{{ LoggingConfiguration }}',
EnableMonitoringDashboard = {{ EnableMonitoringDashboard }}
WHERE 
region = '{{ region }}' --required
RETURNING
enable_monitoring_dashboard,
firewall_arn,
firewall_name,
logging_configuration;