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

Class CfnScheduledQueryPropsMixin

java.lang.Object

software.amazon.jsii.JsiiObject

software.amazon.awscdk.Mixin

software.amazon.awscdk.cfnpropertymixins.services.timestream.CfnScheduledQueryPropsMixin

All Implemented Interfaces:

software.amazon.jsii.JsiiSerializable, software.constructs.IMixin

@Generated(value="jsii-pacmak/1.127.0 (build 2117ad5)",
           date="2026-03-11T13:20:05.840Z")
@Stability(Stable)
public class CfnScheduledQueryPropsMixin
extends Mixin
implements software.constructs.IMixin

Create a scheduled query that will be run on your behalf at the configured schedule.

Timestream assumes the execution role provided as part of the ScheduledQueryExecutionRoleArn parameter to run the query. You can use the NotificationConfiguration parameter to configure notification for your scheduled query operations.

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.*;
 import software.amazon.awscdk.*;
 IMergeStrategy mergeStrategy;
 CfnScheduledQueryPropsMixin cfnScheduledQueryPropsMixin = CfnScheduledQueryPropsMixin.Builder.create(CfnScheduledQueryMixinProps.builder()
         .clientToken("clientToken")
         .errorReportConfiguration(ErrorReportConfigurationProperty.builder()
                 .s3Configuration(S3ConfigurationProperty.builder()
                         .bucketName("bucketName")
                         .encryptionOption("encryptionOption")
                         .objectKeyPrefix("objectKeyPrefix")
                         .build())
                 .build())
         .kmsKeyId("kmsKeyId")
         .notificationConfiguration(NotificationConfigurationProperty.builder()
                 .snsConfiguration(SnsConfigurationProperty.builder()
                         .topicArn("topicArn")
                         .build())
                 .build())
         .queryString("queryString")
         .scheduleConfiguration(ScheduleConfigurationProperty.builder()
                 .scheduleExpression("scheduleExpression")
                 .build())
         .scheduledQueryExecutionRoleArn("scheduledQueryExecutionRoleArn")
         .scheduledQueryName("scheduledQueryName")
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .targetConfiguration(TargetConfigurationProperty.builder()
                 .timestreamConfiguration(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())
                 .build())
         .build())
 .strategy(mergeStrategy)
 .build();
 

See Also:

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

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	CfnScheduledQueryPropsMixin.Builder	A fluent builder for CfnScheduledQueryPropsMixin.
static interface	CfnScheduledQueryPropsMixin.DimensionMappingProperty	This type is used to map column(s) from the query result to a dimension in the destination table.
static interface	CfnScheduledQueryPropsMixin.ErrorReportConfigurationProperty	Configuration required for error reporting.
static interface	CfnScheduledQueryPropsMixin.MixedMeasureMappingProperty	MixedMeasureMappings are mappings that can be used to ingest data into a mixture of narrow and multi measures in the derived table.
static interface	CfnScheduledQueryPropsMixin.MultiMeasureAttributeMappingProperty	Attribute mapping for MULTI value measures.
static interface	CfnScheduledQueryPropsMixin.MultiMeasureMappingsProperty	Only one of MixedMeasureMappings or MultiMeasureMappings is to be provided.
static interface	CfnScheduledQueryPropsMixin.NotificationConfigurationProperty	Notification configuration for a scheduled query.
static interface	CfnScheduledQueryPropsMixin.S3ConfigurationProperty	Details on S3 location for error reports that result from running a query.
static interface	CfnScheduledQueryPropsMixin.ScheduleConfigurationProperty	Configuration of the schedule of the query.
static interface	CfnScheduledQueryPropsMixin.SnsConfigurationProperty	Details on SNS that are required to send the notification.
static interface	CfnScheduledQueryPropsMixin.TargetConfigurationProperty	Configuration used for writing the output of a query.
static interface	CfnScheduledQueryPropsMixin.TimestreamConfigurationProperty	Configuration to write data into Timestream database and table.

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.constructs.IMixin

software.constructs.IMixin.Jsii$Default, software.constructs.IMixin.Jsii$Proxy

Field Summary

Fields

Modifier and Type	Field	Description
protected static final List<String>	CFN_PROPERTY_KEYS

Constructor Summary

Constructors

Modifier	Constructor	Description
	CfnScheduledQueryPropsMixin(CfnScheduledQueryMixinProps props)	Create a mixin to apply properties to AWS::Timestream::ScheduledQuery.
	CfnScheduledQueryPropsMixin(CfnScheduledQueryMixinProps props, CfnPropertyMixinOptions options)	Create a mixin to apply properties to AWS::Timestream::ScheduledQuery.
protected	CfnScheduledQueryPropsMixin(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnScheduledQueryPropsMixin(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method	Description
void	applyTo(software.constructs.IConstruct construct)	Apply the mixin properties to the construct.
protected CfnScheduledQueryMixinProps	getProps()
protected IMergeStrategy	getStrategy()
Boolean	supports(software.constructs.IConstruct construct)	Check if this mixin supports the given construct.

Methods inherited from class software.amazon.awscdk.Mixin

isMixin

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Field Details

CFN_PROPERTY_KEYS

@Stability(Stable)
protected static final List<String> CFN_PROPERTY_KEYS

Constructor Details

CfnScheduledQueryPropsMixin

protected CfnScheduledQueryPropsMixin(software.amazon.jsii.JsiiObjectRef objRef)

CfnScheduledQueryPropsMixin

protected CfnScheduledQueryPropsMixin(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

CfnScheduledQueryPropsMixin

@Stability(Stable)
public CfnScheduledQueryPropsMixin(@NotNull
 CfnScheduledQueryMixinProps props,
 @Nullable
 CfnPropertyMixinOptions options)

Create a mixin to apply properties to AWS::Timestream::ScheduledQuery.

Parameters:

props - L1 properties to apply. This parameter is required.

options - Mixin options.

CfnScheduledQueryPropsMixin

@Stability(Stable)
public CfnScheduledQueryPropsMixin(@NotNull
 CfnScheduledQueryMixinProps props)

Create a mixin to apply properties to AWS::Timestream::ScheduledQuery.

Parameters:

props - L1 properties to apply. This parameter is required.

Method Details

applyTo

@Stability(Stable)
public void applyTo(@NotNull
 software.constructs.IConstruct construct)

Apply the mixin properties to the construct.

Specified by:

applyTo in interface software.constructs.IMixin

Specified by:

applyTo in class Mixin

Parameters:

construct - This parameter is required.

supports

@Stability(Stable)
@NotNull
public Boolean supports(@NotNull
 software.constructs.IConstruct construct)

Check if this mixin supports the given construct.

Specified by:

supports in interface software.constructs.IMixin

Overrides:

supports in class Mixin

Parameters:

construct - This parameter is required.

getProps

@Stability(Stable)
@NotNull
protected CfnScheduledQueryMixinProps getProps()

getStrategy

@Stability(Stable)
@NotNull
protected IMergeStrategy getStrategy()