Package 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.102.0 (build e354887)",
           date="2024-08-23T05:56:24.628Z")
@Stability(Stable)
public interface CfnScheduledQueryProps
extends software.amazon.jsii.JsiiSerializable

Properties for defining a CfnScheduledQuery.

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();
 

See Also:

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

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static CfnScheduledQueryProps.Builder	builder()
default String	getClientToken()	Using a ClientToken makes the call to CreateScheduledQuery idempotent, in other words, making the same request repeatedly will produce the same result.
Object	getErrorReportConfiguration()	Configuration for error reporting.
default String	getKmsKeyId()	The Amazon KMS key used to encrypt the scheduled query resource, at-rest.
Object	getNotificationConfiguration()	Notification configuration for the scheduled query.
String	getQueryString()	The query string to run.
Object	getScheduleConfiguration()	Schedule configuration.
String	getScheduledQueryExecutionRoleArn()	The ARN for the IAM role that Timestream will assume when running the scheduled query.
default String	getScheduledQueryName()	A name for the query.
default List<CfnTag>	getTags()	A list of key-value pairs to label the scheduled query.
default Object	getTargetConfiguration()	Scheduled query target store configuration.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getErrorReportConfiguration

@Stability(Stable)
@NotNull
Object getErrorReportConfiguration()

Configuration for error reporting.

Error reports will be generated when a problem is encountered when writing the query results.

See Also:

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

getNotificationConfiguration

@Stability(Stable)
@NotNull
Object getNotificationConfiguration()

Notification configuration for the scheduled query.

A notification is sent by Timestream when a query run finishes, when the state is updated or when you delete it.

See Also:

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

getQueryString

@Stability(Stable)
@NotNull
String getQueryString()

The query string to run.

Parameter names can be specified in the query string @ character followed by an identifier. The named Parameter @scheduled_runtime is reserved and can be used in the query to get the time at which the query is scheduled to run.

The timestamp calculated according to the ScheduleConfiguration parameter, will be the value of @scheduled_runtime paramater for each query run. For example, consider an instance of a scheduled query executing on 2021-12-01 00:00:00. For this instance, the @scheduled_runtime parameter is initialized to the timestamp 2021-12-01 00:00:00 when invoking the query.

See Also:

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

getScheduleConfiguration

@Stability(Stable)
@NotNull
Object getScheduleConfiguration()

Schedule configuration.

See Also:

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

getScheduledQueryExecutionRoleArn

@Stability(Stable)
@NotNull
String getScheduledQueryExecutionRoleArn()

The ARN for the IAM role that Timestream will assume when running the scheduled query.

See Also:

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

getClientToken

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

Using a ClientToken makes the call to CreateScheduledQuery idempotent, in other words, making the same request repeatedly will produce the same result.

Making multiple identical CreateScheduledQuery requests has the same effect as making a single request.

• If CreateScheduledQuery is called without a ClientToken , the Query SDK generates a ClientToken on your behalf.
• After 8 hours, any request with the same ClientToken is treated as a new request.

See Also:

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

getKmsKeyId

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

The Amazon KMS key used to encrypt the scheduled query resource, at-rest.

If the Amazon KMS key is not specified, the scheduled query resource will be encrypted with a Timestream owned Amazon KMS key. To specify a KMS key, use the key ID, key ARN, alias name, or alias ARN. When using an alias name, prefix the name with alias/

If ErrorReportConfiguration uses SSE_KMS as encryption type, the same KmsKeyId is used to encrypt the error report at rest.

See Also:

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

getScheduledQueryName

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

A name for the query.

Scheduled query names must be unique within each Region.

See Also:

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

getTags

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

A list of key-value pairs to label the scheduled query.

See Also:

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

getTargetConfiguration

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

Scheduled query target store configuration.

See Also:

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

builder

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

Returns:

a CfnScheduledQueryProps.Builder of CfnScheduledQueryProps