CfnCampaign

class aws_cdk.aws_iotfleetwise.CfnCampaign(scope, id, *, collection_scheme, name, signal_catalog_arn, target_arn, action=None, compression=None, data_destination_configs=None, data_extra_dimensions=None, data_partitions=None, description=None, diagnostics_mode=None, expiry_time=None, post_trigger_collection_duration=None, priority=None, signals_to_collect=None, signals_to_fetch=None, spooling_mode=None, start_time=None, tags=None)

Bases: CfnResource

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

ExampleMetadata:

fixture=_generated

Example:

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

cfn_campaign = iotfleetwise.CfnCampaign(self, "MyCfnCampaign",
    collection_scheme=iotfleetwise.CfnCampaign.CollectionSchemeProperty(
        condition_based_collection_scheme=iotfleetwise.CfnCampaign.ConditionBasedCollectionSchemeProperty(
            expression="expression",

            # the properties below are optional
            condition_language_version=123,
            minimum_trigger_interval_ms=123,
            trigger_mode="triggerMode"
        ),
        time_based_collection_scheme=iotfleetwise.CfnCampaign.TimeBasedCollectionSchemeProperty(
            period_ms=123
        )
    ),
    name="name",
    signal_catalog_arn="signalCatalogArn",
    target_arn="targetArn",

    # the properties below are optional
    action="action",
    compression="compression",
    data_destination_configs=[iotfleetwise.CfnCampaign.DataDestinationConfigProperty(
        mqtt_topic_config=iotfleetwise.CfnCampaign.MqttTopicConfigProperty(
            execution_role_arn="executionRoleArn",
            mqtt_topic_arn="mqttTopicArn"
        ),
        s3_config=iotfleetwise.CfnCampaign.S3ConfigProperty(
            bucket_arn="bucketArn",

            # the properties below are optional
            data_format="dataFormat",
            prefix="prefix",
            storage_compression_format="storageCompressionFormat"
        ),
        timestream_config=iotfleetwise.CfnCampaign.TimestreamConfigProperty(
            execution_role_arn="executionRoleArn",
            timestream_table_arn="timestreamTableArn"
        )
    )],
    data_extra_dimensions=["dataExtraDimensions"],
    data_partitions=[iotfleetwise.CfnCampaign.DataPartitionProperty(
        id="id",
        storage_options=iotfleetwise.CfnCampaign.DataPartitionStorageOptionsProperty(
            maximum_size=iotfleetwise.CfnCampaign.StorageMaximumSizeProperty(
                unit="unit",
                value=123
            ),
            minimum_time_to_live=iotfleetwise.CfnCampaign.StorageMinimumTimeToLiveProperty(
                unit="unit",
                value=123
            ),
            storage_location="storageLocation"
        ),

        # the properties below are optional
        upload_options=iotfleetwise.CfnCampaign.DataPartitionUploadOptionsProperty(
            expression="expression",

            # the properties below are optional
            condition_language_version=123
        )
    )],
    description="description",
    diagnostics_mode="diagnosticsMode",
    expiry_time="expiryTime",
    post_trigger_collection_duration=123,
    priority=123,
    signals_to_collect=[iotfleetwise.CfnCampaign.SignalInformationProperty(
        name="name",

        # the properties below are optional
        data_partition_id="dataPartitionId",
        max_sample_count=123,
        minimum_sampling_interval_ms=123
    )],
    signals_to_fetch=[iotfleetwise.CfnCampaign.SignalFetchInformationProperty(
        actions=["actions"],
        fully_qualified_name="fullyQualifiedName",
        signal_fetch_config=iotfleetwise.CfnCampaign.SignalFetchConfigProperty(
            condition_based=iotfleetwise.CfnCampaign.ConditionBasedSignalFetchConfigProperty(
                condition_expression="conditionExpression",
                trigger_mode="triggerMode"
            ),
            time_based=iotfleetwise.CfnCampaign.TimeBasedSignalFetchConfigProperty(
                execution_frequency_ms=123
            )
        ),

        # the properties below are optional
        condition_language_version=123
    )],
    spooling_mode="spoolingMode",
    start_time="startTime",
    tags=[CfnTag(
        key="key",
        value="value"
    )]
)
Parameters:
  • scope (Construct) – Scope in which this resource is defined.

  • id (str) – Construct identifier for this resource (unique in its scope).

  • collection_scheme (Union[IResolvable, CollectionSchemeProperty, Dict[str, Any]]) – The data collection scheme associated with the campaign. You can specify a scheme that collects data based on time or an event.

  • name (str) – The name of a campaign.

  • signal_catalog_arn (str) – The Amazon Resource Name (ARN) of the signal catalog associated with the campaign.

  • target_arn (str) – The Amazon Resource Name (ARN) of a vehicle or fleet to which the campaign is deployed.

  • action (Optional[str]) – Specifies how to update a campaign. The action can be one of the following:. - APPROVE - To approve delivering a data collection scheme to vehicles. - SUSPEND - To suspend collecting signal data. The campaign is deleted from vehicles and all vehicles in the suspended campaign will stop sending data. - RESUME - To reactivate the SUSPEND campaign. The campaign is redeployed to all vehicles and the vehicles will resume sending data. - UPDATE - To update a campaign.

  • compression (Optional[str]) – Whether to compress signals before transmitting data to AWS IoT FleetWise . If you don’t want to compress the signals, use OFF . If it’s not specified, SNAPPY is used. Default: SNAPPY Default: - “OFF”

  • data_destination_configs (Union[IResolvable, Sequence[Union[IResolvable, DataDestinationConfigProperty, Dict[str, Any]]], None]) – The destination where the campaign sends data. You can choose to send data to be stored in Amazon S3 or Amazon Timestream . Amazon S3 optimizes the cost of data storage and provides additional mechanisms to use vehicle data, such as data lakes, centralized data storage, data processing pipelines, and analytics. AWS IoT FleetWise supports at-least-once file delivery to S3. Your vehicle data is stored on multiple AWS IoT FleetWise servers for redundancy and high availability. You can use Amazon Timestream to access and analyze time series data, and Timestream to query vehicle data so that you can identify trends and patterns.

  • data_extra_dimensions (Optional[Sequence[str]]) – A list of vehicle attributes to associate with a campaign. Enrich the data with specified vehicle attributes. For example, add make and model to the campaign, and AWS IoT FleetWise will associate the data with those attributes as dimensions in Amazon Timestream . You can then query the data against make and model . Default: An empty array

  • data_partitions (Union[IResolvable, Sequence[Union[IResolvable, DataPartitionProperty, Dict[str, Any]]], None]) – The data partitions associated with the signals collected from the vehicle.

  • description (Optional[str]) – The description of the campaign.

  • diagnostics_mode (Optional[str]) – Option for a vehicle to send diagnostic trouble codes to AWS IoT FleetWise . If you want to send diagnostic trouble codes, use SEND_ACTIVE_DTCS . If it’s not specified, OFF is used. Default: OFF Default: - “OFF”

  • expiry_time (Optional[str]) – The time the campaign expires, in seconds since epoch (January 1, 1970 at midnight UTC time). Vehicle data isn’t collected after the campaign expires. Default: 253402214400 (December 31, 9999, 00:00:00 UTC) Default: - “253402214400”

  • post_trigger_collection_duration (Union[int, float, None]) – How long (in milliseconds) to collect raw data after a triggering event initiates the collection. If it’s not specified, 0 is used. Default: 0 Default: - 0

  • priority (Union[int, float, None]) – A number indicating the priority of one campaign over another campaign for a certain vehicle or fleet. A campaign with the lowest value is deployed to vehicles before any other campaigns. If it’s not specified, 0 is used. Default: 0 Default: - 0

  • signals_to_collect (Union[IResolvable, Sequence[Union[IResolvable, SignalInformationProperty, Dict[str, Any]]], None]) – A list of information about signals to collect.

  • signals_to_fetch (Union[IResolvable, Sequence[Union[IResolvable, SignalFetchInformationProperty, Dict[str, Any]]], None]) – A list of information about signals to fetch.

  • spooling_mode (Optional[str]) – Whether to store collected data after a vehicle lost a connection with the cloud. After a connection is re-established, the data is automatically forwarded to AWS IoT FleetWise . If you want to store collected data when a vehicle loses connection with the cloud, use TO_DISK . If it’s not specified, OFF is used. Default: OFF Default: - “OFF”

  • start_time (Optional[str]) – The time, in milliseconds, to deliver a campaign after it was approved. If it’s not specified, 0 is used. Default: 0 Default: - “0”

  • tags (Optional[Sequence[Union[CfnTag, Dict[str, Any]]]]) – Metadata that can be used to manage the campaign.

