Package software.amazon.awscdk.services.frauddetector

Interface CfnDetectorProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnDetectorProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.98.0 (build 00b106d)",
           date="2024-05-08T21:35:07.597Z")
@Stability(Stable)
public interface CfnDetectorProps
extends software.amazon.jsii.JsiiSerializable

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 software.amazon.awscdk.services.frauddetector.*;
 CfnDetectorProps cfnDetectorProps = CfnDetectorProps.builder()
         .detectorId("detectorId")
         .eventType(EventTypeProperty.builder()
                 .arn("arn")
                 .createdTime("createdTime")
                 .description("description")
                 .entityTypes(List.of(EntityTypeProperty.builder()
                         .arn("arn")
                         .createdTime("createdTime")
                         .description("description")
                         .inline(false)
                         .lastUpdatedTime("lastUpdatedTime")
                         .name("name")
                         .tags(List.of(CfnTag.builder()
                                 .key("key")
                                 .value("value")
                                 .build()))
                         .build()))
                 .eventVariables(List.of(EventVariableProperty.builder()
                         .arn("arn")
                         .createdTime("createdTime")
                         .dataSource("dataSource")
                         .dataType("dataType")
                         .defaultValue("defaultValue")
                         .description("description")
                         .inline(false)
                         .lastUpdatedTime("lastUpdatedTime")
                         .name("name")
                         .tags(List.of(CfnTag.builder()
                                 .key("key")
                                 .value("value")
                                 .build()))
                         .variableType("variableType")
                         .build()))
                 .inline(false)
                 .labels(List.of(LabelProperty.builder()
                         .arn("arn")
                         .createdTime("createdTime")
                         .description("description")
                         .inline(false)
                         .lastUpdatedTime("lastUpdatedTime")
                         .name("name")
                         .tags(List.of(CfnTag.builder()
                                 .key("key")
                                 .value("value")
                                 .build()))
                         .build()))
                 .lastUpdatedTime("lastUpdatedTime")
                 .name("name")
                 .tags(List.of(CfnTag.builder()
                         .key("key")
                         .value("value")
                         .build()))
                 .build())
         .rules(List.of(RuleProperty.builder()
                 .arn("arn")
                 .createdTime("createdTime")
                 .description("description")
                 .detectorId("detectorId")
                 .expression("expression")
                 .language("language")
                 .lastUpdatedTime("lastUpdatedTime")
                 .outcomes(List.of(OutcomeProperty.builder()
                         .arn("arn")
                         .createdTime("createdTime")
                         .description("description")
                         .inline(false)
                         .lastUpdatedTime("lastUpdatedTime")
                         .name("name")
                         .tags(List.of(CfnTag.builder()
                                 .key("key")
                                 .value("value")
                                 .build()))
                         .build()))
                 .ruleId("ruleId")
                 .ruleVersion("ruleVersion")
                 .tags(List.of(CfnTag.builder()
                         .key("key")
                         .value("value")
                         .build()))
                 .build()))
         // the properties below are optional
         .associatedModels(List.of(ModelProperty.builder()
                 .arn("arn")
                 .build()))
         .description("description")
         .detectorVersionStatus("detectorVersionStatus")
         .ruleExecutionMode("ruleExecutionMode")
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .build();
 

See Also:

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

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnDetectorProps.Builder	A builder for CfnDetectorProps
static final class	CfnDetectorProps.Jsii$Proxy	An implementation for CfnDetectorProps

Method Summary

Modifier and Type	Method	Description
static CfnDetectorProps.Builder	builder()
default Object	getAssociatedModels()	The models to associate with this detector.
default String	getDescription()	The detector description.
String	getDetectorId()	The name of the detector.
default String	getDetectorVersionStatus()	The status of the detector version.
Object	getEventType()	The event type associated with this detector.
default String	getRuleExecutionMode()	The rule execution mode for the rules included in the detector version.
Object	getRules()	The rules to include in the detector version.
default List<CfnTag>	getTags()	An array of key-value pairs to apply to this resource.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getDetectorId

@Stability(Stable)
@NotNull
String getDetectorId()

The name of the detector.

See Also:

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

getEventType

@Stability(Stable)
@NotNull
Object getEventType()

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

getRules

@Stability(Stable)
@NotNull
Object getRules()

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

getAssociatedModels

@Stability(Stable)
@Nullable
default Object getAssociatedModels()

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

getDescription

@Stability(Stable)
@Nullable
default String getDescription()

The detector description.

See Also:

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

getDetectorVersionStatus

@Stability(Stable)
@Nullable
default String getDetectorVersionStatus()

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

getRuleExecutionMode

@Stability(Stable)
@Nullable
default String getRuleExecutionMode()

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

getTags

@Stability(Stable)
@Nullable
default List<CfnTag> getTags()

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

builder

@Stability(Stable)
static CfnDetectorProps.Builder builder()

Returns:

a CfnDetectorProps.Builder of CfnDetectorProps