CfnAutomationRule

class aws_cdk.aws_securityhub.CfnAutomationRule(scope, id, *, actions, criteria, description, rule_name, rule_order, is_terminal=None, rule_status=None, tags=None)

Bases: CfnResource

The AWS::SecurityHub::AutomationRule resource specifies an automation rule based on input parameters.

For more information, see Automation rules in the AWS Security Hub User Guide .

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-securityhub-automationrule.html
CloudformationResource:: AWS::SecurityHub::AutomationRule
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 = securityhub.CfnAutomationRule(self, "MyCfnAutomationRule",
    actions=[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"
    )],
    criteria=securityhub.CfnAutomationRule.AutomationRulesFindingFiltersProperty(
        aws_account_id=[securityhub.CfnAutomationRule.StringFilterProperty(
            comparison="comparison",
            value="value"
        )],
        company_name=[securityhub.CfnAutomationRule.StringFilterProperty(
            comparison="comparison",
            value="value"
        )],
        compliance_associated_standards_id=[securityhub.CfnAutomationRule.StringFilterProperty(
            comparison="comparison",
            value="value"
        )],
        compliance_security_control_id=[securityhub.CfnAutomationRule.StringFilterProperty(
            comparison="comparison",
            value="value"
        )],
        compliance_status=[securityhub.CfnAutomationRule.StringFilterProperty(
            comparison="comparison",
            value="value"
        )],
        confidence=[securityhub.CfnAutomationRule.NumberFilterProperty(
            eq=123,
            gte=123,
            lte=123
        )],
        created_at=[securityhub.CfnAutomationRule.DateFilterProperty(
            date_range=securityhub.CfnAutomationRule.DateRangeProperty(
                unit="unit",
                value=123
            ),
            end="end",
            start="start"
        )],
        criticality=[securityhub.CfnAutomationRule.NumberFilterProperty(
            eq=123,
            gte=123,
            lte=123
        )],
        description=[securityhub.CfnAutomationRule.StringFilterProperty(
            comparison="comparison",
            value="value"
        )],
        first_observed_at=[securityhub.CfnAutomationRule.DateFilterProperty(
            date_range=securityhub.CfnAutomationRule.DateRangeProperty(
                unit="unit",
                value=123
            ),
            end="end",
            start="start"
        )],
        generator_id=[securityhub.CfnAutomationRule.StringFilterProperty(
            comparison="comparison",
            value="value"
        )],
        id=[securityhub.CfnAutomationRule.StringFilterProperty(
            comparison="comparison",
            value="value"
        )],
        last_observed_at=[securityhub.CfnAutomationRule.DateFilterProperty(
            date_range=securityhub.CfnAutomationRule.DateRangeProperty(
                unit="unit",
                value=123
            ),
            end="end",
            start="start"
        )],
        note_text=[securityhub.CfnAutomationRule.StringFilterProperty(
            comparison="comparison",
            value="value"
        )],
        note_updated_at=[securityhub.CfnAutomationRule.DateFilterProperty(
            date_range=securityhub.CfnAutomationRule.DateRangeProperty(
                unit="unit",
                value=123
            ),
            end="end",
            start="start"
        )],
        note_updated_by=[securityhub.CfnAutomationRule.StringFilterProperty(
            comparison="comparison",
            value="value"
        )],
        product_arn=[securityhub.CfnAutomationRule.StringFilterProperty(
            comparison="comparison",
            value="value"
        )],
        product_name=[securityhub.CfnAutomationRule.StringFilterProperty(
            comparison="comparison",
            value="value"
        )],
        record_state=[securityhub.CfnAutomationRule.StringFilterProperty(
            comparison="comparison",
            value="value"
        )],
        related_findings_id=[securityhub.CfnAutomationRule.StringFilterProperty(
            comparison="comparison",
            value="value"
        )],
        related_findings_product_arn=[securityhub.CfnAutomationRule.StringFilterProperty(
            comparison="comparison",
            value="value"
        )],
        resource_details_other=[securityhub.CfnAutomationRule.MapFilterProperty(
            comparison="comparison",
            key="key",
            value="value"
        )],
        resource_id=[securityhub.CfnAutomationRule.StringFilterProperty(
            comparison="comparison",
            value="value"
        )],
        resource_partition=[securityhub.CfnAutomationRule.StringFilterProperty(
            comparison="comparison",
            value="value"
        )],
        resource_region=[securityhub.CfnAutomationRule.StringFilterProperty(
            comparison="comparison",
            value="value"
        )],
        resource_tags=[securityhub.CfnAutomationRule.MapFilterProperty(
            comparison="comparison",
            key="key",
            value="value"
        )],
        resource_type=[securityhub.CfnAutomationRule.StringFilterProperty(
            comparison="comparison",
            value="value"
        )],
        severity_label=[securityhub.CfnAutomationRule.StringFilterProperty(
            comparison="comparison",
            value="value"
        )],
        source_url=[securityhub.CfnAutomationRule.StringFilterProperty(
            comparison="comparison",
            value="value"
        )],
        title=[securityhub.CfnAutomationRule.StringFilterProperty(
            comparison="comparison",
            value="value"
        )],
        type=[securityhub.CfnAutomationRule.StringFilterProperty(
            comparison="comparison",
            value="value"
        )],
        updated_at=[securityhub.CfnAutomationRule.DateFilterProperty(
            date_range=securityhub.CfnAutomationRule.DateRangeProperty(
                unit="unit",
                value=123
            ),
            end="end",
            start="start"
        )],
        user_defined_fields=[securityhub.CfnAutomationRule.MapFilterProperty(
            comparison="comparison",
            key="key",
            value="value"
        )],
        verification_state=[securityhub.CfnAutomationRule.StringFilterProperty(
            comparison="comparison",
            value="value"
        )],
        workflow_status=[securityhub.CfnAutomationRule.StringFilterProperty(
            comparison="comparison",
            value="value"
        )]
    ),
    description="description",
    rule_name="ruleName",
    rule_order=123,

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

Parameters:

scope (Construct) – Scope in which this resource is defined.
id (str) – Construct identifier for this resource (unique in its scope).
actions (Union[IResolvable, Sequence[Union[IResolvable, AutomationRulesActionProperty, Dict[str, Any]]]]) – One or more actions to update finding fields if a finding matches the conditions specified in Criteria .
criteria (Union[IResolvable, AutomationRulesFindingFiltersProperty, Dict[str, Any]]) – A set of AWS Security Finding Format (ASFF) finding field attributes and corresponding expected values that Security Hub uses to filter findings. If a rule is enabled and a finding matches the criteria specified in this parameter, Security Hub applies the rule action to the finding.
description (str) – A description of the rule.
rule_name (str) – The name of the rule.
rule_order (Union[int, float]) – 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.
is_terminal (Union[bool, IResolvable, None]) – Specifies whether a rule is the last to be applied with respect to a finding that matches the rule criteria. This is useful when a finding matches the criteria for multiple rules, and each rule has different actions. If a rule is terminal, Security Hub applies the rule action to a finding that matches the rule criteria and doesn’t evaluate other rules for the finding. By default, a rule isn’t terminal.
rule_status (Optional[str]) – Whether the rule is active after it is created. If this parameter is equal to ENABLED , Security Hub applies the rule to findings and finding updates after the rule is created.
tags (Optional[Mapping[str, str]]) – User-defined tags associated with an automation rule.

Methods

add_deletion_override(path)

Syntactic sugar for addOverride(path, undefined).

Parameters:: path (str) – The path of the value to delete.
Return type:: None

add_dependency(target)

Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.

This can be used for resources across stacks (or nested stack) boundaries and the dependency will automatically be transferred to the relevant scope.

Parameters:: target (CfnResource)
Return type:: None

add_depends_on(target)

(deprecated) Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.

Parameters:: target (CfnResource)
Deprecated:: use addDependency
Stability:: deprecated
Return type:: None

add_metadata(key, value)

Add a value to the CloudFormation Resource Metadata.

Parameters:

key (str)
value (Any)

See:

Return type:

None

https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html

Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.

add_override(path, value)

Adds an override to the synthesized CloudFormation resource.

To add a property override, either use addPropertyOverride or prefix path with “Properties.” (i.e. Properties.TopicName).

If the override is nested, separate each nested level using a dot (.) in the path parameter. If there is an array as part of the nesting, specify the index in the path.

To include a literal . in the property name, prefix with a \. In most programming languages you will need to write this as "\\." because the \ itself will need to be escaped.

For example:

cfn_resource.add_override("Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes", ["myattribute"])
cfn_resource.add_override("Properties.GlobalSecondaryIndexes.1.ProjectionType", "INCLUDE")

would add the overrides Example:

