Interface CfnCalculatedAttributeDefinition.IRangeProperty

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

Namespace: Amazon.CDK.AWS.CustomerProfiles

Assembly: Amazon.CDK.Lib.dll

Syntax (csharp)

public interface CfnCalculatedAttributeDefinition.IRangeProperty

Syntax (vb)

Public Interface CfnCalculatedAttributeDefinition.IRangeProperty

Remarks

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

ExampleMetadata: fixture=_generated

Examples

// The code below shows an example of how to instantiate this type.
             // The values are placeholders you should change.
             using Amazon.CDK.AWS.CustomerProfiles;

             var rangeProperty = new RangeProperty {
                 Unit = "unit",

                 // the properties below are optional
                 TimestampFormat = "timestampFormat",
                 TimestampSource = "timestampSource",
                 Value = 123,
                 ValueRange = new ValueRangeProperty {
                     End = 123,
                     Start = 123
                 }
             };

Synopsis

Properties

TimestampFormat	The format the timestamp field in your JSON object is specified.
TimestampSource	An expression specifying the field in your JSON object from which the date should be parsed.
Unit	The unit of time.
Value	The amount of time of the specified unit.
ValueRange	A structure letting customers specify a relative time window over which over which data is included in the Calculated Attribute.

Properties

TimestampFormat

The format the timestamp field in your JSON object is specified.

string? TimestampFormat { get; }

Property Value

string

Remarks

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: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-calculatedattributedefinition-range.html#cfn-customerprofiles-calculatedattributedefinition-range-timestampformat

TimestampSource

An expression specifying the field in your JSON object from which the date should be parsed.

string? TimestampSource { get; }

Property Value

string

Remarks

The expression should follow the structure of "{ObjectTypeName.<Location of timestamp field in JSON pointer format>}". E.g. if your object type is MyType and source JSON is {"generatedAt": {"timestamp": "1737587945945"}}, then TimestampSource should be "{MyType.generatedAt.timestamp}"