software.amazon.awscdk.services.frauddetector

Class CfnVariable

java.lang.Object

software.amazon.jsii.JsiiObject

software.constructs.Construct

software.amazon.awscdk.CfnElement

software.amazon.awscdk.CfnRefElement

software.amazon.awscdk.CfnResource

software.amazon.awscdk.services.frauddetector.CfnVariable

All Implemented Interfaces:

IInspectable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable

@Generated(value="jsii-pacmak/1.67.0 (build 2c027f5)",
           date="2022-09-19T20:26:39.419Z")
 @Stability(value=Stable)
public class CfnVariable
extends CfnResource
implements IInspectable

A CloudFormation `AWS::FraudDetector::Variable`.

Manages a variable.

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.*;
 CfnVariable cfnVariable = CfnVariable.Builder.create(this, "MyCfnVariable")
         .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();
 

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CfnVariable.Builder A fluent builder for CfnVariable.

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.amazon.awscdk.IInspectable

IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

Nested classes/interfaces inherited from interface software.constructs.IConstruct

software.constructs.IConstruct.Jsii$Default

Field Summary

Fields

Modifier and Type	Field and Description
static String	CFN_RESOURCE_TYPE_NAME The CloudFormation resource type name for this resource class.

Constructor Summary

Constructors

Modifier	Constructor and Description
	CfnVariable(software.constructs.Construct scope, String id, CfnVariableProps props) Create a new `AWS::FraudDetector::Variable`.
protected	CfnVariable(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnVariable(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method and Description
String	getAttrArn() The ARN of the variable.
String	getAttrCreatedTime() Timestamp of when variable was created.
String	getAttrLastUpdatedTime() Timestamp of when variable was last updated.
protected Map<String,Object>	getCfnProperties()
String	getDataSource() The data source of the variable.
String	getDataType() The data type of the variable.
String	getDefaultValue() The default value of the variable.
String	getDescription() The description of the variable.
String	getName() The name of the variable.
TagManager	getTags() An array of key-value pairs to apply to this resource.
String	getVariableType() The type of the variable.
void	inspect(TreeInspector inspector) Examines the CloudFormation resource and discloses attributes.
protected Map<String,Object>	renderProperties(Map<String,Object> props)
void	setDataSource(String value) The data source of the variable.
void	setDataType(String value) The data type of the variable.
void	setDefaultValue(String value) The default value of the variable.
void	setDescription(String value) The description of the variable.
void	setName(String value) The name of the variable.
void	setVariableType(String value) The type of the variable.

Methods inherited from class software.amazon.awscdk.CfnResource

addDeletionOverride, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, getUpdatedProperties, isCfnResource, shouldSynthesize, toString, validateProperties

Methods inherited from class software.amazon.awscdk.CfnRefElement

getRef

Methods inherited from class software.amazon.awscdk.CfnElement

getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId

Methods inherited from class software.constructs.Construct

getNode, isConstruct

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Field Detail

CFN_RESOURCE_TYPE_NAME

@Stability(value=Stable)
public static final String CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

Constructor Detail

CfnVariable

protected CfnVariable(software.amazon.jsii.JsiiObjectRef objRef)

CfnVariable

protected CfnVariable(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

CfnVariable

@Stability(value=Stable)
public CfnVariable(@NotNull
                                            software.constructs.Construct scope,
                                            @NotNull
                                            String id,
                                            @NotNull
                                            CfnVariableProps props)

Create a new `AWS::FraudDetector::Variable`.

Parameters:

scope - - scope in which this resource is defined. This parameter is required.

id - - scoped id of the resource. This parameter is required.

props - - resource properties. This parameter is required.

Method Detail

inspect

@Stability(value=Stable)
public void inspect(@NotNull
                                             TreeInspector inspector)

Examines the CloudFormation resource and discloses attributes.

Specified by:

inspect in interface IInspectable

Parameters:

inspector - - tree inspector to collect and process attributes. This parameter is required.

renderProperties

@Stability(value=Stable)
 @NotNull
protected Map<String,Object> renderProperties(@NotNull
                                                                                 Map<String,Object> props)

Overrides:

renderProperties in class CfnResource

Parameters:

props - This parameter is required.

getAttrArn

@Stability(value=Stable)
 @NotNull
public String getAttrArn()

The ARN of the variable.

getAttrCreatedTime

@Stability(value=Stable)
 @NotNull
public String getAttrCreatedTime()

Timestamp of when variable was created.

getAttrLastUpdatedTime

@Stability(value=Stable)
 @NotNull
public String getAttrLastUpdatedTime()

Timestamp of when variable was last updated.

getCfnProperties

@Stability(value=Stable)
 @NotNull
protected Map<String,Object> getCfnProperties()

Overrides:

getCfnProperties in class CfnResource

getTags

@Stability(value=Stable)
 @NotNull
public TagManager getTags()

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

For more information, see Tag .

getDataSource

@Stability(value=Stable)
 @NotNull
public 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.

setDataSource

@Stability(value=Stable)
public void setDataSource(@NotNull
                                                   String value)

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.

getDataType

@Stability(value=Stable)
 @NotNull
public String getDataType()

The data type of the variable.

Valid data types: STRING | INTEGER | BOOLEAN | FLOAT

setDataType

@Stability(value=Stable)
public void setDataType(@NotNull
                                                 String value)

The data type of the variable.

Valid data types: STRING | INTEGER | BOOLEAN | FLOAT

getDefaultValue

@Stability(value=Stable)
 @NotNull
public String getDefaultValue()

The default value of the variable.

setDefaultValue

@Stability(value=Stable)
public void setDefaultValue(@NotNull
                                                     String value)

The default value of the variable.

getName

@Stability(value=Stable)
 @NotNull
public String getName()

The name of the variable.

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

setName

@Stability(value=Stable)
public void setName(@NotNull
                                             String value)

The name of the variable.

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

getDescription

@Stability(value=Stable)
 @Nullable
public String getDescription()

The description of the variable.

setDescription

@Stability(value=Stable)
public void setDescription(@Nullable
                                                    String value)

The description of the variable.

getVariableType

@Stability(value=Stable)
 @Nullable
public String getVariableType()

The type of the variable. For more information see [Variable types](https://docs.aws.amazon.com/frauddetector/latest/ug/create-a-variable.html#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

setVariableType

@Stability(value=Stable)
public void setVariableType(@Nullable
                                                     String value)

The type of the variable. For more information see [Variable types](https://docs.aws.amazon.com/frauddetector/latest/ug/create-a-variable.html#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