CfnDetector

class aws_cdk.aws_frauddetector.CfnDetector(scope, id, *, detector_id, event_type, rules, associated_models=None, description=None, detector_version_status=None, rule_execution_mode=None, tags=None)

Bases: CfnResource

A CloudFormation AWS::FraudDetector::Detector.

Manages a detector and associated detector versions.

CloudformationResource:: AWS::FraudDetector::Detector
Link:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-frauddetector-detector.html
ExampleMetadata:: fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
import aws_cdk.aws_frauddetector as frauddetector

cfn_detector = frauddetector.CfnDetector(self, "MyCfnDetector",
    detector_id="detectorId",
    event_type=frauddetector.CfnDetector.EventTypeProperty(
        arn="arn",
        created_time="createdTime",
        description="description",
        entity_types=[frauddetector.CfnDetector.EntityTypeProperty(
            arn="arn",
            created_time="createdTime",
            description="description",
            inline=False,
            last_updated_time="lastUpdatedTime",
            name="name",
            tags=[CfnTag(
                key="key",
                value="value"
            )]
        )],
        event_variables=[frauddetector.CfnDetector.EventVariableProperty(
            arn="arn",
            created_time="createdTime",
            data_source="dataSource",
            data_type="dataType",
            default_value="defaultValue",
            description="description",
            inline=False,
            last_updated_time="lastUpdatedTime",
            name="name",
            tags=[CfnTag(
                key="key",
                value="value"
            )],
            variable_type="variableType"
        )],
        inline=False,
        labels=[frauddetector.CfnDetector.LabelProperty(
            arn="arn",
            created_time="createdTime",
            description="description",
            inline=False,
            last_updated_time="lastUpdatedTime",
            name="name",
            tags=[CfnTag(
                key="key",
                value="value"
            )]
        )],
        last_updated_time="lastUpdatedTime",
        name="name",
        tags=[CfnTag(
            key="key",
            value="value"
        )]
    ),
    rules=[frauddetector.CfnDetector.RuleProperty(
        arn="arn",
        created_time="createdTime",
        description="description",
        detector_id="detectorId",
        expression="expression",
        language="language",
        last_updated_time="lastUpdatedTime",
        outcomes=[frauddetector.CfnDetector.OutcomeProperty(
            arn="arn",
            created_time="createdTime",
            description="description",
            inline=False,
            last_updated_time="lastUpdatedTime",
            name="name",
            tags=[CfnTag(
                key="key",
                value="value"
            )]
        )],
        rule_id="ruleId",
        rule_version="ruleVersion",
        tags=[CfnTag(
            key="key",
            value="value"
        )]
    )],

    # the properties below are optional
    associated_models=[frauddetector.CfnDetector.ModelProperty(
        arn="arn"
    )],
    description="description",
    detector_version_status="detectorVersionStatus",
    rule_execution_mode="ruleExecutionMode",
    tags=[CfnTag(
        key="key",
        value="value"
    )]
)

Create a new AWS::FraudDetector::Detector.

Parameters:

scope (Construct) –
- scope in which this resource is defined.
id (str) –
- scoped id of the resource.
detector_id (str) – The name of the detector.
event_type (Union[EventTypeProperty, Dict[str, Any], IResolvable]) – The event type associated with this detector.
rules (Union[IResolvable, Sequence[Union[IResolvable, RuleProperty, Dict[str, Any]]]]) – The rules to include in the detector version.
associated_models (Union[IResolvable, Sequence[Union[IResolvable, ModelProperty, Dict[str, Any]]], None]) – The models to associate with this detector. You must provide the ARNs of all the models you want to associate.
description (Optional[str]) – The detector description.
detector_version_status (Optional[str]) – The status of the detector version. If a value is not provided for this property, AWS CloudFormation assumes DRAFT status. Valid values: ACTIVE | DRAFT
rule_execution_mode (Optional[str]) – 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.
tags (Optional[Sequence[Union[CfnTag, Dict[str, Any]]]]) – An array of key-value pairs to apply to this resource. For more information, see Tag .

Methods

add_deletion_override(path)

Syntactic sugar for addOverride(path, undefined).