Methods

add_deletion_override(path)

Syntactic sugar for addOverride(path, undefined).

Parameters:

path (str) – The path of the value to delete.

Return type:

None

add_dependency(target)

Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.

This can be used for resources across stacks (or nested stack) boundaries and the dependency will automatically be transferred to the relevant scope.

Parameters:

target (CfnResource) –

Return type:

None

add_depends_on(target)

(deprecated) Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.

Parameters:

target (CfnResource) –

Deprecated:

use addDependency

Stability:

deprecated

Return type:

None

add_metadata(key, value)

Add a value to the CloudFormation Resource Metadata.

Parameters:
  • key (str) –

  • value (Any) –

See:

Return type:

None

https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html

Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.

add_override(path, value)

Adds an override to the synthesized CloudFormation resource.

To add a property override, either use addPropertyOverride or prefix path with “Properties.” (i.e. Properties.TopicName).

If the override is nested, separate each nested level using a dot (.) in the path parameter. If there is an array as part of the nesting, specify the index in the path.

To include a literal . in the property name, prefix with a \. In most programming languages you will need to write this as "\\." because the \ itself will need to be escaped.

For example:

cfn_resource.add_override("Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes", ["myattribute"])
cfn_resource.add_override("Properties.GlobalSecondaryIndexes.1.ProjectionType", "INCLUDE")

