Package software.amazon.awscdk.services.frauddetector

Interface CfnDetector.EventVariableProperty

All Superinterfaces:
software.amazon.jsii.JsiiSerializable
All Known Implementing Classes:
CfnDetector.EventVariableProperty.Jsii$Proxy
Enclosing class:
CfnDetector
@Stability(Stable) public static interface CfnDetector.EventVariableProperty extends software.amazon.jsii.JsiiSerializable
The event type variable for the detector.

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.*;
 EventVariableProperty eventVariableProperty = EventVariableProperty.builder()
         .arn("arn")
         .createdTime("createdTime")
         .dataSource("dataSource")
         .dataType("dataType")
         .defaultValue("defaultValue")
         .description("description")
         .inline(false)
         .lastUpdatedTime("lastUpdatedTime")
         .name("name")
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .variableType("variableType")
         .build();

  • Method Details

    • getArn

      @Stability(Stable) @Nullable default String getArn()
      The event variable ARN.

    • getCreatedTime

      @Stability(Stable) @Nullable default String getCreatedTime()
      Timestamp for when the event variable was created.

    • getDataSource

      @Stability(Stable) @Nullable default String getDataSource()
      The data source of the event 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) @Nullable default String getDataType()
      The data type of the event variable.

      Valid values: STRING | INTEGER | BOOLEAN | FLOAT

    • getDefaultValue

      @Stability(Stable) @Nullable default String getDefaultValue()
      The default value of the event variable.

      This is required if you are providing the details of your variables instead of the ARN.

    • getDescription

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

    • getInline

      @Stability(Stable) @Nullable default Object getInline()
      Indicates whether the resource is defined within this CloudFormation template and impacts the create, update, and delete behavior of the stack.

      If the value is true , CloudFormation will create/update/delete the resource when creating/updating/deleting the stack. If the value is false , CloudFormation will validate that the object exists and then use it within the resource without making changes to the object.

      For example, when creating AWS::FraudDetector::Detector you must define at least two variables. You can set Inline=true for these variables and CloudFormation will create/update/delete the variables as part of stack operations. However, if you set Inline=false , CloudFormation will associate the variables to your detector but not execute any changes to the variables.

    • getLastUpdatedTime

      @Stability(Stable) @Nullable default String getLastUpdatedTime()
      Timestamp for when the event variable was last updated.

    • getName

      @Stability(Stable) @Nullable default String getName()
      The name of the event variable.

    • getTags

      @Stability(Stable) @Nullable default List<CfnTag> getTags()
      An array of key-value pairs to apply to this resource.

      For more information, see Tag .

    • getVariableType

      @Stability(Stable) @Nullable default String getVariableType()
      The type of event variable.

      For more information, see Variable types .

    • builder

      @Stability(Stable) static CfnDetector.EventVariableProperty.Builder builder()
      Returns:
      a CfnDetector.EventVariableProperty.Builder of CfnDetector.EventVariableProperty