Skip to content
v2.277.0

AutomationRulesActionProperty Struct ​

One or more actions that AWS Security Hub CSPM takes when a finding matches the defined criteria of a rule.

Example ​

ts
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_securityhub as securityhub } from 'aws-cdk-lib';
const automationRulesActionProperty: securityhub.CfnAutomationRule.AutomationRulesActionProperty = {
  findingFieldsUpdate: {
    confidence: 123,
    criticality: 123,
    note: {
      text: 'text',
      updatedBy: 'updatedBy',
    },
    relatedFindings: [{
      id: 'id',
      productArn: 'productArn',
    }],
    severity: {
      label: 'label',
      normalized: 123,
      product: 123,
    },
    types: ['types'],
    userDefinedFields: {
      userDefinedFieldsKey: 'userDefinedFields',
    },
    verificationState: 'verificationState',
    workflow: {
      status: 'status',
    },
  },
  type: 'type',
};
python
# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_securityhub as securityhub

automation_rules_action_property = securityhub.CfnAutomationRule.AutomationRulesActionProperty(
    finding_fields_update=securityhub.CfnAutomationRule.AutomationRulesFindingFieldsUpdateProperty(
        confidence=123,
        criticality=123,
        note=securityhub.CfnAutomationRule.NoteUpdateProperty(
            text="text",
            updated_by="updatedBy"
        ),
        related_findings=[securityhub.CfnAutomationRule.RelatedFindingProperty(
            id="id",
            product_arn="productArn"
        )],
        severity=securityhub.CfnAutomationRule.SeverityUpdateProperty(
            label="label",
            normalized=123,
            product=123
        ),
        types=["types"],
        user_defined_fields={
            "user_defined_fields_key": "userDefinedFields"
        },
        verification_state="verificationState",
        workflow=securityhub.CfnAutomationRule.WorkflowUpdateProperty(
            status="status"
        )
    ),
    type="type"
)
java
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import software.amazon.awscdk.services.securityhub.*;

AutomationRulesActionProperty automationRulesActionProperty = AutomationRulesActionProperty.builder()
        .findingFieldsUpdate(AutomationRulesFindingFieldsUpdateProperty.builder()
                .confidence(123)
                .criticality(123)
                .note(NoteUpdateProperty.builder()
                        .text("text")
                        .updatedBy("updatedBy")
                        .build())
                .relatedFindings(List.of(RelatedFindingProperty.builder()
                        .id("id")
                        .productArn("productArn")
                        .build()))
                .severity(SeverityUpdateProperty.builder()
                        .label("label")
                        .normalized(123)
                        .product(123)
                        .build())
                .types(List.of("types"))
                .userDefinedFields(Map.of(
                        "userDefinedFieldsKey", "userDefinedFields"))
                .verificationState("verificationState")
                .workflow(WorkflowUpdateProperty.builder()
                        .status("status")
                        .build())
                .build())
        .type("type")
        .build();
csharp
// Install: dotnet add package Amazon.CDK.Lib
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.SecurityHub;

var automationRulesActionProperty = new AutomationRulesActionProperty {
    FindingFieldsUpdate = new AutomationRulesFindingFieldsUpdateProperty {
        Confidence = 123,
        Criticality = 123,
        Note = new NoteUpdateProperty {
            Text = "text",
            UpdatedBy = "updatedBy"
        },
        RelatedFindings = new [] { new RelatedFindingProperty {
            Id = "id",
            ProductArn = "productArn"
        } },
        Severity = new SeverityUpdateProperty {
            Label = "label",
            Normalized = 123,
            Product = 123
        },
        Types = new [] { "types" },
        UserDefinedFields = new Dictionary<string, string> {
            { "userDefinedFieldsKey", "userDefinedFields" }
        },
        VerificationState = "verificationState",
        Workflow = new WorkflowUpdateProperty {
            Status = "status"
        }
    },
    Type = "type"
};
go
// Install: go get github.com/aws/aws-cdk-go/awscdk/v2
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"

automationRulesActionProperty := &AutomationRulesActionProperty{
	FindingFieldsUpdate: &AutomationRulesFindingFieldsUpdateProperty{
		Confidence: jsii.Number(123),
		Criticality: jsii.Number(123),
		Note: &NoteUpdateProperty{
			Text: jsii.String("text"),
			UpdatedBy: jsii.String("updatedBy"),
		},
		RelatedFindings: []interface{}{
			&RelatedFindingProperty{
				Id: jsii.String("id"),
				ProductArn: jsii.String("productArn"),
			},
		},
		Severity: &SeverityUpdateProperty{
			Label: jsii.String("label"),
			Normalized: jsii.Number(123),
			Product: jsii.Number(123),
		},
		Types: []*string{
			jsii.String("types"),
		},
		UserDefinedFields: map[string]*string{
			"userDefinedFieldsKey": jsii.String("userDefinedFields"),
		},
		VerificationState: jsii.String("verificationState"),
		Workflow: &WorkflowUpdateProperty{
			Status: jsii.String("status"),
		},
	},
	Type: jsii.String("type"),
}

Properties ​

findingFieldsUpdateIResolvable | CfnAutomationRule.AutomationRulesFindingFieldsUpdatePropertyfinding_fields_updatetyping.Union[IResolvable, AutomationRulesFindingFieldsUpdateProperty]findingFieldsUpdateIResolvableFindingFieldsUpdateIResolvableFindingFieldsUpdateinterface{} required #
Specifies that the automation rule action is an update to a finding field.
typestringtypestrtypeStringTypestringType*string required #
Specifies the type of action that Security Hub CSPM takes when a finding matches the defined criteria of a rule.