software.amazon.awscdk.services.frauddetector

Class CfnEventType

java.lang.Object

software.amazon.jsii.JsiiObject

software.constructs.Construct

software.amazon.awscdk.CfnElement

software.amazon.awscdk.CfnRefElement

software.amazon.awscdk.CfnResource

software.amazon.awscdk.services.frauddetector.CfnEventType

All Implemented Interfaces:

IInspectable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable

@Generated(value="jsii-pacmak/1.67.0 (build 2c027f5)",
           date="2022-09-19T20:26:39.414Z")
 @Stability(value=Stable)
public class CfnEventType
extends CfnResource
implements IInspectable

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.

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.*;
 CfnEventType cfnEventType = CfnEventType.Builder.create(this, "MyCfnEventType")
         .entityTypes(List.of(EntityTypeProperty.builder()
                 .arn("arn")
                 .createdTime("createdTime")
                 .description("description")
                 .inline(false)
                 .lastUpdatedTime("lastUpdatedTime")
                 .name("name")
                 .tags(List.of(CfnTag.builder()
                         .key("key")
                         .value("value")
                         .build()))
                 .build()))
         .eventVariables(List.of(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()))
         .labels(List.of(LabelProperty.builder()
                 .arn("arn")
                 .createdTime("createdTime")
                 .description("description")
                 .inline(false)
                 .lastUpdatedTime("lastUpdatedTime")
                 .name("name")
                 .tags(List.of(CfnTag.builder()
                         .key("key")
                         .value("value")
                         .build()))
                 .build()))
         .name("name")
         // the properties below are optional
         .description("description")
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CfnEventType.Builder A fluent builder for CfnEventType.
static interface	CfnEventType.EntityTypeProperty The entity type details.
static interface	CfnEventType.EventVariableProperty The variables associated with this event type.
static interface	CfnEventType.LabelProperty The label associated with the event type.

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.amazon.awscdk.IInspectable

IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

Nested classes/interfaces inherited from interface software.constructs.IConstruct

software.constructs.IConstruct.Jsii$Default

Field Summary

Fields

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

Constructor Summary

Constructors

Modifier	Constructor and Description
	CfnEventType(software.constructs.Construct scope, String id, CfnEventTypeProps props) Create a new `AWS::FraudDetector::EventType`.
protected	CfnEventType(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnEventType(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method and Description
String	getAttrArn() The event type ARN.
String	getAttrCreatedTime() Timestamp of when event type was created.
String	getAttrLastUpdatedTime() Timestamp of when event type was last updated.
protected Map<String,Object>	getCfnProperties()
String	getDescription() The event type description.
Object	getEntityTypes() The event type entity types.
Object	getEventVariables() The event type event variables.
Object	getLabels() The event type labels.
String	getName() The event type name.
TagManager	getTags() An array of key-value pairs to apply to this resource.
void	inspect(TreeInspector inspector) Examines the CloudFormation resource and discloses attributes.
protected Map<String,Object>	renderProperties(Map<String,Object> props)
void	setDescription(String value) The event type description.
void	setEntityTypes(IResolvable value) The event type entity types.
void	setEntityTypes(List<Object> value) The event type entity types.
void	setEventVariables(IResolvable value) The event type event variables.
void	setEventVariables(List<Object> value) The event type event variables.
void	setLabels(IResolvable value) The event type labels.
void	setLabels(List<Object> value) The event type labels.
void	setName(String value) The event type name.

Methods inherited from class software.amazon.awscdk.CfnResource

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

Methods inherited from class software.amazon.awscdk.CfnRefElement

getRef

Methods inherited from class software.amazon.awscdk.CfnElement

getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId

Methods inherited from class software.constructs.Construct

getNode, isConstruct

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

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

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Field Detail

CFN_RESOURCE_TYPE_NAME

@Stability(value=Stable)
public static final String CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

Constructor Detail

CfnEventType

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

CfnEventType

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

CfnEventType

@Stability(value=Stable)
public CfnEventType(@NotNull
                                             software.constructs.Construct scope,
                                             @NotNull
                                             String id,
                                             @NotNull
                                             CfnEventTypeProps props)

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

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

@Stability(value=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(value=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(value=Stable)
 @NotNull
public String getAttrArn()

The event type ARN.

getAttrCreatedTime

@Stability(value=Stable)
 @NotNull
public String getAttrCreatedTime()

Timestamp of when event type was created.

getAttrLastUpdatedTime

@Stability(value=Stable)
 @NotNull
public String getAttrLastUpdatedTime()

Timestamp of when event type was last updated.

getCfnProperties

@Stability(value=Stable)
 @NotNull
protected Map<String,Object> getCfnProperties()

Overrides:

getCfnProperties in class CfnResource

getTags

@Stability(value=Stable)
 @NotNull
public TagManager getTags()

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

For more information, see Tag .

getEntityTypes

@Stability(value=Stable)
 @NotNull
public Object getEntityTypes()

The event type entity types.

setEntityTypes

@Stability(value=Stable)
public void setEntityTypes(@NotNull
                                                    IResolvable value)

The event type entity types.

setEntityTypes

@Stability(value=Stable)
public void setEntityTypes(@NotNull
                                                    List<Object> value)

The event type entity types.

getEventVariables

@Stability(value=Stable)
 @NotNull
public Object getEventVariables()

The event type event variables.

setEventVariables

@Stability(value=Stable)
public void setEventVariables(@NotNull
                                                       IResolvable value)

The event type event variables.

setEventVariables

@Stability(value=Stable)
public void setEventVariables(@NotNull
                                                       List<Object> value)

The event type event variables.

getLabels

@Stability(value=Stable)
 @NotNull
public Object getLabels()

The event type labels.

setLabels

@Stability(value=Stable)
public void setLabels(@NotNull
                                               IResolvable value)

The event type labels.

setLabels

@Stability(value=Stable)
public void setLabels(@NotNull
                                               List<Object> value)

The event type labels.

getName

@Stability(value=Stable)
 @NotNull
public String getName()

The event type name.

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

setName

@Stability(value=Stable)
public void setName(@NotNull
                                             String value)

The event type name.

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

getDescription

@Stability(value=Stable)
 @Nullable
public String getDescription()

The event type description.

setDescription

@Stability(value=Stable)
public void setDescription(@Nullable
                                                    String value)

The event type description.