Class WebAclLoggingConfiguration


  • public class WebAclLoggingConfiguration
    extends com.pulumi.resources.CustomResource
    This resource creates a WAFv2 Web ACL Logging Configuration. > **WARNING:** When logging from a WAFv2 Web ACL to a CloudWatch Log Group, the WAFv2 service tries to create or update a generic Log Resource Policy named `AWSWAF-LOGS`. However, if there are a large number of Web ACLs or if the account frequently creates and deletes Web ACLs, this policy may exceed the maximum policy size. As a result, this resource type will fail to be created. More details about this issue can be found in this issue. To prevent this issue, you can manage a specific resource policy. Please refer to the example below for managing a CloudWatch Log Group with a managed CloudWatch Log Resource Policy. ## Example Usage ### With Redacted Fields
     
     package generated_program;
     
     import com.pulumi.Context;
     import com.pulumi.Pulumi;
     import com.pulumi.core.Output;
     import com.pulumi.aws.wafv2.WebAclLoggingConfiguration;
     import com.pulumi.aws.wafv2.WebAclLoggingConfigurationArgs;
     import com.pulumi.aws.wafv2.inputs.WebAclLoggingConfigurationRedactedFieldArgs;
     import com.pulumi.aws.wafv2.inputs.WebAclLoggingConfigurationRedactedFieldSingleHeaderArgs;
     import java.util.ArrayList;
     import java.util.Arrays;
     import java.util.Map;
     import java.io.File;
     import java.nio.file.Files;
     import java.nio.file.Paths;
     
     public class App {
         public static void main(String[] args) {
             Pulumi.run(App::stack);
         }
     
         public static void stack(Context ctx) {
             var example = new WebAclLoggingConfiguration("example", WebAclLoggingConfigurationArgs.builder()
                 .redactedFields(WebAclLoggingConfigurationRedactedFieldArgs.builder()
                     .singleHeader(WebAclLoggingConfigurationRedactedFieldSingleHeaderArgs.builder()
                         .name("user-agent")
                         .build())
                     .build())
                 .logDestinationConfigs(exampleAwsKinesisFirehoseDeliveryStream.arn())
                 .resourceArn(exampleAwsWafv2WebAcl.arn())
                 .build());
     
         }
     }
     
     
    ### With Logging Filter
     
     package generated_program;
     
     import com.pulumi.Context;
     import com.pulumi.Pulumi;
     import com.pulumi.core.Output;
     import com.pulumi.aws.wafv2.WebAclLoggingConfiguration;
     import com.pulumi.aws.wafv2.WebAclLoggingConfigurationArgs;
     import com.pulumi.aws.wafv2.inputs.WebAclLoggingConfigurationLoggingFilterArgs;
     import com.pulumi.aws.wafv2.inputs.WebAclLoggingConfigurationLoggingFilterFilterArgs;
     import com.pulumi.aws.wafv2.inputs.WebAclLoggingConfigurationLoggingFilterFilterConditionArgs;
     import com.pulumi.aws.wafv2.inputs.WebAclLoggingConfigurationLoggingFilterFilterConditionActionConditionArgs;
     import com.pulumi.aws.wafv2.inputs.WebAclLoggingConfigurationLoggingFilterFilterConditionLabelNameConditionArgs;
     import java.util.ArrayList;
     import java.util.Arrays;
     import java.util.Map;
     import java.io.File;
     import java.nio.file.Files;
     import java.nio.file.Paths;
     
     public class App {
         public static void main(String[] args) {
             Pulumi.run(App::stack);
         }
     
         public static void stack(Context ctx) {
             var example = new WebAclLoggingConfiguration("example", WebAclLoggingConfigurationArgs.builder()
                 .loggingFilter(WebAclLoggingConfigurationLoggingFilterArgs.builder()
                     .filters(                
                         WebAclLoggingConfigurationLoggingFilterFilterArgs.builder()
                             .conditions(                        
                                 WebAclLoggingConfigurationLoggingFilterFilterConditionArgs.builder()
                                     .actionCondition(WebAclLoggingConfigurationLoggingFilterFilterConditionActionConditionArgs.builder()
                                         .action("COUNT")
                                         .build())
                                     .build(),
                                 WebAclLoggingConfigurationLoggingFilterFilterConditionArgs.builder()
                                     .labelNameCondition(WebAclLoggingConfigurationLoggingFilterFilterConditionLabelNameConditionArgs.builder()
                                         .labelName("awswaf:111122223333:rulegroup:testRules:LabelNameZ")
                                         .build())
                                     .build())
                             .behavior("DROP")
                             .requirement("MEETS_ALL")
                             .build(),
                         WebAclLoggingConfigurationLoggingFilterFilterArgs.builder()
                             .conditions(WebAclLoggingConfigurationLoggingFilterFilterConditionArgs.builder()
                                 .actionCondition(WebAclLoggingConfigurationLoggingFilterFilterConditionActionConditionArgs.builder()
                                     .action("ALLOW")
                                     .build())
                                 .build())
                             .behavior("KEEP")
                             .requirement("MEETS_ANY")
                             .build())
                     .defaultBehavior("KEEP")
                     .build())
                 .logDestinationConfigs(exampleAwsKinesisFirehoseDeliveryStream.arn())
                 .resourceArn(exampleAwsWafv2WebAcl.arn())
                 .build());
     
         }
     }
     
     
    ## Import Using `pulumi import`, import WAFv2 Web ACL Logging Configurations using the ARN of the WAFv2 Web ACL. For example: ```sh $ pulumi import aws:wafv2/webAclLoggingConfiguration:WebAclLoggingConfiguration example arn:aws:wafv2:us-west-2:123456789012:regional/webacl/test-logs/a1b2c3d4-5678-90ab-cdef ```
    • Nested Class Summary

      • Nested classes/interfaces inherited from class com.pulumi.resources.CustomResource

        com.pulumi.resources.CustomResource.CustomResourceInternal
      • Nested classes/interfaces inherited from class com.pulumi.resources.Resource

        com.pulumi.resources.Resource.LazyField<T extends java.lang.Object>, com.pulumi.resources.Resource.LazyFields, com.pulumi.resources.Resource.ResourceInternal
    • Field Summary

      • Fields inherited from class com.pulumi.resources.Resource

        childResources, remote
    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      static WebAclLoggingConfiguration get​(java.lang.String name, com.pulumi.core.Output<java.lang.String> id, WebAclLoggingConfigurationState state, com.pulumi.resources.CustomResourceOptions options)
      Get an existing Host resource's state with the given name, ID, and optional extra properties used to qualify the lookup.
      com.pulumi.core.Output<java.util.List<java.lang.String>> logDestinationConfigs()  
      com.pulumi.core.Output<java.util.Optional<WebAclLoggingConfigurationLoggingFilter>> loggingFilter()  
      com.pulumi.core.Output<java.util.Optional<java.util.List<WebAclLoggingConfigurationRedactedField>>> redactedFields()  
      com.pulumi.core.Output<java.lang.String> region()  
      com.pulumi.core.Output<java.lang.String> resourceArn()  
      • Methods inherited from class com.pulumi.resources.CustomResource

        getId, id, idFuture
      • Methods inherited from class com.pulumi.resources.Resource

        getChildResources, getResourceName, getResourceType, getUrn, pulumiChildResources, pulumiResourceName, pulumiResourceType, urn
      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    • Constructor Detail

      • WebAclLoggingConfiguration

        public WebAclLoggingConfiguration​(java.lang.String name)
        Parameters:
        name - The _unique_ name of the resulting resource.
      • WebAclLoggingConfiguration

        public WebAclLoggingConfiguration​(java.lang.String name,
                                          WebAclLoggingConfigurationArgs args)
        Parameters:
        name - The _unique_ name of the resulting resource.
        args - The arguments to use to populate this resource's properties.
      • WebAclLoggingConfiguration

        public WebAclLoggingConfiguration​(java.lang.String name,
                                          WebAclLoggingConfigurationArgs args,
                                          @Nullable
                                          com.pulumi.resources.CustomResourceOptions options)
        Parameters:
        name - The _unique_ name of the resulting resource.
        args - The arguments to use to populate this resource's properties.
        options - A bag of options that control this resource's behavior.
    • Method Detail

      • logDestinationConfigs

        public com.pulumi.core.Output<java.util.List<java.lang.String>> logDestinationConfigs()
        Returns:
        Configuration block that allows you to associate Amazon Kinesis Data Firehose, CloudWatch Log log group, or S3 bucket ARNs with the web ACL. **Note:** data firehose, log group, or bucket name **must** be prefixed with `aws-waf-logs-`, e.g. `aws-waf-logs-example-firehose`, `aws-waf-logs-example-log-group`, or `aws-waf-logs-example-bucket`.
      • loggingFilter

        public com.pulumi.core.Output<java.util.Optional<WebAclLoggingConfigurationLoggingFilter>> loggingFilter()
        Returns:
        Configuration block that specifies which web requests are kept in the logs and which are dropped. It allows filtering based on the rule action and the web request labels applied by matching rules during web ACL evaluation. For more details, refer to the Logging Filter section below.
      • redactedFields

        public com.pulumi.core.Output<java.util.Optional<java.util.List<WebAclLoggingConfigurationRedactedField>>> redactedFields()
        Returns:
        Configuration for parts of the request that you want to keep out of the logs. Up to 100 `redactedFields` blocks are supported. See Redacted Fields below for more details.
      • region

        public com.pulumi.core.Output<java.lang.String> region()
        Returns:
        Region where this resource will be [managed](https://docs.aws.amazon.com/general/latest/gr/rande.html#regional-endpoints). Defaults to the Region set in the provider configuration.
      • resourceArn

        public com.pulumi.core.Output<java.lang.String> resourceArn()
        Returns:
        ARN of the web ACL that you want to associate with `logDestinationConfigs`.
      • get

        public static WebAclLoggingConfiguration get​(java.lang.String name,
                                                     com.pulumi.core.Output<java.lang.String> id,
                                                     @Nullable
                                                     WebAclLoggingConfigurationState state,
                                                     @Nullable
                                                     com.pulumi.resources.CustomResourceOptions options)
        Get an existing Host resource's state with the given name, ID, and optional extra properties used to qualify the lookup.
        Parameters:
        name - The _unique_ name of the resulting resource.
        id - The _unique_ provider ID of the resource to lookup.
        state -
        options - Optional settings to control the behavior of the CustomResource.