Package software.amazon.awscdk.services.customerprofiles

Interface CfnCalculatedAttributeDefinition.RangeProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnCalculatedAttributeDefinition.RangeProperty.Jsii$Proxy

Enclosing class:

CfnCalculatedAttributeDefinition

@Stability(Stable)
public static interface CfnCalculatedAttributeDefinition.RangeProperty
extends software.amazon.jsii.JsiiSerializable

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

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.*;
 RangeProperty rangeProperty = RangeProperty.builder()
         .unit("unit")
         // the properties below are optional
         .timestampFormat("timestampFormat")
         .timestampSource("timestampSource")
         .value(123)
         .valueRange(ValueRangeProperty.builder()
                 .end(123)
                 .start(123)
                 .build())
         .build();
 

See Also:

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

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static CfnCalculatedAttributeDefinition.RangeProperty.Builder	builder()
default String	getTimestampFormat()	The format the timestamp field in your JSON object is specified.
default String	getTimestampSource()	An expression specifying the field in your JSON object from which the date should be parsed.
String	getUnit()	The unit of time.
default Number	getValue()	The amount of time of the specified unit.
default Object	getValueRange()	A structure letting customers specify a relative time window over which over which data is included in the Calculated Attribute.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getUnit

@Stability(Stable)
@NotNull
String getUnit()

The unit of time.

See Also:

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

getTimestampFormat

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

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 Also:

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

getTimestampSource

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

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 Also:

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

getValue

@Stability(Stable)
@Nullable
default Number getValue()

The amount of time of the specified unit.

See Also:

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

getValueRange

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

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.

Returns union: either IResolvable or CfnCalculatedAttributeDefinition.ValueRangeProperty

See Also:

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

builder

@Stability(Stable)
static CfnCalculatedAttributeDefinition.RangeProperty.Builder builder()

Returns:

a CfnCalculatedAttributeDefinition.RangeProperty.Builder of CfnCalculatedAttributeDefinition.RangeProperty