AWS::FraudDetector::Detector EventVariable
The event type variable for the detector.
Syntax
To declare this entity in your AWS CloudFormation template, use the following syntax:
JSON
{ "Arn" :
String
, "CreatedTime" :String
, "DataSource" :String
, "DataType" :String
, "DefaultValue" :String
, "Description" :String
, "Inline" :Boolean
, "LastUpdatedTime" :String
, "Name" :String
, "Tags" :[ Tag, ... ]
, "VariableType" :String
}
YAML
Arn:
String
CreatedTime:String
DataSource:String
DataType:String
DefaultValue:String
Description:String
Inline:Boolean
LastUpdatedTime:String
Name:String
Tags:- Tag
VariableType:String
Properties
Arn
-
The event variable ARN.
Required: No
Type: String
Update requires: No interruption
CreatedTime
-
Timestamp for when the event variable was created.
Required: No
Type: String
Update requires: No interruption
DataSource
-
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 eitherEVENT
orMODEL_SCORE
for DataSource.Required: No
Type: String
Allowed values:
EVENT
Update requires: No interruption
DataType
-
The data type of the event variable.
Valid values:
STRING | INTEGER | BOOLEAN | FLOAT
Required: No
Type: String
Allowed values:
STRING | INTEGER | FLOAT | BOOLEAN
Update requires: No interruption
DefaultValue
-
The default value of the event variable. This is required if you are providing the details of your variables instead of the ARN.
Required: No
Type: String
Update requires: No interruption
Description
-
The description of the event variable.
Required: No
Type: String
Minimum:
1
Maximum:
256
Update requires: No interruption
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 isfalse
, 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 setInline=true
for these variables and CloudFormation will create/update/delete the variables as part of stack operations. However, if you setInline=false
, CloudFormation will associate the variables to your detector but not execute any changes to the variables.Required: No
Type: Boolean
Update requires: No interruption
LastUpdatedTime
-
Timestamp for when the event variable was last updated.
Required: No
Type: String
Update requires: No interruption
Name
-
The name of the event variable.
Required: No
Type: String
Update requires: No interruption
-
An array of key-value pairs to apply to this resource.
For more information, see Tag.
Required: No
Type: Array of Tag
Maximum:
200
Update requires: No interruption
VariableType
-
The type of event variable. For more information, see Variable types.
Required: No
Type: String
Allowed values:
AUTH_CODE | AVS | BILLING_ADDRESS_L1 | BILLING_ADDRESS_L2 | BILLING_CITY | BILLING_COUNTRY | BILLING_NAME | BILLING_PHONE | BILLING_STATE | BILLING_ZIP | CARD_BIN | CATEGORICAL | CURRENCY_CODE | EMAIL_ADDRESS | FINGERPRINT | FRAUD_LABEL | FREE_FORM_TEXT | IP_ADDRESS | NUMERIC | ORDER_ID | PAYMENT_TYPE | PHONE_NUMBER | PRICE | PRODUCT_CATEGORY | SHIPPING_ADDRESS_L1 | SHIPPING_ADDRESS_L2 | SHIPPING_CITY | SHIPPING_COUNTRY | SHIPPING_NAME | SHIPPING_PHONE | SHIPPING_STATE | SHIPPING_ZIP | USERAGENT
Update requires: No interruption