Class CfnLoggingConfigurationProps

Properties for defining a CfnLoggingConfiguration.

Inheritance

object

CfnLoggingConfigurationProps

Implements

ICfnLoggingConfigurationProps

Inherited Members

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Namespace: Amazon.CDK.AWS.WAFv2

Assembly: Amazon.CDK.Lib.dll

Syntax (csharp)

public class CfnLoggingConfigurationProps : ICfnLoggingConfigurationProps

Syntax (vb)

Public Class CfnLoggingConfigurationProps Implements ICfnLoggingConfigurationProps

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-wafv2-loggingconfiguration.html

ExampleMetadata: fixture=_generated

Examples

// The code below shows an example of how to instantiate this type.
             // The values are placeholders you should change.
             using Amazon.CDK.AWS.WAFv2;

             var jsonBody;
             var loggingFilter;
             var method;
             var queryString;
             var singleHeader;
             var uriPath;

             var cfnLoggingConfigurationProps = new CfnLoggingConfigurationProps {
                 LogDestinationConfigs = new [] { "logDestinationConfigs" },
                 ResourceArn = "resourceArn",

                 // the properties below are optional
                 LoggingFilter = loggingFilter,
                 RedactedFields = new [] { new FieldToMatchProperty {
                     JsonBody = jsonBody,
                     Method = method,
                     QueryString = queryString,
                     SingleHeader = singleHeader,
                     UriPath = uriPath
                 } }
             };

Synopsis

Constructors

CfnLoggingConfigurationProps()

Properties for defining a CfnLoggingConfiguration.

Properties

LogDestinationConfigs	The logging destination configuration that you want to associate with the web ACL.
LoggingFilter	Filtering that specifies which web requests are kept in the logs and which are dropped.
RedactedFields	The parts of the request that you want to keep out of the logs.
ResourceArn	The Amazon Resource Name (ARN) of the web ACL that you want to associate with LogDestinationConfigs .

Constructors

CfnLoggingConfigurationProps()

Properties for defining a CfnLoggingConfiguration.

public CfnLoggingConfigurationProps()

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-wafv2-loggingconfiguration.html

ExampleMetadata: fixture=_generated

Examples

// The code below shows an example of how to instantiate this type.
             // The values are placeholders you should change.
             using Amazon.CDK.AWS.WAFv2;

             var jsonBody;
             var loggingFilter;
             var method;
             var queryString;
             var singleHeader;
             var uriPath;

             var cfnLoggingConfigurationProps = new CfnLoggingConfigurationProps {
                 LogDestinationConfigs = new [] { "logDestinationConfigs" },
                 ResourceArn = "resourceArn",

                 // the properties below are optional
                 LoggingFilter = loggingFilter,
                 RedactedFields = new [] { new FieldToMatchProperty {
                     JsonBody = jsonBody,
                     Method = method,
                     QueryString = queryString,
                     SingleHeader = singleHeader,
                     UriPath = uriPath
                 } }
             };

Properties

LogDestinationConfigs

The logging destination configuration that you want to associate with the web ACL.

public object[] LogDestinationConfigs { get; set; }

Property Value

object[]

Remarks

You can associate one logging destination to a web ACL.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-wafv2-loggingconfiguration.html#cfn-wafv2-loggingconfiguration-logdestinationconfigs

Type union: (either string or IDeliveryStreamRef or ILogGroupRef or IBucketRef)[]

LoggingFilter

Filtering that specifies which web requests are kept in the logs and which are dropped.

public object? LoggingFilter { get; set; }

Property Value

object

Remarks

You can filter on the rule action and on the web request labels that were applied by matching rules during web ACL evaluation.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-wafv2-loggingconfiguration.html#cfn-wafv2-loggingconfiguration-loggingfilter

RedactedFields

The parts of the request that you want to keep out of the logs.

public object? RedactedFields { get; set; }

Property Value

object

Remarks

For example, if you redact the SingleHeader field, the HEADER field in the logs will be REDACTED for all rules that use the SingleHeader FieldToMatch setting.

If you configure data protection for the web ACL, the protection applies to the data that AWS WAF sends to the logs.

Redaction applies only to the component that's specified in the rule's FieldToMatch setting, so the SingleHeader redaction doesn't apply to rules that use the Headers FieldToMatch .

You can specify only the following fields for redaction: <code>UriPath</code> , <code>QueryString</code> , <code>SingleHeader</code> , and <code>Method</code> . > This setting has no impact on request sampling. You can only exclude fields from request sampling by disabling sampling in the web ACL visibility configuration or by configuring data protection for the web ACL.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-wafv2-loggingconfiguration.html#cfn-wafv2-loggingconfiguration-redactedfields

Type union: either IResolvable or (either IResolvable or CfnLoggingConfiguration.IFieldToMatchProperty)[]

ResourceArn

The Amazon Resource Name (ARN) of the web ACL that you want to associate with LogDestinationConfigs .

public object ResourceArn { get; set; }

Property Value

object

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-wafv2-loggingconfiguration.html#cfn-wafv2-loggingconfiguration-resourcearn

Type union: either string or IWebACLRef

Implements

ICfnLoggingConfigurationProps