CfnDetectorProps

class aws_cdk.aws_frauddetector.CfnDetectorProps(*, detector_id, event_type, rules, associated_models=None, description=None, detector_version_status=None, rule_execution_mode=None, tags=None)

Bases: object

Properties for defining a CfnDetector.

Parameters:

• detector_id (str) – The name of the detector.

• event_type (Union[IResolvable, EventTypeProperty, Dict[str, Any]]) – The event type associated with this detector.

• rules (Union[IResolvable, Sequence[Union[IResolvable, RuleProperty, Dict[str, Any]]]]) – The rules to include in the detector version.

• associated_models (Union[IResolvable, Sequence[Union[IResolvable, ModelProperty, Dict[str, Any]]], None]) – The models to associate with this detector. You must provide the ARNs of all the models you want to associate.

• description (Optional[str]) – The detector description.

• detector_version_status (Optional[str]) – The status of the detector version. If a value is not provided for this property, AWS CloudFormation assumes DRAFT status. Valid values: ACTIVE | DRAFT

• rule_execution_mode (Optional[str]) – The rule execution mode for the rules included in the detector version. Valid values: FIRST_MATCHED | ALL_MATCHED Default value: FIRST_MATCHED You can define and edit the rule mode at the detector version level, when it is in draft status. If you specify FIRST_MATCHED , Amazon Fraud Detector evaluates rules sequentially, first to last, stopping at the first matched rule. Amazon Fraud dectector then provides the outcomes for that single rule. If you specifiy ALL_MATCHED , Amazon Fraud Detector evaluates all rules and returns the outcomes for all matched rules.

• tags (Optional[Sequence[Union[CfnTag, Dict[str, Any]]]]) – An array of key-value pairs to apply to this resource. For more information, see Tag .

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-frauddetector-detector.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_frauddetector as frauddetector

cfn_detector_props = frauddetector.CfnDetectorProps(
    detector_id="detectorId",
    event_type=frauddetector.CfnDetector.EventTypeProperty(
        arn="arn",
        created_time="createdTime",
        description="description",
        entity_types=[frauddetector.CfnDetector.EntityTypeProperty(
            arn="arn",
            created_time="createdTime",
            description="description",
            inline=False,
            last_updated_time="lastUpdatedTime",
            name="name",
            tags=[CfnTag(
                key="key",
                value="value"
            )]
        )],
        event_variables=[frauddetector.CfnDetector.EventVariableProperty(
            arn="arn",
            created_time="createdTime",
            data_source="dataSource",
            data_type="dataType",
            default_value="defaultValue",
            description="description",
            inline=False,
            last_updated_time="lastUpdatedTime",
            name="name",
            tags=[CfnTag(
                key="key",
                value="value"
            )],
            variable_type="variableType"
        )],
        inline=False,
        labels=[frauddetector.CfnDetector.LabelProperty(
            arn="arn",
            created_time="createdTime",
            description="description",
            inline=False,
            last_updated_time="lastUpdatedTime",
            name="name",
            tags=[CfnTag(
                key="key",
                value="value"
            )]
        )],
        last_updated_time="lastUpdatedTime",
        name="name",
        tags=[CfnTag(
            key="key",
            value="value"
        )]
    ),
    rules=[frauddetector.CfnDetector.RuleProperty(
        arn="arn",
        created_time="createdTime",
        description="description",
        detector_id="detectorId",
        expression="expression",
        language="language",
        last_updated_time="lastUpdatedTime",
        outcomes=[frauddetector.CfnDetector.OutcomeProperty(
            arn="arn",
            created_time="createdTime",
            description="description",
            inline=False,
            last_updated_time="lastUpdatedTime",
            name="name",
            tags=[CfnTag(
                key="key",
                value="value"
            )]
        )],
        rule_id="ruleId",
        rule_version="ruleVersion",
        tags=[CfnTag(
            key="key",
            value="value"
        )]
    )],

    # the properties below are optional
    associated_models=[frauddetector.CfnDetector.ModelProperty(
        arn="arn"
    )],
    description="description",
    detector_version_status="detectorVersionStatus",
    rule_execution_mode="ruleExecutionMode",
    tags=[CfnTag(
        key="key",
        value="value"
    )]
)

Attributes

associated_models

The models to associate with this detector.

You must provide the ARNs of all the models you want to associate.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-frauddetector-detector.html#cfn-frauddetector-detector-associatedmodels

description

The detector description.

See:

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

detector_id

The name of the detector.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-frauddetector-detector.html#cfn-frauddetector-detector-detectorid

detector_version_status

The status of the detector version.

If a value is not provided for this property, AWS CloudFormation assumes DRAFT status.

Valid values: ACTIVE | DRAFT

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-frauddetector-detector.html#cfn-frauddetector-detector-detectorversionstatus

event_type

The event type associated with this detector.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-frauddetector-detector.html#cfn-frauddetector-detector-eventtype

rule_execution_mode

The rule execution mode for the rules included in the detector version.

Valid values: FIRST_MATCHED | ALL_MATCHED Default value: FIRST_MATCHED

You can define and edit the rule mode at the detector version level, when it is in draft status.

If you specify FIRST_MATCHED , Amazon Fraud Detector evaluates rules sequentially, first to last, stopping at the first matched rule. Amazon Fraud dectector then provides the outcomes for that single rule.

If you specifiy ALL_MATCHED , Amazon Fraud Detector evaluates all rules and returns the outcomes for all matched rules.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-frauddetector-detector.html#cfn-frauddetector-detector-ruleexecutionmode

rules

The rules to include in the detector version.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-frauddetector-detector.html#cfn-frauddetector-detector-rules

tags

An array of key-value pairs to apply to this resource.

For more information, see Tag .

See:

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