CfnCampaignPropsMixin

class aws_cdk.mixins_preview.aws_iotfleetwise.mixins.CfnCampaignPropsMixin(props, *, strategy=None)

Bases: Mixin

Creates an orchestration of data collection rules.

The AWS IoT FleetWise Edge Agent software running in vehicles uses campaigns to decide how to collect and transfer data to the cloud. You create campaigns in the cloud. After you or your team approve campaigns, AWS IoT FleetWise automatically deploys them to vehicles.

For more information, see Campaigns in the AWS IoT FleetWise Developer Guide . .. epigraph:

Access to certain AWS IoT FleetWise features is currently gated. For more information, see `AWS Region and feature availability <https://docs.aws.amazon.com/iot-fleetwise/latest/developerguide/fleetwise-regions.html>`_ in the *AWS IoT FleetWise Developer Guide* .

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotfleetwise-campaign.html
CloudformationResource:: AWS::IoTFleetWise::Campaign
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_iotfleetwise import mixins as iotfleetwise_mixins

cfn_campaign_props_mixin = iotfleetwise_mixins.CfnCampaignPropsMixin(iotfleetwise_mixins.CfnCampaignMixinProps(
    action="action",
    collection_scheme=iotfleetwise_mixins.CfnCampaignPropsMixin.CollectionSchemeProperty(
        condition_based_collection_scheme=iotfleetwise_mixins.CfnCampaignPropsMixin.ConditionBasedCollectionSchemeProperty(
            condition_language_version=123,
            expression="expression",
            minimum_trigger_interval_ms=123,
            trigger_mode="triggerMode"
        ),
        time_based_collection_scheme=iotfleetwise_mixins.CfnCampaignPropsMixin.TimeBasedCollectionSchemeProperty(
            period_ms=123
        )
    ),
    compression="compression",
    data_destination_configs=[iotfleetwise_mixins.CfnCampaignPropsMixin.DataDestinationConfigProperty(
        mqtt_topic_config=iotfleetwise_mixins.CfnCampaignPropsMixin.MqttTopicConfigProperty(
            execution_role_arn="executionRoleArn",
            mqtt_topic_arn="mqttTopicArn"
        ),
        s3_config=iotfleetwise_mixins.CfnCampaignPropsMixin.S3ConfigProperty(
            bucket_arn="bucketArn",
            data_format="dataFormat",
            prefix="prefix",
            storage_compression_format="storageCompressionFormat"
        ),
        timestream_config=iotfleetwise_mixins.CfnCampaignPropsMixin.TimestreamConfigProperty(
            execution_role_arn="executionRoleArn",
            timestream_table_arn="timestreamTableArn"
        )
    )],
    data_extra_dimensions=["dataExtraDimensions"],
    data_partitions=[iotfleetwise_mixins.CfnCampaignPropsMixin.DataPartitionProperty(
        id="id",
        storage_options=iotfleetwise_mixins.CfnCampaignPropsMixin.DataPartitionStorageOptionsProperty(
            maximum_size=iotfleetwise_mixins.CfnCampaignPropsMixin.StorageMaximumSizeProperty(
                unit="unit",
                value=123
            ),
            minimum_time_to_live=iotfleetwise_mixins.CfnCampaignPropsMixin.StorageMinimumTimeToLiveProperty(
                unit="unit",
                value=123
            ),
            storage_location="storageLocation"
        ),
        upload_options=iotfleetwise_mixins.CfnCampaignPropsMixin.DataPartitionUploadOptionsProperty(
            condition_language_version=123,
            expression="expression"
        )
    )],
    description="description",
    diagnostics_mode="diagnosticsMode",
    expiry_time="expiryTime",
    name="name",
    post_trigger_collection_duration=123,
    priority=123,
    signal_catalog_arn="signalCatalogArn",
    signals_to_collect=[iotfleetwise_mixins.CfnCampaignPropsMixin.SignalInformationProperty(
        data_partition_id="dataPartitionId",
        max_sample_count=123,
        minimum_sampling_interval_ms=123,
        name="name"
    )],
    signals_to_fetch=[iotfleetwise_mixins.CfnCampaignPropsMixin.SignalFetchInformationProperty(
        actions=["actions"],
        condition_language_version=123,
        fully_qualified_name="fullyQualifiedName",
        signal_fetch_config=iotfleetwise_mixins.CfnCampaignPropsMixin.SignalFetchConfigProperty(
            condition_based=iotfleetwise_mixins.CfnCampaignPropsMixin.ConditionBasedSignalFetchConfigProperty(
                condition_expression="conditionExpression",
                trigger_mode="triggerMode"
            ),
            time_based=iotfleetwise_mixins.CfnCampaignPropsMixin.TimeBasedSignalFetchConfigProperty(
                execution_frequency_ms=123
            )
        )
    )],
    spooling_mode="spoolingMode",
    start_time="startTime",
    tags=[CfnTag(
        key="key",
        value="value"
    )],
    target_arn="targetArn"
),
    strategy=mixins.PropertyMergeStrategy.OVERRIDE
)

