getLoggingConfiguration

A WAFv2 Logging Configuration Resource Provider

Using getLoggingConfiguration

Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

function getLoggingConfiguration(args: GetLoggingConfigurationArgs, opts?: InvokeOptions): Promise<GetLoggingConfigurationResult>
function getLoggingConfigurationOutput(args: GetLoggingConfigurationOutputArgs, opts?: InvokeOptions): Output<GetLoggingConfigurationResult>
def get_logging_configuration(resource_arn: Optional[str] = None,
                              opts: Optional[InvokeOptions] = None) -> GetLoggingConfigurationResult
def get_logging_configuration_output(resource_arn: Optional[pulumi.Input[str]] = None,
                              opts: Optional[InvokeOptions] = None) -> Output[GetLoggingConfigurationResult]
func LookupLoggingConfiguration(ctx *Context, args *LookupLoggingConfigurationArgs, opts ...InvokeOption) (*LookupLoggingConfigurationResult, error)
func LookupLoggingConfigurationOutput(ctx *Context, args *LookupLoggingConfigurationOutputArgs, opts ...InvokeOption) LookupLoggingConfigurationResultOutput

> Note: This function is named LookupLoggingConfiguration in the Go SDK.

public static class GetLoggingConfiguration 
{
    public static Task<GetLoggingConfigurationResult> InvokeAsync(GetLoggingConfigurationArgs args, InvokeOptions? opts = null)
    public static Output<GetLoggingConfigurationResult> Invoke(GetLoggingConfigurationInvokeArgs args, InvokeOptions? opts = null)
}
public static CompletableFuture<GetLoggingConfigurationResult> getLoggingConfiguration(GetLoggingConfigurationArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet
fn::invoke:
  function: aws-native:wafv2:getLoggingConfiguration
  arguments:
    # arguments dictionary

The following arguments are supported:

ResourceArn string

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

ResourceArn string

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

resourceArn String

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

resourceArn string

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

resource_arn str

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

resourceArn String

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

getLoggingConfiguration Result

The following output properties are available:

LogDestinationConfigs List<string>

The Amazon Resource Names (ARNs) of the logging destinations that you want to associate with the web ACL.

LoggingFilter Pulumi.AwsNative.WAFv2.Outputs.LoggingFilterProperties

Filtering that specifies which web requests are kept in the logs and which are dropped. You can filter on the rule action and on the web request labels that were applied by matching rules during web ACL evaluation.

ManagedByFirewallManager bool

Indicates whether the logging configuration was created by AWS Firewall Manager, as part of an AWS WAF policy configuration. If true, only Firewall Manager can modify or delete the configuration.

RedactedFields List<Pulumi.AwsNative.WAFv2.Outputs.LoggingConfigurationFieldToMatch>

The parts of the request that you want to keep out of the logs. For example, if you redact the HEADER field, the HEADER field in the firehose will be xxx.

LogDestinationConfigs []string

The Amazon Resource Names (ARNs) of the logging destinations that you want to associate with the web ACL.

LoggingFilter LoggingFilterProperties

Filtering that specifies which web requests are kept in the logs and which are dropped. You can filter on the rule action and on the web request labels that were applied by matching rules during web ACL evaluation.

ManagedByFirewallManager bool

Indicates whether the logging configuration was created by AWS Firewall Manager, as part of an AWS WAF policy configuration. If true, only Firewall Manager can modify or delete the configuration.

RedactedFields []LoggingConfigurationFieldToMatch

The parts of the request that you want to keep out of the logs. For example, if you redact the HEADER field, the HEADER field in the firehose will be xxx.

logDestinationConfigs List<String>

The Amazon Resource Names (ARNs) of the logging destinations that you want to associate with the web ACL.

loggingFilter LoggingFilterProperties

Filtering that specifies which web requests are kept in the logs and which are dropped. You can filter on the rule action and on the web request labels that were applied by matching rules during web ACL evaluation.

managedByFirewallManager Boolean

Indicates whether the logging configuration was created by AWS Firewall Manager, as part of an AWS WAF policy configuration. If true, only Firewall Manager can modify or delete the configuration.

redactedFields List<LoggingConfigurationFieldToMatch>

The parts of the request that you want to keep out of the logs. For example, if you redact the HEADER field, the HEADER field in the firehose will be xxx.

logDestinationConfigs string[]

The Amazon Resource Names (ARNs) of the logging destinations that you want to associate with the web ACL.

loggingFilter LoggingFilterProperties

Filtering that specifies which web requests are kept in the logs and which are dropped. You can filter on the rule action and on the web request labels that were applied by matching rules during web ACL evaluation.

managedByFirewallManager boolean

Indicates whether the logging configuration was created by AWS Firewall Manager, as part of an AWS WAF policy configuration. If true, only Firewall Manager can modify or delete the configuration.

redactedFields LoggingConfigurationFieldToMatch[]

The parts of the request that you want to keep out of the logs. For example, if you redact the HEADER field, the HEADER field in the firehose will be xxx.

log_destination_configs Sequence[str]

The Amazon Resource Names (ARNs) of the logging destinations that you want to associate with the web ACL.

logging_filter LoggingFilterProperties

Filtering that specifies which web requests are kept in the logs and which are dropped. You can filter on the rule action and on the web request labels that were applied by matching rules during web ACL evaluation.

managed_by_firewall_manager bool

Indicates whether the logging configuration was created by AWS Firewall Manager, as part of an AWS WAF policy configuration. If true, only Firewall Manager can modify or delete the configuration.

redacted_fields Sequence[LoggingConfigurationFieldToMatch]

The parts of the request that you want to keep out of the logs. For example, if you redact the HEADER field, the HEADER field in the firehose will be xxx.

logDestinationConfigs List<String>

The Amazon Resource Names (ARNs) of the logging destinations that you want to associate with the web ACL.

loggingFilter Property Map

Filtering that specifies which web requests are kept in the logs and which are dropped. You can filter on the rule action and on the web request labels that were applied by matching rules during web ACL evaluation.

managedByFirewallManager Boolean

Indicates whether the logging configuration was created by AWS Firewall Manager, as part of an AWS WAF policy configuration. If true, only Firewall Manager can modify or delete the configuration.

redactedFields List<Property Map>

The parts of the request that you want to keep out of the logs. For example, if you redact the HEADER field, the HEADER field in the firehose will be xxx.

Supporting Types

LoggingConfigurationCondition

actionCondition Property Map

A single action condition.

labelNameCondition Property Map

A single label name condition.

LoggingConfigurationConditionActionConditionProperties

Action Pulumi.AwsNative.WAFv2.LoggingConfigurationConditionActionConditionPropertiesAction

Logic to apply to the filtering conditions. You can specify that, in order to satisfy the filter, a log must match all conditions or must match at least one condition.

Action LoggingConfigurationConditionActionConditionPropertiesAction

Logic to apply to the filtering conditions. You can specify that, in order to satisfy the filter, a log must match all conditions or must match at least one condition.

action LoggingConfigurationConditionActionConditionPropertiesAction

Logic to apply to the filtering conditions. You can specify that, in order to satisfy the filter, a log must match all conditions or must match at least one condition.

action LoggingConfigurationConditionActionConditionPropertiesAction

Logic to apply to the filtering conditions. You can specify that, in order to satisfy the filter, a log must match all conditions or must match at least one condition.

action LoggingConfigurationConditionActionConditionPropertiesAction

Logic to apply to the filtering conditions. You can specify that, in order to satisfy the filter, a log must match all conditions or must match at least one condition.

action "ALLOW" | "BLOCK" | "COUNT" | "CAPTCHA" | "EXCLUDED_AS_COUNT"

Logic to apply to the filtering conditions. You can specify that, in order to satisfy the filter, a log must match all conditions or must match at least one condition.

LoggingConfigurationConditionActionConditionPropertiesAction

LoggingConfigurationConditionLabelNameConditionProperties

LabelName string

The label name that a log record must contain in order to meet the condition. This must be a fully qualified label name. Fully qualified labels have a prefix, optional namespaces, and label name. The prefix identifies the rule group or web ACL context of the rule that added the label.

LabelName string

The label name that a log record must contain in order to meet the condition. This must be a fully qualified label name. Fully qualified labels have a prefix, optional namespaces, and label name. The prefix identifies the rule group or web ACL context of the rule that added the label.

labelName String

The label name that a log record must contain in order to meet the condition. This must be a fully qualified label name. Fully qualified labels have a prefix, optional namespaces, and label name. The prefix identifies the rule group or web ACL context of the rule that added the label.

labelName string

The label name that a log record must contain in order to meet the condition. This must be a fully qualified label name. Fully qualified labels have a prefix, optional namespaces, and label name. The prefix identifies the rule group or web ACL context of the rule that added the label.

label_name str

The label name that a log record must contain in order to meet the condition. This must be a fully qualified label name. Fully qualified labels have a prefix, optional namespaces, and label name. The prefix identifies the rule group or web ACL context of the rule that added the label.

labelName String

The label name that a log record must contain in order to meet the condition. This must be a fully qualified label name. Fully qualified labels have a prefix, optional namespaces, and label name. The prefix identifies the rule group or web ACL context of the rule that added the label.

LoggingConfigurationFieldToMatch

JsonBody Pulumi.AwsNative.WAFv2.Inputs.LoggingConfigurationFieldToMatchJsonBodyProperties

Inspect the request body as JSON. The request body immediately follows the request headers. This is the part of a request that contains any additional data that you want to send to your web server as the HTTP request body, such as data from a form.

Method object

Inspect the HTTP method. The method indicates the type of operation that the request is asking the origin to perform.

QueryString object

Inspect the query string. This is the part of a URL that appears after a ? character, if any.

SingleHeader Pulumi.AwsNative.WAFv2.Inputs.LoggingConfigurationFieldToMatchSingleHeaderProperties

Inspect a single header. Provide the name of the header to inspect, for example, User-Agent or Referer. This setting isn't case sensitive.

UriPath object

Inspect the request URI path. This is the part of a web request that identifies a resource, for example, /images/daily-ad.jpg.

JsonBody LoggingConfigurationFieldToMatchJsonBodyProperties

Inspect the request body as JSON. The request body immediately follows the request headers. This is the part of a request that contains any additional data that you want to send to your web server as the HTTP request body, such as data from a form.

Method interface{}

Inspect the HTTP method. The method indicates the type of operation that the request is asking the origin to perform.

QueryString interface{}

Inspect the query string. This is the part of a URL that appears after a ? character, if any.

SingleHeader LoggingConfigurationFieldToMatchSingleHeaderProperties

Inspect a single header. Provide the name of the header to inspect, for example, User-Agent or Referer. This setting isn't case sensitive.

UriPath interface{}

Inspect the request URI path. This is the part of a web request that identifies a resource, for example, /images/daily-ad.jpg.

jsonBody LoggingConfigurationFieldToMatchJsonBodyProperties

Inspect the request body as JSON. The request body immediately follows the request headers. This is the part of a request that contains any additional data that you want to send to your web server as the HTTP request body, such as data from a form.

method Object

Inspect the HTTP method. The method indicates the type of operation that the request is asking the origin to perform.

queryString Object

Inspect the query string. This is the part of a URL that appears after a ? character, if any.

singleHeader LoggingConfigurationFieldToMatchSingleHeaderProperties

Inspect a single header. Provide the name of the header to inspect, for example, User-Agent or Referer. This setting isn't case sensitive.

uriPath Object

Inspect the request URI path. This is the part of a web request that identifies a resource, for example, /images/daily-ad.jpg.

jsonBody LoggingConfigurationFieldToMatchJsonBodyProperties

Inspect the request body as JSON. The request body immediately follows the request headers. This is the part of a request that contains any additional data that you want to send to your web server as the HTTP request body, such as data from a form.

method any

Inspect the HTTP method. The method indicates the type of operation that the request is asking the origin to perform.

queryString any

Inspect the query string. This is the part of a URL that appears after a ? character, if any.

singleHeader LoggingConfigurationFieldToMatchSingleHeaderProperties

Inspect a single header. Provide the name of the header to inspect, for example, User-Agent or Referer. This setting isn't case sensitive.

uriPath any

Inspect the request URI path. This is the part of a web request that identifies a resource, for example, /images/daily-ad.jpg.

json_body LoggingConfigurationFieldToMatchJsonBodyProperties

Inspect the request body as JSON. The request body immediately follows the request headers. This is the part of a request that contains any additional data that you want to send to your web server as the HTTP request body, such as data from a form.

method Any

Inspect the HTTP method. The method indicates the type of operation that the request is asking the origin to perform.

query_string Any

Inspect the query string. This is the part of a URL that appears after a ? character, if any.

single_header LoggingConfigurationFieldToMatchSingleHeaderProperties

Inspect a single header. Provide the name of the header to inspect, for example, User-Agent or Referer. This setting isn't case sensitive.

uri_path Any

Inspect the request URI path. This is the part of a web request that identifies a resource, for example, /images/daily-ad.jpg.

jsonBody Property Map

Inspect the request body as JSON. The request body immediately follows the request headers. This is the part of a request that contains any additional data that you want to send to your web server as the HTTP request body, such as data from a form.

method Any

Inspect the HTTP method. The method indicates the type of operation that the request is asking the origin to perform.

queryString Any

Inspect the query string. This is the part of a URL that appears after a ? character, if any.

singleHeader Property Map

Inspect a single header. Provide the name of the header to inspect, for example, User-Agent or Referer. This setting isn't case sensitive.

uriPath Any

Inspect the request URI path. This is the part of a web request that identifies a resource, for example, /images/daily-ad.jpg.

LoggingConfigurationFieldToMatchJsonBodyProperties

MatchPattern Pulumi.AwsNative.WAFv2.Inputs.LoggingConfigurationFieldToMatchJsonBodyPropertiesMatchPatternProperties

The patterns to look for in the JSON body. AWS WAF inspects the results of these pattern matches against the rule inspection criteria.

MatchScope Pulumi.AwsNative.WAFv2.LoggingConfigurationFieldToMatchJsonBodyPropertiesMatchScope

The parts of the JSON to match against using the MatchPattern. If you specify All, AWS WAF matches against keys and values.

InvalidFallbackBehavior Pulumi.AwsNative.WAFv2.LoggingConfigurationFieldToMatchJsonBodyPropertiesInvalidFallbackBehavior

What AWS WAF should do if it fails to completely parse the JSON body.

MatchPattern LoggingConfigurationFieldToMatchJsonBodyPropertiesMatchPatternProperties

The patterns to look for in the JSON body. AWS WAF inspects the results of these pattern matches against the rule inspection criteria.

MatchScope LoggingConfigurationFieldToMatchJsonBodyPropertiesMatchScope

The parts of the JSON to match against using the MatchPattern. If you specify All, AWS WAF matches against keys and values.

InvalidFallbackBehavior LoggingConfigurationFieldToMatchJsonBodyPropertiesInvalidFallbackBehavior

What AWS WAF should do if it fails to completely parse the JSON body.

matchPattern LoggingConfigurationFieldToMatchJsonBodyPropertiesMatchPatternProperties

The patterns to look for in the JSON body. AWS WAF inspects the results of these pattern matches against the rule inspection criteria.

matchScope LoggingConfigurationFieldToMatchJsonBodyPropertiesMatchScope

The parts of the JSON to match against using the MatchPattern. If you specify All, AWS WAF matches against keys and values.

invalidFallbackBehavior LoggingConfigurationFieldToMatchJsonBodyPropertiesInvalidFallbackBehavior

What AWS WAF should do if it fails to completely parse the JSON body.

matchPattern LoggingConfigurationFieldToMatchJsonBodyPropertiesMatchPatternProperties

The patterns to look for in the JSON body. AWS WAF inspects the results of these pattern matches against the rule inspection criteria.

matchScope LoggingConfigurationFieldToMatchJsonBodyPropertiesMatchScope

The parts of the JSON to match against using the MatchPattern. If you specify All, AWS WAF matches against keys and values.

invalidFallbackBehavior LoggingConfigurationFieldToMatchJsonBodyPropertiesInvalidFallbackBehavior

What AWS WAF should do if it fails to completely parse the JSON body.

match_pattern LoggingConfigurationFieldToMatchJsonBodyPropertiesMatchPatternProperties

The patterns to look for in the JSON body. AWS WAF inspects the results of these pattern matches against the rule inspection criteria.

match_scope LoggingConfigurationFieldToMatchJsonBodyPropertiesMatchScope

The parts of the JSON to match against using the MatchPattern. If you specify All, AWS WAF matches against keys and values.

invalid_fallback_behavior LoggingConfigurationFieldToMatchJsonBodyPropertiesInvalidFallbackBehavior

What AWS WAF should do if it fails to completely parse the JSON body.

matchPattern Property Map

The patterns to look for in the JSON body. AWS WAF inspects the results of these pattern matches against the rule inspection criteria.

matchScope "ALL" | "KEY" | "VALUE"

The parts of the JSON to match against using the MatchPattern. If you specify All, AWS WAF matches against keys and values.

invalidFallbackBehavior "MATCH" | "NO_MATCH" | "EVALUATE_AS_STRING"

What AWS WAF should do if it fails to completely parse the JSON body.

LoggingConfigurationFieldToMatchJsonBodyPropertiesInvalidFallbackBehavior

LoggingConfigurationFieldToMatchJsonBodyPropertiesMatchPatternProperties

All object

Match all of the elements. See also MatchScope in JsonBody. You must specify either this setting or the IncludedPaths setting, but not both.

IncludedPaths List<string>

Match only the specified include paths. See also MatchScope in JsonBody.

All interface{}

Match all of the elements. See also MatchScope in JsonBody. You must specify either this setting or the IncludedPaths setting, but not both.

IncludedPaths []string

Match only the specified include paths. See also MatchScope in JsonBody.

all Object

Match all of the elements. See also MatchScope in JsonBody. You must specify either this setting or the IncludedPaths setting, but not both.

includedPaths List<String>

Match only the specified include paths. See also MatchScope in JsonBody.

all any

Match all of the elements. See also MatchScope in JsonBody. You must specify either this setting or the IncludedPaths setting, but not both.

includedPaths string[]

Match only the specified include paths. See also MatchScope in JsonBody.

all Any

Match all of the elements. See also MatchScope in JsonBody. You must specify either this setting or the IncludedPaths setting, but not both.

included_paths Sequence[str]

Match only the specified include paths. See also MatchScope in JsonBody.

all Any

Match all of the elements. See also MatchScope in JsonBody. You must specify either this setting or the IncludedPaths setting, but not both.

includedPaths List<String>

Match only the specified include paths. See also MatchScope in JsonBody.

LoggingConfigurationFieldToMatchJsonBodyPropertiesMatchScope

LoggingConfigurationFieldToMatchSingleHeaderProperties

Name string

The name of the query header to inspect.

Name string

The name of the query header to inspect.

name String

The name of the query header to inspect.

name string

The name of the query header to inspect.

name str

The name of the query header to inspect.

name String

The name of the query header to inspect.

LoggingConfigurationFilter

Behavior Pulumi.AwsNative.WAFv2.LoggingConfigurationFilterBehavior

How to handle logs that satisfy the filter's conditions and requirement.

Conditions List<Pulumi.AwsNative.WAFv2.Inputs.LoggingConfigurationCondition>

Match conditions for the filter.

Requirement Pulumi.AwsNative.WAFv2.LoggingConfigurationFilterRequirement

Logic to apply to the filtering conditions. You can specify that, in order to satisfy the filter, a log must match all conditions or must match at least one condition.

Behavior LoggingConfigurationFilterBehavior

How to handle logs that satisfy the filter's conditions and requirement.

Conditions []LoggingConfigurationCondition

Match conditions for the filter.

Requirement LoggingConfigurationFilterRequirement

Logic to apply to the filtering conditions. You can specify that, in order to satisfy the filter, a log must match all conditions or must match at least one condition.

behavior LoggingConfigurationFilterBehavior

How to handle logs that satisfy the filter's conditions and requirement.

conditions List<LoggingConfigurationCondition>

Match conditions for the filter.

requirement LoggingConfigurationFilterRequirement

Logic to apply to the filtering conditions. You can specify that, in order to satisfy the filter, a log must match all conditions or must match at least one condition.

behavior LoggingConfigurationFilterBehavior

How to handle logs that satisfy the filter's conditions and requirement.

conditions LoggingConfigurationCondition[]

Match conditions for the filter.

requirement LoggingConfigurationFilterRequirement

Logic to apply to the filtering conditions. You can specify that, in order to satisfy the filter, a log must match all conditions or must match at least one condition.

behavior LoggingConfigurationFilterBehavior

How to handle logs that satisfy the filter's conditions and requirement.

conditions Sequence[LoggingConfigurationCondition]

Match conditions for the filter.

requirement LoggingConfigurationFilterRequirement

Logic to apply to the filtering conditions. You can specify that, in order to satisfy the filter, a log must match all conditions or must match at least one condition.

behavior "KEEP" | "DROP"

How to handle logs that satisfy the filter's conditions and requirement.

conditions List<Property Map>

Match conditions for the filter.

requirement "MEETS_ALL" | "MEETS_ANY"

Logic to apply to the filtering conditions. You can specify that, in order to satisfy the filter, a log must match all conditions or must match at least one condition.

LoggingConfigurationFilterBehavior

LoggingConfigurationFilterRequirement

LoggingConfigurationLoggingFilterPropertiesDefaultBehavior

LoggingFilterProperties

DefaultBehavior Pulumi.AwsNative.WAFv2.LoggingConfigurationLoggingFilterPropertiesDefaultBehavior

Default handling for logs that don't match any of the specified filtering conditions.

Filters List<Pulumi.AwsNative.WAFv2.Inputs.LoggingConfigurationFilter>

The filters that you want to apply to the logs.

DefaultBehavior LoggingConfigurationLoggingFilterPropertiesDefaultBehavior

Default handling for logs that don't match any of the specified filtering conditions.

Filters []LoggingConfigurationFilter

The filters that you want to apply to the logs.

defaultBehavior LoggingConfigurationLoggingFilterPropertiesDefaultBehavior

Default handling for logs that don't match any of the specified filtering conditions.

filters List<LoggingConfigurationFilter>

The filters that you want to apply to the logs.

defaultBehavior LoggingConfigurationLoggingFilterPropertiesDefaultBehavior

Default handling for logs that don't match any of the specified filtering conditions.

filters LoggingConfigurationFilter[]

The filters that you want to apply to the logs.

default_behavior LoggingConfigurationLoggingFilterPropertiesDefaultBehavior

Default handling for logs that don't match any of the specified filtering conditions.

filters Sequence[LoggingConfigurationFilter]

The filters that you want to apply to the logs.

defaultBehavior "KEEP" | "DROP"

Default handling for logs that don't match any of the specified filtering conditions.

filters List<Property Map>

The filters that you want to apply to the logs.

Package Details

Repository
https://github.com/pulumi/pulumi-aws-native
License
Apache-2.0