This is the new *CloudFormation Template Reference Guide*. Please update your bookmarks and links. For help getting started with CloudFormation, see the [AWS CloudFormation User Guide](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/Welcome.html).

# AWS::Timestream::ScheduledQuery
<a name="aws-resource-timestream-scheduledquery"></a>

 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.

## Syntax
<a name="aws-resource-timestream-scheduledquery-syntax"></a>

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

### JSON
<a name="aws-resource-timestream-scheduledquery-syntax.json"></a>

```
{
  "Type" : "AWS::Timestream::ScheduledQuery",
  "Properties" : {
      "[ClientToken](#cfn-timestream-scheduledquery-clienttoken)" : String,
      "[ErrorReportConfiguration](#cfn-timestream-scheduledquery-errorreportconfiguration)" : ErrorReportConfiguration,
      "[KmsKeyId](#cfn-timestream-scheduledquery-kmskeyid)" : String,
      "[NotificationConfiguration](#cfn-timestream-scheduledquery-notificationconfiguration)" : NotificationConfiguration,
      "[QueryString](#cfn-timestream-scheduledquery-querystring)" : String,
      "[ScheduleConfiguration](#cfn-timestream-scheduledquery-scheduleconfiguration)" : ScheduleConfiguration,
      "[ScheduledQueryExecutionRoleArn](#cfn-timestream-scheduledquery-scheduledqueryexecutionrolearn)" : String,
      "[ScheduledQueryName](#cfn-timestream-scheduledquery-scheduledqueryname)" : String,
      "[Tags](#cfn-timestream-scheduledquery-tags)" : [ Tag, ... ],
      "[TargetConfiguration](#cfn-timestream-scheduledquery-targetconfiguration)" : TargetConfiguration
    }
}
```

### YAML
<a name="aws-resource-timestream-scheduledquery-syntax.yaml"></a>

```
Type: AWS::Timestream::ScheduledQuery
Properties:
  [ClientToken](#cfn-timestream-scheduledquery-clienttoken): String
  [ErrorReportConfiguration](#cfn-timestream-scheduledquery-errorreportconfiguration): 
    ErrorReportConfiguration
  [KmsKeyId](#cfn-timestream-scheduledquery-kmskeyid): String
  [NotificationConfiguration](#cfn-timestream-scheduledquery-notificationconfiguration): 
    NotificationConfiguration
  [QueryString](#cfn-timestream-scheduledquery-querystring): 
    String
  [ScheduleConfiguration](#cfn-timestream-scheduledquery-scheduleconfiguration): 
    ScheduleConfiguration
  [ScheduledQueryExecutionRoleArn](#cfn-timestream-scheduledquery-scheduledqueryexecutionrolearn): String
  [ScheduledQueryName](#cfn-timestream-scheduledquery-scheduledqueryname): String
  [Tags](#cfn-timestream-scheduledquery-tags): 
    - Tag
  [TargetConfiguration](#cfn-timestream-scheduledquery-targetconfiguration): 
    TargetConfiguration
```

## Properties
<a name="aws-resource-timestream-scheduledquery-properties"></a>

`ClientToken`  <a name="cfn-timestream-scheduledquery-clienttoken"></a>
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  
*Minimum*: `32`  
*Maximum*: `128`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`ErrorReportConfiguration`  <a name="cfn-timestream-scheduledquery-errorreportconfiguration"></a>
Configuration for error reporting. Error reports will be generated when a problem is encountered when writing the query results.   
*Required*: Yes  
*Type*: [ErrorReportConfiguration](aws-properties-timestream-scheduledquery-errorreportconfiguration.md)  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

`KmsKeyId`  <a name="cfn-timestream-scheduledquery-kmskeyid"></a>
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  
*Minimum*: `1`  
*Maximum*: `2048`  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

`NotificationConfiguration`  <a name="cfn-timestream-scheduledquery-notificationconfiguration"></a>
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](aws-properties-timestream-scheduledquery-notificationconfiguration.md)  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

