CfnDatasetPropsMixin

class aws_cdk.mixins_preview.aws_iotanalytics.mixins.CfnDatasetPropsMixin(props, *, strategy=None)

Bases: Mixin

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 .

See:

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

CloudformationResource:

AWS::IoTAnalytics::Dataset

Mixin:

true

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.mixins_preview import mixins
from aws_cdk.mixins_preview.aws_iotanalytics import mixins as iotanalytics_mixins

cfn_dataset_props_mixin = iotanalytics_mixins.CfnDatasetPropsMixin(iotanalytics_mixins.CfnDatasetMixinProps(
    actions=[iotanalytics_mixins.CfnDatasetPropsMixin.ActionProperty(
        action_name="actionName",
        container_action=iotanalytics_mixins.CfnDatasetPropsMixin.ContainerActionProperty(
            execution_role_arn="executionRoleArn",
            image="image",
            resource_configuration=iotanalytics_mixins.CfnDatasetPropsMixin.ResourceConfigurationProperty(
                compute_type="computeType",
                volume_size_in_gb=123
            ),
            variables=[iotanalytics_mixins.CfnDatasetPropsMixin.VariableProperty(
                dataset_content_version_value=iotanalytics_mixins.CfnDatasetPropsMixin.DatasetContentVersionValueProperty(
                    dataset_name="datasetName"
                ),
                double_value=123,
                output_file_uri_value=iotanalytics_mixins.CfnDatasetPropsMixin.OutputFileUriValueProperty(
                    file_name="fileName"
                ),
                string_value="stringValue",
                variable_name="variableName"
            )]
        ),
        query_action=iotanalytics_mixins.CfnDatasetPropsMixin.QueryActionProperty(
            filters=[iotanalytics_mixins.CfnDatasetPropsMixin.FilterProperty(
                delta_time=iotanalytics_mixins.CfnDatasetPropsMixin.DeltaTimeProperty(
                    offset_seconds=123,
                    time_expression="timeExpression"
                )
            )],
            sql_query="sqlQuery"
        )
    )],
    content_delivery_rules=[iotanalytics_mixins.CfnDatasetPropsMixin.DatasetContentDeliveryRuleProperty(
        destination=iotanalytics_mixins.CfnDatasetPropsMixin.DatasetContentDeliveryRuleDestinationProperty(
            iot_events_destination_configuration=iotanalytics_mixins.CfnDatasetPropsMixin.IotEventsDestinationConfigurationProperty(
                input_name="inputName",
                role_arn="roleArn"
            ),
            s3_destination_configuration=iotanalytics_mixins.CfnDatasetPropsMixin.S3DestinationConfigurationProperty(
                bucket="bucket",
                glue_configuration=iotanalytics_mixins.CfnDatasetPropsMixin.GlueConfigurationProperty(
                    database_name="databaseName",
                    table_name="tableName"
                ),
                key="key",
                role_arn="roleArn"
            )
        ),
        entry_name="entryName"
    )],
    dataset_name="datasetName",
    late_data_rules=[iotanalytics_mixins.CfnDatasetPropsMixin.LateDataRuleProperty(
        rule_configuration=iotanalytics_mixins.CfnDatasetPropsMixin.LateDataRuleConfigurationProperty(
            delta_time_session_window_configuration=iotanalytics_mixins.CfnDatasetPropsMixin.DeltaTimeSessionWindowConfigurationProperty(
                timeout_in_minutes=123
            )
        ),
        rule_name="ruleName"
    )],
    retention_period=iotanalytics_mixins.CfnDatasetPropsMixin.RetentionPeriodProperty(
        number_of_days=123,
        unlimited=False
    ),
    tags=[CfnTag(
        key="key",
        value="value"
    )],
    triggers=[iotanalytics_mixins.CfnDatasetPropsMixin.TriggerProperty(
        schedule=iotanalytics_mixins.CfnDatasetPropsMixin.ScheduleProperty(
            schedule_expression="scheduleExpression"
        ),
        triggering_dataset=iotanalytics_mixins.CfnDatasetPropsMixin.TriggeringDatasetProperty(
            dataset_name="datasetName"
        )
    )],
    versioning_configuration=iotanalytics_mixins.CfnDatasetPropsMixin.VersioningConfigurationProperty(
        max_versions=123,
        unlimited=False
    )
),
    strategy=mixins.PropertyMergeStrategy.OVERRIDE
)

Create a mixin to apply properties to AWS::IoTAnalytics::Dataset.

Parameters:

• props (Union[CfnDatasetMixinProps, Dict[str, Any]]) – L1 properties to apply.

• strategy (Optional[PropertyMergeStrategy]) – (experimental) Strategy for merging nested properties. Default: - PropertyMergeStrategy.MERGE

Methods

apply_to(construct)

Apply the mixin properties to the construct.

Parameters:

construct (IConstruct)

Return type:

IConstruct

supports(construct)

Check if this mixin supports the given construct.

Parameters:

construct (IConstruct)

Return type:

bool

Attributes

