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:
IInspectable, ITaggable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable
@Generated(value="jsii-pacmak/1.101.0 (build b95fe5d)", date="2024-07-12T19:34:03.247Z") @Stability(Stable) public class CfnDataset extends CfnResource implements IInspectable, 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:

  • 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

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

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

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

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

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

    • setVersioningConfiguration

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

    • setVersioningConfiguration

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