interface CfnScheduledQueryProps

Language	Type name
.NET	`Amazon.CDK.AWS.Timestream.CfnScheduledQueryProps`
Java	`software.amazon.awscdk.services.timestream.CfnScheduledQueryProps`
Python	`aws_cdk.aws_timestream.CfnScheduledQueryProps`
TypeScript	`@aws-cdk/aws-timestream` » `CfnScheduledQueryProps`

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 * as timestream from '@aws-cdk/aws-timestream';
const cfnScheduledQueryProps: timestream.CfnScheduledQueryProps = {
  errorReportConfiguration: {
    s3Configuration: {
      bucketName: 'bucketName',

      // the properties below are optional
      encryptionOption: 'encryptionOption',
      objectKeyPrefix: 'objectKeyPrefix',
    },
  },
  notificationConfiguration: {
    snsConfiguration: {
      topicArn: 'topicArn',
    },
  },
  queryString: 'queryString',
  scheduleConfiguration: {
    scheduleExpression: 'scheduleExpression',
  },
  scheduledQueryExecutionRoleArn: 'scheduledQueryExecutionRoleArn',

  // the properties below are optional
  clientToken: 'clientToken',
  kmsKeyId: 'kmsKeyId',
  scheduledQueryName: 'scheduledQueryName',
  tags: [{
    key: 'key',
    value: 'value',
  }],
  targetConfiguration: {
    timestreamConfiguration: {
      databaseName: 'databaseName',
      dimensionMappings: [{
        dimensionValueType: 'dimensionValueType',
        name: 'name',
      }],
      tableName: 'tableName',
      timeColumn: 'timeColumn',

      // the properties below are optional
      measureNameColumn: 'measureNameColumn',
      mixedMeasureMappings: [{
        measureValueType: 'measureValueType',

        // the properties below are optional
        measureName: 'measureName',
        multiMeasureAttributeMappings: [{
          measureValueType: 'measureValueType',
          sourceColumn: 'sourceColumn',

          // the properties below are optional
          targetMultiMeasureAttributeName: 'targetMultiMeasureAttributeName',
        }],
        sourceColumn: 'sourceColumn',
        targetMeasureName: 'targetMeasureName',
      }],
      multiMeasureMappings: {
        multiMeasureAttributeMappings: [{
          measureValueType: 'measureValueType',
          sourceColumn: 'sourceColumn',

          // the properties below are optional
          targetMultiMeasureAttributeName: 'targetMultiMeasureAttributeName',
        }],

        // the properties below are optional
        targetMultiMeasureName: 'targetMultiMeasureName',
      },
    },
  },
};

Properties

Name	Type	Description
errorReportConfiguration	`ErrorReportConfigurationProperty` `\|` `IResolvable`	Configuration for error reporting.
notificationConfiguration	`IResolvable` `\|` `NotificationConfigurationProperty`	Notification configuration for the scheduled query.
queryString	`string`	The query string to run.
scheduleConfiguration	`IResolvable` `\|` `ScheduleConfigurationProperty`	Schedule configuration.
scheduledQueryExecutionRoleArn	`string`	The ARN for the IAM role that Timestream will assume when running the scheduled query.
clientToken?	`string`	Using a ClientToken makes the call to CreateScheduledQuery idempotent, in other words, making the same request repeatedly will produce the same result.
kmsKeyId?	`string`	The Amazon KMS key used to encrypt the scheduled query resource, at-rest.
scheduledQueryName?	`string`	A name for the query.
tags?	`CfnTag[]`	A list of key-value pairs to label the scheduled query.
targetConfiguration?	`IResolvable` `\|` `TargetConfigurationProperty`	Scheduled query target store configuration.

errorReportConfiguration

Type: ErrorReportConfigurationProperty | IResolvable

Configuration for error reporting.

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

notificationConfiguration

Type: IResolvable | NotificationConfigurationProperty

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.

queryString

Type: 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 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.

scheduleConfiguration

Type: IResolvable | ScheduleConfigurationProperty

Schedule configuration.

scheduledQueryExecutionRoleArn

Type: string

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

clientToken?

Type: string (optional)

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.

kmsKeyId?

Type: string (optional)

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.

scheduledQueryName?

Type: string (optional)

A name for the query.

Scheduled query names must be unique within each Region.

tags?

Type: CfnTag[] (optional)

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

targetConfiguration?

Type: IResolvable | TargetConfigurationProperty (optional)

Scheduled query target store configuration.