CFN_PROPERTY_KEYS = ['actions', 'contentDeliveryRules', 'datasetName', 'lateDataRules', 'retentionPeriod', 'tags', 'triggers', 'versioningConfiguration']

Static Methods

classmethod is_mixin(x)

(experimental) Checks if x is a Mixin.

Parameters:

x (Any) – Any object.

Return type:

bool

Returns:

true if x is an object created from a class which extends Mixin.

Stability:

experimental

ActionProperty

class CfnDatasetPropsMixin.ActionProperty(*, action_name=None, container_action=None, query_action=None)

Bases: object

Information needed to run the “containerAction” to produce data set contents.

Parameters:

• action_name (Optional[str]) – The name of the data set action by which data set contents are automatically created.

• container_action (Union[IResolvable, ContainerActionProperty, Dict[str, Any], None]) – Information which allows the system to run a containerized application in order to create the data set contents. The application must be in a Docker container along with any needed support libraries.

• query_action (Union[IResolvable, QueryActionProperty, Dict[str, Any], None]) – An “SqlQueryDatasetAction” object that uses an SQL query to automatically create data set contents.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-dataset-action.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.mixins_preview.aws_iotanalytics import mixins as iotanalytics_mixins

action_property = iotanalytics_mixins.CfnDatasetPropsMixin.ActionProperty(
    action_name="actionName",
    container_action=iotanalytics_mixins.CfnDatasetPropsMixin.ContainerActionProperty(
        execution_role_arn="executionRoleArn",
        image="image",
        resource_configuration=iotanalytics_mixins.CfnDatasetPropsMixin.ResourceConfigurationProperty(
            compute_type="computeType",
            volume_size_in_gb=123
        ),
        variables=[iotanalytics_mixins.CfnDatasetPropsMixin.VariableProperty(
            dataset_content_version_value=iotanalytics_mixins.CfnDatasetPropsMixin.DatasetContentVersionValueProperty(
                dataset_name="datasetName"
            ),
            double_value=123,
            output_file_uri_value=iotanalytics_mixins.CfnDatasetPropsMixin.OutputFileUriValueProperty(
                file_name="fileName"
            ),
            string_value="stringValue",
            variable_name="variableName"
        )]
    ),
    query_action=iotanalytics_mixins.CfnDatasetPropsMixin.QueryActionProperty(
        filters=[iotanalytics_mixins.CfnDatasetPropsMixin.FilterProperty(
            delta_time=iotanalytics_mixins.CfnDatasetPropsMixin.DeltaTimeProperty(
                offset_seconds=123,
                time_expression="timeExpression"
            )
        )],
        sql_query="sqlQuery"
    )
)

Attributes

action_name

The name of the data set action by which data set contents are automatically created.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-dataset-action.html#cfn-iotanalytics-dataset-action-actionname

container_action

Information which allows the system to run a containerized application in order to create the data set contents.

The application must be in a Docker container along with any needed support libraries.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-dataset-action.html#cfn-iotanalytics-dataset-action-containeraction

query_action

An “SqlQueryDatasetAction” object that uses an SQL query to automatically create data set contents.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-dataset-action.html#cfn-iotanalytics-dataset-action-queryaction

ContainerActionProperty

class CfnDatasetPropsMixin.ContainerActionProperty(*, execution_role_arn=None, image=None, resource_configuration=None, variables=None)

Bases: object

Information needed to run the “containerAction” to produce data set contents.

Parameters:

• execution_role_arn (Optional[str]) – The ARN of the role which gives permission to the system to access needed resources in order to run the “containerAction”. This includes, at minimum, permission to retrieve the data set contents which are the input to the containerized application.

• image (Optional[str]) – The ARN of the Docker container stored in your account. The Docker container contains an application and needed support libraries and is used to generate data set contents.

• resource_configuration (Union[IResolvable, ResourceConfigurationProperty, Dict[str, Any], None]) – Configuration of the resource which executes the “containerAction”.

• variables (Union[IResolvable, Sequence[Union[IResolvable, VariableProperty, Dict[str, Any]]], None]) – The values of variables used within the context of the execution of the containerized application (basically, parameters passed to the application). Each variable must have a name and a value given by one of “stringValue”, “datasetContentVersionValue”, or “outputFileUriValue”.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-dataset-containeraction.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.mixins_preview.aws_iotanalytics import mixins as iotanalytics_mixins

container_action_property = iotanalytics_mixins.CfnDatasetPropsMixin.ContainerActionProperty(
    execution_role_arn="executionRoleArn",
    image="image",
    resource_configuration=iotanalytics_mixins.CfnDatasetPropsMixin.ResourceConfigurationProperty(
        compute_type="computeType",
        volume_size_in_gb=123
    ),
    variables=[iotanalytics_mixins.CfnDatasetPropsMixin.VariableProperty(
        dataset_content_version_value=iotanalytics_mixins.CfnDatasetPropsMixin.DatasetContentVersionValueProperty(
            dataset_name="datasetName"
        ),
        double_value=123,
        output_file_uri_value=iotanalytics_mixins.CfnDatasetPropsMixin.OutputFileUriValueProperty(
            file_name="fileName"
        ),
        string_value="stringValue",
        variable_name="variableName"
    )]
)

