CfnCalculatedAttributeDefinitionPropsMixin

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

Bases: Mixin

A calculated attribute definition for Customer Profiles.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-customerprofiles-calculatedattributedefinition.html
CloudformationResource:: AWS::CustomerProfiles::CalculatedAttributeDefinition
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_calculated_attribute_definition_props_mixin = customerprofiles_mixins.CfnCalculatedAttributeDefinitionPropsMixin(customerprofiles_mixins.CfnCalculatedAttributeDefinitionMixinProps(
    attribute_details=customerprofiles_mixins.CfnCalculatedAttributeDefinitionPropsMixin.AttributeDetailsProperty(
        attributes=[customerprofiles_mixins.CfnCalculatedAttributeDefinitionPropsMixin.AttributeItemProperty(
            name="name"
        )],
        expression="expression"
    ),
    calculated_attribute_name="calculatedAttributeName",
    conditions=customerprofiles_mixins.CfnCalculatedAttributeDefinitionPropsMixin.ConditionsProperty(
        object_count=123,
        range=customerprofiles_mixins.CfnCalculatedAttributeDefinitionPropsMixin.RangeProperty(
            timestamp_format="timestampFormat",
            timestamp_source="timestampSource",
            unit="unit",
            value=123,
            value_range=customerprofiles_mixins.CfnCalculatedAttributeDefinitionPropsMixin.ValueRangeProperty(
                end=123,
                start=123
            )
        ),
        threshold=customerprofiles_mixins.CfnCalculatedAttributeDefinitionPropsMixin.ThresholdProperty(
            operator="operator",
            value="value"
        )
    ),
    description="description",
    display_name="displayName",
    domain_name="domainName",
    statistic="statistic",
    tags=[CfnTag(
        key="key",
        value="value"
    )],
    use_historical_data=False
),
    strategy=mixins.PropertyMergeStrategy.OVERRIDE
)

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

Parameters:

props (Union[CfnCalculatedAttributeDefinitionMixinProps, Dict[str, Any]]) – L1 properties to apply.
strategy (Optional[PropertyMergeStrategy]) – (experimental) Strategy for merging nested properties. Default: - PropertyMergeStrategy.MERGE

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 = ['attributeDetails', 'calculatedAttributeName', 'conditions', 'description', 'displayName', 'domainName', 'statistic', 'tags', 'useHistoricalData']

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

AttributeDetailsProperty

class CfnCalculatedAttributeDefinitionPropsMixin.AttributeDetailsProperty(*, attributes=None, expression=None)

Bases: object

Mathematical expression and a list of attribute items specified in that expression.

Parameters:

attributes (Union[IResolvable, Sequence[Union[IResolvable, AttributeItemProperty, Dict[str, Any]]], None]) – Mathematical expression and a list of attribute items specified in that expression.
expression (Optional[str]) – Mathematical expression that is performed on attribute items provided in the attribute list. Each element in the expression should follow the structure of “{ObjectTypeName.AttributeName}”.

See:

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

attribute_details_property = customerprofiles_mixins.CfnCalculatedAttributeDefinitionPropsMixin.AttributeDetailsProperty(
    attributes=[customerprofiles_mixins.CfnCalculatedAttributeDefinitionPropsMixin.AttributeItemProperty(
        name="name"
    )],
    expression="expression"
)

Attributes

attributes

Mathematical expression and a list of attribute items specified in that expression.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-calculatedattributedefinition-attributedetails.html#cfn-customerprofiles-calculatedattributedefinition-attributedetails-attributes

expression

Mathematical expression that is performed on attribute items provided in the attribute list.

Each element in the expression should follow the structure of “{ObjectTypeName.AttributeName}”.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-calculatedattributedefinition-attributedetails.html#cfn-customerprofiles-calculatedattributedefinition-attributedetails-expression

AttributeItemProperty

class CfnCalculatedAttributeDefinitionPropsMixin.AttributeItemProperty(*, name=None)

Bases: object

The details of a single attribute item specified in the mathematical expression.

Parameters:: name (Optional[str]) – The unique name of the calculated attribute.
See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-calculatedattributedefinition-attributeitem.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

attribute_item_property = customerprofiles_mixins.CfnCalculatedAttributeDefinitionPropsMixin.AttributeItemProperty(
    name="name"
)

Attributes

name

