CfnEventTriggerMixinProps

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

Bases: object

Properties for CfnEventTriggerPropsMixin.

Parameters:

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

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

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

  • 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.

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

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

  • 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.mixins_preview.aws_customerprofiles import mixins as customerprofiles_mixins

cfn_event_trigger_mixin_props = customerprofiles_mixins.CfnEventTriggerMixinProps(
    description="description",
    domain_name="domainName",
    event_trigger_conditions=[customerprofiles_mixins.CfnEventTriggerPropsMixin.EventTriggerConditionProperty(
        event_trigger_dimensions=[customerprofiles_mixins.CfnEventTriggerPropsMixin.EventTriggerDimensionProperty(
            object_attributes=[customerprofiles_mixins.CfnEventTriggerPropsMixin.ObjectAttributeProperty(
                comparison_operator="comparisonOperator",
                field_name="fieldName",
                source="source",
                values=["values"]
            )]
        )],
        logical_operator="logicalOperator"
    )],
    event_trigger_limits=customerprofiles_mixins.CfnEventTriggerPropsMixin.EventTriggerLimitsProperty(
        event_expiration=123,
        periods=[customerprofiles_mixins.CfnEventTriggerPropsMixin.PeriodProperty(
            max_invocations_per_profile=123,
            unit="unit",
            unlimited=False,
            value=123
        )]
    ),
    event_trigger_name="eventTriggerName",
    object_type_name="objectTypeName",
    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