Package software.amazon.awscdk.services.timestream

Interface CfnScheduledQuery.TimestreamConfigurationProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnScheduledQuery.TimestreamConfigurationProperty.Jsii$Proxy

Enclosing class:

CfnScheduledQuery

@Stability(Stable)
public static interface CfnScheduledQuery.TimestreamConfigurationProperty
extends software.amazon.jsii.JsiiSerializable

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 software.amazon.awscdk.services.timestream.*;
 TimestreamConfigurationProperty timestreamConfigurationProperty = TimestreamConfigurationProperty.builder()
         .databaseName("databaseName")
         .dimensionMappings(List.of(DimensionMappingProperty.builder()
                 .dimensionValueType("dimensionValueType")
                 .name("name")
                 .build()))
         .tableName("tableName")
         .timeColumn("timeColumn")
         // the properties below are optional
         .measureNameColumn("measureNameColumn")
         .mixedMeasureMappings(List.of(MixedMeasureMappingProperty.builder()
                 .measureValueType("measureValueType")
                 // the properties below are optional
                 .measureName("measureName")
                 .multiMeasureAttributeMappings(List.of(MultiMeasureAttributeMappingProperty.builder()
                         .measureValueType("measureValueType")
                         .sourceColumn("sourceColumn")
                         // the properties below are optional
                         .targetMultiMeasureAttributeName("targetMultiMeasureAttributeName")
                         .build()))
                 .sourceColumn("sourceColumn")
                 .targetMeasureName("targetMeasureName")
                 .build()))
         .multiMeasureMappings(MultiMeasureMappingsProperty.builder()
                 .multiMeasureAttributeMappings(List.of(MultiMeasureAttributeMappingProperty.builder()
                         .measureValueType("measureValueType")
                         .sourceColumn("sourceColumn")
                         // the properties below are optional
                         .targetMultiMeasureAttributeName("targetMultiMeasureAttributeName")
                         .build()))
                 // the properties below are optional
                 .targetMultiMeasureName("targetMultiMeasureName")
                 .build())
         .build();
 

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static CfnScheduledQuery.TimestreamConfigurationProperty.Builder	builder()
String	getDatabaseName()	Name of Timestream database to which the query result will be written.
Object	getDimensionMappings()	This is to allow mapping column(s) from the query result to the dimension in the destination table.
default String	getMeasureNameColumn()	Name of the measure column.
default Object	getMixedMeasureMappings()	Specifies how to map measures to multi-measure records.
default Object	getMultiMeasureMappings()	Multi-measure mappings.
String	getTableName()	Name of Timestream table that the query result will be written to.
String	getTimeColumn()	Column from query result that should be used as the time column in destination table.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getDatabaseName

@Stability(Stable)
@NotNull
String getDatabaseName()

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

getDimensionMappings

@Stability(Stable)
@NotNull
Object getDimensionMappings()

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

getTableName

@Stability(Stable)
@NotNull
String getTableName()

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.

getTimeColumn

@Stability(Stable)
@NotNull
String getTimeColumn()

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

Column type for this should be TIMESTAMP.

getMeasureNameColumn

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

Name of the measure column.

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

getMixedMeasureMappings

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

Specifies how to map measures to multi-measure records.

getMultiMeasureMappings

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

Multi-measure mappings.

builder

@Stability(Stable)
static CfnScheduledQuery.TimestreamConfigurationProperty.Builder builder()

Returns:

a CfnScheduledQuery.TimestreamConfigurationProperty.Builder of CfnScheduledQuery.TimestreamConfigurationProperty