awsfrauddetector

package
v2.14.0 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Feb 25, 2022 License: Apache-2.0 Imports: 6 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func CfnDetector_CFN_RESOURCE_TYPE_NAME 

func CfnDetector_CFN_RESOURCE_TYPE_NAME() *string

func CfnDetector_IsCfnElement 

func CfnDetector_IsCfnElement(x interface{}) *bool

Returns `true` if a construct is a stack element (i.e. part of the synthesized cloudformation template).

Uses duck-typing instead of `instanceof` to allow stack elements from different versions of this library to be included in the same stack.

Returns: The construct as a stack element or undefined if it is not a stack element.

func CfnDetector_IsCfnResource 

func CfnDetector_IsCfnResource(construct constructs.IConstruct) *bool

Check whether the given construct is a CfnResource.

func CfnDetector_IsConstruct 

func CfnDetector_IsConstruct(x interface{}) *bool

Checks if `x` is a construct.

Returns: true if `x` is an object created from a class which extends `Construct`. Deprecated: use `x instanceof Construct` instead

func CfnEntityType_CFN_RESOURCE_TYPE_NAME 

func CfnEntityType_CFN_RESOURCE_TYPE_NAME() *string

func CfnEntityType_IsCfnElement 

func CfnEntityType_IsCfnElement(x interface{}) *bool

Returns `true` if a construct is a stack element (i.e. part of the synthesized cloudformation template).

Uses duck-typing instead of `instanceof` to allow stack elements from different versions of this library to be included in the same stack.

Returns: The construct as a stack element or undefined if it is not a stack element.

func CfnEntityType_IsCfnResource 

func CfnEntityType_IsCfnResource(construct constructs.IConstruct) *bool

Check whether the given construct is a CfnResource.

func CfnEntityType_IsConstruct 

func CfnEntityType_IsConstruct(x interface{}) *bool

Checks if `x` is a construct.

Returns: true if `x` is an object created from a class which extends `Construct`. Deprecated: use `x instanceof Construct` instead

func CfnEventType_CFN_RESOURCE_TYPE_NAME 

func CfnEventType_CFN_RESOURCE_TYPE_NAME() *string

func CfnEventType_IsCfnElement 

func CfnEventType_IsCfnElement(x interface{}) *bool

Returns `true` if a construct is a stack element (i.e. part of the synthesized cloudformation template).

Uses duck-typing instead of `instanceof` to allow stack elements from different versions of this library to be included in the same stack.

Returns: The construct as a stack element or undefined if it is not a stack element.

func CfnEventType_IsCfnResource 

func CfnEventType_IsCfnResource(construct constructs.IConstruct) *bool

Check whether the given construct is a CfnResource.

func CfnEventType_IsConstruct 

func CfnEventType_IsConstruct(x interface{}) *bool

Checks if `x` is a construct.

Returns: true if `x` is an object created from a class which extends `Construct`. Deprecated: use `x instanceof Construct` instead

func CfnLabel_CFN_RESOURCE_TYPE_NAME 

func CfnLabel_CFN_RESOURCE_TYPE_NAME() *string

func CfnLabel_IsCfnElement 

func CfnLabel_IsCfnElement(x interface{}) *bool

Returns `true` if a construct is a stack element (i.e. part of the synthesized cloudformation template).

Uses duck-typing instead of `instanceof` to allow stack elements from different versions of this library to be included in the same stack.

Returns: The construct as a stack element or undefined if it is not a stack element.

func CfnLabel_IsCfnResource 

func CfnLabel_IsCfnResource(construct constructs.IConstruct) *bool

Check whether the given construct is a CfnResource.

func CfnLabel_IsConstruct 

func CfnLabel_IsConstruct(x interface{}) *bool

Checks if `x` is a construct.

Returns: true if `x` is an object created from a class which extends `Construct`. Deprecated: use `x instanceof Construct` instead

func CfnOutcome_CFN_RESOURCE_TYPE_NAME 

func CfnOutcome_CFN_RESOURCE_TYPE_NAME() *string

func CfnOutcome_IsCfnElement 

func CfnOutcome_IsCfnElement(x interface{}) *bool

Returns `true` if a construct is a stack element (i.e. part of the synthesized cloudformation template).

Uses duck-typing instead of `instanceof` to allow stack elements from different versions of this library to be included in the same stack.

Returns: The construct as a stack element or undefined if it is not a stack element.