Parameters:: path (str) – The path of the value to delete.
Return type:: None

add_depends_on(target)

Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.

This can be used for resources across stacks (or nested stack) boundaries and the dependency will automatically be transferred to the relevant scope.

Parameters:: target (CfnResource)
Return type:: None

add_metadata(key, value)

Add a value to the CloudFormation Resource Metadata.

Parameters:

key (str)
value (Any)

See:

Return type:

None

https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html

Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.

add_override(path, value)

Adds an override to the synthesized CloudFormation resource.

To add a property override, either use addPropertyOverride or prefix path with “Properties.” (i.e. Properties.TopicName).

If the override is nested, separate each nested level using a dot (.) in the path parameter. If there is an array as part of the nesting, specify the index in the path.

To include a literal . in the property name, prefix with a \. In most programming languages you will need to write this as "\\." because the \ itself will need to be escaped.

For example:

cfn_resource.add_override("Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes", ["myattribute"])
cfn_resource.add_override("Properties.GlobalSecondaryIndexes.1.ProjectionType", "INCLUDE")

would add the overrides Example:

"Properties": {
   "GlobalSecondaryIndexes": [
     {
       "Projection": {
         "NonKeyAttributes": [ "myattribute" ]
         ...
       }
       ...
     },
     {
       "ProjectionType": "INCLUDE"
       ...
     },
   ]
   ...
}

The value argument to addOverride will not be processed or translated in any way. Pass raw JSON values in here with the correct capitalization for CloudFormation. If you pass CDK classes or structs, they will be rendered with lowercased key names, and CloudFormation will reject the template.

Parameters:

path (str) –
- The path of the property, you can use dot notation to override values in complex types. Any intermdediate keys will be created as needed.
value (Any) –
- The value. Could be primitive or complex.

Return type:

None

add_property_deletion_override(property_path)

Adds an override that deletes the value of a property from the resource definition.

Parameters:: property_path (str) – The path to the property.
Return type:: None

add_property_override(property_path, value)

Adds an override to a resource property.

Syntactic sugar for addOverride("Properties.<...>", value).

Parameters:

property_path (str) – The path of the property.
value (Any) – The value.

Return type:

None

apply_removal_policy(policy=None, *, apply_to_update_replace_policy=None, default=None)

Sets the deletion policy of the resource based on the removal policy specified.

The Removal Policy controls what happens to this resource when it stops being managed by CloudFormation, either because you’ve removed it from the CDK application or because you’ve made a change that requires the resource to be replaced.

The resource can be deleted (RemovalPolicy.DESTROY), or left in your AWS account for data recovery and cleanup later (RemovalPolicy.RETAIN).

Parameters:

policy (Optional[RemovalPolicy])
apply_to_update_replace_policy (Optional[bool]) – Apply the same deletion policy to the resource’s “UpdateReplacePolicy”. Default: true
default (Optional[RemovalPolicy]) – The default policy to apply in case the removal policy is not defined. Default: - Default value is resource specific. To determine the default value for a resoure, please consult that specific resource’s documentation.

Return type:

None

get_att(attribute_name)

Returns a token for an runtime attribute of this resource.

Ideally, use generated attribute accessors (e.g. resource.arn), but this can be used for future compatibility in case there is no generated attribute.

Parameters:: attribute_name (str) – The name of the attribute.
Return type:: Reference

get_metadata(key)

Retrieve a value value from the CloudFormation Resource Metadata.

Parameters:: key (str)
See:
Return type:: Any

https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html

Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.

inspect(inspector)

Examines the CloudFormation resource and discloses attributes.

Parameters:

inspector (TreeInspector) –

tree inspector to collect and process attributes.

Return type:

None

override_logical_id(new_logical_id)

Overrides the auto-generated logical ID with a specific ID.

Parameters:: new_logical_id (str) – The new logical ID to use for this stack element.
Return type:: None

to_string()

Returns a string representation of this construct.

Return type:: str
Returns:: a string representation of this resource

Attributes

CFN_RESOURCE_TYPE_NAME = 'AWS::FraudDetector::Detector'

associated_models

The models to associate with this detector.

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

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

