AutomationRule class

Resource for managing an AWS Security Hub Automation Rule.

Example Usage

Basic Usage

import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";

const example = new aws.securityhub.AutomationRule("example", {
    description: "Elevate finding severity to CRITICAL when specific resources such as an S3 bucket is at risk",
    ruleName: "Elevate severity of findings that relate to important resources",
    ruleOrder: 1,
    actions: [{
        findingFieldsUpdate: {
            severity: {
                label: "CRITICAL",
                product: 0,
            },
            note: {
                text: "This is a critical resource. Please review ASAP.",
                updatedBy: "sechub-automation",
            },
            types: ["Software and Configuration Checks/Industry and Regulatory Standards"],
            userDefinedFields: {
                key: "value",
            },
        },
        type: "FINDING_FIELDS_UPDATE",
    }],
    criteria: {
        resourceIds: [{
            comparison: "EQUALS",
            value: "arn:aws:s3:::examplebucket/*",
        }],
    },
});
import pulumi
import pulumi_aws as aws

example = aws.securityhub.AutomationRule("example",
    description="Elevate finding severity to CRITICAL when specific resources such as an S3 bucket is at risk",
    rule_name="Elevate severity of findings that relate to important resources",
    rule_order=1,
    actions=[{
        "finding_fields_update": {
            "severity": {
                "label": "CRITICAL",
                "product": float(0),
            },
            "note": {
                "text": "This is a critical resource. Please review ASAP.",
                "updated_by": "sechub-automation",
            },
            "types": ["Software and Configuration Checks/Industry and Regulatory Standards"],
            "user_defined_fields": {
                "key": "value",
            },
        },
        "type": "FINDING_FIELDS_UPDATE",
    }],
    criteria={
        "resource_ids": [{
            "comparison": "EQUALS",
            "value": "arn:aws:s3:::examplebucket/*",
        }],
    })
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;

return await Deployment.RunAsync(() =>
{
    var example = new Aws.SecurityHub.AutomationRule("example", new()
    {
        Description = "Elevate finding severity to CRITICAL when specific resources such as an S3 bucket is at risk",
        RuleName = "Elevate severity of findings that relate to important resources",
        RuleOrder = 1,
        Actions = new[]
        {
            new Aws.SecurityHub.Inputs.AutomationRuleActionArgs
            {
                FindingFieldsUpdate = new Aws.SecurityHub.Inputs.AutomationRuleActionFindingFieldsUpdateArgs
                {
                    Severity = new Aws.SecurityHub.Inputs.AutomationRuleActionFindingFieldsUpdateSeverityArgs
                    {
                        Label = "CRITICAL",
                        Product = 0,
                    },
                    Note = new Aws.SecurityHub.Inputs.AutomationRuleActionFindingFieldsUpdateNoteArgs
                    {
                        Text = "This is a critical resource. Please review ASAP.",
                        UpdatedBy = "sechub-automation",
                    },
                    Types = new[]
                    {
                        "Software and Configuration Checks/Industry and Regulatory Standards",
                    },
                    UserDefinedFields =
                    {
                        { "key", "value" },
                    },
                },
                Type = "FINDING_FIELDS_UPDATE",
            },
        },
        Criteria = new Aws.SecurityHub.Inputs.AutomationRuleCriteriaArgs
        {
            ResourceIds = new[]
            {
                new Aws.SecurityHub.Inputs.AutomationRuleCriteriaResourceIdArgs
                {
                    Comparison = "EQUALS",
                    Value = "arn:aws:s3:::examplebucket/*",
                },
            },
        },
    });

});
package main

