CfnEventTriggerPropsMixin

class aws_cdk.mixins_preview.aws_customerprofiles.mixins.CfnEventTriggerPropsMixin(props, *, strategy=None)

Bases: Mixin

Specifies the rules to perform an action based on customer ingested data.

See:

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

CloudformationResource:

AWS::CustomerProfiles::EventTrigger

Mixin:

true

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

cfn_event_trigger_props_mixin = customerprofiles_mixins.CfnEventTriggerPropsMixin(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"
    )]
),
    strategy=mixins.PropertyMergeStrategy.OVERRIDE
)

Create a mixin to apply properties to AWS::CustomerProfiles::EventTrigger.

Parameters:

Methods

apply_to(construct)

Apply the mixin properties to the construct.

Parameters:

construct (IConstruct)

Return type:

IConstruct

supports(construct)

Check if this mixin supports the given construct.

Parameters:

construct (IConstruct)

Return type:

bool

Attributes

CFN_PROPERTY_KEYS = ['description', 'domainName', 'eventTriggerConditions', 'eventTriggerLimits', 'eventTriggerName', 'objectTypeName', 'segmentFilter', 'tags']

Static Methods

classmethod is_mixin(x)

(experimental) Checks if x is a Mixin.

Parameters:

x (Any) – Any object.

Return type:

bool

Returns:

true if x is an object created from a class which extends Mixin.

Stability:

experimental

EventTriggerConditionProperty

class CfnEventTriggerPropsMixin.EventTriggerConditionProperty(*, event_trigger_dimensions=None, logical_operator=None)

Bases: object

Specifies the circumstances under which the event should trigger the destination.

Parameters:

  • event_trigger_dimensions (Union[IResolvable, Sequence[Union[IResolvable, EventTriggerDimensionProperty, Dict[str, Any]]], None]) – A list of dimensions to be evaluated for the event.

  • logical_operator (Optional[str]) – The operator used to combine multiple dimensions.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-eventtrigger-eventtriggercondition.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

event_trigger_condition_property = 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"
)

Attributes

event_trigger_dimensions

A list of dimensions to be evaluated for the event.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-eventtrigger-eventtriggercondition.html#cfn-customerprofiles-eventtrigger-eventtriggercondition-eventtriggerdimensions

logical_operator

The operator used to combine multiple dimensions.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-eventtrigger-eventtriggercondition.html#cfn-customerprofiles-eventtrigger-eventtriggercondition-logicaloperator

EventTriggerDimensionProperty

class CfnEventTriggerPropsMixin.EventTriggerDimensionProperty(*, object_attributes=None)

Bases: object

A specific event dimension to be assessed.

Parameters:

object_attributes (Union[IResolvable, Sequence[Union[IResolvable, ObjectAttributeProperty, Dict[str, Any]]], None]) – A list of object attributes to be evaluated.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-eventtrigger-eventtriggerdimension.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

event_trigger_dimension_property = customerprofiles_mixins.CfnEventTriggerPropsMixin.EventTriggerDimensionProperty(
    object_attributes=[customerprofiles_mixins.CfnEventTriggerPropsMixin.ObjectAttributeProperty(
        comparison_operator="comparisonOperator",
        field_name="fieldName",
        source="source",
        values=["values"]
    )]
)

Attributes

object_attributes

A list of object attributes to be evaluated.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-eventtrigger-eventtriggerdimension.html#cfn-customerprofiles-eventtrigger-eventtriggerdimension-objectattributes

EventTriggerLimitsProperty

class CfnEventTriggerPropsMixin.EventTriggerLimitsProperty(*, event_expiration=None, periods=None)

Bases: object

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

Parameters:

  • event_expiration (Union[int, float, None]) – Specifies that an event will only trigger the destination if it is processed within a certain latency period.

  • periods (Union[IResolvable, Sequence[Union[IResolvable, PeriodProperty, Dict[str, Any]]], None]) – A list of time periods during which the limits apply.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-eventtrigger-eventtriggerlimits.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

event_trigger_limits_property = customerprofiles_mixins.CfnEventTriggerPropsMixin.EventTriggerLimitsProperty(
    event_expiration=123,
    periods=[customerprofiles_mixins.CfnEventTriggerPropsMixin.PeriodProperty(
        max_invocations_per_profile=123,
        unit="unit",
        unlimited=False,
        value=123
    )]
)

Attributes

event_expiration

Specifies that an event will only trigger the destination if it is processed within a certain latency period.

See:

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

periods

A list of time periods during which the limits apply.

See:

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

ObjectAttributeProperty

class CfnEventTriggerPropsMixin.ObjectAttributeProperty(*, comparison_operator=None, field_name=None, source=None, values=None)

Bases: object

The criteria that a specific object attribute must meet to trigger the destination.

Parameters:

  • comparison_operator (Optional[str]) – The operator used to compare an attribute against a list of values.

  • field_name (Optional[str]) – A field defined within an object type.

  • source (Optional[str]) – An attribute contained within a source object.

  • values (Optional[Sequence[str]]) – The amount of time of the specified unit.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-eventtrigger-objectattribute.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

object_attribute_property = customerprofiles_mixins.CfnEventTriggerPropsMixin.ObjectAttributeProperty(
    comparison_operator="comparisonOperator",
    field_name="fieldName",
    source="source",
    values=["values"]
)

Attributes

comparison_operator

The operator used to compare an attribute against a list of values.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-eventtrigger-objectattribute.html#cfn-customerprofiles-eventtrigger-objectattribute-comparisonoperator

field_name

A field defined within an object type.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-eventtrigger-objectattribute.html#cfn-customerprofiles-eventtrigger-objectattribute-fieldname

source

An attribute contained within a source object.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-eventtrigger-objectattribute.html#cfn-customerprofiles-eventtrigger-objectattribute-source

values

The amount of time of the specified unit.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-eventtrigger-objectattribute.html#cfn-customerprofiles-eventtrigger-objectattribute-values

PeriodProperty

class CfnEventTriggerPropsMixin.PeriodProperty(*, max_invocations_per_profile=None, unit=None, unlimited=None, value=None)

Bases: object

Defines a limit and the time period during which it is enforced.

Parameters:

  • max_invocations_per_profile (Union[int, float, None]) – The maximum allowed number of destination invocations per profile.

  • unit (Optional[str]) – The unit of time.

  • unlimited (Union[bool, IResolvable, None]) – If set to true, there is no limit on the number of destination invocations per profile. The default is false.

  • value (Union[int, float, None]) – The amount of time of the specified unit.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-eventtrigger-period.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

period_property = customerprofiles_mixins.CfnEventTriggerPropsMixin.PeriodProperty(
    max_invocations_per_profile=123,
    unit="unit",
    unlimited=False,
    value=123
)

Attributes

max_invocations_per_profile

The maximum allowed number of destination invocations per profile.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-eventtrigger-period.html#cfn-customerprofiles-eventtrigger-period-maxinvocationsperprofile

unit

The unit of time.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-eventtrigger-period.html#cfn-customerprofiles-eventtrigger-period-unit

unlimited

If set to true, there is no limit on the number of destination invocations per profile.

The default is false.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-eventtrigger-period.html#cfn-customerprofiles-eventtrigger-period-unlimited

value

The amount of time of the specified unit.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-eventtrigger-period.html#cfn-customerprofiles-eventtrigger-period-value