"Properties": {
  "GlobalSecondaryIndexes": [
    {
      "Projection": {
        "NonKeyAttributes": [ "myattribute" ]
        ...
      }
      ...
    },
    {
      "ProjectionType": "INCLUDE"
      ...
    },
  ]
  ...
}

The value argument to addOverride will not be processed or translated in any way. Pass raw JSON values in here with the correct capitalization for CloudFormation. If you pass CDK classes or structs, they will be rendered with lowercased key names, and CloudFormation will reject the template.

Parameters:

path (str) –
- The path of the property, you can use dot notation to override values in complex types. Any intermediate keys will be created as needed.
value (Any) –
- The value. Could be primitive or complex.

Return type:

None

add_property_deletion_override(property_path)

Adds an override that deletes the value of a property from the resource definition.

Parameters:: property_path (str) – The path to the property.
Return type:: None

add_property_override(property_path, value)

Adds an override to a resource property.

Syntactic sugar for addOverride("Properties.<...>", value).

Parameters:

property_path (str) – The path of the property.
value (Any) – The value.

Return type:

None

apply_removal_policy(policy=None, *, apply_to_update_replace_policy=None, default=None)

Sets the deletion policy of the resource based on the removal policy specified.

The Removal Policy controls what happens to this resource when it stops being managed by CloudFormation, either because you’ve removed it from the CDK application or because you’ve made a change that requires the resource to be replaced.

The resource can be deleted (RemovalPolicy.DESTROY), or left in your AWS account for data recovery and cleanup later (RemovalPolicy.RETAIN). In some cases, a snapshot can be taken of the resource prior to deletion (RemovalPolicy.SNAPSHOT). A list of resources that support this policy can be found in the following link:

Parameters:

policy (Optional[RemovalPolicy])
apply_to_update_replace_policy (Optional[bool]) – Apply the same deletion policy to the resource’s “UpdateReplacePolicy”. Default: true
default (Optional[RemovalPolicy]) – The default policy to apply in case the removal policy is not defined. Default: - Default value is resource specific. To determine the default value for a resource, please consult that specific resource’s documentation.

See:

https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-deletionpolicy.html#aws-attribute-deletionpolicy-options

Return type:

None

get_att(attribute_name, type_hint=None)

Returns a token for an runtime attribute of this resource.

Ideally, use generated attribute accessors (e.g. resource.arn), but this can be used for future compatibility in case there is no generated attribute.

Parameters:

attribute_name (str) – The name of the attribute.
type_hint (Optional[ResolutionTypeHint])

Return type:

Reference

get_metadata(key)

Retrieve a value value from the CloudFormation Resource Metadata.

Parameters:: key (str)
See:
Return type:: Any

https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html

Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.

inspect(inspector)

Examines the CloudFormation resource and discloses attributes.

Parameters:: inspector (TreeInspector) – tree inspector to collect and process attributes.
Return type:: None

obtain_dependencies()

Retrieves an array of resources this resource depends on.

This assembles dependencies on resources across stacks (including nested stacks) automatically.

Return type:: List[Union[Stack, CfnResource]]

obtain_resource_dependencies()

Get a shallow copy of dependencies between this resource and other resources in the same stack.

Return type:: List[CfnResource]

override_logical_id(new_logical_id)

Overrides the auto-generated logical ID with a specific ID.

Parameters:: new_logical_id (str) – The new logical ID to use for this stack element.
Return type:: None

remove_dependency(target)

Indicates that this resource no longer depends on another resource.

This can be used for resources across stacks (including nested stacks) and the dependency will automatically be removed from the relevant scope.

Parameters:: target (CfnResource)
Return type:: None

replace_dependency(target, new_target)

Replaces one dependency with another.

Parameters:

target (CfnResource) – The dependency to replace.
new_target (CfnResource) – The new dependency to add.

Return type:

None

to_string()

Returns a string representation of this construct.

Return type:: str
Returns:: a string representation of this resource

Attributes

CFN_RESOURCE_TYPE_NAME = 'AWS::SecurityHub::AutomationRule'

actions: One or more actions to update finding fields if a finding matches the conditions specified in Criteria .

attr_created_at

A timestamp that indicates when the rule was created.

Uses the date-time format specified in RFC 3339 section 5.6, Internet Date/Time Format . The value cannot contain spaces. For example, 2020-03-22T13:22:13.933Z .

CloudformationAttribute:: CreatedAt

attr_created_by

The principal that created the rule.

For example, arn:aws:sts::123456789012:assumed-role/Developer-Role/JaneDoe .

CloudformationAttribute:: CreatedBy

attr_rule_arn

The Amazon Resource Name (ARN) of the automation rule that you create.

For example, arn:aws:securityhub:us-east-1:123456789012:automation-rule/a1b2c3d4-5678-90ab-cdef-EXAMPLE11111 .

CloudformationAttribute:: RuleArn

attr_updated_at

A timestamp that indicates when the rule was most recently updated.

Uses the date-time format specified in RFC 3339 section 5.6, Internet Date/Time Format . The value cannot contain spaces. For example, 2020-03-22T13:22:13.933Z .

CloudformationAttribute:: UpdatedAt

automation_rule_ref: A reference to a AutomationRule resource.

cdk_tag_manager: Tag Manager which manages the tags for this resource.

cfn_options: Options for this resource, such as condition, update policy etc.

cfn_resource_type: AWS resource type.

creation_stack

return:

the stack trace of the point where this Resource was created from, sourced from the +metadata+ entry typed +aws:cdk:logicalId+, and with the bottom-most node +internal+ entries filtered.

criteria: A set of AWS Security Finding Format (ASFF) finding field attributes and corresponding expected values that Security Hub uses to filter findings. If a rule is enabled and a finding matches the criteria specified in this parameter, Security Hub applies the rule action to the finding.

description: A description of the rule.

is_terminal: Specifies whether a rule is the last to be applied with respect to a finding that matches the rule criteria.

logical_id

The logical ID for this CloudFormation stack element.

The logical ID of the element is calculated from the path of the resource node in the construct tree.

To override this value, use overrideLogicalId(newLogicalId).

Returns:

the logical ID as a stringified token. This value will only get resolved during synthesis.

node: The tree node.

ref

Return a string that will be resolved to a CloudFormation { Ref } for this element.

If, by any chance, the intrinsic reference of a resource is not a string, you could coerce it to an IResolvable through Lazy.any({ produce: resource.ref }).

rule_name: The name of the rule.

rule_order: An integer ranging from 1 to 1000 that represents the order in which the rule action is applied to findings.

rule_status: Whether the rule is active after it is created.

stack

The stack in which this element is defined.

CfnElements must be defined within a stack scope (directly or indirectly).

tags: User-defined tags associated with an automation rule.

Static Methods

classmethod is_cfn_element(x)

Returns true if a construct is a stack element (i.e. part of the synthesized cloudformation template).

Uses duck-typing instead of instanceof to allow stack elements from different versions of this library to be included in the same stack.

Parameters:: x (Any)
Return type:: bool
Returns:: The construct as a stack element or undefined if it is not a stack element.

classmethod is_cfn_resource(x)

Check whether the given object is a CfnResource.

Parameters:: x (Any)
Return type:: bool

classmethod is_construct(x)

Checks if x is a construct.

Use this method instead of instanceof to properly detect Construct instances, even when the construct library is symlinked.

Explanation: in JavaScript, multiple copies of the constructs library on disk are seen as independent, completely different libraries. As a consequence, the class Construct in each copy of the constructs library is seen as a different class, and an instance of one class will not test as instanceof the other class. npm install will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the constructs library can be accidentally installed, and instanceof will behave unpredictably. It is safest to avoid using instanceof, and using this type-testing method instead.

Parameters:: x (Any) – Any object.
Return type:: bool
Returns:: true if x is an object created from a class which extends Construct.

AutomationRulesActionProperty

class CfnAutomationRule.AutomationRulesActionProperty(*, finding_fields_update, type)

Bases: object

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

Parameters:

finding_fields_update (Union[IResolvable, AutomationRulesFindingFieldsUpdateProperty, Dict[str, Any]]) – Specifies that the automation rule action is an update to a finding field.
type (str) – Specifies the type of action that Security Hub takes when a finding matches the defined criteria of a rule.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-securityhub-automationrule-automationrulesaction.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

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"
)

Attributes

finding_fields_update

Specifies that the automation rule action is an update to a finding field.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-securityhub-automationrule-automationrulesaction.html#cfn-securityhub-automationrule-automationrulesaction-findingfieldsupdate

type

Specifies the type of action that Security Hub takes when a finding matches the defined criteria of a rule.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-securityhub-automationrule-automationrulesaction.html#cfn-securityhub-automationrule-automationrulesaction-type

AutomationRulesFindingFieldsUpdateProperty

class CfnAutomationRule.AutomationRulesFindingFieldsUpdateProperty(*, confidence=None, criticality=None, note=None, related_findings=None, severity=None, types=None, user_defined_fields=None, verification_state=None, workflow=None)

