Package software.amazon.awscdk.services.customerprofiles

Class CfnCalculatedAttributeDefinition

java.lang.Object
software.amazon.jsii.JsiiObject
software.constructs.Construct
software.amazon.awscdk.CfnElement
software.amazon.awscdk.CfnRefElement
software.amazon.awscdk.CfnResource
software.amazon.awscdk.services.customerprofiles.CfnCalculatedAttributeDefinition
All Implemented Interfaces:
IInspectable, ITaggableV2, ICalculatedAttributeDefinitionRef, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable
@Generated(value="jsii-pacmak/1.116.0 (build 0eddcff)", date="2025-10-29T11:15:35.789Z") @Stability(Stable) public class CfnCalculatedAttributeDefinition extends CfnResource implements IInspectable, ICalculatedAttributeDefinitionRef, ITaggableV2
A calculated attribute definition for Customer Profiles.

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.*;
 CfnCalculatedAttributeDefinition cfnCalculatedAttributeDefinition = CfnCalculatedAttributeDefinition.Builder.create(this, "MyCfnCalculatedAttributeDefinition")
         .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:

  • Field Details

    • CFN_RESOURCE_TYPE_NAME

      @Stability(Stable) public static final String CFN_RESOURCE_TYPE_NAME
      The CloudFormation resource type name for this resource class.

  • Constructor Details

    • CfnCalculatedAttributeDefinition

      protected CfnCalculatedAttributeDefinition(software.amazon.jsii.JsiiObjectRef objRef)

    • CfnCalculatedAttributeDefinition

      protected CfnCalculatedAttributeDefinition(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

    • CfnCalculatedAttributeDefinition

      @Stability(Stable) public CfnCalculatedAttributeDefinition(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull CfnCalculatedAttributeDefinitionProps props)
      Parameters:
      scope - Scope in which this resource is defined. This parameter is required.
      id - Construct identifier for this resource (unique in its scope). This parameter is required.
      props - Resource properties. This parameter is required.

  • Method Details

    • inspect

      @Stability(Stable) public void inspect(@NotNull TreeInspector inspector)
      Examines the CloudFormation resource and discloses attributes.

      Specified by:
      inspect in interface IInspectable
      Parameters:
      inspector - tree inspector to collect and process attributes. This parameter is required.

    • renderProperties

      @Stability(Stable) @NotNull protected Map<String,Object> renderProperties(@NotNull Map<String,Object> props)
      Overrides:
      renderProperties in class CfnResource
      Parameters:
      props - This parameter is required.

    • getAttrCreatedAt

      @Stability(Stable) @NotNull public String getAttrCreatedAt()
      The timestamp of when the calculated attribute definition was created.

    • getAttrLastUpdatedAt

      @Stability(Stable) @NotNull public String getAttrLastUpdatedAt()
      The timestamp of when the calculated attribute definition was most recently edited.

    • getAttrReadiness

      @Stability(Stable) @NotNull public IResolvable getAttrReadiness()
      The readiness status of the calculated attribute.

    • getAttrStatus

      @Stability(Stable) @NotNull public String getAttrStatus()
      Status of the Calculated Attribute creation (whether all historical data has been indexed.).

    • getCalculatedAttributeDefinitionRef

      @Stability(Stable) @NotNull public CalculatedAttributeDefinitionReference getCalculatedAttributeDefinitionRef()
      A reference to a CalculatedAttributeDefinition resource.
      Specified by:
      getCalculatedAttributeDefinitionRef in interface ICalculatedAttributeDefinitionRef

    • getCdkTagManager

      @Stability(Stable) @NotNull public TagManager getCdkTagManager()
      Tag Manager which manages the tags for this resource.
      Specified by:
      getCdkTagManager in interface ITaggableV2

    • getCfnProperties

      @Stability(Stable) @NotNull protected Map<String,Object> getCfnProperties()
      Overrides:
      getCfnProperties in class CfnResource

    • getAttributeDetails

      @Stability(Stable) @NotNull public Object getAttributeDetails()
      Mathematical expression and a list of attribute items specified in that expression.

      Returns union: either IResolvable or CfnCalculatedAttributeDefinition.AttributeDetailsProperty

    • setAttributeDetails

      @Stability(Stable) public void setAttributeDetails(@NotNull IResolvable value)
      Mathematical expression and a list of attribute items specified in that expression.

    • setAttributeDetails

      @Stability(Stable) public void setAttributeDetails(@NotNull CfnCalculatedAttributeDefinition.AttributeDetailsProperty value)
      Mathematical expression and a list of attribute items specified in that expression.

    • getCalculatedAttributeName

      @Stability(Stable) @NotNull public String getCalculatedAttributeName()
      The name of an attribute defined in a profile object type.

    • setCalculatedAttributeName

      @Stability(Stable) public void setCalculatedAttributeName(@NotNull String value)
      The name of an attribute defined in a profile object type.

    • getDomainName

      @Stability(Stable) @NotNull public String getDomainName()
      The unique name of the domain.

    • setDomainName

      @Stability(Stable) public void setDomainName(@NotNull String value)
      The unique name of the domain.

    • getStatistic

      @Stability(Stable) @NotNull public String getStatistic()
      The aggregation operation to perform for the calculated attribute.

    • setStatistic

      @Stability(Stable) public void setStatistic(@NotNull String value)
      The aggregation operation to perform for the calculated attribute.

    • getConditions

      @Stability(Stable) @Nullable public Object getConditions()
      The conditions including range, object count, and threshold for the calculated attribute.

      Returns union: either IResolvable or CfnCalculatedAttributeDefinition.ConditionsProperty

    • setConditions

      @Stability(Stable) public void setConditions(@Nullable IResolvable value)
      The conditions including range, object count, and threshold for the calculated attribute.

    • setConditions

      @Stability(Stable) public void setConditions(@Nullable CfnCalculatedAttributeDefinition.ConditionsProperty value)
      The conditions including range, object count, and threshold for the calculated attribute.

    • getDescription

      @Stability(Stable) @Nullable public String getDescription()
      The description of the calculated attribute.

    • setDescription

      @Stability(Stable) public void setDescription(@Nullable String value)
      The description of the calculated attribute.

    • getDisplayName

      @Stability(Stable) @Nullable public String getDisplayName()
      The display name of the calculated attribute.

    • setDisplayName

      @Stability(Stable) public void setDisplayName(@Nullable String value)
      The display name of the calculated attribute.

    • getTags

      @Stability(Stable) @Nullable public List<CfnTag> getTags()
      An array of key-value pairs to apply to this resource.

    • setTags

      @Stability(Stable) public void setTags(@Nullable List<CfnTag> value)
      An array of key-value pairs to apply to this resource.

    • getUseHistoricalData

      @Stability(Stable) @Nullable public Object getUseHistoricalData()
      Whether historical data ingested before the Calculated Attribute was created should be included in calculations.

      Returns union: either Boolean or IResolvable

    • setUseHistoricalData

      @Stability(Stable) public void setUseHistoricalData(@Nullable Boolean value)
      Whether historical data ingested before the Calculated Attribute was created should be included in calculations.

    • setUseHistoricalData

      @Stability(Stable) public void setUseHistoricalData(@Nullable IResolvable value)
      Whether historical data ingested before the Calculated Attribute was created should be included in calculations.