software.amazon.awscdk.services.iotanalytics

Interface CfnDatasetProps

All Known Implementing Classes:

CfnDatasetProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.71.0 (build f1f58ae)",
           date="2022-11-29T04:32:15.660Z")
public interface CfnDatasetProps

Properties for defining a `CfnDataset`.

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.*;
 CfnDatasetProps cfnDatasetProps = CfnDatasetProps.builder()
         .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();
 

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	CfnDatasetProps.Builder A builder for CfnDatasetProps
static class	CfnDatasetProps.Jsii$Proxy An implementation for CfnDatasetProps

Method Summary

Modifier and Type	Method and Description
static CfnDatasetProps.Builder	builder()
java.lang.Object	getActions() The `DatasetAction` objects that automatically create the dataset contents.
default java.lang.Object	getContentDeliveryRules() When dataset contents are created they are delivered to destinations specified here.
default java.lang.String	getDatasetName() The name of the dataset.
default java.lang.Object	getLateDataRules() A list of data rules that send notifications to CloudWatch, when data arrives late.
default java.lang.Object	getRetentionPeriod() Optional.
default java.util.List<CfnTag>	getTags() Metadata which can be used to manage the data set.
default java.lang.Object	getTriggers() The `DatasetTrigger` objects that specify when the dataset is automatically updated.
default java.lang.Object	getVersioningConfiguration() Optional.

Method Detail

getActions

java.lang.Object getActions()

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

getContentDeliveryRules

default java.lang.Object getContentDeliveryRules()

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

getDatasetName

default java.lang.String getDatasetName()

The name of the dataset.

getLateDataRules

default java.lang.Object getLateDataRules()

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

To specify lateDataRules , the dataset must use a DeltaTimer filter.

getRetentionPeriod

default java.lang.Object getRetentionPeriod()

Optional.

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

getTags

default java.util.List<CfnTag> getTags()

Metadata which can be used to manage the data set.

For more information, see Tag .

getTriggers

default java.lang.Object getTriggers()

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

getVersioningConfiguration

default java.lang.Object getVersioningConfiguration()

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

builder

static CfnDatasetProps.Builder builder()

Returns:

a CfnDatasetProps.Builder of CfnDatasetProps