CfnDetectorProps Struct
Properties for defining a CfnDetector.
Example
ts
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_frauddetector as frauddetector } from 'aws-cdk-lib';
const cfnDetectorProps: frauddetector.CfnDetectorProps = {
detectorId: 'detectorId',
eventType: {
arn: 'arn',
createdTime: 'createdTime',
description: 'description',
entityTypes: [{
arn: 'arn',
createdTime: 'createdTime',
description: 'description',
inline: false,
lastUpdatedTime: 'lastUpdatedTime',
name: 'name',
tags: [{
key: 'key',
value: 'value',
}],
}],
eventVariables: [{
arn: 'arn',
createdTime: 'createdTime',
dataSource: 'dataSource',
dataType: 'dataType',
defaultValue: 'defaultValue',
description: 'description',
inline: false,
lastUpdatedTime: 'lastUpdatedTime',
name: 'name',
tags: [{
key: 'key',
value: 'value',
}],
variableType: 'variableType',
}],
inline: false,
labels: [{
arn: 'arn',
createdTime: 'createdTime',
description: 'description',
inline: false,
lastUpdatedTime: 'lastUpdatedTime',
name: 'name',
tags: [{
key: 'key',
value: 'value',
}],
}],
lastUpdatedTime: 'lastUpdatedTime',
name: 'name',
tags: [{
key: 'key',
value: 'value',
}],
},
rules: [{
arn: 'arn',
createdTime: 'createdTime',
description: 'description',
detectorId: 'detectorId',
expression: 'expression',
language: 'language',
lastUpdatedTime: 'lastUpdatedTime',
outcomes: [{
arn: 'arn',
createdTime: 'createdTime',
description: 'description',
inline: false,
lastUpdatedTime: 'lastUpdatedTime',
name: 'name',
tags: [{
key: 'key',
value: 'value',
}],
}],
ruleId: 'ruleId',
ruleVersion: 'ruleVersion',
tags: [{
key: 'key',
value: 'value',
}],
}],
// the properties below are optional
associatedModels: [{
arn: 'arn',
}],
description: 'description',
detectorVersionStatus: 'detectorVersionStatus',
ruleExecutionMode: 'ruleExecutionMode',
tags: [{
key: 'key',
value: 'value',
}],
};
Properties
associatedModelsoptionalIResolvable | IResolvable | CfnDetector.ModelProperty[]associated_modelsoptionaltyping.Union[IResolvable, typing.List[typing.Union[IResolvable, ModelProperty]]]associatedModelsoptionalIResolvableAssociatedModelsoptionalIResolvableAssociatedModelsoptionalinterface{}#The models to associate with this detector.
You must provide the ARNs of all the models you want to associate.
descriptionoptionalstringdescriptionoptionalstrdescriptionoptionalStringDescriptionoptionalstringDescriptionoptional*string#The detector description.
The name of the detector.
detectorVersionStatusoptionalstringdetector_version_statusoptionalstrdetectorVersionStatusoptionalStringDetectorVersionStatusoptionalstringDetectorVersionStatusoptional*string#The status of the detector version.
If a value is not provided for this property, AWS CloudFormation assumes DRAFT status.
Valid values: ACTIVE | DRAFT
eventTypeIResolvable | CfnDetector.EventTypePropertyevent_typetyping.Union[IResolvable, EventTypeProperty]eventTypeIResolvableEventTypeIResolvableEventTypeinterface{}required#The event type associated with this detector.
ruleExecutionModeoptionalstringrule_execution_modeoptionalstrruleExecutionModeoptionalStringRuleExecutionModeoptionalstringRuleExecutionModeoptional*string#The rule execution mode for the rules included in the detector version.
notes
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.
rulesIResolvable | IResolvable | CfnDetector.RuleProperty[]rulestyping.Union[IResolvable, typing.List[typing.Union[IResolvable, RuleProperty]]]rulesIResolvableRulesIResolvableRulesinterface{}required#The rules to include in the detector version.