aws-cdk-lib 2.172.0__py3-none-any.whl → 2.173.1__py3-none-any.whl
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Potentially problematic release.
This version of aws-cdk-lib might be problematic. Click here for more details.
- aws_cdk/__init__.py +57 -0
- aws_cdk/_jsii/__init__.py +1 -1
- aws_cdk/_jsii/{aws-cdk-lib@2.172.0.jsii.tgz → aws-cdk-lib@2.173.1.jsii.tgz} +0 -0
- aws_cdk/aws_amazonmq/__init__.py +40 -40
- aws_cdk/aws_apigateway/__init__.py +111 -64
- aws_cdk/aws_applicationautoscaling/__init__.py +141 -66
- aws_cdk/aws_appsync/__init__.py +4 -3
- aws_cdk/aws_autoscaling/__init__.py +15 -6
- aws_cdk/aws_bedrock/__init__.py +32 -44
- aws_cdk/aws_chatbot/__init__.py +72 -46
- aws_cdk/aws_cleanrooms/__init__.py +4 -6
- aws_cdk/aws_cloudfront/__init__.py +4 -2
- aws_cdk/aws_cloudtrail/__init__.py +104 -68
- aws_cdk/aws_cloudwatch/__init__.py +51 -14
- aws_cdk/aws_codebuild/__init__.py +39 -0
- aws_cdk/aws_codepipeline/__init__.py +4 -4
- aws_cdk/aws_cognito/__init__.py +221 -53
- aws_cdk/aws_config/__init__.py +13 -10
- aws_cdk/aws_connect/__init__.py +25 -23
- aws_cdk/aws_connectcampaignsv2/__init__.py +187 -176
- aws_cdk/aws_docdb/__init__.py +128 -0
- aws_cdk/aws_dynamodb/__init__.py +256 -0
- aws_cdk/aws_ec2/__init__.py +130 -48
- aws_cdk/aws_ecs/__init__.py +25 -13
- aws_cdk/aws_eks/__init__.py +86 -24
- aws_cdk/aws_elasticache/__init__.py +22 -22
- aws_cdk/aws_elasticloadbalancingv2/__init__.py +138 -128
- aws_cdk/aws_events/__init__.py +39 -26
- aws_cdk/aws_fsx/__init__.py +134 -10
- aws_cdk/aws_imagebuilder/__init__.py +8 -8
- aws_cdk/aws_invoicing/__init__.py +651 -0
- aws_cdk/aws_iot/__init__.py +28 -22
- aws_cdk/aws_iotfleetwise/__init__.py +473 -332
- aws_cdk/aws_iotsitewise/__init__.py +6 -4
- aws_cdk/aws_ivs/__init__.py +43 -31
- aws_cdk/aws_kendra/__init__.py +4 -0
- aws_cdk/aws_lakeformation/__init__.py +2 -1
- aws_cdk/aws_lambda/__init__.py +258 -156
- aws_cdk/aws_logs/__init__.py +532 -0
- aws_cdk/aws_m2/__init__.py +15 -15
- aws_cdk/aws_mediaconnect/__init__.py +24 -14
- aws_cdk/aws_medialive/__init__.py +2359 -5
- aws_cdk/aws_mediapackage/__init__.py +3 -9
- aws_cdk/aws_mediapackagev2/__init__.py +19 -17
- aws_cdk/aws_memorydb/__init__.py +664 -4
- aws_cdk/aws_qbusiness/__init__.py +2018 -66
- aws_cdk/aws_rds/__init__.py +30 -0
- aws_cdk/aws_resourcegroups/__init__.py +26 -17
- aws_cdk/aws_route53/__init__.py +1177 -10
- aws_cdk/aws_route53_targets/__init__.py +224 -100
- aws_cdk/aws_route53resolver/__init__.py +4 -2
- aws_cdk/aws_s3/__init__.py +4 -4
- aws_cdk/aws_s3express/__init__.py +30 -19
- aws_cdk/aws_sagemaker/__init__.py +783 -9
- aws_cdk/aws_secretsmanager/__init__.py +20 -6
- aws_cdk/aws_securityhub/__init__.py +64 -32
- aws_cdk/aws_servicediscovery/__init__.py +43 -0
- aws_cdk/aws_ses/__init__.py +109 -0
- aws_cdk/aws_stepfunctions_tasks/__init__.py +190 -35
- aws_cdk/aws_synthetics/__init__.py +7 -5
- aws_cdk/aws_vpclattice/__init__.py +1479 -122
- aws_cdk/aws_wisdom/__init__.py +2698 -232
- aws_cdk/aws_workspacesweb/__init__.py +118 -61
- {aws_cdk_lib-2.172.0.dist-info → aws_cdk_lib-2.173.1.dist-info}/METADATA +1 -1
- {aws_cdk_lib-2.172.0.dist-info → aws_cdk_lib-2.173.1.dist-info}/RECORD +69 -68
- {aws_cdk_lib-2.172.0.dist-info → aws_cdk_lib-2.173.1.dist-info}/LICENSE +0 -0
- {aws_cdk_lib-2.172.0.dist-info → aws_cdk_lib-2.173.1.dist-info}/NOTICE +0 -0
- {aws_cdk_lib-2.172.0.dist-info → aws_cdk_lib-2.173.1.dist-info}/WHEEL +0 -0
- {aws_cdk_lib-2.172.0.dist-info → aws_cdk_lib-2.173.1.dist-info}/top_level.txt +0 -0
|
@@ -80,7 +80,10 @@ class CfnCampaign(
|
|
|
80
80
|
|
|
81
81
|
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.
|
|
82
82
|
|
|
83
|
-
For more information, see `
|
|
83
|
+
For more information, see `Campaigns <https://docs.aws.amazon.com/iot-fleetwise/latest/developerguide/campaigns.html>`_ in the *AWS IoT FleetWise Developer Guide* .
|
|
84
|
+
.. epigraph::
|
|
85
|
+
|
|
86
|
+
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* .
|
|
84
87
|
|
|
85
88
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotfleetwise-campaign.html
|
|
86
89
|
:cloudformationResource: AWS::IoTFleetWise::Campaign
|
|
@@ -225,20 +228,20 @@ class CfnCampaign(
|
|
|
225
228
|
:param signal_catalog_arn: The Amazon Resource Name (ARN) of the signal catalog associated with the campaign.
|
|
226
229
|
:param target_arn: The Amazon Resource Name (ARN) of a vehicle or fleet to which the campaign is deployed.
|
|
227
230
|
:param action: 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.
|
|
228
|
-
:param compression:
|
|
229
|
-
:param data_destination_configs:
|
|
230
|
-
:param data_extra_dimensions:
|
|
231
|
-
:param data_partitions:
|
|
232
|
-
:param description:
|
|
233
|
-
:param diagnostics_mode:
|
|
234
|
-
:param expiry_time:
|
|
235
|
-
:param post_trigger_collection_duration:
|
|
236
|
-
:param priority:
|
|
237
|
-
:param signals_to_collect:
|
|
238
|
-
:param signals_to_fetch:
|
|
239
|
-
:param spooling_mode:
|
|
240
|
-
:param start_time:
|
|
241
|
-
:param tags:
|
|
231
|
+
:param compression: 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"
|
|
232
|
+
:param data_destination_configs: 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.
|
|
233
|
+
:param data_extra_dimensions: 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
|
|
234
|
+
:param data_partitions: The data partitions associated with the signals collected from the vehicle.
|
|
235
|
+
:param description: The description of the campaign.
|
|
236
|
+
:param diagnostics_mode: 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"
|
|
237
|
+
:param expiry_time: 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"
|
|
238
|
+
:param post_trigger_collection_duration: 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
|
|
239
|
+
:param priority: 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
|
|
240
|
+
:param signals_to_collect: A list of information about signals to collect.
|
|
241
|
+
:param signals_to_fetch: A list of information about signals to fetch.
|
|
242
|
+
:param spooling_mode: 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"
|
|
243
|
+
:param start_time: The time, in milliseconds, to deliver a campaign after it was approved. If it's not specified, ``0`` is used. Default: ``0`` Default: - "0"
|
|
244
|
+
:param tags: Metadata that can be used to manage the campaign.
|
|
242
245
|
'''
|
|
243
246
|
if __debug__:
|
|
244
247
|
type_hints = typing.get_type_hints(_typecheckingstub__f7abc45d2046b48ec3bc5807ec2826a784930a5009b41b194dd6e4bed2413f8d)
|
|
@@ -423,7 +426,7 @@ class CfnCampaign(
|
|
|
423
426
|
@builtins.property
|
|
424
427
|
@jsii.member(jsii_name="compression")
|
|
425
428
|
def compression(self) -> typing.Optional[builtins.str]:
|
|
426
|
-
'''
|
|
429
|
+
'''Whether to compress signals before transmitting data to AWS IoT FleetWise .'''
|
|
427
430
|
return typing.cast(typing.Optional[builtins.str], jsii.get(self, "compression"))
|
|
428
431
|
|
|
429
432
|
@compression.setter
|
|
@@ -438,7 +441,7 @@ class CfnCampaign(
|
|
|
438
441
|
def data_destination_configs(
|
|
439
442
|
self,
|
|
440
443
|
) -> typing.Optional[typing.Union[_IResolvable_da3f097b, typing.List[typing.Union[_IResolvable_da3f097b, "CfnCampaign.DataDestinationConfigProperty"]]]]:
|
|
441
|
-
'''
|
|
444
|
+
'''The destination where the campaign sends data.'''
|
|
442
445
|
return typing.cast(typing.Optional[typing.Union[_IResolvable_da3f097b, typing.List[typing.Union[_IResolvable_da3f097b, "CfnCampaign.DataDestinationConfigProperty"]]]], jsii.get(self, "dataDestinationConfigs"))
|
|
443
446
|
|
|
444
447
|
@data_destination_configs.setter
|
|
@@ -454,7 +457,7 @@ class CfnCampaign(
|
|
|
454
457
|
@builtins.property
|
|
455
458
|
@jsii.member(jsii_name="dataExtraDimensions")
|
|
456
459
|
def data_extra_dimensions(self) -> typing.Optional[typing.List[builtins.str]]:
|
|
457
|
-
'''
|
|
460
|
+
'''A list of vehicle attributes to associate with a campaign.'''
|
|
458
461
|
return typing.cast(typing.Optional[typing.List[builtins.str]], jsii.get(self, "dataExtraDimensions"))
|
|
459
462
|
|
|
460
463
|
@data_extra_dimensions.setter
|
|
@@ -472,6 +475,7 @@ class CfnCampaign(
|
|
|
472
475
|
def data_partitions(
|
|
473
476
|
self,
|
|
474
477
|
) -> typing.Optional[typing.Union[_IResolvable_da3f097b, typing.List[typing.Union[_IResolvable_da3f097b, "CfnCampaign.DataPartitionProperty"]]]]:
|
|
478
|
+
'''The data partitions associated with the signals collected from the vehicle.'''
|
|
475
479
|
return typing.cast(typing.Optional[typing.Union[_IResolvable_da3f097b, typing.List[typing.Union[_IResolvable_da3f097b, "CfnCampaign.DataPartitionProperty"]]]], jsii.get(self, "dataPartitions"))
|
|
476
480
|
|
|
477
481
|
@data_partitions.setter
|
|
@@ -487,7 +491,7 @@ class CfnCampaign(
|
|
|
487
491
|
@builtins.property
|
|
488
492
|
@jsii.member(jsii_name="description")
|
|
489
493
|
def description(self) -> typing.Optional[builtins.str]:
|
|
490
|
-
'''
|
|
494
|
+
'''The description of the campaign.'''
|
|
491
495
|
return typing.cast(typing.Optional[builtins.str], jsii.get(self, "description"))
|
|
492
496
|
|
|
493
497
|
@description.setter
|
|
@@ -500,7 +504,7 @@ class CfnCampaign(
|
|
|
500
504
|
@builtins.property
|
|
501
505
|
@jsii.member(jsii_name="diagnosticsMode")
|
|
502
506
|
def diagnostics_mode(self) -> typing.Optional[builtins.str]:
|
|
503
|
-
'''
|
|
507
|
+
'''Option for a vehicle to send diagnostic trouble codes to AWS IoT FleetWise .'''
|
|
504
508
|
return typing.cast(typing.Optional[builtins.str], jsii.get(self, "diagnosticsMode"))
|
|
505
509
|
|
|
506
510
|
@diagnostics_mode.setter
|
|
@@ -513,7 +517,7 @@ class CfnCampaign(
|
|
|
513
517
|
@builtins.property
|
|
514
518
|
@jsii.member(jsii_name="expiryTime")
|
|
515
519
|
def expiry_time(self) -> typing.Optional[builtins.str]:
|
|
516
|
-
'''
|
|
520
|
+
'''The time the campaign expires, in seconds since epoch (January 1, 1970 at midnight UTC time).'''
|
|
517
521
|
return typing.cast(typing.Optional[builtins.str], jsii.get(self, "expiryTime"))
|
|
518
522
|
|
|
519
523
|
@expiry_time.setter
|
|
@@ -526,7 +530,7 @@ class CfnCampaign(
|
|
|
526
530
|
@builtins.property
|
|
527
531
|
@jsii.member(jsii_name="postTriggerCollectionDuration")
|
|
528
532
|
def post_trigger_collection_duration(self) -> typing.Optional[jsii.Number]:
|
|
529
|
-
'''
|
|
533
|
+
'''How long (in milliseconds) to collect raw data after a triggering event initiates the collection.'''
|
|
530
534
|
return typing.cast(typing.Optional[jsii.Number], jsii.get(self, "postTriggerCollectionDuration"))
|
|
531
535
|
|
|
532
536
|
@post_trigger_collection_duration.setter
|
|
@@ -542,7 +546,7 @@ class CfnCampaign(
|
|
|
542
546
|
@builtins.property
|
|
543
547
|
@jsii.member(jsii_name="priority")
|
|
544
548
|
def priority(self) -> typing.Optional[jsii.Number]:
|
|
545
|
-
'''
|
|
549
|
+
'''A number indicating the priority of one campaign over another campaign for a certain vehicle or fleet.'''
|
|
546
550
|
return typing.cast(typing.Optional[jsii.Number], jsii.get(self, "priority"))
|
|
547
551
|
|
|
548
552
|
@priority.setter
|
|
@@ -557,7 +561,7 @@ class CfnCampaign(
|
|
|
557
561
|
def signals_to_collect(
|
|
558
562
|
self,
|
|
559
563
|
) -> typing.Optional[typing.Union[_IResolvable_da3f097b, typing.List[typing.Union[_IResolvable_da3f097b, "CfnCampaign.SignalInformationProperty"]]]]:
|
|
560
|
-
'''
|
|
564
|
+
'''A list of information about signals to collect.'''
|
|
561
565
|
return typing.cast(typing.Optional[typing.Union[_IResolvable_da3f097b, typing.List[typing.Union[_IResolvable_da3f097b, "CfnCampaign.SignalInformationProperty"]]]], jsii.get(self, "signalsToCollect"))
|
|
562
566
|
|
|
563
567
|
@signals_to_collect.setter
|
|
@@ -575,6 +579,7 @@ class CfnCampaign(
|
|
|
575
579
|
def signals_to_fetch(
|
|
576
580
|
self,
|
|
577
581
|
) -> typing.Optional[typing.Union[_IResolvable_da3f097b, typing.List[typing.Union[_IResolvable_da3f097b, "CfnCampaign.SignalFetchInformationProperty"]]]]:
|
|
582
|
+
'''A list of information about signals to fetch.'''
|
|
578
583
|
return typing.cast(typing.Optional[typing.Union[_IResolvable_da3f097b, typing.List[typing.Union[_IResolvable_da3f097b, "CfnCampaign.SignalFetchInformationProperty"]]]], jsii.get(self, "signalsToFetch"))
|
|
579
584
|
|
|
580
585
|
@signals_to_fetch.setter
|
|
@@ -590,7 +595,7 @@ class CfnCampaign(
|
|
|
590
595
|
@builtins.property
|
|
591
596
|
@jsii.member(jsii_name="spoolingMode")
|
|
592
597
|
def spooling_mode(self) -> typing.Optional[builtins.str]:
|
|
593
|
-
'''
|
|
598
|
+
'''Whether to store collected data after a vehicle lost a connection with the cloud.'''
|
|
594
599
|
return typing.cast(typing.Optional[builtins.str], jsii.get(self, "spoolingMode"))
|
|
595
600
|
|
|
596
601
|
@spooling_mode.setter
|
|
@@ -603,7 +608,10 @@ class CfnCampaign(
|
|
|
603
608
|
@builtins.property
|
|
604
609
|
@jsii.member(jsii_name="startTime")
|
|
605
610
|
def start_time(self) -> typing.Optional[builtins.str]:
|
|
606
|
-
'''
|
|
611
|
+
'''The time, in milliseconds, to deliver a campaign after it was approved.
|
|
612
|
+
|
|
613
|
+
If it's not specified, ``0`` is used.
|
|
614
|
+
'''
|
|
607
615
|
return typing.cast(typing.Optional[builtins.str], jsii.get(self, "startTime"))
|
|
608
616
|
|
|
609
617
|
@start_time.setter
|
|
@@ -616,7 +624,7 @@ class CfnCampaign(
|
|
|
616
624
|
@builtins.property
|
|
617
625
|
@jsii.member(jsii_name="tagsRaw")
|
|
618
626
|
def tags_raw(self) -> typing.Optional[typing.List[_CfnTag_f6864754]]:
|
|
619
|
-
'''
|
|
627
|
+
'''Metadata that can be used to manage the campaign.'''
|
|
620
628
|
return typing.cast(typing.Optional[typing.List[_CfnTag_f6864754]], jsii.get(self, "tagsRaw"))
|
|
621
629
|
|
|
622
630
|
@tags_raw.setter
|
|
@@ -643,8 +651,8 @@ class CfnCampaign(
|
|
|
643
651
|
) -> None:
|
|
644
652
|
'''Specifies what data to collect and how often or when to collect it.
|
|
645
653
|
|
|
646
|
-
:param condition_based_collection_scheme:
|
|
647
|
-
:param time_based_collection_scheme:
|
|
654
|
+
:param condition_based_collection_scheme: Information about a collection scheme that uses a simple logical expression to recognize what data to collect.
|
|
655
|
+
:param time_based_collection_scheme: Information about a collection scheme that uses a time period to decide how often to collect data.
|
|
648
656
|
|
|
649
657
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotfleetwise-campaign-collectionscheme.html
|
|
650
658
|
:exampleMetadata: fixture=_generated
|
|
@@ -683,7 +691,7 @@ class CfnCampaign(
|
|
|
683
691
|
def condition_based_collection_scheme(
|
|
684
692
|
self,
|
|
685
693
|
) -> typing.Optional[typing.Union[_IResolvable_da3f097b, "CfnCampaign.ConditionBasedCollectionSchemeProperty"]]:
|
|
686
|
-
'''
|
|
694
|
+
'''Information about a collection scheme that uses a simple logical expression to recognize what data to collect.
|
|
687
695
|
|
|
688
696
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotfleetwise-campaign-collectionscheme.html#cfn-iotfleetwise-campaign-collectionscheme-conditionbasedcollectionscheme
|
|
689
697
|
'''
|
|
@@ -694,7 +702,7 @@ class CfnCampaign(
|
|
|
694
702
|
def time_based_collection_scheme(
|
|
695
703
|
self,
|
|
696
704
|
) -> typing.Optional[typing.Union[_IResolvable_da3f097b, "CfnCampaign.TimeBasedCollectionSchemeProperty"]]:
|
|
697
|
-
'''
|
|
705
|
+
'''Information about a collection scheme that uses a time period to decide how often to collect data.
|
|
698
706
|
|
|
699
707
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotfleetwise-campaign-collectionscheme.html#cfn-iotfleetwise-campaign-collectionscheme-timebasedcollectionscheme
|
|
700
708
|
'''
|
|
@@ -734,9 +742,9 @@ class CfnCampaign(
|
|
|
734
742
|
'''Information about a collection scheme that uses a simple logical expression to recognize what data to collect.
|
|
735
743
|
|
|
736
744
|
:param expression: The logical expression used to recognize what data to collect. For example, ``$variable.Vehicle.OutsideAirTemperature >= 105.0`` .
|
|
737
|
-
:param condition_language_version:
|
|
738
|
-
:param minimum_trigger_interval_ms:
|
|
739
|
-
:param trigger_mode:
|
|
745
|
+
:param condition_language_version: Specifies the version of the conditional expression language.
|
|
746
|
+
:param minimum_trigger_interval_ms: 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.
|
|
747
|
+
:param 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.
|
|
740
748
|
|
|
741
749
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotfleetwise-campaign-conditionbasedcollectionscheme.html
|
|
742
750
|
:exampleMetadata: fixture=_generated
|
|
@@ -786,7 +794,7 @@ class CfnCampaign(
|
|
|
786
794
|
|
|
787
795
|
@builtins.property
|
|
788
796
|
def condition_language_version(self) -> typing.Optional[jsii.Number]:
|
|
789
|
-
'''
|
|
797
|
+
'''Specifies the version of the conditional expression language.
|
|
790
798
|
|
|
791
799
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotfleetwise-campaign-conditionbasedcollectionscheme.html#cfn-iotfleetwise-campaign-conditionbasedcollectionscheme-conditionlanguageversion
|
|
792
800
|
'''
|
|
@@ -795,7 +803,7 @@ class CfnCampaign(
|
|
|
795
803
|
|
|
796
804
|
@builtins.property
|
|
797
805
|
def minimum_trigger_interval_ms(self) -> typing.Optional[jsii.Number]:
|
|
798
|
-
'''
|
|
806
|
+
'''The minimum duration of time between two triggering events to collect data, in milliseconds.
|
|
799
807
|
|
|
800
808
|
.. epigraph::
|
|
801
809
|
|
|
@@ -808,7 +816,7 @@ class CfnCampaign(
|
|
|
808
816
|
|
|
809
817
|
@builtins.property
|
|
810
818
|
def trigger_mode(self) -> typing.Optional[builtins.str]:
|
|
811
|
-
'''
|
|
819
|
+
'''Whether to collect data for all triggering events ( ``ALWAYS`` ).
|
|
812
820
|
|
|
813
821
|
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.
|
|
814
822
|
|
|
@@ -843,9 +851,10 @@ class CfnCampaign(
|
|
|
843
851
|
condition_expression: builtins.str,
|
|
844
852
|
trigger_mode: builtins.str,
|
|
845
853
|
) -> None:
|
|
846
|
-
'''
|
|
847
|
-
|
|
848
|
-
:param
|
|
854
|
+
'''Specifies the condition under which a signal fetch occurs.
|
|
855
|
+
|
|
856
|
+
:param condition_expression: The condition that must be satisfied to trigger a signal fetch.
|
|
857
|
+
:param trigger_mode: Indicates the mode in which the signal fetch is triggered.
|
|
849
858
|
|
|
850
859
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotfleetwise-campaign-conditionbasedsignalfetchconfig.html
|
|
851
860
|
:exampleMetadata: fixture=_generated
|
|
@@ -872,7 +881,8 @@ class CfnCampaign(
|
|
|
872
881
|
|
|
873
882
|
@builtins.property
|
|
874
883
|
def condition_expression(self) -> builtins.str:
|
|
875
|
-
'''
|
|
884
|
+
'''The condition that must be satisfied to trigger a signal fetch.
|
|
885
|
+
|
|
876
886
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotfleetwise-campaign-conditionbasedsignalfetchconfig.html#cfn-iotfleetwise-campaign-conditionbasedsignalfetchconfig-conditionexpression
|
|
877
887
|
'''
|
|
878
888
|
result = self._values.get("condition_expression")
|
|
@@ -881,7 +891,8 @@ class CfnCampaign(
|
|
|
881
891
|
|
|
882
892
|
@builtins.property
|
|
883
893
|
def trigger_mode(self) -> builtins.str:
|
|
884
|
-
'''
|
|
894
|
+
'''Indicates the mode in which the signal fetch is triggered.
|
|
895
|
+
|
|
885
896
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotfleetwise-campaign-conditionbasedsignalfetchconfig.html#cfn-iotfleetwise-campaign-conditionbasedsignalfetchconfig-triggermode
|
|
886
897
|
'''
|
|
887
898
|
result = self._values.get("trigger_mode")
|
|
@@ -920,9 +931,9 @@ class CfnCampaign(
|
|
|
920
931
|
|
|
921
932
|
You can send data to be stored in Amazon S3 or Amazon Timestream .
|
|
922
933
|
|
|
923
|
-
:param mqtt_topic_config:
|
|
924
|
-
:param s3_config:
|
|
925
|
-
:param timestream_config:
|
|
934
|
+
:param mqtt_topic_config: 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 <https://docs.aws.amazon.com/iot-fleetwise/latest/developerguide/fleetwise-regions.html>`_ in the *AWS IoT FleetWise Developer Guide* .
|
|
935
|
+
:param s3_config: The Amazon S3 bucket where the AWS IoT FleetWise campaign sends data.
|
|
936
|
+
:param timestream_config: The Amazon Timestream table where the campaign sends data.
|
|
926
937
|
|
|
927
938
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotfleetwise-campaign-datadestinationconfig.html
|
|
928
939
|
:exampleMetadata: fixture=_generated
|
|
@@ -969,7 +980,12 @@ class CfnCampaign(
|
|
|
969
980
|
def mqtt_topic_config(
|
|
970
981
|
self,
|
|
971
982
|
) -> typing.Optional[typing.Union[_IResolvable_da3f097b, "CfnCampaign.MqttTopicConfigProperty"]]:
|
|
972
|
-
'''
|
|
983
|
+
'''The MQTT topic to which the AWS IoT FleetWise campaign routes data.
|
|
984
|
+
|
|
985
|
+
.. epigraph::
|
|
986
|
+
|
|
987
|
+
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* .
|
|
988
|
+
|
|
973
989
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotfleetwise-campaign-datadestinationconfig.html#cfn-iotfleetwise-campaign-datadestinationconfig-mqtttopicconfig
|
|
974
990
|
'''
|
|
975
991
|
result = self._values.get("mqtt_topic_config")
|
|
@@ -979,7 +995,7 @@ class CfnCampaign(
|
|
|
979
995
|
def s3_config(
|
|
980
996
|
self,
|
|
981
997
|
) -> typing.Optional[typing.Union[_IResolvable_da3f097b, "CfnCampaign.S3ConfigProperty"]]:
|
|
982
|
-
'''
|
|
998
|
+
'''The Amazon S3 bucket where the AWS IoT FleetWise campaign sends data.
|
|
983
999
|
|
|
984
1000
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotfleetwise-campaign-datadestinationconfig.html#cfn-iotfleetwise-campaign-datadestinationconfig-s3config
|
|
985
1001
|
'''
|
|
@@ -990,7 +1006,7 @@ class CfnCampaign(
|
|
|
990
1006
|
def timestream_config(
|
|
991
1007
|
self,
|
|
992
1008
|
) -> typing.Optional[typing.Union[_IResolvable_da3f097b, "CfnCampaign.TimestreamConfigProperty"]]:
|
|
993
|
-
'''
|
|
1009
|
+
'''The Amazon Timestream table where the campaign sends data.
|
|
994
1010
|
|
|
995
1011
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotfleetwise-campaign-datadestinationconfig.html#cfn-iotfleetwise-campaign-datadestinationconfig-timestreamconfig
|
|
996
1012
|
'''
|
|
@@ -1025,10 +1041,16 @@ class CfnCampaign(
|
|
|
1025
1041
|
storage_options: typing.Union[_IResolvable_da3f097b, typing.Union["CfnCampaign.DataPartitionStorageOptionsProperty", typing.Dict[builtins.str, typing.Any]]],
|
|
1026
1042
|
upload_options: typing.Optional[typing.Union[_IResolvable_da3f097b, typing.Union["CfnCampaign.DataPartitionUploadOptionsProperty", typing.Dict[builtins.str, typing.Any]]]] = None,
|
|
1027
1043
|
) -> None:
|
|
1028
|
-
'''
|
|
1029
|
-
|
|
1030
|
-
|
|
1031
|
-
|
|
1044
|
+
'''The configuration for signal data storage and upload options.
|
|
1045
|
+
|
|
1046
|
+
You can only specify these options when the campaign's spooling mode is ``TO_DISK`` .
|
|
1047
|
+
.. epigraph::
|
|
1048
|
+
|
|
1049
|
+
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* .
|
|
1050
|
+
|
|
1051
|
+
:param 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.
|
|
1052
|
+
:param storage_options: The storage options for a data partition.
|
|
1053
|
+
:param upload_options: The upload options for the data partition.
|
|
1032
1054
|
|
|
1033
1055
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotfleetwise-campaign-datapartition.html
|
|
1034
1056
|
:exampleMetadata: fixture=_generated
|
|
@@ -1076,7 +1098,10 @@ class CfnCampaign(
|
|
|
1076
1098
|
|
|
1077
1099
|
@builtins.property
|
|
1078
1100
|
def id(self) -> builtins.str:
|
|
1079
|
-
'''
|
|
1101
|
+
'''The ID of the data partition.
|
|
1102
|
+
|
|
1103
|
+
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.
|
|
1104
|
+
|
|
1080
1105
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotfleetwise-campaign-datapartition.html#cfn-iotfleetwise-campaign-datapartition-id
|
|
1081
1106
|
'''
|
|
1082
1107
|
result = self._values.get("id")
|
|
@@ -1087,7 +1112,8 @@ class CfnCampaign(
|
|
|
1087
1112
|
def storage_options(
|
|
1088
1113
|
self,
|
|
1089
1114
|
) -> typing.Union[_IResolvable_da3f097b, "CfnCampaign.DataPartitionStorageOptionsProperty"]:
|
|
1090
|
-
'''
|
|
1115
|
+
'''The storage options for a data partition.
|
|
1116
|
+
|
|
1091
1117
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotfleetwise-campaign-datapartition.html#cfn-iotfleetwise-campaign-datapartition-storageoptions
|
|
1092
1118
|
'''
|
|
1093
1119
|
result = self._values.get("storage_options")
|
|
@@ -1098,7 +1124,8 @@ class CfnCampaign(
|
|
|
1098
1124
|
def upload_options(
|
|
1099
1125
|
self,
|
|
1100
1126
|
) -> typing.Optional[typing.Union[_IResolvable_da3f097b, "CfnCampaign.DataPartitionUploadOptionsProperty"]]:
|
|
1101
|
-
'''
|
|
1127
|
+
'''The upload options for the data partition.
|
|
1128
|
+
|
|
1102
1129
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotfleetwise-campaign-datapartition.html#cfn-iotfleetwise-campaign-datapartition-uploadoptions
|
|
1103
1130
|
'''
|
|
1104
1131
|
result = self._values.get("upload_options")
|
|
@@ -1132,10 +1159,11 @@ class CfnCampaign(
|
|
|
1132
1159
|
minimum_time_to_live: typing.Union[_IResolvable_da3f097b, typing.Union["CfnCampaign.StorageMinimumTimeToLiveProperty", typing.Dict[builtins.str, typing.Any]]],
|
|
1133
1160
|
storage_location: builtins.str,
|
|
1134
1161
|
) -> None:
|
|
1135
|
-
'''
|
|
1136
|
-
|
|
1137
|
-
:param
|
|
1138
|
-
:param
|
|
1162
|
+
'''Size, time, and location options for the data partition.
|
|
1163
|
+
|
|
1164
|
+
:param maximum_size: 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.
|
|
1165
|
+
:param 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.
|
|
1166
|
+
:param storage_location: The folder name for the data partition under the campaign storage folder.
|
|
1139
1167
|
|
|
1140
1168
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotfleetwise-campaign-datapartitionstorageoptions.html
|
|
1141
1169
|
:exampleMetadata: fixture=_generated
|
|
@@ -1173,7 +1201,12 @@ class CfnCampaign(
|
|
|
1173
1201
|
def maximum_size(
|
|
1174
1202
|
self,
|
|
1175
1203
|
) -> typing.Union[_IResolvable_da3f097b, "CfnCampaign.StorageMaximumSizeProperty"]:
|
|
1176
|
-
'''
|
|
1204
|
+
'''The maximum storage size of the data stored in the data partition.
|
|
1205
|
+
|
|
1206
|
+
.. epigraph::
|
|
1207
|
+
|
|
1208
|
+
Newer data overwrites older data when the partition reaches the maximum size.
|
|
1209
|
+
|
|
1177
1210
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotfleetwise-campaign-datapartitionstorageoptions.html#cfn-iotfleetwise-campaign-datapartitionstorageoptions-maximumsize
|
|
1178
1211
|
'''
|
|
1179
1212
|
result = self._values.get("maximum_size")
|
|
@@ -1184,7 +1217,12 @@ class CfnCampaign(
|
|
|
1184
1217
|
def minimum_time_to_live(
|
|
1185
1218
|
self,
|
|
1186
1219
|
) -> typing.Union[_IResolvable_da3f097b, "CfnCampaign.StorageMinimumTimeToLiveProperty"]:
|
|
1187
|
-
'''
|
|
1220
|
+
'''The amount of time that data in this partition will be kept on disk.
|
|
1221
|
+
|
|
1222
|
+
- After the designated amount of time passes, the data can be removed, but it's not guaranteed to be removed.
|
|
1223
|
+
- Before the time expires, data in this partition can still be deleted if the partition reaches its configured maximum size.
|
|
1224
|
+
- Newer data will overwrite older data when the partition reaches the maximum size.
|
|
1225
|
+
|
|
1188
1226
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotfleetwise-campaign-datapartitionstorageoptions.html#cfn-iotfleetwise-campaign-datapartitionstorageoptions-minimumtimetolive
|
|
1189
1227
|
'''
|
|
1190
1228
|
result = self._values.get("minimum_time_to_live")
|
|
@@ -1193,7 +1231,8 @@ class CfnCampaign(
|
|
|
1193
1231
|
|
|
1194
1232
|
@builtins.property
|
|
1195
1233
|
def storage_location(self) -> builtins.str:
|
|
1196
|
-
'''
|
|
1234
|
+
'''The folder name for the data partition under the campaign storage folder.
|
|
1235
|
+
|
|
1197
1236
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotfleetwise-campaign-datapartitionstorageoptions.html#cfn-iotfleetwise-campaign-datapartitionstorageoptions-storagelocation
|
|
1198
1237
|
'''
|
|
1199
1238
|
result = self._values.get("storage_location")
|
|
@@ -1226,9 +1265,15 @@ class CfnCampaign(
|
|
|
1226
1265
|
expression: builtins.str,
|
|
1227
1266
|
condition_language_version: typing.Optional[jsii.Number] = None,
|
|
1228
1267
|
) -> None:
|
|
1229
|
-
'''
|
|
1230
|
-
|
|
1231
|
-
|
|
1268
|
+
'''The upload options for the data partition.
|
|
1269
|
+
|
|
1270
|
+
If upload options are specified, you must also specify storage options. See `DataPartitionStorageOptions <https://docs.aws.amazon.com/iot-fleetwise/latest/APIReference/API_DataPartitionStorageOptions.html>`_ .
|
|
1271
|
+
.. epigraph::
|
|
1272
|
+
|
|
1273
|
+
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* .
|
|
1274
|
+
|
|
1275
|
+
:param expression: The logical expression used to recognize what data to collect. For example, ``$variable.``Vehicle.OutsideAirTemperature`` >= 105.0`` .
|
|
1276
|
+
:param condition_language_version: The version of the condition language. Defaults to the most recent condition language version.
|
|
1232
1277
|
|
|
1233
1278
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotfleetwise-campaign-datapartitionuploadoptions.html
|
|
1234
1279
|
:exampleMetadata: fixture=_generated
|
|
@@ -1258,7 +1303,10 @@ class CfnCampaign(
|
|
|
1258
1303
|
|
|
1259
1304
|
@builtins.property
|
|
1260
1305
|
def expression(self) -> builtins.str:
|
|
1261
|
-
'''
|
|
1306
|
+
'''The logical expression used to recognize what data to collect.
|
|
1307
|
+
|
|
1308
|
+
For example, ``$variable.``Vehicle.OutsideAirTemperature`` >= 105.0`` .
|
|
1309
|
+
|
|
1262
1310
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotfleetwise-campaign-datapartitionuploadoptions.html#cfn-iotfleetwise-campaign-datapartitionuploadoptions-expression
|
|
1263
1311
|
'''
|
|
1264
1312
|
result = self._values.get("expression")
|
|
@@ -1267,7 +1315,10 @@ class CfnCampaign(
|
|
|
1267
1315
|
|
|
1268
1316
|
@builtins.property
|
|
1269
1317
|
def condition_language_version(self) -> typing.Optional[jsii.Number]:
|
|
1270
|
-
'''
|
|
1318
|
+
'''The version of the condition language.
|
|
1319
|
+
|
|
1320
|
+
Defaults to the most recent condition language version.
|
|
1321
|
+
|
|
1271
1322
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotfleetwise-campaign-datapartitionuploadoptions.html#cfn-iotfleetwise-campaign-datapartitionuploadoptions-conditionlanguageversion
|
|
1272
1323
|
'''
|
|
1273
1324
|
result = self._values.get("condition_language_version")
|
|
@@ -1299,9 +1350,15 @@ class CfnCampaign(
|
|
|
1299
1350
|
execution_role_arn: builtins.str,
|
|
1300
1351
|
mqtt_topic_arn: builtins.str,
|
|
1301
1352
|
) -> None:
|
|
1302
|
-
'''
|
|
1303
|
-
|
|
1304
|
-
|
|
1353
|
+
'''The MQTT topic to which the AWS IoT FleetWise campaign routes data.
|
|
1354
|
+
|
|
1355
|
+
For more information, see `Device communication protocols <https://docs.aws.amazon.com/iot/latest/developerguide/protocols.html>`_ in the *AWS IoT Core Developer Guide* .
|
|
1356
|
+
.. epigraph::
|
|
1357
|
+
|
|
1358
|
+
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* .
|
|
1359
|
+
|
|
1360
|
+
:param 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.
|
|
1361
|
+
:param mqtt_topic_arn: The ARN of the MQTT topic.
|
|
1305
1362
|
|
|
1306
1363
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotfleetwise-campaign-mqtttopicconfig.html
|
|
1307
1364
|
:exampleMetadata: fixture=_generated
|
|
@@ -1328,7 +1385,8 @@ class CfnCampaign(
|
|
|
1328
1385
|
|
|
1329
1386
|
@builtins.property
|
|
1330
1387
|
def execution_role_arn(self) -> builtins.str:
|
|
1331
|
-
'''
|
|
1388
|
+
'''The ARN of the role that grants AWS IoT FleetWise permission to access and act on messages sent to the MQTT topic.
|
|
1389
|
+
|
|
1332
1390
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotfleetwise-campaign-mqtttopicconfig.html#cfn-iotfleetwise-campaign-mqtttopicconfig-executionrolearn
|
|
1333
1391
|
'''
|
|
1334
1392
|
result = self._values.get("execution_role_arn")
|
|
@@ -1337,7 +1395,8 @@ class CfnCampaign(
|
|
|
1337
1395
|
|
|
1338
1396
|
@builtins.property
|
|
1339
1397
|
def mqtt_topic_arn(self) -> builtins.str:
|
|
1340
|
-
'''
|
|
1398
|
+
'''The ARN of the MQTT topic.
|
|
1399
|
+
|
|
1341
1400
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotfleetwise-campaign-mqtttopicconfig.html#cfn-iotfleetwise-campaign-mqtttopicconfig-mqtttopicarn
|
|
1342
1401
|
'''
|
|
1343
1402
|
result = self._values.get("mqtt_topic_arn")
|
|
@@ -1379,9 +1438,9 @@ class CfnCampaign(
|
|
|
1379
1438
|
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 <https://docs.aws.amazon.com/AmazonS3/latest/userguide/creating-buckets-s3.html>`_ in the *Amazon Simple Storage Service User Guide* .
|
|
1380
1439
|
|
|
1381
1440
|
:param bucket_arn: The Amazon Resource Name (ARN) of the Amazon S3 bucket.
|
|
1382
|
-
:param data_format:
|
|
1383
|
-
:param prefix:
|
|
1384
|
-
:param storage_compression_format:
|
|
1441
|
+
:param 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.
|
|
1442
|
+
:param 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 <https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-prefixes.html>`_ 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/`` .
|
|
1443
|
+
:param 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.
|
|
1385
1444
|
|
|
1386
1445
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotfleetwise-campaign-s3config.html
|
|
1387
1446
|
:exampleMetadata: fixture=_generated
|
|
@@ -1429,7 +1488,7 @@ class CfnCampaign(
|
|
|
1429
1488
|
|
|
1430
1489
|
@builtins.property
|
|
1431
1490
|
def data_format(self) -> typing.Optional[builtins.str]:
|
|
1432
|
-
'''
|
|
1491
|
+
'''Specify the format that files are saved in the Amazon S3 bucket.
|
|
1433
1492
|
|
|
1434
1493
|
You can save files in an Apache Parquet or JSON format.
|
|
1435
1494
|
|
|
@@ -1443,7 +1502,7 @@ class CfnCampaign(
|
|
|
1443
1502
|
|
|
1444
1503
|
@builtins.property
|
|
1445
1504
|
def prefix(self) -> typing.Optional[builtins.str]:
|
|
1446
|
-
'''
|
|
1505
|
+
'''Enter an S3 bucket prefix.
|
|
1447
1506
|
|
|
1448
1507
|
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 <https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-prefixes.html>`_ in the *Amazon Simple Storage Service User Guide* .
|
|
1449
1508
|
|
|
@@ -1456,7 +1515,7 @@ class CfnCampaign(
|
|
|
1456
1515
|
|
|
1457
1516
|
@builtins.property
|
|
1458
1517
|
def storage_compression_format(self) -> typing.Optional[builtins.str]:
|
|
1459
|
-
'''
|
|
1518
|
+
'''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.
|
|
1460
1519
|
|
|
1461
1520
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotfleetwise-campaign-s3config.html#cfn-iotfleetwise-campaign-s3config-storagecompressionformat
|
|
1462
1521
|
'''
|
|
@@ -1486,9 +1545,14 @@ class CfnCampaign(
|
|
|
1486
1545
|
condition_based: typing.Optional[typing.Union[_IResolvable_da3f097b, typing.Union["CfnCampaign.ConditionBasedSignalFetchConfigProperty", typing.Dict[builtins.str, typing.Any]]]] = None,
|
|
1487
1546
|
time_based: typing.Optional[typing.Union[_IResolvable_da3f097b, typing.Union["CfnCampaign.TimeBasedSignalFetchConfigProperty", typing.Dict[builtins.str, typing.Any]]]] = None,
|
|
1488
1547
|
) -> None:
|
|
1489
|
-
'''
|
|
1490
|
-
|
|
1491
|
-
|
|
1548
|
+
'''The configuration of the signal fetch operation.
|
|
1549
|
+
|
|
1550
|
+
.. epigraph::
|
|
1551
|
+
|
|
1552
|
+
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* .
|
|
1553
|
+
|
|
1554
|
+
:param condition_based: The configuration of a condition-based signal fetch operation.
|
|
1555
|
+
:param time_based: The configuration of a time-based signal fetch operation.
|
|
1492
1556
|
|
|
1493
1557
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotfleetwise-campaign-signalfetchconfig.html
|
|
1494
1558
|
:exampleMetadata: fixture=_generated
|
|
@@ -1523,7 +1587,8 @@ class CfnCampaign(
|
|
|
1523
1587
|
def condition_based(
|
|
1524
1588
|
self,
|
|
1525
1589
|
) -> typing.Optional[typing.Union[_IResolvable_da3f097b, "CfnCampaign.ConditionBasedSignalFetchConfigProperty"]]:
|
|
1526
|
-
'''
|
|
1590
|
+
'''The configuration of a condition-based signal fetch operation.
|
|
1591
|
+
|
|
1527
1592
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotfleetwise-campaign-signalfetchconfig.html#cfn-iotfleetwise-campaign-signalfetchconfig-conditionbased
|
|
1528
1593
|
'''
|
|
1529
1594
|
result = self._values.get("condition_based")
|
|
@@ -1533,7 +1598,8 @@ class CfnCampaign(
|
|
|
1533
1598
|
def time_based(
|
|
1534
1599
|
self,
|
|
1535
1600
|
) -> typing.Optional[typing.Union[_IResolvable_da3f097b, "CfnCampaign.TimeBasedSignalFetchConfigProperty"]]:
|
|
1536
|
-
'''
|
|
1601
|
+
'''The configuration of a time-based signal fetch operation.
|
|
1602
|
+
|
|
1537
1603
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotfleetwise-campaign-signalfetchconfig.html#cfn-iotfleetwise-campaign-signalfetchconfig-timebased
|
|
1538
1604
|
'''
|
|
1539
1605
|
result = self._values.get("time_based")
|
|
@@ -1569,11 +1635,16 @@ class CfnCampaign(
|
|
|
1569
1635
|
signal_fetch_config: typing.Union[_IResolvable_da3f097b, typing.Union["CfnCampaign.SignalFetchConfigProperty", typing.Dict[builtins.str, typing.Any]]],
|
|
1570
1636
|
condition_language_version: typing.Optional[jsii.Number] = None,
|
|
1571
1637
|
) -> None:
|
|
1572
|
-
'''
|
|
1573
|
-
|
|
1574
|
-
|
|
1575
|
-
|
|
1576
|
-
|
|
1638
|
+
'''Information about the signal to be fetched.
|
|
1639
|
+
|
|
1640
|
+
.. epigraph::
|
|
1641
|
+
|
|
1642
|
+
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* .
|
|
1643
|
+
|
|
1644
|
+
:param actions: The actions to be performed by the signal fetch.
|
|
1645
|
+
:param fully_qualified_name: The fully qualified name of the signal to be fetched.
|
|
1646
|
+
:param signal_fetch_config: The configuration of the signal fetch operation.
|
|
1647
|
+
:param condition_language_version: The version of the condition language used.
|
|
1577
1648
|
|
|
1578
1649
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotfleetwise-campaign-signalfetchinformation.html
|
|
1579
1650
|
:exampleMetadata: fixture=_generated
|
|
@@ -1617,7 +1688,8 @@ class CfnCampaign(
|
|
|
1617
1688
|
|
|
1618
1689
|
@builtins.property
|
|
1619
1690
|
def actions(self) -> typing.List[builtins.str]:
|
|
1620
|
-
'''
|
|
1691
|
+
'''The actions to be performed by the signal fetch.
|
|
1692
|
+
|
|
1621
1693
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotfleetwise-campaign-signalfetchinformation.html#cfn-iotfleetwise-campaign-signalfetchinformation-actions
|
|
1622
1694
|
'''
|
|
1623
1695
|
result = self._values.get("actions")
|
|
@@ -1626,7 +1698,8 @@ class CfnCampaign(
|
|
|
1626
1698
|
|
|
1627
1699
|
@builtins.property
|
|
1628
1700
|
def fully_qualified_name(self) -> builtins.str:
|
|
1629
|
-
'''
|
|
1701
|
+
'''The fully qualified name of the signal to be fetched.
|
|
1702
|
+
|
|
1630
1703
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotfleetwise-campaign-signalfetchinformation.html#cfn-iotfleetwise-campaign-signalfetchinformation-fullyqualifiedname
|
|
1631
1704
|
'''
|
|
1632
1705
|
result = self._values.get("fully_qualified_name")
|
|
@@ -1637,7 +1710,8 @@ class CfnCampaign(
|
|
|
1637
1710
|
def signal_fetch_config(
|
|
1638
1711
|
self,
|
|
1639
1712
|
) -> typing.Union[_IResolvable_da3f097b, "CfnCampaign.SignalFetchConfigProperty"]:
|
|
1640
|
-
'''
|
|
1713
|
+
'''The configuration of the signal fetch operation.
|
|
1714
|
+
|
|
1641
1715
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotfleetwise-campaign-signalfetchinformation.html#cfn-iotfleetwise-campaign-signalfetchinformation-signalfetchconfig
|
|
1642
1716
|
'''
|
|
1643
1717
|
result = self._values.get("signal_fetch_config")
|
|
@@ -1646,7 +1720,8 @@ class CfnCampaign(
|
|
|
1646
1720
|
|
|
1647
1721
|
@builtins.property
|
|
1648
1722
|
def condition_language_version(self) -> typing.Optional[jsii.Number]:
|
|
1649
|
-
'''
|
|
1723
|
+
'''The version of the condition language used.
|
|
1724
|
+
|
|
1650
1725
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotfleetwise-campaign-signalfetchinformation.html#cfn-iotfleetwise-campaign-signalfetchinformation-conditionlanguageversion
|
|
1651
1726
|
'''
|
|
1652
1727
|
result = self._values.get("condition_language_version")
|
|
@@ -1685,9 +1760,9 @@ class CfnCampaign(
|
|
|
1685
1760
|
'''Information about a signal.
|
|
1686
1761
|
|
|
1687
1762
|
:param name: The name of the signal.
|
|
1688
|
-
:param data_partition_id:
|
|
1689
|
-
:param max_sample_count:
|
|
1690
|
-
:param minimum_sampling_interval_ms:
|
|
1763
|
+
:param 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* .
|
|
1764
|
+
:param max_sample_count: The maximum number of samples to collect.
|
|
1765
|
+
:param minimum_sampling_interval_ms: 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.
|
|
1691
1766
|
|
|
1692
1767
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotfleetwise-campaign-signalinformation.html
|
|
1693
1768
|
:exampleMetadata: fixture=_generated
|
|
@@ -1735,7 +1810,13 @@ class CfnCampaign(
|
|
|
1735
1810
|
|
|
1736
1811
|
@builtins.property
|
|
1737
1812
|
def data_partition_id(self) -> typing.Optional[builtins.str]:
|
|
1738
|
-
'''
|
|
1813
|
+
'''The ID of the data partition this signal is associated with.
|
|
1814
|
+
|
|
1815
|
+
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.
|
|
1816
|
+
.. epigraph::
|
|
1817
|
+
|
|
1818
|
+
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* .
|
|
1819
|
+
|
|
1739
1820
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotfleetwise-campaign-signalinformation.html#cfn-iotfleetwise-campaign-signalinformation-datapartitionid
|
|
1740
1821
|
'''
|
|
1741
1822
|
result = self._values.get("data_partition_id")
|
|
@@ -1743,7 +1824,7 @@ class CfnCampaign(
|
|
|
1743
1824
|
|
|
1744
1825
|
@builtins.property
|
|
1745
1826
|
def max_sample_count(self) -> typing.Optional[jsii.Number]:
|
|
1746
|
-
'''
|
|
1827
|
+
'''The maximum number of samples to collect.
|
|
1747
1828
|
|
|
1748
1829
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotfleetwise-campaign-signalinformation.html#cfn-iotfleetwise-campaign-signalinformation-maxsamplecount
|
|
1749
1830
|
'''
|
|
@@ -1752,7 +1833,7 @@ class CfnCampaign(
|
|
|
1752
1833
|
|
|
1753
1834
|
@builtins.property
|
|
1754
1835
|
def minimum_sampling_interval_ms(self) -> typing.Optional[jsii.Number]:
|
|
1755
|
-
'''
|
|
1836
|
+
'''The minimum duration of time (in milliseconds) between two triggering events to collect data.
|
|
1756
1837
|
|
|
1757
1838
|
.. epigraph::
|
|
1758
1839
|
|
|
@@ -1781,9 +1862,14 @@ class CfnCampaign(
|
|
|
1781
1862
|
)
|
|
1782
1863
|
class StorageMaximumSizeProperty:
|
|
1783
1864
|
def __init__(self, *, unit: builtins.str, value: jsii.Number) -> None:
|
|
1784
|
-
'''
|
|
1785
|
-
|
|
1786
|
-
|
|
1865
|
+
'''The maximum storage size for the data partition.
|
|
1866
|
+
|
|
1867
|
+
.. epigraph::
|
|
1868
|
+
|
|
1869
|
+
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* .
|
|
1870
|
+
|
|
1871
|
+
:param unit: The data type of the data to store.
|
|
1872
|
+
:param value: The maximum amount of time to store data.
|
|
1787
1873
|
|
|
1788
1874
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotfleetwise-campaign-storagemaximumsize.html
|
|
1789
1875
|
:exampleMetadata: fixture=_generated
|
|
@@ -1810,7 +1896,8 @@ class CfnCampaign(
|
|
|
1810
1896
|
|
|
1811
1897
|
@builtins.property
|
|
1812
1898
|
def unit(self) -> builtins.str:
|
|
1813
|
-
'''
|
|
1899
|
+
'''The data type of the data to store.
|
|
1900
|
+
|
|
1814
1901
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotfleetwise-campaign-storagemaximumsize.html#cfn-iotfleetwise-campaign-storagemaximumsize-unit
|
|
1815
1902
|
'''
|
|
1816
1903
|
result = self._values.get("unit")
|
|
@@ -1819,7 +1906,8 @@ class CfnCampaign(
|
|
|
1819
1906
|
|
|
1820
1907
|
@builtins.property
|
|
1821
1908
|
def value(self) -> jsii.Number:
|
|
1822
|
-
'''
|
|
1909
|
+
'''The maximum amount of time to store data.
|
|
1910
|
+
|
|
1823
1911
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotfleetwise-campaign-storagemaximumsize.html#cfn-iotfleetwise-campaign-storagemaximumsize-value
|
|
1824
1912
|
'''
|
|
1825
1913
|
result = self._values.get("value")
|
|
@@ -1844,9 +1932,14 @@ class CfnCampaign(
|
|
|
1844
1932
|
)
|
|
1845
1933
|
class StorageMinimumTimeToLiveProperty:
|
|
1846
1934
|
def __init__(self, *, unit: builtins.str, value: jsii.Number) -> None:
|
|
1847
|
-
'''
|
|
1848
|
-
|
|
1849
|
-
|
|
1935
|
+
'''Information about the minimum amount of time that data will be kept.
|
|
1936
|
+
|
|
1937
|
+
.. epigraph::
|
|
1938
|
+
|
|
1939
|
+
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* .
|
|
1940
|
+
|
|
1941
|
+
:param unit: The time increment type.
|
|
1942
|
+
:param value: The minimum amount of time to store the data.
|
|
1850
1943
|
|
|
1851
1944
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotfleetwise-campaign-storageminimumtimetolive.html
|
|
1852
1945
|
:exampleMetadata: fixture=_generated
|
|
@@ -1873,7 +1966,8 @@ class CfnCampaign(
|
|
|
1873
1966
|
|
|
1874
1967
|
@builtins.property
|
|
1875
1968
|
def unit(self) -> builtins.str:
|
|
1876
|
-
'''
|
|
1969
|
+
'''The time increment type.
|
|
1970
|
+
|
|
1877
1971
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotfleetwise-campaign-storageminimumtimetolive.html#cfn-iotfleetwise-campaign-storageminimumtimetolive-unit
|
|
1878
1972
|
'''
|
|
1879
1973
|
result = self._values.get("unit")
|
|
@@ -1882,7 +1976,8 @@ class CfnCampaign(
|
|
|
1882
1976
|
|
|
1883
1977
|
@builtins.property
|
|
1884
1978
|
def value(self) -> jsii.Number:
|
|
1885
|
-
'''
|
|
1979
|
+
'''The minimum amount of time to store the data.
|
|
1980
|
+
|
|
1886
1981
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotfleetwise-campaign-storageminimumtimetolive.html#cfn-iotfleetwise-campaign-storageminimumtimetolive-value
|
|
1887
1982
|
'''
|
|
1888
1983
|
result = self._values.get("value")
|
|
@@ -1961,8 +2056,9 @@ class CfnCampaign(
|
|
|
1961
2056
|
)
|
|
1962
2057
|
class TimeBasedSignalFetchConfigProperty:
|
|
1963
2058
|
def __init__(self, *, execution_frequency_ms: jsii.Number) -> None:
|
|
1964
|
-
'''
|
|
1965
|
-
|
|
2059
|
+
'''Used to configure a frequency-based vehicle signal fetch.
|
|
2060
|
+
|
|
2061
|
+
:param execution_frequency_ms: The frequency with which the signal fetch will be executed.
|
|
1966
2062
|
|
|
1967
2063
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotfleetwise-campaign-timebasedsignalfetchconfig.html
|
|
1968
2064
|
:exampleMetadata: fixture=_generated
|
|
@@ -1986,7 +2082,8 @@ class CfnCampaign(
|
|
|
1986
2082
|
|
|
1987
2083
|
@builtins.property
|
|
1988
2084
|
def execution_frequency_ms(self) -> jsii.Number:
|
|
1989
|
-
'''
|
|
2085
|
+
'''The frequency with which the signal fetch will be executed.
|
|
2086
|
+
|
|
1990
2087
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotfleetwise-campaign-timebasedsignalfetchconfig.html#cfn-iotfleetwise-campaign-timebasedsignalfetchconfig-executionfrequencyms
|
|
1991
2088
|
'''
|
|
1992
2089
|
result = self._values.get("execution_frequency_ms")
|
|
@@ -2137,20 +2234,20 @@ class CfnCampaignProps:
|
|
|
2137
2234
|
:param signal_catalog_arn: The Amazon Resource Name (ARN) of the signal catalog associated with the campaign.
|
|
2138
2235
|
:param target_arn: The Amazon Resource Name (ARN) of a vehicle or fleet to which the campaign is deployed.
|
|
2139
2236
|
:param action: 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.
|
|
2140
|
-
:param compression:
|
|
2141
|
-
:param data_destination_configs:
|
|
2142
|
-
:param data_extra_dimensions:
|
|
2143
|
-
:param data_partitions:
|
|
2144
|
-
:param description:
|
|
2145
|
-
:param diagnostics_mode:
|
|
2146
|
-
:param expiry_time:
|
|
2147
|
-
:param post_trigger_collection_duration:
|
|
2148
|
-
:param priority:
|
|
2149
|
-
:param signals_to_collect:
|
|
2150
|
-
:param signals_to_fetch:
|
|
2151
|
-
:param spooling_mode:
|
|
2152
|
-
:param start_time:
|
|
2153
|
-
:param tags:
|
|
2237
|
+
:param compression: 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"
|
|
2238
|
+
:param data_destination_configs: 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.
|
|
2239
|
+
:param data_extra_dimensions: 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
|
|
2240
|
+
:param data_partitions: The data partitions associated with the signals collected from the vehicle.
|
|
2241
|
+
:param description: The description of the campaign.
|
|
2242
|
+
:param diagnostics_mode: 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"
|
|
2243
|
+
:param expiry_time: 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"
|
|
2244
|
+
:param post_trigger_collection_duration: 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
|
|
2245
|
+
:param priority: 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
|
|
2246
|
+
:param signals_to_collect: A list of information about signals to collect.
|
|
2247
|
+
:param signals_to_fetch: A list of information about signals to fetch.
|
|
2248
|
+
:param spooling_mode: 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"
|
|
2249
|
+
:param start_time: The time, in milliseconds, to deliver a campaign after it was approved. If it's not specified, ``0`` is used. Default: ``0`` Default: - "0"
|
|
2250
|
+
:param tags: Metadata that can be used to manage the campaign.
|
|
2154
2251
|
|
|
2155
2252
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotfleetwise-campaign.html
|
|
2156
2253
|
:exampleMetadata: fixture=_generated
|
|
@@ -2378,7 +2475,7 @@ class CfnCampaignProps:
|
|
|
2378
2475
|
|
|
2379
2476
|
@builtins.property
|
|
2380
2477
|
def compression(self) -> typing.Optional[builtins.str]:
|
|
2381
|
-
'''
|
|
2478
|
+
'''Whether to compress signals before transmitting data to AWS IoT FleetWise .
|
|
2382
2479
|
|
|
2383
2480
|
If you don't want to compress the signals, use ``OFF`` . If it's not specified, ``SNAPPY`` is used.
|
|
2384
2481
|
|
|
@@ -2395,7 +2492,7 @@ class CfnCampaignProps:
|
|
|
2395
2492
|
def data_destination_configs(
|
|
2396
2493
|
self,
|
|
2397
2494
|
) -> typing.Optional[typing.Union[_IResolvable_da3f097b, typing.List[typing.Union[_IResolvable_da3f097b, CfnCampaign.DataDestinationConfigProperty]]]]:
|
|
2398
|
-
'''
|
|
2495
|
+
'''The destination where the campaign sends data.
|
|
2399
2496
|
|
|
2400
2497
|
You can choose to send data to be stored in Amazon S3 or Amazon Timestream .
|
|
2401
2498
|
|
|
@@ -2410,7 +2507,7 @@ class CfnCampaignProps:
|
|
|
2410
2507
|
|
|
2411
2508
|
@builtins.property
|
|
2412
2509
|
def data_extra_dimensions(self) -> typing.Optional[typing.List[builtins.str]]:
|
|
2413
|
-
'''
|
|
2510
|
+
'''A list of vehicle attributes to associate with a campaign.
|
|
2414
2511
|
|
|
2415
2512
|
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`` .
|
|
2416
2513
|
|
|
@@ -2425,7 +2522,8 @@ class CfnCampaignProps:
|
|
|
2425
2522
|
def data_partitions(
|
|
2426
2523
|
self,
|
|
2427
2524
|
) -> typing.Optional[typing.Union[_IResolvable_da3f097b, typing.List[typing.Union[_IResolvable_da3f097b, CfnCampaign.DataPartitionProperty]]]]:
|
|
2428
|
-
'''
|
|
2525
|
+
'''The data partitions associated with the signals collected from the vehicle.
|
|
2526
|
+
|
|
2429
2527
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotfleetwise-campaign.html#cfn-iotfleetwise-campaign-datapartitions
|
|
2430
2528
|
'''
|
|
2431
2529
|
result = self._values.get("data_partitions")
|
|
@@ -2433,7 +2531,7 @@ class CfnCampaignProps:
|
|
|
2433
2531
|
|
|
2434
2532
|
@builtins.property
|
|
2435
2533
|
def description(self) -> typing.Optional[builtins.str]:
|
|
2436
|
-
'''
|
|
2534
|
+
'''The description of the campaign.
|
|
2437
2535
|
|
|
2438
2536
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotfleetwise-campaign.html#cfn-iotfleetwise-campaign-description
|
|
2439
2537
|
'''
|
|
@@ -2442,7 +2540,7 @@ class CfnCampaignProps:
|
|
|
2442
2540
|
|
|
2443
2541
|
@builtins.property
|
|
2444
2542
|
def diagnostics_mode(self) -> typing.Optional[builtins.str]:
|
|
2445
|
-
'''
|
|
2543
|
+
'''Option for a vehicle to send diagnostic trouble codes to AWS IoT FleetWise .
|
|
2446
2544
|
|
|
2447
2545
|
If you want to send diagnostic trouble codes, use ``SEND_ACTIVE_DTCS`` . If it's not specified, ``OFF`` is used.
|
|
2448
2546
|
|
|
@@ -2457,7 +2555,7 @@ class CfnCampaignProps:
|
|
|
2457
2555
|
|
|
2458
2556
|
@builtins.property
|
|
2459
2557
|
def expiry_time(self) -> typing.Optional[builtins.str]:
|
|
2460
|
-
'''
|
|
2558
|
+
'''The time the campaign expires, in seconds since epoch (January 1, 1970 at midnight UTC time).
|
|
2461
2559
|
|
|
2462
2560
|
Vehicle data isn't collected after the campaign expires.
|
|
2463
2561
|
|
|
@@ -2472,7 +2570,7 @@ class CfnCampaignProps:
|
|
|
2472
2570
|
|
|
2473
2571
|
@builtins.property
|
|
2474
2572
|
def post_trigger_collection_duration(self) -> typing.Optional[jsii.Number]:
|
|
2475
|
-
'''
|
|
2573
|
+
'''How long (in milliseconds) to collect raw data after a triggering event initiates the collection.
|
|
2476
2574
|
|
|
2477
2575
|
If it's not specified, ``0`` is used.
|
|
2478
2576
|
|
|
@@ -2487,7 +2585,7 @@ class CfnCampaignProps:
|
|
|
2487
2585
|
|
|
2488
2586
|
@builtins.property
|
|
2489
2587
|
def priority(self) -> typing.Optional[jsii.Number]:
|
|
2490
|
-
'''
|
|
2588
|
+
'''A number indicating the priority of one campaign over another campaign for a certain vehicle or fleet.
|
|
2491
2589
|
|
|
2492
2590
|
A campaign with the lowest value is deployed to vehicles before any other campaigns. If it's not specified, ``0`` is used.
|
|
2493
2591
|
|
|
@@ -2504,7 +2602,7 @@ class CfnCampaignProps:
|
|
|
2504
2602
|
def signals_to_collect(
|
|
2505
2603
|
self,
|
|
2506
2604
|
) -> typing.Optional[typing.Union[_IResolvable_da3f097b, typing.List[typing.Union[_IResolvable_da3f097b, CfnCampaign.SignalInformationProperty]]]]:
|
|
2507
|
-
'''
|
|
2605
|
+
'''A list of information about signals to collect.
|
|
2508
2606
|
|
|
2509
2607
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotfleetwise-campaign.html#cfn-iotfleetwise-campaign-signalstocollect
|
|
2510
2608
|
'''
|
|
@@ -2515,7 +2613,8 @@ class CfnCampaignProps:
|
|
|
2515
2613
|
def signals_to_fetch(
|
|
2516
2614
|
self,
|
|
2517
2615
|
) -> typing.Optional[typing.Union[_IResolvable_da3f097b, typing.List[typing.Union[_IResolvable_da3f097b, CfnCampaign.SignalFetchInformationProperty]]]]:
|
|
2518
|
-
'''
|
|
2616
|
+
'''A list of information about signals to fetch.
|
|
2617
|
+
|
|
2519
2618
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotfleetwise-campaign.html#cfn-iotfleetwise-campaign-signalstofetch
|
|
2520
2619
|
'''
|
|
2521
2620
|
result = self._values.get("signals_to_fetch")
|
|
@@ -2523,7 +2622,7 @@ class CfnCampaignProps:
|
|
|
2523
2622
|
|
|
2524
2623
|
@builtins.property
|
|
2525
2624
|
def spooling_mode(self) -> typing.Optional[builtins.str]:
|
|
2526
|
-
'''
|
|
2625
|
+
'''Whether to store collected data after a vehicle lost a connection with the cloud.
|
|
2527
2626
|
|
|
2528
2627
|
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.
|
|
2529
2628
|
|
|
@@ -2538,9 +2637,7 @@ class CfnCampaignProps:
|
|
|
2538
2637
|
|
|
2539
2638
|
@builtins.property
|
|
2540
2639
|
def start_time(self) -> typing.Optional[builtins.str]:
|
|
2541
|
-
'''
|
|
2542
|
-
|
|
2543
|
-
If it's not specified, ``0`` is used.
|
|
2640
|
+
'''The time, in milliseconds, to deliver a campaign after it was approved. If it's not specified, ``0`` is used.
|
|
2544
2641
|
|
|
2545
2642
|
Default: ``0``
|
|
2546
2643
|
|
|
@@ -2553,7 +2650,7 @@ class CfnCampaignProps:
|
|
|
2553
2650
|
|
|
2554
2651
|
@builtins.property
|
|
2555
2652
|
def tags(self) -> typing.Optional[typing.List[_CfnTag_f6864754]]:
|
|
2556
|
-
'''
|
|
2653
|
+
'''Metadata that can be used to manage the campaign.
|
|
2557
2654
|
|
|
2558
2655
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotfleetwise-campaign.html#cfn-iotfleetwise-campaign-tags
|
|
2559
2656
|
'''
|
|
@@ -2585,6 +2682,11 @@ class CfnDecoderManifest(
|
|
|
2585
2682
|
- Each network interface has a unique ID.
|
|
2586
2683
|
- The signal decoders are specified in the model manifest.
|
|
2587
2684
|
|
|
2685
|
+
For more information, see `Decoder manifests <https://docs.aws.amazon.com/iot-fleetwise/latest/developerguide/decoder-manifests.html>`_ in the *AWS IoT FleetWise Developer Guide* .
|
|
2686
|
+
.. epigraph::
|
|
2687
|
+
|
|
2688
|
+
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* .
|
|
2689
|
+
|
|
2588
2690
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotfleetwise-decodermanifest.html
|
|
2589
2691
|
:cloudformationResource: AWS::IoTFleetWise::DecoderManifest
|
|
2590
2692
|
:exampleMetadata: fixture=_generated
|
|
@@ -2685,12 +2787,12 @@ class CfnDecoderManifest(
|
|
|
2685
2787
|
:param id: Construct identifier for this resource (unique in its scope).
|
|
2686
2788
|
:param model_manifest_arn: The Amazon Resource Name (ARN) of a vehicle model (model manifest) associated with the decoder manifest.
|
|
2687
2789
|
:param name: The name of the decoder manifest.
|
|
2688
|
-
:param default_for_unmapped_signals:
|
|
2689
|
-
:param description:
|
|
2690
|
-
:param network_interfaces:
|
|
2691
|
-
:param signal_decoders:
|
|
2692
|
-
:param status:
|
|
2693
|
-
:param tags:
|
|
2790
|
+
:param default_for_unmapped_signals: Use default decoders for all unmapped signals in the model. You don't need to provide any detailed decoding information.
|
|
2791
|
+
:param description: A brief description of the decoder manifest.
|
|
2792
|
+
:param network_interfaces: A list of information about available network interfaces.
|
|
2793
|
+
:param signal_decoders: A list of information about signal decoders.
|
|
2794
|
+
:param status: The state of the decoder manifest. If the status is ``ACTIVE`` , the decoder manifest can't be edited. If the status is marked ``DRAFT`` , you can edit the decoder manifest. Default: - "DRAFT"
|
|
2795
|
+
:param tags: Metadata that can be used to manage the decoder manifest.
|
|
2694
2796
|
'''
|
|
2695
2797
|
if __debug__:
|
|
2696
2798
|
type_hints = typing.get_type_hints(_typecheckingstub__bd0d8efce6baca0fa606fb0cf95bebcdeda196fcde2fb7e18542334332eb8ba4)
|
|
@@ -2806,6 +2908,7 @@ class CfnDecoderManifest(
|
|
|
2806
2908
|
@builtins.property
|
|
2807
2909
|
@jsii.member(jsii_name="defaultForUnmappedSignals")
|
|
2808
2910
|
def default_for_unmapped_signals(self) -> typing.Optional[builtins.str]:
|
|
2911
|
+
'''Use default decoders for all unmapped signals in the model.'''
|
|
2809
2912
|
return typing.cast(typing.Optional[builtins.str], jsii.get(self, "defaultForUnmappedSignals"))
|
|
2810
2913
|
|
|
2811
2914
|
@default_for_unmapped_signals.setter
|
|
@@ -2821,7 +2924,7 @@ class CfnDecoderManifest(
|
|
|
2821
2924
|
@builtins.property
|
|
2822
2925
|
@jsii.member(jsii_name="description")
|
|
2823
2926
|
def description(self) -> typing.Optional[builtins.str]:
|
|
2824
|
-
'''
|
|
2927
|
+
'''A brief description of the decoder manifest.'''
|
|
2825
2928
|
return typing.cast(typing.Optional[builtins.str], jsii.get(self, "description"))
|
|
2826
2929
|
|
|
2827
2930
|
@description.setter
|
|
@@ -2836,7 +2939,7 @@ class CfnDecoderManifest(
|
|
|
2836
2939
|
def network_interfaces(
|
|
2837
2940
|
self,
|
|
2838
2941
|
) -> typing.Optional[typing.Union[_IResolvable_da3f097b, typing.List[typing.Union[_IResolvable_da3f097b, "CfnDecoderManifest.NetworkInterfacesItemsProperty"]]]]:
|
|
2839
|
-
'''
|
|
2942
|
+
'''A list of information about available network interfaces.'''
|
|
2840
2943
|
return typing.cast(typing.Optional[typing.Union[_IResolvable_da3f097b, typing.List[typing.Union[_IResolvable_da3f097b, "CfnDecoderManifest.NetworkInterfacesItemsProperty"]]]], jsii.get(self, "networkInterfaces"))
|
|
2841
2944
|
|
|
2842
2945
|
@network_interfaces.setter
|
|
@@ -2854,7 +2957,7 @@ class CfnDecoderManifest(
|
|
|
2854
2957
|
def signal_decoders(
|
|
2855
2958
|
self,
|
|
2856
2959
|
) -> typing.Optional[typing.Union[_IResolvable_da3f097b, typing.List[typing.Union[_IResolvable_da3f097b, "CfnDecoderManifest.SignalDecodersItemsProperty"]]]]:
|
|
2857
|
-
'''
|
|
2960
|
+
'''A list of information about signal decoders.'''
|
|
2858
2961
|
return typing.cast(typing.Optional[typing.Union[_IResolvable_da3f097b, typing.List[typing.Union[_IResolvable_da3f097b, "CfnDecoderManifest.SignalDecodersItemsProperty"]]]], jsii.get(self, "signalDecoders"))
|
|
2859
2962
|
|
|
2860
2963
|
@signal_decoders.setter
|
|
@@ -2870,7 +2973,7 @@ class CfnDecoderManifest(
|
|
|
2870
2973
|
@builtins.property
|
|
2871
2974
|
@jsii.member(jsii_name="status")
|
|
2872
2975
|
def status(self) -> typing.Optional[builtins.str]:
|
|
2873
|
-
'''
|
|
2976
|
+
'''The state of the decoder manifest.'''
|
|
2874
2977
|
return typing.cast(typing.Optional[builtins.str], jsii.get(self, "status"))
|
|
2875
2978
|
|
|
2876
2979
|
@status.setter
|
|
@@ -2883,7 +2986,7 @@ class CfnDecoderManifest(
|
|
|
2883
2986
|
@builtins.property
|
|
2884
2987
|
@jsii.member(jsii_name="tagsRaw")
|
|
2885
2988
|
def tags_raw(self) -> typing.Optional[typing.List[_CfnTag_f6864754]]:
|
|
2886
|
-
'''
|
|
2989
|
+
'''Metadata that can be used to manage the decoder manifest.'''
|
|
2887
2990
|
return typing.cast(typing.Optional[typing.List[_CfnTag_f6864754]], jsii.get(self, "tagsRaw"))
|
|
2888
2991
|
|
|
2889
2992
|
@tags_raw.setter
|
|
@@ -2913,8 +3016,8 @@ class CfnDecoderManifest(
|
|
|
2913
3016
|
'''A single controller area network (CAN) device interface.
|
|
2914
3017
|
|
|
2915
3018
|
:param name: The unique name of the interface.
|
|
2916
|
-
:param protocol_name:
|
|
2917
|
-
:param protocol_version:
|
|
3019
|
+
:param protocol_name: The name of the communication protocol for the interface.
|
|
3020
|
+
:param protocol_version: The version of the communication protocol for the interface.
|
|
2918
3021
|
|
|
2919
3022
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotfleetwise-decodermanifest-caninterface.html
|
|
2920
3023
|
:exampleMetadata: fixture=_generated
|
|
@@ -2958,7 +3061,7 @@ class CfnDecoderManifest(
|
|
|
2958
3061
|
|
|
2959
3062
|
@builtins.property
|
|
2960
3063
|
def protocol_name(self) -> typing.Optional[builtins.str]:
|
|
2961
|
-
'''
|
|
3064
|
+
'''The name of the communication protocol for the interface.
|
|
2962
3065
|
|
|
2963
3066
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotfleetwise-decodermanifest-caninterface.html#cfn-iotfleetwise-decodermanifest-caninterface-protocolname
|
|
2964
3067
|
'''
|
|
@@ -2967,7 +3070,7 @@ class CfnDecoderManifest(
|
|
|
2967
3070
|
|
|
2968
3071
|
@builtins.property
|
|
2969
3072
|
def protocol_version(self) -> typing.Optional[builtins.str]:
|
|
2970
|
-
'''
|
|
3073
|
+
'''The version of the communication protocol for the interface.
|
|
2971
3074
|
|
|
2972
3075
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotfleetwise-decodermanifest-caninterface.html#cfn-iotfleetwise-decodermanifest-caninterface-protocolversion
|
|
2973
3076
|
'''
|
|
@@ -3237,7 +3340,7 @@ class CfnDecoderManifest(
|
|
|
3237
3340
|
start_bit: builtins.str,
|
|
3238
3341
|
name: typing.Optional[builtins.str] = None,
|
|
3239
3342
|
) -> None:
|
|
3240
|
-
'''
|
|
3343
|
+
'''Information about a single controller area network (CAN) signal and the messages it receives and transmits.
|
|
3241
3344
|
|
|
3242
3345
|
:param factor: A multiplier used to decode the CAN message.
|
|
3243
3346
|
:param is_big_endian: Whether the byte ordering of a CAN message is big-endian.
|
|
@@ -3246,7 +3349,7 @@ class CfnDecoderManifest(
|
|
|
3246
3349
|
:param message_id: The ID of the message.
|
|
3247
3350
|
:param offset: The offset used to calculate the signal value. Combined with factor, the calculation is ``value = raw_value * factor + offset`` .
|
|
3248
3351
|
:param start_bit: Indicates the beginning of the CAN message.
|
|
3249
|
-
:param name:
|
|
3352
|
+
:param name: The name of the signal.
|
|
3250
3353
|
|
|
3251
3354
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotfleetwise-decodermanifest-cansignal.html
|
|
3252
3355
|
:exampleMetadata: fixture=_generated
|
|
@@ -3366,7 +3469,7 @@ class CfnDecoderManifest(
|
|
|
3366
3469
|
|
|
3367
3470
|
@builtins.property
|
|
3368
3471
|
def name(self) -> typing.Optional[builtins.str]:
|
|
3369
|
-
'''
|
|
3472
|
+
'''The name of the signal.
|
|
3370
3473
|
|
|
3371
3474
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotfleetwise-decodermanifest-cansignal.html#cfn-iotfleetwise-decodermanifest-cansignal-name
|
|
3372
3475
|
'''
|
|
@@ -3403,7 +3506,7 @@ class CfnDecoderManifest(
|
|
|
3403
3506
|
can_interface: typing.Optional[typing.Union[_IResolvable_da3f097b, typing.Union["CfnDecoderManifest.CanInterfaceProperty", typing.Dict[builtins.str, typing.Any]]]] = None,
|
|
3404
3507
|
obd_interface: typing.Optional[typing.Union[_IResolvable_da3f097b, typing.Union["CfnDecoderManifest.ObdInterfaceProperty", typing.Dict[builtins.str, typing.Any]]]] = None,
|
|
3405
3508
|
) -> None:
|
|
3406
|
-
'''
|
|
3509
|
+
'''A list of information about available network interfaces.
|
|
3407
3510
|
|
|
3408
3511
|
:param interface_id:
|
|
3409
3512
|
:param type:
|
|
@@ -3537,11 +3640,11 @@ class CfnDecoderManifest(
|
|
|
3537
3640
|
|
|
3538
3641
|
:param name: The name of the interface.
|
|
3539
3642
|
:param request_message_id: The ID of the message requesting vehicle data.
|
|
3540
|
-
:param dtc_request_interval_seconds:
|
|
3541
|
-
:param has_transmission_ecu:
|
|
3542
|
-
:param obd_standard:
|
|
3543
|
-
:param pid_request_interval_seconds:
|
|
3544
|
-
:param use_extended_ids:
|
|
3643
|
+
:param dtc_request_interval_seconds: The maximum number message requests per diagnostic trouble code per second.
|
|
3644
|
+
:param has_transmission_ecu: Whether the vehicle has a transmission control module (TCM).
|
|
3645
|
+
:param obd_standard: The standard OBD II PID.
|
|
3646
|
+
:param pid_request_interval_seconds: The maximum number message requests per second.
|
|
3647
|
+
:param use_extended_ids: Whether to use extended IDs in the message.
|
|
3545
3648
|
|
|
3546
3649
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotfleetwise-decodermanifest-obdinterface.html
|
|
3547
3650
|
:exampleMetadata: fixture=_generated
|
|
@@ -3610,7 +3713,7 @@ class CfnDecoderManifest(
|
|
|
3610
3713
|
|
|
3611
3714
|
@builtins.property
|
|
3612
3715
|
def dtc_request_interval_seconds(self) -> typing.Optional[builtins.str]:
|
|
3613
|
-
'''
|
|
3716
|
+
'''The maximum number message requests per diagnostic trouble code per second.
|
|
3614
3717
|
|
|
3615
3718
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotfleetwise-decodermanifest-obdinterface.html#cfn-iotfleetwise-decodermanifest-obdinterface-dtcrequestintervalseconds
|
|
3616
3719
|
'''
|
|
@@ -3619,7 +3722,7 @@ class CfnDecoderManifest(
|
|
|
3619
3722
|
|
|
3620
3723
|
@builtins.property
|
|
3621
3724
|
def has_transmission_ecu(self) -> typing.Optional[builtins.str]:
|
|
3622
|
-
'''
|
|
3725
|
+
'''Whether the vehicle has a transmission control module (TCM).
|
|
3623
3726
|
|
|
3624
3727
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotfleetwise-decodermanifest-obdinterface.html#cfn-iotfleetwise-decodermanifest-obdinterface-hastransmissionecu
|
|
3625
3728
|
'''
|
|
@@ -3628,7 +3731,7 @@ class CfnDecoderManifest(
|
|
|
3628
3731
|
|
|
3629
3732
|
@builtins.property
|
|
3630
3733
|
def obd_standard(self) -> typing.Optional[builtins.str]:
|
|
3631
|
-
'''
|
|
3734
|
+
'''The standard OBD II PID.
|
|
3632
3735
|
|
|
3633
3736
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotfleetwise-decodermanifest-obdinterface.html#cfn-iotfleetwise-decodermanifest-obdinterface-obdstandard
|
|
3634
3737
|
'''
|
|
@@ -3637,7 +3740,7 @@ class CfnDecoderManifest(
|
|
|
3637
3740
|
|
|
3638
3741
|
@builtins.property
|
|
3639
3742
|
def pid_request_interval_seconds(self) -> typing.Optional[builtins.str]:
|
|
3640
|
-
'''
|
|
3743
|
+
'''The maximum number message requests per second.
|
|
3641
3744
|
|
|
3642
3745
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotfleetwise-decodermanifest-obdinterface.html#cfn-iotfleetwise-decodermanifest-obdinterface-pidrequestintervalseconds
|
|
3643
3746
|
'''
|
|
@@ -3646,7 +3749,7 @@ class CfnDecoderManifest(
|
|
|
3646
3749
|
|
|
3647
3750
|
@builtins.property
|
|
3648
3751
|
def use_extended_ids(self) -> typing.Optional[builtins.str]:
|
|
3649
|
-
'''
|
|
3752
|
+
'''Whether to use extended IDs in the message.
|
|
3650
3753
|
|
|
3651
3754
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotfleetwise-decodermanifest-obdinterface.html#cfn-iotfleetwise-decodermanifest-obdinterface-useextendedids
|
|
3652
3755
|
'''
|
|
@@ -3684,7 +3787,7 @@ class CfnDecoderManifest(
|
|
|
3684
3787
|
'''Information about a network interface specified by the On-board diagnostic (OBD) II protocol.
|
|
3685
3788
|
|
|
3686
3789
|
:param interface_id: The ID of the network interface.
|
|
3687
|
-
:param obd_interface:
|
|
3790
|
+
:param obd_interface: Information about a network interface specified by the On-board diagnostic (OBD) II protocol.
|
|
3688
3791
|
:param type: The network protocol for the vehicle. For example, ``CAN_SIGNAL`` specifies a protocol that defines how data is communicated between electronic control units (ECUs). ``OBD_SIGNAL`` specifies a protocol that defines how self-diagnostic data is communicated between ECUs.
|
|
3689
3792
|
|
|
3690
3793
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotfleetwise-decodermanifest-obdnetworkinterface.html
|
|
@@ -3737,7 +3840,7 @@ class CfnDecoderManifest(
|
|
|
3737
3840
|
def obd_interface(
|
|
3738
3841
|
self,
|
|
3739
3842
|
) -> typing.Union[_IResolvable_da3f097b, "CfnDecoderManifest.ObdInterfaceProperty"]:
|
|
3740
|
-
'''
|
|
3843
|
+
'''Information about a network interface specified by the On-board diagnostic (OBD) II protocol.
|
|
3741
3844
|
|
|
3742
3845
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotfleetwise-decodermanifest-obdnetworkinterface.html#cfn-iotfleetwise-decodermanifest-obdnetworkinterface-obdinterface
|
|
3743
3846
|
'''
|
|
@@ -3789,10 +3892,10 @@ class CfnDecoderManifest(
|
|
|
3789
3892
|
) -> None:
|
|
3790
3893
|
'''A list of information about signal decoders.
|
|
3791
3894
|
|
|
3792
|
-
:param fully_qualified_name:
|
|
3793
|
-
:param interface_id:
|
|
3895
|
+
:param fully_qualified_name: The fully qualified name of a signal decoder as defined in a vehicle model.
|
|
3896
|
+
:param interface_id: The ID of a network interface that specifies what network protocol a vehicle follows.
|
|
3794
3897
|
:param obd_signal: Information about signal messages using the on-board diagnostics (OBD) II protocol in a vehicle.
|
|
3795
|
-
:param type:
|
|
3898
|
+
:param type: The network protocol for the vehicle. For example, ``CAN_SIGNAL`` specifies a protocol that defines how data is communicated between electronic control units (ECUs). ``OBD_SIGNAL`` specifies a protocol that defines how self-diagnostic data is communicated between ECUs.
|
|
3796
3899
|
|
|
3797
3900
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotfleetwise-decodermanifest-obdsignaldecoder.html
|
|
3798
3901
|
:exampleMetadata: fixture=_generated
|
|
@@ -3837,7 +3940,8 @@ class CfnDecoderManifest(
|
|
|
3837
3940
|
|
|
3838
3941
|
@builtins.property
|
|
3839
3942
|
def fully_qualified_name(self) -> builtins.str:
|
|
3840
|
-
'''
|
|
3943
|
+
'''The fully qualified name of a signal decoder as defined in a vehicle model.
|
|
3944
|
+
|
|
3841
3945
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotfleetwise-decodermanifest-obdsignaldecoder.html#cfn-iotfleetwise-decodermanifest-obdsignaldecoder-fullyqualifiedname
|
|
3842
3946
|
'''
|
|
3843
3947
|
result = self._values.get("fully_qualified_name")
|
|
@@ -3846,7 +3950,8 @@ class CfnDecoderManifest(
|
|
|
3846
3950
|
|
|
3847
3951
|
@builtins.property
|
|
3848
3952
|
def interface_id(self) -> builtins.str:
|
|
3849
|
-
'''
|
|
3953
|
+
'''The ID of a network interface that specifies what network protocol a vehicle follows.
|
|
3954
|
+
|
|
3850
3955
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotfleetwise-decodermanifest-obdsignaldecoder.html#cfn-iotfleetwise-decodermanifest-obdsignaldecoder-interfaceid
|
|
3851
3956
|
'''
|
|
3852
3957
|
result = self._values.get("interface_id")
|
|
@@ -3867,7 +3972,10 @@ class CfnDecoderManifest(
|
|
|
3867
3972
|
|
|
3868
3973
|
@builtins.property
|
|
3869
3974
|
def type(self) -> builtins.str:
|
|
3870
|
-
'''
|
|
3975
|
+
'''The network protocol for the vehicle.
|
|
3976
|
+
|
|
3977
|
+
For example, ``CAN_SIGNAL`` specifies a protocol that defines how data is communicated between electronic control units (ECUs). ``OBD_SIGNAL`` specifies a protocol that defines how self-diagnostic data is communicated between ECUs.
|
|
3978
|
+
|
|
3871
3979
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotfleetwise-decodermanifest-obdsignaldecoder.html#cfn-iotfleetwise-decodermanifest-obdsignaldecoder-type
|
|
3872
3980
|
'''
|
|
3873
3981
|
result = self._values.get("type")
|
|
@@ -3923,8 +4031,8 @@ class CfnDecoderManifest(
|
|
|
3923
4031
|
:param scaling: A multiplier used to decode the message.
|
|
3924
4032
|
:param service_mode: The mode of operation (diagnostic service) in a message.
|
|
3925
4033
|
:param start_byte: Indicates the beginning of the message.
|
|
3926
|
-
:param bit_mask_length:
|
|
3927
|
-
:param bit_right_shift:
|
|
4034
|
+
:param bit_mask_length: The number of bits to mask in a message.
|
|
4035
|
+
:param bit_right_shift: The number of positions to shift bits in the message.
|
|
3928
4036
|
|
|
3929
4037
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotfleetwise-decodermanifest-obdsignal.html
|
|
3930
4038
|
:exampleMetadata: fixture=_generated
|
|
@@ -4048,7 +4156,7 @@ class CfnDecoderManifest(
|
|
|
4048
4156
|
|
|
4049
4157
|
@builtins.property
|
|
4050
4158
|
def bit_mask_length(self) -> typing.Optional[builtins.str]:
|
|
4051
|
-
'''
|
|
4159
|
+
'''The number of bits to mask in a message.
|
|
4052
4160
|
|
|
4053
4161
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotfleetwise-decodermanifest-obdsignal.html#cfn-iotfleetwise-decodermanifest-obdsignal-bitmasklength
|
|
4054
4162
|
'''
|
|
@@ -4057,7 +4165,7 @@ class CfnDecoderManifest(
|
|
|
4057
4165
|
|
|
4058
4166
|
@builtins.property
|
|
4059
4167
|
def bit_right_shift(self) -> typing.Optional[builtins.str]:
|
|
4060
|
-
'''
|
|
4168
|
+
'''The number of positions to shift bits in the message.
|
|
4061
4169
|
|
|
4062
4170
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotfleetwise-decodermanifest-obdsignal.html#cfn-iotfleetwise-decodermanifest-obdsignal-bitrightshift
|
|
4063
4171
|
'''
|
|
@@ -4253,12 +4361,12 @@ class CfnDecoderManifestProps:
|
|
|
4253
4361
|
|
|
4254
4362
|
:param model_manifest_arn: The Amazon Resource Name (ARN) of a vehicle model (model manifest) associated with the decoder manifest.
|
|
4255
4363
|
:param name: The name of the decoder manifest.
|
|
4256
|
-
:param default_for_unmapped_signals:
|
|
4257
|
-
:param description:
|
|
4258
|
-
:param network_interfaces:
|
|
4259
|
-
:param signal_decoders:
|
|
4260
|
-
:param status:
|
|
4261
|
-
:param tags:
|
|
4364
|
+
:param default_for_unmapped_signals: Use default decoders for all unmapped signals in the model. You don't need to provide any detailed decoding information.
|
|
4365
|
+
:param description: A brief description of the decoder manifest.
|
|
4366
|
+
:param network_interfaces: A list of information about available network interfaces.
|
|
4367
|
+
:param signal_decoders: A list of information about signal decoders.
|
|
4368
|
+
:param status: The state of the decoder manifest. If the status is ``ACTIVE`` , the decoder manifest can't be edited. If the status is marked ``DRAFT`` , you can edit the decoder manifest. Default: - "DRAFT"
|
|
4369
|
+
:param tags: Metadata that can be used to manage the decoder manifest.
|
|
4262
4370
|
|
|
4263
4371
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotfleetwise-decodermanifest.html
|
|
4264
4372
|
:exampleMetadata: fixture=_generated
|
|
@@ -4388,7 +4496,10 @@ class CfnDecoderManifestProps:
|
|
|
4388
4496
|
|
|
4389
4497
|
@builtins.property
|
|
4390
4498
|
def default_for_unmapped_signals(self) -> typing.Optional[builtins.str]:
|
|
4391
|
-
'''
|
|
4499
|
+
'''Use default decoders for all unmapped signals in the model.
|
|
4500
|
+
|
|
4501
|
+
You don't need to provide any detailed decoding information.
|
|
4502
|
+
|
|
4392
4503
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotfleetwise-decodermanifest.html#cfn-iotfleetwise-decodermanifest-defaultforunmappedsignals
|
|
4393
4504
|
'''
|
|
4394
4505
|
result = self._values.get("default_for_unmapped_signals")
|
|
@@ -4396,7 +4507,7 @@ class CfnDecoderManifestProps:
|
|
|
4396
4507
|
|
|
4397
4508
|
@builtins.property
|
|
4398
4509
|
def description(self) -> typing.Optional[builtins.str]:
|
|
4399
|
-
'''
|
|
4510
|
+
'''A brief description of the decoder manifest.
|
|
4400
4511
|
|
|
4401
4512
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotfleetwise-decodermanifest.html#cfn-iotfleetwise-decodermanifest-description
|
|
4402
4513
|
'''
|
|
@@ -4407,7 +4518,7 @@ class CfnDecoderManifestProps:
|
|
|
4407
4518
|
def network_interfaces(
|
|
4408
4519
|
self,
|
|
4409
4520
|
) -> typing.Optional[typing.Union[_IResolvable_da3f097b, typing.List[typing.Union[_IResolvable_da3f097b, CfnDecoderManifest.NetworkInterfacesItemsProperty]]]]:
|
|
4410
|
-
'''
|
|
4521
|
+
'''A list of information about available network interfaces.
|
|
4411
4522
|
|
|
4412
4523
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotfleetwise-decodermanifest.html#cfn-iotfleetwise-decodermanifest-networkinterfaces
|
|
4413
4524
|
'''
|
|
@@ -4418,7 +4529,7 @@ class CfnDecoderManifestProps:
|
|
|
4418
4529
|
def signal_decoders(
|
|
4419
4530
|
self,
|
|
4420
4531
|
) -> typing.Optional[typing.Union[_IResolvable_da3f097b, typing.List[typing.Union[_IResolvable_da3f097b, CfnDecoderManifest.SignalDecodersItemsProperty]]]]:
|
|
4421
|
-
'''
|
|
4532
|
+
'''A list of information about signal decoders.
|
|
4422
4533
|
|
|
4423
4534
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotfleetwise-decodermanifest.html#cfn-iotfleetwise-decodermanifest-signaldecoders
|
|
4424
4535
|
'''
|
|
@@ -4427,7 +4538,7 @@ class CfnDecoderManifestProps:
|
|
|
4427
4538
|
|
|
4428
4539
|
@builtins.property
|
|
4429
4540
|
def status(self) -> typing.Optional[builtins.str]:
|
|
4430
|
-
'''
|
|
4541
|
+
'''The state of the decoder manifest.
|
|
4431
4542
|
|
|
4432
4543
|
If the status is ``ACTIVE`` , the decoder manifest can't be edited. If the status is marked ``DRAFT`` , you can edit the decoder manifest.
|
|
4433
4544
|
|
|
@@ -4440,7 +4551,7 @@ class CfnDecoderManifestProps:
|
|
|
4440
4551
|
|
|
4441
4552
|
@builtins.property
|
|
4442
4553
|
def tags(self) -> typing.Optional[typing.List[_CfnTag_f6864754]]:
|
|
4443
|
-
'''
|
|
4554
|
+
'''Metadata that can be used to manage the decoder manifest.
|
|
4444
4555
|
|
|
4445
4556
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotfleetwise-decodermanifest.html#cfn-iotfleetwise-decodermanifest-tags
|
|
4446
4557
|
'''
|
|
@@ -4511,8 +4622,8 @@ class CfnFleet(
|
|
|
4511
4622
|
:param id_: Construct identifier for this resource (unique in its scope).
|
|
4512
4623
|
:param id: The unique ID of the fleet.
|
|
4513
4624
|
:param signal_catalog_arn: The ARN of the signal catalog associated with the fleet.
|
|
4514
|
-
:param description:
|
|
4515
|
-
:param tags:
|
|
4625
|
+
:param description: A brief description of the fleet.
|
|
4626
|
+
:param tags: Metadata that can be used to manage the fleet.
|
|
4516
4627
|
'''
|
|
4517
4628
|
if __debug__:
|
|
4518
4629
|
type_hints = typing.get_type_hints(_typecheckingstub__be2399a288ba3f0fe4eba6c31d42082d31eac165febede18736a759d92f2120d)
|
|
@@ -4624,7 +4735,7 @@ class CfnFleet(
|
|
|
4624
4735
|
@builtins.property
|
|
4625
4736
|
@jsii.member(jsii_name="description")
|
|
4626
4737
|
def description(self) -> typing.Optional[builtins.str]:
|
|
4627
|
-
'''
|
|
4738
|
+
'''A brief description of the fleet.'''
|
|
4628
4739
|
return typing.cast(typing.Optional[builtins.str], jsii.get(self, "description"))
|
|
4629
4740
|
|
|
4630
4741
|
@description.setter
|
|
@@ -4637,7 +4748,7 @@ class CfnFleet(
|
|
|
4637
4748
|
@builtins.property
|
|
4638
4749
|
@jsii.member(jsii_name="tagsRaw")
|
|
4639
4750
|
def tags_raw(self) -> typing.Optional[typing.List[_CfnTag_f6864754]]:
|
|
4640
|
-
'''
|
|
4751
|
+
'''Metadata that can be used to manage the fleet.'''
|
|
4641
4752
|
return typing.cast(typing.Optional[typing.List[_CfnTag_f6864754]], jsii.get(self, "tagsRaw"))
|
|
4642
4753
|
|
|
4643
4754
|
@tags_raw.setter
|
|
@@ -4671,8 +4782,8 @@ class CfnFleetProps:
|
|
|
4671
4782
|
|
|
4672
4783
|
:param id: The unique ID of the fleet.
|
|
4673
4784
|
:param signal_catalog_arn: The ARN of the signal catalog associated with the fleet.
|
|
4674
|
-
:param description:
|
|
4675
|
-
:param tags:
|
|
4785
|
+
:param description: A brief description of the fleet.
|
|
4786
|
+
:param tags: Metadata that can be used to manage the fleet.
|
|
4676
4787
|
|
|
4677
4788
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotfleetwise-fleet.html
|
|
4678
4789
|
:exampleMetadata: fixture=_generated
|
|
@@ -4732,7 +4843,7 @@ class CfnFleetProps:
|
|
|
4732
4843
|
|
|
4733
4844
|
@builtins.property
|
|
4734
4845
|
def description(self) -> typing.Optional[builtins.str]:
|
|
4735
|
-
'''
|
|
4846
|
+
'''A brief description of the fleet.
|
|
4736
4847
|
|
|
4737
4848
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotfleetwise-fleet.html#cfn-iotfleetwise-fleet-description
|
|
4738
4849
|
'''
|
|
@@ -4741,7 +4852,7 @@ class CfnFleetProps:
|
|
|
4741
4852
|
|
|
4742
4853
|
@builtins.property
|
|
4743
4854
|
def tags(self) -> typing.Optional[typing.List[_CfnTag_f6864754]]:
|
|
4744
|
-
'''
|
|
4855
|
+
'''Metadata that can be used to manage the fleet.
|
|
4745
4856
|
|
|
4746
4857
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotfleetwise-fleet.html#cfn-iotfleetwise-fleet-tags
|
|
4747
4858
|
'''
|
|
@@ -4812,10 +4923,10 @@ class CfnModelManifest(
|
|
|
4812
4923
|
:param id: Construct identifier for this resource (unique in its scope).
|
|
4813
4924
|
:param name: The name of the vehicle model.
|
|
4814
4925
|
:param signal_catalog_arn: The Amazon Resource Name (ARN) of the signal catalog associated with the vehicle model.
|
|
4815
|
-
:param description:
|
|
4816
|
-
:param nodes:
|
|
4817
|
-
:param status:
|
|
4818
|
-
:param tags:
|
|
4926
|
+
:param description: A brief description of the vehicle model.
|
|
4927
|
+
:param nodes: A list of nodes, which are a general abstraction of signals.
|
|
4928
|
+
:param status: The state of the vehicle model. If the status is ``ACTIVE`` , the vehicle model can't be edited. If the status is ``DRAFT`` , you can edit the vehicle model. Default: - "DRAFT"
|
|
4929
|
+
:param tags: Metadata that can be used to manage the vehicle model.
|
|
4819
4930
|
'''
|
|
4820
4931
|
if __debug__:
|
|
4821
4932
|
type_hints = typing.get_type_hints(_typecheckingstub__2f0e03fe14f53de97f2e7071c7f10132492e794782f840695921dc42cd286a81)
|
|
@@ -4929,7 +5040,7 @@ class CfnModelManifest(
|
|
|
4929
5040
|
@builtins.property
|
|
4930
5041
|
@jsii.member(jsii_name="description")
|
|
4931
5042
|
def description(self) -> typing.Optional[builtins.str]:
|
|
4932
|
-
'''
|
|
5043
|
+
'''A brief description of the vehicle model.'''
|
|
4933
5044
|
return typing.cast(typing.Optional[builtins.str], jsii.get(self, "description"))
|
|
4934
5045
|
|
|
4935
5046
|
@description.setter
|
|
@@ -4942,7 +5053,7 @@ class CfnModelManifest(
|
|
|
4942
5053
|
@builtins.property
|
|
4943
5054
|
@jsii.member(jsii_name="nodes")
|
|
4944
5055
|
def nodes(self) -> typing.Optional[typing.List[builtins.str]]:
|
|
4945
|
-
'''
|
|
5056
|
+
'''A list of nodes, which are a general abstraction of signals.'''
|
|
4946
5057
|
return typing.cast(typing.Optional[typing.List[builtins.str]], jsii.get(self, "nodes"))
|
|
4947
5058
|
|
|
4948
5059
|
@nodes.setter
|
|
@@ -4955,7 +5066,7 @@ class CfnModelManifest(
|
|
|
4955
5066
|
@builtins.property
|
|
4956
5067
|
@jsii.member(jsii_name="status")
|
|
4957
5068
|
def status(self) -> typing.Optional[builtins.str]:
|
|
4958
|
-
'''
|
|
5069
|
+
'''The state of the vehicle model.'''
|
|
4959
5070
|
return typing.cast(typing.Optional[builtins.str], jsii.get(self, "status"))
|
|
4960
5071
|
|
|
4961
5072
|
@status.setter
|
|
@@ -4968,7 +5079,7 @@ class CfnModelManifest(
|
|
|
4968
5079
|
@builtins.property
|
|
4969
5080
|
@jsii.member(jsii_name="tagsRaw")
|
|
4970
5081
|
def tags_raw(self) -> typing.Optional[typing.List[_CfnTag_f6864754]]:
|
|
4971
|
-
'''
|
|
5082
|
+
'''Metadata that can be used to manage the vehicle model.'''
|
|
4972
5083
|
return typing.cast(typing.Optional[typing.List[_CfnTag_f6864754]], jsii.get(self, "tagsRaw"))
|
|
4973
5084
|
|
|
4974
5085
|
@tags_raw.setter
|
|
@@ -5006,10 +5117,10 @@ class CfnModelManifestProps:
|
|
|
5006
5117
|
|
|
5007
5118
|
:param name: The name of the vehicle model.
|
|
5008
5119
|
:param signal_catalog_arn: The Amazon Resource Name (ARN) of the signal catalog associated with the vehicle model.
|
|
5009
|
-
:param description:
|
|
5010
|
-
:param nodes:
|
|
5011
|
-
:param status:
|
|
5012
|
-
:param tags:
|
|
5120
|
+
:param description: A brief description of the vehicle model.
|
|
5121
|
+
:param nodes: A list of nodes, which are a general abstraction of signals.
|
|
5122
|
+
:param status: The state of the vehicle model. If the status is ``ACTIVE`` , the vehicle model can't be edited. If the status is ``DRAFT`` , you can edit the vehicle model. Default: - "DRAFT"
|
|
5123
|
+
:param tags: Metadata that can be used to manage the vehicle model.
|
|
5013
5124
|
|
|
5014
5125
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotfleetwise-modelmanifest.html
|
|
5015
5126
|
:exampleMetadata: fixture=_generated
|
|
@@ -5077,7 +5188,7 @@ class CfnModelManifestProps:
|
|
|
5077
5188
|
|
|
5078
5189
|
@builtins.property
|
|
5079
5190
|
def description(self) -> typing.Optional[builtins.str]:
|
|
5080
|
-
'''
|
|
5191
|
+
'''A brief description of the vehicle model.
|
|
5081
5192
|
|
|
5082
5193
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotfleetwise-modelmanifest.html#cfn-iotfleetwise-modelmanifest-description
|
|
5083
5194
|
'''
|
|
@@ -5086,7 +5197,7 @@ class CfnModelManifestProps:
|
|
|
5086
5197
|
|
|
5087
5198
|
@builtins.property
|
|
5088
5199
|
def nodes(self) -> typing.Optional[typing.List[builtins.str]]:
|
|
5089
|
-
'''
|
|
5200
|
+
'''A list of nodes, which are a general abstraction of signals.
|
|
5090
5201
|
|
|
5091
5202
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotfleetwise-modelmanifest.html#cfn-iotfleetwise-modelmanifest-nodes
|
|
5092
5203
|
'''
|
|
@@ -5095,7 +5206,7 @@ class CfnModelManifestProps:
|
|
|
5095
5206
|
|
|
5096
5207
|
@builtins.property
|
|
5097
5208
|
def status(self) -> typing.Optional[builtins.str]:
|
|
5098
|
-
'''
|
|
5209
|
+
'''The state of the vehicle model.
|
|
5099
5210
|
|
|
5100
5211
|
If the status is ``ACTIVE`` , the vehicle model can't be edited. If the status is ``DRAFT`` , you can edit the vehicle model.
|
|
5101
5212
|
|
|
@@ -5108,7 +5219,7 @@ class CfnModelManifestProps:
|
|
|
5108
5219
|
|
|
5109
5220
|
@builtins.property
|
|
5110
5221
|
def tags(self) -> typing.Optional[typing.List[_CfnTag_f6864754]]:
|
|
5111
|
-
'''
|
|
5222
|
+
'''Metadata that can be used to manage the vehicle model.
|
|
5112
5223
|
|
|
5113
5224
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotfleetwise-modelmanifest.html#cfn-iotfleetwise-modelmanifest-tags
|
|
5114
5225
|
'''
|
|
@@ -5135,6 +5246,8 @@ class CfnSignalCatalog(
|
|
|
5135
5246
|
):
|
|
5136
5247
|
'''Creates a collection of standardized signals that can be reused to create vehicle models.
|
|
5137
5248
|
|
|
5249
|
+
For more information, see `Signal catalogs <https://docs.aws.amazon.com/iot-fleetwise/latest/developerguide/signal-catalogs.html>`_ in the *AWS IoT FleetWise Developer Guide* .
|
|
5250
|
+
|
|
5138
5251
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotfleetwise-signalcatalog.html
|
|
5139
5252
|
:cloudformationResource: AWS::IoTFleetWise::SignalCatalog
|
|
5140
5253
|
:exampleMetadata: fixture=_generated
|
|
@@ -5220,11 +5333,11 @@ class CfnSignalCatalog(
|
|
|
5220
5333
|
'''
|
|
5221
5334
|
:param scope: Scope in which this resource is defined.
|
|
5222
5335
|
:param id: Construct identifier for this resource (unique in its scope).
|
|
5223
|
-
:param description:
|
|
5224
|
-
:param name:
|
|
5225
|
-
:param node_counts:
|
|
5226
|
-
:param nodes:
|
|
5227
|
-
:param tags:
|
|
5336
|
+
:param description: A brief description of the signal catalog.
|
|
5337
|
+
:param name: The name of the signal catalog.
|
|
5338
|
+
:param node_counts: Information about the number of nodes and node types in a vehicle network.
|
|
5339
|
+
:param nodes: A list of information about nodes, which are a general abstraction of signals.
|
|
5340
|
+
:param tags: Metadata that can be used to manage the signal catalog.
|
|
5228
5341
|
'''
|
|
5229
5342
|
if __debug__:
|
|
5230
5343
|
type_hints = typing.get_type_hints(_typecheckingstub__00a926b4b26fd9efc933b63c5d4e497e8bfeceb8f4fb16790d18152e0fd2e282)
|
|
@@ -5356,7 +5469,7 @@ class CfnSignalCatalog(
|
|
|
5356
5469
|
@builtins.property
|
|
5357
5470
|
@jsii.member(jsii_name="description")
|
|
5358
5471
|
def description(self) -> typing.Optional[builtins.str]:
|
|
5359
|
-
'''
|
|
5472
|
+
'''A brief description of the signal catalog.'''
|
|
5360
5473
|
return typing.cast(typing.Optional[builtins.str], jsii.get(self, "description"))
|
|
5361
5474
|
|
|
5362
5475
|
@description.setter
|
|
@@ -5369,7 +5482,7 @@ class CfnSignalCatalog(
|
|
|
5369
5482
|
@builtins.property
|
|
5370
5483
|
@jsii.member(jsii_name="name")
|
|
5371
5484
|
def name(self) -> typing.Optional[builtins.str]:
|
|
5372
|
-
'''
|
|
5485
|
+
'''The name of the signal catalog.'''
|
|
5373
5486
|
return typing.cast(typing.Optional[builtins.str], jsii.get(self, "name"))
|
|
5374
5487
|
|
|
5375
5488
|
@name.setter
|
|
@@ -5384,7 +5497,7 @@ class CfnSignalCatalog(
|
|
|
5384
5497
|
def node_counts(
|
|
5385
5498
|
self,
|
|
5386
5499
|
) -> typing.Optional[typing.Union[_IResolvable_da3f097b, "CfnSignalCatalog.NodeCountsProperty"]]:
|
|
5387
|
-
'''
|
|
5500
|
+
'''Information about the number of nodes and node types in a vehicle network.'''
|
|
5388
5501
|
return typing.cast(typing.Optional[typing.Union[_IResolvable_da3f097b, "CfnSignalCatalog.NodeCountsProperty"]], jsii.get(self, "nodeCounts"))
|
|
5389
5502
|
|
|
5390
5503
|
@node_counts.setter
|
|
@@ -5402,7 +5515,7 @@ class CfnSignalCatalog(
|
|
|
5402
5515
|
def nodes(
|
|
5403
5516
|
self,
|
|
5404
5517
|
) -> typing.Optional[typing.Union[_IResolvable_da3f097b, typing.List[typing.Union[_IResolvable_da3f097b, "CfnSignalCatalog.NodeProperty"]]]]:
|
|
5405
|
-
'''
|
|
5518
|
+
'''A list of information about nodes, which are a general abstraction of signals.'''
|
|
5406
5519
|
return typing.cast(typing.Optional[typing.Union[_IResolvable_da3f097b, typing.List[typing.Union[_IResolvable_da3f097b, "CfnSignalCatalog.NodeProperty"]]]], jsii.get(self, "nodes"))
|
|
5407
5520
|
|
|
5408
5521
|
@nodes.setter
|
|
@@ -5418,7 +5531,7 @@ class CfnSignalCatalog(
|
|
|
5418
5531
|
@builtins.property
|
|
5419
5532
|
@jsii.member(jsii_name="tagsRaw")
|
|
5420
5533
|
def tags_raw(self) -> typing.Optional[typing.List[_CfnTag_f6864754]]:
|
|
5421
|
-
'''
|
|
5534
|
+
'''Metadata that can be used to manage the signal catalog.'''
|
|
5422
5535
|
return typing.cast(typing.Optional[typing.List[_CfnTag_f6864754]], jsii.get(self, "tagsRaw"))
|
|
5423
5536
|
|
|
5424
5537
|
@tags_raw.setter
|
|
@@ -5464,12 +5577,12 @@ class CfnSignalCatalog(
|
|
|
5464
5577
|
|
|
5465
5578
|
:param data_type: The specified data type of the actuator.
|
|
5466
5579
|
:param fully_qualified_name: The fully qualified name of the actuator. For example, the fully qualified name of an actuator might be ``Vehicle.Front.Left.Door.Lock`` .
|
|
5467
|
-
:param allowed_values:
|
|
5468
|
-
:param assigned_value:
|
|
5469
|
-
:param description:
|
|
5470
|
-
:param max:
|
|
5471
|
-
:param min:
|
|
5472
|
-
:param unit:
|
|
5580
|
+
:param allowed_values: A list of possible values an actuator can take.
|
|
5581
|
+
:param assigned_value: A specified value for the actuator.
|
|
5582
|
+
:param description: A brief description of the actuator.
|
|
5583
|
+
:param max: The specified possible maximum value of an actuator.
|
|
5584
|
+
:param min: The specified possible minimum value of an actuator.
|
|
5585
|
+
:param unit: The scientific unit for the actuator.
|
|
5473
5586
|
|
|
5474
5587
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotfleetwise-signalcatalog-actuator.html
|
|
5475
5588
|
:exampleMetadata: fixture=_generated
|
|
@@ -5544,7 +5657,7 @@ class CfnSignalCatalog(
|
|
|
5544
5657
|
|
|
5545
5658
|
@builtins.property
|
|
5546
5659
|
def allowed_values(self) -> typing.Optional[typing.List[builtins.str]]:
|
|
5547
|
-
'''
|
|
5660
|
+
'''A list of possible values an actuator can take.
|
|
5548
5661
|
|
|
5549
5662
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotfleetwise-signalcatalog-actuator.html#cfn-iotfleetwise-signalcatalog-actuator-allowedvalues
|
|
5550
5663
|
'''
|
|
@@ -5553,7 +5666,7 @@ class CfnSignalCatalog(
|
|
|
5553
5666
|
|
|
5554
5667
|
@builtins.property
|
|
5555
5668
|
def assigned_value(self) -> typing.Optional[builtins.str]:
|
|
5556
|
-
'''
|
|
5669
|
+
'''A specified value for the actuator.
|
|
5557
5670
|
|
|
5558
5671
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotfleetwise-signalcatalog-actuator.html#cfn-iotfleetwise-signalcatalog-actuator-assignedvalue
|
|
5559
5672
|
'''
|
|
@@ -5562,7 +5675,7 @@ class CfnSignalCatalog(
|
|
|
5562
5675
|
|
|
5563
5676
|
@builtins.property
|
|
5564
5677
|
def description(self) -> typing.Optional[builtins.str]:
|
|
5565
|
-
'''
|
|
5678
|
+
'''A brief description of the actuator.
|
|
5566
5679
|
|
|
5567
5680
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotfleetwise-signalcatalog-actuator.html#cfn-iotfleetwise-signalcatalog-actuator-description
|
|
5568
5681
|
'''
|
|
@@ -5571,7 +5684,7 @@ class CfnSignalCatalog(
|
|
|
5571
5684
|
|
|
5572
5685
|
@builtins.property
|
|
5573
5686
|
def max(self) -> typing.Optional[jsii.Number]:
|
|
5574
|
-
'''
|
|
5687
|
+
'''The specified possible maximum value of an actuator.
|
|
5575
5688
|
|
|
5576
5689
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotfleetwise-signalcatalog-actuator.html#cfn-iotfleetwise-signalcatalog-actuator-max
|
|
5577
5690
|
'''
|
|
@@ -5580,7 +5693,7 @@ class CfnSignalCatalog(
|
|
|
5580
5693
|
|
|
5581
5694
|
@builtins.property
|
|
5582
5695
|
def min(self) -> typing.Optional[jsii.Number]:
|
|
5583
|
-
'''
|
|
5696
|
+
'''The specified possible minimum value of an actuator.
|
|
5584
5697
|
|
|
5585
5698
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotfleetwise-signalcatalog-actuator.html#cfn-iotfleetwise-signalcatalog-actuator-min
|
|
5586
5699
|
'''
|
|
@@ -5589,7 +5702,7 @@ class CfnSignalCatalog(
|
|
|
5589
5702
|
|
|
5590
5703
|
@builtins.property
|
|
5591
5704
|
def unit(self) -> typing.Optional[builtins.str]:
|
|
5592
|
-
'''
|
|
5705
|
+
'''The scientific unit for the actuator.
|
|
5593
5706
|
|
|
5594
5707
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotfleetwise-signalcatalog-actuator.html#cfn-iotfleetwise-signalcatalog-actuator-unit
|
|
5595
5708
|
'''
|
|
@@ -5640,13 +5753,13 @@ class CfnSignalCatalog(
|
|
|
5640
5753
|
|
|
5641
5754
|
:param data_type: The specified data type of the attribute.
|
|
5642
5755
|
:param fully_qualified_name: The fully qualified name of the attribute. For example, the fully qualified name of an attribute might be ``Vehicle.Body.Engine.Type`` .
|
|
5643
|
-
:param allowed_values:
|
|
5644
|
-
:param assigned_value:
|
|
5645
|
-
:param default_value:
|
|
5646
|
-
:param description:
|
|
5647
|
-
:param max:
|
|
5648
|
-
:param min:
|
|
5649
|
-
:param unit:
|
|
5756
|
+
:param allowed_values: A list of possible values an attribute can be assigned.
|
|
5757
|
+
:param assigned_value: A specified value for the attribute.
|
|
5758
|
+
:param default_value: The default value of the attribute.
|
|
5759
|
+
:param description: A brief description of the attribute.
|
|
5760
|
+
:param max: The specified possible maximum value of the attribute.
|
|
5761
|
+
:param min: The specified possible minimum value of the attribute.
|
|
5762
|
+
:param unit: The scientific unit for the attribute.
|
|
5650
5763
|
|
|
5651
5764
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotfleetwise-signalcatalog-attribute.html
|
|
5652
5765
|
:exampleMetadata: fixture=_generated
|
|
@@ -5725,7 +5838,7 @@ class CfnSignalCatalog(
|
|
|
5725
5838
|
|
|
5726
5839
|
@builtins.property
|
|
5727
5840
|
def allowed_values(self) -> typing.Optional[typing.List[builtins.str]]:
|
|
5728
|
-
'''
|
|
5841
|
+
'''A list of possible values an attribute can be assigned.
|
|
5729
5842
|
|
|
5730
5843
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotfleetwise-signalcatalog-attribute.html#cfn-iotfleetwise-signalcatalog-attribute-allowedvalues
|
|
5731
5844
|
'''
|
|
@@ -5734,7 +5847,7 @@ class CfnSignalCatalog(
|
|
|
5734
5847
|
|
|
5735
5848
|
@builtins.property
|
|
5736
5849
|
def assigned_value(self) -> typing.Optional[builtins.str]:
|
|
5737
|
-
'''
|
|
5850
|
+
'''A specified value for the attribute.
|
|
5738
5851
|
|
|
5739
5852
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotfleetwise-signalcatalog-attribute.html#cfn-iotfleetwise-signalcatalog-attribute-assignedvalue
|
|
5740
5853
|
'''
|
|
@@ -5743,7 +5856,7 @@ class CfnSignalCatalog(
|
|
|
5743
5856
|
|
|
5744
5857
|
@builtins.property
|
|
5745
5858
|
def default_value(self) -> typing.Optional[builtins.str]:
|
|
5746
|
-
'''
|
|
5859
|
+
'''The default value of the attribute.
|
|
5747
5860
|
|
|
5748
5861
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotfleetwise-signalcatalog-attribute.html#cfn-iotfleetwise-signalcatalog-attribute-defaultvalue
|
|
5749
5862
|
'''
|
|
@@ -5752,7 +5865,7 @@ class CfnSignalCatalog(
|
|
|
5752
5865
|
|
|
5753
5866
|
@builtins.property
|
|
5754
5867
|
def description(self) -> typing.Optional[builtins.str]:
|
|
5755
|
-
'''
|
|
5868
|
+
'''A brief description of the attribute.
|
|
5756
5869
|
|
|
5757
5870
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotfleetwise-signalcatalog-attribute.html#cfn-iotfleetwise-signalcatalog-attribute-description
|
|
5758
5871
|
'''
|
|
@@ -5761,7 +5874,7 @@ class CfnSignalCatalog(
|
|
|
5761
5874
|
|
|
5762
5875
|
@builtins.property
|
|
5763
5876
|
def max(self) -> typing.Optional[jsii.Number]:
|
|
5764
|
-
'''
|
|
5877
|
+
'''The specified possible maximum value of the attribute.
|
|
5765
5878
|
|
|
5766
5879
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotfleetwise-signalcatalog-attribute.html#cfn-iotfleetwise-signalcatalog-attribute-max
|
|
5767
5880
|
'''
|
|
@@ -5770,7 +5883,7 @@ class CfnSignalCatalog(
|
|
|
5770
5883
|
|
|
5771
5884
|
@builtins.property
|
|
5772
5885
|
def min(self) -> typing.Optional[jsii.Number]:
|
|
5773
|
-
'''
|
|
5886
|
+
'''The specified possible minimum value of the attribute.
|
|
5774
5887
|
|
|
5775
5888
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotfleetwise-signalcatalog-attribute.html#cfn-iotfleetwise-signalcatalog-attribute-min
|
|
5776
5889
|
'''
|
|
@@ -5779,7 +5892,7 @@ class CfnSignalCatalog(
|
|
|
5779
5892
|
|
|
5780
5893
|
@builtins.property
|
|
5781
5894
|
def unit(self) -> typing.Optional[builtins.str]:
|
|
5782
|
-
'''
|
|
5895
|
+
'''The scientific unit for the attribute.
|
|
5783
5896
|
|
|
5784
5897
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotfleetwise-signalcatalog-attribute.html#cfn-iotfleetwise-signalcatalog-attribute-unit
|
|
5785
5898
|
'''
|
|
@@ -5815,7 +5928,7 @@ class CfnSignalCatalog(
|
|
|
5815
5928
|
'''A group of signals that are defined in a hierarchical structure.
|
|
5816
5929
|
|
|
5817
5930
|
:param fully_qualified_name: The fully qualified name of the branch. For example, the fully qualified name of a branch might be ``Vehicle.Body.Engine`` .
|
|
5818
|
-
:param description:
|
|
5931
|
+
:param description: A brief description of the branch.
|
|
5819
5932
|
|
|
5820
5933
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotfleetwise-signalcatalog-branch.html
|
|
5821
5934
|
:exampleMetadata: fixture=_generated
|
|
@@ -5857,7 +5970,7 @@ class CfnSignalCatalog(
|
|
|
5857
5970
|
|
|
5858
5971
|
@builtins.property
|
|
5859
5972
|
def description(self) -> typing.Optional[builtins.str]:
|
|
5860
|
-
'''
|
|
5973
|
+
'''A brief description of the branch.
|
|
5861
5974
|
|
|
5862
5975
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotfleetwise-signalcatalog-branch.html#cfn-iotfleetwise-signalcatalog-branch-description
|
|
5863
5976
|
'''
|
|
@@ -5898,11 +6011,11 @@ class CfnSignalCatalog(
|
|
|
5898
6011
|
) -> None:
|
|
5899
6012
|
'''Information about the number of nodes and node types in a vehicle network.
|
|
5900
6013
|
|
|
5901
|
-
:param total_actuators:
|
|
5902
|
-
:param total_attributes:
|
|
5903
|
-
:param total_branches:
|
|
5904
|
-
:param total_nodes:
|
|
5905
|
-
:param total_sensors:
|
|
6014
|
+
:param total_actuators: The total number of nodes in a vehicle network that represent actuators.
|
|
6015
|
+
:param total_attributes: The total number of nodes in a vehicle network that represent attributes.
|
|
6016
|
+
:param total_branches: The total number of nodes in a vehicle network that represent branches.
|
|
6017
|
+
:param total_nodes: The total number of nodes in a vehicle network.
|
|
6018
|
+
:param total_sensors: The total number of nodes in a vehicle network that represent sensors.
|
|
5906
6019
|
|
|
5907
6020
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotfleetwise-signalcatalog-nodecounts.html
|
|
5908
6021
|
:exampleMetadata: fixture=_generated
|
|
@@ -5942,7 +6055,7 @@ class CfnSignalCatalog(
|
|
|
5942
6055
|
|
|
5943
6056
|
@builtins.property
|
|
5944
6057
|
def total_actuators(self) -> typing.Optional[jsii.Number]:
|
|
5945
|
-
'''
|
|
6058
|
+
'''The total number of nodes in a vehicle network that represent actuators.
|
|
5946
6059
|
|
|
5947
6060
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotfleetwise-signalcatalog-nodecounts.html#cfn-iotfleetwise-signalcatalog-nodecounts-totalactuators
|
|
5948
6061
|
'''
|
|
@@ -5951,7 +6064,7 @@ class CfnSignalCatalog(
|
|
|
5951
6064
|
|
|
5952
6065
|
@builtins.property
|
|
5953
6066
|
def total_attributes(self) -> typing.Optional[jsii.Number]:
|
|
5954
|
-
'''
|
|
6067
|
+
'''The total number of nodes in a vehicle network that represent attributes.
|
|
5955
6068
|
|
|
5956
6069
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotfleetwise-signalcatalog-nodecounts.html#cfn-iotfleetwise-signalcatalog-nodecounts-totalattributes
|
|
5957
6070
|
'''
|
|
@@ -5960,7 +6073,7 @@ class CfnSignalCatalog(
|
|
|
5960
6073
|
|
|
5961
6074
|
@builtins.property
|
|
5962
6075
|
def total_branches(self) -> typing.Optional[jsii.Number]:
|
|
5963
|
-
'''
|
|
6076
|
+
'''The total number of nodes in a vehicle network that represent branches.
|
|
5964
6077
|
|
|
5965
6078
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotfleetwise-signalcatalog-nodecounts.html#cfn-iotfleetwise-signalcatalog-nodecounts-totalbranches
|
|
5966
6079
|
'''
|
|
@@ -5969,7 +6082,7 @@ class CfnSignalCatalog(
|
|
|
5969
6082
|
|
|
5970
6083
|
@builtins.property
|
|
5971
6084
|
def total_nodes(self) -> typing.Optional[jsii.Number]:
|
|
5972
|
-
'''
|
|
6085
|
+
'''The total number of nodes in a vehicle network.
|
|
5973
6086
|
|
|
5974
6087
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotfleetwise-signalcatalog-nodecounts.html#cfn-iotfleetwise-signalcatalog-nodecounts-totalnodes
|
|
5975
6088
|
'''
|
|
@@ -5978,7 +6091,7 @@ class CfnSignalCatalog(
|
|
|
5978
6091
|
|
|
5979
6092
|
@builtins.property
|
|
5980
6093
|
def total_sensors(self) -> typing.Optional[jsii.Number]:
|
|
5981
|
-
'''
|
|
6094
|
+
'''The total number of nodes in a vehicle network that represent sensors.
|
|
5982
6095
|
|
|
5983
6096
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotfleetwise-signalcatalog-nodecounts.html#cfn-iotfleetwise-signalcatalog-nodecounts-totalsensors
|
|
5984
6097
|
'''
|
|
@@ -6019,10 +6132,10 @@ class CfnSignalCatalog(
|
|
|
6019
6132
|
|
|
6020
6133
|
A node can be specified as an actuator, attribute, branch, or sensor.
|
|
6021
6134
|
|
|
6022
|
-
:param actuator:
|
|
6023
|
-
:param attribute:
|
|
6024
|
-
:param branch:
|
|
6025
|
-
:param sensor:
|
|
6135
|
+
:param actuator: Information about a node specified as an actuator. .. epigraph:: An actuator is a digital representation of a vehicle device.
|
|
6136
|
+
:param attribute: Information about a node specified as an attribute. .. epigraph:: An attribute represents static information about a vehicle.
|
|
6137
|
+
:param branch: Information about a node specified as a branch. .. epigraph:: A group of signals that are defined in a hierarchical structure.
|
|
6138
|
+
:param sensor: An input component that reports the environmental condition of a vehicle. .. epigraph:: You can collect data about fluid levels, temperatures, vibrations, or battery voltage from sensors.
|
|
6026
6139
|
|
|
6027
6140
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotfleetwise-signalcatalog-node.html
|
|
6028
6141
|
:exampleMetadata: fixture=_generated
|
|
@@ -6098,7 +6211,7 @@ class CfnSignalCatalog(
|
|
|
6098
6211
|
def actuator(
|
|
6099
6212
|
self,
|
|
6100
6213
|
) -> typing.Optional[typing.Union[_IResolvable_da3f097b, "CfnSignalCatalog.ActuatorProperty"]]:
|
|
6101
|
-
'''
|
|
6214
|
+
'''Information about a node specified as an actuator.
|
|
6102
6215
|
|
|
6103
6216
|
.. epigraph::
|
|
6104
6217
|
|
|
@@ -6113,7 +6226,7 @@ class CfnSignalCatalog(
|
|
|
6113
6226
|
def attribute(
|
|
6114
6227
|
self,
|
|
6115
6228
|
) -> typing.Optional[typing.Union[_IResolvable_da3f097b, "CfnSignalCatalog.AttributeProperty"]]:
|
|
6116
|
-
'''
|
|
6229
|
+
'''Information about a node specified as an attribute.
|
|
6117
6230
|
|
|
6118
6231
|
.. epigraph::
|
|
6119
6232
|
|
|
@@ -6128,7 +6241,7 @@ class CfnSignalCatalog(
|
|
|
6128
6241
|
def branch(
|
|
6129
6242
|
self,
|
|
6130
6243
|
) -> typing.Optional[typing.Union[_IResolvable_da3f097b, "CfnSignalCatalog.BranchProperty"]]:
|
|
6131
|
-
'''
|
|
6244
|
+
'''Information about a node specified as a branch.
|
|
6132
6245
|
|
|
6133
6246
|
.. epigraph::
|
|
6134
6247
|
|
|
@@ -6143,7 +6256,7 @@ class CfnSignalCatalog(
|
|
|
6143
6256
|
def sensor(
|
|
6144
6257
|
self,
|
|
6145
6258
|
) -> typing.Optional[typing.Union[_IResolvable_da3f097b, "CfnSignalCatalog.SensorProperty"]]:
|
|
6146
|
-
'''
|
|
6259
|
+
'''An input component that reports the environmental condition of a vehicle.
|
|
6147
6260
|
|
|
6148
6261
|
.. epigraph::
|
|
6149
6262
|
|
|
@@ -6198,11 +6311,11 @@ class CfnSignalCatalog(
|
|
|
6198
6311
|
|
|
6199
6312
|
:param data_type: The specified data type of the sensor.
|
|
6200
6313
|
:param fully_qualified_name: The fully qualified name of the sensor. For example, the fully qualified name of a sensor might be ``Vehicle.Body.Engine.Battery`` .
|
|
6201
|
-
:param allowed_values:
|
|
6202
|
-
:param description:
|
|
6203
|
-
:param max:
|
|
6204
|
-
:param min:
|
|
6205
|
-
:param unit:
|
|
6314
|
+
:param allowed_values: A list of possible values a sensor can take.
|
|
6315
|
+
:param description: A brief description of a sensor.
|
|
6316
|
+
:param max: The specified possible maximum value of the sensor.
|
|
6317
|
+
:param min: The specified possible minimum value of the sensor.
|
|
6318
|
+
:param unit: The scientific unit of measurement for data collected by the sensor.
|
|
6206
6319
|
|
|
6207
6320
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotfleetwise-signalcatalog-sensor.html
|
|
6208
6321
|
:exampleMetadata: fixture=_generated
|
|
@@ -6273,7 +6386,7 @@ class CfnSignalCatalog(
|
|
|
6273
6386
|
|
|
6274
6387
|
@builtins.property
|
|
6275
6388
|
def allowed_values(self) -> typing.Optional[typing.List[builtins.str]]:
|
|
6276
|
-
'''
|
|
6389
|
+
'''A list of possible values a sensor can take.
|
|
6277
6390
|
|
|
6278
6391
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotfleetwise-signalcatalog-sensor.html#cfn-iotfleetwise-signalcatalog-sensor-allowedvalues
|
|
6279
6392
|
'''
|
|
@@ -6282,7 +6395,7 @@ class CfnSignalCatalog(
|
|
|
6282
6395
|
|
|
6283
6396
|
@builtins.property
|
|
6284
6397
|
def description(self) -> typing.Optional[builtins.str]:
|
|
6285
|
-
'''
|
|
6398
|
+
'''A brief description of a sensor.
|
|
6286
6399
|
|
|
6287
6400
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotfleetwise-signalcatalog-sensor.html#cfn-iotfleetwise-signalcatalog-sensor-description
|
|
6288
6401
|
'''
|
|
@@ -6291,7 +6404,7 @@ class CfnSignalCatalog(
|
|
|
6291
6404
|
|
|
6292
6405
|
@builtins.property
|
|
6293
6406
|
def max(self) -> typing.Optional[jsii.Number]:
|
|
6294
|
-
'''
|
|
6407
|
+
'''The specified possible maximum value of the sensor.
|
|
6295
6408
|
|
|
6296
6409
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotfleetwise-signalcatalog-sensor.html#cfn-iotfleetwise-signalcatalog-sensor-max
|
|
6297
6410
|
'''
|
|
@@ -6300,7 +6413,7 @@ class CfnSignalCatalog(
|
|
|
6300
6413
|
|
|
6301
6414
|
@builtins.property
|
|
6302
6415
|
def min(self) -> typing.Optional[jsii.Number]:
|
|
6303
|
-
'''
|
|
6416
|
+
'''The specified possible minimum value of the sensor.
|
|
6304
6417
|
|
|
6305
6418
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotfleetwise-signalcatalog-sensor.html#cfn-iotfleetwise-signalcatalog-sensor-min
|
|
6306
6419
|
'''
|
|
@@ -6309,7 +6422,7 @@ class CfnSignalCatalog(
|
|
|
6309
6422
|
|
|
6310
6423
|
@builtins.property
|
|
6311
6424
|
def unit(self) -> typing.Optional[builtins.str]:
|
|
6312
|
-
'''
|
|
6425
|
+
'''The scientific unit of measurement for data collected by the sensor.
|
|
6313
6426
|
|
|
6314
6427
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotfleetwise-signalcatalog-sensor.html#cfn-iotfleetwise-signalcatalog-sensor-unit
|
|
6315
6428
|
'''
|
|
@@ -6351,11 +6464,11 @@ class CfnSignalCatalogProps:
|
|
|
6351
6464
|
) -> None:
|
|
6352
6465
|
'''Properties for defining a ``CfnSignalCatalog``.
|
|
6353
6466
|
|
|
6354
|
-
:param description:
|
|
6355
|
-
:param name:
|
|
6356
|
-
:param node_counts:
|
|
6357
|
-
:param nodes:
|
|
6358
|
-
:param tags:
|
|
6467
|
+
:param description: A brief description of the signal catalog.
|
|
6468
|
+
:param name: The name of the signal catalog.
|
|
6469
|
+
:param node_counts: Information about the number of nodes and node types in a vehicle network.
|
|
6470
|
+
:param nodes: A list of information about nodes, which are a general abstraction of signals.
|
|
6471
|
+
:param tags: Metadata that can be used to manage the signal catalog.
|
|
6359
6472
|
|
|
6360
6473
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotfleetwise-signalcatalog.html
|
|
6361
6474
|
:exampleMetadata: fixture=_generated
|
|
@@ -6447,7 +6560,7 @@ class CfnSignalCatalogProps:
|
|
|
6447
6560
|
|
|
6448
6561
|
@builtins.property
|
|
6449
6562
|
def description(self) -> typing.Optional[builtins.str]:
|
|
6450
|
-
'''
|
|
6563
|
+
'''A brief description of the signal catalog.
|
|
6451
6564
|
|
|
6452
6565
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotfleetwise-signalcatalog.html#cfn-iotfleetwise-signalcatalog-description
|
|
6453
6566
|
'''
|
|
@@ -6456,7 +6569,7 @@ class CfnSignalCatalogProps:
|
|
|
6456
6569
|
|
|
6457
6570
|
@builtins.property
|
|
6458
6571
|
def name(self) -> typing.Optional[builtins.str]:
|
|
6459
|
-
'''
|
|
6572
|
+
'''The name of the signal catalog.
|
|
6460
6573
|
|
|
6461
6574
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotfleetwise-signalcatalog.html#cfn-iotfleetwise-signalcatalog-name
|
|
6462
6575
|
'''
|
|
@@ -6467,7 +6580,7 @@ class CfnSignalCatalogProps:
|
|
|
6467
6580
|
def node_counts(
|
|
6468
6581
|
self,
|
|
6469
6582
|
) -> typing.Optional[typing.Union[_IResolvable_da3f097b, CfnSignalCatalog.NodeCountsProperty]]:
|
|
6470
|
-
'''
|
|
6583
|
+
'''Information about the number of nodes and node types in a vehicle network.
|
|
6471
6584
|
|
|
6472
6585
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotfleetwise-signalcatalog.html#cfn-iotfleetwise-signalcatalog-nodecounts
|
|
6473
6586
|
'''
|
|
@@ -6478,7 +6591,7 @@ class CfnSignalCatalogProps:
|
|
|
6478
6591
|
def nodes(
|
|
6479
6592
|
self,
|
|
6480
6593
|
) -> typing.Optional[typing.Union[_IResolvable_da3f097b, typing.List[typing.Union[_IResolvable_da3f097b, CfnSignalCatalog.NodeProperty]]]]:
|
|
6481
|
-
'''
|
|
6594
|
+
'''A list of information about nodes, which are a general abstraction of signals.
|
|
6482
6595
|
|
|
6483
6596
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotfleetwise-signalcatalog.html#cfn-iotfleetwise-signalcatalog-nodes
|
|
6484
6597
|
'''
|
|
@@ -6487,7 +6600,7 @@ class CfnSignalCatalogProps:
|
|
|
6487
6600
|
|
|
6488
6601
|
@builtins.property
|
|
6489
6602
|
def tags(self) -> typing.Optional[typing.List[_CfnTag_f6864754]]:
|
|
6490
|
-
'''
|
|
6603
|
+
'''Metadata that can be used to manage the signal catalog.
|
|
6491
6604
|
|
|
6492
6605
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotfleetwise-signalcatalog.html#cfn-iotfleetwise-signalcatalog-tags
|
|
6493
6606
|
'''
|
|
@@ -6512,7 +6625,14 @@ class CfnStateTemplate(
|
|
|
6512
6625
|
metaclass=jsii.JSIIMeta,
|
|
6513
6626
|
jsii_type="aws-cdk-lib.aws_iotfleetwise.CfnStateTemplate",
|
|
6514
6627
|
):
|
|
6515
|
-
'''
|
|
6628
|
+
'''Creates a mechanism for vehicle owners to track the state of their vehicles.
|
|
6629
|
+
|
|
6630
|
+
State templates determine which signal updates the vehicle sends to the cloud.
|
|
6631
|
+
|
|
6632
|
+
For more information, see `State templates <https://docs.aws.amazon.com/iot-fleetwise/latest/developerguide/state-templates.html>`_ in the *AWS IoT FleetWise Developer Guide* .
|
|
6633
|
+
.. epigraph::
|
|
6634
|
+
|
|
6635
|
+
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* .
|
|
6516
6636
|
|
|
6517
6637
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotfleetwise-statetemplate.html
|
|
6518
6638
|
:cloudformationResource: AWS::IoTFleetWise::StateTemplate
|
|
@@ -6556,13 +6676,13 @@ class CfnStateTemplate(
|
|
|
6556
6676
|
'''
|
|
6557
6677
|
:param scope: Scope in which this resource is defined.
|
|
6558
6678
|
:param id: Construct identifier for this resource (unique in its scope).
|
|
6559
|
-
:param name:
|
|
6560
|
-
:param signal_catalog_arn:
|
|
6561
|
-
:param state_template_properties:
|
|
6562
|
-
:param data_extra_dimensions:
|
|
6563
|
-
:param description:
|
|
6564
|
-
:param metadata_extra_dimensions:
|
|
6565
|
-
:param tags:
|
|
6679
|
+
:param name: The unique alias of the state template.
|
|
6680
|
+
:param signal_catalog_arn: The Amazon Resource Name (ARN) of the signal catalog associated with the state template.
|
|
6681
|
+
:param state_template_properties: A list of signals from which data is collected. The state template properties contain the fully qualified names of the signals.
|
|
6682
|
+
:param data_extra_dimensions: A list of vehicle attributes associated with the payload published on the state template's MQTT topic.
|
|
6683
|
+
:param description: A brief description of the state template.
|
|
6684
|
+
:param metadata_extra_dimensions: A list of vehicle attributes to associate with the user properties of the messages published on the state template's MQTT topic. For example, if you add ``Vehicle.Attributes.Make`` and ``Vehicle.Attributes.Model`` attributes, these attributes are included as user properties with the MQTT message.
|
|
6685
|
+
:param tags: Metadata that can be used to manage the state template.
|
|
6566
6686
|
'''
|
|
6567
6687
|
if __debug__:
|
|
6568
6688
|
type_hints = typing.get_type_hints(_typecheckingstub__abb7c39bd72174c6927a0144336547ba8eb6d6e1a1e3b03c36137d528cc0517e)
|
|
@@ -6613,7 +6733,8 @@ class CfnStateTemplate(
|
|
|
6613
6733
|
@builtins.property
|
|
6614
6734
|
@jsii.member(jsii_name="attrArn")
|
|
6615
6735
|
def attr_arn(self) -> builtins.str:
|
|
6616
|
-
'''
|
|
6736
|
+
'''The Amazon Resource Name (ARN) of the state template.
|
|
6737
|
+
|
|
6617
6738
|
:cloudformationAttribute: Arn
|
|
6618
6739
|
'''
|
|
6619
6740
|
return typing.cast(builtins.str, jsii.get(self, "attrArn"))
|
|
@@ -6621,7 +6742,8 @@ class CfnStateTemplate(
|
|
|
6621
6742
|
@builtins.property
|
|
6622
6743
|
@jsii.member(jsii_name="attrCreationTime")
|
|
6623
6744
|
def attr_creation_time(self) -> builtins.str:
|
|
6624
|
-
'''
|
|
6745
|
+
'''The time the state template was created, in seconds since epoch (January 1, 1970 at midnight UTC time).
|
|
6746
|
+
|
|
6625
6747
|
:cloudformationAttribute: CreationTime
|
|
6626
6748
|
'''
|
|
6627
6749
|
return typing.cast(builtins.str, jsii.get(self, "attrCreationTime"))
|
|
@@ -6629,7 +6751,8 @@ class CfnStateTemplate(
|
|
|
6629
6751
|
@builtins.property
|
|
6630
6752
|
@jsii.member(jsii_name="attrLastModificationTime")
|
|
6631
6753
|
def attr_last_modification_time(self) -> builtins.str:
|
|
6632
|
-
'''
|
|
6754
|
+
'''The time the state template was last updated, in seconds since epoch (January 1, 1970 at midnight UTC time).
|
|
6755
|
+
|
|
6633
6756
|
:cloudformationAttribute: LastModificationTime
|
|
6634
6757
|
'''
|
|
6635
6758
|
return typing.cast(builtins.str, jsii.get(self, "attrLastModificationTime"))
|
|
@@ -6648,6 +6771,7 @@ class CfnStateTemplate(
|
|
|
6648
6771
|
@builtins.property
|
|
6649
6772
|
@jsii.member(jsii_name="name")
|
|
6650
6773
|
def name(self) -> builtins.str:
|
|
6774
|
+
'''The unique alias of the state template.'''
|
|
6651
6775
|
return typing.cast(builtins.str, jsii.get(self, "name"))
|
|
6652
6776
|
|
|
6653
6777
|
@name.setter
|
|
@@ -6660,6 +6784,7 @@ class CfnStateTemplate(
|
|
|
6660
6784
|
@builtins.property
|
|
6661
6785
|
@jsii.member(jsii_name="signalCatalogArn")
|
|
6662
6786
|
def signal_catalog_arn(self) -> builtins.str:
|
|
6787
|
+
'''The Amazon Resource Name (ARN) of the signal catalog associated with the state template.'''
|
|
6663
6788
|
return typing.cast(builtins.str, jsii.get(self, "signalCatalogArn"))
|
|
6664
6789
|
|
|
6665
6790
|
@signal_catalog_arn.setter
|
|
@@ -6672,6 +6797,7 @@ class CfnStateTemplate(
|
|
|
6672
6797
|
@builtins.property
|
|
6673
6798
|
@jsii.member(jsii_name="stateTemplateProperties")
|
|
6674
6799
|
def state_template_properties(self) -> typing.List[builtins.str]:
|
|
6800
|
+
'''A list of signals from which data is collected.'''
|
|
6675
6801
|
return typing.cast(typing.List[builtins.str], jsii.get(self, "stateTemplateProperties"))
|
|
6676
6802
|
|
|
6677
6803
|
@state_template_properties.setter
|
|
@@ -6684,6 +6810,7 @@ class CfnStateTemplate(
|
|
|
6684
6810
|
@builtins.property
|
|
6685
6811
|
@jsii.member(jsii_name="dataExtraDimensions")
|
|
6686
6812
|
def data_extra_dimensions(self) -> typing.Optional[typing.List[builtins.str]]:
|
|
6813
|
+
'''A list of vehicle attributes associated with the payload published on the state template's MQTT topic.'''
|
|
6687
6814
|
return typing.cast(typing.Optional[typing.List[builtins.str]], jsii.get(self, "dataExtraDimensions"))
|
|
6688
6815
|
|
|
6689
6816
|
@data_extra_dimensions.setter
|
|
@@ -6699,6 +6826,7 @@ class CfnStateTemplate(
|
|
|
6699
6826
|
@builtins.property
|
|
6700
6827
|
@jsii.member(jsii_name="description")
|
|
6701
6828
|
def description(self) -> typing.Optional[builtins.str]:
|
|
6829
|
+
'''A brief description of the state template.'''
|
|
6702
6830
|
return typing.cast(typing.Optional[builtins.str], jsii.get(self, "description"))
|
|
6703
6831
|
|
|
6704
6832
|
@description.setter
|
|
@@ -6711,6 +6839,7 @@ class CfnStateTemplate(
|
|
|
6711
6839
|
@builtins.property
|
|
6712
6840
|
@jsii.member(jsii_name="metadataExtraDimensions")
|
|
6713
6841
|
def metadata_extra_dimensions(self) -> typing.Optional[typing.List[builtins.str]]:
|
|
6842
|
+
'''A list of vehicle attributes to associate with the user properties of the messages published on the state template's MQTT topic.'''
|
|
6714
6843
|
return typing.cast(typing.Optional[typing.List[builtins.str]], jsii.get(self, "metadataExtraDimensions"))
|
|
6715
6844
|
|
|
6716
6845
|
@metadata_extra_dimensions.setter
|
|
@@ -6726,6 +6855,7 @@ class CfnStateTemplate(
|
|
|
6726
6855
|
@builtins.property
|
|
6727
6856
|
@jsii.member(jsii_name="tags")
|
|
6728
6857
|
def tags(self) -> typing.Optional[typing.List[_CfnTag_f6864754]]:
|
|
6858
|
+
'''Metadata that can be used to manage the state template.'''
|
|
6729
6859
|
return typing.cast(typing.Optional[typing.List[_CfnTag_f6864754]], jsii.get(self, "tags"))
|
|
6730
6860
|
|
|
6731
6861
|
@tags.setter
|
|
@@ -6763,13 +6893,13 @@ class CfnStateTemplateProps:
|
|
|
6763
6893
|
) -> None:
|
|
6764
6894
|
'''Properties for defining a ``CfnStateTemplate``.
|
|
6765
6895
|
|
|
6766
|
-
:param name:
|
|
6767
|
-
:param signal_catalog_arn:
|
|
6768
|
-
:param state_template_properties:
|
|
6769
|
-
:param data_extra_dimensions:
|
|
6770
|
-
:param description:
|
|
6771
|
-
:param metadata_extra_dimensions:
|
|
6772
|
-
:param tags:
|
|
6896
|
+
:param name: The unique alias of the state template.
|
|
6897
|
+
:param signal_catalog_arn: The Amazon Resource Name (ARN) of the signal catalog associated with the state template.
|
|
6898
|
+
:param state_template_properties: A list of signals from which data is collected. The state template properties contain the fully qualified names of the signals.
|
|
6899
|
+
:param data_extra_dimensions: A list of vehicle attributes associated with the payload published on the state template's MQTT topic.
|
|
6900
|
+
:param description: A brief description of the state template.
|
|
6901
|
+
:param metadata_extra_dimensions: A list of vehicle attributes to associate with the user properties of the messages published on the state template's MQTT topic. For example, if you add ``Vehicle.Attributes.Make`` and ``Vehicle.Attributes.Model`` attributes, these attributes are included as user properties with the MQTT message.
|
|
6902
|
+
:param tags: Metadata that can be used to manage the state template.
|
|
6773
6903
|
|
|
6774
6904
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotfleetwise-statetemplate.html
|
|
6775
6905
|
:exampleMetadata: fixture=_generated
|
|
@@ -6820,7 +6950,8 @@ class CfnStateTemplateProps:
|
|
|
6820
6950
|
|
|
6821
6951
|
@builtins.property
|
|
6822
6952
|
def name(self) -> builtins.str:
|
|
6823
|
-
'''
|
|
6953
|
+
'''The unique alias of the state template.
|
|
6954
|
+
|
|
6824
6955
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotfleetwise-statetemplate.html#cfn-iotfleetwise-statetemplate-name
|
|
6825
6956
|
'''
|
|
6826
6957
|
result = self._values.get("name")
|
|
@@ -6829,7 +6960,8 @@ class CfnStateTemplateProps:
|
|
|
6829
6960
|
|
|
6830
6961
|
@builtins.property
|
|
6831
6962
|
def signal_catalog_arn(self) -> builtins.str:
|
|
6832
|
-
'''
|
|
6963
|
+
'''The Amazon Resource Name (ARN) of the signal catalog associated with the state template.
|
|
6964
|
+
|
|
6833
6965
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotfleetwise-statetemplate.html#cfn-iotfleetwise-statetemplate-signalcatalogarn
|
|
6834
6966
|
'''
|
|
6835
6967
|
result = self._values.get("signal_catalog_arn")
|
|
@@ -6838,7 +6970,10 @@ class CfnStateTemplateProps:
|
|
|
6838
6970
|
|
|
6839
6971
|
@builtins.property
|
|
6840
6972
|
def state_template_properties(self) -> typing.List[builtins.str]:
|
|
6841
|
-
'''
|
|
6973
|
+
'''A list of signals from which data is collected.
|
|
6974
|
+
|
|
6975
|
+
The state template properties contain the fully qualified names of the signals.
|
|
6976
|
+
|
|
6842
6977
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotfleetwise-statetemplate.html#cfn-iotfleetwise-statetemplate-statetemplateproperties
|
|
6843
6978
|
'''
|
|
6844
6979
|
result = self._values.get("state_template_properties")
|
|
@@ -6847,7 +6982,8 @@ class CfnStateTemplateProps:
|
|
|
6847
6982
|
|
|
6848
6983
|
@builtins.property
|
|
6849
6984
|
def data_extra_dimensions(self) -> typing.Optional[typing.List[builtins.str]]:
|
|
6850
|
-
'''
|
|
6985
|
+
'''A list of vehicle attributes associated with the payload published on the state template's MQTT topic.
|
|
6986
|
+
|
|
6851
6987
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotfleetwise-statetemplate.html#cfn-iotfleetwise-statetemplate-dataextradimensions
|
|
6852
6988
|
'''
|
|
6853
6989
|
result = self._values.get("data_extra_dimensions")
|
|
@@ -6855,7 +6991,8 @@ class CfnStateTemplateProps:
|
|
|
6855
6991
|
|
|
6856
6992
|
@builtins.property
|
|
6857
6993
|
def description(self) -> typing.Optional[builtins.str]:
|
|
6858
|
-
'''
|
|
6994
|
+
'''A brief description of the state template.
|
|
6995
|
+
|
|
6859
6996
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotfleetwise-statetemplate.html#cfn-iotfleetwise-statetemplate-description
|
|
6860
6997
|
'''
|
|
6861
6998
|
result = self._values.get("description")
|
|
@@ -6863,7 +7000,10 @@ class CfnStateTemplateProps:
|
|
|
6863
7000
|
|
|
6864
7001
|
@builtins.property
|
|
6865
7002
|
def metadata_extra_dimensions(self) -> typing.Optional[typing.List[builtins.str]]:
|
|
6866
|
-
'''
|
|
7003
|
+
'''A list of vehicle attributes to associate with the user properties of the messages published on the state template's MQTT topic.
|
|
7004
|
+
|
|
7005
|
+
For example, if you add ``Vehicle.Attributes.Make`` and ``Vehicle.Attributes.Model`` attributes, these attributes are included as user properties with the MQTT message.
|
|
7006
|
+
|
|
6867
7007
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotfleetwise-statetemplate.html#cfn-iotfleetwise-statetemplate-metadataextradimensions
|
|
6868
7008
|
'''
|
|
6869
7009
|
result = self._values.get("metadata_extra_dimensions")
|
|
@@ -6871,7 +7011,8 @@ class CfnStateTemplateProps:
|
|
|
6871
7011
|
|
|
6872
7012
|
@builtins.property
|
|
6873
7013
|
def tags(self) -> typing.Optional[typing.List[_CfnTag_f6864754]]:
|
|
6874
|
-
'''
|
|
7014
|
+
'''Metadata that can be used to manage the state template.
|
|
7015
|
+
|
|
6875
7016
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotfleetwise-statetemplate.html#cfn-iotfleetwise-statetemplate-tags
|
|
6876
7017
|
'''
|
|
6877
7018
|
result = self._values.get("tags")
|
|
@@ -6902,7 +7043,7 @@ class CfnVehicle(
|
|
|
6902
7043
|
|
|
6903
7044
|
If you have an existing AWS IoT thing, you can use AWS IoT FleetWise to create a vehicle and collect data from your thing.
|
|
6904
7045
|
|
|
6905
|
-
For more information, see `
|
|
7046
|
+
For more information, see `Vehicles <https://docs.aws.amazon.com/iot-fleetwise/latest/developerguide/vehicles.html>`_ in the *AWS IoT FleetWise Developer Guide* .
|
|
6906
7047
|
|
|
6907
7048
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotfleetwise-vehicle.html
|
|
6908
7049
|
:cloudformationResource: AWS::IoTFleetWise::Vehicle
|
|
@@ -6949,9 +7090,9 @@ class CfnVehicle(
|
|
|
6949
7090
|
:param decoder_manifest_arn: The Amazon Resource Name (ARN) of a decoder manifest associated with the vehicle to create.
|
|
6950
7091
|
:param model_manifest_arn: The Amazon Resource Name (ARN) of the vehicle model (model manifest) to create the vehicle from.
|
|
6951
7092
|
:param name: The unique ID of the vehicle.
|
|
6952
|
-
:param association_behavior:
|
|
6953
|
-
:param attributes:
|
|
6954
|
-
:param tags:
|
|
7093
|
+
:param association_behavior: An option to create a new AWS IoT thing when creating a vehicle, or to validate an existing thing as a vehicle.
|
|
7094
|
+
:param attributes: Static information about a vehicle in a key-value pair. For example: ``"engine Type"`` : ``"v6"``
|
|
7095
|
+
:param tags: Metadata which can be used to manage the vehicle.
|
|
6955
7096
|
'''
|
|
6956
7097
|
if __debug__:
|
|
6957
7098
|
type_hints = typing.get_type_hints(_typecheckingstub__c7269c48709f71a558e1053c22bd1ef391024711944714eff09133981d39ff54)
|
|
@@ -7078,7 +7219,7 @@ class CfnVehicle(
|
|
|
7078
7219
|
@builtins.property
|
|
7079
7220
|
@jsii.member(jsii_name="associationBehavior")
|
|
7080
7221
|
def association_behavior(self) -> typing.Optional[builtins.str]:
|
|
7081
|
-
'''
|
|
7222
|
+
'''An option to create a new AWS IoT thing when creating a vehicle, or to validate an existing thing as a vehicle.'''
|
|
7082
7223
|
return typing.cast(typing.Optional[builtins.str], jsii.get(self, "associationBehavior"))
|
|
7083
7224
|
|
|
7084
7225
|
@association_behavior.setter
|
|
@@ -7093,7 +7234,7 @@ class CfnVehicle(
|
|
|
7093
7234
|
def attributes(
|
|
7094
7235
|
self,
|
|
7095
7236
|
) -> typing.Optional[typing.Union[_IResolvable_da3f097b, typing.Mapping[builtins.str, builtins.str]]]:
|
|
7096
|
-
'''
|
|
7237
|
+
'''Static information about a vehicle in a key-value pair.'''
|
|
7097
7238
|
return typing.cast(typing.Optional[typing.Union[_IResolvable_da3f097b, typing.Mapping[builtins.str, builtins.str]]], jsii.get(self, "attributes"))
|
|
7098
7239
|
|
|
7099
7240
|
@attributes.setter
|
|
@@ -7109,7 +7250,7 @@ class CfnVehicle(
|
|
|
7109
7250
|
@builtins.property
|
|
7110
7251
|
@jsii.member(jsii_name="tagsRaw")
|
|
7111
7252
|
def tags_raw(self) -> typing.Optional[typing.List[_CfnTag_f6864754]]:
|
|
7112
|
-
'''
|
|
7253
|
+
'''Metadata which can be used to manage the vehicle.'''
|
|
7113
7254
|
return typing.cast(typing.Optional[typing.List[_CfnTag_f6864754]], jsii.get(self, "tagsRaw"))
|
|
7114
7255
|
|
|
7115
7256
|
@tags_raw.setter
|
|
@@ -7148,9 +7289,9 @@ class CfnVehicleProps:
|
|
|
7148
7289
|
:param decoder_manifest_arn: The Amazon Resource Name (ARN) of a decoder manifest associated with the vehicle to create.
|
|
7149
7290
|
:param model_manifest_arn: The Amazon Resource Name (ARN) of the vehicle model (model manifest) to create the vehicle from.
|
|
7150
7291
|
:param name: The unique ID of the vehicle.
|
|
7151
|
-
:param association_behavior:
|
|
7152
|
-
:param attributes:
|
|
7153
|
-
:param tags:
|
|
7292
|
+
:param association_behavior: An option to create a new AWS IoT thing when creating a vehicle, or to validate an existing thing as a vehicle.
|
|
7293
|
+
:param attributes: Static information about a vehicle in a key-value pair. For example: ``"engine Type"`` : ``"v6"``
|
|
7294
|
+
:param tags: Metadata which can be used to manage the vehicle.
|
|
7154
7295
|
|
|
7155
7296
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotfleetwise-vehicle.html
|
|
7156
7297
|
:exampleMetadata: fixture=_generated
|
|
@@ -7229,7 +7370,7 @@ class CfnVehicleProps:
|
|
|
7229
7370
|
|
|
7230
7371
|
@builtins.property
|
|
7231
7372
|
def association_behavior(self) -> typing.Optional[builtins.str]:
|
|
7232
|
-
'''
|
|
7373
|
+
'''An option to create a new AWS IoT thing when creating a vehicle, or to validate an existing thing as a vehicle.
|
|
7233
7374
|
|
|
7234
7375
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotfleetwise-vehicle.html#cfn-iotfleetwise-vehicle-associationbehavior
|
|
7235
7376
|
'''
|
|
@@ -7240,7 +7381,7 @@ class CfnVehicleProps:
|
|
|
7240
7381
|
def attributes(
|
|
7241
7382
|
self,
|
|
7242
7383
|
) -> typing.Optional[typing.Union[_IResolvable_da3f097b, typing.Mapping[builtins.str, builtins.str]]]:
|
|
7243
|
-
'''
|
|
7384
|
+
'''Static information about a vehicle in a key-value pair.
|
|
7244
7385
|
|
|
7245
7386
|
For example: ``"engine Type"`` : ``"v6"``
|
|
7246
7387
|
|
|
@@ -7251,7 +7392,7 @@ class CfnVehicleProps:
|
|
|
7251
7392
|
|
|
7252
7393
|
@builtins.property
|
|
7253
7394
|
def tags(self) -> typing.Optional[typing.List[_CfnTag_f6864754]]:
|
|
7254
|
-
'''
|
|
7395
|
+
'''Metadata which can be used to manage the vehicle.
|
|
7255
7396
|
|
|
7256
7397
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotfleetwise-vehicle.html#cfn-iotfleetwise-vehicle-tags
|
|
7257
7398
|
'''
|