Attributes

execution_role_arn

The ARN of the role which gives permission to the system to access needed resources in order to run the “containerAction”.

This includes, at minimum, permission to retrieve the data set contents which are the input to the containerized application.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-dataset-containeraction.html#cfn-iotanalytics-dataset-containeraction-executionrolearn

image

The ARN of the Docker container stored in your account.

The Docker container contains an application and needed support libraries and is used to generate data set contents.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-dataset-containeraction.html#cfn-iotanalytics-dataset-containeraction-image

resource_configuration

Configuration of the resource which executes the “containerAction”.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-dataset-containeraction.html#cfn-iotanalytics-dataset-containeraction-resourceconfiguration

variables

The values of variables used within the context of the execution of the containerized application (basically, parameters passed to the application).

Each variable must have a name and a value given by one of “stringValue”, “datasetContentVersionValue”, or “outputFileUriValue”.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-dataset-containeraction.html#cfn-iotanalytics-dataset-containeraction-variables

DatasetContentDeliveryRuleDestinationProperty

class CfnDatasetPropsMixin.DatasetContentDeliveryRuleDestinationProperty(*, iot_events_destination_configuration=None, s3_destination_configuration=None)

Bases: object

The destination to which dataset contents are delivered.

Parameters:

• iot_events_destination_configuration (Union[IResolvable, IotEventsDestinationConfigurationProperty, Dict[str, Any], None]) – Configuration information for delivery of dataset contents to AWS IoT Events .

• s3_destination_configuration (Union[IResolvable, S3DestinationConfigurationProperty, Dict[str, Any], None]) – Configuration information for delivery of dataset contents to Amazon S3.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-dataset-datasetcontentdeliveryruledestination.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.mixins_preview.aws_iotanalytics import mixins as iotanalytics_mixins

dataset_content_delivery_rule_destination_property = iotanalytics_mixins.CfnDatasetPropsMixin.DatasetContentDeliveryRuleDestinationProperty(
    iot_events_destination_configuration=iotanalytics_mixins.CfnDatasetPropsMixin.IotEventsDestinationConfigurationProperty(
        input_name="inputName",
        role_arn="roleArn"
    ),
    s3_destination_configuration=iotanalytics_mixins.CfnDatasetPropsMixin.S3DestinationConfigurationProperty(
        bucket="bucket",
        glue_configuration=iotanalytics_mixins.CfnDatasetPropsMixin.GlueConfigurationProperty(
            database_name="databaseName",
            table_name="tableName"
        ),
        key="key",
        role_arn="roleArn"
    )
)

Attributes

iot_events_destination_configuration

Configuration information for delivery of dataset contents to AWS IoT Events .

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-dataset-datasetcontentdeliveryruledestination.html#cfn-iotanalytics-dataset-datasetcontentdeliveryruledestination-ioteventsdestinationconfiguration

s3_destination_configuration

Configuration information for delivery of dataset contents to Amazon S3.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-dataset-datasetcontentdeliveryruledestination.html#cfn-iotanalytics-dataset-datasetcontentdeliveryruledestination-s3destinationconfiguration

DatasetContentDeliveryRuleProperty

class CfnDatasetPropsMixin.DatasetContentDeliveryRuleProperty(*, destination=None, entry_name=None)

Bases: object

When dataset contents are created, they are delivered to destination specified here.

Parameters:

• destination (Union[IResolvable, DatasetContentDeliveryRuleDestinationProperty, Dict[str, Any], None]) – The destination to which dataset contents are delivered.

• entry_name (Optional[str]) – The name of the dataset content delivery rules entry.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-dataset-datasetcontentdeliveryrule.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.mixins_preview.aws_iotanalytics import mixins as iotanalytics_mixins

dataset_content_delivery_rule_property = iotanalytics_mixins.CfnDatasetPropsMixin.DatasetContentDeliveryRuleProperty(
    destination=iotanalytics_mixins.CfnDatasetPropsMixin.DatasetContentDeliveryRuleDestinationProperty(
        iot_events_destination_configuration=iotanalytics_mixins.CfnDatasetPropsMixin.IotEventsDestinationConfigurationProperty(
            input_name="inputName",
            role_arn="roleArn"
        ),
        s3_destination_configuration=iotanalytics_mixins.CfnDatasetPropsMixin.S3DestinationConfigurationProperty(
            bucket="bucket",
            glue_configuration=iotanalytics_mixins.CfnDatasetPropsMixin.GlueConfigurationProperty(
                database_name="databaseName",
                table_name="tableName"
            ),
            key="key",
            role_arn="roleArn"
        )
    ),
    entry_name="entryName"
)

Attributes

destination

The destination to which dataset contents are delivered.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-dataset-datasetcontentdeliveryrule.html#cfn-iotanalytics-dataset-datasetcontentdeliveryrule-destination

entry_name

