CfnDetectorPropsMixin

class aws_cdk.mixins_preview.aws_frauddetector.mixins.CfnDetectorPropsMixin(props, *, strategy=None)

Bases: Mixin

Manages a detector and associated detector versions.

See:

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

CloudformationResource:

AWS::FraudDetector::Detector

Mixin:

true

ExampleMetadata:

fixture=_generated

Example:

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

cfn_detector_props_mixin = frauddetector_mixins.CfnDetectorPropsMixin(frauddetector_mixins.CfnDetectorMixinProps(
    associated_models=[frauddetector_mixins.CfnDetectorPropsMixin.ModelProperty(
        arn="arn"
    )],
    description="description",
    detector_id="detectorId",
    detector_version_status="detectorVersionStatus",
    event_type=frauddetector_mixins.CfnDetectorPropsMixin.EventTypeProperty(
        arn="arn",
        created_time="createdTime",
        description="description",
        entity_types=[frauddetector_mixins.CfnDetectorPropsMixin.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_mixins.CfnDetectorPropsMixin.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_mixins.CfnDetectorPropsMixin.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"
        )]
    ),
    rule_execution_mode="ruleExecutionMode",
    rules=[frauddetector_mixins.CfnDetectorPropsMixin.RuleProperty(
        arn="arn",
        created_time="createdTime",
        description="description",
        detector_id="detectorId",
        expression="expression",
        language="language",
        last_updated_time="lastUpdatedTime",
        outcomes=[frauddetector_mixins.CfnDetectorPropsMixin.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"
        )]
    )],
    tags=[CfnTag(
        key="key",
        value="value"
    )]
),
    strategy=mixins.PropertyMergeStrategy.OVERRIDE
)

Create a mixin to apply properties to AWS::FraudDetector::Detector.

Parameters:
  • props (Union[CfnDetectorMixinProps, Dict[str, Any]]) – L1 properties to apply.

  • strategy (Optional[PropertyMergeStrategy]) – (experimental) Strategy for merging nested properties. Default: - PropertyMergeStrategy.MERGE

Methods

apply_to(construct)

Apply the mixin properties to the construct.

Parameters:

construct (IConstruct)

Return type:

IConstruct

supports(construct)

Check if this mixin supports the given construct.

Parameters:

construct (IConstruct)

Return type:

bool

Attributes

CFN_PROPERTY_KEYS = ['associatedModels', 'description', 'detectorId', 'detectorVersionStatus', 'eventType', 'ruleExecutionMode', 'rules', 'tags']

Static Methods

classmethod is_mixin(x)

(experimental) Checks if x is a Mixin.

Parameters:

x (Any) – Any object.

Return type:

bool

Returns:

true if x is an object created from a class which extends Mixin.

Stability:

experimental

EntityTypeProperty

class CfnDetectorPropsMixin.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 .

See:

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.
from aws_cdk.mixins_preview.aws_frauddetector import mixins as frauddetector_mixins

entity_type_property = frauddetector_mixins.CfnDetectorPropsMixin.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.

See:

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.

See:

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

description

The entity type description.

See:

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.

See:

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.

See:

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

name

The entity type name.

See:

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 .

See:

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

EventTypeProperty

class CfnDetectorPropsMixin.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 .

See:

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.
from aws_cdk.mixins_preview.aws_frauddetector import mixins as frauddetector_mixins

event_type_property = frauddetector_mixins.CfnDetectorPropsMixin.EventTypeProperty(
    arn="arn",
    created_time="createdTime",
    description="description",
    entity_types=[frauddetector_mixins.CfnDetectorPropsMixin.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_mixins.CfnDetectorPropsMixin.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_mixins.CfnDetectorPropsMixin.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.

See:

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.

See:

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

description

The event type description.

See:

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.

See:

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.

See:

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.

See:

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

labels

The event type labels.

See:

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.

See:

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

name

The event type name.

See:

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 .

See:

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

EventVariableProperty

class CfnDetectorPropsMixin.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 .

See:

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.
from aws_cdk.mixins_preview.aws_frauddetector import mixins as frauddetector_mixins

event_variable_property = frauddetector_mixins.CfnDetectorPropsMixin.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.

See:

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.

See:

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.

See:

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

See:

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.

See:

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.

See:

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.

See:

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.

See:

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.

See:

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 .

See:

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 .

See:

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

LabelProperty

class CfnDetectorPropsMixin.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 .

See:

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.
from aws_cdk.mixins_preview.aws_frauddetector import mixins as frauddetector_mixins

label_property = frauddetector_mixins.CfnDetectorPropsMixin.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.

See:

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.

See:

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

description

The label description.

See:

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.

See:

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.

See:

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

name

The label name.

See:

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 .

See:

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

ModelProperty

class CfnDetectorPropsMixin.ModelProperty(*, arn=None)

Bases: object

The model.

Parameters:

arn (Optional[str]) – The ARN of the model.

See:

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.
from aws_cdk.mixins_preview.aws_frauddetector import mixins as frauddetector_mixins

model_property = frauddetector_mixins.CfnDetectorPropsMixin.ModelProperty(
    arn="arn"
)

Attributes

arn

The ARN of the model.

See:

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

OutcomeProperty

class CfnDetectorPropsMixin.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 .

See:

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.
from aws_cdk.mixins_preview.aws_frauddetector import mixins as frauddetector_mixins

outcome_property = frauddetector_mixins.CfnDetectorPropsMixin.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.

See:

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.

See:

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

description

The outcome description.

See:

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.

See:

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.

See:

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

name

The outcome name.

See:

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 .

See:

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

RuleProperty

class CfnDetectorPropsMixin.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.

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. Valid Value: DETECTORPL

  • 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 .

See:

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.
from aws_cdk.mixins_preview.aws_frauddetector import mixins as frauddetector_mixins

rule_property = frauddetector_mixins.CfnDetectorPropsMixin.RuleProperty(
    arn="arn",
    created_time="createdTime",
    description="description",
    detector_id="detectorId",
    expression="expression",
    language="language",
    last_updated_time="lastUpdatedTime",
    outcomes=[frauddetector_mixins.CfnDetectorPropsMixin.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"
    )]
)

Attributes

arn

The rule ARN.

See:

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

created_time

Timestamp for when the rule was created.

See:

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

description

The rule description.

See:

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

detector_id

The detector for which the rule is associated.

See:

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

expression

The rule expression.

A rule expression captures the business logic. For more information, see Rule language reference .

See:

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

language

The rule language.

Valid Value: DETECTORPL

See:

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

last_updated_time

Timestamp for when the rule was last updated.

See:

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

outcomes

The rule outcome.

See:

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

rule_id

The rule ID.

See:

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

rule_version

The rule version.

See:

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

tags

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

For more information, see Tag .

See:

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