The unique name of the calculated attribute.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-calculatedattributedefinition-attributeitem.html#cfn-customerprofiles-calculatedattributedefinition-attributeitem-name

ConditionsProperty

class CfnCalculatedAttributeDefinitionPropsMixin.ConditionsProperty(*, object_count=None, range=None, threshold=None)

Bases: object

The conditions including range, object count, and threshold for the calculated attribute.

Parameters:

object_count (Union[int, float, None]) – The number of profile objects used for the calculated attribute.
range (Union[IResolvable, RangeProperty, Dict[str, Any], None]) – The relative time period over which data is included in the aggregation.
threshold (Union[IResolvable, ThresholdProperty, Dict[str, Any], None]) – The threshold for the calculated attribute.

See:

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

conditions_property = customerprofiles_mixins.CfnCalculatedAttributeDefinitionPropsMixin.ConditionsProperty(
    object_count=123,
    range=customerprofiles_mixins.CfnCalculatedAttributeDefinitionPropsMixin.RangeProperty(
        timestamp_format="timestampFormat",
        timestamp_source="timestampSource",
        unit="unit",
        value=123,
        value_range=customerprofiles_mixins.CfnCalculatedAttributeDefinitionPropsMixin.ValueRangeProperty(
            end=123,
            start=123
        )
    ),
    threshold=customerprofiles_mixins.CfnCalculatedAttributeDefinitionPropsMixin.ThresholdProperty(
        operator="operator",
        value="value"
    )
)

Attributes

object_count

The number of profile objects used for the calculated attribute.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-calculatedattributedefinition-conditions.html#cfn-customerprofiles-calculatedattributedefinition-conditions-objectcount

range

The relative time period over which data is included in the aggregation.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-calculatedattributedefinition-conditions.html#cfn-customerprofiles-calculatedattributedefinition-conditions-range

threshold

The threshold for the calculated attribute.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-calculatedattributedefinition-conditions.html#cfn-customerprofiles-calculatedattributedefinition-conditions-threshold

RangeProperty

class CfnCalculatedAttributeDefinitionPropsMixin.RangeProperty(*, timestamp_format=None, timestamp_source=None, unit=None, value=None, value_range=None)

Bases: object

The relative time period over which data is included in the aggregation.

Parameters:

timestamp_format (Optional[str]) – The format the timestamp field in your JSON object is specified. This value should be one of EPOCHMILLI (for Unix epoch timestamps with second/millisecond level precision) or ISO_8601 (following ISO_8601 format with second/millisecond level precision, with an optional offset of Z or in the format HH:MM or HHMM.). E.g. if your object type is MyType and source JSON is {“generatedAt”: {“timestamp”: “2001-07-04T12:08:56.235-0700”}}, then TimestampFormat should be “ISO_8601”
timestamp_source (Optional[str]) – An expression specifying the field in your JSON object from which the date should be parsed. The expression should follow the structure of “{ObjectTypeName.}”. E.g. if your object type is MyType and source JSON is {“generatedAt”: {“timestamp”: “1737587945945”}}, then TimestampSource should be “{MyType.generatedAt.timestamp}”
unit (Optional[str]) – The unit of time.
value (Union[int, float, None]) – The amount of time of the specified unit.
value_range (Union[IResolvable, ValueRangeProperty, Dict[str, Any], None]) – A structure letting customers specify a relative time window over which over which data is included in the Calculated Attribute. Use positive numbers to indicate that the endpoint is in the past, and negative numbers to indicate it is in the future. ValueRange overrides Value.

See:

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

range_property = customerprofiles_mixins.CfnCalculatedAttributeDefinitionPropsMixin.RangeProperty(
    timestamp_format="timestampFormat",
    timestamp_source="timestampSource",
    unit="unit",
    value=123,
    value_range=customerprofiles_mixins.CfnCalculatedAttributeDefinitionPropsMixin.ValueRangeProperty(
        end=123,
        start=123
    )
)

Attributes

timestamp_format

The format the timestamp field in your JSON object is specified.

This value should be one of EPOCHMILLI (for Unix epoch timestamps with second/millisecond level precision) or ISO_8601 (following ISO_8601 format with second/millisecond level precision, with an optional offset of Z or in the format HH:MM or HHMM.). E.g. if your object type is MyType and source JSON is {“generatedAt”: {“timestamp”: “2001-07-04T12:08:56.235-0700”}}, then TimestampFormat should be “ISO_8601”

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-calculatedattributedefinition-range.html#cfn-customerprofiles-calculatedattributedefinition-range-timestampformat

