software.amazon.awscdk.services.timestream

Interface CfnScheduledQueryProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnScheduledQueryProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.47.0 (build 86d2c33)",
           date="2021-12-22T10:27:19.555Z")
 @Stability(value=Stable)
public interface CfnScheduledQueryProps
extends software.amazon.jsii.JsiiSerializable

Properties for defining a `AWS::Timestream::ScheduledQuery`.

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.*;
 CfnScheduledQueryProps cfnScheduledQueryProps = CfnScheduledQueryProps.builder()
         .errorReportConfiguration(ErrorReportConfigurationProperty.builder()
                 .s3Configuration(S3ConfigurationProperty.builder()
                         .bucketName("bucketName")
                         // the properties below are optional
                         .encryptionOption("encryptionOption")
                         .objectKeyPrefix("objectKeyPrefix")
                         .build())
                 .build())
         .notificationConfiguration(NotificationConfigurationProperty.builder()
                 .snsConfiguration(SnsConfigurationProperty.builder()
                         .topicArn("topicArn")
                         .build())
                 .build())
         .queryString("queryString")
         .scheduleConfiguration(ScheduleConfigurationProperty.builder()
                 .scheduleExpression("scheduleExpression")
                 .build())
         .scheduledQueryExecutionRoleArn("scheduledQueryExecutionRoleArn")
         // the properties below are optional
         .clientToken("clientToken")
         .kmsKeyId("kmsKeyId")
         .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()))
                         .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())
                 .build())
         .build();
 

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method and Description
static CfnScheduledQueryProps.Builder	builder()
default String	getClientToken() `AWS::Timestream::ScheduledQuery.ClientToken`.
Object	getErrorReportConfiguration() `AWS::Timestream::ScheduledQuery.ErrorReportConfiguration`.
default String	getKmsKeyId() `AWS::Timestream::ScheduledQuery.KmsKeyId`.
Object	getNotificationConfiguration() `AWS::Timestream::ScheduledQuery.NotificationConfiguration`.
String	getQueryString() `AWS::Timestream::ScheduledQuery.QueryString`.
Object	getScheduleConfiguration() `AWS::Timestream::ScheduledQuery.ScheduleConfiguration`.
String	getScheduledQueryExecutionRoleArn() `AWS::Timestream::ScheduledQuery.ScheduledQueryExecutionRoleArn`.
default String	getScheduledQueryName() `AWS::Timestream::ScheduledQuery.ScheduledQueryName`.
default List<CfnTag>	getTags() `AWS::Timestream::ScheduledQuery.Tags`.
default Object	getTargetConfiguration() `AWS::Timestream::ScheduledQuery.TargetConfiguration`.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getClientToken

@Stability(value=Stable)
 @Nullable
default String getClientToken()

`AWS::Timestream::ScheduledQuery.ClientToken`.

getErrorReportConfiguration

@Stability(value=Stable)
 @NotNull
Object getErrorReportConfiguration()

`AWS::Timestream::ScheduledQuery.ErrorReportConfiguration`.

getKmsKeyId

@Stability(value=Stable)
 @Nullable
default String getKmsKeyId()

`AWS::Timestream::ScheduledQuery.KmsKeyId`.

getNotificationConfiguration

@Stability(value=Stable)
 @NotNull
Object getNotificationConfiguration()

`AWS::Timestream::ScheduledQuery.NotificationConfiguration`.

getQueryString

@Stability(value=Stable)
 @NotNull
String getQueryString()

`AWS::Timestream::ScheduledQuery.QueryString`.

getScheduleConfiguration

@Stability(value=Stable)
 @NotNull
Object getScheduleConfiguration()

`AWS::Timestream::ScheduledQuery.ScheduleConfiguration`.

getScheduledQueryExecutionRoleArn

@Stability(value=Stable)
 @NotNull
String getScheduledQueryExecutionRoleArn()

`AWS::Timestream::ScheduledQuery.ScheduledQueryExecutionRoleArn`.

getScheduledQueryName

@Stability(value=Stable)
 @Nullable
default String getScheduledQueryName()

`AWS::Timestream::ScheduledQuery.ScheduledQueryName`.

getTags

@Stability(value=Stable)
 @Nullable
default List<CfnTag> getTags()

`AWS::Timestream::ScheduledQuery.Tags`.

getTargetConfiguration

@Stability(value=Stable)
 @Nullable
default Object getTargetConfiguration()

`AWS::Timestream::ScheduledQuery.TargetConfiguration`.

builder

@Stability(value=Stable)
static CfnScheduledQueryProps.Builder builder()

Returns:

a CfnScheduledQueryProps.Builder of CfnScheduledQueryProps