`QueryString`  <a name="cfn-timestream-scheduledquery-querystring"></a>
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  
*Minimum*: `1`  
*Maximum*: `262144`  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

`ScheduleConfiguration`  <a name="cfn-timestream-scheduledquery-scheduleconfiguration"></a>
Schedule configuration.  
*Required*: Yes  
*Type*: [ScheduleConfiguration](aws-properties-timestream-scheduledquery-scheduleconfiguration.md)  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

`ScheduledQueryExecutionRoleArn`  <a name="cfn-timestream-scheduledquery-scheduledqueryexecutionrolearn"></a>
The ARN for the IAM role that Timestream will assume when running the scheduled query.   
*Required*: Yes  
*Type*: String  
*Minimum*: `1`  
*Maximum*: `2048`  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

`ScheduledQueryName`  <a name="cfn-timestream-scheduledquery-scheduledqueryname"></a>
A name for the query. Scheduled query names must be unique within each Region.  
*Required*: No  
*Type*: String  
*Pattern*: `[a-zA-Z0-9_.-]+`  
*Minimum*: `1`  
*Maximum*: `64`  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

`Tags`  <a name="cfn-timestream-scheduledquery-tags"></a>
A list of key-value pairs to label the scheduled query.  
*Required*: No  
*Type*: Array of [Tag](aws-properties-timestream-scheduledquery-tag.md)  
*Maximum*: `200`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`TargetConfiguration`  <a name="cfn-timestream-scheduledquery-targetconfiguration"></a>
Scheduled query target store configuration.  
*Required*: No  
*Type*: [TargetConfiguration](aws-properties-timestream-scheduledquery-targetconfiguration.md)  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

## Return values
<a name="aws-resource-timestream-scheduledquery-return-values"></a>

### Ref
<a name="aws-resource-timestream-scheduledquery-return-values-ref"></a>

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 [https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).

### Fn::GetAtt
<a name="aws-resource-timestream-scheduledquery-return-values-fn--getatt"></a>

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

#### 
<a name="aws-resource-timestream-scheduledquery-return-values-fn--getatt-fn--getatt"></a>

`Arn`  <a name="Arn-fn::getatt"></a>
The `ARN` of the scheduled query.

`SQErrorReportConfiguration`  <a name="SQErrorReportConfiguration-fn::getatt"></a>
The scheduled query error reporting configuration.

`SQKmsKeyId`  <a name="SQKmsKeyId-fn::getatt"></a>
The KMS key used to encrypt the query resource, if a customer managed KMS key was provided.

`SQName`  <a name="SQName-fn::getatt"></a>
The scheduled query name.

`SQNotificationConfiguration`  <a name="SQNotificationConfiguration-fn::getatt"></a>
The scheduled query notification configuration.

`SQQueryString`  <a name="SQQueryString-fn::getatt"></a>
The scheduled query string..

`SQScheduleConfiguration`  <a name="SQScheduleConfiguration-fn::getatt"></a>
The scheduled query schedule configuration.

`SQScheduledQueryExecutionRoleArn`  <a name="SQScheduledQueryExecutionRoleArn-fn::getatt"></a>
The ARN of the IAM role that will be used by Timestream to run the query.

`SQTargetConfiguration`  <a name="SQTargetConfiguration-fn::getatt"></a>
The configuration for query output.

# AWS::Timestream::ScheduledQuery DimensionMapping
<a name="aws-properties-timestream-scheduledquery-dimensionmapping"></a>

This type is used to map column(s) from the query result to a dimension in the destination table.

## Syntax
<a name="aws-properties-timestream-scheduledquery-dimensionmapping-syntax"></a>

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

### JSON
<a name="aws-properties-timestream-scheduledquery-dimensionmapping-syntax.json"></a>

```
{
  "[DimensionValueType](#cfn-timestream-scheduledquery-dimensionmapping-dimensionvaluetype)" : String,
  "[Name](#cfn-timestream-scheduledquery-dimensionmapping-name)" : String
}
```

### YAML
<a name="aws-properties-timestream-scheduledquery-dimensionmapping-syntax.yaml"></a>

