interface CfnDetectorMixinProps

Language	Type name
.NET	Amazon.CDK.Mixins.Preview.AWS.FraudDetector.Mixins.CfnDetectorMixinProps
Go	github.com/aws/aws-cdk-go/awscdkmixinspreview/v2/awsfrauddetector/mixins#CfnDetectorMixinProps
Java	software.amazon.awscdk.mixins.preview.services.frauddetector.mixins.CfnDetectorMixinProps
Python	aws_cdk.mixins_preview.aws_frauddetector.mixins.CfnDetectorMixinProps
TypeScript	@aws-cdk/mixins-preview » aws_frauddetector » mixins » CfnDetectorMixinProps

Properties for CfnDetectorPropsMixin.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-frauddetector-detector.html

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { mixins as frauddetector_mixins } from '@aws-cdk/mixins-preview/aws-frauddetector';
const cfnDetectorMixinProps: frauddetector_mixins.CfnDetectorMixinProps = {
  associatedModels: [{
    arn: 'arn',
  }],
  description: 'description',
  detectorId: 'detectorId',
  detectorVersionStatus: 'detectorVersionStatus',
  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',
    }],
  },
  ruleExecutionMode: 'ruleExecutionMode',
  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',
    }],
  }],
  tags: [{
    key: 'key',
    value: 'value',
  }],
};

Properties

Name	Type	Description
associatedModels?	IResolvable | (IResolvable | ModelProperty)[]	The models to associate with this detector.
description?	string	The detector description.
detectorId?	string	The name of the detector.
detectorVersionStatus?	string	The status of the detector version.
eventType?	IResolvable | EventTypeProperty	The event type associated with this detector.
ruleExecutionMode?	string	The rule execution mode for the rules included in the detector version.
rules?	IResolvable | (IResolvable | RuleProperty)[]	The rules to include in the detector version.
tags?	CfnTag[]	An array of key-value pairs to apply to this resource.

---

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.

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

---

description?

Type: string (optional)

The detector description.

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

---

detectorId?

Type: string (optional)

The name of the detector.

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

---

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

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

---

eventType?

Type: IResolvable | EventTypeProperty (optional)

The event type associated with this detector.

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

---

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.

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

---

rules?

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

The rules to include in the detector version.

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

---

tags?

Type: CfnTag[] (optional)

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

For more information, see Tag .

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