Skip to content
v2.277.0

AutomationRulesFindingFieldsUpdateProperty Struct ​

Identifies the finding fields that the automation rule action updates when a finding matches the defined criteria.

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 automationRulesFindingFieldsUpdateProperty: securityhub.CfnAutomationRule.AutomationRulesFindingFieldsUpdateProperty = {
  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',
  },
};
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_finding_fields_update_property = 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"
    )
)
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.*;

AutomationRulesFindingFieldsUpdateProperty automationRulesFindingFieldsUpdateProperty = 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();
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 automationRulesFindingFieldsUpdateProperty = 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"
    }
};
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"

automationRulesFindingFieldsUpdateProperty := &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"),
	},
}

Properties ​

confidenceoptionalnumberconfidenceoptionalint | floatconfidenceoptionalNumberConfidenceoptionaldoubleConfidenceoptional*float64#
The rule action updates the `Confidence` field of a finding.
criticalityoptionalnumbercriticalityoptionalint | floatcriticalityoptionalNumberCriticalityoptionaldoubleCriticalityoptional*float64#
The rule action updates the `Criticality` field of a finding.
noteoptionalIResolvable | CfnAutomationRule.NoteUpdatePropertynoteoptionaltyping.Union[IResolvable, NoteUpdateProperty]noteoptionalIResolvableNoteoptionalIResolvableNoteoptionalinterface{}#
The rule action will update the `Note` field of a finding.
relatedFindingsoptionalIResolvable | IResolvable | CfnAutomationRule.RelatedFindingProperty[]related_findingsoptionaltyping.Union[IResolvable, typing.List[typing.Union[IResolvable, RelatedFindingProperty]]]relatedFindingsoptionalIResolvableRelatedFindingsoptionalIResolvableRelatedFindingsoptionalinterface{}#
The rule action will update the `RelatedFindings` field of a finding.
severityoptionalIResolvable | CfnAutomationRule.SeverityUpdatePropertyseverityoptionaltyping.Union[IResolvable, SeverityUpdateProperty]severityoptionalIResolvableSeverityoptionalIResolvableSeverityoptionalinterface{}#
The rule action will update the `Severity` field of a finding.
typesoptionalstring[]typesoptionaltyping.List[str]typesoptionalList<String>Typesoptionalstring[]Typesoptional*[]*string#
The rule action updates the `Types` field of a finding.
userDefinedFieldsoptionalIResolvable | { [key: string]: string }user_defined_fieldsoptionaltyping.Union[IResolvable, typing.Mapping[str, str]]userDefinedFieldsoptionalIResolvableUserDefinedFieldsoptionalIResolvableUserDefinedFieldsoptionalinterface{}#
The rule action updates the `UserDefinedFields` field of a finding.
verificationStateoptionalstringverification_stateoptionalstrverificationStateoptionalStringVerificationStateoptionalstringVerificationStateoptional*string#
The rule action updates the `VerificationState` field of a finding.
workflowoptionalIResolvable | CfnAutomationRule.WorkflowUpdatePropertyworkflowoptionaltyping.Union[IResolvable, WorkflowUpdateProperty]workflowoptionalIResolvableWorkflowoptionalIResolvableWorkflowoptionalinterface{}#
The rule action will update the `Workflow` field of a finding.