The name of the dataset content delivery rules entry.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-dataset-datasetcontentdeliveryrule.html#cfn-iotanalytics-dataset-datasetcontentdeliveryrule-entryname

DatasetContentVersionValueProperty

class CfnDatasetPropsMixin.DatasetContentVersionValueProperty(*, dataset_name=None)

Bases: object

The dataset whose latest contents are used as input to the notebook or application.

Parameters:

dataset_name (Optional[str]) – The name of the dataset whose latest contents are used as input to the notebook or application.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-dataset-datasetcontentversionvalue.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.mixins_preview.aws_iotanalytics import mixins as iotanalytics_mixins

dataset_content_version_value_property = iotanalytics_mixins.CfnDatasetPropsMixin.DatasetContentVersionValueProperty(
    dataset_name="datasetName"
)

Attributes

dataset_name

The name of the dataset whose latest contents are used as input to the notebook or application.

See:

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

DeltaTimeProperty

class CfnDatasetPropsMixin.DeltaTimeProperty(*, offset_seconds=None, time_expression=None)

Bases: object

Used to limit data to that which has arrived since the last execution of the action.

Parameters:

• offset_seconds (Union[int, float, None]) – The number of seconds of estimated in-flight lag time of message data. When you create dataset contents using message data from a specified timeframe, some message data might still be in flight when processing begins, and so do not arrive in time to be processed. Use this field to make allowances for the in flight time of your message data, so that data not processed from a previous timeframe is included with the next timeframe. Otherwise, missed message data would be excluded from processing during the next timeframe too, because its timestamp places it within the previous timeframe.

• time_expression (Optional[str]) – An expression by which the time of the message data might be determined. This can be the name of a timestamp field or a SQL expression that is used to derive the time the message data was generated.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-dataset-deltatime.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.mixins_preview.aws_iotanalytics import mixins as iotanalytics_mixins

delta_time_property = iotanalytics_mixins.CfnDatasetPropsMixin.DeltaTimeProperty(
    offset_seconds=123,
    time_expression="timeExpression"
)

Attributes

offset_seconds

The number of seconds of estimated in-flight lag time of message data.

When you create dataset contents using message data from a specified timeframe, some message data might still be in flight when processing begins, and so do not arrive in time to be processed. Use this field to make allowances for the in flight time of your message data, so that data not processed from a previous timeframe is included with the next timeframe. Otherwise, missed message data would be excluded from processing during the next timeframe too, because its timestamp places it within the previous timeframe.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-dataset-deltatime.html#cfn-iotanalytics-dataset-deltatime-offsetseconds

time_expression

An expression by which the time of the message data might be determined.

This can be the name of a timestamp field or a SQL expression that is used to derive the time the message data was generated.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-dataset-deltatime.html#cfn-iotanalytics-dataset-deltatime-timeexpression

DeltaTimeSessionWindowConfigurationProperty

class CfnDatasetPropsMixin.DeltaTimeSessionWindowConfigurationProperty(*, timeout_in_minutes=None)

Bases: object

A structure that contains the configuration information of a delta time session window.

`DeltaTime <https://docs.aws.amazon.com/iotanalytics/latest/APIReference/API_DeltaTime.html>`_ specifies a time interval. You can use DeltaTime to create dataset contents with data that has arrived in the data store since the last execution. For an example of DeltaTime , see Creating a SQL dataset with a delta window (CLI) in the AWS IoT Analytics User Guide .

Parameters:

timeout_in_minutes (Union[int, float, None]) – A time interval. You can use timeoutInMinutes so that AWS IoT Analytics can batch up late data notifications that have been generated since the last execution. AWS IoT Analytics sends one batch of notifications to Amazon CloudWatch Events at one time. For more information about how to write a timestamp expression, see Date and Time Functions and Operators , in the Presto 0.172 Documentation .

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-dataset-deltatimesessionwindowconfiguration.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.mixins_preview.aws_iotanalytics import mixins as iotanalytics_mixins

delta_time_session_window_configuration_property = iotanalytics_mixins.CfnDatasetPropsMixin.DeltaTimeSessionWindowConfigurationProperty(
    timeout_in_minutes=123
)

Attributes

timeout_in_minutes

A time interval.

You can use timeoutInMinutes so that AWS IoT Analytics can batch up late data notifications that have been generated since the last execution. AWS IoT Analytics sends one batch of notifications to Amazon CloudWatch Events at one time.

For more information about how to write a timestamp expression, see Date and Time Functions and Operators , in the Presto 0.172 Documentation .

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-dataset-deltatimesessionwindowconfiguration.html#cfn-iotanalytics-dataset-deltatimesessionwindowconfiguration-timeoutinminutes

FilterProperty

class CfnDatasetPropsMixin.FilterProperty(*, delta_time=None)

Bases: object

Information which is used to filter message data, to segregate it according to the time frame in which it arrives.

Parameters:

delta_time (Union[IResolvable, DeltaTimeProperty, Dict[str, Any], None]) – Used to limit data to that which has arrived since the last execution of the action.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-dataset-filter.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.mixins_preview.aws_iotanalytics import mixins as iotanalytics_mixins