Bases: object

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

Parameters:

confidence (Union[int, float, None]) – The rule action updates the Confidence field of a finding.
criticality (Union[int, float, None]) – The rule action updates the Criticality field of a finding.
note (Union[IResolvable, NoteUpdateProperty, Dict[str, Any], None]) – The rule action will update the Note field of a finding.
related_findings (Union[IResolvable, Sequence[Union[IResolvable, RelatedFindingProperty, Dict[str, Any]]], None]) – The rule action will update the RelatedFindings field of a finding.
severity (Union[IResolvable, SeverityUpdateProperty, Dict[str, Any], None]) – The rule action will update the Severity field of a finding.
types (Optional[Sequence[str]]) – The rule action updates the Types field of a finding.
user_defined_fields (Union[Mapping[str, str], IResolvable, None]) – The rule action updates the UserDefinedFields field of a finding.
verification_state (Optional[str]) – The rule action updates the VerificationState field of a finding.
workflow (Union[IResolvable, WorkflowUpdateProperty, Dict[str, Any], None]) – The rule action will update the Workflow field of a finding.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-securityhub-automationrule-automationrulesfindingfieldsupdate.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

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"
    )
)

Attributes

confidence

The rule action updates the Confidence field of a finding.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-securityhub-automationrule-automationrulesfindingfieldsupdate.html#cfn-securityhub-automationrule-automationrulesfindingfieldsupdate-confidence

criticality

The rule action updates the Criticality field of a finding.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-securityhub-automationrule-automationrulesfindingfieldsupdate.html#cfn-securityhub-automationrule-automationrulesfindingfieldsupdate-criticality

note

The rule action will update the Note field of a finding.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-securityhub-automationrule-automationrulesfindingfieldsupdate.html#cfn-securityhub-automationrule-automationrulesfindingfieldsupdate-note

related_findings

The rule action will update the RelatedFindings field of a finding.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-securityhub-automationrule-automationrulesfindingfieldsupdate.html#cfn-securityhub-automationrule-automationrulesfindingfieldsupdate-relatedfindings

severity

The rule action will update the Severity field of a finding.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-securityhub-automationrule-automationrulesfindingfieldsupdate.html#cfn-securityhub-automationrule-automationrulesfindingfieldsupdate-severity

types

The rule action updates the Types field of a finding.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-securityhub-automationrule-automationrulesfindingfieldsupdate.html#cfn-securityhub-automationrule-automationrulesfindingfieldsupdate-types

user_defined_fields

The rule action updates the UserDefinedFields field of a finding.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-securityhub-automationrule-automationrulesfindingfieldsupdate.html#cfn-securityhub-automationrule-automationrulesfindingfieldsupdate-userdefinedfields

verification_state

The rule action updates the VerificationState field of a finding.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-securityhub-automationrule-automationrulesfindingfieldsupdate.html#cfn-securityhub-automationrule-automationrulesfindingfieldsupdate-verificationstate

workflow

The rule action will update the Workflow field of a finding.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-securityhub-automationrule-automationrulesfindingfieldsupdate.html#cfn-securityhub-automationrule-automationrulesfindingfieldsupdate-workflow

AutomationRulesFindingFiltersProperty

class CfnAutomationRule.AutomationRulesFindingFiltersProperty(*, aws_account_id=None, company_name=None, compliance_associated_standards_id=None, compliance_security_control_id=None, compliance_status=None, confidence=None, created_at=None, criticality=None, description=None, first_observed_at=None, generator_id=None, id=None, last_observed_at=None, note_text=None, note_updated_at=None, note_updated_by=None, product_arn=None, product_name=None, record_state=None, related_findings_id=None, related_findings_product_arn=None, resource_details_other=None, resource_id=None, resource_partition=None, resource_region=None, resource_tags=None, resource_type=None, severity_label=None, source_url=None, title=None, type=None, updated_at=None, user_defined_fields=None, verification_state=None, workflow_status=None)

Bases: object

The criteria that determine which findings a rule applies to.

Parameters:

