aws-cdk-lib.aws_frauddetector.CfnDetector.EventVariableProperty

interface EventVariableProperty

LanguageType name
.NETAmazon.CDK.AWS.FraudDetector.CfnDetector.EventVariableProperty
Gogithub.com/aws/aws-cdk-go/awscdk/v2/awsfrauddetector#CfnDetector_EventVariableProperty
Javasoftware.amazon.awscdk.services.frauddetector.CfnDetector.EventVariableProperty
Pythonaws_cdk.aws_frauddetector.CfnDetector.EventVariableProperty
TypeScript aws-cdk-lib » aws_frauddetector » CfnDetector » EventVariableProperty

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 { aws_frauddetector as frauddetector } from 'aws-cdk-lib';
const eventVariableProperty: frauddetector.CfnDetector.EventVariableProperty = {
  arn: 'arn',
  createdTime: 'createdTime',
  dataSource: 'dataSource',
  dataType: 'dataType',
  defaultValue: 'defaultValue',
  description: 'description',
  inline: false,
  lastUpdatedTime: 'lastUpdatedTime',
  name: 'name',
  tags: [{
    key: 'key',
    value: 'value',
  }],
  variableType: 'variableType',
};

Properties

NameTypeDescription
arn?stringThe event variable ARN.
createdTime?stringTimestamp for when the event variable was created.
dataSource?stringThe data source of the event variable.
dataType?stringThe data type of the event variable.
defaultValue?stringThe default value of the event variable.
description?stringThe description of the event variable.
inline?boolean | IResolvableIndicates whether the resource is defined within this CloudFormation template and impacts the create, update, and delete behavior of the stack.
lastUpdatedTime?stringTimestamp for when the event variable was last updated.
name?stringThe name of the event variable.
tags?CfnTag[]An array of key-value pairs to apply to this resource.
variableType?stringThe type of event variable.

arn?

Type: string (optional)

The event variable ARN.


createdTime?

Type: string (optional)

Timestamp for when the event variable was created.


dataSource?

Type: string (optional)

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.


dataType?

Type: string (optional)

The data type of the event variable.

Valid values: STRING | INTEGER | BOOLEAN | FLOAT


defaultValue?

Type: string (optional)

The default value of the event variable.

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


description?

Type: string (optional)

The description of the event variable.


inline?

Type: boolean | IResolvable (optional)

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.


lastUpdatedTime?

Type: string (optional)

Timestamp for when the event variable was last updated.


name?

Type: string (optional)

The name of the event variable.


tags?

Type: CfnTag[] (optional)

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

For more information, see Tag .


variableType?

Type: string (optional)

The type of event variable.

For more information, see Variable types .