Create a mixin to apply properties to AWS::IoTFleetWise::Campaign.

Parameters:

props (Union[CfnCampaignMixinProps, 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 = ['action', 'collectionScheme', 'compression', 'dataDestinationConfigs', 'dataExtraDimensions', 'dataPartitions', 'description', 'diagnosticsMode', 'expiryTime', 'name', 'postTriggerCollectionDuration', 'priority', 'signalCatalogArn', 'signalsToCollect', 'signalsToFetch', 'spoolingMode', 'startTime', 'tags', 'targetArn']

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

CollectionSchemeProperty

class CfnCampaignPropsMixin.CollectionSchemeProperty(*, condition_based_collection_scheme=None, time_based_collection_scheme=None)

Bases: object

Specifies what data to collect and how often or when to collect it.

Parameters:

condition_based_collection_scheme (Union[IResolvable, ConditionBasedCollectionSchemeProperty, Dict[str, Any], None]) – Information about a collection scheme that uses a simple logical expression to recognize what data to collect.
time_based_collection_scheme (Union[IResolvable, TimeBasedCollectionSchemeProperty, Dict[str, Any], None]) – Information about a collection scheme that uses a time period to decide how often to collect data.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotfleetwise-campaign-collectionscheme.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_iotfleetwise import mixins as iotfleetwise_mixins

collection_scheme_property = iotfleetwise_mixins.CfnCampaignPropsMixin.CollectionSchemeProperty(
    condition_based_collection_scheme=iotfleetwise_mixins.CfnCampaignPropsMixin.ConditionBasedCollectionSchemeProperty(
        condition_language_version=123,
        expression="expression",
        minimum_trigger_interval_ms=123,
        trigger_mode="triggerMode"
    ),
    time_based_collection_scheme=iotfleetwise_mixins.CfnCampaignPropsMixin.TimeBasedCollectionSchemeProperty(
        period_ms=123
    )
)

Attributes

condition_based_collection_scheme

Information about a collection scheme that uses a simple logical expression to recognize what data to collect.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotfleetwise-campaign-collectionscheme.html#cfn-iotfleetwise-campaign-collectionscheme-conditionbasedcollectionscheme

time_based_collection_scheme

Information about a collection scheme that uses a time period to decide how often to collect data.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotfleetwise-campaign-collectionscheme.html#cfn-iotfleetwise-campaign-collectionscheme-timebasedcollectionscheme

ConditionBasedCollectionSchemeProperty

class CfnCampaignPropsMixin.ConditionBasedCollectionSchemeProperty(*, condition_language_version=None, expression=None, minimum_trigger_interval_ms=None, trigger_mode=None)

Bases: object

Information about a collection scheme that uses a simple logical expression to recognize what data to collect.

Parameters:

condition_language_version (Union[int, float, None]) – Specifies the version of the conditional expression language.
expression (Optional[str]) – The logical expression used to recognize what data to collect. For example, $variable.Vehicle.OutsideAirTemperature >= 105.0 .
minimum_trigger_interval_ms (Union[int, float, None]) – The minimum duration of time between two triggering events to collect data, in milliseconds. .. epigraph:: If a signal changes often, you might want to collect data at a slower rate.
trigger_mode (Optional[str]) – Whether to collect data for all triggering events ( ALWAYS ). Specify ( RISING_EDGE ), or specify only when the condition first evaluates to false. For example, triggering on “AirbagDeployed”; Users aren’t interested on triggering when the airbag is already exploded; they only care about the change from not deployed => deployed.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotfleetwise-campaign-conditionbasedcollectionscheme.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_iotfleetwise import mixins as iotfleetwise_mixins

condition_based_collection_scheme_property = iotfleetwise_mixins.CfnCampaignPropsMixin.ConditionBasedCollectionSchemeProperty(
    condition_language_version=123,
    expression="expression",
    minimum_trigger_interval_ms=123,
    trigger_mode="triggerMode"
)

Attributes

condition_language_version

Specifies the version of the conditional expression language.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotfleetwise-campaign-conditionbasedcollectionscheme.html#cfn-iotfleetwise-campaign-conditionbasedcollectionscheme-conditionlanguageversion

expression

The logical expression used to recognize what data to collect.

For example, $variable.Vehicle.OutsideAirTemperature >= 105.0 .

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotfleetwise-campaign-conditionbasedcollectionscheme.html#cfn-iotfleetwise-campaign-conditionbasedcollectionscheme-expression

minimum_trigger_interval_ms

The minimum duration of time between two triggering events to collect data, in milliseconds.

If a signal changes often, you might want to collect data at a slower rate.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotfleetwise-campaign-conditionbasedcollectionscheme.html#cfn-iotfleetwise-campaign-conditionbasedcollectionscheme-minimumtriggerintervalms

trigger_mode

Whether to collect data for all triggering events ( ALWAYS ).

Specify ( RISING_EDGE ), or specify only when the condition first evaluates to false. For example, triggering on “AirbagDeployed”; Users aren’t interested on triggering when the airbag is already exploded; they only care about the change from not deployed => deployed.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotfleetwise-campaign-conditionbasedcollectionscheme.html#cfn-iotfleetwise-campaign-conditionbasedcollectionscheme-triggermode

ConditionBasedSignalFetchConfigProperty

class CfnCampaignPropsMixin.ConditionBasedSignalFetchConfigProperty(*, condition_expression=None, trigger_mode=None)

Bases: object

Specifies the condition under which a signal fetch occurs.

Parameters:

condition_expression (Optional[str]) – The condition that must be satisfied to trigger a signal fetch.
trigger_mode (Optional[str]) – Indicates the mode in which the signal fetch is triggered.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotfleetwise-campaign-conditionbasedsignalfetchconfig.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_iotfleetwise import mixins as iotfleetwise_mixins

condition_based_signal_fetch_config_property = iotfleetwise_mixins.CfnCampaignPropsMixin.ConditionBasedSignalFetchConfigProperty(
    condition_expression="conditionExpression",
    trigger_mode="triggerMode"
)

Attributes

condition_expression

The condition that must be satisfied to trigger a signal fetch.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotfleetwise-campaign-conditionbasedsignalfetchconfig.html#cfn-iotfleetwise-campaign-conditionbasedsignalfetchconfig-conditionexpression

trigger_mode

Indicates the mode in which the signal fetch is triggered.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotfleetwise-campaign-conditionbasedsignalfetchconfig.html#cfn-iotfleetwise-campaign-conditionbasedsignalfetchconfig-triggermode

DataDestinationConfigProperty

class CfnCampaignPropsMixin.DataDestinationConfigProperty(*, mqtt_topic_config=None, s3_config=None, timestream_config=None)

Bases: object

The destination where the AWS IoT FleetWise campaign sends data.

You can send data to be stored in Amazon S3 or Amazon Timestream .

Parameters:

mqtt_topic_config (Union[IResolvable, MqttTopicConfigProperty, Dict[str, Any], None]) – The MQTT topic to which the AWS IoT FleetWise campaign routes data. .. epigraph:: Access to certain AWS IoT FleetWise features is currently gated. For more information, see AWS Region and feature availability in the AWS IoT FleetWise Developer Guide .
s3_config (Union[IResolvable, S3ConfigProperty, Dict[str, Any], None]) – The Amazon S3 bucket where the AWS IoT FleetWise campaign sends data.
timestream_config (Union[IResolvable, TimestreamConfigProperty, Dict[str, Any], None]) – The Amazon Timestream table where the campaign sends data.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotfleetwise-campaign-datadestinationconfig.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_iotfleetwise import mixins as iotfleetwise_mixins

data_destination_config_property = iotfleetwise_mixins.CfnCampaignPropsMixin.DataDestinationConfigProperty(
    mqtt_topic_config=iotfleetwise_mixins.CfnCampaignPropsMixin.MqttTopicConfigProperty(
        execution_role_arn="executionRoleArn",
        mqtt_topic_arn="mqttTopicArn"
    ),
    s3_config=iotfleetwise_mixins.CfnCampaignPropsMixin.S3ConfigProperty(
        bucket_arn="bucketArn",
        data_format="dataFormat",
        prefix="prefix",
        storage_compression_format="storageCompressionFormat"
    ),
    timestream_config=iotfleetwise_mixins.CfnCampaignPropsMixin.TimestreamConfigProperty(
        execution_role_arn="executionRoleArn",
        timestream_table_arn="timestreamTableArn"
    )
)

Attributes

mqtt_topic_config

The MQTT topic to which the AWS IoT FleetWise campaign routes data.

Access to certain AWS IoT FleetWise features is currently gated. For more information, see AWS Region and feature availability in the AWS IoT FleetWise Developer Guide .

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotfleetwise-campaign-datadestinationconfig.html#cfn-iotfleetwise-campaign-datadestinationconfig-mqtttopicconfig

s3_config

The Amazon S3 bucket where the AWS IoT FleetWise campaign sends data.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotfleetwise-campaign-datadestinationconfig.html#cfn-iotfleetwise-campaign-datadestinationconfig-s3config

timestream_config

The Amazon Timestream table where the campaign sends data.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotfleetwise-campaign-datadestinationconfig.html#cfn-iotfleetwise-campaign-datadestinationconfig-timestreamconfig

DataPartitionProperty

class CfnCampaignPropsMixin.DataPartitionProperty(*, id=None, storage_options=None, upload_options=None)

Bases: object

The configuration for signal data storage and upload options.

You can only specify these options when the campaign’s spooling mode is TO_DISK . .. epigraph:

Access to certain AWS IoT FleetWise features is currently gated. For more information, see `AWS Region and feature availability <https://docs.aws.amazon.com/iot-fleetwise/latest/developerguide/fleetwise-regions.html>`_ in the *AWS IoT FleetWise Developer Guide* .

Parameters:

id (Optional[str]) – The ID of the data partition. The data partition ID must be unique within a campaign. You can establish a data partition as the default partition for a campaign by using default as the ID.
storage_options (Union[IResolvable, DataPartitionStorageOptionsProperty, Dict[str, Any], None]) – The storage options for a data partition.
upload_options (Union[IResolvable, DataPartitionUploadOptionsProperty, Dict[str, Any], None]) – The upload options for the data partition.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotfleetwise-campaign-datapartition.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_iotfleetwise import mixins as iotfleetwise_mixins

data_partition_property = iotfleetwise_mixins.CfnCampaignPropsMixin.DataPartitionProperty(
    id="id",
    storage_options=iotfleetwise_mixins.CfnCampaignPropsMixin.DataPartitionStorageOptionsProperty(
        maximum_size=iotfleetwise_mixins.CfnCampaignPropsMixin.StorageMaximumSizeProperty(
            unit="unit",
            value=123
        ),
        minimum_time_to_live=iotfleetwise_mixins.CfnCampaignPropsMixin.StorageMinimumTimeToLiveProperty(
            unit="unit",
            value=123
        ),
        storage_location="storageLocation"
    ),
    upload_options=iotfleetwise_mixins.CfnCampaignPropsMixin.DataPartitionUploadOptionsProperty(
        condition_language_version=123,
        expression="expression"
    )
)

Attributes

id

The ID of the data partition.

The data partition ID must be unique within a campaign. You can establish a data partition as the default partition for a campaign by using default as the ID.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotfleetwise-campaign-datapartition.html#cfn-iotfleetwise-campaign-datapartition-id

storage_options

The storage options for a data partition.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotfleetwise-campaign-datapartition.html#cfn-iotfleetwise-campaign-datapartition-storageoptions

upload_options

The upload options for the data partition.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotfleetwise-campaign-datapartition.html#cfn-iotfleetwise-campaign-datapartition-uploadoptions

DataPartitionStorageOptionsProperty

class CfnCampaignPropsMixin.DataPartitionStorageOptionsProperty(*, maximum_size=None, minimum_time_to_live=None, storage_location=None)

Bases: object

Size, time, and location options for the data partition.

Parameters:

maximum_size (Union[IResolvable, StorageMaximumSizeProperty, Dict[str, Any], None]) – The maximum storage size of the data stored in the data partition. .. epigraph:: Newer data overwrites older data when the partition reaches the maximum size.
minimum_time_to_live (Union[IResolvable, StorageMinimumTimeToLiveProperty, Dict[str, Any], None]) – The amount of time that data in this partition will be kept on disk. - After the designated amount of time passes, the data can be removed, but it’s not guaranteed to be removed. - Before the time expires, data in this partition can still be deleted if the partition reaches its configured maximum size. - Newer data will overwrite older data when the partition reaches the maximum size.
storage_location (Optional[str]) – The folder name for the data partition under the campaign storage folder.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotfleetwise-campaign-datapartitionstorageoptions.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_iotfleetwise import mixins as iotfleetwise_mixins

data_partition_storage_options_property = iotfleetwise_mixins.CfnCampaignPropsMixin.DataPartitionStorageOptionsProperty(
    maximum_size=iotfleetwise_mixins.CfnCampaignPropsMixin.StorageMaximumSizeProperty(
        unit="unit",
        value=123
    ),
    minimum_time_to_live=iotfleetwise_mixins.CfnCampaignPropsMixin.StorageMinimumTimeToLiveProperty(
        unit="unit",
        value=123
    ),
    storage_location="storageLocation"
)

Attributes

maximum_size

The maximum storage size of the data stored in the data partition.

Newer data overwrites older data when the partition reaches the maximum size.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotfleetwise-campaign-datapartitionstorageoptions.html#cfn-iotfleetwise-campaign-datapartitionstorageoptions-maximumsize

minimum_time_to_live

The amount of time that data in this partition will be kept on disk.

After the designated amount of time passes, the data can be removed, but it’s not guaranteed to be removed.
Before the time expires, data in this partition can still be deleted if the partition reaches its configured maximum size.
Newer data will overwrite older data when the partition reaches the maximum size.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotfleetwise-campaign-datapartitionstorageoptions.html#cfn-iotfleetwise-campaign-datapartitionstorageoptions-minimumtimetolive

storage_location

The folder name for the data partition under the campaign storage folder.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotfleetwise-campaign-datapartitionstorageoptions.html#cfn-iotfleetwise-campaign-datapartitionstorageoptions-storagelocation

DataPartitionUploadOptionsProperty

class CfnCampaignPropsMixin.DataPartitionUploadOptionsProperty(*, condition_language_version=None, expression=None)

Bases: object

The upload options for the data partition.

If upload options are specified, you must also specify storage options. See DataPartitionStorageOptions . .. epigraph:

Access to certain AWS IoT FleetWise features is currently gated. For more information, see `AWS Region and feature availability <https://docs.aws.amazon.com/iot-fleetwise/latest/developerguide/fleetwise-regions.html>`_ in the *AWS IoT FleetWise Developer Guide* .

Parameters:

condition_language_version (Union[int, float, None]) – The version of the condition language. Defaults to the most recent condition language version.
expression (Optional[str]) – The logical expression used to recognize what data to collect. For example, $variable.``Vehicle.OutsideAirTemperature >= 105.0`` .

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotfleetwise-campaign-datapartitionuploadoptions.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_iotfleetwise import mixins as iotfleetwise_mixins

data_partition_upload_options_property = iotfleetwise_mixins.CfnCampaignPropsMixin.DataPartitionUploadOptionsProperty(
    condition_language_version=123,
    expression="expression"
)

Attributes

condition_language_version

The version of the condition language.

Defaults to the most recent condition language version.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotfleetwise-campaign-datapartitionuploadoptions.html#cfn-iotfleetwise-campaign-datapartitionuploadoptions-conditionlanguageversion

expression

The logical expression used to recognize what data to collect.

For example, $variable.``Vehicle.OutsideAirTemperature >= 105.0`` .

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotfleetwise-campaign-datapartitionuploadoptions.html#cfn-iotfleetwise-campaign-datapartitionuploadoptions-expression

MqttTopicConfigProperty

class CfnCampaignPropsMixin.MqttTopicConfigProperty(*, execution_role_arn=None, mqtt_topic_arn=None)

Bases: object

The MQTT topic to which the AWS IoT FleetWise campaign routes data.

For more information, see Device communication protocols in the AWS IoT Core Developer Guide . .. epigraph:

Access to certain AWS IoT FleetWise features is currently gated. For more information, see `AWS Region and feature availability <https://docs.aws.amazon.com/iot-fleetwise/latest/developerguide/fleetwise-regions.html>`_ in the *AWS IoT FleetWise Developer Guide* .

Parameters:

execution_role_arn (Optional[str]) – The ARN of the role that grants AWS IoT FleetWise permission to access and act on messages sent to the MQTT topic.
mqtt_topic_arn (Optional[str]) – The ARN of the MQTT topic.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotfleetwise-campaign-mqtttopicconfig.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_iotfleetwise import mixins as iotfleetwise_mixins

mqtt_topic_config_property = iotfleetwise_mixins.CfnCampaignPropsMixin.MqttTopicConfigProperty(
    execution_role_arn="executionRoleArn",
    mqtt_topic_arn="mqttTopicArn"
)

Attributes

execution_role_arn

The ARN of the role that grants AWS IoT FleetWise permission to access and act on messages sent to the MQTT topic.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotfleetwise-campaign-mqtttopicconfig.html#cfn-iotfleetwise-campaign-mqtttopicconfig-executionrolearn

mqtt_topic_arn

The ARN of the MQTT topic.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotfleetwise-campaign-mqtttopicconfig.html#cfn-iotfleetwise-campaign-mqtttopicconfig-mqtttopicarn

S3ConfigProperty

class CfnCampaignPropsMixin.S3ConfigProperty(*, bucket_arn=None, data_format=None, prefix=None, storage_compression_format=None)

Bases: object

The Amazon S3 bucket where the AWS IoT FleetWise campaign sends data.

Amazon S3 is an object storage service that stores data as objects within buckets. For more information, see Creating, configuring, and working with Amazon S3 buckets in the Amazon Simple Storage Service User Guide .

Parameters:

bucket_arn (Optional[str]) – The Amazon Resource Name (ARN) of the Amazon S3 bucket.
data_format (Optional[str]) – Specify the format that files are saved in the Amazon S3 bucket. You can save files in an Apache Parquet or JSON format. - Parquet - Store data in a columnar storage file format. Parquet is optimal for fast data retrieval and can reduce costs. This option is selected by default. - JSON - Store data in a standard text-based JSON file format.
prefix (Optional[str]) – Enter an S3 bucket prefix. The prefix is the string of characters after the bucket name and before the object name. You can use the prefix to organize data stored in Amazon S3 buckets. For more information, see Organizing objects using prefixes in the Amazon Simple Storage Service User Guide . By default, AWS IoT FleetWise sets the prefix processed-data/year=YY/month=MM/date=DD/hour=HH/ (in UTC) to data it delivers to Amazon S3 . You can enter a prefix to append it to this default prefix. For example, if you enter the prefix vehicles , the prefix will be vehicles/processed-data/year=YY/month=MM/date=DD/hour=HH/ .
storage_compression_format (Optional[str]) – By default, stored data is compressed as a .gzip file. Compressed files have a reduced file size, which can optimize the cost of data storage.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotfleetwise-campaign-s3config.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_iotfleetwise import mixins as iotfleetwise_mixins

s3_config_property = iotfleetwise_mixins.CfnCampaignPropsMixin.S3ConfigProperty(
    bucket_arn="bucketArn",
    data_format="dataFormat",
    prefix="prefix",
    storage_compression_format="storageCompressionFormat"
)

Attributes

bucket_arn

The Amazon Resource Name (ARN) of the Amazon S3 bucket.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotfleetwise-campaign-s3config.html#cfn-iotfleetwise-campaign-s3config-bucketarn

data_format

Specify the format that files are saved in the Amazon S3 bucket.

You can save files in an Apache Parquet or JSON format.

Parquet - Store data in a columnar storage file format. Parquet is optimal for fast data retrieval and can reduce costs. This option is selected by default.
JSON - Store data in a standard text-based JSON file format.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotfleetwise-campaign-s3config.html#cfn-iotfleetwise-campaign-s3config-dataformat

prefix

Enter an S3 bucket prefix.

The prefix is the string of characters after the bucket name and before the object name. You can use the prefix to organize data stored in Amazon S3 buckets. For more information, see Organizing objects using prefixes in the Amazon Simple Storage Service User Guide .

By default, AWS IoT FleetWise sets the prefix processed-data/year=YY/month=MM/date=DD/hour=HH/ (in UTC) to data it delivers to Amazon S3 . You can enter a prefix to append it to this default prefix. For example, if you enter the prefix vehicles , the prefix will be vehicles/processed-data/year=YY/month=MM/date=DD/hour=HH/ .

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotfleetwise-campaign-s3config.html#cfn-iotfleetwise-campaign-s3config-prefix

storage_compression_format

By default, stored data is compressed as a .gzip file. Compressed files have a reduced file size, which can optimize the cost of data storage.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotfleetwise-campaign-s3config.html#cfn-iotfleetwise-campaign-s3config-storagecompressionformat

SignalFetchConfigProperty

class CfnCampaignPropsMixin.SignalFetchConfigProperty(*, condition_based=None, time_based=None)

Bases: object

The configuration of the signal fetch operation.

Access to certain AWS IoT FleetWise features is currently gated. For more information, see AWS Region and feature availability in the AWS IoT FleetWise Developer Guide .

Parameters:

condition_based (Union[IResolvable, ConditionBasedSignalFetchConfigProperty, Dict[str, Any], None]) – The configuration of a condition-based signal fetch operation.
time_based (Union[IResolvable, TimeBasedSignalFetchConfigProperty, Dict[str, Any], None]) – The configuration of a time-based signal fetch operation.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotfleetwise-campaign-signalfetchconfig.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_iotfleetwise import mixins as iotfleetwise_mixins

signal_fetch_config_property = iotfleetwise_mixins.CfnCampaignPropsMixin.SignalFetchConfigProperty(
    condition_based=iotfleetwise_mixins.CfnCampaignPropsMixin.ConditionBasedSignalFetchConfigProperty(
        condition_expression="conditionExpression",
        trigger_mode="triggerMode"
    ),
    time_based=iotfleetwise_mixins.CfnCampaignPropsMixin.TimeBasedSignalFetchConfigProperty(
        execution_frequency_ms=123
    )
)

Attributes

condition_based

The configuration of a condition-based signal fetch operation.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotfleetwise-campaign-signalfetchconfig.html#cfn-iotfleetwise-campaign-signalfetchconfig-conditionbased

time_based

The configuration of a time-based signal fetch operation.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotfleetwise-campaign-signalfetchconfig.html#cfn-iotfleetwise-campaign-signalfetchconfig-timebased

SignalFetchInformationProperty

class CfnCampaignPropsMixin.SignalFetchInformationProperty(*, actions=None, condition_language_version=None, fully_qualified_name=None, signal_fetch_config=None)

Bases: object

Information about the signal to be fetched.

Access to certain AWS IoT FleetWise features is currently gated. For more information, see AWS Region and feature availability in the AWS IoT FleetWise Developer Guide .

Parameters:

actions (Optional[Sequence[str]]) – The actions to be performed by the signal fetch.
condition_language_version (Union[int, float, None]) – The version of the condition language used.
fully_qualified_name (Optional[str]) – The fully qualified name of the signal to be fetched.
signal_fetch_config (Union[IResolvable, SignalFetchConfigProperty, Dict[str, Any], None]) – The configuration of the signal fetch operation.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotfleetwise-campaign-signalfetchinformation.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_iotfleetwise import mixins as iotfleetwise_mixins

signal_fetch_information_property = iotfleetwise_mixins.CfnCampaignPropsMixin.SignalFetchInformationProperty(
    actions=["actions"],
    condition_language_version=123,
    fully_qualified_name="fullyQualifiedName",
    signal_fetch_config=iotfleetwise_mixins.CfnCampaignPropsMixin.SignalFetchConfigProperty(
        condition_based=iotfleetwise_mixins.CfnCampaignPropsMixin.ConditionBasedSignalFetchConfigProperty(
            condition_expression="conditionExpression",
            trigger_mode="triggerMode"
        ),
        time_based=iotfleetwise_mixins.CfnCampaignPropsMixin.TimeBasedSignalFetchConfigProperty(
            execution_frequency_ms=123
        )
    )
)

Attributes

actions

The actions to be performed by the signal fetch.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotfleetwise-campaign-signalfetchinformation.html#cfn-iotfleetwise-campaign-signalfetchinformation-actions

condition_language_version

The version of the condition language used.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotfleetwise-campaign-signalfetchinformation.html#cfn-iotfleetwise-campaign-signalfetchinformation-conditionlanguageversion

fully_qualified_name

The fully qualified name of the signal to be fetched.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotfleetwise-campaign-signalfetchinformation.html#cfn-iotfleetwise-campaign-signalfetchinformation-fullyqualifiedname

signal_fetch_config

The configuration of the signal fetch operation.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotfleetwise-campaign-signalfetchinformation.html#cfn-iotfleetwise-campaign-signalfetchinformation-signalfetchconfig

SignalInformationProperty

class CfnCampaignPropsMixin.SignalInformationProperty(*, data_partition_id=None, max_sample_count=None, minimum_sampling_interval_ms=None, name=None)

Bases: object

Information about a signal.

Parameters:

data_partition_id (Optional[str]) –
The ID of the data partition this signal is associated with. The ID must match one of the IDs provided in dataPartitions . This is accomplished either by specifying a particular data partition ID or by using default for an established default partition. You can establish a default partition in the DataPartition data type. .. epigraph:: If you upload a signal as a condition for a campaign’s data partition, the same signal must be included in signalsToCollect . > Access to certain AWS IoT FleetWise features is currently gated. For more information, see AWS Region and feature availability in the AWS IoT FleetWise Developer Guide .
max_sample_count (Union[int, float, None]) – The maximum number of samples to collect.
minimum_sampling_interval_ms (Union[int, float, None]) – The minimum duration of time (in milliseconds) between two triggering events to collect data. .. epigraph:: If a signal changes often, you might want to collect data at a slower rate.
name (Optional[str]) – The name of the signal.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotfleetwise-campaign-signalinformation.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_iotfleetwise import mixins as iotfleetwise_mixins

signal_information_property = iotfleetwise_mixins.CfnCampaignPropsMixin.SignalInformationProperty(
    data_partition_id="dataPartitionId",
    max_sample_count=123,
    minimum_sampling_interval_ms=123,
    name="name"
)

Attributes

data_partition_id

The ID of the data partition this signal is associated with.

The ID must match one of the IDs provided in dataPartitions . This is accomplished either by specifying a particular data partition ID or by using default for an established default partition. You can establish a default partition in the DataPartition data type. .. epigraph:

If you upload a signal as a condition for a campaign's data partition, the same signal must be included in ``signalsToCollect`` . > Access to certain AWS IoT FleetWise features is currently gated. For more information, see `AWS Region and feature availability <https://docs.aws.amazon.com/iot-fleetwise/latest/developerguide/fleetwise-regions.html>`_ in the *AWS IoT FleetWise Developer Guide* .

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotfleetwise-campaign-signalinformation.html#cfn-iotfleetwise-campaign-signalinformation-datapartitionid

max_sample_count

The maximum number of samples to collect.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotfleetwise-campaign-signalinformation.html#cfn-iotfleetwise-campaign-signalinformation-maxsamplecount

minimum_sampling_interval_ms

The minimum duration of time (in milliseconds) between two triggering events to collect data.

If a signal changes often, you might want to collect data at a slower rate.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotfleetwise-campaign-signalinformation.html#cfn-iotfleetwise-campaign-signalinformation-minimumsamplingintervalms

name

The name of the signal.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotfleetwise-campaign-signalinformation.html#cfn-iotfleetwise-campaign-signalinformation-name

StorageMaximumSizeProperty

class CfnCampaignPropsMixin.StorageMaximumSizeProperty(*, unit=None, value=None)

Bases: object

The maximum storage size for the data partition.

Access to certain AWS IoT FleetWise features is currently gated. For more information, see AWS Region and feature availability in the AWS IoT FleetWise Developer Guide .

Parameters:

unit (Optional[str]) – The data type of the data to store.
value (Union[int, float, None]) – The maximum amount of time to store data.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotfleetwise-campaign-storagemaximumsize.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_iotfleetwise import mixins as iotfleetwise_mixins

storage_maximum_size_property = iotfleetwise_mixins.CfnCampaignPropsMixin.StorageMaximumSizeProperty(
    unit="unit",
    value=123
)

Attributes

unit

The data type of the data to store.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotfleetwise-campaign-storagemaximumsize.html#cfn-iotfleetwise-campaign-storagemaximumsize-unit

value

The maximum amount of time to store data.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotfleetwise-campaign-storagemaximumsize.html#cfn-iotfleetwise-campaign-storagemaximumsize-value

StorageMinimumTimeToLiveProperty

class CfnCampaignPropsMixin.StorageMinimumTimeToLiveProperty(*, unit=None, value=None)

Bases: object

Information about the minimum amount of time that data will be kept.

Access to certain AWS IoT FleetWise features is currently gated. For more information, see AWS Region and feature availability in the AWS IoT FleetWise Developer Guide .

Parameters:

unit (Optional[str]) – The time increment type.
value (Union[int, float, None]) – The minimum amount of time to store the data.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotfleetwise-campaign-storageminimumtimetolive.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_iotfleetwise import mixins as iotfleetwise_mixins

storage_minimum_time_to_live_property = iotfleetwise_mixins.CfnCampaignPropsMixin.StorageMinimumTimeToLiveProperty(
    unit="unit",
    value=123
)

Attributes

unit

The time increment type.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotfleetwise-campaign-storageminimumtimetolive.html#cfn-iotfleetwise-campaign-storageminimumtimetolive-unit

value

The minimum amount of time to store the data.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotfleetwise-campaign-storageminimumtimetolive.html#cfn-iotfleetwise-campaign-storageminimumtimetolive-value

TimeBasedCollectionSchemeProperty

class CfnCampaignPropsMixin.TimeBasedCollectionSchemeProperty(*, period_ms=None)

Bases: object

Information about a collection scheme that uses a time period to decide how often to collect data.

Parameters:: period_ms (Union[int, float, None]) – The time period (in milliseconds) to decide how often to collect data. For example, if the time period is 60000 , the Edge Agent software collects data once every minute.
See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotfleetwise-campaign-timebasedcollectionscheme.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_iotfleetwise import mixins as iotfleetwise_mixins

time_based_collection_scheme_property = iotfleetwise_mixins.CfnCampaignPropsMixin.TimeBasedCollectionSchemeProperty(
    period_ms=123
)

Attributes

period_ms

The time period (in milliseconds) to decide how often to collect data.

For example, if the time period is 60000 , the Edge Agent software collects data once every minute.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotfleetwise-campaign-timebasedcollectionscheme.html#cfn-iotfleetwise-campaign-timebasedcollectionscheme-periodms

TimeBasedSignalFetchConfigProperty

class CfnCampaignPropsMixin.TimeBasedSignalFetchConfigProperty(*, execution_frequency_ms=None)

Bases: object

Used to configure a frequency-based vehicle signal fetch.

Parameters:: execution_frequency_ms (Union[int, float, None]) – The frequency with which the signal fetch will be executed.
See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotfleetwise-campaign-timebasedsignalfetchconfig.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_iotfleetwise import mixins as iotfleetwise_mixins

time_based_signal_fetch_config_property = iotfleetwise_mixins.CfnCampaignPropsMixin.TimeBasedSignalFetchConfigProperty(
    execution_frequency_ms=123
)

Attributes

execution_frequency_ms

The frequency with which the signal fetch will be executed.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotfleetwise-campaign-timebasedsignalfetchconfig.html#cfn-iotfleetwise-campaign-timebasedsignalfetchconfig-executionfrequencyms

TimestreamConfigProperty

class CfnCampaignPropsMixin.TimestreamConfigProperty(*, execution_role_arn=None, timestream_table_arn=None)

Bases: object

The Amazon Timestream table where the AWS IoT FleetWise campaign sends data.

Timestream stores and organizes data to optimize query processing time and to reduce storage costs. For more information, see Data modeling in the Amazon Timestream Developer Guide .

Parameters:

execution_role_arn (Optional[str]) – The Amazon Resource Name (ARN) of the task execution role that grants AWS IoT FleetWise permission to deliver data to the Amazon Timestream table.
timestream_table_arn (Optional[str]) – The Amazon Resource Name (ARN) of the Amazon Timestream table.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotfleetwise-campaign-timestreamconfig.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_iotfleetwise import mixins as iotfleetwise_mixins

timestream_config_property = iotfleetwise_mixins.CfnCampaignPropsMixin.TimestreamConfigProperty(
    execution_role_arn="executionRoleArn",
    timestream_table_arn="timestreamTableArn"
)

Attributes

execution_role_arn

The Amazon Resource Name (ARN) of the task execution role that grants AWS IoT FleetWise permission to deliver data to the Amazon Timestream table.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotfleetwise-campaign-timestreamconfig.html#cfn-iotfleetwise-campaign-timestreamconfig-executionrolearn

timestream_table_arn

The Amazon Resource Name (ARN) of the Amazon Timestream table.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotfleetwise-campaign-timestreamconfig.html#cfn-iotfleetwise-campaign-timestreamconfig-timestreamtablearn