aws_account_id (Union[IResolvable, Sequence[Union[IResolvable, StringFilterProperty, Dict[str, Any]]], None]) – The AWS account ID in which a finding was generated. Array Members: Minimum number of 1 item. Maximum number of 100 items.
company_name (Union[IResolvable, Sequence[Union[IResolvable, StringFilterProperty, Dict[str, Any]]], None]) – The name of the company for the product that generated the finding. For control-based findings, the company is AWS . Array Members: Minimum number of 1 item. Maximum number of 20 items.
compliance_associated_standards_id (Union[IResolvable, Sequence[Union[IResolvable, StringFilterProperty, Dict[str, Any]]], None]) – The unique identifier of a standard in which a control is enabled. This field consists of the resource portion of the Amazon Resource Name (ARN) returned for a standard in the DescribeStandards API response. Array Members: Minimum number of 1 item. Maximum number of 20 items.
compliance_security_control_id (Union[IResolvable, Sequence[Union[IResolvable, StringFilterProperty, Dict[str, Any]]], None]) – The security control ID for which a finding was generated. Security control IDs are the same across standards. Array Members: Minimum number of 1 item. Maximum number of 20 items.
compliance_status (Union[IResolvable, Sequence[Union[IResolvable, StringFilterProperty, Dict[str, Any]]], None]) – The result of a security check. This field is only used for findings generated from controls. Array Members: Minimum number of 1 item. Maximum number of 20 items.
confidence (Union[IResolvable, Sequence[Union[IResolvable, NumberFilterProperty, Dict[str, Any]]], None]) – The likelihood that a finding accurately identifies the behavior or issue that it was intended to identify. Confidence is scored on a 0–100 basis using a ratio scale. A value of 0 means 0 percent confidence, and a value of 100 means 100 percent confidence. For example, a data exfiltration detection based on a statistical deviation of network traffic has low confidence because an actual exfiltration hasn’t been verified. For more information, see Confidence in the AWS Security Hub User Guide . Array Members: Minimum number of 1 item. Maximum number of 20 items.
created_at (Union[IResolvable, Sequence[Union[IResolvable, DateFilterProperty, Dict[str, Any]]], None]) – A timestamp that indicates when this finding record was created. For more information about the validation and formatting of timestamp fields in AWS Security Hub , see Timestamps . Array Members: Minimum number of 1 item. Maximum number of 20 items.
criticality (Union[IResolvable, Sequence[Union[IResolvable, NumberFilterProperty, Dict[str, Any]]], None]) – The level of importance that is assigned to the resources that are associated with a finding. Criticality is scored on a 0–100 basis, using a ratio scale that supports only full integers. A score of 0 means that the underlying resources have no criticality, and a score of 100 is reserved for the most critical resources. For more information, see Criticality in the AWS Security Hub User Guide . Array Members: Minimum number of 1 item. Maximum number of 20 items.
description (Union[IResolvable, Sequence[Union[IResolvable, StringFilterProperty, Dict[str, Any]]], None]) – A finding’s description. Array Members: Minimum number of 1 item. Maximum number of 20 items.
first_observed_at (Union[IResolvable, Sequence[Union[IResolvable, DateFilterProperty, Dict[str, Any]]], None]) –
A timestamp that indicates when the potential security issue captured by a finding was first observed by the security findings product. For more information about the validation and formatting of timestamp fields in AWS Security Hub , see Timestamps . Array Members: Minimum number of 1 item. Maximum number of 20 items.
generator_id (Union[IResolvable, Sequence[Union[IResolvable, StringFilterProperty, Dict[str, Any]]], None]) – The identifier for the solution-specific component that generated a finding. Array Members: Minimum number of 1 item. Maximum number of 100 items.
id (Union[IResolvable, Sequence[Union[IResolvable, StringFilterProperty, Dict[str, Any]]], None]) – The product-specific identifier for a finding. Array Members: Minimum number of 1 item. Maximum number of 20 items.
last_observed_at (Union[IResolvable, Sequence[Union[IResolvable, DateFilterProperty, Dict[str, Any]]], None]) –
A timestamp that indicates when the security findings provider most recently observed a change in the resource that is involved in the finding. For more information about the validation and formatting of timestamp fields in AWS Security Hub , see Timestamps . Array Members: Minimum number of 1 item. Maximum number of 20 items.
note_text (Union[IResolvable, Sequence[Union[IResolvable, StringFilterProperty, Dict[str, Any]]], None]) – The text of a user-defined note that’s added to a finding. Array Members: Minimum number of 1 item. Maximum number of 20 items.
note_updated_at (Union[IResolvable, Sequence[Union[IResolvable, DateFilterProperty, Dict[str, Any]]], None]) –
The timestamp of when the note was updated. For more information about the validation and formatting of timestamp fields in AWS Security Hub , see Timestamps . Array Members: Minimum number of 1 item. Maximum number of 20 items.
note_updated_by (Union[IResolvable, Sequence[Union[IResolvable, StringFilterProperty, Dict[str, Any]]], None]) – The principal that created a note. Array Members: Minimum number of 1 item. Maximum number of 20 items.
product_arn (Union[IResolvable, Sequence[Union[IResolvable, StringFilterProperty, Dict[str, Any]]], None]) – The Amazon Resource Name (ARN) for a third-party product that generated a finding in Security Hub. Array Members: Minimum number of 1 item. Maximum number of 20 items.
product_name (Union[IResolvable, Sequence[Union[IResolvable, StringFilterProperty, Dict[str, Any]]], None]) – Provides the name of the product that generated the finding. For control-based findings, the product name is Security Hub. Array Members: Minimum number of 1 item. Maximum number of 20 items.
record_state (Union[IResolvable, Sequence[Union[IResolvable, StringFilterProperty, Dict[str, Any]]], None]) – Provides the current state of a finding. Array Members: Minimum number of 1 item. Maximum number of 20 items.
related_findings_id (Union[IResolvable, Sequence[Union[IResolvable, StringFilterProperty, Dict[str, Any]]], None]) – The product-generated identifier for a related finding. Array Members: Minimum number of 1 item. Maximum number of 20 items.
related_findings_product_arn (Union[IResolvable, Sequence[Union[IResolvable, StringFilterProperty, Dict[str, Any]]], None]) – The ARN for the product that generated a related finding. Array Members: Minimum number of 1 item. Maximum number of 20 items.
resource_details_other (Union[IResolvable, Sequence[Union[IResolvable, MapFilterProperty, Dict[str, Any]]], None]) – Custom fields and values about the resource that a finding pertains to. Array Members: Minimum number of 1 item. Maximum number of 20 items.
resource_id (Union[IResolvable, Sequence[Union[IResolvable, StringFilterProperty, Dict[str, Any]]], None]) – The identifier for the given resource type. For AWS resources that are identified by Amazon Resource Names (ARNs), this is the ARN. For AWS resources that lack ARNs, this is the identifier as defined by the AWS service that created the resource. For non- AWS resources, this is a unique identifier that is associated with the resource. Array Members: Minimum number of 1 item. Maximum number of 100 items.
resource_partition (Union[IResolvable, Sequence[Union[IResolvable, StringFilterProperty, Dict[str, Any]]], None]) – The partition in which the resource that the finding pertains to is located. A partition is a group of AWS Regions . Each AWS account is scoped to one partition. Array Members: Minimum number of 1 item. Maximum number of 20 items.
resource_region (Union[IResolvable, Sequence[Union[IResolvable, StringFilterProperty, Dict[str, Any]]], None]) – The AWS Region where the resource that a finding pertains to is located. Array Members: Minimum number of 1 item. Maximum number of 20 items.
resource_tags (Union[IResolvable, Sequence[Union[IResolvable, MapFilterProperty, Dict[str, Any]]], None]) – A list of AWS tags associated with a resource at the time the finding was processed. Array Members: Minimum number of 1 item. Maximum number of 20 items.
resource_type (Union[IResolvable, Sequence[Union[IResolvable, StringFilterProperty, Dict[str, Any]]], None]) – A finding’s title. Array Members: Minimum number of 1 item. Maximum number of 100 items.
severity_label (Union[IResolvable, Sequence[Union[IResolvable, StringFilterProperty, Dict[str, Any]]], None]) – The severity value of the finding. Array Members: Minimum number of 1 item. Maximum number of 20 items.
source_url (Union[IResolvable, Sequence[Union[IResolvable, StringFilterProperty, Dict[str, Any]]], None]) – Provides a URL that links to a page about the current finding in the finding product. Array Members: Minimum number of 1 item. Maximum number of 20 items.
title (Union[IResolvable, Sequence[Union[IResolvable, StringFilterProperty, Dict[str, Any]]], None]) – A finding’s title. Array Members: Minimum number of 1 item. Maximum number of 100 items.
type (Union[IResolvable, Sequence[Union[IResolvable, StringFilterProperty, Dict[str, Any]]], None]) – One or more finding types in the format of namespace/category/classifier that classify a finding. For a list of namespaces, classifiers, and categories, see Types taxonomy for ASFF in the AWS Security Hub User Guide . Array Members: Minimum number of 1 item. Maximum number of 20 items.
updated_at (Union[IResolvable, Sequence[Union[IResolvable, DateFilterProperty, Dict[str, Any]]], None]) –
A timestamp that indicates when the finding record was most recently updated. For more information about the validation and formatting of timestamp fields in AWS Security Hub , see Timestamps . Array Members: Minimum number of 1 item. Maximum number of 20 items.
user_defined_fields (Union[IResolvable, Sequence[Union[IResolvable, MapFilterProperty, Dict[str, Any]]], None]) – A list of user-defined name and value string pairs added to a finding. Array Members: Minimum number of 1 item. Maximum number of 20 items.
verification_state (Union[IResolvable, Sequence[Union[IResolvable, StringFilterProperty, Dict[str, Any]]], None]) – Provides the veracity of a finding. Array Members: Minimum number of 1 item. Maximum number of 20 items.
workflow_status (Union[IResolvable, Sequence[Union[IResolvable, StringFilterProperty, Dict[str, Any]]], None]) – Provides information about the status of the investigation into a finding. Array Members: Minimum number of 1 item. Maximum number of 20 items.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-securityhub-automationrule-automationrulesfindingfilters.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

automation_rules_finding_filters_property = securityhub.CfnAutomationRule.AutomationRulesFindingFiltersProperty(
    aws_account_id=[securityhub.CfnAutomationRule.StringFilterProperty(
        comparison="comparison",
        value="value"
    )],
    company_name=[securityhub.CfnAutomationRule.StringFilterProperty(
        comparison="comparison",
        value="value"
    )],
    compliance_associated_standards_id=[securityhub.CfnAutomationRule.StringFilterProperty(
        comparison="comparison",
        value="value"
    )],
    compliance_security_control_id=[securityhub.CfnAutomationRule.StringFilterProperty(
        comparison="comparison",
        value="value"
    )],
    compliance_status=[securityhub.CfnAutomationRule.StringFilterProperty(
        comparison="comparison",
        value="value"
    )],
    confidence=[securityhub.CfnAutomationRule.NumberFilterProperty(
        eq=123,
        gte=123,
        lte=123
    )],
    created_at=[securityhub.CfnAutomationRule.DateFilterProperty(
        date_range=securityhub.CfnAutomationRule.DateRangeProperty(
            unit="unit",
            value=123
        ),
        end="end",
        start="start"
    )],
    criticality=[securityhub.CfnAutomationRule.NumberFilterProperty(
        eq=123,
        gte=123,
        lte=123
    )],
    description=[securityhub.CfnAutomationRule.StringFilterProperty(
        comparison="comparison",
        value="value"
    )],
    first_observed_at=[securityhub.CfnAutomationRule.DateFilterProperty(
        date_range=securityhub.CfnAutomationRule.DateRangeProperty(
            unit="unit",
            value=123
        ),
        end="end",
        start="start"
    )],
    generator_id=[securityhub.CfnAutomationRule.StringFilterProperty(
        comparison="comparison",
        value="value"
    )],
    id=[securityhub.CfnAutomationRule.StringFilterProperty(
        comparison="comparison",
        value="value"
    )],
    last_observed_at=[securityhub.CfnAutomationRule.DateFilterProperty(
        date_range=securityhub.CfnAutomationRule.DateRangeProperty(
            unit="unit",
            value=123
        ),
        end="end",
        start="start"
    )],
    note_text=[securityhub.CfnAutomationRule.StringFilterProperty(
        comparison="comparison",
        value="value"
    )],
    note_updated_at=[securityhub.CfnAutomationRule.DateFilterProperty(
        date_range=securityhub.CfnAutomationRule.DateRangeProperty(
            unit="unit",
            value=123
        ),
        end="end",
        start="start"
    )],
    note_updated_by=[securityhub.CfnAutomationRule.StringFilterProperty(
        comparison="comparison",
        value="value"
    )],
    product_arn=[securityhub.CfnAutomationRule.StringFilterProperty(
        comparison="comparison",
        value="value"
    )],
    product_name=[securityhub.CfnAutomationRule.StringFilterProperty(
        comparison="comparison",
        value="value"
    )],
    record_state=[securityhub.CfnAutomationRule.StringFilterProperty(
        comparison="comparison",
        value="value"
    )],
    related_findings_id=[securityhub.CfnAutomationRule.StringFilterProperty(
        comparison="comparison",
        value="value"
    )],
    related_findings_product_arn=[securityhub.CfnAutomationRule.StringFilterProperty(
        comparison="comparison",
        value="value"
    )],
    resource_details_other=[securityhub.CfnAutomationRule.MapFilterProperty(
        comparison="comparison",
        key="key",
        value="value"
    )],
    resource_id=[securityhub.CfnAutomationRule.StringFilterProperty(
        comparison="comparison",
        value="value"
    )],
    resource_partition=[securityhub.CfnAutomationRule.StringFilterProperty(
        comparison="comparison",
        value="value"
    )],
    resource_region=[securityhub.CfnAutomationRule.StringFilterProperty(
        comparison="comparison",
        value="value"
    )],
    resource_tags=[securityhub.CfnAutomationRule.MapFilterProperty(
        comparison="comparison",
        key="key",
        value="value"
    )],
    resource_type=[securityhub.CfnAutomationRule.StringFilterProperty(
        comparison="comparison",
        value="value"
    )],
    severity_label=[securityhub.CfnAutomationRule.StringFilterProperty(
        comparison="comparison",
        value="value"
    )],
    source_url=[securityhub.CfnAutomationRule.StringFilterProperty(
        comparison="comparison",
        value="value"
    )],
    title=[securityhub.CfnAutomationRule.StringFilterProperty(
        comparison="comparison",
        value="value"
    )],
    type=[securityhub.CfnAutomationRule.StringFilterProperty(
        comparison="comparison",
        value="value"
    )],
    updated_at=[securityhub.CfnAutomationRule.DateFilterProperty(
        date_range=securityhub.CfnAutomationRule.DateRangeProperty(
            unit="unit",
            value=123
        ),
        end="end",
        start="start"
    )],
    user_defined_fields=[securityhub.CfnAutomationRule.MapFilterProperty(
        comparison="comparison",
        key="key",
        value="value"
    )],
    verification_state=[securityhub.CfnAutomationRule.StringFilterProperty(
        comparison="comparison",
        value="value"
    )],
    workflow_status=[securityhub.CfnAutomationRule.StringFilterProperty(
        comparison="comparison",
        value="value"
    )]
)