```
  [DimensionValueType](#cfn-timestream-scheduledquery-dimensionmapping-dimensionvaluetype): String
  [Name](#cfn-timestream-scheduledquery-dimensionmapping-name): String
```

## Properties
<a name="aws-properties-timestream-scheduledquery-dimensionmapping-properties"></a>

`DimensionValueType`  <a name="cfn-timestream-scheduledquery-dimensionmapping-dimensionvaluetype"></a>
Type for the dimension: VARCHAR  
*Required*: Yes  
*Type*: String  
*Allowed values*: `VARCHAR`  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

`Name`  <a name="cfn-timestream-scheduledquery-dimensionmapping-name"></a>
Column name from query result.  
*Required*: Yes  
*Type*: String  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

# AWS::Timestream::ScheduledQuery ErrorReportConfiguration
<a name="aws-properties-timestream-scheduledquery-errorreportconfiguration"></a>

Configuration required for error reporting.

## Syntax
<a name="aws-properties-timestream-scheduledquery-errorreportconfiguration-syntax"></a>

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

### JSON
<a name="aws-properties-timestream-scheduledquery-errorreportconfiguration-syntax.json"></a>

```
{
  "[S3Configuration](#cfn-timestream-scheduledquery-errorreportconfiguration-s3configuration)" : S3Configuration
}
```

### YAML
<a name="aws-properties-timestream-scheduledquery-errorreportconfiguration-syntax.yaml"></a>

```
  [S3Configuration](#cfn-timestream-scheduledquery-errorreportconfiguration-s3configuration): 
    S3Configuration
```

## Properties
<a name="aws-properties-timestream-scheduledquery-errorreportconfiguration-properties"></a>

`S3Configuration`  <a name="cfn-timestream-scheduledquery-errorreportconfiguration-s3configuration"></a>
The S3 configuration for the error reports.  
*Required*: Yes  
*Type*: [S3Configuration](aws-properties-timestream-scheduledquery-s3configuration.md)  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

# AWS::Timestream::ScheduledQuery MixedMeasureMapping
<a name="aws-properties-timestream-scheduledquery-mixedmeasuremapping"></a>

MixedMeasureMappings are mappings that can be used to ingest data into a mixture of narrow and multi measures in the derived table.

## Syntax
<a name="aws-properties-timestream-scheduledquery-mixedmeasuremapping-syntax"></a>

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

### JSON
<a name="aws-properties-timestream-scheduledquery-mixedmeasuremapping-syntax.json"></a>

```
{
  "[MeasureName](#cfn-timestream-scheduledquery-mixedmeasuremapping-measurename)" : String,
  "[MeasureValueType](#cfn-timestream-scheduledquery-mixedmeasuremapping-measurevaluetype)" : String,
  "[MultiMeasureAttributeMappings](#cfn-timestream-scheduledquery-mixedmeasuremapping-multimeasureattributemappings)" : [ MultiMeasureAttributeMapping, ... ],
  "[SourceColumn](#cfn-timestream-scheduledquery-mixedmeasuremapping-sourcecolumn)" : String,
  "[TargetMeasureName](#cfn-timestream-scheduledquery-mixedmeasuremapping-targetmeasurename)" : String
}
```

### YAML
<a name="aws-properties-timestream-scheduledquery-mixedmeasuremapping-syntax.yaml"></a>

```
  [MeasureName](#cfn-timestream-scheduledquery-mixedmeasuremapping-measurename): String
  [MeasureValueType](#cfn-timestream-scheduledquery-mixedmeasuremapping-measurevaluetype): String
  [MultiMeasureAttributeMappings](#cfn-timestream-scheduledquery-mixedmeasuremapping-multimeasureattributemappings): 
    - MultiMeasureAttributeMapping
  [SourceColumn](#cfn-timestream-scheduledquery-mixedmeasuremapping-sourcecolumn): String
  [TargetMeasureName](#cfn-timestream-scheduledquery-mixedmeasuremapping-targetmeasurename): String
```

