CfnEventTriggerProps

class aws_cdk.aws_customerprofiles.CfnEventTriggerProps(*, domain_name, event_trigger_conditions, event_trigger_name, object_type_name, description=None, event_trigger_limits=None, segment_filter=None, tags=None)

Bases: object

Properties for defining a CfnEventTrigger.

Parameters:

• domain_name (str) – The unique name of the domain.

• event_trigger_conditions (Union[IResolvable, Sequence[Union[IResolvable, EventTriggerConditionProperty, Dict[str, Any]]]]) – A list of conditions that determine when an event should trigger the destination.

• event_trigger_name (str) – The unique name of the event trigger.

• object_type_name (str) – The unique name of the object type.

• description (Optional[str]) – The description of the event trigger.

• event_trigger_limits (Union[IResolvable, EventTriggerLimitsProperty, Dict[str, Any], None]) – Defines limits controlling whether an event triggers the destination, based on ingestion latency and the number of invocations per profile over specific time periods.

• segment_filter (Optional[str]) – The destination is triggered only for profiles that meet the criteria of a segment definition.

• tags (Optional[Sequence[Union[CfnTag, Dict[str, Any]]]]) – An array of key-value pairs to apply to this resource.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-customerprofiles-eventtrigger.html

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_customerprofiles as customerprofiles

cfn_event_trigger_props = customerprofiles.CfnEventTriggerProps(
    domain_name="domainName",
    event_trigger_conditions=[customerprofiles.CfnEventTrigger.EventTriggerConditionProperty(
        event_trigger_dimensions=[customerprofiles.CfnEventTrigger.EventTriggerDimensionProperty(
            object_attributes=[customerprofiles.CfnEventTrigger.ObjectAttributeProperty(
                comparison_operator="comparisonOperator",
                values=["values"],

                # the properties below are optional
                field_name="fieldName",
                source="source"
            )]
        )],
        logical_operator="logicalOperator"
    )],
    event_trigger_name="eventTriggerName",
    object_type_name="objectTypeName",

    # the properties below are optional
    description="description",
    event_trigger_limits=customerprofiles.CfnEventTrigger.EventTriggerLimitsProperty(
        event_expiration=123,
        periods=[customerprofiles.CfnEventTrigger.PeriodProperty(
            unit="unit",
            value=123,

            # the properties below are optional
            max_invocations_per_profile=123,
            unlimited=False
        )]
    ),
    segment_filter="segmentFilter",
    tags=[CfnTag(
        key="key",
        value="value"
    )]
)

Attributes

description

The description of the event trigger.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-customerprofiles-eventtrigger.html#cfn-customerprofiles-eventtrigger-description

domain_name

The unique name of the domain.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-customerprofiles-eventtrigger.html#cfn-customerprofiles-eventtrigger-domainname

event_trigger_conditions

A list of conditions that determine when an event should trigger the destination.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-customerprofiles-eventtrigger.html#cfn-customerprofiles-eventtrigger-eventtriggerconditions

event_trigger_limits

Defines limits controlling whether an event triggers the destination, based on ingestion latency and the number of invocations per profile over specific time periods.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-customerprofiles-eventtrigger.html#cfn-customerprofiles-eventtrigger-eventtriggerlimits

event_trigger_name

The unique name of the event trigger.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-customerprofiles-eventtrigger.html#cfn-customerprofiles-eventtrigger-eventtriggername

object_type_name

The unique name of the object type.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-customerprofiles-eventtrigger.html#cfn-customerprofiles-eventtrigger-objecttypename

segment_filter

The destination is triggered only for profiles that meet the criteria of a segment definition.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-customerprofiles-eventtrigger.html#cfn-customerprofiles-eventtrigger-segmentfilter

tags

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

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-customerprofiles-eventtrigger.html#cfn-customerprofiles-eventtrigger-tags