Package software.amazon.awscdk.services.frauddetector

Interface CfnVariableProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnVariableProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.104.0 (build e79254c)",
           date="2024-12-06T14:43:19.529Z")
@Stability(Stable)
public interface CfnVariableProps
extends software.amazon.jsii.JsiiSerializable

Properties for defining a CfnVariable.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.frauddetector.*;
 CfnVariableProps cfnVariableProps = CfnVariableProps.builder()
         .dataSource("dataSource")
         .dataType("dataType")
         .defaultValue("defaultValue")
         .name("name")
         // the properties below are optional
         .description("description")
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .variableType("variableType")
         .build();
 

See Also:

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

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnVariableProps.Builder	A builder for CfnVariableProps
static final class	CfnVariableProps.Jsii$Proxy	An implementation for CfnVariableProps

Method Summary

Modifier and Type	Method	Description
static CfnVariableProps.Builder	builder()
String	getDataSource()	The data source of the variable.
String	getDataType()	The data type of the variable.
String	getDefaultValue()	The default value of the variable.
default String	getDescription()	The description of the variable.
String	getName()	The name of the variable.
default List<CfnTag>	getTags()	An array of key-value pairs to apply to this resource.
default String	getVariableType()	The type of the variable.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getDataSource

@Stability(Stable)
@NotNull
String getDataSource()

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.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-frauddetector-variable.html#cfn-frauddetector-variable-datasource

getDataType

@Stability(Stable)
@NotNull
String getDataType()

The data type of the variable.

Valid data types: STRING | INTEGER | BOOLEAN | FLOAT

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-frauddetector-variable.html#cfn-frauddetector-variable-datatype

getDefaultValue

@Stability(Stable)
@NotNull
String getDefaultValue()

The default value of the variable.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-frauddetector-variable.html#cfn-frauddetector-variable-defaultvalue

getName

@Stability(Stable)
@NotNull
String getName()

The name of the variable.

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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-frauddetector-variable.html#cfn-frauddetector-variable-name

getDescription

@Stability(Stable)
@Nullable
default String getDescription()

The description of the variable.

See Also:

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

getTags

@Stability(Stable)
@Nullable
default List<CfnTag> getTags()

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

For more information, see Tag .

See Also:

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

getVariableType

@Stability(Stable)
@Nullable
default String getVariableType()

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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-frauddetector-variable.html#cfn-frauddetector-variable-variabletype

builder

@Stability(Stable)
static CfnVariableProps.Builder builder()

Returns:

a CfnVariableProps.Builder of CfnVariableProps