would add the overrides Example:

"Properties": {
  "GlobalSecondaryIndexes": [
    {
      "Projection": {
        "NonKeyAttributes": [ "myattribute" ]
        ...
      }
      ...
    },
    {
      "ProjectionType": "INCLUDE"
      ...
    },
  ]
  ...
}

The value argument to addOverride will not be processed or translated in any way. Pass raw JSON values in here with the correct capitalization for CloudFormation. If you pass CDK classes or structs, they will be rendered with lowercased key names, and CloudFormation will reject the template.

Parameters:
  • path (str) –

    • The path of the property, you can use dot notation to override values in complex types. Any intermediate keys will be created as needed.

  • value (Any) –

    • The value. Could be primitive or complex.

Return type:

None

add_property_deletion_override(property_path)

Adds an override that deletes the value of a property from the resource definition.

Parameters:

property_path (str) – The path to the property.

Return type:

None

add_property_override(property_path, value)

Adds an override to a resource property.

Syntactic sugar for addOverride("Properties.<...>", value).

Parameters:
  • property_path (str) – The path of the property.

  • value (Any) – The value.

Return type:

None

apply_removal_policy(policy=None, *, apply_to_update_replace_policy=None, default=None)

Sets the deletion policy of the resource based on the removal policy specified.

The Removal Policy controls what happens to this resource when it stops being managed by CloudFormation, either because you’ve removed it from the CDK application or because you’ve made a change that requires the resource to be replaced.

The resource can be deleted (RemovalPolicy.DESTROY), or left in your AWS account for data recovery and cleanup later (RemovalPolicy.RETAIN). In some cases, a snapshot can be taken of the resource prior to deletion (RemovalPolicy.SNAPSHOT). A list of resources that support this policy can be found in the following link:

Parameters:
  • policy (Optional[RemovalPolicy]) –

  • apply_to_update_replace_policy (Optional[bool]) – Apply the same deletion policy to the resource’s “UpdateReplacePolicy”. Default: true

  • default (Optional[RemovalPolicy]) – The default policy to apply in case the removal policy is not defined. Default: - Default value is resource specific. To determine the default value for a resource, please consult that specific resource’s documentation.

See:

https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-deletionpolicy.html#aws-attribute-deletionpolicy-options

Return type:

None

get_att(attribute_name, type_hint=None)

Returns a token for an runtime attribute of this resource.

Ideally, use generated attribute accessors (e.g. resource.arn), but this can be used for future compatibility in case there is no generated attribute.

Parameters:
  • attribute_name (str) – The name of the attribute.

  • type_hint (Optional[ResolutionTypeHint]) –

Return type:

Reference

get_metadata(key)

Retrieve a value value from the CloudFormation Resource Metadata.

Parameters:

key (str) –

See:

Return type:

Any

https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html

Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.

inspect(inspector)

Examines the CloudFormation resource and discloses attributes.

Parameters:

inspector (TreeInspector) – tree inspector to collect and process attributes.

Return type:

None

obtain_dependencies()