func CfnOutcome_IsCfnResource 

func CfnOutcome_IsCfnResource(construct constructs.IConstruct) *bool

Check whether the given construct is a CfnResource.

func CfnOutcome_IsConstruct 

func CfnOutcome_IsConstruct(x interface{}) *bool

Checks if `x` is a construct.

Returns: true if `x` is an object created from a class which extends `Construct`. Deprecated: use `x instanceof Construct` instead

func CfnVariable_CFN_RESOURCE_TYPE_NAME 

func CfnVariable_CFN_RESOURCE_TYPE_NAME() *string

func CfnVariable_IsCfnElement 

func CfnVariable_IsCfnElement(x interface{}) *bool

Returns `true` if a construct is a stack element (i.e. part of the synthesized cloudformation template).

Uses duck-typing instead of `instanceof` to allow stack elements from different versions of this library to be included in the same stack.

Returns: The construct as a stack element or undefined if it is not a stack element.

func CfnVariable_IsCfnResource 

func CfnVariable_IsCfnResource(construct constructs.IConstruct) *bool

Check whether the given construct is a CfnResource.

func CfnVariable_IsConstruct 

func CfnVariable_IsConstruct(x interface{}) *bool

Checks if `x` is a construct.

Returns: true if `x` is an object created from a class which extends `Construct`. Deprecated: use `x instanceof Construct` instead

func NewCfnDetector_Override 

func NewCfnDetector_Override(c CfnDetector, scope constructs.Construct, id *string, props *CfnDetectorProps)

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

func NewCfnEntityType_Override 

func NewCfnEntityType_Override(c CfnEntityType, scope constructs.Construct, id *string, props *CfnEntityTypeProps)

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

func NewCfnEventType_Override 

func NewCfnEventType_Override(c CfnEventType, scope constructs.Construct, id *string, props *CfnEventTypeProps)

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

func NewCfnLabel_Override 

func NewCfnLabel_Override(c CfnLabel, scope constructs.Construct, id *string, props *CfnLabelProps)

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

func NewCfnOutcome_Override 

func NewCfnOutcome_Override(c CfnOutcome, scope constructs.Construct, id *string, props *CfnOutcomeProps)

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

func NewCfnVariable_Override 

func NewCfnVariable_Override(c CfnVariable, scope constructs.Construct, id *string, props *CfnVariableProps)

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

Types

type CfnDetector 

type CfnDetector interface {
	awscdk.CfnResource
	awscdk.IInspectable
	AssociatedModels() interface{}
	SetAssociatedModels(val interface{})
	AttrArn() *string
	AttrCreatedTime() *string
	AttrDetectorVersionId() *string
	AttrEventTypeArn() *string
	AttrEventTypeCreatedTime() *string
	AttrEventTypeLastUpdatedTime() *string
	AttrLastUpdatedTime() *string
	CfnOptions() awscdk.ICfnResourceOptions
	CfnProperties() *map[string]interface{}
	CfnResourceType() *string
	CreationStack() *[]*string
	Description() *string
	SetDescription(val *string)
	DetectorId() *string
	SetDetectorId(val *string)
	DetectorVersionStatus() *string
	SetDetectorVersionStatus(val *string)
	EventType() interface{}
	SetEventType(val interface{})
	LogicalId() *string
	Node() constructs.Node
	Ref() *string
	RuleExecutionMode() *string
	SetRuleExecutionMode(val *string)
	Rules() interface{}
	SetRules(val interface{})
	Stack() awscdk.Stack
	Tags() awscdk.TagManager
	UpdatedProperites() *map[string]interface{}
	AddDeletionOverride(path *string)
	AddDependsOn(target awscdk.CfnResource)
	AddMetadata(key *string, value interface{})
	AddOverride(path *string, value interface{})
	AddPropertyDeletionOverride(propertyPath *string)
	AddPropertyOverride(propertyPath *string, value interface{})
	ApplyRemovalPolicy(policy awscdk.RemovalPolicy, options *awscdk.RemovalPolicyOptions)
	GetAtt(attributeName *string) awscdk.Reference
	GetMetadata(key *string) interface{}
	Inspect(inspector awscdk.TreeInspector)
	OverrideLogicalId(newLogicalId *string)
	RenderProperties(props *map[string]interface{}) *map[string]interface{}
	ShouldSynthesize() *bool
	ToString() *string
	ValidateProperties(_properties interface{})
}

