CfnCustomDetectionRuleAssociationProps

class aws_cdk.aws_guardduty.CfnCustomDetectionRuleAssociationProps(*, mode, rule_id, tags=None)

Bases: object

Properties for defining a CfnCustomDetectionRuleAssociation.

Parameters:

  • mode (str) – Whether the rule runs in LIVE mode (generates findings) or DRY_RUN mode (evaluates without generating findings).

  • rule_id (str) – The catalog identifier of the custom detection rule to associate.

  • tags (Optional[Sequence[Union[TagItemProperty, Dict[str, Any]]]]) – The tags applied to the association.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-guardduty-customdetectionruleassociation.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_guardduty as guardduty

cfn_custom_detection_rule_association_props = guardduty.CfnCustomDetectionRuleAssociationProps(
    mode="mode",
    rule_id="ruleId",

    # the properties below are optional
    tags=[guardduty.CfnCustomDetectionRuleAssociation.TagItemProperty(
        key="key",
        value="value"
    )]
)

Attributes

mode

Whether the rule runs in LIVE mode (generates findings) or DRY_RUN mode (evaluates without generating findings).

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-guardduty-customdetectionruleassociation.html#cfn-guardduty-customdetectionruleassociation-mode

rule_id

The catalog identifier of the custom detection rule to associate.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-guardduty-customdetectionruleassociation.html#cfn-guardduty-customdetectionruleassociation-ruleid

tags

The tags applied to the association.

See:

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