attr_arn

The detector ARN.

CloudformationAttribute:: Arn

attr_created_time

Timestamp of when detector was created.

CloudformationAttribute:: CreatedTime

attr_detector_version_id

The name of the detector.

CloudformationAttribute:: DetectorVersionId

attr_event_type_arn

EventType.Arn

Type:: cloudformationAttribute

attr_event_type_created_time

EventType.CreatedTime

Type:: cloudformationAttribute

attr_event_type_last_updated_time

EventType.LastUpdatedTime

Type:: cloudformationAttribute

attr_last_updated_time

Timestamp of when detector was last updated.

CloudformationAttribute:: LastUpdatedTime

cfn_options: Options for this resource, such as condition, update policy etc.

cfn_resource_type: AWS resource type.

creation_stack

return:

the stack trace of the point where this Resource was created from, sourced from the +metadata+ entry typed +aws:cdk:logicalId+, and with the bottom-most node +internal+ entries filtered.

description

The detector description.

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

detector_id

The name of the detector.

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

detector_version_status

The status of the detector version.

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

Valid values: ACTIVE | DRAFT

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

event_type

The event type associated with this detector.

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

logical_id

The logical ID for this CloudFormation stack element.

The logical ID of the element is calculated from the path of the resource node in the construct tree.

To override this value, use overrideLogicalId(newLogicalId).

Returns:

the logical ID as a stringified token. This value will only get resolved during synthesis.

node: The construct tree node associated with this construct.

ref

Return a string that will be resolved to a CloudFormation { Ref } for this element.

If, by any chance, the intrinsic reference of a resource is not a string, you could coerce it to an IResolvable through Lazy.any({ produce: resource.ref }).

rule_execution_mode

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.

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

rules

The rules to include in the detector version.

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

stack

The stack in which this element is defined.

CfnElements must be defined within a stack scope (directly or indirectly).

tags

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

For more information, see Tag .

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

Static Methods

classmethod is_cfn_element(x)

Returns true if a construct is a stack element (i.e. part of the synthesized cloudformation template).

Uses duck-typing instead of instanceof to allow stack elements from different versions of this library to be included in the same stack.

Parameters:: x (Any)
Return type:: bool
Returns:: The construct as a stack element or undefined if it is not a stack element.

classmethod is_cfn_resource(construct)

Check whether the given construct is a CfnResource.

Parameters:: construct (IConstruct)
Return type:: bool

classmethod is_construct(x)

Return whether the given object is a Construct.

Parameters:: x (Any)
Return type:: bool

EntityTypeProperty

class CfnDetector.EntityTypeProperty(*, arn=None, created_time=None, description=None, inline=None, last_updated_time=None, name=None, tags=None)

Bases: object

The entity type details.

Parameters:

arn (Optional[str]) – The entity type ARN.
created_time (Optional[str]) – Timestamp of when the entity type was created.
description (Optional[str]) – The entity type description.
inline (Union[bool, IResolvable, None]) – Indicates whether the resource is defined within this CloudFormation template and impacts the create, update, and delete behavior of the stack. If the value is true , CloudFormation will create/update/delete the resource when creating/updating/deleting the stack. If the value is false , CloudFormation will validate that the object exists and then use it within the resource without making changes to the object. For example, when creating AWS::FraudDetector::Detector you must define at least two variables. You can set Inline=true for these Variables and CloudFormation will create/update/delete the variables as part of stack operations. However, if you set Inline=false , CloudFormation will associate the variables to your detector but not execute any changes to the variables.
last_updated_time (Optional[str]) – Timestamp of when the entity type was last updated.
name (Optional[str]) – The entity type name.
tags (Optional[Sequence[Union[CfnTag, Dict[str, Any]]]]) –
An array of key-value pairs to apply to this resource. For more information, see Tag .

Link:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-frauddetector-detector-entitytype.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
import aws_cdk.aws_frauddetector as frauddetector

entity_type_property = frauddetector.CfnDetector.EntityTypeProperty(
    arn="arn",
    created_time="createdTime",
    description="description",
    inline=False,
    last_updated_time="lastUpdatedTime",
    name="name",
    tags=[CfnTag(
        key="key",
        value="value"
    )]
)

