AWS::FraudDetector::Variable - AWS CloudFormation (original) (raw)

Manages a variable.

Syntax

To declare this entity in your AWS CloudFormation template, use the following syntax:

JSON

{
  "Type" : "AWS::FraudDetector::Variable",
  "Properties" : {
      "DataSource" : String,
      "DataType" : String,
      "DefaultValue" : String,
      "Description" : String,
      "Name" : String,
      "Tags" : [ Tag, ... ],
      "VariableType" : String
    }
}

YAML

Type: AWS::FraudDetector::Variable
Properties:
  DataSource: String
  DataType: String
  DefaultValue: String
  Description: String
  Name: String
  Tags: 
    - Tag
  VariableType: String

Properties

DataSource

The data source of the 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.

Required: Yes

Type: String

Allowed values: EVENT | EXTERNAL_MODEL_SCORE

Update requires: No interruption

DataType

The data type of the variable.

Valid data types: STRING | INTEGER | BOOLEAN | FLOAT

Required: Yes

Type: String

Allowed values: STRING | INTEGER | FLOAT | BOOLEAN

Update requires: No interruption

DefaultValue

The default value of the variable.

Required: Yes

Type: String

Update requires: No interruption

Description

The description of the variable.

Required: No

Type: String

Minimum: 1

Maximum: 256

Update requires: No interruption

Name

The name of the variable.

Pattern: ^[0-9a-z_-]+$

Required: Yes

Type: String

Pattern: ^[a-z_][a-z0-9_]{0,99}?$

Update requires: Replacement

Tags

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 the variable. For more information see Variable types.

Valid 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

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

Return values

Ref

When you pass the logical ID of this resource to the intrinsic Ref function, Ref returns the primary identifier for the resource, which is the ARN.

Example: { "Ref": "arn:aws:frauddetector:us-west-2:123123123123:outcome/outcome_name"}

For more information about using the Ref function, see Ref.

Fn::GetAtt

The Fn::GetAtt intrinsic function returns a value for a specified attribute of this type. The following are the available attributes and sample return values.

For more information about using the Fn::GetAtt intrinsic function, see Fn::GetAtt.

Arn

The ARN of the variable.

CreatedTime

Timestamp of when variable was created.

LastUpdatedTime

Timestamp of when variable was last updated.

See also