timestamp_source

An expression specifying the field in your JSON object from which the date should be parsed.

The expression should follow the structure of “{ObjectTypeName.}”. E.g. if your object type is MyType and source JSON is {“generatedAt”: {“timestamp”: “1737587945945”}}, then TimestampSource should be “{MyType.generatedAt.timestamp}”

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-calculatedattributedefinition-range.html#cfn-customerprofiles-calculatedattributedefinition-range-timestampsource

unit

The unit of time.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-calculatedattributedefinition-range.html#cfn-customerprofiles-calculatedattributedefinition-range-unit

value

The amount of time of the specified unit.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-calculatedattributedefinition-range.html#cfn-customerprofiles-calculatedattributedefinition-range-value

value_range

A structure letting customers specify a relative time window over which over which data is included in the Calculated Attribute.

Use positive numbers to indicate that the endpoint is in the past, and negative numbers to indicate it is in the future. ValueRange overrides Value.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-calculatedattributedefinition-range.html#cfn-customerprofiles-calculatedattributedefinition-range-valuerange

ReadinessProperty

class CfnCalculatedAttributeDefinitionPropsMixin.ReadinessProperty(*, message=None, progress_percentage=None)

Bases: object

Information indicating if the Calculated Attribute is ready for use by confirming all historical data has been processed and reflected.

Parameters:

message (Optional[str]) – Any customer messaging.
progress_percentage (Union[int, float, None]) – Approximately how far the Calculated Attribute creation is from completion.

See:

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

readiness_property = customerprofiles_mixins.CfnCalculatedAttributeDefinitionPropsMixin.ReadinessProperty(
    message="message",
    progress_percentage=123
)

Attributes

message

Any customer messaging.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-calculatedattributedefinition-readiness.html#cfn-customerprofiles-calculatedattributedefinition-readiness-message

progress_percentage

Approximately how far the Calculated Attribute creation is from completion.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-calculatedattributedefinition-readiness.html#cfn-customerprofiles-calculatedattributedefinition-readiness-progresspercentage

ThresholdProperty

class CfnCalculatedAttributeDefinitionPropsMixin.ThresholdProperty(*, operator=None, value=None)

Bases: object

The threshold for the calculated attribute.

Parameters:

operator (Optional[str]) – The operator of the threshold.
value (Optional[str]) – The value of the threshold.

See:

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

threshold_property = customerprofiles_mixins.CfnCalculatedAttributeDefinitionPropsMixin.ThresholdProperty(
    operator="operator",
    value="value"
)

Attributes

operator

The operator of the threshold.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-calculatedattributedefinition-threshold.html#cfn-customerprofiles-calculatedattributedefinition-threshold-operator

value

The value of the threshold.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-calculatedattributedefinition-threshold.html#cfn-customerprofiles-calculatedattributedefinition-threshold-value

ValueRangeProperty

class CfnCalculatedAttributeDefinitionPropsMixin.ValueRangeProperty(*, end=None, start=None)

Bases: object

A structure letting customers specify a relative time window over which over which data is included in the Calculated Attribute.

Use positive numbers to indicate that the endpoint is in the past, and negative numbers to indicate it is in the future. ValueRange overrides Value.

Parameters:

end (Union[int, float, None]) – The ending point for this overridden range. Positive numbers indicate how many days in the past data should be included, and negative numbers indicate how many days in the future.
start (Union[int, float, None]) – The starting point for this overridden range. Positive numbers indicate how many days in the past data should be included, and negative numbers indicate how many days in the future.

See:

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

value_range_property = customerprofiles_mixins.CfnCalculatedAttributeDefinitionPropsMixin.ValueRangeProperty(
    end=123,
    start=123
)

Attributes

end

The ending point for this overridden range.

Positive numbers indicate how many days in the past data should be included, and negative numbers indicate how many days in the future.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-calculatedattributedefinition-valuerange.html#cfn-customerprofiles-calculatedattributedefinition-valuerange-end

start

The starting point for this overridden range.

Positive numbers indicate how many days in the past data should be included, and negative numbers indicate how many days in the future.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-calculatedattributedefinition-valuerange.html#cfn-customerprofiles-calculatedattributedefinition-valuerange-start