Attributes

arn

The entity type ARN.

Link:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-frauddetector-detector-entitytype.html#cfn-frauddetector-detector-entitytype-arn

created_time

Timestamp of when the entity type was created.

Link:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-frauddetector-detector-entitytype.html#cfn-frauddetector-detector-entitytype-createdtime

description

The entity type description.

Link:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-frauddetector-detector-entitytype.html#cfn-frauddetector-detector-entitytype-description

inline

Indicates whether the resource is defined within this CloudFormation template and impacts the create, update, and delete behavior of the stack.

If the value is true , CloudFormation will create/update/delete the resource when creating/updating/deleting the stack. If the value is false , CloudFormation will validate that the object exists and then use it within the resource without making changes to the object.

For example, when creating AWS::FraudDetector::Detector you must define at least two variables. You can set Inline=true for these Variables and CloudFormation will create/update/delete the variables as part of stack operations. However, if you set Inline=false , CloudFormation will associate the variables to your detector but not execute any changes to the variables.

Link:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-frauddetector-detector-entitytype.html#cfn-frauddetector-detector-entitytype-inline

last_updated_time

Timestamp of when the entity type was last updated.

Link:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-frauddetector-detector-entitytype.html#cfn-frauddetector-detector-entitytype-lastupdatedtime

name

The entity type name.

Link:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-frauddetector-detector-entitytype.html#cfn-frauddetector-detector-entitytype-name

tags

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

For more information, see Tag .

Link:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-frauddetector-detector-entitytype.html#cfn-frauddetector-detector-entitytype-tags

EventTypeProperty

class CfnDetector.EventTypeProperty(*, arn=None, created_time=None, description=None, entity_types=None, event_variables=None, inline=None, labels=None, last_updated_time=None, name=None, tags=None)

Bases: object

The event type details.

Parameters:

arn (Optional[str]) – The entity type ARN.
created_time (Optional[str]) – Timestamp of when the event type was created.
description (Optional[str]) – The event type description.
entity_types (Union[IResolvable, Sequence[Union[IResolvable, EntityTypeProperty, Dict[str, Any]]], None]) – The event type entity types.
event_variables (Union[IResolvable, Sequence[Union[IResolvable, EventVariableProperty, Dict[str, Any]]], None]) – The event type event variables.
inline (Union[bool, IResolvable, None]) – Indicates whether the resource is defined within this CloudFormation template and impacts the create, update, and delete behavior of the stack. If the value is true , CloudFormation will create/update/delete the resource when creating/updating/deleting the stack. If the value is false , CloudFormation will validate that the object exists and then use it within the resource without making changes to the object. For example, when creating AWS::FraudDetector::Detector you must define at least two variables. You can set Inline=true for these variables and CloudFormation will create/update/delete the Variables as part of stack operations. However, if you set Inline=false , CloudFormation will associate the variables to your detector but not execute any changes to the variables.
labels (Union[IResolvable, Sequence[Union[IResolvable, LabelProperty, Dict[str, Any]]], None]) – The event type labels.
last_updated_time (Optional[str]) – Timestamp of when the event type was last updated.
name (Optional[str]) – The event type name.
tags (Optional[Sequence[Union[CfnTag, Dict[str, Any]]]]) –
An array of key-value pairs to apply to this resource. For more information, see Tag .

Link:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-frauddetector-detector-eventtype.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
import aws_cdk.aws_frauddetector as frauddetector

