AWS::Timestream::ScheduledQuery

Timestream ScheduledQuery

The AWS::Timestream::ScheduledQuery resource creates a Timestream Scheduled Query.

Properties

10 configurable properties. 5 required. Click a row to see details.

Filter:

Property	Type	Flags
`ErrorReportConfiguration`	`ErrorReportConfiguration`	RequiredCreate-only
`NotificationConfiguration`	`NotificationConfiguration`	RequiredCreate-only
`QueryString`	`string`	RequiredCreate-only
`ScheduleConfiguration`	`ScheduleConfiguration`	RequiredCreate-only
`ScheduledQueryExecutionRoleArn`	`string`	RequiredCreate-only
`ClientToken`	`string`	Write-only
`KmsKeyId`	`string`	Create-only
`ScheduledQueryName`	`string`	Create-only
`Tags`	`array`
`TargetConfiguration`	`TargetConfiguration`	Create-only

Return Values

Values returned after the resource is created. Access these with Fn::GetAtt.

Attribute	Type	Description
`Arn`	`string`	-
`SQErrorReportConfiguration`	`string`	Configuration for error reporting. Error reports will be generated when a problem is encountered when writing the query results.
`SQKmsKeyId`	`string`	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 nam...
`SQName`	`string`	The name of the scheduled query. Scheduled query names must be unique within each Region.
`SQNotificationConfiguration`	`string`	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.
`SQQueryString`	`string`	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 Sc...
`SQScheduleConfiguration`	`string`	Configuration for when the scheduled query is executed.
`SQScheduledQueryExecutionRoleArn`	`string`	The ARN for the IAM role that Timestream will assume when running the scheduled query.
`SQTargetConfiguration`	`string`	Configuration of target store where scheduled query results are written to.

Sample CloudFormation Template

A minimal template with required properties and common optional ones.

template.yaml

AWSTemplateFormatVersion: "2010-09-09"
Description: Sample template for AWS::Timestream::ScheduledQuery

Resources:
  MyResource:
    Type: AWS::Timestream::ScheduledQuery
    Properties:
      QueryString: "value"
      ScheduleConfiguration: "value"
      NotificationConfiguration: "value"
      ScheduledQueryExecutionRoleArn: "arn:aws:service:region:account:resource"
      ErrorReportConfiguration: "value"
      Tags:
        - Key: Environment
          Value: Production

Required IAM Permissions

Permissions CloudFormation needs in your IAM role to manage this resource.

create

timestream:CreateScheduledQuerytimestream:DescribeEndpointstimestream:TagResourceiam:PassRolekms:DescribeKeykms:GenerateDataKey

read

timestream:DescribeScheduledQuerytimestream:ListTagsForResourcetimestream:DescribeEndpointskms:GenerateDataKeykms:Decrypt

update

timestream:UpdateScheduledQuerytimestream:TagResourcetimestream:UntagResourcetimestream:DescribeEndpoints

delete

timestream:DeleteScheduledQuerytimestream:DescribeScheduledQuerytimestream:DescribeEndpoints

list

timestream:ListScheduledQueriestimestream:DescribeEndpoints

Learn AWS the Practical Way

Our bi-weekly newsletter teaches hands-on AWS fundamentals. No certification fluff - just practical knowledge.

Subscribe to Newsletter

Quick Facts

ServiceTimestream

Properties19

Required5

TaggingSupported

Primary IDArn

Supported Operations

CreateReadUpdateDeleteList

Immutable After Creation

These properties cannot be changed after the resource is created. Updating them triggers a replacement.

ScheduledQueryNameQueryStringScheduleConfigurationNotificationConfigurationScheduledQueryExecutionRoleArnTargetConfigurationErrorReportConfigurationKmsKeyId

Related Resources

External Links

AWS Documentation