2.233.0

interface RangeProperty

LanguageType name
.NETAmazon.CDK.Mixins.Preview.AWS.CustomerProfiles.Mixins.CfnCalculatedAttributeDefinitionPropsMixin.RangeProperty
Gogithub.com/aws/aws-cdk-go/awscdkmixinspreview/v2/awscustomerprofiles/mixins#CfnCalculatedAttributeDefinitionPropsMixin_RangeProperty
Javasoftware.amazon.awscdk.mixins.preview.services.customerprofiles.mixins.CfnCalculatedAttributeDefinitionPropsMixin.RangeProperty
Pythonaws_cdk.mixins_preview.aws_customerprofiles.mixins.CfnCalculatedAttributeDefinitionPropsMixin.RangeProperty
TypeScript @aws-cdk/mixins-preview » aws_customerprofiles » mixins » CfnCalculatedAttributeDefinitionPropsMixin » RangeProperty

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

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

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { mixins as customerprofiles_mixins } from '@aws-cdk/mixins-preview/aws-customerprofiles';
const rangeProperty: customerprofiles_mixins.CfnCalculatedAttributeDefinitionPropsMixin.RangeProperty = {
  timestampFormat: 'timestampFormat',
  timestampSource: 'timestampSource',
  unit: 'unit',
  value: 123,
  valueRange: {
    end: 123,
    start: 123,
  },
};

Properties

NameTypeDescription
timestampFormat?stringThe format the timestamp field in your JSON object is specified.
timestampSource?stringAn expression specifying the field in your JSON object from which the date should be parsed.
unit?stringThe unit of time.
value?numberThe amount of time of the specified unit.
valueRange?IResolvable | ValueRangePropertyA structure letting customers specify a relative time window over which over which data is included in the Calculated Attribute.

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"

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

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

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

unit?

Type: string (optional)

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

value?

Type: number (optional)

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

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.

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

← PreviousNext →