Package software.amazon.awscdk.services.frauddetector

Class CfnVariable

java.lang.Object
software.amazon.jsii.JsiiObject
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, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct
@Generated(value="jsii-pacmak/1.84.0 (build 5404dcf)", date="2023-06-19T16:29:56.846Z") @Stability(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();

  • Field Details

    • CFN_RESOURCE_TYPE_NAME

      @Stability(Stable) public static final String CFN_RESOURCE_TYPE_NAME
      The CloudFormation resource type name for this resource class.

  • Constructor Details

    • CfnVariable

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

    • CfnVariable

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

    • CfnVariable

      @Stability(Stable) public CfnVariable(@NotNull 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 Details

    • inspect

      @Stability(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(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(Stable) @NotNull public String getAttrArn()
      The ARN of the variable.

    • getAttrCreatedTime

      @Stability(Stable) @NotNull public String getAttrCreatedTime()
      Timestamp of when variable was created.

    • getAttrLastUpdatedTime

      @Stability(Stable) @NotNull public String getAttrLastUpdatedTime()
      Timestamp of when variable was last updated.

    • getCfnProperties

      @Stability(Stable) @NotNull protected Map<String,Object> getCfnProperties()
      Overrides:
      getCfnProperties in class CfnResource

    • getTags

      @Stability(Stable) @NotNull public TagManager getTags()
      An array of key-value pairs to apply to this resource.

      For more information, see Tag .

    • getDataSource

      @Stability(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(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(Stable) @NotNull public String getDataType()
      The data type of the variable.

      Valid data types: STRING | INTEGER | BOOLEAN | FLOAT

    • setDataType

      @Stability(Stable) public void setDataType(@NotNull String value)
      The data type of the variable.

      Valid data types: STRING | INTEGER | BOOLEAN | FLOAT

    • getDefaultValue

      @Stability(Stable) @NotNull public String getDefaultValue()
      The default value of the variable.

    • setDefaultValue

      @Stability(Stable) public void setDefaultValue(@NotNull String value)
      The default value of the variable.

    • getName

      @Stability(Stable) @NotNull public String getName()
      The name of the variable.

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

    • setName

      @Stability(Stable) public void setName(@NotNull String value)
      The name of the variable.

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

    • getDescription

      @Stability(Stable) @Nullable public String getDescription()
      The description of the variable.

    • setDescription

      @Stability(Stable) public void setDescription(@Nullable String value)
      The description of the variable.

    • getVariableType

      @Stability(Stable) @Nullable public 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

    • setVariableType

      @Stability(Stable) public void setVariableType(@Nullable String value)
      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