AWS::Timestream::ScheduledQuery - Amazon CloudFormation
Services or capabilities described in Amazon Web Services documentation might vary by Region. To see the differences applicable to the China Regions, see Getting Started with Amazon Web Services in China (PDF).


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.


To declare this entity in your Amazon CloudFormation template, use the following syntax:


{ "Type" : "AWS::Timestream::ScheduledQuery", "Properties" : { "ClientToken" : String, "ErrorReportConfiguration" : ErrorReportConfiguration, "KmsKeyId" : String, "NotificationConfiguration" : NotificationConfiguration, "QueryString" : String, "ScheduleConfiguration" : ScheduleConfiguration, "ScheduledQueryExecutionRoleArn" : String, "ScheduledQueryName" : String, "Tags" : [ Tag, ... ], "TargetConfiguration" : TargetConfiguration } }



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.

Required: No

Type: String

Update requires: Replacement


Configuration for error reporting. Error reports will be generated when a problem is encountered when writing the query results.

Required: Yes

Type: ErrorReportConfiguration

Update requires: Replacement


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.

Required: No

Type: String

Update requires: Replacement


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.

Required: Yes

Type: NotificationConfiguration

Update requires: Replacement


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.

Required: Yes

Type: String

Update requires: Replacement


Schedule configuration.

Required: Yes

Type: ScheduleConfiguration

Update requires: Replacement


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

Required: Yes

Type: String

Update requires: Replacement


A name for the query. Scheduled query names must be unique within each Region.

Required: No

Type: String

Update requires: Replacement


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

Required: No

Type: List of Tag

Update requires: No interruption


Scheduled query target store configuration.

Required: No

Type: TargetConfiguration

Update requires: Replacement

Return values


When you pass the logical ID of this resource to the intrinsic Ref function, Ref returns the scheduled query ARN.

For more information about using the Ref function, see Ref.


The Fn::GetAtt returns a value for the specified attribute of this type. The following are the available attributes:


The ARN of the scheduled query.


The scheduled query error reporting configuration.


The KMS key used to encrypt the query resource, if a customer managed KMS key was provided.


The scheduled query name.


The scheduled query notification configuration.


The scheduled query string..


The scheduled query schedule configuration.


The ARN of the IAM role that will be used by Timestream to run the query.


The configuration for query output.