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 AWS::IoTAnalytics::Dataset.

Parameters
Link

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

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
import aws_cdk.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

AWS::IoTAnalytics::Dataset.Actions.

Link

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

Return type

Union[IResolvable, List[Union[ActionProperty, IResolvable]]]

content_delivery_rules

AWS::IoTAnalytics::Dataset.ContentDeliveryRules.

Link

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

Return type

Union[IResolvable, List[Union[IResolvable, DatasetContentDeliveryRuleProperty]], None]

dataset_name

AWS::IoTAnalytics::Dataset.DatasetName.

Link

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

Return type

Optional[str]

late_data_rules

AWS::IoTAnalytics::Dataset.LateDataRules.

Link

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

Return type

Union[IResolvable, List[Union[IResolvable, LateDataRuleProperty]], None]

retention_period

AWS::IoTAnalytics::Dataset.RetentionPeriod.

Link

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

Return type

Union[IResolvable, RetentionPeriodProperty, None]

tags

AWS::IoTAnalytics::Dataset.Tags.

Link

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

Return type

Optional[List[CfnTag]]

triggers

AWS::IoTAnalytics::Dataset.Triggers.

Link

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

Return type

Union[IResolvable, List[Union[IResolvable, TriggerProperty]], None]

versioning_configuration

AWS::IoTAnalytics::Dataset.VersioningConfiguration.

Link

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

Return type

Union[IResolvable, VersioningConfigurationProperty, None]