Retrieves an array of resources this resource depends on.

This assembles dependencies on resources across stacks (including nested stacks) automatically.

Return type:

List[Union[Stack, CfnResource]]

obtain_resource_dependencies()

Get a shallow copy of dependencies between this resource and other resources in the same stack.

Return type:

List[CfnResource]

override_logical_id(new_logical_id)

Overrides the auto-generated logical ID with a specific ID.

Parameters:

new_logical_id (str) – The new logical ID to use for this stack element.

Return type:

None

remove_dependency(target)

Indicates that this resource no longer depends on another resource.

This can be used for resources across stacks (including nested stacks) and the dependency will automatically be removed from the relevant scope.

Parameters:

target (CfnResource) –

Return type:

None

replace_dependency(target, new_target)

Replaces one dependency with another.

Parameters:
Return type:

None

to_string()

Returns a string representation of this construct.

Return type:

str

Returns:

a string representation of this resource

Attributes

CFN_RESOURCE_TYPE_NAME = 'AWS::IoTFleetWise::Campaign'
action

Specifies how to update a campaign.

The action can be one of the following:.

attr_arn

The Amazon Resource Name (ARN) of the campaign.

CloudformationAttribute:

Arn

attr_creation_time

The time the campaign was created in seconds since epoch (January 1, 1970 at midnight UTC time).

CloudformationAttribute:

CreationTime

attr_last_modification_time

The last time the campaign was modified.

CloudformationAttribute:

LastModificationTime

attr_status

The state of the campaign.

The status can be one of: CREATING , WAITING_FOR_APPROVAL , RUNNING , and SUSPENDED .

CloudformationAttribute:

Status

cfn_options

Options for this resource, such as condition, update policy etc.

cfn_resource_type

AWS resource type.

collection_scheme

The data collection scheme associated with the campaign.

compression

Whether to compress signals before transmitting data to AWS IoT FleetWise .

creation_stack

return:

the stack trace of the point where this Resource was created from, sourced from the +metadata+ entry typed +aws:cdk:logicalId+, and with the bottom-most node +internal+ entries filtered.

data_destination_configs

The destination where the campaign sends data.

data_extra_dimensions

A list of vehicle attributes to associate with a campaign.

data_partitions

The data partitions associated with the signals collected from the vehicle.

description

The description of the campaign.

diagnostics_mode

Option for a vehicle to send diagnostic trouble codes to AWS IoT FleetWise .

expiry_time

The time the campaign expires, in seconds since epoch (January 1, 1970 at midnight UTC time).

logical_id

The logical ID for this CloudFormation stack element.

The logical ID of the element is calculated from the path of the resource node in the construct tree.

To override this value, use overrideLogicalId(newLogicalId).

Returns:

the logical ID as a stringified token. This value will only get resolved during synthesis.

name

The name of a campaign.

node

The tree node.

post_trigger_collection_duration

How long (in milliseconds) to collect raw data after a triggering event initiates the collection.

priority

A number indicating the priority of one campaign over another campaign for a certain vehicle or fleet.

ref

Return a string that will be resolved to a CloudFormation { Ref } for this element.

If, by any chance, the intrinsic reference of a resource is not a string, you could coerce it to an IResolvable through Lazy.any({ produce: resource.ref }).

signal_catalog_arn

The Amazon Resource Name (ARN) of the signal catalog associated with the campaign.

signals_to_collect

A list of information about signals to collect.

signals_to_fetch

A list of information about signals to fetch.

spooling_mode

Whether to store collected data after a vehicle lost a connection with the cloud.

stack

The stack in which this element is defined.

CfnElements must be defined within a stack scope (directly or indirectly).

start_time

The time, in milliseconds, to deliver a campaign after it was approved.

If it’s not specified, 0 is used.

tags

Tag Manager which manages the tags for this resource.

tags_raw

Metadata that can be used to manage the campaign.

target_arn

The Amazon Resource Name (ARN) of a vehicle or fleet to which the campaign is deployed.

Static Methods

classmethod is_cfn_element(x)

Returns true if a construct is a stack element (i.e. part of the synthesized cloudformation template).

Uses duck-typing instead of instanceof to allow stack elements from different versions of this library to be included in the same stack.

Parameters:

x (Any) –

Return type:

bool

Returns:

The construct as a stack element or undefined if it is not a stack element.

classmethod is_cfn_resource(x)

