CfnAutomationRuleV2Props

class aws_cdk.aws_securityhub.CfnAutomationRuleV2Props(*, actions, criteria, description, rule_name, rule_order, rule_status=None, tags=None)

Bases: object

Properties for defining a CfnAutomationRuleV2.

Parameters:
  • actions (Union[IResolvable, Sequence[Union[IResolvable, AutomationRulesActionV2Property, Dict[str, Any]]]]) – A list of actions to be performed when the rule criteria is met.

  • criteria (Union[IResolvable, CriteriaProperty, Dict[str, Any]]) – The filtering type and configuration of the automation rule.

  • description (str) – A description of the V2 automation rule.

  • rule_name (str) – The name of the V2 automation rule.

  • rule_order (Union[int, float]) – The value for the rule priority.

  • rule_status (Optional[str]) – The status of the V2 automation rule.

  • tags (Optional[Mapping[str, str]]) – A list of key-value pairs associated with the V2 automation rule.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-securityhub-automationrulev2.html

ExampleMetadata:

fixture=_generated

Example:

# 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

cfn_automation_rule_v2_props = securityhub.CfnAutomationRuleV2Props(
    actions=[securityhub.CfnAutomationRuleV2.AutomationRulesActionV2Property(
        type="type",

        # the properties below are optional
        external_integration_configuration=securityhub.CfnAutomationRuleV2.ExternalIntegrationConfigurationProperty(
            connector_arn="connectorArn"
        ),
        finding_fields_update=securityhub.CfnAutomationRuleV2.AutomationRulesFindingFieldsUpdateV2Property(
            comment="comment",
            severity_id=123,
            status_id=123
        )
    )],
    criteria=securityhub.CfnAutomationRuleV2.CriteriaProperty(
        ocsf_finding_criteria=securityhub.CfnAutomationRuleV2.OcsfFindingFiltersProperty(
            composite_filters=[securityhub.CfnAutomationRuleV2.CompositeFilterProperty(
                boolean_filters=[securityhub.CfnAutomationRuleV2.OcsfBooleanFilterProperty(
                    field_name="fieldName",
                    filter=securityhub.CfnAutomationRuleV2.BooleanFilterProperty(
                        value=False
                    )
                )],
                date_filters=[securityhub.CfnAutomationRuleV2.OcsfDateFilterProperty(
                    field_name="fieldName",
                    filter=securityhub.CfnAutomationRuleV2.DateFilterProperty(
                        date_range=securityhub.CfnAutomationRuleV2.DateRangeProperty(
                            unit="unit",
                            value=123
                        ),
                        end="end",
                        start="start"
                    )
                )],
                map_filters=[securityhub.CfnAutomationRuleV2.OcsfMapFilterProperty(
                    field_name="fieldName",
                    filter=securityhub.CfnAutomationRuleV2.MapFilterProperty(
                        comparison="comparison",
                        key="key",
                        value="value"
                    )
                )],
                number_filters=[securityhub.CfnAutomationRuleV2.OcsfNumberFilterProperty(
                    field_name="fieldName",
                    filter=securityhub.CfnAutomationRuleV2.NumberFilterProperty(
                        eq=123,
                        gte=123,
                        lte=123
                    )
                )],
                operator="operator",
                string_filters=[securityhub.CfnAutomationRuleV2.OcsfStringFilterProperty(
                    field_name="fieldName",
                    filter=securityhub.CfnAutomationRuleV2.StringFilterProperty(
                        comparison="comparison",
                        value="value"
                    )
                )]
            )],
            composite_operator="compositeOperator"
        )
    ),
    description="description",
    rule_name="ruleName",
    rule_order=123,

    # the properties below are optional
    rule_status="ruleStatus",
    tags={
        "tags_key": "tags"
    }
)

Attributes

actions

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

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-securityhub-automationrulev2.html#cfn-securityhub-automationrulev2-actions

criteria

The filtering type and configuration of the automation rule.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-securityhub-automationrulev2.html#cfn-securityhub-automationrulev2-criteria

description

A description of the V2 automation rule.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-securityhub-automationrulev2.html#cfn-securityhub-automationrulev2-description

rule_name

The name of the V2 automation rule.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-securityhub-automationrulev2.html#cfn-securityhub-automationrulev2-rulename

rule_order

The value for the rule priority.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-securityhub-automationrulev2.html#cfn-securityhub-automationrulev2-ruleorder

rule_status

The status of the V2 automation rule.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-securityhub-automationrulev2.html#cfn-securityhub-automationrulev2-rulestatus

tags

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

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-securityhub-automationrulev2.html#cfn-securityhub-automationrulev2-tags