Attributes

aws_account_id

The AWS account ID in which a finding was generated.

Array Members: Minimum number of 1 item. Maximum number of 100 items.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-securityhub-automationrule-automationrulesfindingfilters.html#cfn-securityhub-automationrule-automationrulesfindingfilters-awsaccountid

company_name

The name of the company for the product that generated the finding.

For control-based findings, the company is AWS .

Array Members: Minimum number of 1 item. Maximum number of 20 items.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-securityhub-automationrule-automationrulesfindingfilters.html#cfn-securityhub-automationrule-automationrulesfindingfilters-companyname

compliance_associated_standards_id

The unique identifier of a standard in which a control is enabled.

This field consists of the resource portion of the Amazon Resource Name (ARN) returned for a standard in the DescribeStandards API response.

Array Members: Minimum number of 1 item. Maximum number of 20 items.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-securityhub-automationrule-automationrulesfindingfilters.html#cfn-securityhub-automationrule-automationrulesfindingfilters-complianceassociatedstandardsid

compliance_security_control_id

The security control ID for which a finding was generated. Security control IDs are the same across standards.

Array Members: Minimum number of 1 item. Maximum number of 20 items.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-securityhub-automationrule-automationrulesfindingfilters.html#cfn-securityhub-automationrule-automationrulesfindingfilters-compliancesecuritycontrolid

compliance_status

The result of a security check. This field is only used for findings generated from controls.

Array Members: Minimum number of 1 item. Maximum number of 20 items.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-securityhub-automationrule-automationrulesfindingfilters.html#cfn-securityhub-automationrule-automationrulesfindingfilters-compliancestatus

confidence

The likelihood that a finding accurately identifies the behavior or issue that it was intended to identify.

Confidence is scored on a 0–100 basis using a ratio scale. A value of 0 means 0 percent confidence, and a value of 100 means 100 percent confidence. For example, a data exfiltration detection based on a statistical deviation of network traffic has low confidence because an actual exfiltration hasn’t been verified. For more information, see Confidence in the AWS Security Hub User Guide .

Array Members: Minimum number of 1 item. Maximum number of 20 items.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-securityhub-automationrule-automationrulesfindingfilters.html#cfn-securityhub-automationrule-automationrulesfindingfilters-confidence

created_at

A timestamp that indicates when this finding record was created.

For more information about the validation and formatting of timestamp fields in AWS Security Hub , see Timestamps .

Array Members: Minimum number of 1 item. Maximum number of 20 items.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-securityhub-automationrule-automationrulesfindingfilters.html#cfn-securityhub-automationrule-automationrulesfindingfilters-createdat

criticality

The level of importance that is assigned to the resources that are associated with a finding.

Criticality is scored on a 0–100 basis, using a ratio scale that supports only full integers. A score of 0 means that the underlying resources have no criticality, and a score of 100 is reserved for the most critical resources. For more information, see Criticality in the AWS Security Hub User Guide .

Array Members: Minimum number of 1 item. Maximum number of 20 items.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-securityhub-automationrule-automationrulesfindingfilters.html#cfn-securityhub-automationrule-automationrulesfindingfilters-criticality

description

A finding’s description.

Array Members: Minimum number of 1 item. Maximum number of 20 items.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-securityhub-automationrule-automationrulesfindingfilters.html#cfn-securityhub-automationrule-automationrulesfindingfilters-description

first_observed_at

A timestamp that indicates when the potential security issue captured by a finding was first observed by the security findings product.

For more information about the validation and formatting of timestamp fields in AWS Security Hub , see Timestamps .

Array Members: Minimum number of 1 item. Maximum number of 20 items.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-securityhub-automationrule-automationrulesfindingfilters.html#cfn-securityhub-automationrule-automationrulesfindingfilters-firstobservedat

generator_id

The identifier for the solution-specific component that generated a finding.

Array Members: Minimum number of 1 item. Maximum number of 100 items.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-securityhub-automationrule-automationrulesfindingfilters.html#cfn-securityhub-automationrule-automationrulesfindingfilters-generatorid

id

The product-specific identifier for a finding.

Array Members: Minimum number of 1 item. Maximum number of 20 items.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-securityhub-automationrule-automationrulesfindingfilters.html#cfn-securityhub-automationrule-automationrulesfindingfilters-id

last_observed_at

A timestamp that indicates when the security findings provider most recently observed a change in the resource that is involved in the finding.

For more information about the validation and formatting of timestamp fields in AWS Security Hub , see Timestamps .

Array Members: Minimum number of 1 item. Maximum number of 20 items.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-securityhub-automationrule-automationrulesfindingfilters.html#cfn-securityhub-automationrule-automationrulesfindingfilters-lastobservedat

note_text

The text of a user-defined note that’s added to a finding.

Array Members: Minimum number of 1 item. Maximum number of 20 items.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-securityhub-automationrule-automationrulesfindingfilters.html#cfn-securityhub-automationrule-automationrulesfindingfilters-notetext

note_updated_at

The timestamp of when the note was updated.

For more information about the validation and formatting of timestamp fields in AWS Security Hub , see Timestamps .

Array Members: Minimum number of 1 item. Maximum number of 20 items.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-securityhub-automationrule-automationrulesfindingfilters.html#cfn-securityhub-automationrule-automationrulesfindingfilters-noteupdatedat

note_updated_by

The principal that created a note.

Array Members: Minimum number of 1 item. Maximum number of 20 items.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-securityhub-automationrule-automationrulesfindingfilters.html#cfn-securityhub-automationrule-automationrulesfindingfilters-noteupdatedby

product_arn

The Amazon Resource Name (ARN) for a third-party product that generated a finding in Security Hub.

Array Members: Minimum number of 1 item. Maximum number of 20 items.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-securityhub-automationrule-automationrulesfindingfilters.html#cfn-securityhub-automationrule-automationrulesfindingfilters-productarn

product_name

Provides the name of the product that generated the finding. For control-based findings, the product name is Security Hub.

Array Members: Minimum number of 1 item. Maximum number of 20 items.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-securityhub-automationrule-automationrulesfindingfilters.html#cfn-securityhub-automationrule-automationrulesfindingfilters-productname

record_state

Provides the current state of a finding.

Array Members: Minimum number of 1 item. Maximum number of 20 items.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-securityhub-automationrule-automationrulesfindingfilters.html#cfn-securityhub-automationrule-automationrulesfindingfilters-recordstate

related_findings_id

The product-generated identifier for a related finding.

Array Members: Minimum number of 1 item. Maximum number of 20 items.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-securityhub-automationrule-automationrulesfindingfilters.html#cfn-securityhub-automationrule-automationrulesfindingfilters-relatedfindingsid

related_findings_product_arn

The ARN for the product that generated a related finding.