A CloudFormation `AWS::FraudDetector::Detector`.

Manages a detector and associated detector versions.

TODO: EXAMPLE

func NewCfnDetector 

func NewCfnDetector(scope constructs.Construct, id *string, props *CfnDetectorProps) CfnDetector

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

type CfnDetectorProps 

type CfnDetectorProps struct {
	// The name of the detector.
	DetectorId *string `json:"detectorId" yaml:"detectorId"`
	// The event type associated with this detector.
	EventType interface{} `json:"eventType" yaml:"eventType"`
	// The rules to include in the detector version.
	Rules interface{} `json:"rules" yaml:"rules"`
	// The models to associate with this detector.
	//
	// You must provide the ARNs of all the models you want to associate.
	AssociatedModels interface{} `json:"associatedModels" yaml:"associatedModels"`
	// The detector description.
	Description *string `json:"description" yaml:"description"`
	// The status of the detector version.
	//
	// If a value is not provided for this property, AWS CloudFormation assumes `DRAFT` status.
	//
	// Valid values: `ACTIVE | DRAFT`
	DetectorVersionStatus *string `json:"detectorVersionStatus" yaml:"detectorVersionStatus"`
	// The rule execution mode for the rules included in the detector version.
	//
	// Valid values: `FIRST_MATCHED | ALL_MATCHED` Default value: `FIRST_MATCHED`
	//
	// You can define and edit the rule mode at the detector version level, when it is in draft status.
	//
	// If you specify `FIRST_MATCHED` , Amazon Fraud Detector evaluates rules sequentially, first to last, stopping at the first matched rule. Amazon Fraud dectector then provides the outcomes for that single rule.
	//
	// If you specifiy `ALL_MATCHED` , Amazon Fraud Detector evaluates all rules and returns the outcomes for all matched rules.
	RuleExecutionMode *string `json:"ruleExecutionMode" yaml:"ruleExecutionMode"`
	// An array of key-value pairs to apply to this resource.
	//
	// For more information, see [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html) .
	Tags *[]*awscdk.CfnTag `json:"tags" yaml:"tags"`
}

Properties for defining a `CfnDetector`.

TODO: EXAMPLE

type CfnDetector_EntityTypeProperty 

type CfnDetector_EntityTypeProperty struct {
	// The entity type ARN.
	Arn *string `json:"arn" yaml:"arn"`
	// Timestamp of when the entity type was created.
	CreatedTime *string `json:"createdTime" yaml:"createdTime"`
	// The entity type description.
	Description *string `json:"description" yaml:"description"`
	// 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.
	Inline interface{} `json:"inline" yaml:"inline"`
	// Timestamp of when the entity type was last updated.
	LastUpdatedTime *string `json:"lastUpdatedTime" yaml:"lastUpdatedTime"`
	// The entity type name.
	Name *string `json:"name" yaml:"name"`
	// An array of key-value pairs to apply to this resource.
	//
	// For more information, see [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html) .
	Tags *[]*awscdk.CfnTag `json:"tags" yaml:"tags"`
}

The entity type details.

TODO: EXAMPLE

type CfnDetector_EventTypeProperty 

type CfnDetector_EventTypeProperty struct {
	// The entity type ARN.
	Arn *string `json:"arn" yaml:"arn"`
	// Timestamp of when the event type was created.
	CreatedTime *string `json:"createdTime" yaml:"createdTime"`
	// The event type description.
	Description *string `json:"description" yaml:"description"`
	// The event type entity types.
	EntityTypes interface{} `json:"entityTypes" yaml:"entityTypes"`
	// The event type event variables.
	EventVariables interface{} `json:"eventVariables" yaml:"eventVariables"`
	// 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.
	Inline interface{} `json:"inline" yaml:"inline"`
	// The event type labels.
	Labels interface{} `json:"labels" yaml:"labels"`
	// Timestamp of when the event type was last updated.
	LastUpdatedTime *string `json:"lastUpdatedTime" yaml:"lastUpdatedTime"`
	// The event type name.
	Name *string `json:"name" yaml:"name"`
	// An array of key-value pairs to apply to this resource.
	//
	// For more information, see [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html) .
	Tags *[]*awscdk.CfnTag `json:"tags" yaml:"tags"`
}

The event type details.

TODO: EXAMPLE

type CfnDetector_EventVariableProperty 

