software.amazon.awscdk.services.frauddetector

Class CfnDetector

java.lang.Object

software.amazon.jsii.JsiiObject

software.constructs.Construct

software.amazon.awscdk.CfnElement

software.amazon.awscdk.CfnRefElement

software.amazon.awscdk.CfnResource

software.amazon.awscdk.services.frauddetector.CfnDetector

All Implemented Interfaces:

IInspectable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable

@Generated(value="jsii-pacmak/1.67.0 (build 2c027f5)",
           date="2022-09-19T20:26:39.398Z")
 @Stability(value=Stable)
public class CfnDetector
extends CfnResource
implements IInspectable

A CloudFormation `AWS::FraudDetector::Detector`.

Manages a detector and associated detector versions.

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.*;
 CfnDetector cfnDetector = CfnDetector.Builder.create(this, "MyCfnDetector")
         .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();
 

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CfnDetector.Builder A fluent builder for CfnDetector.
static interface	CfnDetector.EntityTypeProperty The entity type details.
static interface	CfnDetector.EventTypeProperty The event type details.
static interface	CfnDetector.EventVariableProperty The event type variable for the detector.
static interface	CfnDetector.LabelProperty The label details.
static interface	CfnDetector.ModelProperty The model.
static interface	CfnDetector.OutcomeProperty The outcome.
static interface	CfnDetector.RuleProperty A rule.

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.amazon.awscdk.IInspectable

IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

Nested classes/interfaces inherited from interface software.constructs.IConstruct

software.constructs.IConstruct.Jsii$Default

Field Summary

Fields

Modifier and Type	Field and Description
static String	CFN_RESOURCE_TYPE_NAME The CloudFormation resource type name for this resource class.

Constructor Summary

Constructors

Modifier	Constructor and Description
	CfnDetector(software.constructs.Construct scope, String id, CfnDetectorProps props) Create a new `AWS::FraudDetector::Detector`.