import (
	"github.com/pulumi/pulumi-aws/sdk/v7/go/aws/securityhub"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := securityhub.NewAutomationRule(ctx, "example", &securityhub.AutomationRuleArgs{
			Description: pulumi.String("Elevate finding severity to CRITICAL when specific resources such as an S3 bucket is at risk"),
			RuleName:    pulumi.String("Elevate severity of findings that relate to important resources"),
			RuleOrder:   pulumi.Int(1),
			Actions: securityhub.AutomationRuleActionArray{
				&securityhub.AutomationRuleActionArgs{
					FindingFieldsUpdate: &securityhub.AutomationRuleActionFindingFieldsUpdateArgs{
						Severity: &securityhub.AutomationRuleActionFindingFieldsUpdateSeverityArgs{
							Label:   pulumi.String("CRITICAL"),
							Product: pulumi.Float64(0),
						},
						Note: &securityhub.AutomationRuleActionFindingFieldsUpdateNoteArgs{
							Text:      pulumi.String("This is a critical resource. Please review ASAP."),
							UpdatedBy: pulumi.String("sechub-automation"),
						},
						Types: pulumi.StringArray{
							pulumi.String("Software and Configuration Checks/Industry and Regulatory Standards"),
						},
						UserDefinedFields: pulumi.StringMap{
							"key": pulumi.String("value"),
						},
					},
					Type: pulumi.String("FINDING_FIELDS_UPDATE"),
				},
			},
			Criteria: &securityhub.AutomationRuleCriteriaArgs{
				ResourceIds: securityhub.AutomationRuleCriteriaResourceIdArray{
					&securityhub.AutomationRuleCriteriaResourceIdArgs{
						Comparison: pulumi.String("EQUALS"),
						Value:      pulumi.String("arn:aws:s3:::examplebucket/*"),
					},
				},
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}
pulumi {
  required_providers {
    aws = {
      source = "pulumi/aws"
    }
  }
}

resource "aws_securityhub_automationrule" "example" {
  description = "Elevate finding severity to CRITICAL when specific resources such as an S3 bucket is at risk"
  rule_name   = "Elevate severity of findings that relate to important resources"
  rule_order  = 1
  actions {
    finding_fields_update = {
      severity = {
        label   = "CRITICAL"
        product = "0.0"
      }
      note = {
        text       = "This is a critical resource. Please review ASAP."
        updated_by = "sechub-automation"
      }
      types = ["Software and Configuration Checks/Industry and Regulatory Standards"]
      user_defined_fields = {
        "key" = "value"
      }
    }
    type = "FINDING_FIELDS_UPDATE"
  }
  criteria = {
    resource_ids = [{
      "comparison" = "EQUALS"
      "value"      = "arn:aws:s3:::examplebucket/*"
    }]
  }
}
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.securityhub.AutomationRule;
import com.pulumi.aws.securityhub.AutomationRuleArgs;
import com.pulumi.aws.securityhub.inputs.AutomationRuleActionArgs;
import com.pulumi.aws.securityhub.inputs.AutomationRuleActionFindingFieldsUpdateArgs;
import com.pulumi.aws.securityhub.inputs.AutomationRuleActionFindingFieldsUpdateSeverityArgs;
import com.pulumi.aws.securityhub.inputs.AutomationRuleActionFindingFieldsUpdateNoteArgs;
import com.pulumi.aws.securityhub.inputs.AutomationRuleCriteriaArgs;
import com.pulumi.aws.securityhub.inputs.AutomationRuleCriteriaResourceIdArgs;
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 AutomationRule("example", AutomationRuleArgs.builder()
            .description("Elevate finding severity to CRITICAL when specific resources such as an S3 bucket is at risk")
            .ruleName("Elevate severity of findings that relate to important resources")
            .ruleOrder(1)
            .actions(AutomationRuleActionArgs.builder()
                .findingFieldsUpdate(AutomationRuleActionFindingFieldsUpdateArgs.builder()
                    .severity(AutomationRuleActionFindingFieldsUpdateSeverityArgs.builder()
                        .label("CRITICAL")
                        .product(0.0)
                        .build())
                    .note(AutomationRuleActionFindingFieldsUpdateNoteArgs.builder()
                        .text("This is a critical resource. Please review ASAP.")
                        .updatedBy("sechub-automation")
                        .build())
                    .types("Software and Configuration Checks/Industry and Regulatory Standards")
                    .userDefinedFields(Map.of("key", "value"))
                    .build())
                .type("FINDING_FIELDS_UPDATE")
                .build())
            .criteria(AutomationRuleCriteriaArgs.builder()
                .resourceIds(AutomationRuleCriteriaResourceIdArgs.builder()
                    .comparison("EQUALS")
                    .value("arn:aws:s3:::examplebucket/*")
                    .build())
                .build())
            .build());

    }
}
resources:
  example:
    type: aws:securityhub:AutomationRule
    properties:
      description: Elevate finding severity to CRITICAL when specific resources such as an S3 bucket is at risk
      ruleName: Elevate severity of findings that relate to important resources
      ruleOrder: 1
      actions:
        - findingFieldsUpdate:
            severity:
              label: CRITICAL
              product: '0.0'
            note:
              text: This is a critical resource. Please review ASAP.
              updatedBy: sechub-automation
            types:
              - Software and Configuration Checks/Industry and Regulatory Standards
            userDefinedFields:
              key: value
          type: FINDING_FIELDS_UPDATE
      criteria:
        resourceIds:
          - comparison: EQUALS
            value: arn:aws:s3:::examplebucket/*

Import

Identity Schema

Required

  • arn (String) Amazon Resource Name (ARN) of the Security Hub automation rule.

Using pulumi import, import Security Hub automation rules using arn. For example:

$ pulumi import aws:securityhub/automationRule:AutomationRule example arn:aws:securityhub:us-west-2:123456789012:automation-rule/473eddde-f5c4-4ae5-85c7-e922f271fffc

Constructors

AutomationRule(String name, {AutomationRuleArgs? args, CustomResourceOptions? options})
Creates a new AutomationRule. name The Pulumi resource name. args Arguments used to configure this AutomationRule. The set of arguments for AutomationRule. options Resource options controlling this resource's behavior.

Properties

actions ↔ Output<List<Map<String, dynamic>>>
A block that specifies one or more actions to update finding fields if a finding matches the conditions specified in Criteria. Documented below.
latefinal
arn ↔ Output<String>
The ARN of the Security Hub automation rule.
latefinal
childResources → Set<Resource>
finalinherited
completionSources ↔ Map<String, IOutputCompletionSource>
latefinalinherited
criteria ↔ Output<AutomationRuleCriteria>
A block that specifies a set of ASFF finding field attributes and corresponding expected values that Security Hub uses to filter findings. Documented below.
latefinal
description ↔ Output<String>
The description of the rule.
latefinal
hashCode → int
The hash code for this object.
no setterinherited
id ↔ Output<String>
getter/setter pairinherited
isCustom → bool
Returns whether this resource is provider-managed.
no setterinherited
isProtected → bool
Returns whether this resource is protected from deletion.
no setterinherited
isRemote → bool
Whether this resource is registered as remote.
no setterinherited
isResourceReference → bool
Whether this instance represents a resource value returned over RPC.
finalinherited
isTerminal ↔ Output<bool>
Specifies whether a rule is the last to be applied with respect to a finding that matches the rule criteria. Defaults to false.
latefinal
region ↔ Output<String>
Region where this resource will be managed. Defaults to the Region set in the provider configuration.
latefinal
resourceTransforms → List<ResourceTransform>
Inherited/explicit async transforms.
no setterinherited
ruleName ↔ Output<String>
The name of the rule.
latefinal
ruleOrder ↔ Output<int>
An integer ranging from 1 to 1000 that represents the order in which the rule action is applied to findings. Security Hub applies rules with lower values for this parameter first.
latefinal
ruleStatus ↔ Output<String>
Whether the rule is active after it is created.
latefinal
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
tags ↔ Output<Map<String, String>?>
latefinal
tagsAll ↔ Output<Map<String, String>>
latefinal
transformations → List<ResourceTransformation>
Inherited/explicit legacy transformations.
no setterinherited
urn ↔ Output<String>
latefinalinherited

Methods

failId(Object error) → void
Completes this resource ID with an error when registration fails.
inherited
failOutputs(Object error) → void
Completes all output properties with error.
inherited
failUrn(Object error) → void
Completes this resource URN with an error when registration fails.
inherited
getProvider(String moduleMember) → ProviderResource?
Returns provider for moduleMember's package, if configured.
inherited
getResourceName() → String
Returns this resource's logical name.
inherited
getResourceType() → String
Returns this resource's Pulumi type token.
inherited
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
registerOutput<T>(String propertyName, {Object? decoder(Object?)?, bool isSecret = false}) → Output<T>
Registers a dynamic output property for this resource.
inherited
resolveId(String? value, {required bool isKnown}) → void
Resolves the provider-assigned ID for this resource.
inherited
resolveOutputs(Struct outputs) → void
Resolves all output properties from a monitor response payload.
inherited
resolveUrn(String value) → void
Resolves this resource's URN once assigned by the engine.
inherited
serializeProperties(Map<String, dynamic> properties) → Future<Struct>
Serializes resource properties for RPC transmission.
inherited
toString() → String
A string representation of this object.
inherited

Operators

operator ==(Object other) → bool
The equality operator.
inherited

Static Methods

get(String name, Input<String> id, {AutomationRuleState? state}) → AutomationRule
Gets an existing AutomationRule resource's state with the given name and id.