AWS::Timestream::ScheduledQueryCfnScheduledQuery
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.
Import
import { CfnScheduledQuery } from 'aws-cdk-lib/aws-timestream';Or use the module namespace:
import * as timestream from 'aws-cdk-lib/aws-timestream';
// timestream.CfnScheduledQueryProperties
Configuration passed to the constructor as CfnScheduledQueryProps.
errorReportConfigurationRequiredIResolvable | ErrorReportConfigurationPropertyConfiguration for error reporting. Error reports will be generated when a problem is encountered when writing the query results.
notificationConfigurationRequiredIResolvable | NotificationConfigurationPropertyNotification 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.
queryStringRequiredstringThe 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.
scheduleConfigurationRequiredIResolvable | ScheduleConfigurationPropertySchedule configuration.
scheduledQueryExecutionRoleArnRequiredstring | IRoleRefThe ARN for the IAM role that Timestream will assume when running the scheduled query.
clientTokenOptionalstringUsing 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.
kmsKeyIdOptionalstring | IKeyRefThe 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.
scheduledQueryNameOptionalstringA name for the query. Scheduled query names must be unique within each Region.
tagsOptionalCfnTag[]A list of key-value pairs to label the scheduled query.
targetConfigurationOptionalIResolvable | TargetConfigurationPropertyScheduled query target store configuration.
CloudFormation Resource
This L1 construct maps directly to the following CloudFormation resource type.
Learn AWS the Practical Way
Our bi-weekly newsletter teaches hands-on AWS fundamentals. No certification fluff - just practical knowledge.
Subscribe to NewsletterQuick Facts
aws-timestreamAWS::Timestream::ScheduledQuery