type CfnDetector_EventVariableProperty struct {
	// The event variable ARN.
	Arn *string `json:"arn" yaml:"arn"`
	// Timestamp for when the event variable was created.
	CreatedTime *string `json:"createdTime" yaml:"createdTime"`
	// 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.
	DataSource *string `json:"dataSource" yaml:"dataSource"`
	// The data type of the event variable.
	//
	// Valid values: `STRING | INTEGER | BOOLEAN | FLOAT`
	DataType *string `json:"dataType" yaml:"dataType"`
	// The default value of the event variable.
	//
	// This is required if you are providing the details of your variables instead of the ARN.
	DefaultValue *string `json:"defaultValue" yaml:"defaultValue"`
	// The description of the event variable.
	Description *string `json:"description" yaml:"description"`
	// 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.
	Inline interface{} `json:"inline" yaml:"inline"`
	// Timestamp for when the event variable was last updated.
	LastUpdatedTime *string `json:"lastUpdatedTime" yaml:"lastUpdatedTime"`
	// The name of the event variable.
	Name *string `json:"name" yaml:"name"`
	// An array of key-value pairs to apply to this resource.
	//
	// For more information, see [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html) .
	Tags *[]*awscdk.CfnTag `json:"tags" yaml:"tags"`
	// The type of event variable.
	//
	// For more information, see [Variable types](https://docs.aws.amazon.com/frauddetector/latest/ug/create-a-variable.html#variable-types) .
	VariableType *string `json:"variableType" yaml:"variableType"`
}

The event type variable for the detector.

TODO: EXAMPLE

type CfnDetector_LabelProperty 

type CfnDetector_LabelProperty struct {
	// The label ARN.
	Arn *string `json:"arn" yaml:"arn"`
	// Timestamp of when the event type was created.
	CreatedTime *string `json:"createdTime" yaml:"createdTime"`
	// The label description.
	Description *string `json:"description" yaml:"description"`
	// 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.
	Inline interface{} `json:"inline" yaml:"inline"`
	// Timestamp of when the label was last updated.
	LastUpdatedTime *string `json:"lastUpdatedTime" yaml:"lastUpdatedTime"`
	// The label name.
	Name *string `json:"name" yaml:"name"`
	// An array of key-value pairs to apply to this resource.
	//
	// For more information, see [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html) .
	Tags *[]*awscdk.CfnTag `json:"tags" yaml:"tags"`
}

The label details.

TODO: EXAMPLE

type CfnDetector_ModelProperty 

type CfnDetector_ModelProperty struct {
	// The ARN of the model.
	Arn *string `json:"arn" yaml:"arn"`
}

The model.

TODO: EXAMPLE

type CfnDetector_OutcomeProperty 

type CfnDetector_OutcomeProperty struct {
	// The outcome ARN.
	Arn *string `json:"arn" yaml:"arn"`
	// The timestamp when the outcome was created.
	CreatedTime *string `json:"createdTime" yaml:"createdTime"`
	// The outcome description.
	Description *string `json:"description" yaml:"description"`
	// 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.
	Inline interface{} `json:"inline" yaml:"inline"`
	// The timestamp when the outcome was last updated.
	LastUpdatedTime *string `json:"lastUpdatedTime" yaml:"lastUpdatedTime"`
	// The outcome name.
	Name *string `json:"name" yaml:"name"`
	// An array of key-value pairs to apply to this resource.
	//
	// For more information, see [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html) .
	Tags *[]*awscdk.CfnTag `json:"tags" yaml:"tags"`
}

The outcome.

TODO: EXAMPLE

type CfnDetector_RuleProperty 

type CfnDetector_RuleProperty struct {
	// The rule ARN.
	Arn *string `json:"arn" yaml:"arn"`
	// Timestamp for when the rule was created.
	CreatedTime *string `json:"createdTime" yaml:"createdTime"`
	// The rule description.
	Description *string `json:"description" yaml:"description"`
	// The detector for which the rule is associated.
	DetectorId *string `json:"detectorId" yaml:"detectorId"`
	// The rule expression.
	//
	// A rule expression captures the business logic. For more information, see [Rule language reference](https://docs.aws.amazon.com/frauddetector/latest/ug/rule-language-reference.html) .
	Expression *string `json:"expression" yaml:"expression"`
	// The rule language.
	Language *string `json:"language" yaml:"language"`
	// Timestamp for when the rule was last updated.
	LastUpdatedTime *string `json:"lastUpdatedTime" yaml:"lastUpdatedTime"`
	// The rule outcome.
	Outcomes interface{} `json:"outcomes" yaml:"outcomes"`
	// The rule ID.
	RuleId *string `json:"ruleId" yaml:"ruleId"`
	// The rule version.
	RuleVersion *string `json:"ruleVersion" yaml:"ruleVersion"`
	// An array of key-value pairs to apply to this resource.
	//
	// For more information, see [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html) .
	Tags *[]*awscdk.CfnTag `json:"tags" yaml:"tags"`
}

