interface CfnDatasetProps

Language	Type name
.NET	`Amazon.CDK.AWS.IoTAnalytics.CfnDatasetProps`
Go	`github.com/aws/aws-cdk-go/awscdk/v2/awsiotanalytics#CfnDatasetProps`
Java	`software.amazon.awscdk.services.iotanalytics.CfnDatasetProps`
Python	`aws_cdk.aws_iotanalytics.CfnDatasetProps`
TypeScript	`aws-cdk-lib` » `aws_iotanalytics` » `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 { aws_iotanalytics as iotanalytics } from 'aws-cdk-lib';
const cfnDatasetProps: iotanalytics.CfnDatasetProps = {
  actions: [{
    actionName: 'actionName',

    // the properties below are optional
    containerAction: {
      executionRoleArn: 'executionRoleArn',
      image: 'image',
      resourceConfiguration: {
        computeType: 'computeType',
        volumeSizeInGb: 123,
      },

      // the properties below are optional
      variables: [{
        variableName: 'variableName',

        // the properties below are optional
        datasetContentVersionValue: {
          datasetName: 'datasetName',
        },
        doubleValue: 123,
        outputFileUriValue: {
          fileName: 'fileName',
        },
        stringValue: 'stringValue',
      }],
    },
    queryAction: {
      sqlQuery: 'sqlQuery',

      // the properties below are optional
      filters: [{
        deltaTime: {
          offsetSeconds: 123,
          timeExpression: 'timeExpression',
        },
      }],
    },
  }],

  // the properties below are optional
  contentDeliveryRules: [{
    destination: {
      iotEventsDestinationConfiguration: {
        inputName: 'inputName',
        roleArn: 'roleArn',
      },
      s3DestinationConfiguration: {
        bucket: 'bucket',
        key: 'key',
        roleArn: 'roleArn',

        // the properties below are optional
        glueConfiguration: {
          databaseName: 'databaseName',
          tableName: 'tableName',
        },
      },
    },

    // the properties below are optional
    entryName: 'entryName',
  }],
  datasetName: 'datasetName',
  lateDataRules: [{
    ruleConfiguration: {
      deltaTimeSessionWindowConfiguration: {
        timeoutInMinutes: 123,
      },
    },

    // the properties below are optional
    ruleName: 'ruleName',
  }],
  retentionPeriod: {
    numberOfDays: 123,
    unlimited: false,
  },
  tags: [{
    key: 'key',
    value: 'value',
  }],
  triggers: [{
    schedule: {
      scheduleExpression: 'scheduleExpression',
    },
    triggeringDataset: {
      datasetName: 'datasetName',
    },
  }],
  versioningConfiguration: {
    maxVersions: 123,
    unlimited: false,
  },
};

Properties

Name	Type	Description
actions	`IResolvable` `\|` `IResolvable` `\|` `ActionProperty[]`	The `DatasetAction` objects that automatically create the dataset contents.
contentDeliveryRules?	`IResolvable` `\|` `IResolvable` `\|` `DatasetContentDeliveryRuleProperty[]`	When dataset contents are created they are delivered to destinations specified here.
datasetName?	`string`	The name of the dataset.
lateDataRules?	`IResolvable` `\|` `IResolvable` `\|` `LateDataRuleProperty[]`	A list of data rules that send notifications to CloudWatch, when data arrives late.
retentionPeriod?	`IResolvable` `\|` `RetentionPeriodProperty`	Optional.
tags?	`CfnTag[]`	Metadata which can be used to manage the data set.
triggers?	`IResolvable` `\|` `IResolvable` `\|` `TriggerProperty[]`	The `DatasetTrigger` objects that specify when the dataset is automatically updated.
versioningConfiguration?	`IResolvable` `\|` `VersioningConfigurationProperty`	Optional.

actions

Type: IResolvable | IResolvable | ActionProperty[]

The DatasetAction objects that automatically create the dataset contents.

contentDeliveryRules?

Type: IResolvable | IResolvable | DatasetContentDeliveryRuleProperty[] (optional)

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

datasetName?

Type: string (optional)

The name of the dataset.

lateDataRules?

Type: IResolvable | IResolvable | LateDataRuleProperty[] (optional)

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

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

retentionPeriod?

Type: IResolvable | RetentionPeriodProperty (optional)

Optional.

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

tags?

Type: CfnTag[] (optional)

Metadata which can be used to manage the data set.

For more information, see Tag .

triggers?

Type: IResolvable | IResolvable | TriggerProperty[] (optional)

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

versioningConfiguration?

Type: IResolvable | VersioningConfigurationProperty (optional)

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 .