Package com.pulumi.aws.securityhub

Class AutomationRuleV2

  • public class AutomationRuleV2
extends com.pulumi.resources.CustomResource
    Manages a Security Hub V2 Automation Rule, which automatically updates or takes action on findings that match specified criteria. > **NOTE:** Automation rules must be created in the aggregation (home) region. A Security Hub V2 Aggregator (`aws.securityhub.AggregatorV2`) must exist before creating automation rules. ## Example Usage ### Basic 
     
 package generated_program;
 
 import com.pulumi.Context;
 import com.pulumi.Pulumi;
 import com.pulumi.core.Output;
 import com.pulumi.aws.securityhub.AccountV2;
 import com.pulumi.aws.securityhub.AggregatorV2;
 import com.pulumi.aws.securityhub.AggregatorV2Args;
 import com.pulumi.aws.securityhub.AutomationRuleV2;
 import com.pulumi.aws.securityhub.AutomationRuleV2Args;
 import com.pulumi.aws.securityhub.inputs.AutomationRuleV2CriteriaArgs;
 import com.pulumi.aws.securityhub.inputs.AutomationRuleV2ActionArgs;
 import com.pulumi.aws.securityhub.inputs.AutomationRuleV2ActionFindingFieldsUpdateArgs;
 import static com.pulumi.codegen.internal.Serialization.*;
 import com.pulumi.resources.CustomResourceOptions;
 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 AccountV2("example");
 
         var exampleAggregatorV2 = new AggregatorV2("exampleAggregatorV2", AggregatorV2Args.builder()
             .regionLinkingMode("ALL_REGIONS")
             .build(), CustomResourceOptions.builder()
                 .dependsOn(example)
                 .build());
 
         var exampleAutomationRuleV2 = new AutomationRuleV2("exampleAutomationRuleV2", AutomationRuleV2Args.builder()
             .criteria(AutomationRuleV2CriteriaArgs.builder()
                 .ocsfFindingCriteriaJson(serializeJson(
                     jsonObject(
                         jsonProperty("CompositeFilters", jsonArray(jsonObject(
                             jsonProperty("StringFilters", jsonArray(jsonObject(
                                 jsonProperty("FieldName", "metadata.product.name"),
                                 jsonProperty("Filter", jsonObject(
                                     jsonProperty("Comparison", "EQUALS"),
                                     jsonProperty("Value", "GuardDuty")
                                 ))
                             )))
                         ))),
                         jsonProperty("CompositeOperator", "AND")
                     )))
                 .build())
             .action(AutomationRuleV2ActionArgs.builder()
                 .findingFieldsUpdate(AutomationRuleV2ActionFindingFieldsUpdateArgs.builder()
                     .severityId(99)
                     .statusId(3)
                     .comment("Low severity GuardDuty finding suppressed")
                     .build())
                 .type("FINDING_FIELDS_UPDATE")
                 .build())
             .ruleName("suppress-guardduty-low")
             .description("Suppress low severity GuardDuty findings")
             .ruleOrder(100.0)
             .ruleStatus("ENABLED")
             .build(), CustomResourceOptions.builder()
                 .dependsOn(exampleAggregatorV2)
                 .build());
 
     }
 }
    ## Import ### Identity Schema #### Required - `arn` (String) ARN of the Security Hub V2 automation rule. Using `pulumi import`, import Security Hub V2 automation rules using `arn`. For example: ```sh $ pulumi import aws:securityhub/automationRuleV2:AutomationRuleV2 example arn:aws:securityhub:us-east-1:123456789012:automation-rulev2/3efb04f4-e19e-4458-a698-62364ab7b1a7 ```

    • 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
      com.pulumi.core.Output<AutomationRuleV2Action> action()  
      com.pulumi.core.Output<java.lang.String> arn()  
      com.pulumi.core.Output<AutomationRuleV2Criteria> criteria()  
      com.pulumi.core.Output<java.lang.String> description()  
      static AutomationRuleV2 get​(java.lang.String name, com.pulumi.core.Output<java.lang.String> id, AutomationRuleV2State 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> region()  
      com.pulumi.core.Output<java.lang.String> ruleId()  
      com.pulumi.core.Output<java.lang.String> ruleName()  
      com.pulumi.core.Output<java.lang.Double> ruleOrder()  
      com.pulumi.core.Output<java.lang.String> ruleStatus()  
      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

      • AutomationRuleV2

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

      • AutomationRuleV2

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

      • AutomationRuleV2

        public AutomationRuleV2​(java.lang.String name,
                        AutomationRuleV2Args 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<AutomationRuleV2Action> action()
        Returns:
        Actions to take when the rule matches. Maximum of 1 action block. See `action` below.

      • arn

        public com.pulumi.core.Output<java.lang.String> arn()

      • criteria

        public com.pulumi.core.Output<AutomationRuleV2Criteria> criteria()
        Returns:
        Filtering type and configuration of the automation rule. See `criteria` below.

      • description

        public com.pulumi.core.Output<java.lang.String> description()
        Returns:
        A description of the automation rule.

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

      • ruleId

        public com.pulumi.core.Output<java.lang.String> ruleId()
        Returns:
        ID of the automation rule.

      • ruleName

        public com.pulumi.core.Output<java.lang.String> ruleName()
        Returns:
        The name of the automation rule.

      • ruleOrder

        public com.pulumi.core.Output<java.lang.Double> ruleOrder()
        Returns:
        The priority of the rule. Lower values indicate higher priority.

      • ruleStatus

        public com.pulumi.core.Output<java.lang.String> ruleStatus()
        Returns:
        The status of the rule. Valid values: `ENABLED`, `DISABLED`. Defaults to `ENABLED`.

      • tags

        public com.pulumi.core.Output<java.util.Optional<java.util.Map<java.lang.String,​java.lang.String>>> tags()
        Returns:
        Map of tags to assign to the resource. 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 AutomationRuleV2 get​(java.lang.String name,
                                   com.pulumi.core.Output<java.lang.String> id,
                                   @Nullable
                                   AutomationRuleV2State 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.