Check whether the given object is a CfnResource.

Parameters:

x (Any) –

Return type:

bool

classmethod is_construct(x)

Checks if x is a construct.

Use this method instead of instanceof to properly detect Construct instances, even when the construct library is symlinked.

Explanation: in JavaScript, multiple copies of the constructs library on disk are seen as independent, completely different libraries. As a consequence, the class Construct in each copy of the constructs library is seen as a different class, and an instance of one class will not test as instanceof the other class. npm install will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the constructs library can be accidentally installed, and instanceof will behave unpredictably. It is safest to avoid using instanceof, and using this type-testing method instead.

Parameters:

x (Any) – Any object.

Return type:

bool

Returns:

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

CollectionSchemeProperty

class CfnCampaign.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:
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 import aws_iotfleetwise as iotfleetwise

collection_scheme_property = iotfleetwise.CfnCampaign.CollectionSchemeProperty(
    condition_based_collection_scheme=iotfleetwise.CfnCampaign.ConditionBasedCollectionSchemeProperty(
        expression="expression",

        # the properties below are optional
        condition_language_version=123,
        minimum_trigger_interval_ms=123,
        trigger_mode="triggerMode"
    ),
    time_based_collection_scheme=iotfleetwise.CfnCampaign.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 CfnCampaign.ConditionBasedCollectionSchemeProperty(*, expression, condition_language_version=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:
  • expression (str) – The logical expression used to recognize what data to collect. For example, $variable.Vehicle.OutsideAirTemperature >= 105.0 .

  • condition_language_version (Union[int, float, None]) – Specifies the version of the conditional expression language.

  • 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 import aws_iotfleetwise as iotfleetwise

condition_based_collection_scheme_property = iotfleetwise.CfnCampaign.ConditionBasedCollectionSchemeProperty(
    expression="expression",

    # the properties below are optional
    condition_language_version=123,
    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 CfnCampaign.ConditionBasedSignalFetchConfigProperty(*, condition_expression, trigger_mode)

Bases: object

Specifies the condition under which a signal fetch occurs.

Parameters:
  • condition_expression (str) – The condition that must be satisfied to trigger a signal fetch.

  • trigger_mode (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 import aws_iotfleetwise as iotfleetwise

condition_based_signal_fetch_config_property = iotfleetwise.CfnCampaign.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 CfnCampaign.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:
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 import aws_iotfleetwise as iotfleetwise

data_destination_config_property = iotfleetwise.CfnCampaign.DataDestinationConfigProperty(
    mqtt_topic_config=iotfleetwise.CfnCampaign.MqttTopicConfigProperty(
        execution_role_arn="executionRoleArn",
        mqtt_topic_arn="mqttTopicArn"
    ),
    s3_config=iotfleetwise.CfnCampaign.S3ConfigProperty(
        bucket_arn="bucketArn",

        # the properties below are optional
        data_format="dataFormat",
        prefix="prefix",
        storage_compression_format="storageCompressionFormat"
    ),
    timestream_config=iotfleetwise.CfnCampaign.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 CfnCampaign.DataPartitionProperty(*, id, storage_options, 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 (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]]) – 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 import aws_iotfleetwise as iotfleetwise

data_partition_property = iotfleetwise.CfnCampaign.DataPartitionProperty(
    id="id",
    storage_options=iotfleetwise.CfnCampaign.DataPartitionStorageOptionsProperty(
        maximum_size=iotfleetwise.CfnCampaign.StorageMaximumSizeProperty(
            unit="unit",
            value=123
        ),
        minimum_time_to_live=iotfleetwise.CfnCampaign.StorageMinimumTimeToLiveProperty(
            unit="unit",
            value=123
        ),
        storage_location="storageLocation"
    ),

    # the properties below are optional
    upload_options=iotfleetwise.CfnCampaign.DataPartitionUploadOptionsProperty(
        expression="expression",

        # the properties below are optional
        condition_language_version=123
    )
)

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 CfnCampaign.DataPartitionStorageOptionsProperty(*, maximum_size, minimum_time_to_live, storage_location)

Bases: object

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

Parameters:
  • maximum_size (Union[IResolvable, StorageMaximumSizeProperty, Dict[str, Any]]) – 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]]) – 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 (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 import aws_iotfleetwise as iotfleetwise

data_partition_storage_options_property = iotfleetwise.CfnCampaign.DataPartitionStorageOptionsProperty(
    maximum_size=iotfleetwise.CfnCampaign.StorageMaximumSizeProperty(
        unit="unit",
        value=123
    ),
    minimum_time_to_live=iotfleetwise.CfnCampaign.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 CfnCampaign.DataPartitionUploadOptionsProperty(*, expression, condition_language_version=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:
  • expression (str) – The logical expression used to recognize what data to collect. For example, $variable.``Vehicle.OutsideAirTemperature >= 105.0`` .

  • condition_language_version (Union[int, float, None]) – 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

ExampleMetadata:

fixture=_generated

Example:

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

data_partition_upload_options_property = iotfleetwise.CfnCampaign.DataPartitionUploadOptionsProperty(
    expression="expression",

    # the properties below are optional
    condition_language_version=123
)

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 CfnCampaign.MqttTopicConfigProperty(*, execution_role_arn, mqtt_topic_arn)

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 (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 (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 import aws_iotfleetwise as iotfleetwise

mqtt_topic_config_property = iotfleetwise.CfnCampaign.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 CfnCampaign.S3ConfigProperty(*, bucket_arn, 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 (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 import aws_iotfleetwise as iotfleetwise

s3_config_property = iotfleetwise.CfnCampaign.S3ConfigProperty(
    bucket_arn="bucketArn",

    # the properties below are optional
    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 CfnCampaign.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:
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 import aws_iotfleetwise as iotfleetwise

signal_fetch_config_property = iotfleetwise.CfnCampaign.SignalFetchConfigProperty(
    condition_based=iotfleetwise.CfnCampaign.ConditionBasedSignalFetchConfigProperty(
        condition_expression="conditionExpression",
        trigger_mode="triggerMode"
    ),
    time_based=iotfleetwise.CfnCampaign.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 CfnCampaign.SignalFetchInformationProperty(*, actions, fully_qualified_name, signal_fetch_config, condition_language_version=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 (Sequence[str]) – The actions to be performed by the signal fetch.

  • fully_qualified_name (str) – The fully qualified name of the signal to be fetched.

  • signal_fetch_config (Union[IResolvable, SignalFetchConfigProperty, Dict[str, Any]]) – The configuration of the signal fetch operation.

  • condition_language_version (Union[int, float, None]) – The version of the condition language used.

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 import aws_iotfleetwise as iotfleetwise

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

    # the properties below are optional
    condition_language_version=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 CfnCampaign.SignalInformationProperty(*, name, data_partition_id=None, max_sample_count=None, minimum_sampling_interval_ms=None)

Bases: object

Information about a signal.

Parameters:
  • name (str) – The name of the signal.

  • 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.

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 import aws_iotfleetwise as iotfleetwise

signal_information_property = iotfleetwise.CfnCampaign.SignalInformationProperty(
    name="name",

    # the properties below are optional
    data_partition_id="dataPartitionId",
    max_sample_count=123,
    minimum_sampling_interval_ms=123
)

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 CfnCampaign.StorageMaximumSizeProperty(*, unit, value)

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 (str) – The data type of the data to store.

  • value (Union[int, float]) – 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 import aws_iotfleetwise as iotfleetwise

storage_maximum_size_property = iotfleetwise.CfnCampaign.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 CfnCampaign.StorageMinimumTimeToLiveProperty(*, unit, value)

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 (str) – The time increment type.

  • value (Union[int, float]) – 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 import aws_iotfleetwise as iotfleetwise

storage_minimum_time_to_live_property = iotfleetwise.CfnCampaign.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 CfnCampaign.TimeBasedCollectionSchemeProperty(*, period_ms)

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]) – 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 import aws_iotfleetwise as iotfleetwise

time_based_collection_scheme_property = iotfleetwise.CfnCampaign.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 CfnCampaign.TimeBasedSignalFetchConfigProperty(*, execution_frequency_ms)

Bases: object

Used to configure a frequency-based vehicle signal fetch.

Parameters:

execution_frequency_ms (Union[int, float]) – 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 import aws_iotfleetwise as iotfleetwise

time_based_signal_fetch_config_property = iotfleetwise.CfnCampaign.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 CfnCampaign.TimestreamConfigProperty(*, execution_role_arn, timestream_table_arn)

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 (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 (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 import aws_iotfleetwise as iotfleetwise

timestream_config_property = iotfleetwise.CfnCampaign.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