A rule.

Rule is a condition that tells Amazon Fraud Detector how to interpret variables values during a fraud prediction.

TODO: EXAMPLE

type CfnEntityType 

type CfnEntityType interface {
	awscdk.CfnResource
	awscdk.IInspectable
	AttrArn() *string
	AttrCreatedTime() *string
	AttrLastUpdatedTime() *string
	CfnOptions() awscdk.ICfnResourceOptions
	CfnProperties() *map[string]interface{}
	CfnResourceType() *string
	CreationStack() *[]*string
	Description() *string
	SetDescription(val *string)
	LogicalId() *string
	Name() *string
	SetName(val *string)
	Node() constructs.Node
	Ref() *string
	Stack() awscdk.Stack
	Tags() awscdk.TagManager
	UpdatedProperites() *map[string]interface{}
	AddDeletionOverride(path *string)
	AddDependsOn(target awscdk.CfnResource)
	AddMetadata(key *string, value interface{})
	AddOverride(path *string, value interface{})
	AddPropertyDeletionOverride(propertyPath *string)
	AddPropertyOverride(propertyPath *string, value interface{})
	ApplyRemovalPolicy(policy awscdk.RemovalPolicy, options *awscdk.RemovalPolicyOptions)
	GetAtt(attributeName *string) awscdk.Reference
	GetMetadata(key *string) interface{}
	Inspect(inspector awscdk.TreeInspector)
	OverrideLogicalId(newLogicalId *string)
	RenderProperties(props *map[string]interface{}) *map[string]interface{}
	ShouldSynthesize() *bool
	ToString() *string
	ValidateProperties(_properties interface{})
}

A CloudFormation `AWS::FraudDetector::EntityType`.

Manages an entity type. An entity represents who is performing the event. As part of a fraud prediction, you pass the entity ID to indicate the specific entity who performed the event. An entity type classifies the entity. Example classifications include customer, merchant, or account.

TODO: EXAMPLE

func NewCfnEntityType 

func NewCfnEntityType(scope constructs.Construct, id *string, props *CfnEntityTypeProps) CfnEntityType

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

type CfnEntityTypeProps 

type CfnEntityTypeProps struct {
	// The entity type name.
	//
	// Pattern: `^[0-9a-z_-]+$`
	Name *string `json:"name" yaml:"name"`
	// The entity type description.
	Description *string `json:"description" yaml:"description"`
	// A key and value pair.
	Tags *[]*awscdk.CfnTag `json:"tags" yaml:"tags"`
}

Properties for defining a `CfnEntityType`.

TODO: EXAMPLE

type CfnEventType 

type CfnEventType interface {
	awscdk.CfnResource
	awscdk.IInspectable
	AttrArn() *string
	AttrCreatedTime() *string
	AttrLastUpdatedTime() *string
	CfnOptions() awscdk.ICfnResourceOptions
	CfnProperties() *map[string]interface{}
	CfnResourceType() *string
	CreationStack() *[]*string
	Description() *string
	SetDescription(val *string)
	EntityTypes() interface{}
	SetEntityTypes(val interface{})
	EventVariables() interface{}
	SetEventVariables(val interface{})
	Labels() interface{}
	SetLabels(val interface{})
	LogicalId() *string
	Name() *string
	SetName(val *string)
	Node() constructs.Node
	Ref() *string
	Stack() awscdk.Stack
	Tags() awscdk.TagManager
	UpdatedProperites() *map[string]interface{}
	AddDeletionOverride(path *string)
	AddDependsOn(target awscdk.CfnResource)
	AddMetadata(key *string, value interface{})
	AddOverride(path *string, value interface{})
	AddPropertyDeletionOverride(propertyPath *string)
	AddPropertyOverride(propertyPath *string, value interface{})
	ApplyRemovalPolicy(policy awscdk.RemovalPolicy, options *awscdk.RemovalPolicyOptions)
	GetAtt(attributeName *string) awscdk.Reference
	GetMetadata(key *string) interface{}
	Inspect(inspector awscdk.TreeInspector)
	OverrideLogicalId(newLogicalId *string)
	RenderProperties(props *map[string]interface{}) *map[string]interface{}
	ShouldSynthesize() *bool
	ToString() *string
	ValidateProperties(_properties interface{})
}

