Package software.amazon.awscdk.services.pipes

Interface CfnPipe.PipeTargetTimestreamParametersProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnPipe.PipeTargetTimestreamParametersProperty.Jsii$Proxy

Enclosing class:

CfnPipe

@Stability(Stable)
public static interface CfnPipe.PipeTargetTimestreamParametersProperty
extends software.amazon.jsii.JsiiSerializable

The parameters for using a Timestream for LiveAnalytics table as a target.

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.pipes.*;
 PipeTargetTimestreamParametersProperty pipeTargetTimestreamParametersProperty = PipeTargetTimestreamParametersProperty.builder()
         .dimensionMappings(List.of(DimensionMappingProperty.builder()
                 .dimensionName("dimensionName")
                 .dimensionValue("dimensionValue")
                 .dimensionValueType("dimensionValueType")
                 .build()))
         .timeValue("timeValue")
         .versionValue("versionValue")
         // the properties below are optional
         .epochTimeUnit("epochTimeUnit")
         .multiMeasureMappings(List.of(MultiMeasureMappingProperty.builder()
                 .multiMeasureAttributeMappings(List.of(MultiMeasureAttributeMappingProperty.builder()
                         .measureValue("measureValue")
                         .measureValueType("measureValueType")
                         .multiMeasureAttributeName("multiMeasureAttributeName")
                         .build()))
                 .multiMeasureName("multiMeasureName")
                 .build()))
         .singleMeasureMappings(List.of(SingleMeasureMappingProperty.builder()
                 .measureName("measureName")
                 .measureValue("measureValue")
                 .measureValueType("measureValueType")
                 .build()))
         .timeFieldType("timeFieldType")
         .timestampFormat("timestampFormat")
         .build();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pipes-pipe-pipetargettimestreamparameters.html

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static CfnPipe.PipeTargetTimestreamParametersProperty.Builder	builder()
Object	getDimensionMappings()	Map source data to dimensions in the target Timestream for LiveAnalytics table.
default String	getEpochTimeUnit()	The granularity of the time units used.
default Object	getMultiMeasureMappings()	Maps multiple measures from the source event to the same record in the specified Timestream for LiveAnalytics table.
default Object	getSingleMeasureMappings()	Mappings of single source data fields to individual records in the specified Timestream for LiveAnalytics table.
default String	getTimeFieldType()	The type of time value used.
default String	getTimestampFormat()	How to format the timestamps.
String	getTimeValue()	Dynamic path to the source data field that represents the time value for your data.
String	getVersionValue()	64 bit version value or source data field that represents the version value for your data.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getDimensionMappings

@Stability(Stable)
@NotNull
Object getDimensionMappings()

Map source data to dimensions in the target Timestream for LiveAnalytics table.

For more information, see Amazon Timestream for LiveAnalytics concepts

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pipes-pipe-pipetargettimestreamparameters.html#cfn-pipes-pipe-pipetargettimestreamparameters-dimensionmappings

getTimeValue

@Stability(Stable)
@NotNull
String getTimeValue()

Dynamic path to the source data field that represents the time value for your data.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pipes-pipe-pipetargettimestreamparameters.html#cfn-pipes-pipe-pipetargettimestreamparameters-timevalue

getVersionValue

@Stability(Stable)
@NotNull
String getVersionValue()

64 bit version value or source data field that represents the version value for your data.

Write requests with a higher version number will update the existing measure values of the record and version. In cases where the measure value is the same, the version will still be updated.

Default value is 1.

Timestream for LiveAnalytics does not support updating partial measure values in a record.

Write requests for duplicate data with a higher version number will update the existing measure value and version. In cases where the measure value is the same, Version will still be updated. Default value is 1 .

Version must be 1 or greater, or you will receive a ValidationException error.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pipes-pipe-pipetargettimestreamparameters.html#cfn-pipes-pipe-pipetargettimestreamparameters-versionvalue

getEpochTimeUnit

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

The granularity of the time units used. Default is MILLISECONDS .

Required if TimeFieldType is specified as EPOCH .

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pipes-pipe-pipetargettimestreamparameters.html#cfn-pipes-pipe-pipetargettimestreamparameters-epochtimeunit

getMultiMeasureMappings

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

Maps multiple measures from the source event to the same record in the specified Timestream for LiveAnalytics table.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pipes-pipe-pipetargettimestreamparameters.html#cfn-pipes-pipe-pipetargettimestreamparameters-multimeasuremappings

getSingleMeasureMappings

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

Mappings of single source data fields to individual records in the specified Timestream for LiveAnalytics table.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pipes-pipe-pipetargettimestreamparameters.html#cfn-pipes-pipe-pipetargettimestreamparameters-singlemeasuremappings

getTimeFieldType

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

The type of time value used.

The default is EPOCH .

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pipes-pipe-pipetargettimestreamparameters.html#cfn-pipes-pipe-pipetargettimestreamparameters-timefieldtype

getTimestampFormat

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

How to format the timestamps. For example, yyyy-MM-dd'T'HH:mm:ss'Z' .

Required if TimeFieldType is specified as TIMESTAMP_FORMAT .

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pipes-pipe-pipetargettimestreamparameters.html#cfn-pipes-pipe-pipetargettimestreamparameters-timestampformat

builder

@Stability(Stable)
static CfnPipe.PipeTargetTimestreamParametersProperty.Builder builder()

Returns:

a CfnPipe.PipeTargetTimestreamParametersProperty.Builder of CfnPipe.PipeTargetTimestreamParametersProperty