## Properties
<a name="aws-properties-timestream-scheduledquery-mixedmeasuremapping-properties"></a>

`MeasureName`  <a name="cfn-timestream-scheduledquery-mixedmeasuremapping-measurename"></a>
Refers to the value of measure\$1name in a result row. This field is required if MeasureNameColumn is provided.  
*Required*: No  
*Type*: String  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

`MeasureValueType`  <a name="cfn-timestream-scheduledquery-mixedmeasuremapping-measurevaluetype"></a>
Type of the value that is to be read from sourceColumn. If the mapping is for MULTI, use MeasureValueType.MULTI.  
*Required*: Yes  
*Type*: String  
*Allowed values*: `BIGINT | BOOLEAN | DOUBLE | VARCHAR | MULTI`  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

`MultiMeasureAttributeMappings`  <a name="cfn-timestream-scheduledquery-mixedmeasuremapping-multimeasureattributemappings"></a>
Required when measureValueType is MULTI. Attribute mappings for MULTI value measures.  
*Required*: No  
*Type*: Array of [MultiMeasureAttributeMapping](aws-properties-timestream-scheduledquery-multimeasureattributemapping.md)  
*Minimum*: `1`  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

`SourceColumn`  <a name="cfn-timestream-scheduledquery-mixedmeasuremapping-sourcecolumn"></a>
This field refers to the source column from which measure-value is to be read for result materialization.  
*Required*: No  
*Type*: String  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

`TargetMeasureName`  <a name="cfn-timestream-scheduledquery-mixedmeasuremapping-targetmeasurename"></a>
Target measure name to be used. If not provided, the target measure name by default would be measure-name if provided, or sourceColumn otherwise.   
*Required*: No  
*Type*: String  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

# AWS::Timestream::ScheduledQuery MultiMeasureAttributeMapping
<a name="aws-properties-timestream-scheduledquery-multimeasureattributemapping"></a>

Attribute mapping for MULTI value measures.

## Syntax
<a name="aws-properties-timestream-scheduledquery-multimeasureattributemapping-syntax"></a>

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

### JSON
<a name="aws-properties-timestream-scheduledquery-multimeasureattributemapping-syntax.json"></a>

```
{
  "[MeasureValueType](#cfn-timestream-scheduledquery-multimeasureattributemapping-measurevaluetype)" : String,
  "[SourceColumn](#cfn-timestream-scheduledquery-multimeasureattributemapping-sourcecolumn)" : String,
  "[TargetMultiMeasureAttributeName](#cfn-timestream-scheduledquery-multimeasureattributemapping-targetmultimeasureattributename)" : String
}
```

### YAML
<a name="aws-properties-timestream-scheduledquery-multimeasureattributemapping-syntax.yaml"></a>

```
  [MeasureValueType](#cfn-timestream-scheduledquery-multimeasureattributemapping-measurevaluetype): String
  [SourceColumn](#cfn-timestream-scheduledquery-multimeasureattributemapping-sourcecolumn): String
  [TargetMultiMeasureAttributeName](#cfn-timestream-scheduledquery-multimeasureattributemapping-targetmultimeasureattributename): String
```

## Properties
<a name="aws-properties-timestream-scheduledquery-multimeasureattributemapping-properties"></a>

`MeasureValueType`  <a name="cfn-timestream-scheduledquery-multimeasureattributemapping-measurevaluetype"></a>
Type of the attribute to be read from the source column.  
*Required*: Yes  
*Type*: String  
*Allowed values*: `BIGINT | BOOLEAN | DOUBLE | VARCHAR | TIMESTAMP`  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

`SourceColumn`  <a name="cfn-timestream-scheduledquery-multimeasureattributemapping-sourcecolumn"></a>
Source column from where the attribute value is to be read.  
*Required*: Yes  
*Type*: String  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

`TargetMultiMeasureAttributeName`  <a name="cfn-timestream-scheduledquery-multimeasureattributemapping-targetmultimeasureattributename"></a>
Custom name to be used for attribute name in derived table. If not provided, source column name would be used.  
*Required*: No  
*Type*: String  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