A CloudFormation `AWS::FraudDetector::EventType`.

Manages an event type. An event is a business activity that is evaluated for fraud risk. With Amazon Fraud Detector, you generate fraud predictions for events. An event type defines the structure for an event sent to Amazon Fraud Detector. This includes the variables sent as part of the event, the entity performing the event (such as a customer), and the labels that classify the event. Example event types include online payment transactions, account registrations, and authentications.

TODO: EXAMPLE

func NewCfnEventType 

func NewCfnEventType(scope constructs.Construct, id *string, props *CfnEventTypeProps) CfnEventType

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

type CfnEventTypeProps 

type CfnEventTypeProps struct {
	// The event type entity types.
	EntityTypes interface{} `json:"entityTypes" yaml:"entityTypes"`
	// The event type event variables.
	EventVariables interface{} `json:"eventVariables" yaml:"eventVariables"`
	// The event type labels.
	Labels interface{} `json:"labels" yaml:"labels"`
	// The event type name.
	//
	// Pattern : `^[0-9a-z_-]+$`
	Name *string `json:"name" yaml:"name"`
	// The event type description.
	Description *string `json:"description" yaml:"description"`
	// An array of key-value pairs to apply to this resource.
	//
	// For more information, see [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html) .
	Tags *[]*awscdk.CfnTag `json:"tags" yaml:"tags"`
}

Properties for defining a `CfnEventType`.

TODO: EXAMPLE

type CfnEventType_EntityTypeProperty 

type CfnEventType_EntityTypeProperty struct {
	// The entity type ARN.
	Arn *string `json:"arn" yaml:"arn"`
	// Timestamp of when the entity type was created.
	CreatedTime *string `json:"createdTime" yaml:"createdTime"`
	// The entity type description.
	Description *string `json:"description" yaml:"description"`
	// 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::EventType` 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 event type but not execute any changes to the variables.
	Inline interface{} `json:"inline" yaml:"inline"`
	// Timestamp of when the entity type was last updated.
	LastUpdatedTime *string `json:"lastUpdatedTime" yaml:"lastUpdatedTime"`
	// The entity type name.
	//
	// `^[0-9a-z_-]+$`
	Name *string `json:"name" yaml:"name"`
	// An array of key-value pairs to apply to this resource.
	//
	// For more information, see [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html) .
	Tags *[]*awscdk.CfnTag `json:"tags" yaml:"tags"`
}

The entity type details.

TODO: EXAMPLE

type CfnEventType_EventVariableProperty 

type CfnEventType_EventVariableProperty struct {
	// The event variable ARN.
	Arn *string `json:"arn" yaml:"arn"`
	// Timestamp for when event variable was created.
	CreatedTime *string `json:"createdTime" yaml:"createdTime"`
	// The source of the event variable.
	//
	// Valid values: `EVENT | EXTERNAL_MODEL_SCORE`
	//
	// When defining a variable within a event type, 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.
	DataSource *string `json:"dataSource" yaml:"dataSource"`
	// The data type of the event variable.
	DataType *string `json:"dataType" yaml:"dataType"`
	// The default value of the event variable.
	DefaultValue *string `json:"defaultValue" yaml:"defaultValue"`
	// The event variable description.
	Description *string `json:"description" yaml:"description"`
	// 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::EventType` 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 event type but not execute any changes to the variables.
	Inline interface{} `json:"inline" yaml:"inline"`
	// Timestamp for when the event variable was last updated.
	LastUpdatedTime *string `json:"lastUpdatedTime" yaml:"lastUpdatedTime"`
	// The name of the event variable.
	Name *string `json:"name" yaml:"name"`
	// An array of key-value pairs to apply to this resource.
	//
	// For more information, see [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html) .
	Tags *[]*awscdk.CfnTag `json:"tags" yaml:"tags"`
	// The type of event variable.
	//
	// For more information, see [Variable types](https://docs.aws.amazon.com/frauddetector/latest/ug/create-a-variable.html#variable-types) .
	VariableType *string `json:"variableType" yaml:"variableType"`
}

