interface TimestreamConfigurationProperty

Language	Type name
.NET	`Amazon.CDK.AWS.Timestream.CfnScheduledQuery.TimestreamConfigurationProperty`
Go	`github.com/aws/aws-cdk-go/awscdk/v2/awstimestream#CfnScheduledQuery_TimestreamConfigurationProperty`
Java	`software.amazon.awscdk.services.timestream.CfnScheduledQuery.TimestreamConfigurationProperty`
Python	`aws_cdk.aws_timestream.CfnScheduledQuery.TimestreamConfigurationProperty`
TypeScript	`aws-cdk-lib` » `aws_timestream` » `CfnScheduledQuery` » `TimestreamConfigurationProperty`

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.

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

Name	Type	Description
databaseName	`string`	Name of Timestream database to which the query result will be written.
dimensionMappings	`IResolvable` `\| (IResolvable` `\|` `DimensionMappingProperty)[]`	This is to allow mapping column(s) from the query result to the dimension in the destination table.
tableName	`string`	Name of Timestream table that the query result will be written to.
timeColumn	`string`	Column from query result that should be used as the time column in destination table.
measureNameColumn?	`string`	Name of the measure column.
mixedMeasureMappings?	`IResolvable` `\| (IResolvable` `\|` `MixedMeasureMappingProperty)[]`	Specifies how to map measures to multi-measure records.
multiMeasureMappings?	`IResolvable` `\|` `MultiMeasureMappingsProperty`	Multi-measure mappings.

databaseName

Type: string

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

dimensionMappings

Type: IResolvable | (IResolvable | DimensionMappingProperty)[]

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

tableName

Type: string

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.

timeColumn

Type: string

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

Column type for this should be TIMESTAMP.

measureNameColumn?

Type: string (optional)

Name of the measure column.

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

mixedMeasureMappings?

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

Specifies how to map measures to multi-measure records.

multiMeasureMappings?

Type: IResolvable | MultiMeasureMappingsProperty (optional)

Multi-measure mappings.