logging_configurations

Creates, updates, deletes or gets a logging_configuration resource or lists logging_configurations in a region

Overview

Name	logging_configurations
Type	Resource
Description	Resource type definition for AWS::NetworkFirewall::LoggingConfiguration
Id	aws.networkfirewall.logging_configurations

Fields

Name	Datatype	Description
firewall_name	string
firewall_arn	string	A resource ARN.
logging_configuration	object	Resource type definition for AWS::NetworkFirewall::LoggingConfiguration
region	string	AWS region.

Methods

Name	Accessible by	Required Params
create_resource	INSERT	FirewallArn, LoggingConfiguration, region
delete_resource	DELETE	data__Identifier, region
update_resource	UPDATE	data__Identifier, data__PatchDocument, region
list_resources	SELECT	region
get_resource	SELECT	data__Identifier, region

SELECT examples

Gets all logging_configurations in a region.

SELECT
region,
firewall_name,
firewall_arn,
logging_configuration
FROM aws.networkfirewall.logging_configurations
WHERE region = 'us-east-1';

Gets all properties from an individual logging_configuration.

SELECT
region,
firewall_name,
firewall_arn,
logging_configuration
FROM aws.networkfirewall.logging_configurations
WHERE region = 'us-east-1' AND data__Identifier = '<FirewallArn>';

INSERT example

Use the following StackQL query and manifest file to create a new logging_configuration resource, using stack-deploy.

Required Properties

/*+ create */
INSERT INTO aws.networkfirewall.logging_configurations (
 FirewallArn,
 LoggingConfiguration,
 region
)
SELECT 
'{{ FirewallArn }}',
 '{{ LoggingConfiguration }}',
'{{ region }}';

All Properties

/*+ create */
INSERT INTO aws.networkfirewall.logging_configurations (
 FirewallName,
 FirewallArn,
 LoggingConfiguration,
 region
)
SELECT 
 '{{ FirewallName }}',
 '{{ FirewallArn }}',
 '{{ LoggingConfiguration }}',
 '{{ region }}';

Manifest

version: 1
name: stack name
description: stack description
providers:
  - aws
globals:
  - name: region
    value: '{{ vars.AWS_REGION }}'
resources:
  - name: logging_configuration
    props:
      - name: FirewallName
        value: '{{ FirewallName }}'
      - name: FirewallArn
        value: '{{ FirewallArn }}'
      - name: LoggingConfiguration
        value:
          FirewallName: '{{ FirewallName }}'
          FirewallArn: null
          LoggingConfiguration: null

DELETE example

/*+ delete */
DELETE FROM aws.networkfirewall.logging_configurations
WHERE data__Identifier = '<FirewallArn>'
AND region = 'us-east-1';

Permissions

To operate on the logging_configurations resource, the following permissions are required:

Create

logs:CreateLogDelivery,
logs:GetLogDelivery,
logs:ListLogDeliveries,
s3:PutBucketPolicy,
s3:GetBucketPolicy,
logs:PutResourcePolicy,
logs:DescribeResourcePolicies,
logs:DescribeLogGroups,
iam:CreateServiceLinkedRole,
firehose:TagDeliveryStream,
network-firewall:UpdateLoggingConfiguration,
network-firewall:DescribeLoggingConfiguration

Read

logs:GetLogDelivery,
logs:ListLogDeliveries,
network-firewall:DescribeLoggingConfiguration

Update

logs:CreateLogDelivery,
logs:DeleteLogDelivery,
logs:GetLogDelivery,
logs:UpdateLogDelivery,
logs:ListLogDeliveries,
s3:PutBucketPolicy,
s3:GetBucketPolicy,
logs:PutResourcePolicy,
logs:DescribeResourcePolicies,
logs:DescribeLogGroups,
iam:CreateServiceLinkedRole,
firehose:TagDeliveryStream,
network-firewall:UpdateLoggingConfiguration,
network-firewall:DescribeLoggingConfiguration

Delete

logs:DeleteLogDelivery,
logs:ListLogDeliveries,
logs:GetLogDelivery,
network-firewall:UpdateLoggingConfiguration,
network-firewall:DescribeLoggingConfiguration

List

logs:GetLogDelivery,
logs:ListLogDeliveries,
network-firewall:DescribeLoggingConfiguration