The variables associated with this event type.

TODO: EXAMPLE

type CfnEventType_LabelProperty 

type CfnEventType_LabelProperty struct {
	// The label ARN.
	Arn *string `json:"arn" yaml:"arn"`
	// Timestamp of when the event type was created.
	CreatedTime *string `json:"createdTime" yaml:"createdTime"`
	// The label description.
	Description *string `json:"description" yaml:"description"`
	// 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::EventType` 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 EventType but not execute any changes to the variables.
	Inline interface{} `json:"inline" yaml:"inline"`
	// Timestamp of when the label was last updated.
	LastUpdatedTime *string `json:"lastUpdatedTime" yaml:"lastUpdatedTime"`
	// The label name.
	Name *string `json:"name" yaml:"name"`
	// An array of key-value pairs to apply to this resource.
	//
	// For more information, see [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html) .
	Tags *[]*awscdk.CfnTag `json:"tags" yaml:"tags"`
}

The label associated with the event type.

TODO: EXAMPLE

type CfnLabel 

type CfnLabel interface {
	awscdk.CfnResource
	awscdk.IInspectable
	AttrArn() *string
	AttrCreatedTime() *string
	AttrLastUpdatedTime() *string
	CfnOptions() awscdk.ICfnResourceOptions
	CfnProperties() *map[string]interface{}
	CfnResourceType() *string
	CreationStack() *[]*string
	Description() *string
	SetDescription(val *string)
	LogicalId() *string
	Name() *string
	SetName(val *string)
	Node() constructs.Node
	Ref() *string
	Stack() awscdk.Stack
	Tags() awscdk.TagManager
	UpdatedProperites() *map[string]interface{}
	AddDeletionOverride(path *string)
	AddDependsOn(target awscdk.CfnResource)
	AddMetadata(key *string, value interface{})
	AddOverride(path *string, value interface{})
	AddPropertyDeletionOverride(propertyPath *string)
	AddPropertyOverride(propertyPath *string, value interface{})
	ApplyRemovalPolicy(policy awscdk.RemovalPolicy, options *awscdk.RemovalPolicyOptions)
	GetAtt(attributeName *string) awscdk.Reference
	GetMetadata(key *string) interface{}
	Inspect(inspector awscdk.TreeInspector)
	OverrideLogicalId(newLogicalId *string)
	RenderProperties(props *map[string]interface{}) *map[string]interface{}
	ShouldSynthesize() *bool
	ToString() *string
	ValidateProperties(_properties interface{})
}

A CloudFormation `AWS::FraudDetector::Label`.

Creates or updates label. A label classifies an event as fraudulent or legitimate. Labels are associated with event types and used to train supervised machine learning models in Amazon Fraud Detector.

TODO: EXAMPLE

func NewCfnLabel 

func NewCfnLabel(scope constructs.Construct, id *string, props *CfnLabelProps) CfnLabel

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

type CfnLabelProps 

type CfnLabelProps struct {
	// The label name.
	//
	// Pattern: `^[0-9a-z_-]+$`
	Name *string `json:"name" yaml:"name"`
	// The label description.
	Description *string `json:"description" yaml:"description"`
	// An array of key-value pairs to apply to this resource.
	//
	// For more information, see [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html) .
	Tags *[]*awscdk.CfnTag `json:"tags" yaml:"tags"`
}

Properties for defining a `CfnLabel`.

TODO: EXAMPLE

type CfnOutcome 

type CfnOutcome interface {
	awscdk.CfnResource
	awscdk.IInspectable
	AttrArn() *string
	AttrCreatedTime() *string
	AttrLastUpdatedTime() *string
	CfnOptions() awscdk.ICfnResourceOptions
	CfnProperties() *map[string]interface{}
	CfnResourceType() *string
	CreationStack() *[]*string
	Description() *string
	SetDescription(val *string)
	LogicalId() *string
	Name() *string
	SetName(val *string)
	Node() constructs.Node
	Ref() *string
	Stack() awscdk.Stack
	Tags() awscdk.TagManager
	UpdatedProperites() *map[string]interface{}
	AddDeletionOverride(path *string)
	AddDependsOn(target awscdk.CfnResource)
	AddMetadata(key *string, value interface{})
	AddOverride(path *string, value interface{})
	AddPropertyDeletionOverride(propertyPath *string)
	AddPropertyOverride(propertyPath *string, value interface{})
	ApplyRemovalPolicy(policy awscdk.RemovalPolicy, options *awscdk.RemovalPolicyOptions)
	GetAtt(attributeName *string) awscdk.Reference
	GetMetadata(key *string) interface{}
	Inspect(inspector awscdk.TreeInspector)
	OverrideLogicalId(newLogicalId *string)
	RenderProperties(props *map[string]interface{}) *map[string]interface{}
	ShouldSynthesize() *bool
	ToString() *string
	ValidateProperties(_properties interface{})
}

