interface RangeProperty

Language	Type name
.NET	`Amazon.CDK.AWS.CustomerProfiles.CfnCalculatedAttributeDefinition.RangeProperty`
Go	`github.com/aws/aws-cdk-go/awscdk/v2/awscustomerprofiles#CfnCalculatedAttributeDefinition_RangeProperty`
Java	`software.amazon.awscdk.services.customerprofiles.CfnCalculatedAttributeDefinition.RangeProperty`
Python	`aws_cdk.aws_customerprofiles.CfnCalculatedAttributeDefinition.RangeProperty`
TypeScript	`aws-cdk-lib` » `aws_customerprofiles` » `CfnCalculatedAttributeDefinition` » `RangeProperty`

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 { aws_customerprofiles as customerprofiles } from 'aws-cdk-lib';
const rangeProperty: customerprofiles.CfnCalculatedAttributeDefinition.RangeProperty = {
  unit: 'unit',

  // the properties below are optional
  timestampFormat: 'timestampFormat',
  timestampSource: 'timestampSource',
  value: 123,
  valueRange: {
    end: 123,
    start: 123,
  },
};

Properties

Name	Type	Description
unit	`string`	The unit of time.
timestampFormat?	`string`	The format the timestamp field in your JSON object is specified.
timestampSource?	`string`	An expression specifying the field in your JSON object from which the date should be parsed.
value?	`number`	The amount of time of the specified unit.
valueRange?	`IResolvable` `\|` `ValueRangeProperty`	A structure letting customers specify a relative time window over which over which data is included in the Calculated Attribute.

unit

Type: string

The unit of time.

timestampFormat?

Type: string (optional)

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"

timestampSource?

Type: string (optional)

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}"

value?

Type: number (optional)

The amount of time of the specified unit.

valueRange?

Type: IResolvable | ValueRangeProperty (optional)

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.