Package software.amazon.awscdk.services.customerprofiles

Interface CfnCalculatedAttributeDefinitionProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnCalculatedAttributeDefinitionProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.116.0 (build 0eddcff)",
           date="2025-10-29T11:15:35.794Z")
@Stability(Stable)
public interface CfnCalculatedAttributeDefinitionProps
extends software.amazon.jsii.JsiiSerializable

Properties for defining a CfnCalculatedAttributeDefinition.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.customerprofiles.*;
 CfnCalculatedAttributeDefinitionProps cfnCalculatedAttributeDefinitionProps = CfnCalculatedAttributeDefinitionProps.builder()
         .attributeDetails(AttributeDetailsProperty.builder()
                 .attributes(List.of(AttributeItemProperty.builder()
                         .name("name")
                         .build()))
                 .expression("expression")
                 .build())
         .calculatedAttributeName("calculatedAttributeName")
         .domainName("domainName")
         .statistic("statistic")
         // the properties below are optional
         .conditions(ConditionsProperty.builder()
                 .objectCount(123)
                 .range(RangeProperty.builder()
                         .unit("unit")
                         // the properties below are optional
                         .timestampFormat("timestampFormat")
                         .timestampSource("timestampSource")
                         .value(123)
                         .valueRange(ValueRangeProperty.builder()
                                 .end(123)
                                 .start(123)
                                 .build())
                         .build())
                 .threshold(ThresholdProperty.builder()
                         .operator("operator")
                         .value("value")
                         .build())
                 .build())
         .description("description")
         .displayName("displayName")
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .useHistoricalData(false)
         .build();
 

See Also:

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

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnCalculatedAttributeDefinitionProps.Builder	A builder for CfnCalculatedAttributeDefinitionProps
static final class	CfnCalculatedAttributeDefinitionProps.Jsii$Proxy	An implementation for CfnCalculatedAttributeDefinitionProps

Method Summary

Modifier and Type	Method	Description
static CfnCalculatedAttributeDefinitionProps.Builder	builder()
Object	getAttributeDetails()	Mathematical expression and a list of attribute items specified in that expression.
String	getCalculatedAttributeName()	The name of an attribute defined in a profile object type.
default Object	getConditions()	The conditions including range, object count, and threshold for the calculated attribute.
default String	getDescription()	The description of the calculated attribute.
default String	getDisplayName()	The display name of the calculated attribute.
String	getDomainName()	The unique name of the domain.
String	getStatistic()	The aggregation operation to perform for the calculated attribute.
default List<CfnTag>	getTags()	An array of key-value pairs to apply to this resource.
default Object	getUseHistoricalData()	Whether historical data ingested before the Calculated Attribute was created should be included in calculations.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getAttributeDetails

@Stability(Stable)
@NotNull
Object getAttributeDetails()

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

Returns union: either IResolvable or CfnCalculatedAttributeDefinition.AttributeDetailsProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-customerprofiles-calculatedattributedefinition.html#cfn-customerprofiles-calculatedattributedefinition-attributedetails

getCalculatedAttributeName

@Stability(Stable)
@NotNull
String getCalculatedAttributeName()

The name of an attribute defined in a profile object type.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-customerprofiles-calculatedattributedefinition.html#cfn-customerprofiles-calculatedattributedefinition-calculatedattributename

getDomainName

@Stability(Stable)
@NotNull
String getDomainName()

The unique name of the domain.

See Also:

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

getStatistic

@Stability(Stable)
@NotNull
String getStatistic()

The aggregation operation to perform for the calculated attribute.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-customerprofiles-calculatedattributedefinition.html#cfn-customerprofiles-calculatedattributedefinition-statistic

getConditions

@Stability(Stable)
@Nullable
default Object getConditions()

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

Returns union: either IResolvable or CfnCalculatedAttributeDefinition.ConditionsProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-customerprofiles-calculatedattributedefinition.html#cfn-customerprofiles-calculatedattributedefinition-conditions

getDescription

@Stability(Stable)
@Nullable
default String getDescription()

The description of the calculated attribute.

See Also:

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

getDisplayName

@Stability(Stable)
@Nullable
default String getDisplayName()

The display name of the calculated attribute.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-customerprofiles-calculatedattributedefinition.html#cfn-customerprofiles-calculatedattributedefinition-displayname

getTags

@Stability(Stable)
@Nullable
default List<CfnTag> getTags()

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

See Also:

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

getUseHistoricalData

@Stability(Stable)
@Nullable
default Object getUseHistoricalData()

Whether historical data ingested before the Calculated Attribute was created should be included in calculations.

Returns union: either Boolean or IResolvable

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-customerprofiles-calculatedattributedefinition.html#cfn-customerprofiles-calculatedattributedefinition-usehistoricaldata

builder

@Stability(Stable)
static CfnCalculatedAttributeDefinitionProps.Builder builder()

Returns:

a CfnCalculatedAttributeDefinitionProps.Builder of CfnCalculatedAttributeDefinitionProps