java.lang.Object
software.amazon.jsii.JsiiObject
All Implemented Interfaces:
IConstruct, IDependable, IInspectable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct

@Generated(value="jsii-pacmak/1.84.0 (build 5404dcf)", date="2023-06-19T16:29:56.813Z") @Stability(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();
 
  • Field Details

    • CFN_RESOURCE_TYPE_NAME

      @Stability(Stable) public static final String CFN_RESOURCE_TYPE_NAME
      The CloudFormation resource type name for this resource class.
  • Constructor Details

    • CfnDetector

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

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

      @Stability(Stable) public CfnDetector(@NotNull 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 Details

    • inspect

      @Stability(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(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(Stable) @NotNull public String getAttrArn()
      The detector ARN.
    • getAttrCreatedTime

      @Stability(Stable) @NotNull public String getAttrCreatedTime()
      Timestamp of when detector was created.
    • getAttrDetectorVersionId

      @Stability(Stable) @NotNull public String getAttrDetectorVersionId()
      The name of the detector.
    • getAttrEventTypeArn

      @Stability(Stable) @NotNull public String getAttrEventTypeArn()
    • getAttrEventTypeCreatedTime

      @Stability(Stable) @NotNull public String getAttrEventTypeCreatedTime()
    • getAttrEventTypeLastUpdatedTime

      @Stability(Stable) @NotNull public String getAttrEventTypeLastUpdatedTime()
    • getAttrLastUpdatedTime

      @Stability(Stable) @NotNull public String getAttrLastUpdatedTime()
      Timestamp of when detector was last updated.
    • getCfnProperties

      @Stability(Stable) @NotNull protected Map<String,Object> getCfnProperties()
      Overrides:
      getCfnProperties in class CfnResource
    • getTags

      @Stability(Stable) @NotNull public TagManager getTags()
      An array of key-value pairs to apply to this resource.

      For more information, see Tag .

    • getDetectorId

      @Stability(Stable) @NotNull public String getDetectorId()
      The name of the detector.
    • setDetectorId

      @Stability(Stable) public void setDetectorId(@NotNull String value)
      The name of the detector.
    • getEventType

      @Stability(Stable) @NotNull public Object getEventType()
      The event type associated with this detector.
    • setEventType

      @Stability(Stable) public void setEventType(@NotNull CfnDetector.EventTypeProperty value)
      The event type associated with this detector.
    • setEventType

      @Stability(Stable) public void setEventType(@NotNull IResolvable value)
      The event type associated with this detector.
    • getRules

      @Stability(Stable) @NotNull public Object getRules()
      The rules to include in the detector version.
    • setRules

      @Stability(Stable) public void setRules(@NotNull IResolvable value)
      The rules to include in the detector version.
    • setRules

      @Stability(Stable) public void setRules(@NotNull List<Object> value)
      The rules to include in the detector version.
    • getAssociatedModels

      @Stability(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(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(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(Stable) @Nullable public String getDescription()
      The detector description.
    • setDescription

      @Stability(Stable) public void setDescription(@Nullable String value)
      The detector description.
    • getDetectorVersionStatus

      @Stability(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(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(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(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.