event_type_property = frauddetector.CfnDetector.EventTypeProperty(
    arn="arn",
    created_time="createdTime",
    description="description",
    entity_types=[frauddetector.CfnDetector.EntityTypeProperty(
        arn="arn",
        created_time="createdTime",
        description="description",
        inline=False,
        last_updated_time="lastUpdatedTime",
        name="name",
        tags=[CfnTag(
            key="key",
            value="value"
        )]
    )],
    event_variables=[frauddetector.CfnDetector.EventVariableProperty(
        arn="arn",
        created_time="createdTime",
        data_source="dataSource",
        data_type="dataType",
        default_value="defaultValue",
        description="description",
        inline=False,
        last_updated_time="lastUpdatedTime",
        name="name",
        tags=[CfnTag(
            key="key",
            value="value"
        )],
        variable_type="variableType"
    )],
    inline=False,
    labels=[frauddetector.CfnDetector.LabelProperty(
        arn="arn",
        created_time="createdTime",
        description="description",
        inline=False,
        last_updated_time="lastUpdatedTime",
        name="name",
        tags=[CfnTag(
            key="key",
            value="value"
        )]
    )],
    last_updated_time="lastUpdatedTime",
    name="name",
    tags=[CfnTag(
        key="key",
        value="value"
    )]
)

Attributes

arn

The entity type ARN.

Link:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-frauddetector-detector-eventtype.html#cfn-frauddetector-detector-eventtype-arn

created_time

Timestamp of when the event type was created.

Link:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-frauddetector-detector-eventtype.html#cfn-frauddetector-detector-eventtype-createdtime

description

The event type description.

Link:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-frauddetector-detector-eventtype.html#cfn-frauddetector-detector-eventtype-description

entity_types

The event type entity types.

Link:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-frauddetector-detector-eventtype.html#cfn-frauddetector-detector-eventtype-entitytypes

event_variables

The event type event variables.

Link:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-frauddetector-detector-eventtype.html#cfn-frauddetector-detector-eventtype-eventvariables

inline

Indicates whether the resource is defined within this CloudFormation template and impacts the create, update, and delete behavior of the stack.

If the value is true , CloudFormation will create/update/delete the resource when creating/updating/deleting the stack. If the value is false , CloudFormation will validate that the object exists and then use it within the resource without making changes to the object.

For example, when creating AWS::FraudDetector::Detector you must define at least two variables. You can set Inline=true for these variables and CloudFormation will create/update/delete the Variables as part of stack operations. However, if you set Inline=false , CloudFormation will associate the variables to your detector but not execute any changes to the variables.

Link:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-frauddetector-detector-eventtype.html#cfn-frauddetector-detector-eventtype-inline

labels

The event type labels.

Link:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-frauddetector-detector-eventtype.html#cfn-frauddetector-detector-eventtype-labels

last_updated_time

Timestamp of when the event type was last updated.

Link:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-frauddetector-detector-eventtype.html#cfn-frauddetector-detector-eventtype-lastupdatedtime

name

The event type name.

Link:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-frauddetector-detector-eventtype.html#cfn-frauddetector-detector-eventtype-name

tags

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

For more information, see Tag .

Link:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-frauddetector-detector-eventtype.html#cfn-frauddetector-detector-eventtype-tags

EventVariableProperty

class CfnDetector.EventVariableProperty(*, arn=None, created_time=None, data_source=None, data_type=None, default_value=None, description=None, inline=None, last_updated_time=None, name=None, tags=None, variable_type=None)

Bases: object

The event type variable for the detector.

Parameters:

arn (Optional[str]) – The event variable ARN.
created_time (Optional[str]) – Timestamp for when the event variable was created.
data_source (Optional[str]) – The data source of the event variable. Valid values: EVENT | EXTERNAL_MODEL_SCORE When defining a variable within a detector, you can only use the EVENT value for DataSource when the Inline property is set to true. If the Inline property is set false, you can use either EVENT or MODEL_SCORE for DataSource.
data_type (Optional[str]) – The data type of the event variable. Valid values: STRING | INTEGER | BOOLEAN | FLOAT
default_value (Optional[str]) – The default value of the event variable. This is required if you are providing the details of your variables instead of the ARN.
description (Optional[str]) – The description of the event variable.
inline (Union[bool, IResolvable, None]) – Indicates whether the resource is defined within this CloudFormation template and impacts the create, update, and delete behavior of the stack. If the value is true , CloudFormation will create/update/delete the resource when creating/updating/deleting the stack. If the value is false , CloudFormation will validate that the object exists and then use it within the resource without making changes to the object. For example, when creating AWS::FraudDetector::Detector you must define at least two variables. You can set Inline=true for these variables and CloudFormation will create/update/delete the variables as part of stack operations. However, if you set Inline=false , CloudFormation will associate the variables to your detector but not execute any changes to the variables.
last_updated_time (Optional[str]) – Timestamp for when the event variable was last updated.
name (Optional[str]) – The name of the event variable.
tags (Optional[Sequence[Union[CfnTag, Dict[str, Any]]]]) –
An array of key-value pairs to apply to this resource. For more information, see Tag .
variable_type (Optional[str]) – The type of event variable. For more information, see Variable types .

