Package com.pulumi.aws.guardduty

Class Filter

  • public class Filter
extends com.pulumi.resources.CustomResource
    Provides a resource to manage a GuardDuty filter. ## Example Usage 
     
 package generated_program;
 
 import com.pulumi.Context;
 import com.pulumi.Pulumi;
 import com.pulumi.core.Output;
 import com.pulumi.aws.guardduty.Filter;
 import com.pulumi.aws.guardduty.FilterArgs;
 import com.pulumi.aws.guardduty.inputs.FilterFindingCriteriaArgs;
 import com.pulumi.aws.guardduty.inputs.FilterFindingCriteriaCriterionArgs;
 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 myFilter = new Filter("myFilter", FilterArgs.builder()
             .findingCriteria(FilterFindingCriteriaArgs.builder()
                 .criterions(                
                     FilterFindingCriteriaCriterionArgs.builder()
                         .field("region")
                         .equals("eu-west-1")
                         .build(),
                     FilterFindingCriteriaCriterionArgs.builder()
                         .field("service.additionalInfo.threatListName")
                         .notEquals(                        
                             "some-threat",
                             "another-threat")
                         .build(),
                     FilterFindingCriteriaCriterionArgs.builder()
                         .field("updatedAt")
                         .greaterThan("2020-01-01T00:00:00Z")
                         .lessThan("2020-02-01T00:00:00Z")
                         .build(),
                     FilterFindingCriteriaCriterionArgs.builder()
                         .field("severity")
                         .greaterThanOrEqual("4")
                         .build())
                 .build())
             .name("MyFilter")
             .action("ARCHIVE")
             .detectorId(example.id())
             .rank(1)
             .build());
 
     }
 }
    ## Import Using `pulumi import`, import GuardDuty filters using the detector ID and filter's name separated by a colon. For example: ```sh $ pulumi import aws:guardduty/filter:Filter MyFilter 00b00fd5aecc0ab60a708659477e9617:MyFilter ```

    • 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

    • Constructor Summary

      Constructors 
      Constructor Description
      Filter​(java.lang.String name)  
      Filter​(java.lang.String name, FilterArgs args)  
      Filter​(java.lang.String name, FilterArgs args, com.pulumi.resources.CustomResourceOptions options)  

    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      com.pulumi.core.Output<java.lang.String> action()  
      com.pulumi.core.Output<java.lang.String> arn()  
      com.pulumi.core.Output<java.util.Optional<java.lang.String>> description()  
      com.pulumi.core.Output<java.lang.String> detectorId()  
      com.pulumi.core.Output<FilterFindingCriteria> findingCriteria()  
      static Filter get​(java.lang.String name, com.pulumi.core.Output<java.lang.String> id, FilterState 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.lang.String> name()  
      com.pulumi.core.Output<java.lang.Integer> rank()  
      com.pulumi.core.Output<java.lang.String> region()  
      com.pulumi.core.Output<java.util.Optional<java.util.Map<java.lang.String,​java.lang.String>>> tags()  
      com.pulumi.core.Output<java.util.Map<java.lang.String,​java.lang.String>> tagsAll()  

      • 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

      • Filter

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

      • Filter

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

      • Filter

        public Filter​(java.lang.String name,
              FilterArgs 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

      • action

        public com.pulumi.core.Output<java.lang.String> action()
        Returns:
        Action that is to be applied to the findings that match the filter. Can be one of `ARCHIVE` or `NOOP`.

      • arn

        public com.pulumi.core.Output<java.lang.String> arn()
        Returns:
        ARN of the GuardDuty filter.

      • description

        public com.pulumi.core.Output<java.util.Optional<java.lang.String>> description()
        Returns:
        Description of the filter.

      • detectorId

        public com.pulumi.core.Output<java.lang.String> detectorId()
        Returns:
        ID of a GuardDuty detector, attached to your account.

      • findingCriteria

        public com.pulumi.core.Output<FilterFindingCriteria> findingCriteria()
        Returns:
        Criteria to be used in the filter for querying findings. Contains one or more `criterion` blocks, documented below.

      • name

        public com.pulumi.core.Output<java.lang.String> name()
        Returns:
        Name of your filter.

      • rank

        public com.pulumi.core.Output<java.lang.Integer> rank()
        Returns:
        Position of the filter in the list of current filters. Also specifies the order in which this filter is applied to the findings.

      • 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.

      • tags

        public com.pulumi.core.Output<java.util.Optional<java.util.Map<java.lang.String,​java.lang.String>>> tags()
        Returns:
        Tags that you want to add to the Filter resource. A tag consists of a key and a value. If configured with a provider `defaultTags` configuration block present, tags with matching keys will overwrite those defined at the provider-level.

      • tagsAll

        public com.pulumi.core.Output<java.util.Map<java.lang.String,​java.lang.String>> tagsAll()
        Returns:
        Map of tags assigned to the resource, including those inherited from the provider `defaultTags` configuration block.

      • get

        public static Filter get​(java.lang.String name,
                         com.pulumi.core.Output<java.lang.String> id,
                         @Nullable
                         FilterState 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.