Package software.amazon.awscdk.cfnpropertymixins.services.timestream

Interface CfnScheduledQueryPropsMixin.TimestreamConfigurationProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnScheduledQueryPropsMixin.TimestreamConfigurationProperty.Jsii$Proxy

Enclosing class:

CfnScheduledQueryPropsMixin

@Stability(Stable)
public static interface CfnScheduledQueryPropsMixin.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.cfnpropertymixins.services.timestream.*;
 TimestreamConfigurationProperty timestreamConfigurationProperty = TimestreamConfigurationProperty.builder()
         .databaseName("databaseName")
         .dimensionMappings(List.of(DimensionMappingProperty.builder()
                 .dimensionValueType("dimensionValueType")
                 .name("name")
                 .build()))
         .measureNameColumn("measureNameColumn")
         .mixedMeasureMappings(List.of(MixedMeasureMappingProperty.builder()
                 .measureName("measureName")
                 .measureValueType("measureValueType")
                 .multiMeasureAttributeMappings(List.of(MultiMeasureAttributeMappingProperty.builder()
                         .measureValueType("measureValueType")
                         .sourceColumn("sourceColumn")
                         .targetMultiMeasureAttributeName("targetMultiMeasureAttributeName")
                         .build()))
                 .sourceColumn("sourceColumn")
                 .targetMeasureName("targetMeasureName")
                 .build()))
         .multiMeasureMappings(MultiMeasureMappingsProperty.builder()
                 .multiMeasureAttributeMappings(List.of(MultiMeasureAttributeMappingProperty.builder()
                         .measureValueType("measureValueType")
                         .sourceColumn("sourceColumn")
                         .targetMultiMeasureAttributeName("targetMultiMeasureAttributeName")
                         .build()))
                 .targetMultiMeasureName("targetMultiMeasureName")
                 .build())
         .tableName("tableName")
         .timeColumn("timeColumn")
         .build();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-timestream-scheduledquery-timestreamconfiguration.html

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static CfnScheduledQueryPropsMixin.TimestreamConfigurationProperty.Builder	builder()
default String	getDatabaseName()	Name of Timestream database to which the query result will be written.
default 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.
default String	getTableName()	Name of Timestream table that the query result will be written to.
default 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)
@Nullable
default String getDatabaseName()

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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-timestream-scheduledquery-timestreamconfiguration.html#cfn-timestream-scheduledquery-timestreamconfiguration-databasename

getDimensionMappings

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

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

Returns union: either IResolvable or Listinvalid input: '<'either IResolvable or CfnScheduledQueryPropsMixin.DimensionMappingProperty>

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-timestream-scheduledquery-timestreamconfiguration.html#cfn-timestream-scheduledquery-timestreamconfiguration-dimensionmappings

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 .

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-timestream-scheduledquery-timestreamconfiguration.html#cfn-timestream-scheduledquery-timestreamconfiguration-measurenamecolumn

getMixedMeasureMappings

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

Specifies how to map measures to multi-measure records.

Returns union: either IResolvable or Listinvalid input: '<'either IResolvable or CfnScheduledQueryPropsMixin.MixedMeasureMappingProperty>

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-timestream-scheduledquery-timestreamconfiguration.html#cfn-timestream-scheduledquery-timestreamconfiguration-mixedmeasuremappings

getMultiMeasureMappings

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

Multi-measure mappings.

Returns union: either IResolvable or CfnScheduledQueryPropsMixin.MultiMeasureMappingsProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-timestream-scheduledquery-timestreamconfiguration.html#cfn-timestream-scheduledquery-timestreamconfiguration-multimeasuremappings

getTableName

@Stability(Stable)
@Nullable
default 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.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-timestream-scheduledquery-timestreamconfiguration.html#cfn-timestream-scheduledquery-timestreamconfiguration-tablename

getTimeColumn

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

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

Column type for this should be TIMESTAMP.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-timestream-scheduledquery-timestreamconfiguration.html#cfn-timestream-scheduledquery-timestreamconfiguration-timecolumn

builder

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

Returns:

a CfnScheduledQueryPropsMixin.TimestreamConfigurationProperty.Builder of CfnScheduledQueryPropsMixin.TimestreamConfigurationProperty