A CloudFormation `AWS::FraudDetector::Outcome`.

Creates or updates an outcome.

TODO: EXAMPLE

func NewCfnOutcome 

func NewCfnOutcome(scope constructs.Construct, id *string, props *CfnOutcomeProps) CfnOutcome

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

type CfnOutcomeProps 

type CfnOutcomeProps struct {
	// The outcome name.
	Name *string `json:"name" yaml:"name"`
	// The outcome description.
	Description *string `json:"description" yaml:"description"`
	// An array of key-value pairs to apply to this resource.
	//
	// For more information, see [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html) .
	Tags *[]*awscdk.CfnTag `json:"tags" yaml:"tags"`
}

Properties for defining a `CfnOutcome`.

TODO: EXAMPLE

type CfnVariable 

type CfnVariable interface {
	awscdk.CfnResource
	awscdk.IInspectable
	AttrArn() *string
	AttrCreatedTime() *string
	AttrLastUpdatedTime() *string
	CfnOptions() awscdk.ICfnResourceOptions
	CfnProperties() *map[string]interface{}
	CfnResourceType() *string
	CreationStack() *[]*string
	DataSource() *string
	SetDataSource(val *string)
	DataType() *string
	SetDataType(val *string)
	DefaultValue() *string
	SetDefaultValue(val *string)
	Description() *string
	SetDescription(val *string)
	LogicalId() *string
	Name() *string
	SetName(val *string)
	Node() constructs.Node
	Ref() *string
	Stack() awscdk.Stack
	Tags() awscdk.TagManager
	UpdatedProperites() *map[string]interface{}
	VariableType() *string
	SetVariableType(val *string)
	AddDeletionOverride(path *string)
	AddDependsOn(target awscdk.CfnResource)
	AddMetadata(key *string, value interface{})
	AddOverride(path *string, value interface{})
	AddPropertyDeletionOverride(propertyPath *string)
	AddPropertyOverride(propertyPath *string, value interface{})
	ApplyRemovalPolicy(policy awscdk.RemovalPolicy, options *awscdk.RemovalPolicyOptions)
	GetAtt(attributeName *string) awscdk.Reference
	GetMetadata(key *string) interface{}
	Inspect(inspector awscdk.TreeInspector)
	OverrideLogicalId(newLogicalId *string)
	RenderProperties(props *map[string]interface{}) *map[string]interface{}
	ShouldSynthesize() *bool
	ToString() *string
	ValidateProperties(_properties interface{})
}

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

Manages a variable.

TODO: EXAMPLE

func NewCfnVariable 

func NewCfnVariable(scope constructs.Construct, id *string, props *CfnVariableProps) CfnVariable

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

type CfnVariableProps 

type CfnVariableProps struct {
	// 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.
	DataSource *string `json:"dataSource" yaml:"dataSource"`
	// The data type of the variable.
	//
	// Valid data types: `STRING | INTEGER | BOOLEAN | FLOAT`
	DataType *string `json:"dataType" yaml:"dataType"`
	// The default value of the variable.
	DefaultValue *string `json:"defaultValue" yaml:"defaultValue"`
	// The name of the variable.
	//
	// Pattern: `^[0-9a-z_-]+$`
	Name *string `json:"name" yaml:"name"`
	// The description of the variable.
	Description *string `json:"description" yaml:"description"`
	// An array of key-value pairs to apply to this resource.
	//
	// For more information, see [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html) .
	Tags *[]*awscdk.CfnTag `json:"tags" yaml:"tags"`
	// 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`
	VariableType *string `json:"variableType" yaml:"variableType"`
}

Properties for defining a `CfnVariable`.

TODO: EXAMPLE

Source Files

View all Source files

Directories

Path Synopsis

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.