CfnCampaignProps

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

Bases: object

Properties for defining a CfnCampaign.

Parameters:
  • action (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.

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

  • compression (Optional[str]) – (Optional) 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]) – (Optional) 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]]) – (Optional) 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

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

  • diagnostics_mode (Optional[str]) – (Optional) 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]) – (Optional) 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]) – (Optional) 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]) – (Optional) 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]) – (Optional) A list of information about signals to collect.

  • spooling_mode (Optional[str]) – (Optional) 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]) – (Optional) 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]]]]) – (Optional) Metadata that can be used to manage the campaign.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotfleetwise-campaign.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

cfn_campaign_props = iotfleetwise.CfnCampaignProps(
    action="action",
    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
    compression="compression",
    data_destination_configs=[iotfleetwise.CfnCampaign.DataDestinationConfigProperty(
        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"],
    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
        max_sample_count=123,
        minimum_sampling_interval_ms=123
    )],
    spooling_mode="spoolingMode",
    start_time="startTime",
    tags=[CfnTag(
        key="key",
        value="value"
    )]
)

Attributes

action

.

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

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotfleetwise-campaign.html#cfn-iotfleetwise-campaign-action

Type:

Specifies how to update a campaign. The action can be one of the following

collection_scheme

The data collection scheme associated with the campaign.

You can specify a scheme that collects data based on time or an event.

See:

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

compression

(Optional) 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”

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotfleetwise-campaign.html#cfn-iotfleetwise-campaign-compression

data_destination_configs

(Optional) 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.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotfleetwise-campaign.html#cfn-iotfleetwise-campaign-datadestinationconfigs

data_extra_dimensions

(Optional) 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

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotfleetwise-campaign.html#cfn-iotfleetwise-campaign-dataextradimensions

description

(Optional) The description of the campaign.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotfleetwise-campaign.html#cfn-iotfleetwise-campaign-description

diagnostics_mode

(Optional) 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”

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotfleetwise-campaign.html#cfn-iotfleetwise-campaign-diagnosticsmode

expiry_time

(Optional) 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”

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotfleetwise-campaign.html#cfn-iotfleetwise-campaign-expirytime

name

The name of a campaign.

See:

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

post_trigger_collection_duration

(Optional) 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

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotfleetwise-campaign.html#cfn-iotfleetwise-campaign-posttriggercollectionduration

priority

(Optional) 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

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotfleetwise-campaign.html#cfn-iotfleetwise-campaign-priority

signal_catalog_arn

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

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotfleetwise-campaign.html#cfn-iotfleetwise-campaign-signalcatalogarn

signals_to_collect

(Optional) A list of information about signals to collect.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotfleetwise-campaign.html#cfn-iotfleetwise-campaign-signalstocollect

spooling_mode

(Optional) 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”

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotfleetwise-campaign.html#cfn-iotfleetwise-campaign-spoolingmode

start_time

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

If it’s not specified, 0 is used.

Default: 0

Default:
  • “0”

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotfleetwise-campaign.html#cfn-iotfleetwise-campaign-starttime

tags

(Optional) Metadata that can be used to manage the campaign.

See:

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

target_arn

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

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotfleetwise-campaign.html#cfn-iotfleetwise-campaign-targetarn