Link:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-frauddetector-detector-eventvariable.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
import aws_cdk.aws_frauddetector as frauddetector

event_variable_property = frauddetector.CfnDetector.EventVariableProperty(
    arn="arn",
    created_time="createdTime",
    data_source="dataSource",
    data_type="dataType",
    default_value="defaultValue",
    description="description",
    inline=False,
    last_updated_time="lastUpdatedTime",
    name="name",
    tags=[CfnTag(
        key="key",
        value="value"
    )],
    variable_type="variableType"
)

Attributes

arn

The event variable ARN.

Link:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-frauddetector-detector-eventvariable.html#cfn-frauddetector-detector-eventvariable-arn

created_time

Timestamp for when the event variable was created.

Link:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-frauddetector-detector-eventvariable.html#cfn-frauddetector-detector-eventvariable-createdtime

data_source

The data source of the event variable.

Valid values: EVENT | EXTERNAL_MODEL_SCORE

When defining a variable within a detector, you can only use the EVENT value for DataSource when the Inline property is set to true. If the Inline property is set false, you can use either EVENT or MODEL_SCORE for DataSource.

Link:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-frauddetector-detector-eventvariable.html#cfn-frauddetector-detector-eventvariable-datasource

data_type

The data type of the event variable.

Valid values: STRING | INTEGER | BOOLEAN | FLOAT

Link:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-frauddetector-detector-eventvariable.html#cfn-frauddetector-detector-eventvariable-datatype

default_value

The default value of the event variable.

This is required if you are providing the details of your variables instead of the ARN.

Link:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-frauddetector-detector-eventvariable.html#cfn-frauddetector-detector-eventvariable-defaultvalue

description

The description of the event variable.

Link:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-frauddetector-detector-eventvariable.html#cfn-frauddetector-detector-eventvariable-description

inline

Indicates whether the resource is defined within this CloudFormation template and impacts the create, update, and delete behavior of the stack.

If the value is true , CloudFormation will create/update/delete the resource when creating/updating/deleting the stack. If the value is false , CloudFormation will validate that the object exists and then use it within the resource without making changes to the object.

For example, when creating AWS::FraudDetector::Detector you must define at least two variables. You can set Inline=true for these variables and CloudFormation will create/update/delete the variables as part of stack operations. However, if you set Inline=false , CloudFormation will associate the variables to your detector but not execute any changes to the variables.

Link:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-frauddetector-detector-eventvariable.html#cfn-frauddetector-detector-eventvariable-inline

last_updated_time

Timestamp for when the event variable was last updated.

Link:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-frauddetector-detector-eventvariable.html#cfn-frauddetector-detector-eventvariable-lastupdatedtime

name

The name of the event variable.

Link:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-frauddetector-detector-eventvariable.html#cfn-frauddetector-detector-eventvariable-name

tags

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

For more information, see Tag .

Link:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-frauddetector-detector-eventvariable.html#cfn-frauddetector-detector-eventvariable-tags

variable_type

The type of event variable.

For more information, see Variable types .

Link:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-frauddetector-detector-eventvariable.html#cfn-frauddetector-detector-eventvariable-variabletype

LabelProperty

class CfnDetector.LabelProperty(*, arn=None, created_time=None, description=None, inline=None, last_updated_time=None, name=None, tags=None)

Bases: object

The label details.

Parameters:

