CfnDatasetProps

class aws_cdk.aws_iotanalytics.CfnDatasetProps(*, actions, content_delivery_rules=None, dataset_name=None, late_data_rules=None, retention_period=None, tags=None, triggers=None, versioning_configuration=None)

Bases: object

Properties for defining a CfnDataset.

Parameters:

• actions (Union[IResolvable, Sequence[Union[IResolvable, ActionProperty, Dict[str, Any]]]]) – The DatasetAction objects that automatically create the dataset contents.

• content_delivery_rules (Union[IResolvable, Sequence[Union[IResolvable, DatasetContentDeliveryRuleProperty, Dict[str, Any]]], None]) – When dataset contents are created they are delivered to destinations specified here.

• dataset_name (Optional[str]) – The name of the dataset.

• late_data_rules (Union[IResolvable, Sequence[Union[IResolvable, LateDataRuleProperty, Dict[str, Any]]], None]) – A list of data rules that send notifications to CloudWatch, when data arrives late. To specify lateDataRules , the dataset must use a DeltaTimer filter.

• retention_period (Union[IResolvable, RetentionPeriodProperty, Dict[str, Any], None]) – Optional. How long, in days, message data is kept for the dataset.

• tags (Optional[Sequence[Union[CfnTag, Dict[str, Any]]]]) – Metadata which can be used to manage the data set. For more information, see Tag .

• triggers (Union[IResolvable, Sequence[Union[IResolvable, TriggerProperty, Dict[str, Any]]], None]) – The DatasetTrigger objects that specify when the dataset is automatically updated.

• versioning_configuration (Union[IResolvable, VersioningConfigurationProperty, Dict[str, Any], None]) – 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 .

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotanalytics-dataset.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_iotanalytics as iotanalytics

cfn_dataset_props = iotanalytics.CfnDatasetProps(
    actions=[iotanalytics.CfnDataset.ActionProperty(
        action_name="actionName",

        # the properties below are optional
        container_action=iotanalytics.CfnDataset.ContainerActionProperty(
            execution_role_arn="executionRoleArn",
            image="image",
            resource_configuration=iotanalytics.CfnDataset.ResourceConfigurationProperty(
                compute_type="computeType",
                volume_size_in_gb=123
            ),

            # the properties below are optional
            variables=[iotanalytics.CfnDataset.VariableProperty(
                variable_name="variableName",

                # the properties below are optional
                dataset_content_version_value=iotanalytics.CfnDataset.DatasetContentVersionValueProperty(
                    dataset_name="datasetName"
                ),
                double_value=123,
                output_file_uri_value=iotanalytics.CfnDataset.OutputFileUriValueProperty(
                    file_name="fileName"
                ),
                string_value="stringValue"
            )]
        ),
        query_action=iotanalytics.CfnDataset.QueryActionProperty(
            sql_query="sqlQuery",

            # the properties below are optional
            filters=[iotanalytics.CfnDataset.FilterProperty(
                delta_time=iotanalytics.CfnDataset.DeltaTimeProperty(
                    offset_seconds=123,
                    time_expression="timeExpression"
                )
            )]
        )
    )],

    # the properties below are optional
    content_delivery_rules=[iotanalytics.CfnDataset.DatasetContentDeliveryRuleProperty(
        destination=iotanalytics.CfnDataset.DatasetContentDeliveryRuleDestinationProperty(
            iot_events_destination_configuration=iotanalytics.CfnDataset.IotEventsDestinationConfigurationProperty(
                input_name="inputName",
                role_arn="roleArn"
            ),
            s3_destination_configuration=iotanalytics.CfnDataset.S3DestinationConfigurationProperty(
                bucket="bucket",
                key="key",
                role_arn="roleArn",

                # the properties below are optional
                glue_configuration=iotanalytics.CfnDataset.GlueConfigurationProperty(
                    database_name="databaseName",
                    table_name="tableName"
                )
            )
        ),

        # the properties below are optional
        entry_name="entryName"
    )],
    dataset_name="datasetName",
    late_data_rules=[iotanalytics.CfnDataset.LateDataRuleProperty(
        rule_configuration=iotanalytics.CfnDataset.LateDataRuleConfigurationProperty(
            delta_time_session_window_configuration=iotanalytics.CfnDataset.DeltaTimeSessionWindowConfigurationProperty(
                timeout_in_minutes=123
            )
        ),

        # the properties below are optional
        rule_name="ruleName"
    )],
    retention_period=iotanalytics.CfnDataset.RetentionPeriodProperty(
        number_of_days=123,
        unlimited=False
    ),
    tags=[CfnTag(
        key="key",
        value="value"
    )],
    triggers=[iotanalytics.CfnDataset.TriggerProperty(
        schedule=iotanalytics.CfnDataset.ScheduleProperty(
            schedule_expression="scheduleExpression"
        ),
        triggering_dataset=iotanalytics.CfnDataset.TriggeringDatasetProperty(
            dataset_name="datasetName"
        )
    )],
    versioning_configuration=iotanalytics.CfnDataset.VersioningConfigurationProperty(
        max_versions=123,
        unlimited=False
    )
)

Attributes

actions

The DatasetAction objects that automatically create the dataset contents.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotanalytics-dataset.html#cfn-iotanalytics-dataset-actions

content_delivery_rules

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

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotanalytics-dataset.html#cfn-iotanalytics-dataset-contentdeliveryrules

dataset_name

The name of the dataset.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotanalytics-dataset.html#cfn-iotanalytics-dataset-datasetname

late_data_rules

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

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

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotanalytics-dataset.html#cfn-iotanalytics-dataset-latedatarules

retention_period

Optional.

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

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotanalytics-dataset.html#cfn-iotanalytics-dataset-retentionperiod

tags

Metadata which can be used to manage the data set.

For more information, see Tag .

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotanalytics-dataset.html#cfn-iotanalytics-dataset-tags

triggers

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

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotanalytics-dataset.html#cfn-iotanalytics-dataset-triggers

versioning_configuration

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 .

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotanalytics-dataset.html#cfn-iotanalytics-dataset-versioningconfiguration