Skip to content
v2.278.0

WAFLoggingParametersProperty Struct ​

Configuration parameters for WAF logging, including redacted fields and logging filters.

Example ​

ts
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_observabilityadmin as observabilityadmin } from 'aws-cdk-lib';
const wAFLoggingParametersProperty: observabilityadmin.CfnOrganizationTelemetryRule.WAFLoggingParametersProperty = {
  loggingFilter: {
    defaultBehavior: 'defaultBehavior',
    filters: [{
      behavior: 'behavior',
      conditions: [{
        actionCondition: {
          action: 'action',
        },
        labelNameCondition: {
          labelName: 'labelName',
        },
      }],
      requirement: 'requirement',
    }],
  },
  logType: 'logType',
  redactedFields: [{
    method: 'method',
    queryString: 'queryString',
    singleHeader: {
      name: 'name',
    },
    uriPath: 'uriPath',
  }],
};
python
# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_observabilityadmin as observabilityadmin

w_af_logging_parameters_property = observabilityadmin.CfnOrganizationTelemetryRule.WAFLoggingParametersProperty(
    logging_filter=observabilityadmin.CfnOrganizationTelemetryRule.LoggingFilterProperty(
        default_behavior="defaultBehavior",
        filters=[observabilityadmin.CfnOrganizationTelemetryRule.FilterProperty(
            behavior="behavior",
            conditions=[observabilityadmin.CfnOrganizationTelemetryRule.ConditionProperty(
                action_condition=observabilityadmin.CfnOrganizationTelemetryRule.ActionConditionProperty(
                    action="action"
                ),
                label_name_condition=observabilityadmin.CfnOrganizationTelemetryRule.LabelNameConditionProperty(
                    label_name="labelName"
                )
            )],
            requirement="requirement"
        )]
    ),
    log_type="logType",
    redacted_fields=[observabilityadmin.CfnOrganizationTelemetryRule.FieldToMatchProperty(
        method="method",
        query_string="queryString",
        single_header=observabilityadmin.CfnOrganizationTelemetryRule.SingleHeaderProperty(
            name="name"
        ),
        uri_path="uriPath"
    )]
)
java
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import software.amazon.awscdk.services.observabilityadmin.*;

WAFLoggingParametersProperty wAFLoggingParametersProperty = WAFLoggingParametersProperty.builder()
        .loggingFilter(LoggingFilterProperty.builder()
                .defaultBehavior("defaultBehavior")
                .filters(List.of(FilterProperty.builder()
                        .behavior("behavior")
                        .conditions(List.of(ConditionProperty.builder()
                                .actionCondition(ActionConditionProperty.builder()
                                        .action("action")
                                        .build())
                                .labelNameCondition(LabelNameConditionProperty.builder()
                                        .labelName("labelName")
                                        .build())
                                .build()))
                        .requirement("requirement")
                        .build()))
                .build())
        .logType("logType")
        .redactedFields(List.of(FieldToMatchProperty.builder()
                .method("method")
                .queryString("queryString")
                .singleHeader(SingleHeaderProperty.builder()
                        .name("name")
                        .build())
                .uriPath("uriPath")
                .build()))
        .build();
csharp
// Install: dotnet add package Amazon.CDK.Lib
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.ObservabilityAdmin;

var wAFLoggingParametersProperty = new WAFLoggingParametersProperty {
    LoggingFilter = new LoggingFilterProperty {
        DefaultBehavior = "defaultBehavior",
        Filters = new [] { new FilterProperty {
            Behavior = "behavior",
            Conditions = new [] { new ConditionProperty {
                ActionCondition = new ActionConditionProperty {
                    Action = "action"
                },
                LabelNameCondition = new LabelNameConditionProperty {
                    LabelName = "labelName"
                }
            } },
            Requirement = "requirement"
        } }
    },
    LogType = "logType",
    RedactedFields = new [] { new FieldToMatchProperty {
        Method = "method",
        QueryString = "queryString",
        SingleHeader = new SingleHeaderProperty {
            Name = "name"
        },
        UriPath = "uriPath"
    } }
};
go
// Install: go get github.com/aws/aws-cdk-go/awscdk/v2
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"

wAFLoggingParametersProperty := &WAFLoggingParametersProperty{
	LoggingFilter: &LoggingFilterProperty{
		DefaultBehavior: jsii.String("defaultBehavior"),
		Filters: []interface{}{
			&FilterProperty{
				Behavior: jsii.String("behavior"),
				Conditions: []interface{}{
					&ConditionProperty{
						ActionCondition: &ActionConditionProperty{
							Action: jsii.String("action"),
						},
						LabelNameCondition: &LabelNameConditionProperty{
							LabelName: jsii.String("labelName"),
						},
					},
				},
				Requirement: jsii.String("requirement"),
			},
		},
	},
	LogType: jsii.String("logType"),
	RedactedFields: []interface{}{
		&FieldToMatchProperty{
			Method: jsii.String("method"),
			QueryString: jsii.String("queryString"),
			SingleHeader: &SingleHeaderProperty{
				Name: jsii.String("name"),
			},
			UriPath: jsii.String("uriPath"),
		},
	},
}

Properties ​

loggingFilteroptionalIResolvable | CfnOrganizationTelemetryRule.LoggingFilterPropertylogging_filteroptionaltyping.Union[IResolvable, LoggingFilterProperty]loggingFilteroptionalIResolvableLoggingFilteroptionalIResolvableLoggingFilteroptionalinterface{} #
A filter configuration that determines which WAF log records to include or exclude.
logTypeoptionalstringlog_typeoptionalstrlogTypeoptionalStringLogTypeoptionalstringLogTypeoptional*string #
The type of WAF logs to collect (currently supports WAF_LOGS).
redactedFieldsoptionalIResolvable | IResolvable | CfnOrganizationTelemetryRule.FieldToMatchProperty[]redacted_fieldsoptionaltyping.Union[IResolvable, typing.List[typing.Union[IResolvable, FieldToMatchProperty]]]redactedFieldsoptionalIResolvableRedactedFieldsoptionalIResolvableRedactedFieldsoptionalinterface{} #
The fields to redact from WAF logs to protect sensitive information.