Array Members: Minimum number of 1 item. Maximum number of 20 items.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-securityhub-automationrule-automationrulesfindingfilters.html#cfn-securityhub-automationrule-automationrulesfindingfilters-relatedfindingsproductarn

resource_details_other

Custom fields and values about the resource that a finding pertains to.

Array Members: Minimum number of 1 item. Maximum number of 20 items.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-securityhub-automationrule-automationrulesfindingfilters.html#cfn-securityhub-automationrule-automationrulesfindingfilters-resourcedetailsother

resource_id

The identifier for the given resource type.

For AWS resources that are identified by Amazon Resource Names (ARNs), this is the ARN. For AWS resources that lack ARNs, this is the identifier as defined by the AWS service that created the resource. For non- AWS resources, this is a unique identifier that is associated with the resource.

Array Members: Minimum number of 1 item. Maximum number of 100 items.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-securityhub-automationrule-automationrulesfindingfilters.html#cfn-securityhub-automationrule-automationrulesfindingfilters-resourceid

resource_partition

The partition in which the resource that the finding pertains to is located.

A partition is a group of AWS Regions . Each AWS account is scoped to one partition.

Array Members: Minimum number of 1 item. Maximum number of 20 items.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-securityhub-automationrule-automationrulesfindingfilters.html#cfn-securityhub-automationrule-automationrulesfindingfilters-resourcepartition

resource_region

The AWS Region where the resource that a finding pertains to is located.

Array Members: Minimum number of 1 item. Maximum number of 20 items.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-securityhub-automationrule-automationrulesfindingfilters.html#cfn-securityhub-automationrule-automationrulesfindingfilters-resourceregion

resource_tags

A list of AWS tags associated with a resource at the time the finding was processed.

Array Members: Minimum number of 1 item. Maximum number of 20 items.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-securityhub-automationrule-automationrulesfindingfilters.html#cfn-securityhub-automationrule-automationrulesfindingfilters-resourcetags

resource_type

A finding’s title.

Array Members: Minimum number of 1 item. Maximum number of 100 items.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-securityhub-automationrule-automationrulesfindingfilters.html#cfn-securityhub-automationrule-automationrulesfindingfilters-resourcetype

severity_label

The severity value of the finding.

Array Members: Minimum number of 1 item. Maximum number of 20 items.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-securityhub-automationrule-automationrulesfindingfilters.html#cfn-securityhub-automationrule-automationrulesfindingfilters-severitylabel

source_url

Provides a URL that links to a page about the current finding in the finding product.

Array Members: Minimum number of 1 item. Maximum number of 20 items.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-securityhub-automationrule-automationrulesfindingfilters.html#cfn-securityhub-automationrule-automationrulesfindingfilters-sourceurl

title

A finding’s title.

Array Members: Minimum number of 1 item. Maximum number of 100 items.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-securityhub-automationrule-automationrulesfindingfilters.html#cfn-securityhub-automationrule-automationrulesfindingfilters-title

type

One or more finding types in the format of namespace/category/classifier that classify a finding.

For a list of namespaces, classifiers, and categories, see Types taxonomy for ASFF in the AWS Security Hub User Guide .

Array Members: Minimum number of 1 item. Maximum number of 20 items.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-securityhub-automationrule-automationrulesfindingfilters.html#cfn-securityhub-automationrule-automationrulesfindingfilters-type

updated_at

A timestamp that indicates when the finding record was most recently updated.

For more information about the validation and formatting of timestamp fields in AWS Security Hub , see Timestamps .

Array Members: Minimum number of 1 item. Maximum number of 20 items.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-securityhub-automationrule-automationrulesfindingfilters.html#cfn-securityhub-automationrule-automationrulesfindingfilters-updatedat

user_defined_fields

A list of user-defined name and value string pairs added to a finding.

Array Members: Minimum number of 1 item. Maximum number of 20 items.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-securityhub-automationrule-automationrulesfindingfilters.html#cfn-securityhub-automationrule-automationrulesfindingfilters-userdefinedfields

verification_state

Provides the veracity of a finding.

Array Members: Minimum number of 1 item. Maximum number of 20 items.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-securityhub-automationrule-automationrulesfindingfilters.html#cfn-securityhub-automationrule-automationrulesfindingfilters-verificationstate

workflow_status

Provides information about the status of the investigation into a finding.

Array Members: Minimum number of 1 item. Maximum number of 20 items.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-securityhub-automationrule-automationrulesfindingfilters.html#cfn-securityhub-automationrule-automationrulesfindingfilters-workflowstatus

DateFilterProperty

class CfnAutomationRule.DateFilterProperty(*, date_range=None, end=None, start=None)

Bases: object

A date filter for querying findings.

Parameters:

date_range (Union[IResolvable, DateRangeProperty, Dict[str, Any], None]) – A date range for the date filter.
end (Optional[str]) –
A timestamp that provides the end date for the date filter. For more information about the validation and formatting of timestamp fields in AWS Security Hub , see Timestamps .
start (Optional[str]) –
A timestamp that provides the start date for the date filter. For more information about the validation and formatting of timestamp fields in AWS Security Hub , see Timestamps .

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-securityhub-automationrule-datefilter.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

date_filter_property = securityhub.CfnAutomationRule.DateFilterProperty(
    date_range=securityhub.CfnAutomationRule.DateRangeProperty(
        unit="unit",
        value=123
    ),
    end="end",
    start="start"
)

Attributes

date_range

A date range for the date filter.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-securityhub-automationrule-datefilter.html#cfn-securityhub-automationrule-datefilter-daterange

end

A timestamp that provides the end date for the date filter.

For more information about the validation and formatting of timestamp fields in AWS Security Hub , see Timestamps .

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-securityhub-automationrule-datefilter.html#cfn-securityhub-automationrule-datefilter-end

start

A timestamp that provides the start date for the date filter.

For more information about the validation and formatting of timestamp fields in AWS Security Hub , see Timestamps .

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-securityhub-automationrule-datefilter.html#cfn-securityhub-automationrule-datefilter-start

DateRangeProperty

class CfnAutomationRule.DateRangeProperty(*, unit, value)

Bases: object

A date range for the date filter.

Parameters:

unit (str) – A date range unit for the date filter.
value (Union[int, float]) – A date range value for the date filter.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-securityhub-automationrule-daterange.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

date_range_property = securityhub.CfnAutomationRule.DateRangeProperty(
    unit="unit",
    value=123
)

Attributes

unit

A date range unit for the date filter.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-securityhub-automationrule-daterange.html#cfn-securityhub-automationrule-daterange-unit

value

A date range value for the date filter.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-securityhub-automationrule-daterange.html#cfn-securityhub-automationrule-daterange-value

MapFilterProperty

class CfnAutomationRule.MapFilterProperty(*, comparison, key, value)

Bases: object

A map filter for filtering AWS Security Hub findings.

Each map filter provides the field to check for, the value to check for, and the comparison operator.

Parameters:

comparison (str) –
The condition to apply to the key value when filtering Security Hub findings with a map filter. To search for values that have the filter value, use one of the following comparison operators: - To search for values that include the filter value, use CONTAINS . For example, for the ResourceTags field, the filter Department CONTAINS Security matches findings that include the value Security for the Department tag. In the same example, a finding with a value of Security team for the Department tag is a match. - To search for values that exactly match the filter value, use EQUALS . For example, for the ResourceTags field, the filter Department EQUALS Security matches findings that have the value Security for the Department tag. CONTAINS and EQUALS filters on the same field are joined by OR . A finding matches if it matches any one of those filters. For example, the filters Department CONTAINS Security OR Department CONTAINS Finance match a finding that includes either Security , Finance , or both values. To search for values that don’t have the filter value, use one of the following comparison operators: - To search for values that exclude the filter value, use NOT_CONTAINS . For example, for the ResourceTags field, the filter Department NOT_CONTAINS Finance matches findings that exclude the value Finance for the Department tag. - To search for values other than the filter value, use NOT_EQUALS . For example, for the ResourceTags field, the filter Department NOT_EQUALS Finance matches findings that don’t have the value Finance for the Department tag. NOT_CONTAINS and NOT_EQUALS filters on the same field are joined by AND . A finding matches only if it matches all of those filters. For example, the filters Department NOT_CONTAINS Security AND Department NOT_CONTAINS Finance match a finding that excludes both the Security and Finance values. CONTAINS filters can only be used with other CONTAINS filters. NOT_CONTAINS filters can only be used with other NOT_CONTAINS filters. You can’t have both a CONTAINS filter and a NOT_CONTAINS filter on the same field. Similarly, you can’t have both an EQUALS filter and a NOT_EQUALS filter on the same field. Combining filters in this way returns an error. CONTAINS and NOT_CONTAINS operators can be used only with automation rules. For more information, see Automation rules in the AWS Security Hub User Guide .
key (str) – The key of the map filter. For example, for ResourceTags , Key identifies the name of the tag. For UserDefinedFields , Key is the name of the field.
value (str) – The value for the key in the map filter. Filter values are case sensitive. For example, one of the values for a tag called Department might be Security . If you provide security as the filter value, then there’s no match.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-securityhub-automationrule-mapfilter.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