arn (Optional[str]) – The label ARN.
created_time (Optional[str]) – Timestamp of when the event type was created.
description (Optional[str]) – The label description.
inline (Union[bool, IResolvable, None]) – Indicates whether the resource is defined within this CloudFormation template and impacts the create, update, and delete behavior of the stack. If the value is true , CloudFormation will create/update/delete the resource when creating/updating/deleting the stack. If the value is false , CloudFormation will validate that the object exists and then use it within the resource without making changes to the object. For example, when creating AWS::FraudDetector::Detector you must define at least two variables. You can set Inline=true for these variables and CloudFormation will create/update/delete the variables as part of stack operations. However, if you set Inline=false , CloudFormation will associate the variables to your detector but not execute any changes to the variables.
last_updated_time (Optional[str]) – Timestamp of when the label was last updated.
name (Optional[str]) – The label name.
tags (Optional[Sequence[Union[CfnTag, Dict[str, Any]]]]) –
An array of key-value pairs to apply to this resource. For more information, see Tag .

Link:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-frauddetector-detector-label.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
import aws_cdk.aws_frauddetector as frauddetector

label_property = frauddetector.CfnDetector.LabelProperty(
    arn="arn",
    created_time="createdTime",
    description="description",
    inline=False,
    last_updated_time="lastUpdatedTime",
    name="name",
    tags=[CfnTag(
        key="key",
        value="value"
    )]
)

Attributes

arn

The label ARN.

Link:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-frauddetector-detector-label.html#cfn-frauddetector-detector-label-arn

created_time

Timestamp of when the event type was created.

Link:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-frauddetector-detector-label.html#cfn-frauddetector-detector-label-createdtime

description

The label description.

Link:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-frauddetector-detector-label.html#cfn-frauddetector-detector-label-description

inline

Indicates whether the resource is defined within this CloudFormation template and impacts the create, update, and delete behavior of the stack.

If the value is true , CloudFormation will create/update/delete the resource when creating/updating/deleting the stack. If the value is false , CloudFormation will validate that the object exists and then use it within the resource without making changes to the object.

For example, when creating AWS::FraudDetector::Detector you must define at least two variables. You can set Inline=true for these variables and CloudFormation will create/update/delete the variables as part of stack operations. However, if you set Inline=false , CloudFormation will associate the variables to your detector but not execute any changes to the variables.

Link:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-frauddetector-detector-label.html#cfn-frauddetector-detector-label-inline

last_updated_time

Timestamp of when the label was last updated.

Link:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-frauddetector-detector-label.html#cfn-frauddetector-detector-label-lastupdatedtime

name

The label name.

Link:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-frauddetector-detector-label.html#cfn-frauddetector-detector-label-name

tags

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

For more information, see Tag .

Link:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-frauddetector-detector-label.html#cfn-frauddetector-detector-label-tags

ModelProperty

class CfnDetector.ModelProperty(*, arn=None)

Bases: object

Parameters:: arn (Optional[str]) – CfnDetector.ModelProperty.Arn.
Link:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-frauddetector-detector-model.html
ExampleMetadata:: fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
import aws_cdk.aws_frauddetector as frauddetector

model_property = frauddetector.CfnDetector.ModelProperty(
    arn="arn"
)

Attributes

arn

CfnDetector.ModelProperty.Arn.

Link:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-frauddetector-detector-model.html#cfn-frauddetector-detector-model-arn

OutcomeProperty

class CfnDetector.OutcomeProperty(*, arn=None, created_time=None, description=None, inline=None, last_updated_time=None, name=None, tags=None)

Bases: object

The outcome.

Parameters:

arn (Optional[str]) – The outcome ARN.
created_time (Optional[str]) – The timestamp when the outcome was created.
description (Optional[str]) – The outcome description.
inline (Union[bool, IResolvable, None]) – Indicates whether the resource is defined within this CloudFormation template and impacts the create, update, and delete behavior of the stack. If the value is true , CloudFormation will create/update/delete the resource when creating/updating/deleting the stack. If the value is false , CloudFormation will validate that the object exists and then use it within the resource without making changes to the object. For example, when creating AWS::FraudDetector::Detector you must define at least two variables. You can set Inline=true for these variables and CloudFormation will create/update/delete the variables as part of stack operations. However, if you set Inline=false , CloudFormation will associate the variables to your detector but not execute any changes to the variables.
last_updated_time (Optional[str]) – The timestamp when the outcome was last updated.
name (Optional[str]) – The outcome name.
tags (Optional[Sequence[Union[CfnTag, Dict[str, Any]]]]) –
An array of key-value pairs to apply to this resource. For more information, see Tag .