# AWS::Timestream::ScheduledQuery MultiMeasureMappings
<a name="aws-properties-timestream-scheduledquery-multimeasuremappings"></a>

Only one of MixedMeasureMappings or MultiMeasureMappings is to be provided. MultiMeasureMappings can be used to ingest data as multi measures in the derived table.

## Syntax
<a name="aws-properties-timestream-scheduledquery-multimeasuremappings-syntax"></a>

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

### JSON
<a name="aws-properties-timestream-scheduledquery-multimeasuremappings-syntax.json"></a>

```
{
  "[MultiMeasureAttributeMappings](#cfn-timestream-scheduledquery-multimeasuremappings-multimeasureattributemappings)" : [ MultiMeasureAttributeMapping, ... ],
  "[TargetMultiMeasureName](#cfn-timestream-scheduledquery-multimeasuremappings-targetmultimeasurename)" : String
}
```

### YAML
<a name="aws-properties-timestream-scheduledquery-multimeasuremappings-syntax.yaml"></a>

```
  [MultiMeasureAttributeMappings](#cfn-timestream-scheduledquery-multimeasuremappings-multimeasureattributemappings): 
    - MultiMeasureAttributeMapping
  [TargetMultiMeasureName](#cfn-timestream-scheduledquery-multimeasuremappings-targetmultimeasurename): String
```

## Properties
<a name="aws-properties-timestream-scheduledquery-multimeasuremappings-properties"></a>

`MultiMeasureAttributeMappings`  <a name="cfn-timestream-scheduledquery-multimeasuremappings-multimeasureattributemappings"></a>
Required. Attribute mappings to be used for mapping query results to ingest data for multi-measure attributes.  
*Required*: Yes  
*Type*: Array of [MultiMeasureAttributeMapping](aws-properties-timestream-scheduledquery-multimeasureattributemapping.md)  
*Minimum*: `1`  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

`TargetMultiMeasureName`  <a name="cfn-timestream-scheduledquery-multimeasuremappings-targetmultimeasurename"></a>
The name of the target multi-measure name in the derived table. This input is required when measureNameColumn is not provided. If MeasureNameColumn is provided, then value from that column will be used as multi-measure name.  
*Required*: No  
*Type*: String  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

# AWS::Timestream::ScheduledQuery NotificationConfiguration
<a name="aws-properties-timestream-scheduledquery-notificationconfiguration"></a>

Notification configuration for a scheduled query. A notification is sent by Timestream when a scheduled query is created, its state is updated or when it is deleted. 

## Syntax
<a name="aws-properties-timestream-scheduledquery-notificationconfiguration-syntax"></a>

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

### JSON
<a name="aws-properties-timestream-scheduledquery-notificationconfiguration-syntax.json"></a>

```
{
  "[SnsConfiguration](#cfn-timestream-scheduledquery-notificationconfiguration-snsconfiguration)" : SnsConfiguration
}
```

### YAML
<a name="aws-properties-timestream-scheduledquery-notificationconfiguration-syntax.yaml"></a>

```
  [SnsConfiguration](#cfn-timestream-scheduledquery-notificationconfiguration-snsconfiguration): 
    SnsConfiguration
```

## Properties
<a name="aws-properties-timestream-scheduledquery-notificationconfiguration-properties"></a>

`SnsConfiguration`  <a name="cfn-timestream-scheduledquery-notificationconfiguration-snsconfiguration"></a>
Details on SNS configuration.   
*Required*: Yes  
*Type*: [SnsConfiguration](aws-properties-timestream-scheduledquery-snsconfiguration.md)  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

# AWS::Timestream::ScheduledQuery S3Configuration
<a name="aws-properties-timestream-scheduledquery-s3configuration"></a>

Details on S3 location for error reports that result from running a query. 

## Syntax
<a name="aws-properties-timestream-scheduledquery-s3configuration-syntax"></a>

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

### JSON
<a name="aws-properties-timestream-scheduledquery-s3configuration-syntax.json"></a>

