Package software.amazon.awscdk.services.iotanalytics

Class CfnDataset

java.lang.Object
software.amazon.jsii.JsiiObject
software.constructs.Construct
software.amazon.awscdk.core.Construct
software.amazon.awscdk.core.CfnElement
software.amazon.awscdk.core.CfnRefElement
software.amazon.awscdk.core.CfnResource
software.amazon.awscdk.services.iotanalytics.CfnDataset
All Implemented Interfaces:
IConstruct, IDependable, IInspectable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct
@Generated(value="jsii-pacmak/1.84.0 (build 5404dcf)", date="2023-06-19T16:29:57.741Z") @Stability(Stable) public class CfnDataset extends CfnResource implements IInspectable
A CloudFormation AWS::IoTAnalytics::Dataset.

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();

  • 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 Construct scope, @NotNull String id, @NotNull CfnDatasetProps props)
      Create a new AWS::IoTAnalytics::Dataset.

      Parameters:
      scope -
      • scope in which this resource is defined.
      This parameter is required.
      id -
      • scoped id of the resource.
      This parameter is required.
      props -
      • resource properties.
      This parameter is required.

  • Method Details

    • 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

    • getTags

      @Stability(Stable) @NotNull public TagManager getTags()
      Metadata which can be used to manage the data set.

      For more information, see Tag .

    • getActions

      @Stability(Stable) @NotNull public Object getActions()
      The DatasetAction objects that automatically create the dataset contents.

    • 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.

    • 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.

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

    • setLateDataRules

      @Stability(Stable) public void setLateDataRules(@Nullable IResolvable value)
      A list of data rules that send notifications to CloudWatch, when data arrives late.

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

    • setLateDataRules

      @Stability(Stable) public void setLateDataRules(@Nullable List<Object> value)
      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

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

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

    • setRetentionPeriod

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

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

    • setRetentionPeriod

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

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

    • getTriggers

      @Stability(Stable) @Nullable public Object getTriggers()
      The DatasetTrigger objects that specify when the dataset is automatically updated.

    • 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.

      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 .

    • setVersioningConfiguration

      @Stability(Stable) public void setVersioningConfiguration(@Nullable IResolvable value)
      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 .

    • setVersioningConfiguration

      @Stability(Stable) public void setVersioningConfiguration(@Nullable CfnDataset.VersioningConfigurationProperty value)
      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 .