Package software.amazon.awscdk.services.iotanalytics

Class CfnDataset

java.lang.Object

software.amazon.jsii.JsiiObject

software.constructs.Construct

software.amazon.awscdk.CfnElement

software.amazon.awscdk.CfnRefElement

software.amazon.awscdk.CfnResource

software.amazon.awscdk.services.iotanalytics.CfnDataset

All Implemented Interfaces:

IEnvironmentAware, IInspectable, ITaggable, IDatasetRef, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable

@Generated(value="jsii-pacmak/1.118.0 (build 02eec31)",
           date="2025-11-10T13:40:07.720Z")
@Stability(Stable)
public class CfnDataset
extends CfnResource
implements IInspectable, IDatasetRef, ITaggable

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 AWS IoT Analytics in the AWS IoT Analytics User Guide .

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.iotanalytics.*;
 CfnDataset cfnDataset = CfnDataset.Builder.create(this, "MyCfnDataset")
         .actions(List.of(ActionProperty.builder()
                 .actionName("actionName")
                 // the properties below are optional
                 .containerAction(ContainerActionProperty.builder()
                         .executionRoleArn("executionRoleArn")
                         .image("image")
                         .resourceConfiguration(ResourceConfigurationProperty.builder()
                                 .computeType("computeType")
                                 .volumeSizeInGb(123)
                                 .build())
                         // the properties below are optional
                         .variables(List.of(VariableProperty.builder()
                                 .variableName("variableName")
                                 // the properties below are optional
                                 .datasetContentVersionValue(DatasetContentVersionValueProperty.builder()
                                         .datasetName("datasetName")
                                         .build())
                                 .doubleValue(123)
                                 .outputFileUriValue(OutputFileUriValueProperty.builder()
                                         .fileName("fileName")
                                         .build())
                                 .stringValue("stringValue")
                                 .build()))
                         .build())
                 .queryAction(QueryActionProperty.builder()
                         .sqlQuery("sqlQuery")
                         // the properties below are optional
                         .filters(List.of(FilterProperty.builder()
                                 .deltaTime(DeltaTimeProperty.builder()
                                         .offsetSeconds(123)
                                         .timeExpression("timeExpression")
                                         .build())
                                 .build()))
                         .build())
                 .build()))
         // the properties below are optional
         .contentDeliveryRules(List.of(DatasetContentDeliveryRuleProperty.builder()
                 .destination(DatasetContentDeliveryRuleDestinationProperty.builder()
                         .iotEventsDestinationConfiguration(IotEventsDestinationConfigurationProperty.builder()
                                 .inputName("inputName")
                                 .roleArn("roleArn")
                                 .build())
                         .s3DestinationConfiguration(S3DestinationConfigurationProperty.builder()
                                 .bucket("bucket")
                                 .key("key")
                                 .roleArn("roleArn")
                                 // the properties below are optional
                                 .glueConfiguration(GlueConfigurationProperty.builder()
                                         .databaseName("databaseName")
                                         .tableName("tableName")
                                         .build())
                                 .build())
                         .build())
                 // the properties below are optional
                 .entryName("entryName")
                 .build()))
         .datasetName("datasetName")
         .lateDataRules(List.of(LateDataRuleProperty.builder()
                 .ruleConfiguration(LateDataRuleConfigurationProperty.builder()
                         .deltaTimeSessionWindowConfiguration(DeltaTimeSessionWindowConfigurationProperty.builder()
                                 .timeoutInMinutes(123)
                                 .build())
                         .build())
                 // the properties below are optional
                 .ruleName("ruleName")
                 .build()))
         .retentionPeriod(RetentionPeriodProperty.builder()
                 .numberOfDays(123)
                 .unlimited(false)
                 .build())
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .triggers(List.of(TriggerProperty.builder()
                 .schedule(ScheduleProperty.builder()
                         .scheduleExpression("scheduleExpression")
                         .build())
                 .triggeringDataset(TriggeringDatasetProperty.builder()
                         .datasetName("datasetName")
                         .build())
                 .build()))
         .versioningConfiguration(VersioningConfigurationProperty.builder()
                 .maxVersions(123)
                 .unlimited(false)
                 .build())
         .build();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotanalytics-dataset.html

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	CfnDataset.ActionProperty	Information needed to run the "containerAction" to produce data set contents.
static final class	CfnDataset.Builder	A fluent builder for CfnDataset.
static interface	CfnDataset.ContainerActionProperty	Information needed to run the "containerAction" to produce data set contents.
static interface	CfnDataset.DatasetContentDeliveryRuleDestinationProperty	The destination to which dataset contents are delivered.
static interface	CfnDataset.DatasetContentDeliveryRuleProperty	When dataset contents are created, they are delivered to destination specified here.
static interface	CfnDataset.DatasetContentVersionValueProperty	The dataset whose latest contents are used as input to the notebook or application.
static interface	CfnDataset.DeltaTimeProperty	Used to limit data to that which has arrived since the last execution of the action.
static interface	CfnDataset.DeltaTimeSessionWindowConfigurationProperty	A structure that contains the configuration information of a delta time session window.
static interface	CfnDataset.FilterProperty	Information which is used to filter message data, to segregate it according to the time frame in which it arrives.
static interface	CfnDataset.GlueConfigurationProperty	Configuration information for coordination with AWS Glue , a fully managed extract, transform and load (ETL) service.
static interface	CfnDataset.IotEventsDestinationConfigurationProperty	Configuration information for delivery of dataset contents to AWS IoT Events .
static interface	CfnDataset.LateDataRuleConfigurationProperty	The information needed to configure a delta time session window.
static interface	CfnDataset.LateDataRuleProperty	A structure that contains the name and configuration information of a late data rule.
static interface	CfnDataset.OutputFileUriValueProperty	The value of the variable as a structure that specifies an output file URI.
static interface	CfnDataset.QueryActionProperty	An "SqlQueryDatasetAction" object that uses an SQL query to automatically create data set contents.
static interface	CfnDataset.ResourceConfigurationProperty	The configuration of the resource used to execute the containerAction .
static interface	CfnDataset.RetentionPeriodProperty	How long, in days, message data is kept.
static interface	CfnDataset.S3DestinationConfigurationProperty	Configuration information for delivery of dataset contents to Amazon Simple Storage Service (Amazon S3).
static interface	CfnDataset.ScheduleProperty	The schedule for when to trigger an update.
static interface	CfnDataset.TriggeringDatasetProperty	Information about the dataset whose content generation triggers the new dataset content generation.
static interface	CfnDataset.TriggerProperty	The "DatasetTrigger" that specifies when the data set is automatically updated.
static interface	CfnDataset.VariableProperty	An instance of a variable to be passed to the containerAction execution.
static interface	CfnDataset.VersioningConfigurationProperty	Information about the versioning of dataset contents.

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.constructs.IConstruct

