2.233.0

interface PipeTargetTimestreamParametersProperty

LanguageType name
.NETAmazon.CDK.Mixins.Preview.AWS.Pipes.Mixins.CfnPipePropsMixin.PipeTargetTimestreamParametersProperty
Gogithub.com/aws/aws-cdk-go/awscdkmixinspreview/v2/awspipes/mixins#CfnPipePropsMixin_PipeTargetTimestreamParametersProperty
Javasoftware.amazon.awscdk.mixins.preview.services.pipes.mixins.CfnPipePropsMixin.PipeTargetTimestreamParametersProperty
Pythonaws_cdk.mixins_preview.aws_pipes.mixins.CfnPipePropsMixin.PipeTargetTimestreamParametersProperty
TypeScript @aws-cdk/mixins-preview » aws_pipes » mixins » CfnPipePropsMixin » PipeTargetTimestreamParametersProperty

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

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

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { mixins as pipes_mixins } from '@aws-cdk/mixins-preview/aws-pipes';
const pipeTargetTimestreamParametersProperty: pipes_mixins.CfnPipePropsMixin.PipeTargetTimestreamParametersProperty = {
  dimensionMappings: [{
    dimensionName: 'dimensionName',
    dimensionValue: 'dimensionValue',
    dimensionValueType: 'dimensionValueType',
  }],
  epochTimeUnit: 'epochTimeUnit',
  multiMeasureMappings: [{
    multiMeasureAttributeMappings: [{
      measureValue: 'measureValue',
      measureValueType: 'measureValueType',
      multiMeasureAttributeName: 'multiMeasureAttributeName',
    }],
    multiMeasureName: 'multiMeasureName',
  }],
  singleMeasureMappings: [{
    measureName: 'measureName',
    measureValue: 'measureValue',
    measureValueType: 'measureValueType',
  }],
  timeFieldType: 'timeFieldType',
  timestampFormat: 'timestampFormat',
  timeValue: 'timeValue',
  versionValue: 'versionValue',
};

Properties

NameTypeDescription
dimensionMappings?IResolvable | (IResolvable | DimensionMappingProperty)[]Map source data to dimensions in the target Timestream for LiveAnalytics table.
epochTimeUnit?stringThe granularity of the time units used. Default is MILLISECONDS .
multiMeasureMappings?IResolvable | (IResolvable | MultiMeasureMappingProperty)[]Maps multiple measures from the source event to the same record in the specified Timestream for LiveAnalytics table.
singleMeasureMappings?IResolvable | (IResolvable | SingleMeasureMappingProperty)[]Mappings of single source data fields to individual records in the specified Timestream for LiveAnalytics table.
timeFieldType?stringThe type of time value used.
timeValue?stringDynamic path to the source data field that represents the time value for your data.
timestampFormat?stringHow to format the timestamps. For example, yyyy-MM-dd'T'HH:mm:ss'Z' .
versionValue?string64 bit version value or source data field that represents the version value for your data.

dimensionMappings?

Type: IResolvable | (IResolvable | DimensionMappingProperty)[] (optional)

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

epochTimeUnit?

Type: string (optional)

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

multiMeasureMappings?

Type: IResolvable | (IResolvable | MultiMeasureMappingProperty)[] (optional)

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

singleMeasureMappings?

Type: IResolvable | (IResolvable | SingleMeasureMappingProperty)[] (optional)

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

timeFieldType?

Type: string (optional)

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

timeValue?

Type: string (optional)

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

timestampFormat?

Type: string (optional)

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

versionValue?

Type: string (optional)

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

← PreviousNext →