# AWS IoT Analytics Construct Library

This module is part of the [AWS Cloud Development Kit](https://github.com/aws/aws-cdk) project.

```ts
import * as iotanalytics from 'aws-cdk-lib/aws-iotanalytics';
```

There are no official hand-written ([L2](https://docs.aws.amazon.com/cdk/latest/guide/constructs.html#constructs_lib)) constructs for this service yet. Here are some suggestions on how to proceed:

- Search [Construct Hub for IoTAnalytics construct libraries](https://constructs.dev/search?q=iotanalytics)
- Use the automatically generated [L1](https://docs.aws.amazon.com/cdk/latest/guide/constructs.html#constructs_l1_using) constructs, in the same way you would use [the CloudFormation AWS::IoTAnalytics resources](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/AWS_IoTAnalytics.html) directly.

There are no hand-written ([L2](https://docs.aws.amazon.com/cdk/latest/guide/constructs.html#constructs_lib)) constructs for this service yet.
However, you can still use the automatically generated [L1](https://docs.aws.amazon.com/cdk/latest/guide/constructs.html#constructs_l1_using) constructs, and use this service exactly as you would using CloudFormation directly.

For more information on the resources and properties available for this service, see the [CloudFormation documentation for AWS::IoTAnalytics](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/AWS_IoTAnalytics.html).

(Read the [CDK Contributing Guide](https://github.com/aws/aws-cdk/blob/main/CONTRIBUTING.md) and submit an RFC if you are interested in contributing to this construct library.)

## Types

| Name | Kind | Summary |
| --- | --- | --- |
| [`CfnChannel`](/v2/docs/aws-cdk-lib.aws_iotanalytics.CfnChannel) | Construct (L1) | The AWS::IoTAnalytics::Channel resource collects data from an MQTT topic and archives the raw, unprocessed messages before publishing the data to a pipeline. |
| [`CfnDataset`](/v2/docs/aws-cdk-lib.aws_iotanalytics.CfnDataset) | Construct (L1) | The AWS::IoTAnalytics::Dataset resource stores data retrieved from a data store by applying a `queryAction` (an SQL query) or a `containerAction` (executing a containerized application). |
| [`CfnDatastore`](/v2/docs/aws-cdk-lib.aws_iotanalytics.CfnDatastore) | Construct (L1) | AWS::IoTAnalytics::Datastore resource is a repository for messages. |
| [`CfnPipeline`](/v2/docs/aws-cdk-lib.aws_iotanalytics.CfnPipeline) | Construct (L1) | The AWS::IoTAnalytics::Pipeline resource consumes messages from one or more channels and allows you to process the messages before storing them in a data store. |
| [`CfnChannel.ChannelStorageProperty`](/v2/docs/aws-cdk-lib.aws_iotanalytics.CfnChannel.ChannelStorageProperty) | Struct | Where channel data is stored. |
| [`CfnChannel.CustomerManagedS3Property`](/v2/docs/aws-cdk-lib.aws_iotanalytics.CfnChannel.CustomerManagedS3Property) | Struct | Used to store channel data in an S3 bucket that you manage. |
| [`CfnChannel.RetentionPeriodProperty`](/v2/docs/aws-cdk-lib.aws_iotanalytics.CfnChannel.RetentionPeriodProperty) | Struct | How long, in days, message data is kept. |
| [`CfnChannelProps`](/v2/docs/aws-cdk-lib.aws_iotanalytics.CfnChannelProps) | Struct | Properties for defining a `CfnChannel`. |
| [`CfnDataset.ActionProperty`](/v2/docs/aws-cdk-lib.aws_iotanalytics.CfnDataset.ActionProperty) | Struct | Information needed to run the "containerAction" to produce data set contents. |
| [`CfnDataset.ContainerActionProperty`](/v2/docs/aws-cdk-lib.aws_iotanalytics.CfnDataset.ContainerActionProperty) | Struct | Information needed to run the "containerAction" to produce data set contents. |
| [`CfnDataset.DatasetContentDeliveryRuleDestinationProperty`](/v2/docs/aws-cdk-lib.aws_iotanalytics.CfnDataset.DatasetContentDeliveryRuleDestinationProperty) | Struct | The destination to which dataset contents are delivered. |
| [`CfnDataset.DatasetContentDeliveryRuleProperty`](/v2/docs/aws-cdk-lib.aws_iotanalytics.CfnDataset.DatasetContentDeliveryRuleProperty) | Struct | When dataset contents are created, they are delivered to destination specified here. |
| [`CfnDataset.DatasetContentVersionValueProperty`](/v2/docs/aws-cdk-lib.aws_iotanalytics.CfnDataset.DatasetContentVersionValueProperty) | Struct | The dataset whose latest contents are used as input to the notebook or application. |
| [`CfnDataset.DeltaTimeProperty`](/v2/docs/aws-cdk-lib.aws_iotanalytics.CfnDataset.DeltaTimeProperty) | Struct | Used to limit data to that which has arrived since the last execution of the action. |
| [`CfnDataset.DeltaTimeSessionWindowConfigurationProperty`](/v2/docs/aws-cdk-lib.aws_iotanalytics.CfnDataset.DeltaTimeSessionWindowConfigurationProperty) | Struct | A structure that contains the configuration information of a delta time session window. |
| [`CfnDataset.FilterProperty`](/v2/docs/aws-cdk-lib.aws_iotanalytics.CfnDataset.FilterProperty) | Struct | Information which is used to filter message data, to segregate it according to the time frame in which it arrives. |
| [`CfnDataset.GlueConfigurationProperty`](/v2/docs/aws-cdk-lib.aws_iotanalytics.CfnDataset.GlueConfigurationProperty) | Struct | Configuration information for coordination with AWS Glue , a fully managed extract, transform and load (ETL) service. |
| [`CfnDataset.IotEventsDestinationConfigurationProperty`](/v2/docs/aws-cdk-lib.aws_iotanalytics.CfnDataset.IotEventsDestinationConfigurationProperty) | Struct | Configuration information for delivery of dataset contents to AWS IoT Events . |
| [`CfnDataset.LateDataRuleConfigurationProperty`](/v2/docs/aws-cdk-lib.aws_iotanalytics.CfnDataset.LateDataRuleConfigurationProperty) | Struct | The information needed to configure a delta time session window. |
| [`CfnDataset.LateDataRuleProperty`](/v2/docs/aws-cdk-lib.aws_iotanalytics.CfnDataset.LateDataRuleProperty) | Struct | A structure that contains the name and configuration information of a late data rule. |
| [`CfnDataset.OutputFileUriValueProperty`](/v2/docs/aws-cdk-lib.aws_iotanalytics.CfnDataset.OutputFileUriValueProperty) | Struct | The value of the variable as a structure that specifies an output file URI. |
| [`CfnDataset.QueryActionProperty`](/v2/docs/aws-cdk-lib.aws_iotanalytics.CfnDataset.QueryActionProperty) | Struct | An "SqlQueryDatasetAction" object that uses an SQL query to automatically create data set contents. |
| [`CfnDataset.ResourceConfigurationProperty`](/v2/docs/aws-cdk-lib.aws_iotanalytics.CfnDataset.ResourceConfigurationProperty) | Struct | The configuration of the resource used to execute the `containerAction` . |
| [`CfnDataset.RetentionPeriodProperty`](/v2/docs/aws-cdk-lib.aws_iotanalytics.CfnDataset.RetentionPeriodProperty) | Struct | How long, in days, message data is kept. |
| [`CfnDataset.S3DestinationConfigurationProperty`](/v2/docs/aws-cdk-lib.aws_iotanalytics.CfnDataset.S3DestinationConfigurationProperty) | Struct | Configuration information for delivery of dataset contents to Amazon Simple Storage Service (Amazon S3). |
| [`CfnDataset.ScheduleProperty`](/v2/docs/aws-cdk-lib.aws_iotanalytics.CfnDataset.ScheduleProperty) | Struct | The schedule for when to trigger an update. |
| [`CfnDataset.TriggeringDatasetProperty`](/v2/docs/aws-cdk-lib.aws_iotanalytics.CfnDataset.TriggeringDatasetProperty) | Struct | Information about the dataset whose content generation triggers the new dataset content generation. |
| [`CfnDataset.TriggerProperty`](/v2/docs/aws-cdk-lib.aws_iotanalytics.CfnDataset.TriggerProperty) | Struct | The "DatasetTrigger" that specifies when the data set is automatically updated. |
| [`CfnDataset.VariableProperty`](/v2/docs/aws-cdk-lib.aws_iotanalytics.CfnDataset.VariableProperty) | Struct | An instance of a variable to be passed to the `containerAction` execution. |
| [`CfnDataset.VersioningConfigurationProperty`](/v2/docs/aws-cdk-lib.aws_iotanalytics.CfnDataset.VersioningConfigurationProperty) | Struct | Information about the versioning of dataset contents. |
| [`CfnDatasetProps`](/v2/docs/aws-cdk-lib.aws_iotanalytics.CfnDatasetProps) | Struct | Properties for defining a `CfnDataset`. |
| [`CfnDatastore.ColumnProperty`](/v2/docs/aws-cdk-lib.aws_iotanalytics.CfnDatastore.ColumnProperty) | Struct | Contains information about a column that stores your data. |
| [`CfnDatastore.CustomerManagedS3Property`](/v2/docs/aws-cdk-lib.aws_iotanalytics.CfnDatastore.CustomerManagedS3Property) | Struct | S3-customer-managed; |
| [`CfnDatastore.CustomerManagedS3StorageProperty`](/v2/docs/aws-cdk-lib.aws_iotanalytics.CfnDatastore.CustomerManagedS3StorageProperty) | Struct | Amazon S3 -customer-managed; |
| [`CfnDatastore.DatastorePartitionProperty`](/v2/docs/aws-cdk-lib.aws_iotanalytics.CfnDatastore.DatastorePartitionProperty) | Struct | A single dimension to partition a data store. |
| [`CfnDatastore.DatastorePartitionsProperty`](/v2/docs/aws-cdk-lib.aws_iotanalytics.CfnDatastore.DatastorePartitionsProperty) | Struct | Information about the partition dimensions in a data store. |
| [`CfnDatastore.DatastoreStorageProperty`](/v2/docs/aws-cdk-lib.aws_iotanalytics.CfnDatastore.DatastoreStorageProperty) | Struct | Where data store data is stored. |
| [`CfnDatastore.FileFormatConfigurationProperty`](/v2/docs/aws-cdk-lib.aws_iotanalytics.CfnDatastore.FileFormatConfigurationProperty) | Struct | Contains the configuration information of file formats. ITA data stores support JSON and [Parquet](https://docs.aws.amazon.com/https://parquet.apache.org/) . |
| [`CfnDatastore.IotSiteWiseMultiLayerStorageProperty`](/v2/docs/aws-cdk-lib.aws_iotanalytics.CfnDatastore.IotSiteWiseMultiLayerStorageProperty) | Struct | Stores data used by AWS IoT SiteWise in an Amazon S3 bucket that you manage. |
| [`CfnDatastore.ParquetConfigurationProperty`](/v2/docs/aws-cdk-lib.aws_iotanalytics.CfnDatastore.ParquetConfigurationProperty) | Struct | Contains the configuration information of the Parquet format. |
| [`CfnDatastore.PartitionProperty`](/v2/docs/aws-cdk-lib.aws_iotanalytics.CfnDatastore.PartitionProperty) | Struct | A single dimension to partition a data store. |
| [`CfnDatastore.RetentionPeriodProperty`](/v2/docs/aws-cdk-lib.aws_iotanalytics.CfnDatastore.RetentionPeriodProperty) | Struct | How long, in days, message data is kept. |
| [`CfnDatastore.SchemaDefinitionProperty`](/v2/docs/aws-cdk-lib.aws_iotanalytics.CfnDatastore.SchemaDefinitionProperty) | Struct | Information needed to define a schema. |
| [`CfnDatastore.TimestampPartitionProperty`](/v2/docs/aws-cdk-lib.aws_iotanalytics.CfnDatastore.TimestampPartitionProperty) | Struct | A partition dimension defined by a timestamp attribute. |
| [`CfnDatastoreProps`](/v2/docs/aws-cdk-lib.aws_iotanalytics.CfnDatastoreProps) | Struct | Properties for defining a `CfnDatastore`. |
| [`CfnPipeline.ActivityProperty`](/v2/docs/aws-cdk-lib.aws_iotanalytics.CfnPipeline.ActivityProperty) | Struct | An activity that performs a transformation on a message. |
| [`CfnPipeline.AddAttributesProperty`](/v2/docs/aws-cdk-lib.aws_iotanalytics.CfnPipeline.AddAttributesProperty) | Struct | An activity that adds other attributes based on existing attributes in the message. |
| [`CfnPipeline.ChannelProperty`](/v2/docs/aws-cdk-lib.aws_iotanalytics.CfnPipeline.ChannelProperty) | Struct | Determines the source of the messages to be processed. |
| [`CfnPipeline.DatastoreProperty`](/v2/docs/aws-cdk-lib.aws_iotanalytics.CfnPipeline.DatastoreProperty) | Struct | The datastore activity that specifies where to store the processed data. |
| [`CfnPipeline.DeviceRegistryEnrichProperty`](/v2/docs/aws-cdk-lib.aws_iotanalytics.CfnPipeline.DeviceRegistryEnrichProperty) | Struct | An activity that adds data from the AWS IoT device registry to your message. |
| [`CfnPipeline.DeviceShadowEnrichProperty`](/v2/docs/aws-cdk-lib.aws_iotanalytics.CfnPipeline.DeviceShadowEnrichProperty) | Struct | An activity that adds information from the AWS IoT Device Shadows service to a message. |
| [`CfnPipeline.FilterProperty`](/v2/docs/aws-cdk-lib.aws_iotanalytics.CfnPipeline.FilterProperty) | Struct | An activity that filters a message based on its attributes. |
| [`CfnPipeline.LambdaProperty`](/v2/docs/aws-cdk-lib.aws_iotanalytics.CfnPipeline.LambdaProperty) | Struct | An activity that runs a Lambda function to modify the message. |
| [`CfnPipeline.MathProperty`](/v2/docs/aws-cdk-lib.aws_iotanalytics.CfnPipeline.MathProperty) | Struct | An activity that computes an arithmetic expression using the message's attributes. |
| [`CfnPipeline.RemoveAttributesProperty`](/v2/docs/aws-cdk-lib.aws_iotanalytics.CfnPipeline.RemoveAttributesProperty) | Struct | An activity that removes attributes from a message. |
| [`CfnPipeline.SelectAttributesProperty`](/v2/docs/aws-cdk-lib.aws_iotanalytics.CfnPipeline.SelectAttributesProperty) | Struct | Creates a new message using only the specified attributes from the original message. |
| [`CfnPipelineProps`](/v2/docs/aws-cdk-lib.aws_iotanalytics.CfnPipelineProps) | Struct | Properties for defining a `CfnPipeline`. |