software.constructs.IConstruct.Jsii$Default

Nested classes/interfaces inherited from interface software.amazon.awscdk.services.iotanalytics.IDatasetRef

IDatasetRef.Jsii$Default, IDatasetRef.Jsii$Proxy

Nested classes/interfaces inherited from interface software.amazon.awscdk.IInspectable

IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

Nested classes/interfaces inherited from interface software.amazon.awscdk.ITaggable

ITaggable.Jsii$Default, ITaggable.Jsii$Proxy

Field Summary

Fields

Modifier and Type	Field	Description
static final String	CFN_RESOURCE_TYPE_NAME	The CloudFormation resource type name for this resource class.

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	CfnDataset(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnDataset(software.amazon.jsii.JsiiObjectRef objRef)
	CfnDataset(software.constructs.Construct scope, String id, CfnDatasetProps props)

Method Summary

Modifier and Type	Method	Description
static IDatasetRef	fromDatasetName(software.constructs.Construct scope, String id, String datasetName)	Creates a new IDatasetRef from a datasetName.
Object	getActions()	The DatasetAction objects that automatically create the dataset contents.
String	getAttrId()
protected Map<String,Object>	getCfnProperties()
Object	getContentDeliveryRules()	When dataset contents are created they are delivered to destinations specified here.
String	getDatasetName()	The name of the dataset.
DatasetReference	getDatasetRef()	A reference to a Dataset resource.
Object	getLateDataRules()	A list of data rules that send notifications to CloudWatch, when data arrives late.
Object	getRetentionPeriod()	Optional.
TagManager	getTags()	Tag Manager which manages the tags for this resource.
List<CfnTag>	getTagsRaw()	Metadata which can be used to manage the data set.
Object	getTriggers()	The DatasetTrigger objects that specify when the dataset is automatically updated.
Object	getVersioningConfiguration()	Optional.
void	inspect(TreeInspector inspector)	Examines the CloudFormation resource and discloses attributes.
protected Map<String,Object>	renderProperties(Map<String,Object> props)
void	setActions(List<Object> value)	The DatasetAction objects that automatically create the dataset contents.
void	setActions(IResolvable value)	The DatasetAction objects that automatically create the dataset contents.
void	setContentDeliveryRules(List<Object> value)	When dataset contents are created they are delivered to destinations specified here.
void	setContentDeliveryRules(IResolvable value)	When dataset contents are created they are delivered to destinations specified here.
void	setDatasetName(String value)	The name of the dataset.
void	setLateDataRules(List<Object> value)	A list of data rules that send notifications to CloudWatch, when data arrives late.
void	setLateDataRules(IResolvable value)	A list of data rules that send notifications to CloudWatch, when data arrives late.
void	setRetentionPeriod(IResolvable value)	Optional.
void	setRetentionPeriod(CfnDataset.RetentionPeriodProperty value)	Optional.
void	setTagsRaw(List<CfnTag> value)	Metadata which can be used to manage the data set.
void	setTriggers(List<Object> value)	The DatasetTrigger objects that specify when the dataset is automatically updated.
void	setTriggers(IResolvable value)	The DatasetTrigger objects that specify when the dataset is automatically updated.
void	setVersioningConfiguration(IResolvable value)	Optional.
void	setVersioningConfiguration(CfnDataset.VersioningConfigurationProperty value)	Optional.

Methods inherited from class software.amazon.awscdk.CfnResource

addDeletionOverride, addDependency, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getAtt, getCfnOptions, getCfnResourceType, getEnv, getMetadata, getUpdatedProperites, getUpdatedProperties, isCfnResource, obtainDependencies, obtainResourceDependencies, removeDependency, replaceDependency, shouldSynthesize, toString, validateProperties

Methods inherited from class software.amazon.awscdk.CfnRefElement

getRef

Methods inherited from class software.amazon.awscdk.CfnElement

getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId

Methods inherited from class software.constructs.Construct

getNode, isConstruct

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.constructs.IConstruct

getNode

Methods inherited from interface software.amazon.awscdk.IEnvironmentAware

getEnv

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Field Details

CFN_RESOURCE_TYPE_NAME

@Stability(Stable)
public static final String CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

Constructor Details

CfnDataset

protected CfnDataset(software.amazon.jsii.JsiiObjectRef objRef)

CfnDataset

protected CfnDataset(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

CfnDataset

@Stability(Stable)
public CfnDataset(@NotNull
 software.constructs.Construct scope,
 @NotNull
 String id,
 @NotNull
 CfnDatasetProps props)

Parameters:

scope - Scope in which this resource is defined. This parameter is required.

id - Construct identifier for this resource (unique in its scope). This parameter is required.

props - Resource properties. This parameter is required.

Method Details

fromDatasetName

@Stability(Stable)
@NotNull
public static IDatasetRef fromDatasetName(@NotNull
 software.constructs.Construct scope,
 @NotNull
 String id,
 @NotNull
 String datasetName)

Creates a new IDatasetRef from a datasetName.

Parameters:

scope - This parameter is required.

id - This parameter is required.

datasetName - This parameter is required.

inspect

@Stability(Stable)
public void inspect(@NotNull
 TreeInspector inspector)

Examines the CloudFormation resource and discloses attributes.

Specified by:

inspect in interface IInspectable

Parameters:

inspector - tree inspector to collect and process attributes. This parameter is required.

renderProperties

@Stability(Stable)
@NotNull
protected Map<String,Object> renderProperties(@NotNull
 Map<String,Object> props)

Overrides:

renderProperties in class CfnResource

Parameters:

props - This parameter is required.

getAttrId

@Stability(Stable)
@NotNull
public String getAttrId()

getCfnProperties

@Stability(Stable)
@NotNull
protected Map<String,Object> getCfnProperties()

Overrides:

getCfnProperties in class CfnResource

getDatasetRef

@Stability(Stable)
@NotNull
public DatasetReference getDatasetRef()

A reference to a Dataset resource.

Specified by:

getDatasetRef in interface IDatasetRef

getTags

@Stability(Stable)
@NotNull
public TagManager getTags()

Tag Manager which manages the tags for this resource.

Specified by:

getTags in interface ITaggable

getActions

@Stability(Stable)
@NotNull
public Object getActions()

The DatasetAction objects that automatically create the dataset contents.

Returns union: either IResolvable or Listinvalid input: '<'either IResolvable or CfnDataset.ActionProperty>

setActions

@Stability(Stable)
public void setActions(@NotNull
 IResolvable value)

The DatasetAction objects that automatically create the dataset contents.

setActions

@Stability(Stable)
public void setActions(@NotNull
 List<Object> value)

The DatasetAction objects that automatically create the dataset contents.

getContentDeliveryRules

@Stability(Stable)
@Nullable
public Object getContentDeliveryRules()

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

Returns union: either IResolvable or Listinvalid input: '<'either IResolvable or CfnDataset.DatasetContentDeliveryRuleProperty>

setContentDeliveryRules

@Stability(Stable)
public void setContentDeliveryRules(@Nullable
 IResolvable value)

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

setContentDeliveryRules

@Stability(Stable)
public void setContentDeliveryRules(@Nullable
 List<Object> value)

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

getDatasetName

@Stability(Stable)
@Nullable
public String getDatasetName()

The name of the dataset.

setDatasetName

@Stability(Stable)
public void setDatasetName(@Nullable
 String value)

The name of the dataset.

getLateDataRules

@Stability(Stable)
@Nullable
public Object getLateDataRules()

A list of data rules that send notifications to CloudWatch, when data arrives late.

Returns union: either IResolvable or Listinvalid input: '<'either IResolvable or CfnDataset.LateDataRuleProperty>

setLateDataRules

@Stability(Stable)
public void setLateDataRules(@Nullable
 IResolvable value)

A list of data rules that send notifications to CloudWatch, when data arrives late.

setLateDataRules

@Stability(Stable)
public void setLateDataRules(@Nullable
 List<Object> value)

A list of data rules that send notifications to CloudWatch, when data arrives late.

getRetentionPeriod

@Stability(Stable)
@Nullable
public Object getRetentionPeriod()

Optional.

Returns union: either IResolvable or CfnDataset.RetentionPeriodProperty

setRetentionPeriod

@Stability(Stable)
public void setRetentionPeriod(@Nullable
 IResolvable value)

Optional.

setRetentionPeriod

@Stability(Stable)
public void setRetentionPeriod(@Nullable
 CfnDataset.RetentionPeriodProperty value)

Optional.

getTagsRaw

@Stability(Stable)
@Nullable
public List<CfnTag> getTagsRaw()

Metadata which can be used to manage the data set.

setTagsRaw

@Stability(Stable)
public void setTagsRaw(@Nullable
 List<CfnTag> value)

Metadata which can be used to manage the data set.

getTriggers

@Stability(Stable)
@Nullable
public Object getTriggers()

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

Returns union: either IResolvable or Listinvalid input: '<'either IResolvable or CfnDataset.TriggerProperty>

setTriggers

@Stability(Stable)
public void setTriggers(@Nullable
 IResolvable value)

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

setTriggers

@Stability(Stable)
public void setTriggers(@Nullable
 List<Object> value)

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

getVersioningConfiguration

@Stability(Stable)
@Nullable
public Object getVersioningConfiguration()

Optional.

Returns union: either IResolvable or CfnDataset.VersioningConfigurationProperty

setVersioningConfiguration

@Stability(Stable)
public void setVersioningConfiguration(@Nullable
 IResolvable value)

Optional.

setVersioningConfiguration

@Stability(Stable)
public void setVersioningConfiguration(@Nullable
 CfnDataset.VersioningConfigurationProperty value)

Optional.