CfnEventType
- class aws_cdk.aws_frauddetector.CfnEventType(scope, id, *, entity_types, event_variables, labels, name, description=None, tags=None)
Bases:
CfnResource
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.
- See:
- CloudformationResource:
AWS::FraudDetector::EventType
- ExampleMetadata:
fixture=_generated
Example:
# The code below shows an example of how to instantiate this type. # The values are placeholders you should change. from aws_cdk import aws_frauddetector as frauddetector cfn_event_type = frauddetector.CfnEventType(self, "MyCfnEventType", entity_types=[frauddetector.CfnEventType.EntityTypeProperty( arn="arn", created_time="createdTime", description="description", inline=False, last_updated_time="lastUpdatedTime", name="name", tags=[CfnTag( key="key", value="value" )] )], event_variables=[frauddetector.CfnEventType.EventVariableProperty( arn="arn", created_time="createdTime", data_source="dataSource", data_type="dataType", default_value="defaultValue", description="description", inline=False, last_updated_time="lastUpdatedTime", name="name", tags=[CfnTag( key="key", value="value" )], variable_type="variableType" )], labels=[frauddetector.CfnEventType.LabelProperty( arn="arn", created_time="createdTime", description="description", inline=False, last_updated_time="lastUpdatedTime", name="name", tags=[CfnTag( key="key", value="value" )] )], name="name", # the properties below are optional description="description", tags=[CfnTag( key="key", value="value" )] )
- Parameters:
scope (
Construct
) – Scope in which this resource is defined.id (
str
) – Construct identifier for this resource (unique in its scope).entity_types (
Union
[IResolvable
,Sequence
[Union
[IResolvable
,EntityTypeProperty
,Dict
[str
,Any
]]]]) – The event type entity types.event_variables (
Union
[IResolvable
,Sequence
[Union
[IResolvable
,EventVariableProperty
,Dict
[str
,Any
]]]]) – The event type event variables.labels (
Union
[IResolvable
,Sequence
[Union
[IResolvable
,LabelProperty
,Dict
[str
,Any
]]]]) – The event type labels.name (
str
) – The event type name. Pattern :^[0-9a-z_-]+$
description (
Optional
[str
]) – The event type description.tags (
Optional
[Sequence
[Union
[CfnTag
,Dict
[str
,Any
]]]]) – An array of key-value pairs to apply to this resource. For more information, see Tag .
Methods
- add_deletion_override(path)
Syntactic sugar for
addOverride(path, undefined)
.- Parameters:
path (
str
) – The path of the value to delete.- Return type:
None
- add_dependency(target)
Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.
This can be used for resources across stacks (or nested stack) boundaries and the dependency will automatically be transferred to the relevant scope.
- Parameters:
target (
CfnResource
) –- Return type:
None
- add_depends_on(target)
(deprecated) Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.
- Parameters:
target (
CfnResource
) –- Deprecated:
use addDependency
- Stability:
deprecated
- Return type:
None
- add_metadata(key, value)
Add a value to the CloudFormation Resource Metadata.
- Parameters:
key (
str
) –value (
Any
) –
- See:
- Return type:
None
https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html
Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.
- add_override(path, value)
Adds an override to the synthesized CloudFormation resource.
To add a property override, either use
addPropertyOverride
or prefixpath
with “Properties.” (i.e.Properties.TopicName
).If the override is nested, separate each nested level using a dot (.) in the path parameter. If there is an array as part of the nesting, specify the index in the path.
To include a literal
.
in the property name, prefix with a\
. In most programming languages you will need to write this as"\\."
because the\
itself will need to be escaped.For example:
cfn_resource.add_override("Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes", ["myattribute"]) cfn_resource.add_override("Properties.GlobalSecondaryIndexes.1.ProjectionType", "INCLUDE")
would add the overrides Example:
"Properties": { "GlobalSecondaryIndexes": [ { "Projection": { "NonKeyAttributes": [ "myattribute" ] ... } ... }, { "ProjectionType": "INCLUDE" ... }, ] ... }
The
value
argument toaddOverride
will not be processed or translated in any way. Pass raw JSON values in here with the correct capitalization for CloudFormation. If you pass CDK classes or structs, they will be rendered with lowercased key names, and CloudFormation will reject the template.- Parameters:
path (
str
) –The path of the property, you can use dot notation to override values in complex types. Any intermediate keys will be created as needed.
value (
Any
) –The value. Could be primitive or complex.
- Return type:
None
- add_property_deletion_override(property_path)
Adds an override that deletes the value of a property from the resource definition.
- Parameters:
property_path (
str
) – The path to the property.- Return type:
None
- add_property_override(property_path, value)
Adds an override to a resource property.
Syntactic sugar for
addOverride("Properties.<...>", value)
.- Parameters:
property_path (
str
) – The path of the property.value (
Any
) – The value.
- Return type:
None
- apply_removal_policy(policy=None, *, apply_to_update_replace_policy=None, default=None)
Sets the deletion policy of the resource based on the removal policy specified.
The Removal Policy controls what happens to this resource when it stops being managed by CloudFormation, either because you’ve removed it from the CDK application or because you’ve made a change that requires the resource to be replaced.
The resource can be deleted (
RemovalPolicy.DESTROY
), or left in your AWS account for data recovery and cleanup later (RemovalPolicy.RETAIN
). In some cases, a snapshot can be taken of the resource prior to deletion (RemovalPolicy.SNAPSHOT
). A list of resources that support this policy can be found in the following link:- Parameters:
policy (
Optional
[RemovalPolicy
]) –apply_to_update_replace_policy (
Optional
[bool
]) – Apply the same deletion policy to the resource’s “UpdateReplacePolicy”. Default: truedefault (
Optional
[RemovalPolicy
]) – The default policy to apply in case the removal policy is not defined. Default: - Default value is resource specific. To determine the default value for a resource, please consult that specific resource’s documentation.
- See:
- Return type:
None
- get_att(attribute_name, type_hint=None)
Returns a token for an runtime attribute of this resource.
Ideally, use generated attribute accessors (e.g.
resource.arn
), but this can be used for future compatibility in case there is no generated attribute.- Parameters:
attribute_name (
str
) – The name of the attribute.type_hint (
Optional
[ResolutionTypeHint
]) –
- Return type:
- get_metadata(key)
Retrieve a value value from the CloudFormation Resource Metadata.
- Parameters:
key (
str
) –- See:
- Return type:
Any
https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html
Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.
- inspect(inspector)
Examines the CloudFormation resource and discloses attributes.
- Parameters:
inspector (
TreeInspector
) – tree inspector to collect and process attributes.- Return type:
None
- obtain_dependencies()
Retrieves an array of resources this resource depends on.
This assembles dependencies on resources across stacks (including nested stacks) automatically.
- Return type:
List
[Union
[Stack
,CfnResource
]]
- obtain_resource_dependencies()
Get a shallow copy of dependencies between this resource and other resources in the same stack.
- Return type:
List
[CfnResource
]
- override_logical_id(new_logical_id)
Overrides the auto-generated logical ID with a specific ID.
- Parameters:
new_logical_id (
str
) – The new logical ID to use for this stack element.- Return type:
None
- remove_dependency(target)
Indicates that this resource no longer depends on another resource.
This can be used for resources across stacks (including nested stacks) and the dependency will automatically be removed from the relevant scope.
- Parameters:
target (
CfnResource
) –- Return type:
None
- replace_dependency(target, new_target)
Replaces one dependency with another.
- Parameters:
target (
CfnResource
) – The dependency to replace.new_target (
CfnResource
) – The new dependency to add.
- Return type:
None
- to_string()
Returns a string representation of this construct.
- Return type:
str
- Returns:
a string representation of this resource
Attributes
- CFN_RESOURCE_TYPE_NAME = 'AWS::FraudDetector::EventType'
- attr_arn
The event type ARN.
- CloudformationAttribute:
Arn
- attr_created_time
Timestamp of when event type was created.
- CloudformationAttribute:
CreatedTime
- attr_last_updated_time
Timestamp of when event type was last updated.
- CloudformationAttribute:
LastUpdatedTime
- cfn_options
Options for this resource, such as condition, update policy etc.
- cfn_resource_type
AWS resource type.
- creation_stack
return:
the stack trace of the point where this Resource was created from, sourced from the +metadata+ entry typed +aws:cdk:logicalId+, and with the bottom-most node +internal+ entries filtered.
- description
The event type description.
- entity_types
The event type entity types.
- event_variables
The event type event variables.
- labels
The event type labels.
- logical_id
The logical ID for this CloudFormation stack element.
The logical ID of the element is calculated from the path of the resource node in the construct tree.
To override this value, use
overrideLogicalId(newLogicalId)
.- Returns:
the logical ID as a stringified token. This value will only get resolved during synthesis.
- name
The event type name.
- node
The tree node.
- ref
Return a string that will be resolved to a CloudFormation
{ Ref }
for this element.If, by any chance, the intrinsic reference of a resource is not a string, you could coerce it to an IResolvable through
Lazy.any({ produce: resource.ref })
.
- stack
The stack in which this element is defined.
CfnElements must be defined within a stack scope (directly or indirectly).
- tags
Tag Manager which manages the tags for this resource.
- tags_raw
An array of key-value pairs to apply to this resource.
Static Methods
- classmethod is_cfn_element(x)
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.- Parameters:
x (
Any
) –- Return type:
bool
- Returns:
The construct as a stack element or undefined if it is not a stack element.
- classmethod is_cfn_resource(x)
Check whether the given object is a CfnResource.
- Parameters:
x (
Any
) –- Return type:
bool
- classmethod is_construct(x)
Checks if
x
is a construct.Use this method instead of
instanceof
to properly detectConstruct
instances, even when the construct library is symlinked.Explanation: in JavaScript, multiple copies of the
constructs
library on disk are seen as independent, completely different libraries. As a consequence, the classConstruct
in each copy of theconstructs
library is seen as a different class, and an instance of one class will not test asinstanceof
the other class.npm install
will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of theconstructs
library can be accidentally installed, andinstanceof
will behave unpredictably. It is safest to avoid usinginstanceof
, and using this type-testing method instead.- Parameters:
x (
Any
) – Any object.- Return type:
bool
- Returns:
true if
x
is an object created from a class which extendsConstruct
.
EntityTypeProperty
- class CfnEventType.EntityTypeProperty(*, arn=None, created_time=None, description=None, inline=None, last_updated_time=None, name=None, tags=None)
Bases:
object
The entity type details.
- Parameters:
arn (
Optional
[str
]) – The entity type ARN.created_time (
Optional
[str
]) – Timestamp of when the entity type was created.description (
Optional
[str
]) – The entity type description.inline (
Union
[bool
,IResolvable
,None
]) – Indicates whether the resource is defined within this CloudFormation template and impacts the create, update, and delete behavior of the stack. If the value istrue
, CloudFormation will create/update/delete the resource when creating/updating/deleting the stack. If the value isfalse
, CloudFormation will validate that the object exists and then use it within the resource without making changes to the object. For example, when creatingAWS::FraudDetector::EventType
you must define at least two variables. You can setInline=true
for these variables and CloudFormation will create/update/delete the variables as part of stack operations. However, if you setInline=false
, CloudFormation will associate the variables to your event type but not execute any changes to the variables.last_updated_time (
Optional
[str
]) – Timestamp of when the entity type was last updated.name (
Optional
[str
]) – The entity type name.^[0-9a-z_-]+$
tags (
Optional
[Sequence
[Union
[CfnTag
,Dict
[str
,Any
]]]]) –An array of key-value pairs to apply to this resource. For more information, see Tag .
- See:
- ExampleMetadata:
fixture=_generated
Example:
# The code below shows an example of how to instantiate this type. # The values are placeholders you should change. from aws_cdk import aws_frauddetector as frauddetector entity_type_property = frauddetector.CfnEventType.EntityTypeProperty( arn="arn", created_time="createdTime", description="description", inline=False, last_updated_time="lastUpdatedTime", name="name", tags=[CfnTag( key="key", value="value" )] )
Attributes
- arn
The entity type ARN.
- created_time
Timestamp of when the entity type was created.
- description
The entity type description.
- inline
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 isfalse
, 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 setInline=true
for these variables and CloudFormation will create/update/delete the variables as part of stack operations. However, if you setInline=false
, CloudFormation will associate the variables to your event type but not execute any changes to the variables.
- last_updated_time
Timestamp of when the entity type was last updated.
- name
The entity type name.
^[0-9a-z_-]+$
EventVariableProperty
- class CfnEventType.EventVariableProperty(*, arn=None, created_time=None, data_source=None, data_type=None, default_value=None, description=None, inline=None, last_updated_time=None, name=None, tags=None, variable_type=None)
Bases:
object
The variables associated with this event type.
- Parameters:
arn (
Optional
[str
]) – The event variable ARN.created_time (
Optional
[str
]) – Timestamp for when event variable was created.data_source (
Optional
[str
]) – The source of the event variable. Valid values:EVENT | EXTERNAL_MODEL_SCORE
When defining a variable within a event type, you can only use theEVENT
value for DataSource when the Inline property is set to true. If the Inline property is set false, you can use eitherEVENT
orMODEL_SCORE
for DataSource.data_type (
Optional
[str
]) – The data type of the event variable. For more information, see Data types .default_value (
Optional
[str
]) – The default value of the event variable.description (
Optional
[str
]) – The event variable description.inline (
Union
[bool
,IResolvable
,None
]) – Indicates whether the resource is defined within this CloudFormation template and impacts the create, update, and delete behavior of the stack. If the value istrue
, CloudFormation will create/update/delete the resource when creating/updating/deleting the stack. If the value isfalse
, CloudFormation will validate that the object exists and then use it within the resource without making changes to the object. For example, when creatingAWS::FraudDetector::EventType
you must define at least two variables. You can setInline=true
for these variables and CloudFormation will create/update/delete the Variables as part of stack operations. However, if you setInline=false
, CloudFormation will associate the variables to your event type but not execute any changes to the variables.last_updated_time (
Optional
[str
]) – Timestamp for when the event variable was last updated.name (
Optional
[str
]) – The name of the event variable.tags (
Optional
[Sequence
[Union
[CfnTag
,Dict
[str
,Any
]]]]) –An array of key-value pairs to apply to this resource. For more information, see Tag .
variable_type (
Optional
[str
]) – The type of event variable. For more information, see Variable types .
- See:
- ExampleMetadata:
fixture=_generated
Example:
# The code below shows an example of how to instantiate this type. # The values are placeholders you should change. from aws_cdk import aws_frauddetector as frauddetector event_variable_property = frauddetector.CfnEventType.EventVariableProperty( arn="arn", created_time="createdTime", data_source="dataSource", data_type="dataType", default_value="defaultValue", description="description", inline=False, last_updated_time="lastUpdatedTime", name="name", tags=[CfnTag( key="key", value="value" )], variable_type="variableType" )
Attributes
- arn
The event variable ARN.
- created_time
Timestamp for when event variable was created.
- data_source
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 eitherEVENT
orMODEL_SCORE
for DataSource.
- data_type
The data type of the event variable.
For more information, see Data types .
- default_value
The default value of the event variable.
- description
The event variable description.
- inline
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 isfalse
, 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 setInline=true
for these variables and CloudFormation will create/update/delete the Variables as part of stack operations. However, if you setInline=false
, CloudFormation will associate the variables to your event type but not execute any changes to the variables.
- last_updated_time
Timestamp for when the event variable was last updated.
- name
The name of the event variable.
- variable_type
The type of event variable.
For more information, see Variable types .
LabelProperty
- class CfnEventType.LabelProperty(*, arn=None, created_time=None, description=None, inline=None, last_updated_time=None, name=None, tags=None)
Bases:
object
The label associated with the event type.
- Parameters:
arn (
Optional
[str
]) – The label ARN.created_time (
Optional
[str
]) – Timestamp of when the event type was created.description (
Optional
[str
]) – The label description.inline (
Union
[bool
,IResolvable
,None
]) – Indicates whether the resource is defined within this CloudFormation template and impacts the create, update, and delete behavior of the stack. If the value istrue
, CloudFormation will create/update/delete the resource when creating/updating/deleting the stack. If the value isfalse
, CloudFormation will validate that the object exists and then use it within the resource without making changes to the object. For example, when creatingAWS::FraudDetector::EventType
you must define at least two variables. You can setInline=true
for these variables and CloudFormation will create/update/delete the variables as part of stack operations. However, if you setInline=false
, CloudFormation will associate the variables to your EventType but not execute any changes to the variables.last_updated_time (
Optional
[str
]) – Timestamp of when the label was last updated.name (
Optional
[str
]) – The label name.tags (
Optional
[Sequence
[Union
[CfnTag
,Dict
[str
,Any
]]]]) –An array of key-value pairs to apply to this resource. For more information, see Tag .
- See:
- ExampleMetadata:
fixture=_generated
Example:
# The code below shows an example of how to instantiate this type. # The values are placeholders you should change. from aws_cdk import aws_frauddetector as frauddetector label_property = frauddetector.CfnEventType.LabelProperty( arn="arn", created_time="createdTime", description="description", inline=False, last_updated_time="lastUpdatedTime", name="name", tags=[CfnTag( key="key", value="value" )] )
Attributes
- arn
The label ARN.
- created_time
Timestamp of when the event type was created.
- description
The label description.
- inline
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 isfalse
, 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 setInline=true
for these variables and CloudFormation will create/update/delete the variables as part of stack operations. However, if you setInline=false
, CloudFormation will associate the variables to your EventType but not execute any changes to the variables.
- last_updated_time
Timestamp of when the label was last updated.
- name
The label name.