aws-cdk-lib.aws_timestream.CfnScheduledQuery.TimestreamConfigurationProperty

TimestreamConfigurationProperty Struct

Configuration to write data into Timestream database and table.

This configuration allows the user to map the query result select columns into the destination table columns.

Source

Generated code

Type last changed

v2.93.0 · 23 Aug 2023

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_timestream as timestream } from 'aws-cdk-lib';
const timestreamConfigurationProperty: timestream.CfnScheduledQuery.TimestreamConfigurationProperty = {
  databaseName: 'databaseName',
  dimensionMappings: [{
    dimensionValueType: 'dimensionValueType',
    name: 'name',
  }],
  tableName: 'tableName',
  timeColumn: 'timeColumn',

  // the properties below are optional
  measureNameColumn: 'measureNameColumn',
  mixedMeasureMappings: [{
    measureValueType: 'measureValueType',

    // the properties below are optional
    measureName: 'measureName',
    multiMeasureAttributeMappings: [{
      measureValueType: 'measureValueType',
      sourceColumn: 'sourceColumn',

      // the properties below are optional
      targetMultiMeasureAttributeName: 'targetMultiMeasureAttributeName',
    }],
    sourceColumn: 'sourceColumn',
    targetMeasureName: 'targetMeasureName',
  }],
  multiMeasureMappings: {
    multiMeasureAttributeMappings: [{
      measureValueType: 'measureValueType',
      sourceColumn: 'sourceColumn',

      // the properties below are optional
      targetMultiMeasureAttributeName: 'targetMultiMeasureAttributeName',
    }],

    // the properties below are optional
    targetMultiMeasureName: 'targetMultiMeasureName',
  },
};

Properties

databaseNamestringdatabase_namestrdatabaseNameStringDatabaseNamestringDatabaseName*stringrequired#

Name of Timestream database to which the query result will be written.

dimensionMappingsIResolvable | IResolvable | CfnScheduledQuery.DimensionMappingProperty[]dimension_mappingstyping.Union[IResolvable, typing.List[typing.Union[IResolvable, DimensionMappingProperty]]]dimensionMappingsIResolvableDimensionMappingsIResolvableDimensionMappingsinterface{}required#

This is to allow mapping column(s) from the query result to the dimension in the destination table.

measureNameColumnstringmeasure_name_columnstrmeasureNameColumnStringMeasureNameColumnstringMeasureNameColumn*string#

Name of the measure column.

Also see MultiMeasureMappings and MixedMeasureMappings for how measure name properties on those relate to MeasureNameColumn .

mixedMeasureMappingsIResolvable | IResolvable | CfnScheduledQuery.MixedMeasureMappingProperty[]mixed_measure_mappingstyping.Union[IResolvable, typing.List[typing.Union[IResolvable, MixedMeasureMappingProperty]]]mixedMeasureMappingsIResolvableMixedMeasureMappingsIResolvableMixedMeasureMappingsinterface{}#

Specifies how to map measures to multi-measure records.

multiMeasureMappingsIResolvable | CfnScheduledQuery.MultiMeasureMappingsPropertymulti_measure_mappingstyping.Union[IResolvable, MultiMeasureMappingsProperty]multiMeasureMappingsIResolvableMultiMeasureMappingsIResolvableMultiMeasureMappingsinterface{}#

Multi-measure mappings.

tableNamestringtable_namestrtableNameStringTableNamestringTableName*stringrequired#

Name of Timestream table that the query result will be written to.

The table should be within the same database that is provided in Timestream configuration.

timeColumnstringtime_columnstrtimeColumnStringTimeColumnstringTimeColumn*stringrequired#

Column from query result that should be used as the time column in destination table.

Column type for this should be TIMESTAMP.