aws-cdk-lib.aws_frauddetector.CfnDetectorProps

interface CfnDetectorProps

LanguageType name
.NETAmazon.CDK.AWS.FraudDetector.CfnDetectorProps
Gogithub.com/aws/aws-cdk-go/awscdk/v2/awsfrauddetector#CfnDetectorProps
Javasoftware.amazon.awscdk.services.frauddetector.CfnDetectorProps
Pythonaws_cdk.aws_frauddetector.CfnDetectorProps
TypeScript aws-cdk-lib » aws_frauddetector » CfnDetectorProps

Properties for defining a CfnDetector.

Example

// 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

NameTypeDescription
detectorIdstringThe name of the detector.
eventTypeIResolvable | EventTypePropertyThe event type associated with this detector.
rulesIResolvable | IResolvable | RuleProperty[]The rules to include in the detector version.
associatedModels?IResolvable | IResolvable | ModelProperty[]The models to associate with this detector.
description?stringThe detector description.
detectorVersionStatus?stringThe status of the detector version.
ruleExecutionMode?stringThe rule execution mode for the rules included in the detector version.
tags?CfnTag[]An array of key-value pairs to apply to this resource.

detectorId

Type: string

The name of the detector.


eventType

Type: IResolvable | EventTypeProperty

The event type associated with this detector.


rules

Type: IResolvable | IResolvable | RuleProperty[]

The rules to include in the detector version.


associatedModels?

Type: IResolvable | IResolvable | ModelProperty[] (optional)

The models to associate with this detector.

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


description?

Type: string (optional)

The detector description.


detectorVersionStatus?

Type: string (optional)

The status of the detector version.

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

Valid values: ACTIVE | DRAFT


ruleExecutionMode?

Type: string (optional)

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?

Type: CfnTag[] (optional)

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

For more information, see Tag .