Link:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-frauddetector-detector-outcome.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
import aws_cdk.aws_frauddetector as frauddetector

outcome_property = frauddetector.CfnDetector.OutcomeProperty(
    arn="arn",
    created_time="createdTime",
    description="description",
    inline=False,
    last_updated_time="lastUpdatedTime",
    name="name",
    tags=[CfnTag(
        key="key",
        value="value"
    )]
)

Attributes

arn

The outcome ARN.

Link:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-frauddetector-detector-outcome.html#cfn-frauddetector-detector-outcome-arn

created_time

The timestamp when the outcome was created.

Link:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-frauddetector-detector-outcome.html#cfn-frauddetector-detector-outcome-createdtime

description

The outcome description.

Link:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-frauddetector-detector-outcome.html#cfn-frauddetector-detector-outcome-description

inline

Indicates whether the resource is defined within this CloudFormation template and impacts the create, update, and delete behavior of the stack.

If the value is true , CloudFormation will create/update/delete the resource when creating/updating/deleting the stack. If the value is false , CloudFormation will validate that the object exists and then use it within the resource without making changes to the object.

For example, when creating AWS::FraudDetector::Detector you must define at least two variables. You can set Inline=true for these variables and CloudFormation will create/update/delete the variables as part of stack operations. However, if you set Inline=false , CloudFormation will associate the variables to your detector but not execute any changes to the variables.

Link:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-frauddetector-detector-outcome.html#cfn-frauddetector-detector-outcome-inline

last_updated_time

The timestamp when the outcome was last updated.

Link:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-frauddetector-detector-outcome.html#cfn-frauddetector-detector-outcome-lastupdatedtime

name

The outcome name.

Link:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-frauddetector-detector-outcome.html#cfn-frauddetector-detector-outcome-name

tags

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

For more information, see Tag .

Link:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-frauddetector-detector-outcome.html#cfn-frauddetector-detector-outcome-tags

RuleProperty

class CfnDetector.RuleProperty(*, arn=None, created_time=None, description=None, detector_id=None, expression=None, language=None, last_updated_time=None, outcomes=None, rule_id=None, rule_version=None, tags=None)

Bases: object

A rule.

Rule is a condition that tells Amazon Fraud Detector how to interpret variables values during a fraud prediction.

Parameters:

arn (Optional[str]) – The rule ARN.
created_time (Optional[str]) – Timestamp for when the rule was created.
description (Optional[str]) – The rule description.
detector_id (Optional[str]) – The detector for which the rule is associated.
expression (Optional[str]) – The rule expression. A rule expression captures the business logic. For more information, see Rule language reference .
language (Optional[str]) – The rule language.
last_updated_time (Optional[str]) – Timestamp for when the rule was last updated.
outcomes (Union[IResolvable, Sequence[Union[IResolvable, OutcomeProperty, Dict[str, Any]]], None]) – The rule outcome.
rule_id (Optional[str]) – The rule ID.
rule_version (Optional[str]) – The rule version.
tags (Optional[Sequence[Union[CfnTag, Dict[str, Any]]]]) –
An array of key-value pairs to apply to this resource. For more information, see Tag .

Link:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-frauddetector-detector-rule.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
import aws_cdk.aws_frauddetector as frauddetector

rule_property = frauddetector.CfnDetector.RuleProperty(
    arn="arn",
    created_time="createdTime",
    description="description",
    detector_id="detectorId",
    expression="expression",
    language="language",
    last_updated_time="lastUpdatedTime",
    outcomes=[frauddetector.CfnDetector.OutcomeProperty(
        arn="arn",
        created_time="createdTime",
        description="description",
        inline=False,
        last_updated_time="lastUpdatedTime",
        name="name",
        tags=[CfnTag(
            key="key",
            value="value"
        )]
    )],
    rule_id="ruleId",
    rule_version="ruleVersion",
    tags=[CfnTag(
        key="key",
        value="value"
    )]
)