Package software.amazon.awscdk.cfnpropertymixins.services.iotanalytics

Class CfnDatasetPropsMixin

java.lang.Object

software.amazon.jsii.JsiiObject

software.amazon.awscdk.Mixin

software.amazon.awscdk.cfnpropertymixins.services.iotanalytics.CfnDatasetPropsMixin

All Implemented Interfaces:

software.amazon.jsii.JsiiSerializable, software.constructs.IMixin

@Generated(value="jsii-pacmak/1.127.0 (build 2117ad5)",
           date="2026-03-11T13:20:00.270Z")
@Stability(Stable)
public class CfnDatasetPropsMixin
extends Mixin
implements software.constructs.IMixin

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 in the 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.cfnpropertymixins.services.iotanalytics.*;
 import software.amazon.awscdk.*;
 IMergeStrategy mergeStrategy;
 CfnDatasetPropsMixin cfnDatasetPropsMixin = CfnDatasetPropsMixin.Builder.create(CfnDatasetMixinProps.builder()
         .actions(List.of(ActionProperty.builder()
                 .actionName("actionName")
                 .containerAction(ContainerActionProperty.builder()
                         .executionRoleArn("executionRoleArn")
                         .image("image")
                         .resourceConfiguration(ResourceConfigurationProperty.builder()
                                 .computeType("computeType")
                                 .volumeSizeInGb(123)
                                 .build())
                         .variables(List.of(VariableProperty.builder()
                                 .datasetContentVersionValue(DatasetContentVersionValueProperty.builder()
                                         .datasetName("datasetName")
                                         .build())
                                 .doubleValue(123)
                                 .outputFileUriValue(OutputFileUriValueProperty.builder()
                                         .fileName("fileName")
                                         .build())
                                 .stringValue("stringValue")
                                 .variableName("variableName")
                                 .build()))
                         .build())
                 .queryAction(QueryActionProperty.builder()
                         .filters(List.of(FilterProperty.builder()
                                 .deltaTime(DeltaTimeProperty.builder()
                                         .offsetSeconds(123)
                                         .timeExpression("timeExpression")
                                         .build())
                                 .build()))
                         .sqlQuery("sqlQuery")
                         .build())
                 .build()))
         .contentDeliveryRules(List.of(DatasetContentDeliveryRuleProperty.builder()
                 .destination(DatasetContentDeliveryRuleDestinationProperty.builder()
                         .iotEventsDestinationConfiguration(IotEventsDestinationConfigurationProperty.builder()
                                 .inputName("inputName")
                                 .roleArn("roleArn")
                                 .build())
                         .s3DestinationConfiguration(S3DestinationConfigurationProperty.builder()
                                 .bucket("bucket")
                                 .glueConfiguration(GlueConfigurationProperty.builder()
                                         .databaseName("databaseName")
                                         .tableName("tableName")
                                         .build())
                                 .key("key")
                                 .roleArn("roleArn")
                                 .build())
                         .build())
                 .entryName("entryName")
                 .build()))
         .datasetName("datasetName")
         .lateDataRules(List.of(LateDataRuleProperty.builder()
                 .ruleConfiguration(LateDataRuleConfigurationProperty.builder()
                         .deltaTimeSessionWindowConfiguration(DeltaTimeSessionWindowConfigurationProperty.builder()
                                 .timeoutInMinutes(123)
                                 .build())
                         .build())
                 .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())
 .strategy(mergeStrategy)
 .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	CfnDatasetPropsMixin.ActionProperty	Information needed to run the "containerAction" to produce data set contents.
static final class	CfnDatasetPropsMixin.Builder	A fluent builder for CfnDatasetPropsMixin.
static interface	CfnDatasetPropsMixin.ContainerActionProperty	Information needed to run the "containerAction" to produce data set contents.
static interface	CfnDatasetPropsMixin.DatasetContentDeliveryRuleDestinationProperty	The destination to which dataset contents are delivered.
static interface	CfnDatasetPropsMixin.DatasetContentDeliveryRuleProperty	When dataset contents are created, they are delivered to destination specified here.
static interface	CfnDatasetPropsMixin.DatasetContentVersionValueProperty	The dataset whose latest contents are used as input to the notebook or application.
static interface	CfnDatasetPropsMixin.DeltaTimeProperty	Used to limit data to that which has arrived since the last execution of the action.
static interface	CfnDatasetPropsMixin.DeltaTimeSessionWindowConfigurationProperty	A structure that contains the configuration information of a delta time session window.
static interface	CfnDatasetPropsMixin.FilterProperty	Information which is used to filter message data, to segregate it according to the time frame in which it arrives.
static interface	CfnDatasetPropsMixin.GlueConfigurationProperty	Configuration information for coordination with AWS Glue , a fully managed extract, transform and load (ETL) service.
static interface	CfnDatasetPropsMixin.IotEventsDestinationConfigurationProperty	Configuration information for delivery of dataset contents to AWS IoT Events .
static interface	CfnDatasetPropsMixin.LateDataRuleConfigurationProperty	The information needed to configure a delta time session window.
static interface	CfnDatasetPropsMixin.LateDataRuleProperty	A structure that contains the name and configuration information of a late data rule.
static interface	CfnDatasetPropsMixin.OutputFileUriValueProperty	The value of the variable as a structure that specifies an output file URI.
static interface	CfnDatasetPropsMixin.QueryActionProperty	An "SqlQueryDatasetAction" object that uses an SQL query to automatically create data set contents.
static interface	CfnDatasetPropsMixin.ResourceConfigurationProperty	The configuration of the resource used to execute the containerAction .
static interface	CfnDatasetPropsMixin.RetentionPeriodProperty	How long, in days, message data is kept.
static interface	CfnDatasetPropsMixin.S3DestinationConfigurationProperty	Configuration information for delivery of dataset contents to Amazon Simple Storage Service (Amazon S3).
static interface	CfnDatasetPropsMixin.ScheduleProperty	The schedule for when to trigger an update.
static interface	CfnDatasetPropsMixin.TriggeringDatasetProperty	Information about the dataset whose content generation triggers the new dataset content generation.
static interface	CfnDatasetPropsMixin.TriggerProperty	The "DatasetTrigger" that specifies when the data set is automatically updated.
static interface	CfnDatasetPropsMixin.VariableProperty	An instance of a variable to be passed to the containerAction execution.
static interface	CfnDatasetPropsMixin.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.IMixin

software.constructs.IMixin.Jsii$Default, software.constructs.IMixin.Jsii$Proxy

Field Summary

Fields

Modifier and Type	Field	Description
protected static final List<String>	CFN_PROPERTY_KEYS

Constructor Summary

Constructors

Modifier	Constructor	Description
	CfnDatasetPropsMixin(CfnDatasetMixinProps props)	Create a mixin to apply properties to AWS::IoTAnalytics::Dataset.
	CfnDatasetPropsMixin(CfnDatasetMixinProps props, CfnPropertyMixinOptions options)	Create a mixin to apply properties to AWS::IoTAnalytics::Dataset.
protected	CfnDatasetPropsMixin(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnDatasetPropsMixin(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method	Description
void	applyTo(software.constructs.IConstruct construct)	Apply the mixin properties to the construct.
protected CfnDatasetMixinProps	getProps()
protected IMergeStrategy	getStrategy()
Boolean	supports(software.constructs.IConstruct construct)	Check if this mixin supports the given construct.

Methods inherited from class software.amazon.awscdk.Mixin

isMixin

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, toString, wait, wait, wait

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Field Details

CFN_PROPERTY_KEYS

@Stability(Stable)
protected static final List<String> CFN_PROPERTY_KEYS

Constructor Details

CfnDatasetPropsMixin

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

CfnDatasetPropsMixin

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

CfnDatasetPropsMixin

@Stability(Stable)
public CfnDatasetPropsMixin(@NotNull
 CfnDatasetMixinProps props,
 @Nullable
 CfnPropertyMixinOptions options)

Create a mixin to apply properties to AWS::IoTAnalytics::Dataset.

Parameters:

props - L1 properties to apply. This parameter is required.

options - Mixin options.

CfnDatasetPropsMixin

@Stability(Stable)
public CfnDatasetPropsMixin(@NotNull
 CfnDatasetMixinProps props)

Create a mixin to apply properties to AWS::IoTAnalytics::Dataset.

Parameters:

props - L1 properties to apply. This parameter is required.

Method Details

applyTo

@Stability(Stable)
public void applyTo(@NotNull
 software.constructs.IConstruct construct)

Apply the mixin properties to the construct.

Specified by:

applyTo in interface software.constructs.IMixin

Specified by:

applyTo in class Mixin

Parameters:

construct - This parameter is required.

supports

@Stability(Stable)
@NotNull
public Boolean supports(@NotNull
 software.constructs.IConstruct construct)

Check if this mixin supports the given construct.

Specified by:

supports in interface software.constructs.IMixin

Overrides:

supports in class Mixin

Parameters:

construct - This parameter is required.

getProps

@Stability(Stable)
@NotNull
protected CfnDatasetMixinProps getProps()

getStrategy

@Stability(Stable)
@NotNull
protected IMergeStrategy getStrategy()