```
{
  "[BucketName](#cfn-timestream-scheduledquery-s3configuration-bucketname)" : String,
  "[EncryptionOption](#cfn-timestream-scheduledquery-s3configuration-encryptionoption)" : String,
  "[ObjectKeyPrefix](#cfn-timestream-scheduledquery-s3configuration-objectkeyprefix)" : String
}
```

### YAML
<a name="aws-properties-timestream-scheduledquery-s3configuration-syntax.yaml"></a>

```
  [BucketName](#cfn-timestream-scheduledquery-s3configuration-bucketname): String
  [EncryptionOption](#cfn-timestream-scheduledquery-s3configuration-encryptionoption): String
  [ObjectKeyPrefix](#cfn-timestream-scheduledquery-s3configuration-objectkeyprefix): String
```

## Properties
<a name="aws-properties-timestream-scheduledquery-s3configuration-properties"></a>

`BucketName`  <a name="cfn-timestream-scheduledquery-s3configuration-bucketname"></a>
 Name of the S3 bucket under which error reports will be created.  
*Required*: Yes  
*Type*: String  
*Pattern*: `[a-z0-9][\.\-a-z0-9]{1,61}[a-z0-9]`  
*Minimum*: `3`  
*Maximum*: `63`  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

`EncryptionOption`  <a name="cfn-timestream-scheduledquery-s3configuration-encryptionoption"></a>
 Encryption at rest options for the error reports. If no encryption option is specified, Timestream will choose SSE\$1S3 as default.   
*Required*: No  
*Type*: String  
*Allowed values*: `SSE_S3 | SSE_KMS`  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

`ObjectKeyPrefix`  <a name="cfn-timestream-scheduledquery-s3configuration-objectkeyprefix"></a>
 Prefix for the error report key. Timestream by default adds the following prefix to the error report path.   
*Required*: No  
*Type*: String  
*Pattern*: `[a-zA-Z0-9|!\-_*'\(\)]([a-zA-Z0-9]|[!\-_*'\(\)\/.])+`  
*Minimum*: `1`  
*Maximum*: `896`  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

# AWS::Timestream::ScheduledQuery ScheduleConfiguration
<a name="aws-properties-timestream-scheduledquery-scheduleconfiguration"></a>

Configuration of the schedule of the query.

## Syntax
<a name="aws-properties-timestream-scheduledquery-scheduleconfiguration-syntax"></a>

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

### JSON
<a name="aws-properties-timestream-scheduledquery-scheduleconfiguration-syntax.json"></a>

```
{
  "[ScheduleExpression](#cfn-timestream-scheduledquery-scheduleconfiguration-scheduleexpression)" : String
}
```

### YAML
<a name="aws-properties-timestream-scheduledquery-scheduleconfiguration-syntax.yaml"></a>

```
  [ScheduleExpression](#cfn-timestream-scheduledquery-scheduleconfiguration-scheduleexpression): String
```

## Properties
<a name="aws-properties-timestream-scheduledquery-scheduleconfiguration-properties"></a>

`ScheduleExpression`  <a name="cfn-timestream-scheduledquery-scheduleconfiguration-scheduleexpression"></a>
An expression that denotes when to trigger the scheduled query run. This can be a cron expression or a rate expression.   
*Required*: Yes  
*Type*: String  
*Minimum*: `1`  
*Maximum*: `256`  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

# AWS::Timestream::ScheduledQuery SnsConfiguration
<a name="aws-properties-timestream-scheduledquery-snsconfiguration"></a>

Details on SNS that are required to send the notification.

## Syntax
<a name="aws-properties-timestream-scheduledquery-snsconfiguration-syntax"></a>

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

### JSON
<a name="aws-properties-timestream-scheduledquery-snsconfiguration-syntax.json"></a>

```
{
  "[TopicArn](#cfn-timestream-scheduledquery-snsconfiguration-topicarn)" : String
}
```

### YAML
<a name="aws-properties-timestream-scheduledquery-snsconfiguration-syntax.yaml"></a>

