Skip to content
v2.274.0

AWS IoT Analytics Construct Library ​

This module is part of the AWS Cloud Development Kit project.

ts
import * as iotanalytics from 'aws-cdk-lib/aws-iotanalytics';
python
import aws_cdk.aws_iotanalytics as iotanalytics
java
import software.amazon.awscdk.services.iotanalytics.*;
csharp
using Amazon.CDK.AWS.IoTAnalytics;
go
import iotanalytics "github.com/aws/aws-cdk-go/awscdk"

There are no official hand-written (L2) constructs for this service yet. Here are some suggestions on how to proceed:

There are no hand-written (L2) constructs for this service yet. However, you can still use the automatically generated L1 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.

(Read the CDK Contributing Guide and submit an RFC if you are interested in contributing to this construct library.)

Types ​

NameKindSummary
CfnChannelConstruct (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.
CfnDatasetConstruct (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).
CfnDatastoreConstruct (L1)AWS::IoTAnalytics::Datastore resource is a repository for messages.
CfnPipelineConstruct (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.ChannelStoragePropertyStructWhere channel data is stored.
CfnChannel.CustomerManagedS3PropertyStructUsed to store channel data in an S3 bucket that you manage.
CfnChannel.RetentionPeriodPropertyStructHow long, in days, message data is kept.
CfnChannelPropsStructProperties for defining a CfnChannel.
CfnDataset.ActionPropertyStructInformation needed to run the "containerAction" to produce data set contents.
CfnDataset.ContainerActionPropertyStructInformation needed to run the "containerAction" to produce data set contents.
CfnDataset.DatasetContentDeliveryRuleDestinationPropertyStructThe destination to which dataset contents are delivered.
CfnDataset.DatasetContentDeliveryRulePropertyStructWhen dataset contents are created, they are delivered to destination specified here.
CfnDataset.DatasetContentVersionValuePropertyStructThe dataset whose latest contents are used as input to the notebook or application.
CfnDataset.DeltaTimePropertyStructUsed to limit data to that which has arrived since the last execution of the action.
CfnDataset.DeltaTimeSessionWindowConfigurationPropertyStructA structure that contains the configuration information of a delta time session window.
CfnDataset.FilterPropertyStructInformation which is used to filter message data, to segregate it according to the time frame in which it arrives.
CfnDataset.GlueConfigurationPropertyStructConfiguration information for coordination with AWS Glue , a fully managed extract, transform and load (ETL) service.
CfnDataset.IotEventsDestinationConfigurationPropertyStructConfiguration information for delivery of dataset contents to AWS IoT Events .
CfnDataset.LateDataRuleConfigurationPropertyStructThe information needed to configure a delta time session window.
CfnDataset.LateDataRulePropertyStructA structure that contains the name and configuration information of a late data rule.
CfnDataset.OutputFileUriValuePropertyStructThe value of the variable as a structure that specifies an output file URI.
CfnDataset.QueryActionPropertyStructAn "SqlQueryDatasetAction" object that uses an SQL query to automatically create data set contents.
CfnDataset.ResourceConfigurationPropertyStructThe configuration of the resource used to execute the containerAction .
CfnDataset.RetentionPeriodPropertyStructHow long, in days, message data is kept.
CfnDataset.S3DestinationConfigurationPropertyStructConfiguration information for delivery of dataset contents to Amazon Simple Storage Service (Amazon S3).
CfnDataset.SchedulePropertyStructThe schedule for when to trigger an update.
CfnDataset.TriggeringDatasetPropertyStructInformation about the dataset whose content generation triggers the new dataset content generation.
CfnDataset.TriggerPropertyStructThe "DatasetTrigger" that specifies when the data set is automatically updated.
CfnDataset.VariablePropertyStructAn instance of a variable to be passed to the containerAction execution.
CfnDataset.VersioningConfigurationPropertyStructInformation about the versioning of dataset contents.
CfnDatasetPropsStructProperties for defining a CfnDataset.
CfnDatastore.ColumnPropertyStructContains information about a column that stores your data.
CfnDatastore.CustomerManagedS3PropertyStructS3-customer-managed;
CfnDatastore.CustomerManagedS3StoragePropertyStructAmazon S3 -customer-managed;
CfnDatastore.DatastorePartitionPropertyStructA single dimension to partition a data store.
CfnDatastore.DatastorePartitionsPropertyStructInformation about the partition dimensions in a data store.
CfnDatastore.DatastoreStoragePropertyStructWhere data store data is stored.
CfnDatastore.FileFormatConfigurationPropertyStructContains the configuration information of file formats. ITA data stores support JSON and Parquet .
CfnDatastore.IotSiteWiseMultiLayerStoragePropertyStructStores data used by AWS IoT SiteWise in an Amazon S3 bucket that you manage.
CfnDatastore.ParquetConfigurationPropertyStructContains the configuration information of the Parquet format.
CfnDatastore.PartitionPropertyStructA single dimension to partition a data store.
CfnDatastore.RetentionPeriodPropertyStructHow long, in days, message data is kept.
CfnDatastore.SchemaDefinitionPropertyStructInformation needed to define a schema.
CfnDatastore.TimestampPartitionPropertyStructA partition dimension defined by a timestamp attribute.
CfnDatastorePropsStructProperties for defining a CfnDatastore.
CfnPipeline.ActivityPropertyStructAn activity that performs a transformation on a message.
CfnPipeline.AddAttributesPropertyStructAn activity that adds other attributes based on existing attributes in the message.
CfnPipeline.ChannelPropertyStructDetermines the source of the messages to be processed.
CfnPipeline.DatastorePropertyStructThe datastore activity that specifies where to store the processed data.
CfnPipeline.DeviceRegistryEnrichPropertyStructAn activity that adds data from the AWS IoT device registry to your message.
CfnPipeline.DeviceShadowEnrichPropertyStructAn activity that adds information from the AWS IoT Device Shadows service to a message.
CfnPipeline.FilterPropertyStructAn activity that filters a message based on its attributes.
CfnPipeline.LambdaPropertyStructAn activity that runs a Lambda function to modify the message.
CfnPipeline.MathPropertyStructAn activity that computes an arithmetic expression using the message's attributes.
CfnPipeline.RemoveAttributesPropertyStructAn activity that removes attributes from a message.
CfnPipeline.SelectAttributesPropertyStructCreates a new message using only the specified attributes from the original message.
CfnPipelinePropsStructProperties for defining a CfnPipeline.