LoggingConfiguration

Provides an AWS Network Firewall Logging Configuration Resource

Example Usage

Logging to S3

using Pulumi;
using Aws = Pulumi.Aws;

class MyStack : Stack
{
    public MyStack()
    {
        var example = new Aws.NetworkFirewall.LoggingConfiguration("example", new Aws.NetworkFirewall.LoggingConfigurationArgs
        {
            FirewallArn = aws_networkfirewall_firewall.Example.Arn,
            LoggingConfiguration = new Aws.NetworkFirewall.Inputs.LoggingConfigurationLoggingConfigurationArgs
            {
                LogDestinationConfigs = 
                {
                    new Aws.NetworkFirewall.Inputs.LoggingConfigurationLoggingConfigurationLogDestinationConfigArgs
                    {
                        LogDestination = 
                        {
                            { "bucketName", aws_s3_bucket.Example.Bucket },
                            { "prefix", "/example" },
                        },
                        LogDestinationType = "S3",
                        LogType = "FLOW",
                    },
                },
            },
        });
    }

}
package main

import (
	"github.com/pulumi/pulumi-aws/sdk/v4/go/aws/networkfirewall"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := networkfirewall.NewLoggingConfiguration(ctx, "example", &networkfirewall.LoggingConfigurationArgs{
			FirewallArn: pulumi.Any(aws_networkfirewall_firewall.Example.Arn),
			LoggingConfiguration: &networkfirewall.LoggingConfigurationLoggingConfigurationArgs{
				LogDestinationConfigs: networkfirewall.LoggingConfigurationLoggingConfigurationLogDestinationConfigArray{
					&networkfirewall.LoggingConfigurationLoggingConfigurationLogDestinationConfigArgs{
						LogDestination: pulumi.StringMap{
							"bucketName": pulumi.Any(aws_s3_bucket.Example.Bucket),
							"prefix":     pulumi.String("/example"),
						},
						LogDestinationType: pulumi.String("S3"),
						LogType:            pulumi.String("FLOW"),
					},
				},
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}
import pulumi
import pulumi_aws as aws

example = aws.networkfirewall.LoggingConfiguration("example",
    firewall_arn=aws_networkfirewall_firewall["example"]["arn"],
    logging_configuration=aws.networkfirewall.LoggingConfigurationLoggingConfigurationArgs(
        log_destination_configs=[aws.networkfirewall.LoggingConfigurationLoggingConfigurationLogDestinationConfigArgs(
            log_destination={
                "bucketName": aws_s3_bucket["example"]["bucket"],
                "prefix": "/example",
            },
            log_destination_type="S3",
            log_type="FLOW",
        )],
    ))
import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";

const example = new aws.networkfirewall.LoggingConfiguration("example", {
    firewallArn: aws_networkfirewall_firewall.example.arn,
    loggingConfiguration: {
        logDestinationConfigs: [{
            logDestination: {
                bucketName: aws_s3_bucket.example.bucket,
                prefix: "/example",
            },
            logDestinationType: "S3",
            logType: "FLOW",
        }],
    },
});

Logging to CloudWatch

using Pulumi;
using Aws = Pulumi.Aws;

class MyStack : Stack
{
    public MyStack()
    {
        var example = new Aws.NetworkFirewall.LoggingConfiguration("example", new Aws.NetworkFirewall.LoggingConfigurationArgs
        {
            FirewallArn = aws_networkfirewall_firewall.Example.Arn,
            LoggingConfiguration = new Aws.NetworkFirewall.Inputs.LoggingConfigurationLoggingConfigurationArgs
            {
                LogDestinationConfigs = 
                {
                    new Aws.NetworkFirewall.Inputs.LoggingConfigurationLoggingConfigurationLogDestinationConfigArgs
                    {
                        LogDestination = 
                        {
                            { "logGroup", aws_cloudwatch_log_group.Example.Name },
                        },
                        LogDestinationType = "CloudWatchLogs",
                        LogType = "ALERT",
                    },
                },
            },
        });
    }

}
package main

import (
	"github.com/pulumi/pulumi-aws/sdk/v4/go/aws/networkfirewall"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := networkfirewall.NewLoggingConfiguration(ctx, "example", &networkfirewall.LoggingConfigurationArgs{
			FirewallArn: pulumi.Any(aws_networkfirewall_firewall.Example.Arn),
			LoggingConfiguration: &networkfirewall.LoggingConfigurationLoggingConfigurationArgs{
				LogDestinationConfigs: networkfirewall.LoggingConfigurationLoggingConfigurationLogDestinationConfigArray{
					&networkfirewall.LoggingConfigurationLoggingConfigurationLogDestinationConfigArgs{
						LogDestination: pulumi.StringMap{
							"logGroup": pulumi.Any(aws_cloudwatch_log_group.Example.Name),
						},
						LogDestinationType: pulumi.String("CloudWatchLogs"),
						LogType:            pulumi.String("ALERT"),
					},
				},
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}
import pulumi
import pulumi_aws as aws

example = aws.networkfirewall.LoggingConfiguration("example",
    firewall_arn=aws_networkfirewall_firewall["example"]["arn"],
    logging_configuration=aws.networkfirewall.LoggingConfigurationLoggingConfigurationArgs(
        log_destination_configs=[aws.networkfirewall.LoggingConfigurationLoggingConfigurationLogDestinationConfigArgs(
            log_destination={
                "logGroup": aws_cloudwatch_log_group["example"]["name"],
            },
            log_destination_type="CloudWatchLogs",
            log_type="ALERT",
        )],
    ))
import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";

const example = new aws.networkfirewall.LoggingConfiguration("example", {
    firewallArn: aws_networkfirewall_firewall.example.arn,
    loggingConfiguration: {
        logDestinationConfigs: [{
            logDestination: {
                logGroup: aws_cloudwatch_log_group.example.name,
            },
            logDestinationType: "CloudWatchLogs",
            logType: "ALERT",
        }],
    },
});

Logging to Kinesis Data Firehose

using Pulumi;
using Aws = Pulumi.Aws;

class MyStack : Stack
{
    public MyStack()
    {
        var example = new Aws.NetworkFirewall.LoggingConfiguration("example", new Aws.NetworkFirewall.LoggingConfigurationArgs
        {
            FirewallArn = aws_networkfirewall_firewall.Example.Arn,
            LoggingConfiguration = new Aws.NetworkFirewall.Inputs.LoggingConfigurationLoggingConfigurationArgs
            {
                LogDestinationConfigs = 
                {
                    new Aws.NetworkFirewall.Inputs.LoggingConfigurationLoggingConfigurationLogDestinationConfigArgs
                    {
                        LogDestination = 
                        {
                            { "deliveryStream", aws_kinesis_firehose_delivery_stream.Example.Name },
                        },
                        LogDestinationType = "KinesisDataFirehose",
                        LogType = "ALERT",
                    },
                },
            },
        });
    }

}
package main

import (
	"github.com/pulumi/pulumi-aws/sdk/v4/go/aws/networkfirewall"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := networkfirewall.NewLoggingConfiguration(ctx, "example", &networkfirewall.LoggingConfigurationArgs{
			FirewallArn: pulumi.Any(aws_networkfirewall_firewall.Example.Arn),
			LoggingConfiguration: &networkfirewall.LoggingConfigurationLoggingConfigurationArgs{
				LogDestinationConfigs: networkfirewall.LoggingConfigurationLoggingConfigurationLogDestinationConfigArray{
					&networkfirewall.LoggingConfigurationLoggingConfigurationLogDestinationConfigArgs{
						LogDestination: pulumi.StringMap{
							"deliveryStream": pulumi.Any(aws_kinesis_firehose_delivery_stream.Example.Name),
						},
						LogDestinationType: pulumi.String("KinesisDataFirehose"),
						LogType:            pulumi.String("ALERT"),
					},
				},
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}
import pulumi
import pulumi_aws as aws

example = aws.networkfirewall.LoggingConfiguration("example",
    firewall_arn=aws_networkfirewall_firewall["example"]["arn"],
    logging_configuration=aws.networkfirewall.LoggingConfigurationLoggingConfigurationArgs(
        log_destination_configs=[aws.networkfirewall.LoggingConfigurationLoggingConfigurationLogDestinationConfigArgs(
            log_destination={
                "deliveryStream": aws_kinesis_firehose_delivery_stream["example"]["name"],
            },
            log_destination_type="KinesisDataFirehose",
            log_type="ALERT",
        )],
    ))
import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";

const example = new aws.networkfirewall.LoggingConfiguration("example", {
    firewallArn: aws_networkfirewall_firewall.example.arn,
    loggingConfiguration: {
        logDestinationConfigs: [{
            logDestination: {
                deliveryStream: aws_kinesis_firehose_delivery_stream.example.name,
            },
            logDestinationType: "KinesisDataFirehose",
            logType: "ALERT",
        }],
    },
});

Create a LoggingConfiguration Resource

new LoggingConfiguration(name: string, args: LoggingConfigurationArgs, opts?: CustomResourceOptions);
@overload
def LoggingConfiguration(resource_name: str,
                         opts: Optional[ResourceOptions] = None,
                         firewall_arn: Optional[str] = None,
                         logging_configuration: Optional[LoggingConfigurationLoggingConfigurationArgs] = None)
@overload
def LoggingConfiguration(resource_name: str,
                         args: LoggingConfigurationArgs,
                         opts: Optional[ResourceOptions] = None)
func NewLoggingConfiguration(ctx *Context, name string, args LoggingConfigurationArgs, opts ...ResourceOption) (*LoggingConfiguration, error)
public LoggingConfiguration(string name, LoggingConfigurationArgs args, CustomResourceOptions? opts = null)
name string
The unique name of the resource.
args LoggingConfigurationArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name str
The unique name of the resource.
args LoggingConfigurationArgs
The arguments to resource properties.
opts ResourceOptions
Bag of options to control resource's behavior.
ctx Context
Context object for the current deployment.
name string
The unique name of the resource.
args LoggingConfigurationArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name string
The unique name of the resource.
args LoggingConfigurationArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.

LoggingConfiguration Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

Inputs

The LoggingConfiguration resource accepts the following input properties:

FirewallArn string
The Amazon Resource Name (ARN) of the Network Firewall firewall.
LoggingConfig LoggingConfigurationLoggingConfigurationArgs
A configuration block describing how AWS Network Firewall performs logging for a firewall. See Logging Configuration below for details.
FirewallArn string
The Amazon Resource Name (ARN) of the Network Firewall firewall.
LoggingConfiguration LoggingConfigurationLoggingConfigurationArgs
A configuration block describing how AWS Network Firewall performs logging for a firewall. See Logging Configuration below for details.
firewallArn string
The Amazon Resource Name (ARN) of the Network Firewall firewall.
loggingConfiguration LoggingConfigurationLoggingConfigurationArgs
A configuration block describing how AWS Network Firewall performs logging for a firewall. See Logging Configuration below for details.
firewall_arn str
The Amazon Resource Name (ARN) of the Network Firewall firewall.
logging_configuration LoggingConfigurationLoggingConfigurationArgs
A configuration block describing how AWS Network Firewall performs logging for a firewall. See Logging Configuration below for details.

Outputs

All input properties are implicitly available as output properties. Additionally, the LoggingConfiguration resource produces the following output properties:

Id string
The provider-assigned unique ID for this managed resource.
Id string
The provider-assigned unique ID for this managed resource.
id string
The provider-assigned unique ID for this managed resource.
id str
The provider-assigned unique ID for this managed resource.

Look up an Existing LoggingConfiguration Resource

Get an existing LoggingConfiguration resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

public static get(name: string, id: Input<ID>, state?: LoggingConfigurationState, opts?: CustomResourceOptions): LoggingConfiguration
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        firewall_arn: Optional[str] = None,
        logging_configuration: Optional[LoggingConfigurationLoggingConfigurationArgs] = None) -> LoggingConfiguration
func GetLoggingConfiguration(ctx *Context, name string, id IDInput, state *LoggingConfigurationState, opts ...ResourceOption) (*LoggingConfiguration, error)
public static LoggingConfiguration Get(string name, Input<string> id, LoggingConfigurationState? state, CustomResourceOptions? opts = null)
name
The unique name of the resulting resource.
id
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
resource_name
The unique name of the resulting resource.
id
The unique provider ID of the resource to lookup.
name
The unique name of the resulting resource.
id
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
name
The unique name of the resulting resource.
id
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.

The following state arguments are supported:

FirewallArn string
The Amazon Resource Name (ARN) of the Network Firewall firewall.
LoggingConfig LoggingConfigurationLoggingConfigurationArgs
A configuration block describing how AWS Network Firewall performs logging for a firewall. See Logging Configuration below for details.
FirewallArn string
The Amazon Resource Name (ARN) of the Network Firewall firewall.
LoggingConfiguration LoggingConfigurationLoggingConfigurationArgs
A configuration block describing how AWS Network Firewall performs logging for a firewall. See Logging Configuration below for details.
firewallArn string
The Amazon Resource Name (ARN) of the Network Firewall firewall.
loggingConfiguration LoggingConfigurationLoggingConfigurationArgs
A configuration block describing how AWS Network Firewall performs logging for a firewall. See Logging Configuration below for details.
firewall_arn str
The Amazon Resource Name (ARN) of the Network Firewall firewall.
logging_configuration LoggingConfigurationLoggingConfigurationArgs
A configuration block describing how AWS Network Firewall performs logging for a firewall. See Logging Configuration below for details.

Supporting Types

LoggingConfigurationLoggingConfiguration

LogDestinationConfigs List<LoggingConfigurationLoggingConfigurationLogDestinationConfig>
Set of configuration blocks describing the logging details for a firewall. See Log Destination Config below for details. At most, only two blocks can be specified; one for FLOW logs and one for ALERT logs.
LogDestinationConfigs []LoggingConfigurationLoggingConfigurationLogDestinationConfig
Set of configuration blocks describing the logging details for a firewall. See Log Destination Config below for details. At most, only two blocks can be specified; one for FLOW logs and one for ALERT logs.
logDestinationConfigs LoggingConfigurationLoggingConfigurationLogDestinationConfig[]
Set of configuration blocks describing the logging details for a firewall. See Log Destination Config below for details. At most, only two blocks can be specified; one for FLOW logs and one for ALERT logs.
log_destination_configs Sequence[LoggingConfigurationLoggingConfigurationLogDestinationConfig]
Set of configuration blocks describing the logging details for a firewall. See Log Destination Config below for details. At most, only two blocks can be specified; one for FLOW logs and one for ALERT logs.

LoggingConfigurationLoggingConfigurationLogDestinationConfig

LogDestination Dictionary<string, string>

A map describing the logging destination for the chosen log_destination_type.

  • For an Amazon S3 bucket, specify the key bucketName with the name of the bucket and optionally specify the key prefix with a path.
  • For a CloudWatch log group, specify the key logGroup with the name of the CloudWatch log group.
  • For a Kinesis Data Firehose delivery stream, specify the key deliveryStream with the name of the delivery stream.
LogDestinationType string
The location to send logs to. Valid values: S3, CloudWatchLogs, KinesisDataFirehose.
LogType string
The type of log to send. Valid values: ALERT or FLOW. Alert logs report traffic that matches a StatefulRule with an action setting that sends a log message. Flow logs are standard network traffic flow logs.
LogDestination map[string]string

A map describing the logging destination for the chosen log_destination_type.

  • For an Amazon S3 bucket, specify the key bucketName with the name of the bucket and optionally specify the key prefix with a path.
  • For a CloudWatch log group, specify the key logGroup with the name of the CloudWatch log group.
  • For a Kinesis Data Firehose delivery stream, specify the key deliveryStream with the name of the delivery stream.
LogDestinationType string
The location to send logs to. Valid values: S3, CloudWatchLogs, KinesisDataFirehose.
LogType string
The type of log to send. Valid values: ALERT or FLOW. Alert logs report traffic that matches a StatefulRule with an action setting that sends a log message. Flow logs are standard network traffic flow logs.
logDestination {[key: string]: string}

A map describing the logging destination for the chosen log_destination_type.

  • For an Amazon S3 bucket, specify the key bucketName with the name of the bucket and optionally specify the key prefix with a path.
  • For a CloudWatch log group, specify the key logGroup with the name of the CloudWatch log group.
  • For a Kinesis Data Firehose delivery stream, specify the key deliveryStream with the name of the delivery stream.
logDestinationType string
The location to send logs to. Valid values: S3, CloudWatchLogs, KinesisDataFirehose.
logType string
The type of log to send. Valid values: ALERT or FLOW. Alert logs report traffic that matches a StatefulRule with an action setting that sends a log message. Flow logs are standard network traffic flow logs.
log_destination Mapping[str, str]

A map describing the logging destination for the chosen log_destination_type.

  • For an Amazon S3 bucket, specify the key bucketName with the name of the bucket and optionally specify the key prefix with a path.
  • For a CloudWatch log group, specify the key logGroup with the name of the CloudWatch log group.
  • For a Kinesis Data Firehose delivery stream, specify the key deliveryStream with the name of the delivery stream.
log_destination_type str
The location to send logs to. Valid values: S3, CloudWatchLogs, KinesisDataFirehose.
log_type str
The type of log to send. Valid values: ALERT or FLOW. Alert logs report traffic that matches a StatefulRule with an action setting that sends a log message. Flow logs are standard network traffic flow logs.

Import

Network Firewall Logging Configurations can be imported using the firewall_arn e.g

 $ pulumi import aws:networkfirewall/loggingConfiguration:LoggingConfiguration example arn:aws:network-firewall:us-west-1:123456789012:firewall/example

Package Details

Repository
https://github.com/pulumi/pulumi-aws
License
Apache-2.0
Notes
This Pulumi package is based on the aws Terraform Provider.