software.amazon.awscdk.services.frauddetector

Class CfnVariable

java.lang.Object

software.constructs.Construct

software.amazon.awscdk.core.Construct

software.amazon.awscdk.core.CfnElement

software.amazon.awscdk.core.CfnRefElement

software.amazon.awscdk.core.CfnResource

software.amazon.awscdk.services.frauddetector.CfnVariable

All Implemented Interfaces:

IConstruct, IDependable, IInspectable

@Generated(value="jsii-pacmak/1.67.0 (build 2c027f5)",
           date="2022-09-21T22:30:58.164Z")
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 interface software.amazon.awscdk.core.IInspectable

IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

Nested classes/interfaces inherited from interface software.amazon.awscdk.core.IConstruct

IConstruct.Jsii$Default

Field Summary

Fields

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

Constructor Summary

Constructors

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

Methods inherited from class software.amazon.awscdk.core.CfnResource

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

Methods inherited from class software.amazon.awscdk.core.CfnRefElement

getRef

Methods inherited from class software.amazon.awscdk.core.CfnElement

getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId

Methods inherited from class software.amazon.awscdk.core.Construct

getNode, isConstruct, onPrepare, onSynthesize, onValidate, prepare, synthesize, validate

Methods inherited from class java.lang.Object

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

Field Detail

CFN_RESOURCE_TYPE_NAME

public static final java.lang.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

public CfnVariable(Construct scope,
                   java.lang.String id,
                   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

public void inspect(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

protected java.util.Map<java.lang.String,java.lang.Object> renderProperties(java.util.Map<java.lang.String,java.lang.Object> props)

Overrides:

renderProperties in class CfnResource

Parameters:

props - This parameter is required.

getAttrArn

public java.lang.String getAttrArn()

The ARN of the variable.

getAttrCreatedTime

public java.lang.String getAttrCreatedTime()

Timestamp of when variable was created.

getAttrLastUpdatedTime

public java.lang.String getAttrLastUpdatedTime()

Timestamp of when variable was last updated.

getCfnProperties

protected java.util.Map<java.lang.String,java.lang.Object> getCfnProperties()

Overrides:

getCfnProperties in class CfnResource

getTags

public TagManager getTags()

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

For more information, see Tag .

getDataSource

public java.lang.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

public void setDataSource(java.lang.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

public java.lang.String getDataType()

The data type of the variable.

Valid data types: STRING | INTEGER | BOOLEAN | FLOAT

setDataType

public void setDataType(java.lang.String value)

The data type of the variable.

Valid data types: STRING | INTEGER | BOOLEAN | FLOAT

getDefaultValue

public java.lang.String getDefaultValue()

The default value of the variable.

setDefaultValue

public void setDefaultValue(java.lang.String value)

The default value of the variable.

getName

public java.lang.String getName()

The name of the variable.

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

setName

public void setName(java.lang.String value)

The name of the variable.

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

getDescription

public java.lang.String getDescription()

The description of the variable.

setDescription

public void setDescription(java.lang.String value)

The description of the variable.

getVariableType

public java.lang.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

public void setVariableType(java.lang.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