filter_property = iotanalytics_mixins.CfnDatasetPropsMixin.FilterProperty(
    delta_time=iotanalytics_mixins.CfnDatasetPropsMixin.DeltaTimeProperty(
        offset_seconds=123,
        time_expression="timeExpression"
    )
)

Attributes

delta_time

Used to limit data to that which has arrived since the last execution of the action.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-dataset-filter.html#cfn-iotanalytics-dataset-filter-deltatime

GlueConfigurationProperty

class CfnDatasetPropsMixin.GlueConfigurationProperty(*, database_name=None, table_name=None)

Bases: object

Configuration information for coordination with AWS Glue , a fully managed extract, transform and load (ETL) service.

Parameters:

• database_name (Optional[str]) – The name of the database in your AWS Glue Data Catalog in which the table is located. An AWS Glue Data Catalog database contains metadata tables.

• table_name (Optional[str]) – The name of the table in your AWS Glue Data Catalog that is used to perform the ETL operations. An AWS Glue Data Catalog table contains partitioned data and descriptions of data sources and targets.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-dataset-glueconfiguration.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.mixins_preview.aws_iotanalytics import mixins as iotanalytics_mixins

glue_configuration_property = iotanalytics_mixins.CfnDatasetPropsMixin.GlueConfigurationProperty(
    database_name="databaseName",
    table_name="tableName"
)

Attributes

database_name

The name of the database in your AWS Glue Data Catalog in which the table is located.

An AWS Glue Data Catalog database contains metadata tables.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-dataset-glueconfiguration.html#cfn-iotanalytics-dataset-glueconfiguration-databasename

table_name

The name of the table in your AWS Glue Data Catalog that is used to perform the ETL operations.

An AWS Glue Data Catalog table contains partitioned data and descriptions of data sources and targets.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-dataset-glueconfiguration.html#cfn-iotanalytics-dataset-glueconfiguration-tablename

IotEventsDestinationConfigurationProperty

class CfnDatasetPropsMixin.IotEventsDestinationConfigurationProperty(*, input_name=None, role_arn=None)

Bases: object

Configuration information for delivery of dataset contents to AWS IoT Events .

Parameters:

• input_name (Optional[str]) – The name of the AWS IoT Events input to which dataset contents are delivered.

• role_arn (Optional[str]) – The ARN of the role that grants AWS IoT Analytics permission to deliver dataset contents to an AWS IoT Events input.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-dataset-ioteventsdestinationconfiguration.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.mixins_preview.aws_iotanalytics import mixins as iotanalytics_mixins

iot_events_destination_configuration_property = iotanalytics_mixins.CfnDatasetPropsMixin.IotEventsDestinationConfigurationProperty(
    input_name="inputName",
    role_arn="roleArn"
)

Attributes

input_name

The name of the AWS IoT Events input to which dataset contents are delivered.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-dataset-ioteventsdestinationconfiguration.html#cfn-iotanalytics-dataset-ioteventsdestinationconfiguration-inputname

role_arn

The ARN of the role that grants AWS IoT Analytics permission to deliver dataset contents to an AWS IoT Events input.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-dataset-ioteventsdestinationconfiguration.html#cfn-iotanalytics-dataset-ioteventsdestinationconfiguration-rolearn

LateDataRuleConfigurationProperty

class CfnDatasetPropsMixin.LateDataRuleConfigurationProperty(*, delta_time_session_window_configuration=None)

Bases: object

The information needed to configure a delta time session window.

Parameters:

delta_time_session_window_configuration (Union[IResolvable, DeltaTimeSessionWindowConfigurationProperty, Dict[str, Any], None]) – The information needed to configure a delta time session window.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-dataset-latedataruleconfiguration.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.mixins_preview.aws_iotanalytics import mixins as iotanalytics_mixins

late_data_rule_configuration_property = iotanalytics_mixins.CfnDatasetPropsMixin.LateDataRuleConfigurationProperty(
    delta_time_session_window_configuration=iotanalytics_mixins.CfnDatasetPropsMixin.DeltaTimeSessionWindowConfigurationProperty(
        timeout_in_minutes=123
    )
)

Attributes

delta_time_session_window_configuration

The information needed to configure a delta time session window.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-dataset-latedataruleconfiguration.html#cfn-iotanalytics-dataset-latedataruleconfiguration-deltatimesessionwindowconfiguration

LateDataRuleProperty

class CfnDatasetPropsMixin.LateDataRuleProperty(*, rule_configuration=None, rule_name=None)

Bases: object

A structure that contains the name and configuration information of a late data rule.

Parameters:

• rule_configuration (Union[IResolvable, LateDataRuleConfigurationProperty, Dict[str, Any], None]) – The information needed to configure the late data rule.

• rule_name (Optional[str]) – The name of the late data rule.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-dataset-latedatarule.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.mixins_preview.aws_iotanalytics import mixins as iotanalytics_mixins