```
  [TopicArn](#cfn-timestream-scheduledquery-snsconfiguration-topicarn): String
```

## Properties
<a name="aws-properties-timestream-scheduledquery-snsconfiguration-properties"></a>

`TopicArn`  <a name="cfn-timestream-scheduledquery-snsconfiguration-topicarn"></a>
SNS topic ARN that the scheduled query status notifications will be sent to.  
*Required*: Yes  
*Type*: String  
*Minimum*: `1`  
*Maximum*: `2048`  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

# AWS::Timestream::ScheduledQuery Tag
<a name="aws-properties-timestream-scheduledquery-tag"></a>

 A tag is a label that you assign to a Timestream database and/or table. Each tag consists of a key and an optional value, both of which you define. With tags, you can categorize databases and/or tables, for example, by purpose, owner, or environment. 

## Syntax
<a name="aws-properties-timestream-scheduledquery-tag-syntax"></a>

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

### JSON
<a name="aws-properties-timestream-scheduledquery-tag-syntax.json"></a>

```
{
  "[Key](#cfn-timestream-scheduledquery-tag-key)" : String,
  "[Value](#cfn-timestream-scheduledquery-tag-value)" : String
}
```

### YAML
<a name="aws-properties-timestream-scheduledquery-tag-syntax.yaml"></a>

```
  [Key](#cfn-timestream-scheduledquery-tag-key): String
  [Value](#cfn-timestream-scheduledquery-tag-value): String
```

## Properties
<a name="aws-properties-timestream-scheduledquery-tag-properties"></a>

`Key`  <a name="cfn-timestream-scheduledquery-tag-key"></a>
 The key of the tag. Tag keys are case sensitive.   
*Required*: Yes  
*Type*: String  
*Minimum*: `1`  
*Maximum*: `128`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`Value`  <a name="cfn-timestream-scheduledquery-tag-value"></a>
 The value of the tag. Tag values are case-sensitive and can be null.   
*Required*: Yes  
*Type*: String  
*Minimum*: `0`  
*Maximum*: `256`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

# AWS::Timestream::ScheduledQuery TargetConfiguration
<a name="aws-properties-timestream-scheduledquery-targetconfiguration"></a>

Configuration used for writing the output of a query.

## Syntax
<a name="aws-properties-timestream-scheduledquery-targetconfiguration-syntax"></a>

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

### JSON
<a name="aws-properties-timestream-scheduledquery-targetconfiguration-syntax.json"></a>

```
{
  "[TimestreamConfiguration](#cfn-timestream-scheduledquery-targetconfiguration-timestreamconfiguration)" : TimestreamConfiguration
}
```

### YAML
<a name="aws-properties-timestream-scheduledquery-targetconfiguration-syntax.yaml"></a>

```
  [TimestreamConfiguration](#cfn-timestream-scheduledquery-targetconfiguration-timestreamconfiguration): 
    TimestreamConfiguration
```

## Properties
<a name="aws-properties-timestream-scheduledquery-targetconfiguration-properties"></a>

`TimestreamConfiguration`  <a name="cfn-timestream-scheduledquery-targetconfiguration-timestreamconfiguration"></a>
Configuration needed to write data into the Timestream database and table.  
*Required*: Yes  
*Type*: [TimestreamConfiguration](aws-properties-timestream-scheduledquery-timestreamconfiguration.md)  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

# AWS::Timestream::ScheduledQuery TimestreamConfiguration
<a name="aws-properties-timestream-scheduledquery-timestreamconfiguration"></a>

 Configuration to write data into Timestream database and table. This configuration allows the user to map the query result select columns into the destination table columns. 

## Syntax
<a name="aws-properties-timestream-scheduledquery-timestreamconfiguration-syntax"></a>

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

### JSON
<a name="aws-properties-timestream-scheduledquery-timestreamconfiguration-syntax.json"></a>

