AWS Fundamentals Logo
AWS Fundamentals
L1 ConstructAWS::IoTAnalytics::Dataset

CfnDataset

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). The data set can be populated manually by calling `CreateDatasetContent` or automatically according to a `trigger` you specify. For more information, see [How to Use](https://docs.aws.amazon.com/iotanalytics/latest/userguide/welcome.html#aws-iot-analytics-how) in the *User Guide* .

Import

import { CfnDataset } from 'aws-cdk-lib/aws-iotanalytics';

Or use the module namespace:

import * as iotanalytics from 'aws-cdk-lib/aws-iotanalytics';
// iotanalytics.CfnDataset

Properties

Configuration passed to the constructor as CfnDatasetProps.

actionsRequired
IResolvable | IResolvable | ActionProperty[]

The `DatasetAction` objects that automatically create the dataset contents.

contentDeliveryRulesOptional
IResolvable | IResolvable | DatasetContentDeliveryRuleProperty[]

When dataset contents are created they are delivered to destinations specified here.

datasetNameOptional
string

The name of the dataset.

lateDataRulesOptional
IResolvable | IResolvable | LateDataRuleProperty[]

A list of data rules that send notifications to CloudWatch, when data arrives late. To specify `lateDataRules` , the dataset must use a [DeltaTimer](https://docs.aws.amazon.com/iotanalytics/latest/APIReference/API_DeltaTime.html) filter.

retentionPeriodOptional
IResolvable | RetentionPeriodProperty

Optional. How long, in days, message data is kept for the dataset.

tagsOptional
CfnTag[]

Metadata which can be used to manage the data set. For more information, see [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html) .

triggersOptional
IResolvable | IResolvable | TriggerProperty[]

The `DatasetTrigger` objects that specify when the dataset is automatically updated.

versioningConfigurationOptional
IResolvable | VersioningConfigurationProperty

Optional. How many versions of dataset contents are kept. If not specified or set to null, only the latest version plus the latest succeeded version (if they are different) are kept for the time period specified by the `retentionPeriod` parameter. For more information, see [Keeping Multiple Versions of ITA datasets](https://docs.aws.amazon.com/iotanalytics/latest/userguide/getting-started.html#aws-iot-analytics-dataset-versions) in the *ITA User Guide* .

CloudFormation Resource

This L1 construct maps directly to the following CloudFormation resource type.

AWS::IoTAnalytics::DatasetView in CloudFormation Explorer

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

LevelL1 (CloudFormation)
Moduleaws-iotanalytics
CFN TypeAWS::IoTAnalytics::Dataset
Properties8

Related Constructs

Explore This Service

External Links