late_data_rule_property = iotanalytics_mixins.CfnDatasetPropsMixin.LateDataRuleProperty(
    rule_configuration=iotanalytics_mixins.CfnDatasetPropsMixin.LateDataRuleConfigurationProperty(
        delta_time_session_window_configuration=iotanalytics_mixins.CfnDatasetPropsMixin.DeltaTimeSessionWindowConfigurationProperty(
            timeout_in_minutes=123
        )
    ),
    rule_name="ruleName"
)

Attributes

rule_configuration

The information needed to configure the late data rule.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-dataset-latedatarule.html#cfn-iotanalytics-dataset-latedatarule-ruleconfiguration

rule_name

The name of the late data rule.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-dataset-latedatarule.html#cfn-iotanalytics-dataset-latedatarule-rulename

OutputFileUriValueProperty

class CfnDatasetPropsMixin.OutputFileUriValueProperty(*, file_name=None)

Bases: object

The value of the variable as a structure that specifies an output file URI.

Parameters:

file_name (Optional[str]) – The URI of the location where dataset contents are stored, usually the URI of a file in an S3 bucket.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-dataset-outputfileurivalue.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.mixins_preview.aws_iotanalytics import mixins as iotanalytics_mixins

output_file_uri_value_property = iotanalytics_mixins.CfnDatasetPropsMixin.OutputFileUriValueProperty(
    file_name="fileName"
)

Attributes

file_name

The URI of the location where dataset contents are stored, usually the URI of a file in an S3 bucket.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-dataset-outputfileurivalue.html#cfn-iotanalytics-dataset-outputfileurivalue-filename

QueryActionProperty

class CfnDatasetPropsMixin.QueryActionProperty(*, filters=None, sql_query=None)

Bases: object

An “SqlQueryDatasetAction” object that uses an SQL query to automatically create data set contents.

Parameters:

• filters (Union[IResolvable, Sequence[Union[IResolvable, FilterProperty, Dict[str, Any]]], None]) – Pre-filters applied to message data.

• sql_query (Optional[str]) – An “SqlQueryDatasetAction” object that uses an SQL query to automatically create data set contents.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-dataset-queryaction.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.mixins_preview.aws_iotanalytics import mixins as iotanalytics_mixins

query_action_property = iotanalytics_mixins.CfnDatasetPropsMixin.QueryActionProperty(
    filters=[iotanalytics_mixins.CfnDatasetPropsMixin.FilterProperty(
        delta_time=iotanalytics_mixins.CfnDatasetPropsMixin.DeltaTimeProperty(
            offset_seconds=123,
            time_expression="timeExpression"
        )
    )],
    sql_query="sqlQuery"
)

Attributes

filters

Pre-filters applied to message data.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-dataset-queryaction.html#cfn-iotanalytics-dataset-queryaction-filters

sql_query

An “SqlQueryDatasetAction” object that uses an SQL query to automatically create data set contents.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-dataset-queryaction.html#cfn-iotanalytics-dataset-queryaction-sqlquery

ResourceConfigurationProperty

class CfnDatasetPropsMixin.ResourceConfigurationProperty(*, compute_type=None, volume_size_in_gb=None)

Bases: object

The configuration of the resource used to execute the containerAction .

Parameters:

• compute_type (Optional[str]) – The type of the compute resource used to execute the containerAction . Possible values are: ACU_1 (vCPU=4, memory=16 GiB) or ACU_2 (vCPU=8, memory=32 GiB).

• volume_size_in_gb (Union[int, float, None]) – The size, in GB, of the persistent storage available to the resource instance used to execute the containerAction (min: 1, max: 50).

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-dataset-resourceconfiguration.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.mixins_preview.aws_iotanalytics import mixins as iotanalytics_mixins

resource_configuration_property = iotanalytics_mixins.CfnDatasetPropsMixin.ResourceConfigurationProperty(
    compute_type="computeType",
    volume_size_in_gb=123
)

Attributes

compute_type

The type of the compute resource used to execute the containerAction .

Possible values are: ACU_1 (vCPU=4, memory=16 GiB) or ACU_2 (vCPU=8, memory=32 GiB).

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-dataset-resourceconfiguration.html#cfn-iotanalytics-dataset-resourceconfiguration-computetype

volume_size_in_gb

50).

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-dataset-resourceconfiguration.html#cfn-iotanalytics-dataset-resourceconfiguration-volumesizeingb

Type:

The size, in GB, of the persistent storage available to the resource instance used to execute the containerAction (min

Type:

1, max

RetentionPeriodProperty

class CfnDatasetPropsMixin.RetentionPeriodProperty(*, number_of_days=None, unlimited=None)

Bases: object

How long, in days, message data is kept.

Parameters:

• number_of_days (Union[int, float, None]) – The number of days that message data is kept. The unlimited parameter must be false.

• unlimited (Union[bool, IResolvable, None]) – If true, message data is kept indefinitely.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-dataset-retentionperiod.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.mixins_preview.aws_iotanalytics import mixins as iotanalytics_mixins

retention_period_property = iotanalytics_mixins.CfnDatasetPropsMixin.RetentionPeriodProperty(
    number_of_days=123,
    unlimited=False
)

Attributes

number_of_days

The number of days that message data is kept.

The unlimited parameter must be false.

See:

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

unlimited

If true, message data is kept indefinitely.

See:

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

S3DestinationConfigurationProperty

class CfnDatasetPropsMixin.S3DestinationConfigurationProperty(*, bucket=None, glue_configuration=None, key=None, role_arn=None)

Bases: object

Configuration information for delivery of dataset contents to Amazon Simple Storage Service (Amazon S3).

Parameters:

• bucket (Optional[str]) – The name of the S3 bucket to which dataset contents are delivered.

• glue_configuration (Union[IResolvable, GlueConfigurationProperty, Dict[str, Any], None]) – Configuration information for coordination with AWS Glue , a fully managed extract, transform and load (ETL) service.

• key (Optional[str]) – The key of the dataset contents object in an S3 bucket. Each object has a key that is a unique identifier. Each object has exactly one key. You can create a unique key with the following options: - Use !{iotanalytics:scheduleTime} to insert the time of a scheduled SQL query run. - Use !{iotanalytics:versionId} to insert a unique hash that identifies a dataset content. - Use !{iotanalytics:creationTime} to insert the creation time of a dataset content. The following example creates a unique key for a CSV file: dataset/mydataset/!{iotanalytics:scheduleTime}/!{iotanalytics:versionId}.csv .. epigraph:: If you don’t use !{iotanalytics:versionId} to specify the key, you might get duplicate keys. For example, you might have two dataset contents with the same scheduleTime but different versionId s. This means that one dataset content overwrites the other.

• role_arn (Optional[str]) – The ARN of the role that grants AWS IoT Analytics permission to interact with your Amazon S3 and AWS Glue resources.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-dataset-s3destinationconfiguration.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.mixins_preview.aws_iotanalytics import mixins as iotanalytics_mixins

s3_destination_configuration_property = iotanalytics_mixins.CfnDatasetPropsMixin.S3DestinationConfigurationProperty(
    bucket="bucket",
    glue_configuration=iotanalytics_mixins.CfnDatasetPropsMixin.GlueConfigurationProperty(
        database_name="databaseName",
        table_name="tableName"
    ),
    key="key",
    role_arn="roleArn"
)

Attributes

bucket

The name of the S3 bucket to which dataset contents are delivered.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-dataset-s3destinationconfiguration.html#cfn-iotanalytics-dataset-s3destinationconfiguration-bucket

glue_configuration

Configuration information for coordination with AWS Glue , a fully managed extract, transform and load (ETL) service.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-dataset-s3destinationconfiguration.html#cfn-iotanalytics-dataset-s3destinationconfiguration-glueconfiguration

key

The key of the dataset contents object in an S3 bucket.

Each object has a key that is a unique identifier. Each object has exactly one key.

You can create a unique key with the following options:

• Use !{iotanalytics:scheduleTime} to insert the time of a scheduled SQL query run.

• Use !{iotanalytics:versionId} to insert a unique hash that identifies a dataset content.

• Use !{iotanalytics:creationTime} to insert the creation time of a dataset content.

The following example creates a unique key for a CSV file: dataset/mydataset/!{iotanalytics:scheduleTime}/!{iotanalytics:versionId}.csv .. epigraph:

If you don't use ``!{iotanalytics:versionId}`` to specify the key, you might get duplicate keys. For example, you might have two dataset contents with the same ``scheduleTime`` but different ``versionId`` s. This means that one dataset content overwrites the other.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-dataset-s3destinationconfiguration.html#cfn-iotanalytics-dataset-s3destinationconfiguration-key

role_arn

The ARN of the role that grants AWS IoT Analytics permission to interact with your Amazon S3 and AWS Glue resources.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-dataset-s3destinationconfiguration.html#cfn-iotanalytics-dataset-s3destinationconfiguration-rolearn

ScheduleProperty

class CfnDatasetPropsMixin.ScheduleProperty(*, schedule_expression=None)

Bases: object

The schedule for when to trigger an update.

Parameters:

schedule_expression (Optional[str]) – The expression that defines when to trigger an update. For more information, see Schedule Expressions for Rules in the Amazon CloudWatch documentation.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-dataset-schedule.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.mixins_preview.aws_iotanalytics import mixins as iotanalytics_mixins

schedule_property = iotanalytics_mixins.CfnDatasetPropsMixin.ScheduleProperty(
    schedule_expression="scheduleExpression"
)

Attributes

schedule_expression

The expression that defines when to trigger an update.

For more information, see Schedule Expressions for Rules in the Amazon CloudWatch documentation.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-dataset-schedule.html#cfn-iotanalytics-dataset-schedule-scheduleexpression

TriggerProperty

class CfnDatasetPropsMixin.TriggerProperty(*, schedule=None, triggering_dataset=None)

Bases: object

The “DatasetTrigger” that specifies when the data set is automatically updated.

Parameters:

• schedule (Union[IResolvable, ScheduleProperty, Dict[str, Any], None]) – The “Schedule” when the trigger is initiated.

• triggering_dataset (Union[IResolvable, TriggeringDatasetProperty, Dict[str, Any], None]) – Information about the data set whose content generation triggers the new data set content generation.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-dataset-trigger.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.mixins_preview.aws_iotanalytics import mixins as iotanalytics_mixins

trigger_property = iotanalytics_mixins.CfnDatasetPropsMixin.TriggerProperty(
    schedule=iotanalytics_mixins.CfnDatasetPropsMixin.ScheduleProperty(
        schedule_expression="scheduleExpression"
    ),
    triggering_dataset=iotanalytics_mixins.CfnDatasetPropsMixin.TriggeringDatasetProperty(
        dataset_name="datasetName"
    )
)

Attributes

schedule

The “Schedule” when the trigger is initiated.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-dataset-trigger.html#cfn-iotanalytics-dataset-trigger-schedule

triggering_dataset

Information about the data set whose content generation triggers the new data set content generation.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-dataset-trigger.html#cfn-iotanalytics-dataset-trigger-triggeringdataset

TriggeringDatasetProperty

class CfnDatasetPropsMixin.TriggeringDatasetProperty(*, dataset_name=None)

Bases: object

Information about the dataset whose content generation triggers the new dataset content generation.

Parameters:

dataset_name (Optional[str]) – The name of the data set whose content generation triggers the new data set content generation.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-dataset-triggeringdataset.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.mixins_preview.aws_iotanalytics import mixins as iotanalytics_mixins

triggering_dataset_property = iotanalytics_mixins.CfnDatasetPropsMixin.TriggeringDatasetProperty(
    dataset_name="datasetName"
)

Attributes

dataset_name

The name of the data set whose content generation triggers the new data set content generation.

See:

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

VariableProperty

class CfnDatasetPropsMixin.VariableProperty(*, dataset_content_version_value=None, double_value=None, output_file_uri_value=None, string_value=None, variable_name=None)

Bases: object

An instance of a variable to be passed to the containerAction execution.

Each variable must have a name and a value given by one of stringValue , datasetContentVersionValue , or outputFileUriValue .

Parameters:

• dataset_content_version_value (Union[IResolvable, DatasetContentVersionValueProperty, Dict[str, Any], None]) – The value of the variable as a structure that specifies a dataset content version.

• double_value (Union[int, float, None]) – The value of the variable as a double (numeric).

• output_file_uri_value (Union[IResolvable, OutputFileUriValueProperty, Dict[str, Any], None]) – The value of the variable as a structure that specifies an output file URI.

• string_value (Optional[str]) – The value of the variable as a string.

• variable_name (Optional[str]) – The name of the variable.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-dataset-variable.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.mixins_preview.aws_iotanalytics import mixins as iotanalytics_mixins

variable_property = iotanalytics_mixins.CfnDatasetPropsMixin.VariableProperty(
    dataset_content_version_value=iotanalytics_mixins.CfnDatasetPropsMixin.DatasetContentVersionValueProperty(
        dataset_name="datasetName"
    ),
    double_value=123,
    output_file_uri_value=iotanalytics_mixins.CfnDatasetPropsMixin.OutputFileUriValueProperty(
        file_name="fileName"
    ),
    string_value="stringValue",
    variable_name="variableName"
)

Attributes

dataset_content_version_value

The value of the variable as a structure that specifies a dataset content version.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-dataset-variable.html#cfn-iotanalytics-dataset-variable-datasetcontentversionvalue

double_value

The value of the variable as a double (numeric).

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-dataset-variable.html#cfn-iotanalytics-dataset-variable-doublevalue

output_file_uri_value

The value of the variable as a structure that specifies an output file URI.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-dataset-variable.html#cfn-iotanalytics-dataset-variable-outputfileurivalue

string_value

The value of the variable as a string.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-dataset-variable.html#cfn-iotanalytics-dataset-variable-stringvalue

variable_name

The name of the variable.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-dataset-variable.html#cfn-iotanalytics-dataset-variable-variablename

VersioningConfigurationProperty

class CfnDatasetPropsMixin.VersioningConfigurationProperty(*, max_versions=None, unlimited=None)

Bases: object

Information about the versioning of dataset contents.

Parameters:

• max_versions (Union[int, float, None]) – How many versions of dataset contents are kept. The unlimited parameter must be false .

• unlimited (Union[bool, IResolvable, None]) – If true, unlimited versions of dataset contents are kept.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-dataset-versioningconfiguration.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.mixins_preview.aws_iotanalytics import mixins as iotanalytics_mixins

versioning_configuration_property = iotanalytics_mixins.CfnDatasetPropsMixin.VersioningConfigurationProperty(
    max_versions=123,
    unlimited=False
)

Attributes

max_versions

How many versions of dataset contents are kept.

The unlimited parameter must be false .

See:

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

unlimited

If true, unlimited versions of dataset contents are kept.

See:

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