Class CfnDetector
A CloudFormation AWS::FraudDetector::Detector
.
Inherited Members
Namespace: Amazon.CDK.AWS.FraudDetector
Assembly: Amazon.CDK.AWS.FraudDetector.dll
Syntax (csharp)
public class CfnDetector : CfnResource, IConstruct, IDependable, IInspectable
Syntax (vb)
Public Class CfnDetector
Inherits CfnResource
Implements IConstruct, IDependable, IInspectable
Remarks
Manages a detector and associated detector versions.
CloudformationResource: AWS::FraudDetector::Detector
ExampleMetadata: fixture=_generated
Examples
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.FraudDetector;
var cfnDetector = new CfnDetector(this, "MyCfnDetector", new CfnDetectorProps {
DetectorId = "detectorId",
EventType = new EventTypeProperty {
Arn = "arn",
CreatedTime = "createdTime",
Description = "description",
EntityTypes = new [] { new EntityTypeProperty {
Arn = "arn",
CreatedTime = "createdTime",
Description = "description",
Inline = false,
LastUpdatedTime = "lastUpdatedTime",
Name = "name",
Tags = new [] { new CfnTag {
Key = "key",
Value = "value"
} }
} },
EventVariables = new [] { new EventVariableProperty {
Arn = "arn",
CreatedTime = "createdTime",
DataSource = "dataSource",
DataType = "dataType",
DefaultValue = "defaultValue",
Description = "description",
Inline = false,
LastUpdatedTime = "lastUpdatedTime",
Name = "name",
Tags = new [] { new CfnTag {
Key = "key",
Value = "value"
} },
VariableType = "variableType"
} },
Inline = false,
Labels = new [] { new LabelProperty {
Arn = "arn",
CreatedTime = "createdTime",
Description = "description",
Inline = false,
LastUpdatedTime = "lastUpdatedTime",
Name = "name",
Tags = new [] { new CfnTag {
Key = "key",
Value = "value"
} }
} },
LastUpdatedTime = "lastUpdatedTime",
Name = "name",
Tags = new [] { new CfnTag {
Key = "key",
Value = "value"
} }
},
Rules = new [] { new RuleProperty {
Arn = "arn",
CreatedTime = "createdTime",
Description = "description",
DetectorId = "detectorId",
Expression = "expression",
Language = "language",
LastUpdatedTime = "lastUpdatedTime",
Outcomes = new [] { new OutcomeProperty {
Arn = "arn",
CreatedTime = "createdTime",
Description = "description",
Inline = false,
LastUpdatedTime = "lastUpdatedTime",
Name = "name",
Tags = new [] { new CfnTag {
Key = "key",
Value = "value"
} }
} },
RuleId = "ruleId",
RuleVersion = "ruleVersion",
Tags = new [] { new CfnTag {
Key = "key",
Value = "value"
} }
} },
// the properties below are optional
AssociatedModels = new [] { new ModelProperty {
Arn = "arn"
} },
Description = "description",
DetectorVersionStatus = "detectorVersionStatus",
RuleExecutionMode = "ruleExecutionMode",
Tags = new [] { new CfnTag {
Key = "key",
Value = "value"
} }
});
Synopsis
Constructors
CfnDetector(Construct, String, ICfnDetectorProps) | Create a new |
CfnDetector(ByRefValue) | Used by jsii to construct an instance of this class from a Javascript-owned object reference |
CfnDetector(DeputyBase.DeputyProps) | Used by jsii to construct an instance of this class from DeputyProps |
Properties
AssociatedModels | The models to associate with this detector. |
AttrArn | The detector ARN. |
AttrCreatedTime | Timestamp of when detector was created. |
AttrDetectorVersionId | The name of the detector. |
AttrEventTypeArn | |
AttrEventTypeCreatedTime | |
AttrEventTypeLastUpdatedTime | |
AttrLastUpdatedTime | Timestamp of when detector was last updated. |
CFN_RESOURCE_TYPE_NAME | The CloudFormation resource type name for this resource class. |
CfnProperties | |
Description | The detector description. |
DetectorId | The name of the detector. |
DetectorVersionStatus | The status of the detector version. |
EventType | The event type associated with this detector. |
RuleExecutionMode | The rule execution mode for the rules included in the detector version. |
Rules | The rules to include in the detector version. |
Tags | An array of key-value pairs to apply to this resource. |
Methods
Inspect(TreeInspector) | Examines the CloudFormation resource and discloses attributes. |
RenderProperties(IDictionary<String, Object>) |
Constructors
CfnDetector(Construct, String, ICfnDetectorProps)
Create a new AWS::FraudDetector::Detector
.
public CfnDetector(Construct scope, string id, ICfnDetectorProps props)
Parameters
- scope Construct
- scope in which this resource is defined.
- id System.String
- scoped id of the resource.
- props ICfnDetectorProps
- resource properties.
CfnDetector(ByRefValue)
Used by jsii to construct an instance of this class from a Javascript-owned object reference
protected CfnDetector(ByRefValue reference)
Parameters
- reference Amazon.JSII.Runtime.Deputy.ByRefValue
The Javascript-owned object reference
CfnDetector(DeputyBase.DeputyProps)
Used by jsii to construct an instance of this class from DeputyProps
protected CfnDetector(DeputyBase.DeputyProps props)
Parameters
- props Amazon.JSII.Runtime.Deputy.DeputyBase.DeputyProps
The deputy props
Properties
AssociatedModels
The models to associate with this detector.
public virtual object AssociatedModels { get; set; }
Property Value
System.Object
Remarks
You must provide the ARNs of all the models you want to associate.
AttrArn
The detector ARN.
public virtual string AttrArn { get; }
Property Value
System.String
Remarks
CloudformationAttribute: Arn
AttrCreatedTime
Timestamp of when detector was created.
public virtual string AttrCreatedTime { get; }
Property Value
System.String
Remarks
CloudformationAttribute: CreatedTime
AttrDetectorVersionId
The name of the detector.
public virtual string AttrDetectorVersionId { get; }
Property Value
System.String
Remarks
CloudformationAttribute: DetectorVersionId
AttrEventTypeArn
public virtual string AttrEventTypeArn { get; }
Property Value
System.String
Remarks
CloudformationAttribute: EventType.Arn
AttrEventTypeCreatedTime
public virtual string AttrEventTypeCreatedTime { get; }
Property Value
System.String
Remarks
CloudformationAttribute: EventType.CreatedTime
AttrEventTypeLastUpdatedTime
public virtual string AttrEventTypeLastUpdatedTime { get; }
Property Value
System.String
Remarks
CloudformationAttribute: EventType.LastUpdatedTime
AttrLastUpdatedTime
Timestamp of when detector was last updated.
public virtual string AttrLastUpdatedTime { get; }
Property Value
System.String
Remarks
CloudformationAttribute: LastUpdatedTime
CFN_RESOURCE_TYPE_NAME
The CloudFormation resource type name for this resource class.
public static string CFN_RESOURCE_TYPE_NAME { get; }
Property Value
System.String
CfnProperties
protected override IDictionary<string, object> CfnProperties { get; }
Property Value
System.Collections.Generic.IDictionary<System.String, System.Object>
Overrides
Description
The detector description.
public virtual string Description { get; set; }
Property Value
System.String
Remarks
DetectorId
The name of the detector.
public virtual string DetectorId { get; set; }
Property Value
System.String
Remarks
DetectorVersionStatus
The status of the detector version.
public virtual string DetectorVersionStatus { get; set; }
Property Value
System.String
Remarks
If a value is not provided for this property, AWS CloudFormation assumes DRAFT
status.
Valid values: ACTIVE | DRAFT
EventType
The event type associated with this detector.
public virtual object EventType { get; set; }
Property Value
System.Object
Remarks
RuleExecutionMode
The rule execution mode for the rules included in the detector version.
public virtual string RuleExecutionMode { get; set; }
Property Value
System.String
Remarks
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.
Rules
The rules to include in the detector version.
public virtual object Rules { get; set; }
Property Value
System.Object
Remarks
Tags
An array of key-value pairs to apply to this resource.
public virtual TagManager Tags { get; }
Property Value
Remarks
For more information, see Tag .
Methods
Inspect(TreeInspector)
Examines the CloudFormation resource and discloses attributes.
public virtual void Inspect(TreeInspector inspector)
Parameters
- inspector TreeInspector
- tree inspector to collect and process attributes.
RenderProperties(IDictionary<String, Object>)
protected override IDictionary<string, object> RenderProperties(IDictionary<string, object> props)
Parameters
- props System.Collections.Generic.IDictionary<System.String, System.Object>
Returns
System.Collections.Generic.IDictionary<System.String, System.Object>