```
{
  "[DatabaseName](#cfn-timestream-scheduledquery-timestreamconfiguration-databasename)" : String,
  "[DimensionMappings](#cfn-timestream-scheduledquery-timestreamconfiguration-dimensionmappings)" : [ DimensionMapping, ... ],
  "[MeasureNameColumn](#cfn-timestream-scheduledquery-timestreamconfiguration-measurenamecolumn)" : String,
  "[MixedMeasureMappings](#cfn-timestream-scheduledquery-timestreamconfiguration-mixedmeasuremappings)" : [ MixedMeasureMapping, ... ],
  "[MultiMeasureMappings](#cfn-timestream-scheduledquery-timestreamconfiguration-multimeasuremappings)" : MultiMeasureMappings,
  "[TableName](#cfn-timestream-scheduledquery-timestreamconfiguration-tablename)" : String,
  "[TimeColumn](#cfn-timestream-scheduledquery-timestreamconfiguration-timecolumn)" : String
}
```

### YAML
<a name="aws-properties-timestream-scheduledquery-timestreamconfiguration-syntax.yaml"></a>

```
  [DatabaseName](#cfn-timestream-scheduledquery-timestreamconfiguration-databasename): String
  [DimensionMappings](#cfn-timestream-scheduledquery-timestreamconfiguration-dimensionmappings): 
    - DimensionMapping
  [MeasureNameColumn](#cfn-timestream-scheduledquery-timestreamconfiguration-measurenamecolumn): String
  [MixedMeasureMappings](#cfn-timestream-scheduledquery-timestreamconfiguration-mixedmeasuremappings): 
    - MixedMeasureMapping
  [MultiMeasureMappings](#cfn-timestream-scheduledquery-timestreamconfiguration-multimeasuremappings): 
    MultiMeasureMappings
  [TableName](#cfn-timestream-scheduledquery-timestreamconfiguration-tablename): String
  [TimeColumn](#cfn-timestream-scheduledquery-timestreamconfiguration-timecolumn): String
```

## Properties
<a name="aws-properties-timestream-scheduledquery-timestreamconfiguration-properties"></a>

`DatabaseName`  <a name="cfn-timestream-scheduledquery-timestreamconfiguration-databasename"></a>
Name of Timestream database to which the query result will be written.  
*Required*: Yes  
*Type*: String  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

`DimensionMappings`  <a name="cfn-timestream-scheduledquery-timestreamconfiguration-dimensionmappings"></a>
 This is to allow mapping column(s) from the query result to the dimension in the destination table.   
*Required*: Yes  
*Type*: Array of [DimensionMapping](aws-properties-timestream-scheduledquery-dimensionmapping.md)  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

`MeasureNameColumn`  <a name="cfn-timestream-scheduledquery-timestreamconfiguration-measurenamecolumn"></a>
Name of the measure column. Also see `MultiMeasureMappings` and `MixedMeasureMappings` for how measure name properties on those relate to `MeasureNameColumn`.  
*Required*: No  
*Type*: String  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

`MixedMeasureMappings`  <a name="cfn-timestream-scheduledquery-timestreamconfiguration-mixedmeasuremappings"></a>
Specifies how to map measures to multi-measure records.  
*Required*: No  
*Type*: Array of [MixedMeasureMapping](aws-properties-timestream-scheduledquery-mixedmeasuremapping.md)  
*Minimum*: `1`  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

`MultiMeasureMappings`  <a name="cfn-timestream-scheduledquery-timestreamconfiguration-multimeasuremappings"></a>
Multi-measure mappings.  
*Required*: No  
*Type*: [MultiMeasureMappings](aws-properties-timestream-scheduledquery-multimeasuremappings.md)  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

`TableName`  <a name="cfn-timestream-scheduledquery-timestreamconfiguration-tablename"></a>
Name of Timestream table that the query result will be written to. The table should be within the same database that is provided in Timestream configuration.  
*Required*: Yes  
*Type*: String  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

`TimeColumn`  <a name="cfn-timestream-scheduledquery-timestreamconfiguration-timecolumn"></a>
Column from query result that should be used as the time column in destination table. Column type for this should be TIMESTAMP.  
*Required*: Yes  
*Type*: String  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)