Get Logging Configuration

wafv2_get_logging_configuration

R Documentation

Returns the LoggingConfiguration for the specified web ACL

Description

Returns the LoggingConfiguration for the specified web ACL.

Usage

wafv2_get_logging_configuration(ResourceArn, LogType, LogScope)

Arguments

ResourceArn

[required] The Amazon Resource Name (ARN) of the web ACL for which you want to get the LoggingConfiguration.

LogType

Used to distinguish between various logging options. Currently, there is one option.

Default: WAF_LOGS

LogScope

The owner of the logging configuration, which must be set to CUSTOMER for the configurations that you manage.

The log scope SECURITY_LAKE indicates a configuration that is managed through Amazon Security Lake. You can use Security Lake to collect log and event data from various sources for normalization, analysis, and management. For information, see Collecting data from Amazon Web Services services in the Amazon Security Lake user guide.

Default: CUSTOMER

Value

A list with the following syntax:

list(
  LoggingConfiguration = list(
    ResourceArn = "string",
    LogDestinationConfigs = list(
      "string"
    ),
    RedactedFields = list(
      list(
        SingleHeader = list(
          Name = "string"
        ),
        SingleQueryArgument = list(
          Name = "string"
        ),
        AllQueryArguments = list(),
        UriPath = list(),
        QueryString = list(),
        Body = list(
          OversizeHandling = "CONTINUE"|"MATCH"|"NO_MATCH"
        ),
        Method = list(),
        JsonBody = list(
          MatchPattern = list(
            All = list(),
            IncludedPaths = list(
              "string"
            )
          ),
          MatchScope = "ALL"|"KEY"|"VALUE",
          InvalidFallbackBehavior = "MATCH"|"NO_MATCH"|"EVALUATE_AS_STRING",
          OversizeHandling = "CONTINUE"|"MATCH"|"NO_MATCH"
        ),
        Headers = list(
          MatchPattern = list(
            All = list(),
            IncludedHeaders = list(
              "string"
            ),
            ExcludedHeaders = list(
              "string"
            )
          ),
          MatchScope = "ALL"|"KEY"|"VALUE",
          OversizeHandling = "CONTINUE"|"MATCH"|"NO_MATCH"
        ),
        Cookies = list(
          MatchPattern = list(
            All = list(),
            IncludedCookies = list(
              "string"
            ),
            ExcludedCookies = list(
              "string"
            )
          ),
          MatchScope = "ALL"|"KEY"|"VALUE",
          OversizeHandling = "CONTINUE"|"MATCH"|"NO_MATCH"
        ),
        HeaderOrder = list(
          OversizeHandling = "CONTINUE"|"MATCH"|"NO_MATCH"
        ),
        JA3Fingerprint = list(
          FallbackBehavior = "MATCH"|"NO_MATCH"
        )
      )
    ),
    ManagedByFirewallManager = TRUE|FALSE,
    LoggingFilter = list(
      Filters = list(
        list(
          Behavior = "KEEP"|"DROP",
          Requirement = "MEETS_ALL"|"MEETS_ANY",
          Conditions = list(
            list(
              ActionCondition = list(
                Action = "ALLOW"|"BLOCK"|"COUNT"|"CAPTCHA"|"CHALLENGE"|"EXCLUDED_AS_COUNT"
              ),
              LabelNameCondition = list(
                LabelName = "string"
              )
            )
          )
        )
      ),
      DefaultBehavior = "KEEP"|"DROP"
    ),
    LogType = "WAF_LOGS",
    LogScope = "CUSTOMER"|"SECURITY_LAKE"
  )
)

Request syntax

svc$get_logging_configuration(
  ResourceArn = "string",
  LogType = "WAF_LOGS",
  LogScope = "CUSTOMER"|"SECURITY_LAKE"
)