interface CfnAutomationRuleV2Props

Language	Type name
.NET	`Amazon.CDK.AWS.SecurityHub.CfnAutomationRuleV2Props`
Go	`github.com/aws/aws-cdk-go/awscdk/v2/awssecurityhub#CfnAutomationRuleV2Props`
Java	`software.amazon.awscdk.services.securityhub.CfnAutomationRuleV2Props`
Python	`aws_cdk.aws_securityhub.CfnAutomationRuleV2Props`
TypeScript	`aws-cdk-lib` » `aws_securityhub` » `CfnAutomationRuleV2Props`

Properties for defining a CfnAutomationRuleV2.

Example

// 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 cfnAutomationRuleV2Props: securityhub.CfnAutomationRuleV2Props = {
  actions: [{
    type: 'type',

    // the properties below are optional
    externalIntegrationConfiguration: {
      connectorArn: 'connectorArn',
    },
    findingFieldsUpdate: {
      comment: 'comment',
      severityId: 123,
      statusId: 123,
    },
  }],
  criteria: {
    ocsfFindingCriteria: {
      compositeFilters: [{
        booleanFilters: [{
          fieldName: 'fieldName',
          filter: {
            value: false,
          },
        }],
        dateFilters: [{
          fieldName: 'fieldName',
          filter: {
            dateRange: {
              unit: 'unit',
              value: 123,
            },
            end: 'end',
            start: 'start',
          },
        }],
        mapFilters: [{
          fieldName: 'fieldName',
          filter: {
            comparison: 'comparison',
            key: 'key',
            value: 'value',
          },
        }],
        numberFilters: [{
          fieldName: 'fieldName',
          filter: {
            eq: 123,
            gte: 123,
            lte: 123,
          },
        }],
        operator: 'operator',
        stringFilters: [{
          fieldName: 'fieldName',
          filter: {
            comparison: 'comparison',
            value: 'value',
          },
        }],
      }],
      compositeOperator: 'compositeOperator',
    },
  },
  description: 'description',
  ruleName: 'ruleName',
  ruleOrder: 123,

  // the properties below are optional
  ruleStatus: 'ruleStatus',
  tags: {
    tagsKey: 'tags',
  },
};

Properties

Name	Type	Description
actions	`IResolvable` `\|` `IResolvable` `\|` `AutomationRulesActionV2Property[]`	A list of actions to be performed when the rule criteria is met.
criteria	`IResolvable` `\|` `CriteriaProperty`	The filtering type and configuration of the automation rule.
description	`string`	A description of the V2 automation rule.
ruleName	`string`	The name of the V2 automation rule.
ruleOrder	`number`	The value for the rule priority.
ruleStatus?	`string`	The status of the V2 automation rule.
tags?	`{ [string]: string }`	A list of key-value pairs associated with the V2 automation rule.

actions

Type: IResolvable | IResolvable | AutomationRulesActionV2Property[]

A list of actions to be performed when the rule criteria is met.

criteria

Type: IResolvable | CriteriaProperty

The filtering type and configuration of the automation rule.

description

Type: string

A description of the V2 automation rule.

ruleName

Type: string

The name of the V2 automation rule.

ruleOrder

Type: number

The value for the rule priority.

ruleStatus?

Type: string (optional)

The status of the V2 automation rule.

tags?

Type: { [string]: string } (optional)

A list of key-value pairs associated with the V2 automation rule.