map_filter_property = securityhub.CfnAutomationRule.MapFilterProperty(
    comparison="comparison",
    key="key",
    value="value"
)

Attributes

comparison

The condition to apply to the key value when filtering Security Hub findings with a map filter.

To search for values that have the filter value, use one of the following comparison operators:

To search for values that include the filter value, use CONTAINS . For example, for the ResourceTags field, the filter Department CONTAINS Security matches findings that include the value Security for the Department tag. In the same example, a finding with a value of Security team for the Department tag is a match.
To search for values that exactly match the filter value, use EQUALS . For example, for the ResourceTags field, the filter Department EQUALS Security matches findings that have the value Security for the Department tag.

CONTAINS and EQUALS filters on the same field are joined by OR . A finding matches if it matches any one of those filters. For example, the filters Department CONTAINS Security OR Department CONTAINS Finance match a finding that includes either Security , Finance , or both values.

To search for values that don’t have the filter value, use one of the following comparison operators:

To search for values that exclude the filter value, use NOT_CONTAINS . For example, for the ResourceTags field, the filter Department NOT_CONTAINS Finance matches findings that exclude the value Finance for the Department tag.
To search for values other than the filter value, use NOT_EQUALS . For example, for the ResourceTags field, the filter Department NOT_EQUALS Finance matches findings that don’t have the value Finance for the Department tag.

NOT_CONTAINS and NOT_EQUALS filters on the same field are joined by AND . A finding matches only if it matches all of those filters. For example, the filters Department NOT_CONTAINS Security AND Department NOT_CONTAINS Finance match a finding that excludes both the Security and Finance values.

CONTAINS filters can only be used with other CONTAINS filters. NOT_CONTAINS filters can only be used with other NOT_CONTAINS filters.

You can’t have both a CONTAINS filter and a NOT_CONTAINS filter on the same field. Similarly, you can’t have both an EQUALS filter and a NOT_EQUALS filter on the same field. Combining filters in this way returns an error.

CONTAINS and NOT_CONTAINS operators can be used only with automation rules. For more information, see Automation rules in the AWS Security Hub User Guide .

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-securityhub-automationrule-mapfilter.html#cfn-securityhub-automationrule-mapfilter-comparison

key

The key of the map filter.

For example, for ResourceTags , Key identifies the name of the tag. For UserDefinedFields , Key is the name of the field.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-securityhub-automationrule-mapfilter.html#cfn-securityhub-automationrule-mapfilter-key

value

The value for the key in the map filter.

Filter values are case sensitive. For example, one of the values for a tag called Department might be Security . If you provide security as the filter value, then there’s no match.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-securityhub-automationrule-mapfilter.html#cfn-securityhub-automationrule-mapfilter-value

NoteUpdateProperty

class CfnAutomationRule.NoteUpdateProperty(*, text, updated_by)

Bases: object

The updated note.

Parameters:

text (str) – The updated note text.
updated_by (str) – The principal that updated the note.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-securityhub-automationrule-noteupdate.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

note_update_property = securityhub.CfnAutomationRule.NoteUpdateProperty(
    text="text",
    updated_by="updatedBy"
)

Attributes

text

The updated note text.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-securityhub-automationrule-noteupdate.html#cfn-securityhub-automationrule-noteupdate-text

updated_by

The principal that updated the note.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-securityhub-automationrule-noteupdate.html#cfn-securityhub-automationrule-noteupdate-updatedby

NumberFilterProperty

class CfnAutomationRule.NumberFilterProperty(*, eq=None, gte=None, lte=None)

Bases: object

A number filter for querying findings.

Parameters:

eq (Union[int, float, None]) – The equal-to condition to be applied to a single field when querying for findings.
gte (Union[int, float, None]) – The greater-than-equal condition to be applied to a single field when querying for findings.
lte (Union[int, float, None]) – The less-than-equal condition to be applied to a single field when querying for findings.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-securityhub-automationrule-numberfilter.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

number_filter_property = securityhub.CfnAutomationRule.NumberFilterProperty(
    eq=123,
    gte=123,
    lte=123
)

Attributes

eq

The equal-to condition to be applied to a single field when querying for findings.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-securityhub-automationrule-numberfilter.html#cfn-securityhub-automationrule-numberfilter-eq

gte

The greater-than-equal condition to be applied to a single field when querying for findings.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-securityhub-automationrule-numberfilter.html#cfn-securityhub-automationrule-numberfilter-gte

lte

The less-than-equal condition to be applied to a single field when querying for findings.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-securityhub-automationrule-numberfilter.html#cfn-securityhub-automationrule-numberfilter-lte

RelatedFindingProperty

class CfnAutomationRule.RelatedFindingProperty(*, id, product_arn)

Bases: object

Provides details about a list of findings that the current finding relates to.

Parameters:

id (str) – The product-generated identifier for a related finding. Array Members: Minimum number of 1 item. Maximum number of 20 items.
product_arn (str) – The Amazon Resource Name (ARN) for the product that generated a related finding.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-securityhub-automationrule-relatedfinding.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

related_finding_property = securityhub.CfnAutomationRule.RelatedFindingProperty(
    id="id",
    product_arn="productArn"
)

Attributes

id

The product-generated identifier for a related finding.

Array Members: Minimum number of 1 item. Maximum number of 20 items.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-securityhub-automationrule-relatedfinding.html#cfn-securityhub-automationrule-relatedfinding-id

product_arn

The Amazon Resource Name (ARN) for the product that generated a related finding.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-securityhub-automationrule-relatedfinding.html#cfn-securityhub-automationrule-relatedfinding-productarn

SeverityUpdateProperty

class CfnAutomationRule.SeverityUpdateProperty(*, label=None, normalized=None, product=None)

Bases: object

Updates to the severity information for a finding.

Parameters:

label (Optional[str]) – The severity value of the finding. The allowed values are the following. - INFORMATIONAL - No issue was found. - LOW - The issue does not require action on its own. - MEDIUM - The issue must be addressed but not urgently. - HIGH - The issue must be addressed as a priority. - CRITICAL - The issue must be remediated immediately to avoid it escalating.
normalized (Union[int, float, None]) – The normalized severity for the finding. This attribute is to be deprecated in favor of Label . If you provide Normalized and don’t provide Label , Label is set automatically as follows. - 0 - INFORMATIONAL - 1–39 - LOW - 40–69 - MEDIUM - 70–89 - HIGH - 90–100 - CRITICAL
product (Union[int, float, None]) – The native severity as defined by the AWS service or integrated partner product that generated the finding.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-securityhub-automationrule-severityupdate.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

severity_update_property = securityhub.CfnAutomationRule.SeverityUpdateProperty(
    label="label",
    normalized=123,
    product=123
)

Attributes

label

The severity value of the finding. The allowed values are the following.

INFORMATIONAL - No issue was found.
LOW - The issue does not require action on its own.
MEDIUM - The issue must be addressed but not urgently.
HIGH - The issue must be addressed as a priority.
CRITICAL - The issue must be remediated immediately to avoid it escalating.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-securityhub-automationrule-severityupdate.html#cfn-securityhub-automationrule-severityupdate-label

normalized

The normalized severity for the finding. This attribute is to be deprecated in favor of Label .

If you provide Normalized and don’t provide Label , Label is set automatically as follows.

0 - INFORMATIONAL
1–39 - LOW
40–69 - MEDIUM
70–89 - HIGH
90–100 - CRITICAL

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-securityhub-automationrule-severityupdate.html#cfn-securityhub-automationrule-severityupdate-normalized

product

The native severity as defined by the AWS service or integrated partner product that generated the finding.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-securityhub-automationrule-severityupdate.html#cfn-securityhub-automationrule-severityupdate-product

StringFilterProperty

class CfnAutomationRule.StringFilterProperty(*, comparison, value)

Bases: object

A string filter for filtering AWS Security Hub findings.

Parameters:

comparison (str) –
The condition to apply to a string value when filtering Security Hub findings. To search for values that have the filter value, use one of the following comparison operators: - To search for values that include the filter value, use CONTAINS . For example, the filter Title CONTAINS CloudFront matches findings that have a Title that includes the string CloudFront. - To search for values that exactly match the filter value, use EQUALS . For example, the filter AwsAccountId EQUALS 123456789012 only matches findings that have an account ID of 123456789012 . - To search for values that start with the filter value, use PREFIX . For example, the filter ResourceRegion PREFIX us matches findings that have a ResourceRegion that starts with us . A ResourceRegion that starts with a different value, such as af , ap , or ca , doesn’t match. CONTAINS , EQUALS , and PREFIX filters on the same field are joined by OR . A finding matches if it matches any one of those filters. For example, the filters Title CONTAINS CloudFront OR Title CONTAINS CloudWatch match a finding that includes either CloudFront , CloudWatch , or both strings in the title. To search for values that don’t have the filter value, use one of the following comparison operators: - To search for values that exclude the filter value, use NOT_CONTAINS . For example, the filter Title NOT_CONTAINS CloudFront matches findings that have a Title that excludes the string CloudFront. - To search for values other than the filter value, use NOT_EQUALS . For example, the filter AwsAccountId NOT_EQUALS 123456789012 only matches findings that have an account ID other than 123456789012 . - To search for values that don’t start with the filter value, use PREFIX_NOT_EQUALS . For example, the filter ResourceRegion PREFIX_NOT_EQUALS us matches findings with a ResourceRegion that starts with a value other than us . NOT_CONTAINS , NOT_EQUALS , and PREFIX_NOT_EQUALS filters on the same field are joined by AND . A finding matches only if it matches all of those filters. For example, the filters Title NOT_CONTAINS CloudFront AND Title NOT_CONTAINS CloudWatch match a finding that excludes both CloudFront and CloudWatch in the title. You can’t have both a CONTAINS filter and a NOT_CONTAINS filter on the same field. Similarly, you can’t provide both an EQUALS filter and a NOT_EQUALS or PREFIX_NOT_EQUALS filter on the same field. Combining filters in this way returns an error. CONTAINS filters can only be used with other CONTAINS filters. NOT_CONTAINS filters can only be used with other NOT_CONTAINS filters. You can combine PREFIX filters with NOT_EQUALS or PREFIX_NOT_EQUALS filters for the same field. Security Hub first processes the PREFIX filters, and then the NOT_EQUALS or PREFIX_NOT_EQUALS filters. For example, for the following filters, Security Hub first identifies findings that have resource types that start with either AwsIam or AwsEc2 . It then excludes findings that have a resource type of AwsIamPolicy and findings that have a resource type of AwsEc2NetworkInterface . - ResourceType PREFIX AwsIam - ResourceType PREFIX AwsEc2 - ResourceType NOT_EQUALS AwsIamPolicy - ResourceType NOT_EQUALS AwsEc2NetworkInterface CONTAINS and NOT_CONTAINS operators can be used only with automation rules V1. CONTAINS_WORD operator is only supported in GetFindingsV2 , GetFindingStatisticsV2 , GetResourcesV2 , and GetResourceStatisticsV2 APIs. For more information, see Automation rules in the AWS Security Hub User Guide .
value (str) – The string filter value. Filter values are case sensitive. For example, the product name for control-based findings is Security Hub . If you provide security hub as the filter value, there’s no match.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-securityhub-automationrule-stringfilter.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

string_filter_property = securityhub.CfnAutomationRule.StringFilterProperty(
    comparison="comparison",
    value="value"
)

Attributes

comparison

The condition to apply to a string value when filtering Security Hub findings.

To search for values that have the filter value, use one of the following comparison operators:

To search for values that include the filter value, use CONTAINS . For example, the filter Title CONTAINS CloudFront matches findings that have a Title that includes the string CloudFront.
To search for values that exactly match the filter value, use EQUALS . For example, the filter AwsAccountId EQUALS 123456789012 only matches findings that have an account ID of 123456789012 .
To search for values that start with the filter value, use PREFIX . For example, the filter ResourceRegion PREFIX us matches findings that have a ResourceRegion that starts with us . A ResourceRegion that starts with a different value, such as af , ap , or ca , doesn’t match.

CONTAINS , EQUALS , and PREFIX filters on the same field are joined by OR . A finding matches if it matches any one of those filters. For example, the filters Title CONTAINS CloudFront OR Title CONTAINS CloudWatch match a finding that includes either CloudFront , CloudWatch , or both strings in the title.

To search for values that don’t have the filter value, use one of the following comparison operators:

To search for values that exclude the filter value, use NOT_CONTAINS . For example, the filter Title NOT_CONTAINS CloudFront matches findings that have a Title that excludes the string CloudFront.
To search for values other than the filter value, use NOT_EQUALS . For example, the filter AwsAccountId NOT_EQUALS 123456789012 only matches findings that have an account ID other than 123456789012 .
To search for values that don’t start with the filter value, use PREFIX_NOT_EQUALS . For example, the filter ResourceRegion PREFIX_NOT_EQUALS us matches findings with a ResourceRegion that starts with a value other than us .

NOT_CONTAINS , NOT_EQUALS , and PREFIX_NOT_EQUALS filters on the same field are joined by AND . A finding matches only if it matches all of those filters. For example, the filters Title NOT_CONTAINS CloudFront AND Title NOT_CONTAINS CloudWatch match a finding that excludes both CloudFront and CloudWatch in the title.

You can’t have both a CONTAINS filter and a NOT_CONTAINS filter on the same field. Similarly, you can’t provide both an EQUALS filter and a NOT_EQUALS or PREFIX_NOT_EQUALS filter on the same field. Combining filters in this way returns an error. CONTAINS filters can only be used with other CONTAINS filters. NOT_CONTAINS filters can only be used with other NOT_CONTAINS filters.

You can combine PREFIX filters with NOT_EQUALS or PREFIX_NOT_EQUALS filters for the same field. Security Hub first processes the PREFIX filters, and then the NOT_EQUALS or PREFIX_NOT_EQUALS filters.

For example, for the following filters, Security Hub first identifies findings that have resource types that start with either AwsIam or AwsEc2 . It then excludes findings that have a resource type of AwsIamPolicy and findings that have a resource type of AwsEc2NetworkInterface .

ResourceType PREFIX AwsIam
ResourceType PREFIX AwsEc2
ResourceType NOT_EQUALS AwsIamPolicy
ResourceType NOT_EQUALS AwsEc2NetworkInterface

CONTAINS and NOT_CONTAINS operators can be used only with automation rules V1. CONTAINS_WORD operator is only supported in GetFindingsV2 , GetFindingStatisticsV2 , GetResourcesV2 , and GetResourceStatisticsV2 APIs. For more information, see Automation rules in the AWS Security Hub User Guide .

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-securityhub-automationrule-stringfilter.html#cfn-securityhub-automationrule-stringfilter-comparison

value

The string filter value.

Filter values are case sensitive. For example, the product name for control-based findings is Security Hub . If you provide security hub as the filter value, there’s no match.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-securityhub-automationrule-stringfilter.html#cfn-securityhub-automationrule-stringfilter-value

WorkflowUpdateProperty

class CfnAutomationRule.WorkflowUpdateProperty(*, status)

Bases: object

Used to update information about the investigation into the finding.

Parameters:: status (str) – The status of the investigation into the finding. The workflow status is specific to an individual finding. It does not affect the generation of new findings. For example, setting the workflow status to SUPPRESSED or RESOLVED does not prevent a new finding for the same issue. The allowed values are the following. - NEW - The initial state of a finding, before it is reviewed. Security Hub also resets WorkFlowStatus from NOTIFIED or RESOLVED to NEW in the following cases: - The record state changes from ARCHIVED to ACTIVE . - The compliance status changes from PASSED to either WARNING , FAILED , or NOT_AVAILABLE . - NOTIFIED - Indicates that you notified the resource owner about the security issue. Used when the initial reviewer is not the resource owner, and needs intervention from the resource owner. - RESOLVED - The finding was reviewed and remediated and is now considered resolved. - SUPPRESSED - Indicates that you reviewed the finding and don’t believe that any action is needed. The finding is no longer updated.
See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-securityhub-automationrule-workflowupdate.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

workflow_update_property = securityhub.CfnAutomationRule.WorkflowUpdateProperty(
    status="status"
)

Attributes

status

The status of the investigation into the finding.

The workflow status is specific to an individual finding. It does not affect the generation of new findings. For example, setting the workflow status to SUPPRESSED or RESOLVED does not prevent a new finding for the same issue.

The allowed values are the following.

NEW - The initial state of a finding, before it is reviewed.

Security Hub also resets WorkFlowStatus from NOTIFIED or RESOLVED to NEW in the following cases:

The record state changes from ARCHIVED to ACTIVE .
The compliance status changes from PASSED to either WARNING , FAILED , or NOT_AVAILABLE .
NOTIFIED - Indicates that you notified the resource owner about the security issue. Used when the initial reviewer is not the resource owner, and needs intervention from the resource owner.
RESOLVED - The finding was reviewed and remediated and is now considered resolved.
SUPPRESSED - Indicates that you reviewed the finding and don’t believe that any action is needed. The finding is no longer updated.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-securityhub-automationrule-workflowupdate.html#cfn-securityhub-automationrule-workflowupdate-status