AWS::FraudDetector::Detector
Manages a detector and associated detector versions.
Syntax
To declare this entity in your AWS CloudFormation template, use the following syntax:
JSON
{ "Type" : "AWS::FraudDetector::Detector", "Properties" : { "AssociatedModels" :
[ Model, ... ]
, "Description" :String
, "DetectorId" :String
, "DetectorVersionStatus" :String
, "EventType" :EventType
, "RuleExecutionMode" :String
, "Rules" :[ Rule, ... ]
, "Tags" :[ Tag, ... ]
} }
YAML
Type: AWS::FraudDetector::Detector Properties: AssociatedModels:
- Model
Description:String
DetectorId:String
DetectorVersionStatus:String
EventType:EventType
RuleExecutionMode:String
Rules:- Rule
Tags:- Tag
Properties
AssociatedModels
-
The models to associate with this detector. You must provide the ARNs of all the models you want to associate.
Required: No
Type: Array of Model
Maximum:
10
Update requires: No interruption
Description
-
The detector description.
Required: No
Type: String
Minimum:
1
Maximum:
128
Update requires: No interruption
DetectorId
-
The name of the detector.
Required: Yes
Type: String
Pattern:
^[0-9a-z_-]+$
Minimum:
1
Maximum:
64
Update requires: Replacement
DetectorVersionStatus
-
The status of the detector version. If a value is not provided for this property, AWS CloudFormation assumes
DRAFT
status.Valid values:
ACTIVE | DRAFT
Required: No
Type: String
Allowed values:
DRAFT | ACTIVE
Update requires: No interruption
EventType
-
The event type associated with this detector.
Required: Yes
Type: EventType
Update requires: No interruption
RuleExecutionMode
-
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.Required: No
Type: String
Allowed values:
FIRST_MATCHED | ALL_MATCHED
Update requires: No interruption
Rules
-
The rules to include in the detector version.
Required: Yes
Type: Array of Rule
Minimum:
1
Update requires: No interruption
-
An array of key-value pairs to apply to this resource.
For more information, see Tag.
Required: No
Type: Array of Tag
Maximum:
200
Update requires: No interruption
Return values
Ref
When you pass the logical ID of this resource to the intrinsic Ref
function, Ref
returns the primary identifier for the resource, which is the ARN.
Example: {"Ref": "arn:aws:frauddetector:us-west-2:123123123123:outcome/outcome_name"}
For more information about using the Ref
function, see Ref
.
Fn::GetAtt
The Fn::GetAtt
intrinsic function returns a value for a specified attribute of this type. The following are the available attributes and sample return values.
For more information about using the Fn::GetAtt
intrinsic function, see Fn::GetAtt
.
Arn
-
The detector ARN.
CreatedTime
-
Timestamp of when detector was created.
DetectorVersionId
-
The name of the detector.
EventType.Arn
-
The detector ARN.
EventType.CreatedTime
-
Timestamp of when the detector was created.
EventType.LastUpdatedTime
-
Timestamp of when the detector was last updated.
LastUpdatedTime
-
Timestamp of when detector was last updated.
See also
-
CreateDetectorVersion in the Amazon Fraud Detector API Reference.
-
Create a detector version in the Amazon Fraud Detector User Guide.