protected	CfnDetector(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnDetector(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method and Description
Object	getAssociatedModels() The models to associate with this detector.
String	getAttrArn() The detector ARN.
String	getAttrCreatedTime() Timestamp of when detector was created.
String	getAttrDetectorVersionId() The name of the detector.
String	getAttrEventTypeArn()
String	getAttrEventTypeCreatedTime()
String	getAttrEventTypeLastUpdatedTime()
String	getAttrLastUpdatedTime() Timestamp of when detector was last updated.
protected Map<String,Object>	getCfnProperties()
String	getDescription() The detector description.
String	getDetectorId() The name of the detector.
String	getDetectorVersionStatus() The status of the detector version.
Object	getEventType() The event type associated with this detector.
String	getRuleExecutionMode() The rule execution mode for the rules included in the detector version.
Object	getRules() The rules to include in the detector version.
TagManager	getTags() An array of key-value pairs to apply to this resource.
void	inspect(TreeInspector inspector) Examines the CloudFormation resource and discloses attributes.
protected Map<String,Object>	renderProperties(Map<String,Object> props)
void	setAssociatedModels(IResolvable value) The models to associate with this detector.
void	setAssociatedModels(List<Object> value) The models to associate with this detector.
void	setDescription(String value) The detector description.
void	setDetectorId(String value) The name of the detector.
void	setDetectorVersionStatus(String value) The status of the detector version.
void	setEventType(CfnDetector.EventTypeProperty value) The event type associated with this detector.
void	setEventType(IResolvable value) The event type associated with this detector.
void	setRuleExecutionMode(String value) The rule execution mode for the rules included in the detector version.
void	setRules(IResolvable value) The rules to include in the detector version.
void	setRules(List<Object> value) The rules to include in the detector version.

Methods inherited from class software.amazon.awscdk.CfnResource

addDeletionOverride, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, getUpdatedProperties, isCfnResource, shouldSynthesize, toString, validateProperties

Methods inherited from class software.amazon.awscdk.CfnRefElement

getRef

Methods inherited from class software.amazon.awscdk.CfnElement

getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId

Methods inherited from class software.constructs.Construct

getNode, isConstruct

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Field Detail

CFN_RESOURCE_TYPE_NAME

@Stability(value=Stable)
public static final String CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

Constructor Detail

CfnDetector

protected CfnDetector(software.amazon.jsii.JsiiObjectRef objRef)

CfnDetector

protected CfnDetector(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

CfnDetector

@Stability(value=Stable)
public CfnDetector(@NotNull
                                            software.constructs.Construct scope,
                                            @NotNull
                                            String id,
                                            @NotNull
                                            CfnDetectorProps props)

Create a new `AWS::FraudDetector::Detector`.

Parameters:

scope - - scope in which this resource is defined. This parameter is required.

id - - scoped id of the resource. This parameter is required.

props - - resource properties. This parameter is required.

Method Detail

inspect

@Stability(value=Stable)
public void inspect(@NotNull
                                             TreeInspector inspector)

Examines the CloudFormation resource and discloses attributes.

Specified by:

inspect in interface IInspectable

Parameters:

inspector - - tree inspector to collect and process attributes. This parameter is required.

renderProperties

@Stability(value=Stable)
 @NotNull
protected Map<String,Object> renderProperties(@NotNull
                                                                                 Map<String,Object> props)

Overrides:

renderProperties in class CfnResource

Parameters:

props - This parameter is required.

getAttrArn

@Stability(value=Stable)
 @NotNull
public String getAttrArn()

The detector ARN.

getAttrCreatedTime

@Stability(value=Stable)
 @NotNull
public String getAttrCreatedTime()

Timestamp of when detector was created.

getAttrDetectorVersionId

@Stability(value=Stable)
 @NotNull
public String getAttrDetectorVersionId()

The name of the detector.

getAttrEventTypeArn

@Stability(value=Stable)
 @NotNull
public String getAttrEventTypeArn()

getAttrEventTypeCreatedTime

@Stability(value=Stable)
 @NotNull
public String getAttrEventTypeCreatedTime()

getAttrEventTypeLastUpdatedTime

@Stability(value=Stable)
 @NotNull
public String getAttrEventTypeLastUpdatedTime()

getAttrLastUpdatedTime

@Stability(value=Stable)
 @NotNull
public String getAttrLastUpdatedTime()

Timestamp of when detector was last updated.

getCfnProperties

@Stability(value=Stable)
 @NotNull
protected Map<String,Object> getCfnProperties()

Overrides:

getCfnProperties in class CfnResource

getTags

@Stability(value=Stable)
 @NotNull
public TagManager getTags()

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

For more information, see Tag .

getDetectorId

@Stability(value=Stable)
 @NotNull
public String getDetectorId()

The name of the detector.

setDetectorId

@Stability(value=Stable)
public void setDetectorId(@NotNull
                                                   String value)

The name of the detector.

getEventType

@Stability(value=Stable)
 @NotNull
public Object getEventType()

The event type associated with this detector.

setEventType

@Stability(value=Stable)
public void setEventType(@NotNull
                                                  CfnDetector.EventTypeProperty value)

The event type associated with this detector.

setEventType

@Stability(value=Stable)
public void setEventType(@NotNull
                                                  IResolvable value)

The event type associated with this detector.

getRules

@Stability(value=Stable)
 @NotNull
public Object getRules()

The rules to include in the detector version.

setRules

@Stability(value=Stable)
public void setRules(@NotNull
                                              IResolvable value)

The rules to include in the detector version.

setRules

@Stability(value=Stable)
public void setRules(@NotNull
                                              List<Object> value)

The rules to include in the detector version.

getAssociatedModels

@Stability(value=Stable)
 @Nullable
public Object getAssociatedModels()

The models to associate with this detector.

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

setAssociatedModels

@Stability(value=Stable)
public void setAssociatedModels(@Nullable
                                                         IResolvable value)

The models to associate with this detector.

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

setAssociatedModels

@Stability(value=Stable)
public void setAssociatedModels(@Nullable
                                                         List<Object> value)

The models to associate with this detector.

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

getDescription

@Stability(value=Stable)
 @Nullable
public String getDescription()

The detector description.

setDescription

@Stability(value=Stable)
public void setDescription(@Nullable
                                                    String value)

The detector description.

getDetectorVersionStatus

@Stability(value=Stable)
 @Nullable
public 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

setDetectorVersionStatus

@Stability(value=Stable)
public void setDetectorVersionStatus(@Nullable
                                                              String value)

The status of the detector version.

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

Valid values: ACTIVE | DRAFT

getRuleExecutionMode

@Stability(value=Stable)
 @Nullable
public 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.

setRuleExecutionMode

@Stability(value=Stable)
public void setRuleExecutionMode(@Nullable
                                                          String value)

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.