aws-cdk-lib 2.171.1__py3-none-any.whl → 2.173.0__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 +528 -161
- aws_cdk/_jsii/__init__.py +1 -1
- aws_cdk/_jsii/{aws-cdk-lib@2.171.1.jsii.tgz → aws-cdk-lib@2.173.0.jsii.tgz} +0 -0
- aws_cdk/aws_amazonmq/__init__.py +40 -40
- aws_cdk/aws_apigateway/__init__.py +1357 -120
- aws_cdk/aws_applicationautoscaling/__init__.py +141 -66
- aws_cdk/aws_appsync/__init__.py +163 -139
- aws_cdk/aws_autoscaling/__init__.py +96 -30
- aws_cdk/aws_bedrock/__init__.py +80 -44
- aws_cdk/aws_chatbot/__init__.py +803 -2
- aws_cdk/aws_cleanrooms/__init__.py +4 -6
- aws_cdk/aws_cloudformation/__init__.py +240 -159
- aws_cdk/aws_cloudfront/__init__.py +15 -7
- aws_cdk/aws_cloudtrail/__init__.py +802 -13
- 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 +1032 -43
- aws_cdk/aws_config/__init__.py +13 -10
- aws_cdk/aws_connect/__init__.py +454 -23
- aws_cdk/aws_connectcampaignsv2/__init__.py +187 -176
- aws_cdk/aws_customerprofiles/__init__.py +3148 -0
- aws_cdk/aws_docdb/__init__.py +128 -0
- aws_cdk/aws_dynamodb/__init__.py +256 -0
- aws_cdk/aws_ec2/__init__.py +976 -27
- aws_cdk/aws_ecs/__init__.py +37 -20
- aws_cdk/aws_eks/__init__.py +771 -0
- aws_cdk/aws_elasticache/__init__.py +22 -22
- aws_cdk/aws_elasticloadbalancingv2/__init__.py +441 -177
- aws_cdk/aws_events/__init__.py +550 -30
- 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 +70 -26
- aws_cdk/aws_iotfleetwise/__init__.py +1033 -382
- aws_cdk/aws_iotsitewise/__init__.py +158 -0
- 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 +272 -164
- aws_cdk/aws_lambda_event_sources/__init__.py +2 -1
- aws_cdk/aws_lambda_nodejs/__init__.py +11 -11
- aws_cdk/aws_logs/__init__.py +532 -0
- aws_cdk/aws_m2/__init__.py +289 -0
- 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_mwaa/__init__.py +6 -6
- aws_cdk/aws_opensearchserverless/__init__.py +249 -1
- aws_cdk/aws_pipes/__init__.py +14 -30
- aws_cdk/aws_qbusiness/__init__.py +2021 -67
- aws_cdk/aws_quicksight/__init__.py +8270 -10
- aws_cdk/aws_rbin/__init__.py +53 -34
- aws_cdk/aws_rds/__init__.py +170 -8
- aws_cdk/aws_resourcegroups/__init__.py +362 -4
- aws_cdk/aws_route53/__init__.py +1177 -10
- aws_cdk/aws_route53_targets/__init__.py +297 -91
- aws_cdk/aws_route53resolver/__init__.py +19 -8
- aws_cdk/aws_s3/__init__.py +4 -4
- aws_cdk/aws_s3express/__init__.py +421 -9
- aws_cdk/aws_sagemaker/__init__.py +905 -119
- 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 +188 -41
- 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 +8509 -1502
- aws_cdk/aws_workspacesweb/__init__.py +1081 -0
- {aws_cdk_lib-2.171.1.dist-info → aws_cdk_lib-2.173.0.dist-info}/METADATA +1 -1
- {aws_cdk_lib-2.171.1.dist-info → aws_cdk_lib-2.173.0.dist-info}/RECORD +78 -77
- {aws_cdk_lib-2.171.1.dist-info → aws_cdk_lib-2.173.0.dist-info}/LICENSE +0 -0
- {aws_cdk_lib-2.171.1.dist-info → aws_cdk_lib-2.173.0.dist-info}/NOTICE +0 -0
- {aws_cdk_lib-2.171.1.dist-info → aws_cdk_lib-2.173.0.dist-info}/WHEEL +0 -0
- {aws_cdk_lib-2.171.1.dist-info → aws_cdk_lib-2.173.0.dist-info}/top_level.txt +0 -0
|
@@ -64,6 +64,7 @@ from .. import (
|
|
|
64
64
|
IInspectable as _IInspectable_c2943556,
|
|
65
65
|
IResolvable as _IResolvable_da3f097b,
|
|
66
66
|
ITaggable as _ITaggable_36806126,
|
|
67
|
+
ITaggableV2 as _ITaggableV2_4e6798f8,
|
|
67
68
|
TagManager as _TagManager_0a598cb3,
|
|
68
69
|
TreeInspector as _TreeInspector_488e0dd5,
|
|
69
70
|
)
|
|
@@ -79,7 +80,10 @@ class CfnCampaign(
|
|
|
79
80
|
|
|
80
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.
|
|
81
82
|
|
|
82
|
-
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* .
|
|
83
87
|
|
|
84
88
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotfleetwise-campaign.html
|
|
85
89
|
:cloudformationResource: AWS::IoTFleetWise::Campaign
|
|
@@ -224,20 +228,20 @@ class CfnCampaign(
|
|
|
224
228
|
:param signal_catalog_arn: The Amazon Resource Name (ARN) of the signal catalog associated with the campaign.
|
|
225
229
|
:param target_arn: The Amazon Resource Name (ARN) of a vehicle or fleet to which the campaign is deployed.
|
|
226
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.
|
|
227
|
-
:param compression:
|
|
228
|
-
:param data_destination_configs:
|
|
229
|
-
:param data_extra_dimensions:
|
|
230
|
-
:param data_partitions:
|
|
231
|
-
:param description:
|
|
232
|
-
:param diagnostics_mode:
|
|
233
|
-
:param expiry_time:
|
|
234
|
-
:param post_trigger_collection_duration:
|
|
235
|
-
:param priority:
|
|
236
|
-
:param signals_to_collect:
|
|
237
|
-
:param signals_to_fetch:
|
|
238
|
-
:param spooling_mode:
|
|
239
|
-
:param start_time:
|
|
240
|
-
: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.
|
|
241
245
|
'''
|
|
242
246
|
if __debug__:
|
|
243
247
|
type_hints = typing.get_type_hints(_typecheckingstub__f7abc45d2046b48ec3bc5807ec2826a784930a5009b41b194dd6e4bed2413f8d)
|
|
@@ -422,7 +426,7 @@ class CfnCampaign(
|
|
|
422
426
|
@builtins.property
|
|
423
427
|
@jsii.member(jsii_name="compression")
|
|
424
428
|
def compression(self) -> typing.Optional[builtins.str]:
|
|
425
|
-
'''
|
|
429
|
+
'''Whether to compress signals before transmitting data to AWS IoT FleetWise .'''
|
|
426
430
|
return typing.cast(typing.Optional[builtins.str], jsii.get(self, "compression"))
|
|
427
431
|
|
|
428
432
|
@compression.setter
|
|
@@ -437,7 +441,7 @@ class CfnCampaign(
|
|
|
437
441
|
def data_destination_configs(
|
|
438
442
|
self,
|
|
439
443
|
) -> typing.Optional[typing.Union[_IResolvable_da3f097b, typing.List[typing.Union[_IResolvable_da3f097b, "CfnCampaign.DataDestinationConfigProperty"]]]]:
|
|
440
|
-
'''
|
|
444
|
+
'''The destination where the campaign sends data.'''
|
|
441
445
|
return typing.cast(typing.Optional[typing.Union[_IResolvable_da3f097b, typing.List[typing.Union[_IResolvable_da3f097b, "CfnCampaign.DataDestinationConfigProperty"]]]], jsii.get(self, "dataDestinationConfigs"))
|
|
442
446
|
|
|
443
447
|
@data_destination_configs.setter
|
|
@@ -453,7 +457,7 @@ class CfnCampaign(
|
|
|
453
457
|
@builtins.property
|
|
454
458
|
@jsii.member(jsii_name="dataExtraDimensions")
|
|
455
459
|
def data_extra_dimensions(self) -> typing.Optional[typing.List[builtins.str]]:
|
|
456
|
-
'''
|
|
460
|
+
'''A list of vehicle attributes to associate with a campaign.'''
|
|
457
461
|
return typing.cast(typing.Optional[typing.List[builtins.str]], jsii.get(self, "dataExtraDimensions"))
|
|
458
462
|
|
|
459
463
|
@data_extra_dimensions.setter
|
|
@@ -471,6 +475,7 @@ class CfnCampaign(
|
|
|
471
475
|
def data_partitions(
|
|
472
476
|
self,
|
|
473
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.'''
|
|
474
479
|
return typing.cast(typing.Optional[typing.Union[_IResolvable_da3f097b, typing.List[typing.Union[_IResolvable_da3f097b, "CfnCampaign.DataPartitionProperty"]]]], jsii.get(self, "dataPartitions"))
|
|
475
480
|
|
|
476
481
|
@data_partitions.setter
|
|
@@ -486,7 +491,7 @@ class CfnCampaign(
|
|
|
486
491
|
@builtins.property
|
|
487
492
|
@jsii.member(jsii_name="description")
|
|
488
493
|
def description(self) -> typing.Optional[builtins.str]:
|
|
489
|
-
'''
|
|
494
|
+
'''The description of the campaign.'''
|
|
490
495
|
return typing.cast(typing.Optional[builtins.str], jsii.get(self, "description"))
|
|
491
496
|
|
|
492
497
|
@description.setter
|
|
@@ -499,7 +504,7 @@ class CfnCampaign(
|
|
|
499
504
|
@builtins.property
|
|
500
505
|
@jsii.member(jsii_name="diagnosticsMode")
|
|
501
506
|
def diagnostics_mode(self) -> typing.Optional[builtins.str]:
|
|
502
|
-
'''
|
|
507
|
+
'''Option for a vehicle to send diagnostic trouble codes to AWS IoT FleetWise .'''
|
|
503
508
|
return typing.cast(typing.Optional[builtins.str], jsii.get(self, "diagnosticsMode"))
|
|
504
509
|
|
|
505
510
|
@diagnostics_mode.setter
|
|
@@ -512,7 +517,7 @@ class CfnCampaign(
|
|
|
512
517
|
@builtins.property
|
|
513
518
|
@jsii.member(jsii_name="expiryTime")
|
|
514
519
|
def expiry_time(self) -> typing.Optional[builtins.str]:
|
|
515
|
-
'''
|
|
520
|
+
'''The time the campaign expires, in seconds since epoch (January 1, 1970 at midnight UTC time).'''
|
|
516
521
|
return typing.cast(typing.Optional[builtins.str], jsii.get(self, "expiryTime"))
|
|
517
522
|
|
|
518
523
|
@expiry_time.setter
|
|
@@ -525,7 +530,7 @@ class CfnCampaign(
|
|
|
525
530
|
@builtins.property
|
|
526
531
|
@jsii.member(jsii_name="postTriggerCollectionDuration")
|
|
527
532
|
def post_trigger_collection_duration(self) -> typing.Optional[jsii.Number]:
|
|
528
|
-
'''
|
|
533
|
+
'''How long (in milliseconds) to collect raw data after a triggering event initiates the collection.'''
|
|
529
534
|
return typing.cast(typing.Optional[jsii.Number], jsii.get(self, "postTriggerCollectionDuration"))
|
|
530
535
|
|
|
531
536
|
@post_trigger_collection_duration.setter
|
|
@@ -541,7 +546,7 @@ class CfnCampaign(
|
|
|
541
546
|
@builtins.property
|
|
542
547
|
@jsii.member(jsii_name="priority")
|
|
543
548
|
def priority(self) -> typing.Optional[jsii.Number]:
|
|
544
|
-
'''
|
|
549
|
+
'''A number indicating the priority of one campaign over another campaign for a certain vehicle or fleet.'''
|
|
545
550
|
return typing.cast(typing.Optional[jsii.Number], jsii.get(self, "priority"))
|
|
546
551
|
|
|
547
552
|
@priority.setter
|
|
@@ -556,7 +561,7 @@ class CfnCampaign(
|
|
|
556
561
|
def signals_to_collect(
|
|
557
562
|
self,
|
|
558
563
|
) -> typing.Optional[typing.Union[_IResolvable_da3f097b, typing.List[typing.Union[_IResolvable_da3f097b, "CfnCampaign.SignalInformationProperty"]]]]:
|
|
559
|
-
'''
|
|
564
|
+
'''A list of information about signals to collect.'''
|
|
560
565
|
return typing.cast(typing.Optional[typing.Union[_IResolvable_da3f097b, typing.List[typing.Union[_IResolvable_da3f097b, "CfnCampaign.SignalInformationProperty"]]]], jsii.get(self, "signalsToCollect"))
|
|
561
566
|
|
|
562
567
|
@signals_to_collect.setter
|
|
@@ -574,6 +579,7 @@ class CfnCampaign(
|
|
|
574
579
|
def signals_to_fetch(
|
|
575
580
|
self,
|
|
576
581
|
) -> typing.Optional[typing.Union[_IResolvable_da3f097b, typing.List[typing.Union[_IResolvable_da3f097b, "CfnCampaign.SignalFetchInformationProperty"]]]]:
|
|
582
|
+
'''A list of information about signals to fetch.'''
|
|
577
583
|
return typing.cast(typing.Optional[typing.Union[_IResolvable_da3f097b, typing.List[typing.Union[_IResolvable_da3f097b, "CfnCampaign.SignalFetchInformationProperty"]]]], jsii.get(self, "signalsToFetch"))
|
|
578
584
|
|
|
579
585
|
@signals_to_fetch.setter
|
|
@@ -589,7 +595,7 @@ class CfnCampaign(
|
|
|
589
595
|
@builtins.property
|
|
590
596
|
@jsii.member(jsii_name="spoolingMode")
|
|
591
597
|
def spooling_mode(self) -> typing.Optional[builtins.str]:
|
|
592
|
-
'''
|
|
598
|
+
'''Whether to store collected data after a vehicle lost a connection with the cloud.'''
|
|
593
599
|
return typing.cast(typing.Optional[builtins.str], jsii.get(self, "spoolingMode"))
|
|
594
600
|
|
|
595
601
|
@spooling_mode.setter
|
|
@@ -602,7 +608,10 @@ class CfnCampaign(
|
|
|
602
608
|
@builtins.property
|
|
603
609
|
@jsii.member(jsii_name="startTime")
|
|
604
610
|
def start_time(self) -> typing.Optional[builtins.str]:
|
|
605
|
-
'''
|
|
611
|
+
'''The time, in milliseconds, to deliver a campaign after it was approved.
|
|
612
|
+
|
|
613
|
+
If it's not specified, ``0`` is used.
|
|
614
|
+
'''
|
|
606
615
|
return typing.cast(typing.Optional[builtins.str], jsii.get(self, "startTime"))
|
|
607
616
|
|
|
608
617
|
@start_time.setter
|
|
@@ -615,7 +624,7 @@ class CfnCampaign(
|
|
|
615
624
|
@builtins.property
|
|
616
625
|
@jsii.member(jsii_name="tagsRaw")
|
|
617
626
|
def tags_raw(self) -> typing.Optional[typing.List[_CfnTag_f6864754]]:
|
|
618
|
-
'''
|
|
627
|
+
'''Metadata that can be used to manage the campaign.'''
|
|
619
628
|
return typing.cast(typing.Optional[typing.List[_CfnTag_f6864754]], jsii.get(self, "tagsRaw"))
|
|
620
629
|
|
|
621
630
|
@tags_raw.setter
|
|
@@ -642,8 +651,8 @@ class CfnCampaign(
|
|
|
642
651
|
) -> None:
|
|
643
652
|
'''Specifies what data to collect and how often or when to collect it.
|
|
644
653
|
|
|
645
|
-
:param condition_based_collection_scheme:
|
|
646
|
-
: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.
|
|
647
656
|
|
|
648
657
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotfleetwise-campaign-collectionscheme.html
|
|
649
658
|
:exampleMetadata: fixture=_generated
|
|
@@ -682,7 +691,7 @@ class CfnCampaign(
|
|
|
682
691
|
def condition_based_collection_scheme(
|
|
683
692
|
self,
|
|
684
693
|
) -> typing.Optional[typing.Union[_IResolvable_da3f097b, "CfnCampaign.ConditionBasedCollectionSchemeProperty"]]:
|
|
685
|
-
'''
|
|
694
|
+
'''Information about a collection scheme that uses a simple logical expression to recognize what data to collect.
|
|
686
695
|
|
|
687
696
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotfleetwise-campaign-collectionscheme.html#cfn-iotfleetwise-campaign-collectionscheme-conditionbasedcollectionscheme
|
|
688
697
|
'''
|
|
@@ -693,7 +702,7 @@ class CfnCampaign(
|
|
|
693
702
|
def time_based_collection_scheme(
|
|
694
703
|
self,
|
|
695
704
|
) -> typing.Optional[typing.Union[_IResolvable_da3f097b, "CfnCampaign.TimeBasedCollectionSchemeProperty"]]:
|
|
696
|
-
'''
|
|
705
|
+
'''Information about a collection scheme that uses a time period to decide how often to collect data.
|
|
697
706
|
|
|
698
707
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotfleetwise-campaign-collectionscheme.html#cfn-iotfleetwise-campaign-collectionscheme-timebasedcollectionscheme
|
|
699
708
|
'''
|
|
@@ -733,9 +742,9 @@ class CfnCampaign(
|
|
|
733
742
|
'''Information about a collection scheme that uses a simple logical expression to recognize what data to collect.
|
|
734
743
|
|
|
735
744
|
:param expression: The logical expression used to recognize what data to collect. For example, ``$variable.Vehicle.OutsideAirTemperature >= 105.0`` .
|
|
736
|
-
:param condition_language_version:
|
|
737
|
-
:param minimum_trigger_interval_ms:
|
|
738
|
-
: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.
|
|
739
748
|
|
|
740
749
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotfleetwise-campaign-conditionbasedcollectionscheme.html
|
|
741
750
|
:exampleMetadata: fixture=_generated
|
|
@@ -785,7 +794,7 @@ class CfnCampaign(
|
|
|
785
794
|
|
|
786
795
|
@builtins.property
|
|
787
796
|
def condition_language_version(self) -> typing.Optional[jsii.Number]:
|
|
788
|
-
'''
|
|
797
|
+
'''Specifies the version of the conditional expression language.
|
|
789
798
|
|
|
790
799
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotfleetwise-campaign-conditionbasedcollectionscheme.html#cfn-iotfleetwise-campaign-conditionbasedcollectionscheme-conditionlanguageversion
|
|
791
800
|
'''
|
|
@@ -794,7 +803,7 @@ class CfnCampaign(
|
|
|
794
803
|
|
|
795
804
|
@builtins.property
|
|
796
805
|
def minimum_trigger_interval_ms(self) -> typing.Optional[jsii.Number]:
|
|
797
|
-
'''
|
|
806
|
+
'''The minimum duration of time between two triggering events to collect data, in milliseconds.
|
|
798
807
|
|
|
799
808
|
.. epigraph::
|
|
800
809
|
|
|
@@ -807,7 +816,7 @@ class CfnCampaign(
|
|
|
807
816
|
|
|
808
817
|
@builtins.property
|
|
809
818
|
def trigger_mode(self) -> typing.Optional[builtins.str]:
|
|
810
|
-
'''
|
|
819
|
+
'''Whether to collect data for all triggering events ( ``ALWAYS`` ).
|
|
811
820
|
|
|
812
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.
|
|
813
822
|
|
|
@@ -842,9 +851,10 @@ class CfnCampaign(
|
|
|
842
851
|
condition_expression: builtins.str,
|
|
843
852
|
trigger_mode: builtins.str,
|
|
844
853
|
) -> None:
|
|
845
|
-
'''
|
|
846
|
-
|
|
847
|
-
: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.
|
|
848
858
|
|
|
849
859
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotfleetwise-campaign-conditionbasedsignalfetchconfig.html
|
|
850
860
|
:exampleMetadata: fixture=_generated
|
|
@@ -871,7 +881,8 @@ class CfnCampaign(
|
|
|
871
881
|
|
|
872
882
|
@builtins.property
|
|
873
883
|
def condition_expression(self) -> builtins.str:
|
|
874
|
-
'''
|
|
884
|
+
'''The condition that must be satisfied to trigger a signal fetch.
|
|
885
|
+
|
|
875
886
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotfleetwise-campaign-conditionbasedsignalfetchconfig.html#cfn-iotfleetwise-campaign-conditionbasedsignalfetchconfig-conditionexpression
|
|
876
887
|
'''
|
|
877
888
|
result = self._values.get("condition_expression")
|
|
@@ -880,7 +891,8 @@ class CfnCampaign(
|
|
|
880
891
|
|
|
881
892
|
@builtins.property
|
|
882
893
|
def trigger_mode(self) -> builtins.str:
|
|
883
|
-
'''
|
|
894
|
+
'''Indicates the mode in which the signal fetch is triggered.
|
|
895
|
+
|
|
884
896
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotfleetwise-campaign-conditionbasedsignalfetchconfig.html#cfn-iotfleetwise-campaign-conditionbasedsignalfetchconfig-triggermode
|
|
885
897
|
'''
|
|
886
898
|
result = self._values.get("trigger_mode")
|
|
@@ -919,9 +931,9 @@ class CfnCampaign(
|
|
|
919
931
|
|
|
920
932
|
You can send data to be stored in Amazon S3 or Amazon Timestream .
|
|
921
933
|
|
|
922
|
-
:param mqtt_topic_config:
|
|
923
|
-
:param s3_config:
|
|
924
|
-
: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.
|
|
925
937
|
|
|
926
938
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotfleetwise-campaign-datadestinationconfig.html
|
|
927
939
|
:exampleMetadata: fixture=_generated
|
|
@@ -968,7 +980,12 @@ class CfnCampaign(
|
|
|
968
980
|
def mqtt_topic_config(
|
|
969
981
|
self,
|
|
970
982
|
) -> typing.Optional[typing.Union[_IResolvable_da3f097b, "CfnCampaign.MqttTopicConfigProperty"]]:
|
|
971
|
-
'''
|
|
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
|
+
|
|
972
989
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotfleetwise-campaign-datadestinationconfig.html#cfn-iotfleetwise-campaign-datadestinationconfig-mqtttopicconfig
|
|
973
990
|
'''
|
|
974
991
|
result = self._values.get("mqtt_topic_config")
|
|
@@ -978,7 +995,7 @@ class CfnCampaign(
|
|
|
978
995
|
def s3_config(
|
|
979
996
|
self,
|
|
980
997
|
) -> typing.Optional[typing.Union[_IResolvable_da3f097b, "CfnCampaign.S3ConfigProperty"]]:
|
|
981
|
-
'''
|
|
998
|
+
'''The Amazon S3 bucket where the AWS IoT FleetWise campaign sends data.
|
|
982
999
|
|
|
983
1000
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotfleetwise-campaign-datadestinationconfig.html#cfn-iotfleetwise-campaign-datadestinationconfig-s3config
|
|
984
1001
|
'''
|
|
@@ -989,7 +1006,7 @@ class CfnCampaign(
|
|
|
989
1006
|
def timestream_config(
|
|
990
1007
|
self,
|
|
991
1008
|
) -> typing.Optional[typing.Union[_IResolvable_da3f097b, "CfnCampaign.TimestreamConfigProperty"]]:
|
|
992
|
-
'''
|
|
1009
|
+
'''The Amazon Timestream table where the campaign sends data.
|
|
993
1010
|
|
|
994
1011
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotfleetwise-campaign-datadestinationconfig.html#cfn-iotfleetwise-campaign-datadestinationconfig-timestreamconfig
|
|
995
1012
|
'''
|
|
@@ -1024,10 +1041,16 @@ class CfnCampaign(
|
|
|
1024
1041
|
storage_options: typing.Union[_IResolvable_da3f097b, typing.Union["CfnCampaign.DataPartitionStorageOptionsProperty", typing.Dict[builtins.str, typing.Any]]],
|
|
1025
1042
|
upload_options: typing.Optional[typing.Union[_IResolvable_da3f097b, typing.Union["CfnCampaign.DataPartitionUploadOptionsProperty", typing.Dict[builtins.str, typing.Any]]]] = None,
|
|
1026
1043
|
) -> None:
|
|
1027
|
-
'''
|
|
1028
|
-
|
|
1029
|
-
|
|
1030
|
-
|
|
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.
|
|
1031
1054
|
|
|
1032
1055
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotfleetwise-campaign-datapartition.html
|
|
1033
1056
|
:exampleMetadata: fixture=_generated
|
|
@@ -1075,7 +1098,10 @@ class CfnCampaign(
|
|
|
1075
1098
|
|
|
1076
1099
|
@builtins.property
|
|
1077
1100
|
def id(self) -> builtins.str:
|
|
1078
|
-
'''
|
|
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
|
+
|
|
1079
1105
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotfleetwise-campaign-datapartition.html#cfn-iotfleetwise-campaign-datapartition-id
|
|
1080
1106
|
'''
|
|
1081
1107
|
result = self._values.get("id")
|
|
@@ -1086,7 +1112,8 @@ class CfnCampaign(
|
|
|
1086
1112
|
def storage_options(
|
|
1087
1113
|
self,
|
|
1088
1114
|
) -> typing.Union[_IResolvable_da3f097b, "CfnCampaign.DataPartitionStorageOptionsProperty"]:
|
|
1089
|
-
'''
|
|
1115
|
+
'''The storage options for a data partition.
|
|
1116
|
+
|
|
1090
1117
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotfleetwise-campaign-datapartition.html#cfn-iotfleetwise-campaign-datapartition-storageoptions
|
|
1091
1118
|
'''
|
|
1092
1119
|
result = self._values.get("storage_options")
|
|
@@ -1097,7 +1124,8 @@ class CfnCampaign(
|
|
|
1097
1124
|
def upload_options(
|
|
1098
1125
|
self,
|
|
1099
1126
|
) -> typing.Optional[typing.Union[_IResolvable_da3f097b, "CfnCampaign.DataPartitionUploadOptionsProperty"]]:
|
|
1100
|
-
'''
|
|
1127
|
+
'''The upload options for the data partition.
|
|
1128
|
+
|
|
1101
1129
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotfleetwise-campaign-datapartition.html#cfn-iotfleetwise-campaign-datapartition-uploadoptions
|
|
1102
1130
|
'''
|
|
1103
1131
|
result = self._values.get("upload_options")
|
|
@@ -1131,10 +1159,11 @@ class CfnCampaign(
|
|
|
1131
1159
|
minimum_time_to_live: typing.Union[_IResolvable_da3f097b, typing.Union["CfnCampaign.StorageMinimumTimeToLiveProperty", typing.Dict[builtins.str, typing.Any]]],
|
|
1132
1160
|
storage_location: builtins.str,
|
|
1133
1161
|
) -> None:
|
|
1134
|
-
'''
|
|
1135
|
-
|
|
1136
|
-
:param
|
|
1137
|
-
: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.
|
|
1138
1167
|
|
|
1139
1168
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotfleetwise-campaign-datapartitionstorageoptions.html
|
|
1140
1169
|
:exampleMetadata: fixture=_generated
|
|
@@ -1172,7 +1201,12 @@ class CfnCampaign(
|
|
|
1172
1201
|
def maximum_size(
|
|
1173
1202
|
self,
|
|
1174
1203
|
) -> typing.Union[_IResolvable_da3f097b, "CfnCampaign.StorageMaximumSizeProperty"]:
|
|
1175
|
-
'''
|
|
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
|
+
|
|
1176
1210
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotfleetwise-campaign-datapartitionstorageoptions.html#cfn-iotfleetwise-campaign-datapartitionstorageoptions-maximumsize
|
|
1177
1211
|
'''
|
|
1178
1212
|
result = self._values.get("maximum_size")
|
|
@@ -1183,7 +1217,12 @@ class CfnCampaign(
|
|
|
1183
1217
|
def minimum_time_to_live(
|
|
1184
1218
|
self,
|
|
1185
1219
|
) -> typing.Union[_IResolvable_da3f097b, "CfnCampaign.StorageMinimumTimeToLiveProperty"]:
|
|
1186
|
-
'''
|
|
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
|
+
|
|
1187
1226
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotfleetwise-campaign-datapartitionstorageoptions.html#cfn-iotfleetwise-campaign-datapartitionstorageoptions-minimumtimetolive
|
|
1188
1227
|
'''
|
|
1189
1228
|
result = self._values.get("minimum_time_to_live")
|
|
@@ -1192,7 +1231,8 @@ class CfnCampaign(
|
|
|
1192
1231
|
|
|
1193
1232
|
@builtins.property
|
|
1194
1233
|
def storage_location(self) -> builtins.str:
|
|
1195
|
-
'''
|
|
1234
|
+
'''The folder name for the data partition under the campaign storage folder.
|
|
1235
|
+
|
|
1196
1236
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotfleetwise-campaign-datapartitionstorageoptions.html#cfn-iotfleetwise-campaign-datapartitionstorageoptions-storagelocation
|
|
1197
1237
|
'''
|
|
1198
1238
|
result = self._values.get("storage_location")
|
|
@@ -1225,9 +1265,15 @@ class CfnCampaign(
|
|
|
1225
1265
|
expression: builtins.str,
|
|
1226
1266
|
condition_language_version: typing.Optional[jsii.Number] = None,
|
|
1227
1267
|
) -> None:
|
|
1228
|
-
'''
|
|
1229
|
-
|
|
1230
|
-
|
|
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.
|
|
1231
1277
|
|
|
1232
1278
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotfleetwise-campaign-datapartitionuploadoptions.html
|
|
1233
1279
|
:exampleMetadata: fixture=_generated
|
|
@@ -1257,7 +1303,10 @@ class CfnCampaign(
|
|
|
1257
1303
|
|
|
1258
1304
|
@builtins.property
|
|
1259
1305
|
def expression(self) -> builtins.str:
|
|
1260
|
-
'''
|
|
1306
|
+
'''The logical expression used to recognize what data to collect.
|
|
1307
|
+
|
|
1308
|
+
For example, ``$variable.``Vehicle.OutsideAirTemperature`` >= 105.0`` .
|
|
1309
|
+
|
|
1261
1310
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotfleetwise-campaign-datapartitionuploadoptions.html#cfn-iotfleetwise-campaign-datapartitionuploadoptions-expression
|
|
1262
1311
|
'''
|
|
1263
1312
|
result = self._values.get("expression")
|
|
@@ -1266,7 +1315,10 @@ class CfnCampaign(
|
|
|
1266
1315
|
|
|
1267
1316
|
@builtins.property
|
|
1268
1317
|
def condition_language_version(self) -> typing.Optional[jsii.Number]:
|
|
1269
|
-
'''
|
|
1318
|
+
'''The version of the condition language.
|
|
1319
|
+
|
|
1320
|
+
Defaults to the most recent condition language version.
|
|
1321
|
+
|
|
1270
1322
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotfleetwise-campaign-datapartitionuploadoptions.html#cfn-iotfleetwise-campaign-datapartitionuploadoptions-conditionlanguageversion
|
|
1271
1323
|
'''
|
|
1272
1324
|
result = self._values.get("condition_language_version")
|
|
@@ -1298,9 +1350,15 @@ class CfnCampaign(
|
|
|
1298
1350
|
execution_role_arn: builtins.str,
|
|
1299
1351
|
mqtt_topic_arn: builtins.str,
|
|
1300
1352
|
) -> None:
|
|
1301
|
-
'''
|
|
1302
|
-
|
|
1303
|
-
|
|
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.
|
|
1304
1362
|
|
|
1305
1363
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotfleetwise-campaign-mqtttopicconfig.html
|
|
1306
1364
|
:exampleMetadata: fixture=_generated
|
|
@@ -1327,7 +1385,8 @@ class CfnCampaign(
|
|
|
1327
1385
|
|
|
1328
1386
|
@builtins.property
|
|
1329
1387
|
def execution_role_arn(self) -> builtins.str:
|
|
1330
|
-
'''
|
|
1388
|
+
'''The ARN of the role that grants AWS IoT FleetWise permission to access and act on messages sent to the MQTT topic.
|
|
1389
|
+
|
|
1331
1390
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotfleetwise-campaign-mqtttopicconfig.html#cfn-iotfleetwise-campaign-mqtttopicconfig-executionrolearn
|
|
1332
1391
|
'''
|
|
1333
1392
|
result = self._values.get("execution_role_arn")
|
|
@@ -1336,7 +1395,8 @@ class CfnCampaign(
|
|
|
1336
1395
|
|
|
1337
1396
|
@builtins.property
|
|
1338
1397
|
def mqtt_topic_arn(self) -> builtins.str:
|
|
1339
|
-
'''
|
|
1398
|
+
'''The ARN of the MQTT topic.
|
|
1399
|
+
|
|
1340
1400
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotfleetwise-campaign-mqtttopicconfig.html#cfn-iotfleetwise-campaign-mqtttopicconfig-mqtttopicarn
|
|
1341
1401
|
'''
|
|
1342
1402
|
result = self._values.get("mqtt_topic_arn")
|
|
@@ -1378,9 +1438,9 @@ class CfnCampaign(
|
|
|
1378
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* .
|
|
1379
1439
|
|
|
1380
1440
|
:param bucket_arn: The Amazon Resource Name (ARN) of the Amazon S3 bucket.
|
|
1381
|
-
:param data_format:
|
|
1382
|
-
:param prefix:
|
|
1383
|
-
: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.
|
|
1384
1444
|
|
|
1385
1445
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotfleetwise-campaign-s3config.html
|
|
1386
1446
|
:exampleMetadata: fixture=_generated
|
|
@@ -1428,7 +1488,7 @@ class CfnCampaign(
|
|
|
1428
1488
|
|
|
1429
1489
|
@builtins.property
|
|
1430
1490
|
def data_format(self) -> typing.Optional[builtins.str]:
|
|
1431
|
-
'''
|
|
1491
|
+
'''Specify the format that files are saved in the Amazon S3 bucket.
|
|
1432
1492
|
|
|
1433
1493
|
You can save files in an Apache Parquet or JSON format.
|
|
1434
1494
|
|
|
@@ -1442,7 +1502,7 @@ class CfnCampaign(
|
|
|
1442
1502
|
|
|
1443
1503
|
@builtins.property
|
|
1444
1504
|
def prefix(self) -> typing.Optional[builtins.str]:
|
|
1445
|
-
'''
|
|
1505
|
+
'''Enter an S3 bucket prefix.
|
|
1446
1506
|
|
|
1447
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* .
|
|
1448
1508
|
|
|
@@ -1455,7 +1515,7 @@ class CfnCampaign(
|
|
|
1455
1515
|
|
|
1456
1516
|
@builtins.property
|
|
1457
1517
|
def storage_compression_format(self) -> typing.Optional[builtins.str]:
|
|
1458
|
-
'''
|
|
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.
|
|
1459
1519
|
|
|
1460
1520
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotfleetwise-campaign-s3config.html#cfn-iotfleetwise-campaign-s3config-storagecompressionformat
|
|
1461
1521
|
'''
|
|
@@ -1485,9 +1545,14 @@ class CfnCampaign(
|
|
|
1485
1545
|
condition_based: typing.Optional[typing.Union[_IResolvable_da3f097b, typing.Union["CfnCampaign.ConditionBasedSignalFetchConfigProperty", typing.Dict[builtins.str, typing.Any]]]] = None,
|
|
1486
1546
|
time_based: typing.Optional[typing.Union[_IResolvable_da3f097b, typing.Union["CfnCampaign.TimeBasedSignalFetchConfigProperty", typing.Dict[builtins.str, typing.Any]]]] = None,
|
|
1487
1547
|
) -> None:
|
|
1488
|
-
'''
|
|
1489
|
-
|
|
1490
|
-
|
|
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.
|
|
1491
1556
|
|
|
1492
1557
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotfleetwise-campaign-signalfetchconfig.html
|
|
1493
1558
|
:exampleMetadata: fixture=_generated
|
|
@@ -1522,7 +1587,8 @@ class CfnCampaign(
|
|
|
1522
1587
|
def condition_based(
|
|
1523
1588
|
self,
|
|
1524
1589
|
) -> typing.Optional[typing.Union[_IResolvable_da3f097b, "CfnCampaign.ConditionBasedSignalFetchConfigProperty"]]:
|
|
1525
|
-
'''
|
|
1590
|
+
'''The configuration of a condition-based signal fetch operation.
|
|
1591
|
+
|
|
1526
1592
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotfleetwise-campaign-signalfetchconfig.html#cfn-iotfleetwise-campaign-signalfetchconfig-conditionbased
|
|
1527
1593
|
'''
|
|
1528
1594
|
result = self._values.get("condition_based")
|
|
@@ -1532,7 +1598,8 @@ class CfnCampaign(
|
|
|
1532
1598
|
def time_based(
|
|
1533
1599
|
self,
|
|
1534
1600
|
) -> typing.Optional[typing.Union[_IResolvable_da3f097b, "CfnCampaign.TimeBasedSignalFetchConfigProperty"]]:
|
|
1535
|
-
'''
|
|
1601
|
+
'''The configuration of a time-based signal fetch operation.
|
|
1602
|
+
|
|
1536
1603
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotfleetwise-campaign-signalfetchconfig.html#cfn-iotfleetwise-campaign-signalfetchconfig-timebased
|
|
1537
1604
|
'''
|
|
1538
1605
|
result = self._values.get("time_based")
|
|
@@ -1568,11 +1635,16 @@ class CfnCampaign(
|
|
|
1568
1635
|
signal_fetch_config: typing.Union[_IResolvable_da3f097b, typing.Union["CfnCampaign.SignalFetchConfigProperty", typing.Dict[builtins.str, typing.Any]]],
|
|
1569
1636
|
condition_language_version: typing.Optional[jsii.Number] = None,
|
|
1570
1637
|
) -> None:
|
|
1571
|
-
'''
|
|
1572
|
-
|
|
1573
|
-
|
|
1574
|
-
|
|
1575
|
-
|
|
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.
|
|
1576
1648
|
|
|
1577
1649
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotfleetwise-campaign-signalfetchinformation.html
|
|
1578
1650
|
:exampleMetadata: fixture=_generated
|
|
@@ -1616,7 +1688,8 @@ class CfnCampaign(
|
|
|
1616
1688
|
|
|
1617
1689
|
@builtins.property
|
|
1618
1690
|
def actions(self) -> typing.List[builtins.str]:
|
|
1619
|
-
'''
|
|
1691
|
+
'''The actions to be performed by the signal fetch.
|
|
1692
|
+
|
|
1620
1693
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotfleetwise-campaign-signalfetchinformation.html#cfn-iotfleetwise-campaign-signalfetchinformation-actions
|
|
1621
1694
|
'''
|
|
1622
1695
|
result = self._values.get("actions")
|
|
@@ -1625,7 +1698,8 @@ class CfnCampaign(
|
|
|
1625
1698
|
|
|
1626
1699
|
@builtins.property
|
|
1627
1700
|
def fully_qualified_name(self) -> builtins.str:
|
|
1628
|
-
'''
|
|
1701
|
+
'''The fully qualified name of the signal to be fetched.
|
|
1702
|
+
|
|
1629
1703
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotfleetwise-campaign-signalfetchinformation.html#cfn-iotfleetwise-campaign-signalfetchinformation-fullyqualifiedname
|
|
1630
1704
|
'''
|
|
1631
1705
|
result = self._values.get("fully_qualified_name")
|
|
@@ -1636,7 +1710,8 @@ class CfnCampaign(
|
|
|
1636
1710
|
def signal_fetch_config(
|
|
1637
1711
|
self,
|
|
1638
1712
|
) -> typing.Union[_IResolvable_da3f097b, "CfnCampaign.SignalFetchConfigProperty"]:
|
|
1639
|
-
'''
|
|
1713
|
+
'''The configuration of the signal fetch operation.
|
|
1714
|
+
|
|
1640
1715
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotfleetwise-campaign-signalfetchinformation.html#cfn-iotfleetwise-campaign-signalfetchinformation-signalfetchconfig
|
|
1641
1716
|
'''
|
|
1642
1717
|
result = self._values.get("signal_fetch_config")
|
|
@@ -1645,7 +1720,8 @@ class CfnCampaign(
|
|
|
1645
1720
|
|
|
1646
1721
|
@builtins.property
|
|
1647
1722
|
def condition_language_version(self) -> typing.Optional[jsii.Number]:
|
|
1648
|
-
'''
|
|
1723
|
+
'''The version of the condition language used.
|
|
1724
|
+
|
|
1649
1725
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotfleetwise-campaign-signalfetchinformation.html#cfn-iotfleetwise-campaign-signalfetchinformation-conditionlanguageversion
|
|
1650
1726
|
'''
|
|
1651
1727
|
result = self._values.get("condition_language_version")
|
|
@@ -1684,9 +1760,9 @@ class CfnCampaign(
|
|
|
1684
1760
|
'''Information about a signal.
|
|
1685
1761
|
|
|
1686
1762
|
:param name: The name of the signal.
|
|
1687
|
-
:param data_partition_id:
|
|
1688
|
-
:param max_sample_count:
|
|
1689
|
-
: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.
|
|
1690
1766
|
|
|
1691
1767
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotfleetwise-campaign-signalinformation.html
|
|
1692
1768
|
:exampleMetadata: fixture=_generated
|
|
@@ -1734,7 +1810,13 @@ class CfnCampaign(
|
|
|
1734
1810
|
|
|
1735
1811
|
@builtins.property
|
|
1736
1812
|
def data_partition_id(self) -> typing.Optional[builtins.str]:
|
|
1737
|
-
'''
|
|
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
|
+
|
|
1738
1820
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotfleetwise-campaign-signalinformation.html#cfn-iotfleetwise-campaign-signalinformation-datapartitionid
|
|
1739
1821
|
'''
|
|
1740
1822
|
result = self._values.get("data_partition_id")
|
|
@@ -1742,7 +1824,7 @@ class CfnCampaign(
|
|
|
1742
1824
|
|
|
1743
1825
|
@builtins.property
|
|
1744
1826
|
def max_sample_count(self) -> typing.Optional[jsii.Number]:
|
|
1745
|
-
'''
|
|
1827
|
+
'''The maximum number of samples to collect.
|
|
1746
1828
|
|
|
1747
1829
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotfleetwise-campaign-signalinformation.html#cfn-iotfleetwise-campaign-signalinformation-maxsamplecount
|
|
1748
1830
|
'''
|
|
@@ -1751,7 +1833,7 @@ class CfnCampaign(
|
|
|
1751
1833
|
|
|
1752
1834
|
@builtins.property
|
|
1753
1835
|
def minimum_sampling_interval_ms(self) -> typing.Optional[jsii.Number]:
|
|
1754
|
-
'''
|
|
1836
|
+
'''The minimum duration of time (in milliseconds) between two triggering events to collect data.
|
|
1755
1837
|
|
|
1756
1838
|
.. epigraph::
|
|
1757
1839
|
|
|
@@ -1780,9 +1862,14 @@ class CfnCampaign(
|
|
|
1780
1862
|
)
|
|
1781
1863
|
class StorageMaximumSizeProperty:
|
|
1782
1864
|
def __init__(self, *, unit: builtins.str, value: jsii.Number) -> None:
|
|
1783
|
-
'''
|
|
1784
|
-
|
|
1785
|
-
|
|
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.
|
|
1786
1873
|
|
|
1787
1874
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotfleetwise-campaign-storagemaximumsize.html
|
|
1788
1875
|
:exampleMetadata: fixture=_generated
|
|
@@ -1809,7 +1896,8 @@ class CfnCampaign(
|
|
|
1809
1896
|
|
|
1810
1897
|
@builtins.property
|
|
1811
1898
|
def unit(self) -> builtins.str:
|
|
1812
|
-
'''
|
|
1899
|
+
'''The data type of the data to store.
|
|
1900
|
+
|
|
1813
1901
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotfleetwise-campaign-storagemaximumsize.html#cfn-iotfleetwise-campaign-storagemaximumsize-unit
|
|
1814
1902
|
'''
|
|
1815
1903
|
result = self._values.get("unit")
|
|
@@ -1818,7 +1906,8 @@ class CfnCampaign(
|
|
|
1818
1906
|
|
|
1819
1907
|
@builtins.property
|
|
1820
1908
|
def value(self) -> jsii.Number:
|
|
1821
|
-
'''
|
|
1909
|
+
'''The maximum amount of time to store data.
|
|
1910
|
+
|
|
1822
1911
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotfleetwise-campaign-storagemaximumsize.html#cfn-iotfleetwise-campaign-storagemaximumsize-value
|
|
1823
1912
|
'''
|
|
1824
1913
|
result = self._values.get("value")
|
|
@@ -1843,9 +1932,14 @@ class CfnCampaign(
|
|
|
1843
1932
|
)
|
|
1844
1933
|
class StorageMinimumTimeToLiveProperty:
|
|
1845
1934
|
def __init__(self, *, unit: builtins.str, value: jsii.Number) -> None:
|
|
1846
|
-
'''
|
|
1847
|
-
|
|
1848
|
-
|
|
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.
|
|
1849
1943
|
|
|
1850
1944
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotfleetwise-campaign-storageminimumtimetolive.html
|
|
1851
1945
|
:exampleMetadata: fixture=_generated
|
|
@@ -1872,7 +1966,8 @@ class CfnCampaign(
|
|
|
1872
1966
|
|
|
1873
1967
|
@builtins.property
|
|
1874
1968
|
def unit(self) -> builtins.str:
|
|
1875
|
-
'''
|
|
1969
|
+
'''The time increment type.
|
|
1970
|
+
|
|
1876
1971
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotfleetwise-campaign-storageminimumtimetolive.html#cfn-iotfleetwise-campaign-storageminimumtimetolive-unit
|
|
1877
1972
|
'''
|
|
1878
1973
|
result = self._values.get("unit")
|
|
@@ -1881,7 +1976,8 @@ class CfnCampaign(
|
|
|
1881
1976
|
|
|
1882
1977
|
@builtins.property
|
|
1883
1978
|
def value(self) -> jsii.Number:
|
|
1884
|
-
'''
|
|
1979
|
+
'''The minimum amount of time to store the data.
|
|
1980
|
+
|
|
1885
1981
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotfleetwise-campaign-storageminimumtimetolive.html#cfn-iotfleetwise-campaign-storageminimumtimetolive-value
|
|
1886
1982
|
'''
|
|
1887
1983
|
result = self._values.get("value")
|
|
@@ -1960,8 +2056,9 @@ class CfnCampaign(
|
|
|
1960
2056
|
)
|
|
1961
2057
|
class TimeBasedSignalFetchConfigProperty:
|
|
1962
2058
|
def __init__(self, *, execution_frequency_ms: jsii.Number) -> None:
|
|
1963
|
-
'''
|
|
1964
|
-
|
|
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.
|
|
1965
2062
|
|
|
1966
2063
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotfleetwise-campaign-timebasedsignalfetchconfig.html
|
|
1967
2064
|
:exampleMetadata: fixture=_generated
|
|
@@ -1985,7 +2082,8 @@ class CfnCampaign(
|
|
|
1985
2082
|
|
|
1986
2083
|
@builtins.property
|
|
1987
2084
|
def execution_frequency_ms(self) -> jsii.Number:
|
|
1988
|
-
'''
|
|
2085
|
+
'''The frequency with which the signal fetch will be executed.
|
|
2086
|
+
|
|
1989
2087
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotfleetwise-campaign-timebasedsignalfetchconfig.html#cfn-iotfleetwise-campaign-timebasedsignalfetchconfig-executionfrequencyms
|
|
1990
2088
|
'''
|
|
1991
2089
|
result = self._values.get("execution_frequency_ms")
|
|
@@ -2136,20 +2234,20 @@ class CfnCampaignProps:
|
|
|
2136
2234
|
:param signal_catalog_arn: The Amazon Resource Name (ARN) of the signal catalog associated with the campaign.
|
|
2137
2235
|
:param target_arn: The Amazon Resource Name (ARN) of a vehicle or fleet to which the campaign is deployed.
|
|
2138
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.
|
|
2139
|
-
:param compression:
|
|
2140
|
-
:param data_destination_configs:
|
|
2141
|
-
:param data_extra_dimensions:
|
|
2142
|
-
:param data_partitions:
|
|
2143
|
-
:param description:
|
|
2144
|
-
:param diagnostics_mode:
|
|
2145
|
-
:param expiry_time:
|
|
2146
|
-
:param post_trigger_collection_duration:
|
|
2147
|
-
:param priority:
|
|
2148
|
-
:param signals_to_collect:
|
|
2149
|
-
:param signals_to_fetch:
|
|
2150
|
-
:param spooling_mode:
|
|
2151
|
-
:param start_time:
|
|
2152
|
-
: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.
|
|
2153
2251
|
|
|
2154
2252
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotfleetwise-campaign.html
|
|
2155
2253
|
:exampleMetadata: fixture=_generated
|
|
@@ -2377,7 +2475,7 @@ class CfnCampaignProps:
|
|
|
2377
2475
|
|
|
2378
2476
|
@builtins.property
|
|
2379
2477
|
def compression(self) -> typing.Optional[builtins.str]:
|
|
2380
|
-
'''
|
|
2478
|
+
'''Whether to compress signals before transmitting data to AWS IoT FleetWise .
|
|
2381
2479
|
|
|
2382
2480
|
If you don't want to compress the signals, use ``OFF`` . If it's not specified, ``SNAPPY`` is used.
|
|
2383
2481
|
|
|
@@ -2394,7 +2492,7 @@ class CfnCampaignProps:
|
|
|
2394
2492
|
def data_destination_configs(
|
|
2395
2493
|
self,
|
|
2396
2494
|
) -> typing.Optional[typing.Union[_IResolvable_da3f097b, typing.List[typing.Union[_IResolvable_da3f097b, CfnCampaign.DataDestinationConfigProperty]]]]:
|
|
2397
|
-
'''
|
|
2495
|
+
'''The destination where the campaign sends data.
|
|
2398
2496
|
|
|
2399
2497
|
You can choose to send data to be stored in Amazon S3 or Amazon Timestream .
|
|
2400
2498
|
|
|
@@ -2409,7 +2507,7 @@ class CfnCampaignProps:
|
|
|
2409
2507
|
|
|
2410
2508
|
@builtins.property
|
|
2411
2509
|
def data_extra_dimensions(self) -> typing.Optional[typing.List[builtins.str]]:
|
|
2412
|
-
'''
|
|
2510
|
+
'''A list of vehicle attributes to associate with a campaign.
|
|
2413
2511
|
|
|
2414
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`` .
|
|
2415
2513
|
|
|
@@ -2424,7 +2522,8 @@ class CfnCampaignProps:
|
|
|
2424
2522
|
def data_partitions(
|
|
2425
2523
|
self,
|
|
2426
2524
|
) -> typing.Optional[typing.Union[_IResolvable_da3f097b, typing.List[typing.Union[_IResolvable_da3f097b, CfnCampaign.DataPartitionProperty]]]]:
|
|
2427
|
-
'''
|
|
2525
|
+
'''The data partitions associated with the signals collected from the vehicle.
|
|
2526
|
+
|
|
2428
2527
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotfleetwise-campaign.html#cfn-iotfleetwise-campaign-datapartitions
|
|
2429
2528
|
'''
|
|
2430
2529
|
result = self._values.get("data_partitions")
|
|
@@ -2432,7 +2531,7 @@ class CfnCampaignProps:
|
|
|
2432
2531
|
|
|
2433
2532
|
@builtins.property
|
|
2434
2533
|
def description(self) -> typing.Optional[builtins.str]:
|
|
2435
|
-
'''
|
|
2534
|
+
'''The description of the campaign.
|
|
2436
2535
|
|
|
2437
2536
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotfleetwise-campaign.html#cfn-iotfleetwise-campaign-description
|
|
2438
2537
|
'''
|
|
@@ -2441,7 +2540,7 @@ class CfnCampaignProps:
|
|
|
2441
2540
|
|
|
2442
2541
|
@builtins.property
|
|
2443
2542
|
def diagnostics_mode(self) -> typing.Optional[builtins.str]:
|
|
2444
|
-
'''
|
|
2543
|
+
'''Option for a vehicle to send diagnostic trouble codes to AWS IoT FleetWise .
|
|
2445
2544
|
|
|
2446
2545
|
If you want to send diagnostic trouble codes, use ``SEND_ACTIVE_DTCS`` . If it's not specified, ``OFF`` is used.
|
|
2447
2546
|
|
|
@@ -2456,7 +2555,7 @@ class CfnCampaignProps:
|
|
|
2456
2555
|
|
|
2457
2556
|
@builtins.property
|
|
2458
2557
|
def expiry_time(self) -> typing.Optional[builtins.str]:
|
|
2459
|
-
'''
|
|
2558
|
+
'''The time the campaign expires, in seconds since epoch (January 1, 1970 at midnight UTC time).
|
|
2460
2559
|
|
|
2461
2560
|
Vehicle data isn't collected after the campaign expires.
|
|
2462
2561
|
|
|
@@ -2471,7 +2570,7 @@ class CfnCampaignProps:
|
|
|
2471
2570
|
|
|
2472
2571
|
@builtins.property
|
|
2473
2572
|
def post_trigger_collection_duration(self) -> typing.Optional[jsii.Number]:
|
|
2474
|
-
'''
|
|
2573
|
+
'''How long (in milliseconds) to collect raw data after a triggering event initiates the collection.
|
|
2475
2574
|
|
|
2476
2575
|
If it's not specified, ``0`` is used.
|
|
2477
2576
|
|
|
@@ -2486,7 +2585,7 @@ class CfnCampaignProps:
|
|
|
2486
2585
|
|
|
2487
2586
|
@builtins.property
|
|
2488
2587
|
def priority(self) -> typing.Optional[jsii.Number]:
|
|
2489
|
-
'''
|
|
2588
|
+
'''A number indicating the priority of one campaign over another campaign for a certain vehicle or fleet.
|
|
2490
2589
|
|
|
2491
2590
|
A campaign with the lowest value is deployed to vehicles before any other campaigns. If it's not specified, ``0`` is used.
|
|
2492
2591
|
|
|
@@ -2503,7 +2602,7 @@ class CfnCampaignProps:
|
|
|
2503
2602
|
def signals_to_collect(
|
|
2504
2603
|
self,
|
|
2505
2604
|
) -> typing.Optional[typing.Union[_IResolvable_da3f097b, typing.List[typing.Union[_IResolvable_da3f097b, CfnCampaign.SignalInformationProperty]]]]:
|
|
2506
|
-
'''
|
|
2605
|
+
'''A list of information about signals to collect.
|
|
2507
2606
|
|
|
2508
2607
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotfleetwise-campaign.html#cfn-iotfleetwise-campaign-signalstocollect
|
|
2509
2608
|
'''
|
|
@@ -2514,7 +2613,8 @@ class CfnCampaignProps:
|
|
|
2514
2613
|
def signals_to_fetch(
|
|
2515
2614
|
self,
|
|
2516
2615
|
) -> typing.Optional[typing.Union[_IResolvable_da3f097b, typing.List[typing.Union[_IResolvable_da3f097b, CfnCampaign.SignalFetchInformationProperty]]]]:
|
|
2517
|
-
'''
|
|
2616
|
+
'''A list of information about signals to fetch.
|
|
2617
|
+
|
|
2518
2618
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotfleetwise-campaign.html#cfn-iotfleetwise-campaign-signalstofetch
|
|
2519
2619
|
'''
|
|
2520
2620
|
result = self._values.get("signals_to_fetch")
|
|
@@ -2522,7 +2622,7 @@ class CfnCampaignProps:
|
|
|
2522
2622
|
|
|
2523
2623
|
@builtins.property
|
|
2524
2624
|
def spooling_mode(self) -> typing.Optional[builtins.str]:
|
|
2525
|
-
'''
|
|
2625
|
+
'''Whether to store collected data after a vehicle lost a connection with the cloud.
|
|
2526
2626
|
|
|
2527
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.
|
|
2528
2628
|
|
|
@@ -2537,9 +2637,7 @@ class CfnCampaignProps:
|
|
|
2537
2637
|
|
|
2538
2638
|
@builtins.property
|
|
2539
2639
|
def start_time(self) -> typing.Optional[builtins.str]:
|
|
2540
|
-
'''
|
|
2541
|
-
|
|
2542
|
-
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.
|
|
2543
2641
|
|
|
2544
2642
|
Default: ``0``
|
|
2545
2643
|
|
|
@@ -2552,7 +2650,7 @@ class CfnCampaignProps:
|
|
|
2552
2650
|
|
|
2553
2651
|
@builtins.property
|
|
2554
2652
|
def tags(self) -> typing.Optional[typing.List[_CfnTag_f6864754]]:
|
|
2555
|
-
'''
|
|
2653
|
+
'''Metadata that can be used to manage the campaign.
|
|
2556
2654
|
|
|
2557
2655
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotfleetwise-campaign.html#cfn-iotfleetwise-campaign-tags
|
|
2558
2656
|
'''
|
|
@@ -2584,6 +2682,11 @@ class CfnDecoderManifest(
|
|
|
2584
2682
|
- Each network interface has a unique ID.
|
|
2585
2683
|
- The signal decoders are specified in the model manifest.
|
|
2586
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
|
+
|
|
2587
2690
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotfleetwise-decodermanifest.html
|
|
2588
2691
|
:cloudformationResource: AWS::IoTFleetWise::DecoderManifest
|
|
2589
2692
|
:exampleMetadata: fixture=_generated
|
|
@@ -2599,6 +2702,7 @@ class CfnDecoderManifest(
|
|
|
2599
2702
|
name="name",
|
|
2600
2703
|
|
|
2601
2704
|
# the properties below are optional
|
|
2705
|
+
default_for_unmapped_signals="defaultForUnmappedSignals",
|
|
2602
2706
|
description="description",
|
|
2603
2707
|
network_interfaces=[iotfleetwise.CfnDecoderManifest.NetworkInterfacesItemsProperty(
|
|
2604
2708
|
interface_id="interfaceId",
|
|
@@ -2671,6 +2775,7 @@ class CfnDecoderManifest(
|
|
|
2671
2775
|
*,
|
|
2672
2776
|
model_manifest_arn: builtins.str,
|
|
2673
2777
|
name: builtins.str,
|
|
2778
|
+
default_for_unmapped_signals: typing.Optional[builtins.str] = None,
|
|
2674
2779
|
description: typing.Optional[builtins.str] = None,
|
|
2675
2780
|
network_interfaces: typing.Optional[typing.Union[_IResolvable_da3f097b, typing.Sequence[typing.Union[_IResolvable_da3f097b, typing.Union["CfnDecoderManifest.NetworkInterfacesItemsProperty", typing.Dict[builtins.str, typing.Any]]]]]] = None,
|
|
2676
2781
|
signal_decoders: typing.Optional[typing.Union[_IResolvable_da3f097b, typing.Sequence[typing.Union[_IResolvable_da3f097b, typing.Union["CfnDecoderManifest.SignalDecodersItemsProperty", typing.Dict[builtins.str, typing.Any]]]]]] = None,
|
|
@@ -2682,11 +2787,12 @@ class CfnDecoderManifest(
|
|
|
2682
2787
|
:param id: Construct identifier for this resource (unique in its scope).
|
|
2683
2788
|
:param model_manifest_arn: The Amazon Resource Name (ARN) of a vehicle model (model manifest) associated with the decoder manifest.
|
|
2684
2789
|
:param name: The name of the decoder manifest.
|
|
2685
|
-
:param
|
|
2686
|
-
:param
|
|
2687
|
-
:param
|
|
2688
|
-
:param
|
|
2689
|
-
:param
|
|
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.
|
|
2690
2796
|
'''
|
|
2691
2797
|
if __debug__:
|
|
2692
2798
|
type_hints = typing.get_type_hints(_typecheckingstub__bd0d8efce6baca0fa606fb0cf95bebcdeda196fcde2fb7e18542334332eb8ba4)
|
|
@@ -2695,6 +2801,7 @@ class CfnDecoderManifest(
|
|
|
2695
2801
|
props = CfnDecoderManifestProps(
|
|
2696
2802
|
model_manifest_arn=model_manifest_arn,
|
|
2697
2803
|
name=name,
|
|
2804
|
+
default_for_unmapped_signals=default_for_unmapped_signals,
|
|
2698
2805
|
description=description,
|
|
2699
2806
|
network_interfaces=network_interfaces,
|
|
2700
2807
|
signal_decoders=signal_decoders,
|
|
@@ -2798,10 +2905,26 @@ class CfnDecoderManifest(
|
|
|
2798
2905
|
check_type(argname="argument value", value=value, expected_type=type_hints["value"])
|
|
2799
2906
|
jsii.set(self, "name", value) # pyright: ignore[reportArgumentType]
|
|
2800
2907
|
|
|
2908
|
+
@builtins.property
|
|
2909
|
+
@jsii.member(jsii_name="defaultForUnmappedSignals")
|
|
2910
|
+
def default_for_unmapped_signals(self) -> typing.Optional[builtins.str]:
|
|
2911
|
+
'''Use default decoders for all unmapped signals in the model.'''
|
|
2912
|
+
return typing.cast(typing.Optional[builtins.str], jsii.get(self, "defaultForUnmappedSignals"))
|
|
2913
|
+
|
|
2914
|
+
@default_for_unmapped_signals.setter
|
|
2915
|
+
def default_for_unmapped_signals(
|
|
2916
|
+
self,
|
|
2917
|
+
value: typing.Optional[builtins.str],
|
|
2918
|
+
) -> None:
|
|
2919
|
+
if __debug__:
|
|
2920
|
+
type_hints = typing.get_type_hints(_typecheckingstub__3d210b3f11bc1efe8c19f629b502c0e1e1fbcf1c23ae2d514eb28d3b59482cfc)
|
|
2921
|
+
check_type(argname="argument value", value=value, expected_type=type_hints["value"])
|
|
2922
|
+
jsii.set(self, "defaultForUnmappedSignals", value) # pyright: ignore[reportArgumentType]
|
|
2923
|
+
|
|
2801
2924
|
@builtins.property
|
|
2802
2925
|
@jsii.member(jsii_name="description")
|
|
2803
2926
|
def description(self) -> typing.Optional[builtins.str]:
|
|
2804
|
-
'''
|
|
2927
|
+
'''A brief description of the decoder manifest.'''
|
|
2805
2928
|
return typing.cast(typing.Optional[builtins.str], jsii.get(self, "description"))
|
|
2806
2929
|
|
|
2807
2930
|
@description.setter
|
|
@@ -2816,7 +2939,7 @@ class CfnDecoderManifest(
|
|
|
2816
2939
|
def network_interfaces(
|
|
2817
2940
|
self,
|
|
2818
2941
|
) -> typing.Optional[typing.Union[_IResolvable_da3f097b, typing.List[typing.Union[_IResolvable_da3f097b, "CfnDecoderManifest.NetworkInterfacesItemsProperty"]]]]:
|
|
2819
|
-
'''
|
|
2942
|
+
'''A list of information about available network interfaces.'''
|
|
2820
2943
|
return typing.cast(typing.Optional[typing.Union[_IResolvable_da3f097b, typing.List[typing.Union[_IResolvable_da3f097b, "CfnDecoderManifest.NetworkInterfacesItemsProperty"]]]], jsii.get(self, "networkInterfaces"))
|
|
2821
2944
|
|
|
2822
2945
|
@network_interfaces.setter
|
|
@@ -2834,7 +2957,7 @@ class CfnDecoderManifest(
|
|
|
2834
2957
|
def signal_decoders(
|
|
2835
2958
|
self,
|
|
2836
2959
|
) -> typing.Optional[typing.Union[_IResolvable_da3f097b, typing.List[typing.Union[_IResolvable_da3f097b, "CfnDecoderManifest.SignalDecodersItemsProperty"]]]]:
|
|
2837
|
-
'''
|
|
2960
|
+
'''A list of information about signal decoders.'''
|
|
2838
2961
|
return typing.cast(typing.Optional[typing.Union[_IResolvable_da3f097b, typing.List[typing.Union[_IResolvable_da3f097b, "CfnDecoderManifest.SignalDecodersItemsProperty"]]]], jsii.get(self, "signalDecoders"))
|
|
2839
2962
|
|
|
2840
2963
|
@signal_decoders.setter
|
|
@@ -2850,7 +2973,7 @@ class CfnDecoderManifest(
|
|
|
2850
2973
|
@builtins.property
|
|
2851
2974
|
@jsii.member(jsii_name="status")
|
|
2852
2975
|
def status(self) -> typing.Optional[builtins.str]:
|
|
2853
|
-
'''
|
|
2976
|
+
'''The state of the decoder manifest.'''
|
|
2854
2977
|
return typing.cast(typing.Optional[builtins.str], jsii.get(self, "status"))
|
|
2855
2978
|
|
|
2856
2979
|
@status.setter
|
|
@@ -2863,7 +2986,7 @@ class CfnDecoderManifest(
|
|
|
2863
2986
|
@builtins.property
|
|
2864
2987
|
@jsii.member(jsii_name="tagsRaw")
|
|
2865
2988
|
def tags_raw(self) -> typing.Optional[typing.List[_CfnTag_f6864754]]:
|
|
2866
|
-
'''
|
|
2989
|
+
'''Metadata that can be used to manage the decoder manifest.'''
|
|
2867
2990
|
return typing.cast(typing.Optional[typing.List[_CfnTag_f6864754]], jsii.get(self, "tagsRaw"))
|
|
2868
2991
|
|
|
2869
2992
|
@tags_raw.setter
|
|
@@ -2893,8 +3016,8 @@ class CfnDecoderManifest(
|
|
|
2893
3016
|
'''A single controller area network (CAN) device interface.
|
|
2894
3017
|
|
|
2895
3018
|
:param name: The unique name of the interface.
|
|
2896
|
-
:param protocol_name:
|
|
2897
|
-
: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.
|
|
2898
3021
|
|
|
2899
3022
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotfleetwise-decodermanifest-caninterface.html
|
|
2900
3023
|
:exampleMetadata: fixture=_generated
|
|
@@ -2938,7 +3061,7 @@ class CfnDecoderManifest(
|
|
|
2938
3061
|
|
|
2939
3062
|
@builtins.property
|
|
2940
3063
|
def protocol_name(self) -> typing.Optional[builtins.str]:
|
|
2941
|
-
'''
|
|
3064
|
+
'''The name of the communication protocol for the interface.
|
|
2942
3065
|
|
|
2943
3066
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotfleetwise-decodermanifest-caninterface.html#cfn-iotfleetwise-decodermanifest-caninterface-protocolname
|
|
2944
3067
|
'''
|
|
@@ -2947,7 +3070,7 @@ class CfnDecoderManifest(
|
|
|
2947
3070
|
|
|
2948
3071
|
@builtins.property
|
|
2949
3072
|
def protocol_version(self) -> typing.Optional[builtins.str]:
|
|
2950
|
-
'''
|
|
3073
|
+
'''The version of the communication protocol for the interface.
|
|
2951
3074
|
|
|
2952
3075
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotfleetwise-decodermanifest-caninterface.html#cfn-iotfleetwise-decodermanifest-caninterface-protocolversion
|
|
2953
3076
|
'''
|
|
@@ -3217,7 +3340,7 @@ class CfnDecoderManifest(
|
|
|
3217
3340
|
start_bit: builtins.str,
|
|
3218
3341
|
name: typing.Optional[builtins.str] = None,
|
|
3219
3342
|
) -> None:
|
|
3220
|
-
'''
|
|
3343
|
+
'''Information about a single controller area network (CAN) signal and the messages it receives and transmits.
|
|
3221
3344
|
|
|
3222
3345
|
:param factor: A multiplier used to decode the CAN message.
|
|
3223
3346
|
:param is_big_endian: Whether the byte ordering of a CAN message is big-endian.
|
|
@@ -3226,7 +3349,7 @@ class CfnDecoderManifest(
|
|
|
3226
3349
|
:param message_id: The ID of the message.
|
|
3227
3350
|
:param offset: The offset used to calculate the signal value. Combined with factor, the calculation is ``value = raw_value * factor + offset`` .
|
|
3228
3351
|
:param start_bit: Indicates the beginning of the CAN message.
|
|
3229
|
-
:param name:
|
|
3352
|
+
:param name: The name of the signal.
|
|
3230
3353
|
|
|
3231
3354
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotfleetwise-decodermanifest-cansignal.html
|
|
3232
3355
|
:exampleMetadata: fixture=_generated
|
|
@@ -3346,7 +3469,7 @@ class CfnDecoderManifest(
|
|
|
3346
3469
|
|
|
3347
3470
|
@builtins.property
|
|
3348
3471
|
def name(self) -> typing.Optional[builtins.str]:
|
|
3349
|
-
'''
|
|
3472
|
+
'''The name of the signal.
|
|
3350
3473
|
|
|
3351
3474
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotfleetwise-decodermanifest-cansignal.html#cfn-iotfleetwise-decodermanifest-cansignal-name
|
|
3352
3475
|
'''
|
|
@@ -3383,7 +3506,7 @@ class CfnDecoderManifest(
|
|
|
3383
3506
|
can_interface: typing.Optional[typing.Union[_IResolvable_da3f097b, typing.Union["CfnDecoderManifest.CanInterfaceProperty", typing.Dict[builtins.str, typing.Any]]]] = None,
|
|
3384
3507
|
obd_interface: typing.Optional[typing.Union[_IResolvable_da3f097b, typing.Union["CfnDecoderManifest.ObdInterfaceProperty", typing.Dict[builtins.str, typing.Any]]]] = None,
|
|
3385
3508
|
) -> None:
|
|
3386
|
-
'''
|
|
3509
|
+
'''A list of information about available network interfaces.
|
|
3387
3510
|
|
|
3388
3511
|
:param interface_id:
|
|
3389
3512
|
:param type:
|
|
@@ -3517,11 +3640,11 @@ class CfnDecoderManifest(
|
|
|
3517
3640
|
|
|
3518
3641
|
:param name: The name of the interface.
|
|
3519
3642
|
:param request_message_id: The ID of the message requesting vehicle data.
|
|
3520
|
-
:param dtc_request_interval_seconds:
|
|
3521
|
-
:param has_transmission_ecu:
|
|
3522
|
-
:param obd_standard:
|
|
3523
|
-
:param pid_request_interval_seconds:
|
|
3524
|
-
: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.
|
|
3525
3648
|
|
|
3526
3649
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotfleetwise-decodermanifest-obdinterface.html
|
|
3527
3650
|
:exampleMetadata: fixture=_generated
|
|
@@ -3590,7 +3713,7 @@ class CfnDecoderManifest(
|
|
|
3590
3713
|
|
|
3591
3714
|
@builtins.property
|
|
3592
3715
|
def dtc_request_interval_seconds(self) -> typing.Optional[builtins.str]:
|
|
3593
|
-
'''
|
|
3716
|
+
'''The maximum number message requests per diagnostic trouble code per second.
|
|
3594
3717
|
|
|
3595
3718
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotfleetwise-decodermanifest-obdinterface.html#cfn-iotfleetwise-decodermanifest-obdinterface-dtcrequestintervalseconds
|
|
3596
3719
|
'''
|
|
@@ -3599,7 +3722,7 @@ class CfnDecoderManifest(
|
|
|
3599
3722
|
|
|
3600
3723
|
@builtins.property
|
|
3601
3724
|
def has_transmission_ecu(self) -> typing.Optional[builtins.str]:
|
|
3602
|
-
'''
|
|
3725
|
+
'''Whether the vehicle has a transmission control module (TCM).
|
|
3603
3726
|
|
|
3604
3727
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotfleetwise-decodermanifest-obdinterface.html#cfn-iotfleetwise-decodermanifest-obdinterface-hastransmissionecu
|
|
3605
3728
|
'''
|
|
@@ -3608,7 +3731,7 @@ class CfnDecoderManifest(
|
|
|
3608
3731
|
|
|
3609
3732
|
@builtins.property
|
|
3610
3733
|
def obd_standard(self) -> typing.Optional[builtins.str]:
|
|
3611
|
-
'''
|
|
3734
|
+
'''The standard OBD II PID.
|
|
3612
3735
|
|
|
3613
3736
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotfleetwise-decodermanifest-obdinterface.html#cfn-iotfleetwise-decodermanifest-obdinterface-obdstandard
|
|
3614
3737
|
'''
|
|
@@ -3617,7 +3740,7 @@ class CfnDecoderManifest(
|
|
|
3617
3740
|
|
|
3618
3741
|
@builtins.property
|
|
3619
3742
|
def pid_request_interval_seconds(self) -> typing.Optional[builtins.str]:
|
|
3620
|
-
'''
|
|
3743
|
+
'''The maximum number message requests per second.
|
|
3621
3744
|
|
|
3622
3745
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotfleetwise-decodermanifest-obdinterface.html#cfn-iotfleetwise-decodermanifest-obdinterface-pidrequestintervalseconds
|
|
3623
3746
|
'''
|
|
@@ -3626,7 +3749,7 @@ class CfnDecoderManifest(
|
|
|
3626
3749
|
|
|
3627
3750
|
@builtins.property
|
|
3628
3751
|
def use_extended_ids(self) -> typing.Optional[builtins.str]:
|
|
3629
|
-
'''
|
|
3752
|
+
'''Whether to use extended IDs in the message.
|
|
3630
3753
|
|
|
3631
3754
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotfleetwise-decodermanifest-obdinterface.html#cfn-iotfleetwise-decodermanifest-obdinterface-useextendedids
|
|
3632
3755
|
'''
|
|
@@ -3664,7 +3787,7 @@ class CfnDecoderManifest(
|
|
|
3664
3787
|
'''Information about a network interface specified by the On-board diagnostic (OBD) II protocol.
|
|
3665
3788
|
|
|
3666
3789
|
:param interface_id: The ID of the network interface.
|
|
3667
|
-
:param obd_interface:
|
|
3790
|
+
:param obd_interface: Information about a network interface specified by the On-board diagnostic (OBD) II protocol.
|
|
3668
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.
|
|
3669
3792
|
|
|
3670
3793
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotfleetwise-decodermanifest-obdnetworkinterface.html
|
|
@@ -3717,7 +3840,7 @@ class CfnDecoderManifest(
|
|
|
3717
3840
|
def obd_interface(
|
|
3718
3841
|
self,
|
|
3719
3842
|
) -> typing.Union[_IResolvable_da3f097b, "CfnDecoderManifest.ObdInterfaceProperty"]:
|
|
3720
|
-
'''
|
|
3843
|
+
'''Information about a network interface specified by the On-board diagnostic (OBD) II protocol.
|
|
3721
3844
|
|
|
3722
3845
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotfleetwise-decodermanifest-obdnetworkinterface.html#cfn-iotfleetwise-decodermanifest-obdnetworkinterface-obdinterface
|
|
3723
3846
|
'''
|
|
@@ -3769,10 +3892,10 @@ class CfnDecoderManifest(
|
|
|
3769
3892
|
) -> None:
|
|
3770
3893
|
'''A list of information about signal decoders.
|
|
3771
3894
|
|
|
3772
|
-
:param fully_qualified_name:
|
|
3773
|
-
: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.
|
|
3774
3897
|
:param obd_signal: Information about signal messages using the on-board diagnostics (OBD) II protocol in a vehicle.
|
|
3775
|
-
: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.
|
|
3776
3899
|
|
|
3777
3900
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotfleetwise-decodermanifest-obdsignaldecoder.html
|
|
3778
3901
|
:exampleMetadata: fixture=_generated
|
|
@@ -3817,7 +3940,8 @@ class CfnDecoderManifest(
|
|
|
3817
3940
|
|
|
3818
3941
|
@builtins.property
|
|
3819
3942
|
def fully_qualified_name(self) -> builtins.str:
|
|
3820
|
-
'''
|
|
3943
|
+
'''The fully qualified name of a signal decoder as defined in a vehicle model.
|
|
3944
|
+
|
|
3821
3945
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotfleetwise-decodermanifest-obdsignaldecoder.html#cfn-iotfleetwise-decodermanifest-obdsignaldecoder-fullyqualifiedname
|
|
3822
3946
|
'''
|
|
3823
3947
|
result = self._values.get("fully_qualified_name")
|
|
@@ -3826,7 +3950,8 @@ class CfnDecoderManifest(
|
|
|
3826
3950
|
|
|
3827
3951
|
@builtins.property
|
|
3828
3952
|
def interface_id(self) -> builtins.str:
|
|
3829
|
-
'''
|
|
3953
|
+
'''The ID of a network interface that specifies what network protocol a vehicle follows.
|
|
3954
|
+
|
|
3830
3955
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotfleetwise-decodermanifest-obdsignaldecoder.html#cfn-iotfleetwise-decodermanifest-obdsignaldecoder-interfaceid
|
|
3831
3956
|
'''
|
|
3832
3957
|
result = self._values.get("interface_id")
|
|
@@ -3847,7 +3972,10 @@ class CfnDecoderManifest(
|
|
|
3847
3972
|
|
|
3848
3973
|
@builtins.property
|
|
3849
3974
|
def type(self) -> builtins.str:
|
|
3850
|
-
'''
|
|
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
|
+
|
|
3851
3979
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotfleetwise-decodermanifest-obdsignaldecoder.html#cfn-iotfleetwise-decodermanifest-obdsignaldecoder-type
|
|
3852
3980
|
'''
|
|
3853
3981
|
result = self._values.get("type")
|
|
@@ -3903,8 +4031,8 @@ class CfnDecoderManifest(
|
|
|
3903
4031
|
:param scaling: A multiplier used to decode the message.
|
|
3904
4032
|
:param service_mode: The mode of operation (diagnostic service) in a message.
|
|
3905
4033
|
:param start_byte: Indicates the beginning of the message.
|
|
3906
|
-
:param bit_mask_length:
|
|
3907
|
-
: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.
|
|
3908
4036
|
|
|
3909
4037
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotfleetwise-decodermanifest-obdsignal.html
|
|
3910
4038
|
:exampleMetadata: fixture=_generated
|
|
@@ -4028,7 +4156,7 @@ class CfnDecoderManifest(
|
|
|
4028
4156
|
|
|
4029
4157
|
@builtins.property
|
|
4030
4158
|
def bit_mask_length(self) -> typing.Optional[builtins.str]:
|
|
4031
|
-
'''
|
|
4159
|
+
'''The number of bits to mask in a message.
|
|
4032
4160
|
|
|
4033
4161
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotfleetwise-decodermanifest-obdsignal.html#cfn-iotfleetwise-decodermanifest-obdsignal-bitmasklength
|
|
4034
4162
|
'''
|
|
@@ -4037,7 +4165,7 @@ class CfnDecoderManifest(
|
|
|
4037
4165
|
|
|
4038
4166
|
@builtins.property
|
|
4039
4167
|
def bit_right_shift(self) -> typing.Optional[builtins.str]:
|
|
4040
|
-
'''
|
|
4168
|
+
'''The number of positions to shift bits in the message.
|
|
4041
4169
|
|
|
4042
4170
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotfleetwise-decodermanifest-obdsignal.html#cfn-iotfleetwise-decodermanifest-obdsignal-bitrightshift
|
|
4043
4171
|
'''
|
|
@@ -4208,6 +4336,7 @@ class CfnDecoderManifest(
|
|
|
4208
4336
|
name_mapping={
|
|
4209
4337
|
"model_manifest_arn": "modelManifestArn",
|
|
4210
4338
|
"name": "name",
|
|
4339
|
+
"default_for_unmapped_signals": "defaultForUnmappedSignals",
|
|
4211
4340
|
"description": "description",
|
|
4212
4341
|
"network_interfaces": "networkInterfaces",
|
|
4213
4342
|
"signal_decoders": "signalDecoders",
|
|
@@ -4221,6 +4350,7 @@ class CfnDecoderManifestProps:
|
|
|
4221
4350
|
*,
|
|
4222
4351
|
model_manifest_arn: builtins.str,
|
|
4223
4352
|
name: builtins.str,
|
|
4353
|
+
default_for_unmapped_signals: typing.Optional[builtins.str] = None,
|
|
4224
4354
|
description: typing.Optional[builtins.str] = None,
|
|
4225
4355
|
network_interfaces: typing.Optional[typing.Union[_IResolvable_da3f097b, typing.Sequence[typing.Union[_IResolvable_da3f097b, typing.Union[CfnDecoderManifest.NetworkInterfacesItemsProperty, typing.Dict[builtins.str, typing.Any]]]]]] = None,
|
|
4226
4356
|
signal_decoders: typing.Optional[typing.Union[_IResolvable_da3f097b, typing.Sequence[typing.Union[_IResolvable_da3f097b, typing.Union[CfnDecoderManifest.SignalDecodersItemsProperty, typing.Dict[builtins.str, typing.Any]]]]]] = None,
|
|
@@ -4231,11 +4361,12 @@ class CfnDecoderManifestProps:
|
|
|
4231
4361
|
|
|
4232
4362
|
:param model_manifest_arn: The Amazon Resource Name (ARN) of a vehicle model (model manifest) associated with the decoder manifest.
|
|
4233
4363
|
:param name: The name of the decoder manifest.
|
|
4234
|
-
:param
|
|
4235
|
-
:param
|
|
4236
|
-
:param
|
|
4237
|
-
:param
|
|
4238
|
-
:param
|
|
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.
|
|
4239
4370
|
|
|
4240
4371
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotfleetwise-decodermanifest.html
|
|
4241
4372
|
:exampleMetadata: fixture=_generated
|
|
@@ -4251,6 +4382,7 @@ class CfnDecoderManifestProps:
|
|
|
4251
4382
|
name="name",
|
|
4252
4383
|
|
|
4253
4384
|
# the properties below are optional
|
|
4385
|
+
default_for_unmapped_signals="defaultForUnmappedSignals",
|
|
4254
4386
|
description="description",
|
|
4255
4387
|
network_interfaces=[iotfleetwise.CfnDecoderManifest.NetworkInterfacesItemsProperty(
|
|
4256
4388
|
interface_id="interfaceId",
|
|
@@ -4319,6 +4451,7 @@ class CfnDecoderManifestProps:
|
|
|
4319
4451
|
type_hints = typing.get_type_hints(_typecheckingstub__1be5cfb3ca0441a2fdb0856303c08c4449592f7472588f5c0659c42af4d89e2c)
|
|
4320
4452
|
check_type(argname="argument model_manifest_arn", value=model_manifest_arn, expected_type=type_hints["model_manifest_arn"])
|
|
4321
4453
|
check_type(argname="argument name", value=name, expected_type=type_hints["name"])
|
|
4454
|
+
check_type(argname="argument default_for_unmapped_signals", value=default_for_unmapped_signals, expected_type=type_hints["default_for_unmapped_signals"])
|
|
4322
4455
|
check_type(argname="argument description", value=description, expected_type=type_hints["description"])
|
|
4323
4456
|
check_type(argname="argument network_interfaces", value=network_interfaces, expected_type=type_hints["network_interfaces"])
|
|
4324
4457
|
check_type(argname="argument signal_decoders", value=signal_decoders, expected_type=type_hints["signal_decoders"])
|
|
@@ -4328,6 +4461,8 @@ class CfnDecoderManifestProps:
|
|
|
4328
4461
|
"model_manifest_arn": model_manifest_arn,
|
|
4329
4462
|
"name": name,
|
|
4330
4463
|
}
|
|
4464
|
+
if default_for_unmapped_signals is not None:
|
|
4465
|
+
self._values["default_for_unmapped_signals"] = default_for_unmapped_signals
|
|
4331
4466
|
if description is not None:
|
|
4332
4467
|
self._values["description"] = description
|
|
4333
4468
|
if network_interfaces is not None:
|
|
@@ -4359,9 +4494,20 @@ class CfnDecoderManifestProps:
|
|
|
4359
4494
|
assert result is not None, "Required property 'name' is missing"
|
|
4360
4495
|
return typing.cast(builtins.str, result)
|
|
4361
4496
|
|
|
4497
|
+
@builtins.property
|
|
4498
|
+
def default_for_unmapped_signals(self) -> typing.Optional[builtins.str]:
|
|
4499
|
+
'''Use default decoders for all unmapped signals in the model.
|
|
4500
|
+
|
|
4501
|
+
You don't need to provide any detailed decoding information.
|
|
4502
|
+
|
|
4503
|
+
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotfleetwise-decodermanifest.html#cfn-iotfleetwise-decodermanifest-defaultforunmappedsignals
|
|
4504
|
+
'''
|
|
4505
|
+
result = self._values.get("default_for_unmapped_signals")
|
|
4506
|
+
return typing.cast(typing.Optional[builtins.str], result)
|
|
4507
|
+
|
|
4362
4508
|
@builtins.property
|
|
4363
4509
|
def description(self) -> typing.Optional[builtins.str]:
|
|
4364
|
-
'''
|
|
4510
|
+
'''A brief description of the decoder manifest.
|
|
4365
4511
|
|
|
4366
4512
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotfleetwise-decodermanifest.html#cfn-iotfleetwise-decodermanifest-description
|
|
4367
4513
|
'''
|
|
@@ -4372,7 +4518,7 @@ class CfnDecoderManifestProps:
|
|
|
4372
4518
|
def network_interfaces(
|
|
4373
4519
|
self,
|
|
4374
4520
|
) -> typing.Optional[typing.Union[_IResolvable_da3f097b, typing.List[typing.Union[_IResolvable_da3f097b, CfnDecoderManifest.NetworkInterfacesItemsProperty]]]]:
|
|
4375
|
-
'''
|
|
4521
|
+
'''A list of information about available network interfaces.
|
|
4376
4522
|
|
|
4377
4523
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotfleetwise-decodermanifest.html#cfn-iotfleetwise-decodermanifest-networkinterfaces
|
|
4378
4524
|
'''
|
|
@@ -4383,7 +4529,7 @@ class CfnDecoderManifestProps:
|
|
|
4383
4529
|
def signal_decoders(
|
|
4384
4530
|
self,
|
|
4385
4531
|
) -> typing.Optional[typing.Union[_IResolvable_da3f097b, typing.List[typing.Union[_IResolvable_da3f097b, CfnDecoderManifest.SignalDecodersItemsProperty]]]]:
|
|
4386
|
-
'''
|
|
4532
|
+
'''A list of information about signal decoders.
|
|
4387
4533
|
|
|
4388
4534
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotfleetwise-decodermanifest.html#cfn-iotfleetwise-decodermanifest-signaldecoders
|
|
4389
4535
|
'''
|
|
@@ -4392,7 +4538,7 @@ class CfnDecoderManifestProps:
|
|
|
4392
4538
|
|
|
4393
4539
|
@builtins.property
|
|
4394
4540
|
def status(self) -> typing.Optional[builtins.str]:
|
|
4395
|
-
'''
|
|
4541
|
+
'''The state of the decoder manifest.
|
|
4396
4542
|
|
|
4397
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.
|
|
4398
4544
|
|
|
@@ -4405,7 +4551,7 @@ class CfnDecoderManifestProps:
|
|
|
4405
4551
|
|
|
4406
4552
|
@builtins.property
|
|
4407
4553
|
def tags(self) -> typing.Optional[typing.List[_CfnTag_f6864754]]:
|
|
4408
|
-
'''
|
|
4554
|
+
'''Metadata that can be used to manage the decoder manifest.
|
|
4409
4555
|
|
|
4410
4556
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotfleetwise-decodermanifest.html#cfn-iotfleetwise-decodermanifest-tags
|
|
4411
4557
|
'''
|
|
@@ -4476,8 +4622,8 @@ class CfnFleet(
|
|
|
4476
4622
|
:param id_: Construct identifier for this resource (unique in its scope).
|
|
4477
4623
|
:param id: The unique ID of the fleet.
|
|
4478
4624
|
:param signal_catalog_arn: The ARN of the signal catalog associated with the fleet.
|
|
4479
|
-
:param description:
|
|
4480
|
-
:param tags:
|
|
4625
|
+
:param description: A brief description of the fleet.
|
|
4626
|
+
:param tags: Metadata that can be used to manage the fleet.
|
|
4481
4627
|
'''
|
|
4482
4628
|
if __debug__:
|
|
4483
4629
|
type_hints = typing.get_type_hints(_typecheckingstub__be2399a288ba3f0fe4eba6c31d42082d31eac165febede18736a759d92f2120d)
|
|
@@ -4589,7 +4735,7 @@ class CfnFleet(
|
|
|
4589
4735
|
@builtins.property
|
|
4590
4736
|
@jsii.member(jsii_name="description")
|
|
4591
4737
|
def description(self) -> typing.Optional[builtins.str]:
|
|
4592
|
-
'''
|
|
4738
|
+
'''A brief description of the fleet.'''
|
|
4593
4739
|
return typing.cast(typing.Optional[builtins.str], jsii.get(self, "description"))
|
|
4594
4740
|
|
|
4595
4741
|
@description.setter
|
|
@@ -4602,7 +4748,7 @@ class CfnFleet(
|
|
|
4602
4748
|
@builtins.property
|
|
4603
4749
|
@jsii.member(jsii_name="tagsRaw")
|
|
4604
4750
|
def tags_raw(self) -> typing.Optional[typing.List[_CfnTag_f6864754]]:
|
|
4605
|
-
'''
|
|
4751
|
+
'''Metadata that can be used to manage the fleet.'''
|
|
4606
4752
|
return typing.cast(typing.Optional[typing.List[_CfnTag_f6864754]], jsii.get(self, "tagsRaw"))
|
|
4607
4753
|
|
|
4608
4754
|
@tags_raw.setter
|
|
@@ -4636,8 +4782,8 @@ class CfnFleetProps:
|
|
|
4636
4782
|
|
|
4637
4783
|
:param id: The unique ID of the fleet.
|
|
4638
4784
|
:param signal_catalog_arn: The ARN of the signal catalog associated with the fleet.
|
|
4639
|
-
:param description:
|
|
4640
|
-
:param tags:
|
|
4785
|
+
:param description: A brief description of the fleet.
|
|
4786
|
+
:param tags: Metadata that can be used to manage the fleet.
|
|
4641
4787
|
|
|
4642
4788
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotfleetwise-fleet.html
|
|
4643
4789
|
:exampleMetadata: fixture=_generated
|
|
@@ -4697,7 +4843,7 @@ class CfnFleetProps:
|
|
|
4697
4843
|
|
|
4698
4844
|
@builtins.property
|
|
4699
4845
|
def description(self) -> typing.Optional[builtins.str]:
|
|
4700
|
-
'''
|
|
4846
|
+
'''A brief description of the fleet.
|
|
4701
4847
|
|
|
4702
4848
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotfleetwise-fleet.html#cfn-iotfleetwise-fleet-description
|
|
4703
4849
|
'''
|
|
@@ -4706,7 +4852,7 @@ class CfnFleetProps:
|
|
|
4706
4852
|
|
|
4707
4853
|
@builtins.property
|
|
4708
4854
|
def tags(self) -> typing.Optional[typing.List[_CfnTag_f6864754]]:
|
|
4709
|
-
'''
|
|
4855
|
+
'''Metadata that can be used to manage the fleet.
|
|
4710
4856
|
|
|
4711
4857
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotfleetwise-fleet.html#cfn-iotfleetwise-fleet-tags
|
|
4712
4858
|
'''
|
|
@@ -4777,10 +4923,10 @@ class CfnModelManifest(
|
|
|
4777
4923
|
:param id: Construct identifier for this resource (unique in its scope).
|
|
4778
4924
|
:param name: The name of the vehicle model.
|
|
4779
4925
|
:param signal_catalog_arn: The Amazon Resource Name (ARN) of the signal catalog associated with the vehicle model.
|
|
4780
|
-
:param description:
|
|
4781
|
-
:param nodes:
|
|
4782
|
-
:param status:
|
|
4783
|
-
: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.
|
|
4784
4930
|
'''
|
|
4785
4931
|
if __debug__:
|
|
4786
4932
|
type_hints = typing.get_type_hints(_typecheckingstub__2f0e03fe14f53de97f2e7071c7f10132492e794782f840695921dc42cd286a81)
|
|
@@ -4894,7 +5040,7 @@ class CfnModelManifest(
|
|
|
4894
5040
|
@builtins.property
|
|
4895
5041
|
@jsii.member(jsii_name="description")
|
|
4896
5042
|
def description(self) -> typing.Optional[builtins.str]:
|
|
4897
|
-
'''
|
|
5043
|
+
'''A brief description of the vehicle model.'''
|
|
4898
5044
|
return typing.cast(typing.Optional[builtins.str], jsii.get(self, "description"))
|
|
4899
5045
|
|
|
4900
5046
|
@description.setter
|
|
@@ -4907,7 +5053,7 @@ class CfnModelManifest(
|
|
|
4907
5053
|
@builtins.property
|
|
4908
5054
|
@jsii.member(jsii_name="nodes")
|
|
4909
5055
|
def nodes(self) -> typing.Optional[typing.List[builtins.str]]:
|
|
4910
|
-
'''
|
|
5056
|
+
'''A list of nodes, which are a general abstraction of signals.'''
|
|
4911
5057
|
return typing.cast(typing.Optional[typing.List[builtins.str]], jsii.get(self, "nodes"))
|
|
4912
5058
|
|
|
4913
5059
|
@nodes.setter
|
|
@@ -4920,7 +5066,7 @@ class CfnModelManifest(
|
|
|
4920
5066
|
@builtins.property
|
|
4921
5067
|
@jsii.member(jsii_name="status")
|
|
4922
5068
|
def status(self) -> typing.Optional[builtins.str]:
|
|
4923
|
-
'''
|
|
5069
|
+
'''The state of the vehicle model.'''
|
|
4924
5070
|
return typing.cast(typing.Optional[builtins.str], jsii.get(self, "status"))
|
|
4925
5071
|
|
|
4926
5072
|
@status.setter
|
|
@@ -4933,7 +5079,7 @@ class CfnModelManifest(
|
|
|
4933
5079
|
@builtins.property
|
|
4934
5080
|
@jsii.member(jsii_name="tagsRaw")
|
|
4935
5081
|
def tags_raw(self) -> typing.Optional[typing.List[_CfnTag_f6864754]]:
|
|
4936
|
-
'''
|
|
5082
|
+
'''Metadata that can be used to manage the vehicle model.'''
|
|
4937
5083
|
return typing.cast(typing.Optional[typing.List[_CfnTag_f6864754]], jsii.get(self, "tagsRaw"))
|
|
4938
5084
|
|
|
4939
5085
|
@tags_raw.setter
|
|
@@ -4971,10 +5117,10 @@ class CfnModelManifestProps:
|
|
|
4971
5117
|
|
|
4972
5118
|
:param name: The name of the vehicle model.
|
|
4973
5119
|
:param signal_catalog_arn: The Amazon Resource Name (ARN) of the signal catalog associated with the vehicle model.
|
|
4974
|
-
:param description:
|
|
4975
|
-
:param nodes:
|
|
4976
|
-
:param status:
|
|
4977
|
-
: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.
|
|
4978
5124
|
|
|
4979
5125
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotfleetwise-modelmanifest.html
|
|
4980
5126
|
:exampleMetadata: fixture=_generated
|
|
@@ -5042,7 +5188,7 @@ class CfnModelManifestProps:
|
|
|
5042
5188
|
|
|
5043
5189
|
@builtins.property
|
|
5044
5190
|
def description(self) -> typing.Optional[builtins.str]:
|
|
5045
|
-
'''
|
|
5191
|
+
'''A brief description of the vehicle model.
|
|
5046
5192
|
|
|
5047
5193
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotfleetwise-modelmanifest.html#cfn-iotfleetwise-modelmanifest-description
|
|
5048
5194
|
'''
|
|
@@ -5051,7 +5197,7 @@ class CfnModelManifestProps:
|
|
|
5051
5197
|
|
|
5052
5198
|
@builtins.property
|
|
5053
5199
|
def nodes(self) -> typing.Optional[typing.List[builtins.str]]:
|
|
5054
|
-
'''
|
|
5200
|
+
'''A list of nodes, which are a general abstraction of signals.
|
|
5055
5201
|
|
|
5056
5202
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotfleetwise-modelmanifest.html#cfn-iotfleetwise-modelmanifest-nodes
|
|
5057
5203
|
'''
|
|
@@ -5060,7 +5206,7 @@ class CfnModelManifestProps:
|
|
|
5060
5206
|
|
|
5061
5207
|
@builtins.property
|
|
5062
5208
|
def status(self) -> typing.Optional[builtins.str]:
|
|
5063
|
-
'''
|
|
5209
|
+
'''The state of the vehicle model.
|
|
5064
5210
|
|
|
5065
5211
|
If the status is ``ACTIVE`` , the vehicle model can't be edited. If the status is ``DRAFT`` , you can edit the vehicle model.
|
|
5066
5212
|
|
|
@@ -5073,7 +5219,7 @@ class CfnModelManifestProps:
|
|
|
5073
5219
|
|
|
5074
5220
|
@builtins.property
|
|
5075
5221
|
def tags(self) -> typing.Optional[typing.List[_CfnTag_f6864754]]:
|
|
5076
|
-
'''
|
|
5222
|
+
'''Metadata that can be used to manage the vehicle model.
|
|
5077
5223
|
|
|
5078
5224
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotfleetwise-modelmanifest.html#cfn-iotfleetwise-modelmanifest-tags
|
|
5079
5225
|
'''
|
|
@@ -5100,6 +5246,8 @@ class CfnSignalCatalog(
|
|
|
5100
5246
|
):
|
|
5101
5247
|
'''Creates a collection of standardized signals that can be reused to create vehicle models.
|
|
5102
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
|
+
|
|
5103
5251
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotfleetwise-signalcatalog.html
|
|
5104
5252
|
:cloudformationResource: AWS::IoTFleetWise::SignalCatalog
|
|
5105
5253
|
:exampleMetadata: fixture=_generated
|
|
@@ -5185,11 +5333,11 @@ class CfnSignalCatalog(
|
|
|
5185
5333
|
'''
|
|
5186
5334
|
:param scope: Scope in which this resource is defined.
|
|
5187
5335
|
:param id: Construct identifier for this resource (unique in its scope).
|
|
5188
|
-
:param description:
|
|
5189
|
-
:param name:
|
|
5190
|
-
:param node_counts:
|
|
5191
|
-
:param nodes:
|
|
5192
|
-
: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.
|
|
5193
5341
|
'''
|
|
5194
5342
|
if __debug__:
|
|
5195
5343
|
type_hints = typing.get_type_hints(_typecheckingstub__00a926b4b26fd9efc933b63c5d4e497e8bfeceb8f4fb16790d18152e0fd2e282)
|
|
@@ -5321,7 +5469,7 @@ class CfnSignalCatalog(
|
|
|
5321
5469
|
@builtins.property
|
|
5322
5470
|
@jsii.member(jsii_name="description")
|
|
5323
5471
|
def description(self) -> typing.Optional[builtins.str]:
|
|
5324
|
-
'''
|
|
5472
|
+
'''A brief description of the signal catalog.'''
|
|
5325
5473
|
return typing.cast(typing.Optional[builtins.str], jsii.get(self, "description"))
|
|
5326
5474
|
|
|
5327
5475
|
@description.setter
|
|
@@ -5334,7 +5482,7 @@ class CfnSignalCatalog(
|
|
|
5334
5482
|
@builtins.property
|
|
5335
5483
|
@jsii.member(jsii_name="name")
|
|
5336
5484
|
def name(self) -> typing.Optional[builtins.str]:
|
|
5337
|
-
'''
|
|
5485
|
+
'''The name of the signal catalog.'''
|
|
5338
5486
|
return typing.cast(typing.Optional[builtins.str], jsii.get(self, "name"))
|
|
5339
5487
|
|
|
5340
5488
|
@name.setter
|
|
@@ -5349,7 +5497,7 @@ class CfnSignalCatalog(
|
|
|
5349
5497
|
def node_counts(
|
|
5350
5498
|
self,
|
|
5351
5499
|
) -> typing.Optional[typing.Union[_IResolvable_da3f097b, "CfnSignalCatalog.NodeCountsProperty"]]:
|
|
5352
|
-
'''
|
|
5500
|
+
'''Information about the number of nodes and node types in a vehicle network.'''
|
|
5353
5501
|
return typing.cast(typing.Optional[typing.Union[_IResolvable_da3f097b, "CfnSignalCatalog.NodeCountsProperty"]], jsii.get(self, "nodeCounts"))
|
|
5354
5502
|
|
|
5355
5503
|
@node_counts.setter
|
|
@@ -5367,7 +5515,7 @@ class CfnSignalCatalog(
|
|
|
5367
5515
|
def nodes(
|
|
5368
5516
|
self,
|
|
5369
5517
|
) -> typing.Optional[typing.Union[_IResolvable_da3f097b, typing.List[typing.Union[_IResolvable_da3f097b, "CfnSignalCatalog.NodeProperty"]]]]:
|
|
5370
|
-
'''
|
|
5518
|
+
'''A list of information about nodes, which are a general abstraction of signals.'''
|
|
5371
5519
|
return typing.cast(typing.Optional[typing.Union[_IResolvable_da3f097b, typing.List[typing.Union[_IResolvable_da3f097b, "CfnSignalCatalog.NodeProperty"]]]], jsii.get(self, "nodes"))
|
|
5372
5520
|
|
|
5373
5521
|
@nodes.setter
|
|
@@ -5383,7 +5531,7 @@ class CfnSignalCatalog(
|
|
|
5383
5531
|
@builtins.property
|
|
5384
5532
|
@jsii.member(jsii_name="tagsRaw")
|
|
5385
5533
|
def tags_raw(self) -> typing.Optional[typing.List[_CfnTag_f6864754]]:
|
|
5386
|
-
'''
|
|
5534
|
+
'''Metadata that can be used to manage the signal catalog.'''
|
|
5387
5535
|
return typing.cast(typing.Optional[typing.List[_CfnTag_f6864754]], jsii.get(self, "tagsRaw"))
|
|
5388
5536
|
|
|
5389
5537
|
@tags_raw.setter
|
|
@@ -5429,12 +5577,12 @@ class CfnSignalCatalog(
|
|
|
5429
5577
|
|
|
5430
5578
|
:param data_type: The specified data type of the actuator.
|
|
5431
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`` .
|
|
5432
|
-
:param allowed_values:
|
|
5433
|
-
:param assigned_value:
|
|
5434
|
-
:param description:
|
|
5435
|
-
:param max:
|
|
5436
|
-
:param min:
|
|
5437
|
-
: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.
|
|
5438
5586
|
|
|
5439
5587
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotfleetwise-signalcatalog-actuator.html
|
|
5440
5588
|
:exampleMetadata: fixture=_generated
|
|
@@ -5509,7 +5657,7 @@ class CfnSignalCatalog(
|
|
|
5509
5657
|
|
|
5510
5658
|
@builtins.property
|
|
5511
5659
|
def allowed_values(self) -> typing.Optional[typing.List[builtins.str]]:
|
|
5512
|
-
'''
|
|
5660
|
+
'''A list of possible values an actuator can take.
|
|
5513
5661
|
|
|
5514
5662
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotfleetwise-signalcatalog-actuator.html#cfn-iotfleetwise-signalcatalog-actuator-allowedvalues
|
|
5515
5663
|
'''
|
|
@@ -5518,7 +5666,7 @@ class CfnSignalCatalog(
|
|
|
5518
5666
|
|
|
5519
5667
|
@builtins.property
|
|
5520
5668
|
def assigned_value(self) -> typing.Optional[builtins.str]:
|
|
5521
|
-
'''
|
|
5669
|
+
'''A specified value for the actuator.
|
|
5522
5670
|
|
|
5523
5671
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotfleetwise-signalcatalog-actuator.html#cfn-iotfleetwise-signalcatalog-actuator-assignedvalue
|
|
5524
5672
|
'''
|
|
@@ -5527,7 +5675,7 @@ class CfnSignalCatalog(
|
|
|
5527
5675
|
|
|
5528
5676
|
@builtins.property
|
|
5529
5677
|
def description(self) -> typing.Optional[builtins.str]:
|
|
5530
|
-
'''
|
|
5678
|
+
'''A brief description of the actuator.
|
|
5531
5679
|
|
|
5532
5680
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotfleetwise-signalcatalog-actuator.html#cfn-iotfleetwise-signalcatalog-actuator-description
|
|
5533
5681
|
'''
|
|
@@ -5536,7 +5684,7 @@ class CfnSignalCatalog(
|
|
|
5536
5684
|
|
|
5537
5685
|
@builtins.property
|
|
5538
5686
|
def max(self) -> typing.Optional[jsii.Number]:
|
|
5539
|
-
'''
|
|
5687
|
+
'''The specified possible maximum value of an actuator.
|
|
5540
5688
|
|
|
5541
5689
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotfleetwise-signalcatalog-actuator.html#cfn-iotfleetwise-signalcatalog-actuator-max
|
|
5542
5690
|
'''
|
|
@@ -5545,7 +5693,7 @@ class CfnSignalCatalog(
|
|
|
5545
5693
|
|
|
5546
5694
|
@builtins.property
|
|
5547
5695
|
def min(self) -> typing.Optional[jsii.Number]:
|
|
5548
|
-
'''
|
|
5696
|
+
'''The specified possible minimum value of an actuator.
|
|
5549
5697
|
|
|
5550
5698
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotfleetwise-signalcatalog-actuator.html#cfn-iotfleetwise-signalcatalog-actuator-min
|
|
5551
5699
|
'''
|
|
@@ -5554,7 +5702,7 @@ class CfnSignalCatalog(
|
|
|
5554
5702
|
|
|
5555
5703
|
@builtins.property
|
|
5556
5704
|
def unit(self) -> typing.Optional[builtins.str]:
|
|
5557
|
-
'''
|
|
5705
|
+
'''The scientific unit for the actuator.
|
|
5558
5706
|
|
|
5559
5707
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotfleetwise-signalcatalog-actuator.html#cfn-iotfleetwise-signalcatalog-actuator-unit
|
|
5560
5708
|
'''
|
|
@@ -5605,13 +5753,13 @@ class CfnSignalCatalog(
|
|
|
5605
5753
|
|
|
5606
5754
|
:param data_type: The specified data type of the attribute.
|
|
5607
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`` .
|
|
5608
|
-
:param allowed_values:
|
|
5609
|
-
:param assigned_value:
|
|
5610
|
-
:param default_value:
|
|
5611
|
-
:param description:
|
|
5612
|
-
:param max:
|
|
5613
|
-
:param min:
|
|
5614
|
-
: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.
|
|
5615
5763
|
|
|
5616
5764
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotfleetwise-signalcatalog-attribute.html
|
|
5617
5765
|
:exampleMetadata: fixture=_generated
|
|
@@ -5690,7 +5838,7 @@ class CfnSignalCatalog(
|
|
|
5690
5838
|
|
|
5691
5839
|
@builtins.property
|
|
5692
5840
|
def allowed_values(self) -> typing.Optional[typing.List[builtins.str]]:
|
|
5693
|
-
'''
|
|
5841
|
+
'''A list of possible values an attribute can be assigned.
|
|
5694
5842
|
|
|
5695
5843
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotfleetwise-signalcatalog-attribute.html#cfn-iotfleetwise-signalcatalog-attribute-allowedvalues
|
|
5696
5844
|
'''
|
|
@@ -5699,7 +5847,7 @@ class CfnSignalCatalog(
|
|
|
5699
5847
|
|
|
5700
5848
|
@builtins.property
|
|
5701
5849
|
def assigned_value(self) -> typing.Optional[builtins.str]:
|
|
5702
|
-
'''
|
|
5850
|
+
'''A specified value for the attribute.
|
|
5703
5851
|
|
|
5704
5852
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotfleetwise-signalcatalog-attribute.html#cfn-iotfleetwise-signalcatalog-attribute-assignedvalue
|
|
5705
5853
|
'''
|
|
@@ -5708,7 +5856,7 @@ class CfnSignalCatalog(
|
|
|
5708
5856
|
|
|
5709
5857
|
@builtins.property
|
|
5710
5858
|
def default_value(self) -> typing.Optional[builtins.str]:
|
|
5711
|
-
'''
|
|
5859
|
+
'''The default value of the attribute.
|
|
5712
5860
|
|
|
5713
5861
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotfleetwise-signalcatalog-attribute.html#cfn-iotfleetwise-signalcatalog-attribute-defaultvalue
|
|
5714
5862
|
'''
|
|
@@ -5717,7 +5865,7 @@ class CfnSignalCatalog(
|
|
|
5717
5865
|
|
|
5718
5866
|
@builtins.property
|
|
5719
5867
|
def description(self) -> typing.Optional[builtins.str]:
|
|
5720
|
-
'''
|
|
5868
|
+
'''A brief description of the attribute.
|
|
5721
5869
|
|
|
5722
5870
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotfleetwise-signalcatalog-attribute.html#cfn-iotfleetwise-signalcatalog-attribute-description
|
|
5723
5871
|
'''
|
|
@@ -5726,7 +5874,7 @@ class CfnSignalCatalog(
|
|
|
5726
5874
|
|
|
5727
5875
|
@builtins.property
|
|
5728
5876
|
def max(self) -> typing.Optional[jsii.Number]:
|
|
5729
|
-
'''
|
|
5877
|
+
'''The specified possible maximum value of the attribute.
|
|
5730
5878
|
|
|
5731
5879
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotfleetwise-signalcatalog-attribute.html#cfn-iotfleetwise-signalcatalog-attribute-max
|
|
5732
5880
|
'''
|
|
@@ -5735,7 +5883,7 @@ class CfnSignalCatalog(
|
|
|
5735
5883
|
|
|
5736
5884
|
@builtins.property
|
|
5737
5885
|
def min(self) -> typing.Optional[jsii.Number]:
|
|
5738
|
-
'''
|
|
5886
|
+
'''The specified possible minimum value of the attribute.
|
|
5739
5887
|
|
|
5740
5888
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotfleetwise-signalcatalog-attribute.html#cfn-iotfleetwise-signalcatalog-attribute-min
|
|
5741
5889
|
'''
|
|
@@ -5744,7 +5892,7 @@ class CfnSignalCatalog(
|
|
|
5744
5892
|
|
|
5745
5893
|
@builtins.property
|
|
5746
5894
|
def unit(self) -> typing.Optional[builtins.str]:
|
|
5747
|
-
'''
|
|
5895
|
+
'''The scientific unit for the attribute.
|
|
5748
5896
|
|
|
5749
5897
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotfleetwise-signalcatalog-attribute.html#cfn-iotfleetwise-signalcatalog-attribute-unit
|
|
5750
5898
|
'''
|
|
@@ -5780,7 +5928,7 @@ class CfnSignalCatalog(
|
|
|
5780
5928
|
'''A group of signals that are defined in a hierarchical structure.
|
|
5781
5929
|
|
|
5782
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`` .
|
|
5783
|
-
:param description:
|
|
5931
|
+
:param description: A brief description of the branch.
|
|
5784
5932
|
|
|
5785
5933
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotfleetwise-signalcatalog-branch.html
|
|
5786
5934
|
:exampleMetadata: fixture=_generated
|
|
@@ -5822,7 +5970,7 @@ class CfnSignalCatalog(
|
|
|
5822
5970
|
|
|
5823
5971
|
@builtins.property
|
|
5824
5972
|
def description(self) -> typing.Optional[builtins.str]:
|
|
5825
|
-
'''
|
|
5973
|
+
'''A brief description of the branch.
|
|
5826
5974
|
|
|
5827
5975
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotfleetwise-signalcatalog-branch.html#cfn-iotfleetwise-signalcatalog-branch-description
|
|
5828
5976
|
'''
|
|
@@ -5863,11 +6011,11 @@ class CfnSignalCatalog(
|
|
|
5863
6011
|
) -> None:
|
|
5864
6012
|
'''Information about the number of nodes and node types in a vehicle network.
|
|
5865
6013
|
|
|
5866
|
-
:param total_actuators:
|
|
5867
|
-
:param total_attributes:
|
|
5868
|
-
:param total_branches:
|
|
5869
|
-
:param total_nodes:
|
|
5870
|
-
: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.
|
|
5871
6019
|
|
|
5872
6020
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotfleetwise-signalcatalog-nodecounts.html
|
|
5873
6021
|
:exampleMetadata: fixture=_generated
|
|
@@ -5907,7 +6055,7 @@ class CfnSignalCatalog(
|
|
|
5907
6055
|
|
|
5908
6056
|
@builtins.property
|
|
5909
6057
|
def total_actuators(self) -> typing.Optional[jsii.Number]:
|
|
5910
|
-
'''
|
|
6058
|
+
'''The total number of nodes in a vehicle network that represent actuators.
|
|
5911
6059
|
|
|
5912
6060
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotfleetwise-signalcatalog-nodecounts.html#cfn-iotfleetwise-signalcatalog-nodecounts-totalactuators
|
|
5913
6061
|
'''
|
|
@@ -5916,7 +6064,7 @@ class CfnSignalCatalog(
|
|
|
5916
6064
|
|
|
5917
6065
|
@builtins.property
|
|
5918
6066
|
def total_attributes(self) -> typing.Optional[jsii.Number]:
|
|
5919
|
-
'''
|
|
6067
|
+
'''The total number of nodes in a vehicle network that represent attributes.
|
|
5920
6068
|
|
|
5921
6069
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotfleetwise-signalcatalog-nodecounts.html#cfn-iotfleetwise-signalcatalog-nodecounts-totalattributes
|
|
5922
6070
|
'''
|
|
@@ -5925,7 +6073,7 @@ class CfnSignalCatalog(
|
|
|
5925
6073
|
|
|
5926
6074
|
@builtins.property
|
|
5927
6075
|
def total_branches(self) -> typing.Optional[jsii.Number]:
|
|
5928
|
-
'''
|
|
6076
|
+
'''The total number of nodes in a vehicle network that represent branches.
|
|
5929
6077
|
|
|
5930
6078
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotfleetwise-signalcatalog-nodecounts.html#cfn-iotfleetwise-signalcatalog-nodecounts-totalbranches
|
|
5931
6079
|
'''
|
|
@@ -5934,7 +6082,7 @@ class CfnSignalCatalog(
|
|
|
5934
6082
|
|
|
5935
6083
|
@builtins.property
|
|
5936
6084
|
def total_nodes(self) -> typing.Optional[jsii.Number]:
|
|
5937
|
-
'''
|
|
6085
|
+
'''The total number of nodes in a vehicle network.
|
|
5938
6086
|
|
|
5939
6087
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotfleetwise-signalcatalog-nodecounts.html#cfn-iotfleetwise-signalcatalog-nodecounts-totalnodes
|
|
5940
6088
|
'''
|
|
@@ -5943,7 +6091,7 @@ class CfnSignalCatalog(
|
|
|
5943
6091
|
|
|
5944
6092
|
@builtins.property
|
|
5945
6093
|
def total_sensors(self) -> typing.Optional[jsii.Number]:
|
|
5946
|
-
'''
|
|
6094
|
+
'''The total number of nodes in a vehicle network that represent sensors.
|
|
5947
6095
|
|
|
5948
6096
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotfleetwise-signalcatalog-nodecounts.html#cfn-iotfleetwise-signalcatalog-nodecounts-totalsensors
|
|
5949
6097
|
'''
|
|
@@ -5984,10 +6132,10 @@ class CfnSignalCatalog(
|
|
|
5984
6132
|
|
|
5985
6133
|
A node can be specified as an actuator, attribute, branch, or sensor.
|
|
5986
6134
|
|
|
5987
|
-
:param actuator:
|
|
5988
|
-
:param attribute:
|
|
5989
|
-
:param branch:
|
|
5990
|
-
: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.
|
|
5991
6139
|
|
|
5992
6140
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotfleetwise-signalcatalog-node.html
|
|
5993
6141
|
:exampleMetadata: fixture=_generated
|
|
@@ -6063,7 +6211,7 @@ class CfnSignalCatalog(
|
|
|
6063
6211
|
def actuator(
|
|
6064
6212
|
self,
|
|
6065
6213
|
) -> typing.Optional[typing.Union[_IResolvable_da3f097b, "CfnSignalCatalog.ActuatorProperty"]]:
|
|
6066
|
-
'''
|
|
6214
|
+
'''Information about a node specified as an actuator.
|
|
6067
6215
|
|
|
6068
6216
|
.. epigraph::
|
|
6069
6217
|
|
|
@@ -6078,7 +6226,7 @@ class CfnSignalCatalog(
|
|
|
6078
6226
|
def attribute(
|
|
6079
6227
|
self,
|
|
6080
6228
|
) -> typing.Optional[typing.Union[_IResolvable_da3f097b, "CfnSignalCatalog.AttributeProperty"]]:
|
|
6081
|
-
'''
|
|
6229
|
+
'''Information about a node specified as an attribute.
|
|
6082
6230
|
|
|
6083
6231
|
.. epigraph::
|
|
6084
6232
|
|
|
@@ -6093,7 +6241,7 @@ class CfnSignalCatalog(
|
|
|
6093
6241
|
def branch(
|
|
6094
6242
|
self,
|
|
6095
6243
|
) -> typing.Optional[typing.Union[_IResolvable_da3f097b, "CfnSignalCatalog.BranchProperty"]]:
|
|
6096
|
-
'''
|
|
6244
|
+
'''Information about a node specified as a branch.
|
|
6097
6245
|
|
|
6098
6246
|
.. epigraph::
|
|
6099
6247
|
|
|
@@ -6108,7 +6256,7 @@ class CfnSignalCatalog(
|
|
|
6108
6256
|
def sensor(
|
|
6109
6257
|
self,
|
|
6110
6258
|
) -> typing.Optional[typing.Union[_IResolvable_da3f097b, "CfnSignalCatalog.SensorProperty"]]:
|
|
6111
|
-
'''
|
|
6259
|
+
'''An input component that reports the environmental condition of a vehicle.
|
|
6112
6260
|
|
|
6113
6261
|
.. epigraph::
|
|
6114
6262
|
|
|
@@ -6163,11 +6311,11 @@ class CfnSignalCatalog(
|
|
|
6163
6311
|
|
|
6164
6312
|
:param data_type: The specified data type of the sensor.
|
|
6165
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`` .
|
|
6166
|
-
:param allowed_values:
|
|
6167
|
-
:param description:
|
|
6168
|
-
:param max:
|
|
6169
|
-
:param min:
|
|
6170
|
-
: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.
|
|
6171
6319
|
|
|
6172
6320
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotfleetwise-signalcatalog-sensor.html
|
|
6173
6321
|
:exampleMetadata: fixture=_generated
|
|
@@ -6238,7 +6386,7 @@ class CfnSignalCatalog(
|
|
|
6238
6386
|
|
|
6239
6387
|
@builtins.property
|
|
6240
6388
|
def allowed_values(self) -> typing.Optional[typing.List[builtins.str]]:
|
|
6241
|
-
'''
|
|
6389
|
+
'''A list of possible values a sensor can take.
|
|
6242
6390
|
|
|
6243
6391
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotfleetwise-signalcatalog-sensor.html#cfn-iotfleetwise-signalcatalog-sensor-allowedvalues
|
|
6244
6392
|
'''
|
|
@@ -6247,7 +6395,7 @@ class CfnSignalCatalog(
|
|
|
6247
6395
|
|
|
6248
6396
|
@builtins.property
|
|
6249
6397
|
def description(self) -> typing.Optional[builtins.str]:
|
|
6250
|
-
'''
|
|
6398
|
+
'''A brief description of a sensor.
|
|
6251
6399
|
|
|
6252
6400
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotfleetwise-signalcatalog-sensor.html#cfn-iotfleetwise-signalcatalog-sensor-description
|
|
6253
6401
|
'''
|
|
@@ -6256,7 +6404,7 @@ class CfnSignalCatalog(
|
|
|
6256
6404
|
|
|
6257
6405
|
@builtins.property
|
|
6258
6406
|
def max(self) -> typing.Optional[jsii.Number]:
|
|
6259
|
-
'''
|
|
6407
|
+
'''The specified possible maximum value of the sensor.
|
|
6260
6408
|
|
|
6261
6409
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotfleetwise-signalcatalog-sensor.html#cfn-iotfleetwise-signalcatalog-sensor-max
|
|
6262
6410
|
'''
|
|
@@ -6265,7 +6413,7 @@ class CfnSignalCatalog(
|
|
|
6265
6413
|
|
|
6266
6414
|
@builtins.property
|
|
6267
6415
|
def min(self) -> typing.Optional[jsii.Number]:
|
|
6268
|
-
'''
|
|
6416
|
+
'''The specified possible minimum value of the sensor.
|
|
6269
6417
|
|
|
6270
6418
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotfleetwise-signalcatalog-sensor.html#cfn-iotfleetwise-signalcatalog-sensor-min
|
|
6271
6419
|
'''
|
|
@@ -6274,7 +6422,7 @@ class CfnSignalCatalog(
|
|
|
6274
6422
|
|
|
6275
6423
|
@builtins.property
|
|
6276
6424
|
def unit(self) -> typing.Optional[builtins.str]:
|
|
6277
|
-
'''
|
|
6425
|
+
'''The scientific unit of measurement for data collected by the sensor.
|
|
6278
6426
|
|
|
6279
6427
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotfleetwise-signalcatalog-sensor.html#cfn-iotfleetwise-signalcatalog-sensor-unit
|
|
6280
6428
|
'''
|
|
@@ -6316,11 +6464,11 @@ class CfnSignalCatalogProps:
|
|
|
6316
6464
|
) -> None:
|
|
6317
6465
|
'''Properties for defining a ``CfnSignalCatalog``.
|
|
6318
6466
|
|
|
6319
|
-
:param description:
|
|
6320
|
-
:param name:
|
|
6321
|
-
:param node_counts:
|
|
6322
|
-
:param nodes:
|
|
6323
|
-
: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.
|
|
6324
6472
|
|
|
6325
6473
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotfleetwise-signalcatalog.html
|
|
6326
6474
|
:exampleMetadata: fixture=_generated
|
|
@@ -6412,7 +6560,7 @@ class CfnSignalCatalogProps:
|
|
|
6412
6560
|
|
|
6413
6561
|
@builtins.property
|
|
6414
6562
|
def description(self) -> typing.Optional[builtins.str]:
|
|
6415
|
-
'''
|
|
6563
|
+
'''A brief description of the signal catalog.
|
|
6416
6564
|
|
|
6417
6565
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotfleetwise-signalcatalog.html#cfn-iotfleetwise-signalcatalog-description
|
|
6418
6566
|
'''
|
|
@@ -6421,7 +6569,7 @@ class CfnSignalCatalogProps:
|
|
|
6421
6569
|
|
|
6422
6570
|
@builtins.property
|
|
6423
6571
|
def name(self) -> typing.Optional[builtins.str]:
|
|
6424
|
-
'''
|
|
6572
|
+
'''The name of the signal catalog.
|
|
6425
6573
|
|
|
6426
6574
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotfleetwise-signalcatalog.html#cfn-iotfleetwise-signalcatalog-name
|
|
6427
6575
|
'''
|
|
@@ -6432,7 +6580,7 @@ class CfnSignalCatalogProps:
|
|
|
6432
6580
|
def node_counts(
|
|
6433
6581
|
self,
|
|
6434
6582
|
) -> typing.Optional[typing.Union[_IResolvable_da3f097b, CfnSignalCatalog.NodeCountsProperty]]:
|
|
6435
|
-
'''
|
|
6583
|
+
'''Information about the number of nodes and node types in a vehicle network.
|
|
6436
6584
|
|
|
6437
6585
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotfleetwise-signalcatalog.html#cfn-iotfleetwise-signalcatalog-nodecounts
|
|
6438
6586
|
'''
|
|
@@ -6443,7 +6591,7 @@ class CfnSignalCatalogProps:
|
|
|
6443
6591
|
def nodes(
|
|
6444
6592
|
self,
|
|
6445
6593
|
) -> typing.Optional[typing.Union[_IResolvable_da3f097b, typing.List[typing.Union[_IResolvable_da3f097b, CfnSignalCatalog.NodeProperty]]]]:
|
|
6446
|
-
'''
|
|
6594
|
+
'''A list of information about nodes, which are a general abstraction of signals.
|
|
6447
6595
|
|
|
6448
6596
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotfleetwise-signalcatalog.html#cfn-iotfleetwise-signalcatalog-nodes
|
|
6449
6597
|
'''
|
|
@@ -6452,7 +6600,7 @@ class CfnSignalCatalogProps:
|
|
|
6452
6600
|
|
|
6453
6601
|
@builtins.property
|
|
6454
6602
|
def tags(self) -> typing.Optional[typing.List[_CfnTag_f6864754]]:
|
|
6455
|
-
'''
|
|
6603
|
+
'''Metadata that can be used to manage the signal catalog.
|
|
6456
6604
|
|
|
6457
6605
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotfleetwise-signalcatalog.html#cfn-iotfleetwise-signalcatalog-tags
|
|
6458
6606
|
'''
|
|
@@ -6471,23 +6619,23 @@ class CfnSignalCatalogProps:
|
|
|
6471
6619
|
)
|
|
6472
6620
|
|
|
6473
6621
|
|
|
6474
|
-
@jsii.implements(_IInspectable_c2943556,
|
|
6475
|
-
class
|
|
6622
|
+
@jsii.implements(_IInspectable_c2943556, _ITaggableV2_4e6798f8)
|
|
6623
|
+
class CfnStateTemplate(
|
|
6476
6624
|
_CfnResource_9df397a6,
|
|
6477
6625
|
metaclass=jsii.JSIIMeta,
|
|
6478
|
-
jsii_type="aws-cdk-lib.aws_iotfleetwise.
|
|
6626
|
+
jsii_type="aws-cdk-lib.aws_iotfleetwise.CfnStateTemplate",
|
|
6479
6627
|
):
|
|
6480
|
-
'''Creates a
|
|
6628
|
+
'''Creates a mechanism for vehicle owners to track the state of their vehicles.
|
|
6481
6629
|
|
|
6482
|
-
|
|
6483
|
-
.. epigraph::
|
|
6630
|
+
State templates determine which signal updates the vehicle sends to the cloud.
|
|
6484
6631
|
|
|
6485
|
-
|
|
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::
|
|
6486
6634
|
|
|
6487
|
-
|
|
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* .
|
|
6488
6636
|
|
|
6489
|
-
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotfleetwise-
|
|
6490
|
-
:cloudformationResource: AWS::IoTFleetWise::
|
|
6637
|
+
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotfleetwise-statetemplate.html
|
|
6638
|
+
:cloudformationResource: AWS::IoTFleetWise::StateTemplate
|
|
6491
6639
|
:exampleMetadata: fixture=_generated
|
|
6492
6640
|
|
|
6493
6641
|
Example::
|
|
@@ -6496,16 +6644,15 @@ class CfnVehicle(
|
|
|
6496
6644
|
# The values are placeholders you should change.
|
|
6497
6645
|
from aws_cdk import aws_iotfleetwise as iotfleetwise
|
|
6498
6646
|
|
|
6499
|
-
|
|
6500
|
-
decoder_manifest_arn="decoderManifestArn",
|
|
6501
|
-
model_manifest_arn="modelManifestArn",
|
|
6647
|
+
cfn_state_template = iotfleetwise.CfnStateTemplate(self, "MyCfnStateTemplate",
|
|
6502
6648
|
name="name",
|
|
6649
|
+
signal_catalog_arn="signalCatalogArn",
|
|
6650
|
+
state_template_properties=["stateTemplateProperties"],
|
|
6503
6651
|
|
|
6504
6652
|
# the properties below are optional
|
|
6505
|
-
|
|
6506
|
-
|
|
6507
|
-
|
|
6508
|
-
},
|
|
6653
|
+
data_extra_dimensions=["dataExtraDimensions"],
|
|
6654
|
+
description="description",
|
|
6655
|
+
metadata_extra_dimensions=["metadataExtraDimensions"],
|
|
6509
6656
|
tags=[CfnTag(
|
|
6510
6657
|
key="key",
|
|
6511
6658
|
value="value"
|
|
@@ -6518,33 +6665,36 @@ class CfnVehicle(
|
|
|
6518
6665
|
scope: _constructs_77d1e7e8.Construct,
|
|
6519
6666
|
id: builtins.str,
|
|
6520
6667
|
*,
|
|
6521
|
-
decoder_manifest_arn: builtins.str,
|
|
6522
|
-
model_manifest_arn: builtins.str,
|
|
6523
6668
|
name: builtins.str,
|
|
6524
|
-
|
|
6525
|
-
|
|
6669
|
+
signal_catalog_arn: builtins.str,
|
|
6670
|
+
state_template_properties: typing.Sequence[builtins.str],
|
|
6671
|
+
data_extra_dimensions: typing.Optional[typing.Sequence[builtins.str]] = None,
|
|
6672
|
+
description: typing.Optional[builtins.str] = None,
|
|
6673
|
+
metadata_extra_dimensions: typing.Optional[typing.Sequence[builtins.str]] = None,
|
|
6526
6674
|
tags: typing.Optional[typing.Sequence[typing.Union[_CfnTag_f6864754, typing.Dict[builtins.str, typing.Any]]]] = None,
|
|
6527
6675
|
) -> None:
|
|
6528
6676
|
'''
|
|
6529
6677
|
:param scope: Scope in which this resource is defined.
|
|
6530
6678
|
:param id: Construct identifier for this resource (unique in its scope).
|
|
6531
|
-
:param
|
|
6532
|
-
:param
|
|
6533
|
-
:param
|
|
6534
|
-
:param
|
|
6535
|
-
:param
|
|
6536
|
-
:param
|
|
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.
|
|
6537
6686
|
'''
|
|
6538
6687
|
if __debug__:
|
|
6539
|
-
type_hints = typing.get_type_hints(
|
|
6688
|
+
type_hints = typing.get_type_hints(_typecheckingstub__abb7c39bd72174c6927a0144336547ba8eb6d6e1a1e3b03c36137d528cc0517e)
|
|
6540
6689
|
check_type(argname="argument scope", value=scope, expected_type=type_hints["scope"])
|
|
6541
6690
|
check_type(argname="argument id", value=id, expected_type=type_hints["id"])
|
|
6542
|
-
props =
|
|
6543
|
-
decoder_manifest_arn=decoder_manifest_arn,
|
|
6544
|
-
model_manifest_arn=model_manifest_arn,
|
|
6691
|
+
props = CfnStateTemplateProps(
|
|
6545
6692
|
name=name,
|
|
6546
|
-
|
|
6547
|
-
|
|
6693
|
+
signal_catalog_arn=signal_catalog_arn,
|
|
6694
|
+
state_template_properties=state_template_properties,
|
|
6695
|
+
data_extra_dimensions=data_extra_dimensions,
|
|
6696
|
+
description=description,
|
|
6697
|
+
metadata_extra_dimensions=metadata_extra_dimensions,
|
|
6548
6698
|
tags=tags,
|
|
6549
6699
|
)
|
|
6550
6700
|
|
|
@@ -6557,7 +6707,7 @@ class CfnVehicle(
|
|
|
6557
6707
|
:param inspector: tree inspector to collect and process attributes.
|
|
6558
6708
|
'''
|
|
6559
6709
|
if __debug__:
|
|
6560
|
-
type_hints = typing.get_type_hints(
|
|
6710
|
+
type_hints = typing.get_type_hints(_typecheckingstub__023876b0892019068eae11329147db15c493a19f3c3aaa1f07c72970b12e3bda)
|
|
6561
6711
|
check_type(argname="argument inspector", value=inspector, expected_type=type_hints["inspector"])
|
|
6562
6712
|
return typing.cast(None, jsii.invoke(self, "inspect", [inspector]))
|
|
6563
6713
|
|
|
@@ -6570,7 +6720,7 @@ class CfnVehicle(
|
|
|
6570
6720
|
:param props: -
|
|
6571
6721
|
'''
|
|
6572
6722
|
if __debug__:
|
|
6573
|
-
type_hints = typing.get_type_hints(
|
|
6723
|
+
type_hints = typing.get_type_hints(_typecheckingstub__240ffae6c05a011b97e9e81ad3f007590f273d8b4efcb1e11ad4b4323e088ff0)
|
|
6574
6724
|
check_type(argname="argument props", value=props, expected_type=type_hints["props"])
|
|
6575
6725
|
return typing.cast(typing.Mapping[builtins.str, typing.Any], jsii.invoke(self, "renderProperties", [props]))
|
|
6576
6726
|
|
|
@@ -6583,7 +6733,7 @@ class CfnVehicle(
|
|
|
6583
6733
|
@builtins.property
|
|
6584
6734
|
@jsii.member(jsii_name="attrArn")
|
|
6585
6735
|
def attr_arn(self) -> builtins.str:
|
|
6586
|
-
'''The Amazon Resource Name (ARN) of the
|
|
6736
|
+
'''The Amazon Resource Name (ARN) of the state template.
|
|
6587
6737
|
|
|
6588
6738
|
:cloudformationAttribute: Arn
|
|
6589
6739
|
'''
|
|
@@ -6592,7 +6742,7 @@ class CfnVehicle(
|
|
|
6592
6742
|
@builtins.property
|
|
6593
6743
|
@jsii.member(jsii_name="attrCreationTime")
|
|
6594
6744
|
def attr_creation_time(self) -> builtins.str:
|
|
6595
|
-
'''The time the
|
|
6745
|
+
'''The time the state template was created, in seconds since epoch (January 1, 1970 at midnight UTC time).
|
|
6596
6746
|
|
|
6597
6747
|
:cloudformationAttribute: CreationTime
|
|
6598
6748
|
'''
|
|
@@ -6601,81 +6751,490 @@ class CfnVehicle(
|
|
|
6601
6751
|
@builtins.property
|
|
6602
6752
|
@jsii.member(jsii_name="attrLastModificationTime")
|
|
6603
6753
|
def attr_last_modification_time(self) -> builtins.str:
|
|
6604
|
-
'''The time the
|
|
6754
|
+
'''The time the state template was last updated, in seconds since epoch (January 1, 1970 at midnight UTC time).
|
|
6605
6755
|
|
|
6606
6756
|
:cloudformationAttribute: LastModificationTime
|
|
6607
6757
|
'''
|
|
6608
6758
|
return typing.cast(builtins.str, jsii.get(self, "attrLastModificationTime"))
|
|
6609
6759
|
|
|
6610
6760
|
@builtins.property
|
|
6611
|
-
@jsii.member(jsii_name="
|
|
6612
|
-
def
|
|
6613
|
-
return typing.cast(typing.Mapping[builtins.str, typing.Any], jsii.get(self, "cfnProperties"))
|
|
6614
|
-
|
|
6615
|
-
@builtins.property
|
|
6616
|
-
@jsii.member(jsii_name="tags")
|
|
6617
|
-
def tags(self) -> _TagManager_0a598cb3:
|
|
6761
|
+
@jsii.member(jsii_name="cdkTagManager")
|
|
6762
|
+
def cdk_tag_manager(self) -> _TagManager_0a598cb3:
|
|
6618
6763
|
'''Tag Manager which manages the tags for this resource.'''
|
|
6619
|
-
return typing.cast(_TagManager_0a598cb3, jsii.get(self, "
|
|
6620
|
-
|
|
6621
|
-
@builtins.property
|
|
6622
|
-
@jsii.member(jsii_name="decoderManifestArn")
|
|
6623
|
-
def decoder_manifest_arn(self) -> builtins.str:
|
|
6624
|
-
'''The Amazon Resource Name (ARN) of a decoder manifest associated with the vehicle to create.'''
|
|
6625
|
-
return typing.cast(builtins.str, jsii.get(self, "decoderManifestArn"))
|
|
6626
|
-
|
|
6627
|
-
@decoder_manifest_arn.setter
|
|
6628
|
-
def decoder_manifest_arn(self, value: builtins.str) -> None:
|
|
6629
|
-
if __debug__:
|
|
6630
|
-
type_hints = typing.get_type_hints(_typecheckingstub__07dfd0df1edc272a1b88da28d8fb52906df9f9da3594e4adc19e6bed64630a13)
|
|
6631
|
-
check_type(argname="argument value", value=value, expected_type=type_hints["value"])
|
|
6632
|
-
jsii.set(self, "decoderManifestArn", value) # pyright: ignore[reportArgumentType]
|
|
6764
|
+
return typing.cast(_TagManager_0a598cb3, jsii.get(self, "cdkTagManager"))
|
|
6633
6765
|
|
|
6634
6766
|
@builtins.property
|
|
6635
|
-
@jsii.member(jsii_name="
|
|
6636
|
-
def
|
|
6637
|
-
|
|
6638
|
-
return typing.cast(builtins.str, jsii.get(self, "modelManifestArn"))
|
|
6639
|
-
|
|
6640
|
-
@model_manifest_arn.setter
|
|
6641
|
-
def model_manifest_arn(self, value: builtins.str) -> None:
|
|
6642
|
-
if __debug__:
|
|
6643
|
-
type_hints = typing.get_type_hints(_typecheckingstub__44d29d9f9e6bcafa63b7a5a0e813e2a6bc9bf4dce13cba6bf0c8f3674cb8ab42)
|
|
6644
|
-
check_type(argname="argument value", value=value, expected_type=type_hints["value"])
|
|
6645
|
-
jsii.set(self, "modelManifestArn", value) # pyright: ignore[reportArgumentType]
|
|
6767
|
+
@jsii.member(jsii_name="cfnProperties")
|
|
6768
|
+
def _cfn_properties(self) -> typing.Mapping[builtins.str, typing.Any]:
|
|
6769
|
+
return typing.cast(typing.Mapping[builtins.str, typing.Any], jsii.get(self, "cfnProperties"))
|
|
6646
6770
|
|
|
6647
6771
|
@builtins.property
|
|
6648
6772
|
@jsii.member(jsii_name="name")
|
|
6649
6773
|
def name(self) -> builtins.str:
|
|
6650
|
-
'''The unique
|
|
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
|
|
6654
6778
|
def name(self, value: builtins.str) -> None:
|
|
6655
6779
|
if __debug__:
|
|
6656
|
-
type_hints = typing.get_type_hints(
|
|
6780
|
+
type_hints = typing.get_type_hints(_typecheckingstub__36385bddc5b397b7f956fb1c0b04069c9ebf5960aab30ef12f2493e28595e1f1)
|
|
6657
6781
|
check_type(argname="argument value", value=value, expected_type=type_hints["value"])
|
|
6658
6782
|
jsii.set(self, "name", value) # pyright: ignore[reportArgumentType]
|
|
6659
6783
|
|
|
6660
6784
|
@builtins.property
|
|
6661
|
-
@jsii.member(jsii_name="
|
|
6662
|
-
def
|
|
6663
|
-
'''
|
|
6664
|
-
return typing.cast(
|
|
6785
|
+
@jsii.member(jsii_name="signalCatalogArn")
|
|
6786
|
+
def signal_catalog_arn(self) -> builtins.str:
|
|
6787
|
+
'''The Amazon Resource Name (ARN) of the signal catalog associated with the state template.'''
|
|
6788
|
+
return typing.cast(builtins.str, jsii.get(self, "signalCatalogArn"))
|
|
6665
6789
|
|
|
6666
|
-
@
|
|
6667
|
-
def
|
|
6790
|
+
@signal_catalog_arn.setter
|
|
6791
|
+
def signal_catalog_arn(self, value: builtins.str) -> None:
|
|
6668
6792
|
if __debug__:
|
|
6669
|
-
type_hints = typing.get_type_hints(
|
|
6793
|
+
type_hints = typing.get_type_hints(_typecheckingstub__27a840727f29e62be6bbd510f866836050b8857803605fea1417134dea96d266)
|
|
6670
6794
|
check_type(argname="argument value", value=value, expected_type=type_hints["value"])
|
|
6671
|
-
jsii.set(self, "
|
|
6795
|
+
jsii.set(self, "signalCatalogArn", value) # pyright: ignore[reportArgumentType]
|
|
6672
6796
|
|
|
6673
6797
|
@builtins.property
|
|
6674
|
-
@jsii.member(jsii_name="
|
|
6675
|
-
def
|
|
6676
|
-
|
|
6798
|
+
@jsii.member(jsii_name="stateTemplateProperties")
|
|
6799
|
+
def state_template_properties(self) -> typing.List[builtins.str]:
|
|
6800
|
+
'''A list of signals from which data is collected.'''
|
|
6801
|
+
return typing.cast(typing.List[builtins.str], jsii.get(self, "stateTemplateProperties"))
|
|
6802
|
+
|
|
6803
|
+
@state_template_properties.setter
|
|
6804
|
+
def state_template_properties(self, value: typing.List[builtins.str]) -> None:
|
|
6805
|
+
if __debug__:
|
|
6806
|
+
type_hints = typing.get_type_hints(_typecheckingstub__5965939ee8e58624ca94131bf3a1a550feb2416fc464e55dbb973bea62bc3ea0)
|
|
6807
|
+
check_type(argname="argument value", value=value, expected_type=type_hints["value"])
|
|
6808
|
+
jsii.set(self, "stateTemplateProperties", value) # pyright: ignore[reportArgumentType]
|
|
6809
|
+
|
|
6810
|
+
@builtins.property
|
|
6811
|
+
@jsii.member(jsii_name="dataExtraDimensions")
|
|
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.'''
|
|
6814
|
+
return typing.cast(typing.Optional[typing.List[builtins.str]], jsii.get(self, "dataExtraDimensions"))
|
|
6815
|
+
|
|
6816
|
+
@data_extra_dimensions.setter
|
|
6817
|
+
def data_extra_dimensions(
|
|
6818
|
+
self,
|
|
6819
|
+
value: typing.Optional[typing.List[builtins.str]],
|
|
6820
|
+
) -> None:
|
|
6821
|
+
if __debug__:
|
|
6822
|
+
type_hints = typing.get_type_hints(_typecheckingstub__19421b7dfae3a07d6c498f1f38a62544c446c06d6e43b6a9ae138bca4a765472)
|
|
6823
|
+
check_type(argname="argument value", value=value, expected_type=type_hints["value"])
|
|
6824
|
+
jsii.set(self, "dataExtraDimensions", value) # pyright: ignore[reportArgumentType]
|
|
6825
|
+
|
|
6826
|
+
@builtins.property
|
|
6827
|
+
@jsii.member(jsii_name="description")
|
|
6828
|
+
def description(self) -> typing.Optional[builtins.str]:
|
|
6829
|
+
'''A brief description of the state template.'''
|
|
6830
|
+
return typing.cast(typing.Optional[builtins.str], jsii.get(self, "description"))
|
|
6831
|
+
|
|
6832
|
+
@description.setter
|
|
6833
|
+
def description(self, value: typing.Optional[builtins.str]) -> None:
|
|
6834
|
+
if __debug__:
|
|
6835
|
+
type_hints = typing.get_type_hints(_typecheckingstub__efec27c415a19def60c4cdf390d49a1cfe3a88e80f44e798e0a30ca90f7f44b2)
|
|
6836
|
+
check_type(argname="argument value", value=value, expected_type=type_hints["value"])
|
|
6837
|
+
jsii.set(self, "description", value) # pyright: ignore[reportArgumentType]
|
|
6838
|
+
|
|
6839
|
+
@builtins.property
|
|
6840
|
+
@jsii.member(jsii_name="metadataExtraDimensions")
|
|
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.'''
|
|
6843
|
+
return typing.cast(typing.Optional[typing.List[builtins.str]], jsii.get(self, "metadataExtraDimensions"))
|
|
6844
|
+
|
|
6845
|
+
@metadata_extra_dimensions.setter
|
|
6846
|
+
def metadata_extra_dimensions(
|
|
6847
|
+
self,
|
|
6848
|
+
value: typing.Optional[typing.List[builtins.str]],
|
|
6849
|
+
) -> None:
|
|
6850
|
+
if __debug__:
|
|
6851
|
+
type_hints = typing.get_type_hints(_typecheckingstub__54306b96085449c8906b2e1feda97b6033703ecaf9d0f0ba4130192827b1521a)
|
|
6852
|
+
check_type(argname="argument value", value=value, expected_type=type_hints["value"])
|
|
6853
|
+
jsii.set(self, "metadataExtraDimensions", value) # pyright: ignore[reportArgumentType]
|
|
6854
|
+
|
|
6855
|
+
@builtins.property
|
|
6856
|
+
@jsii.member(jsii_name="tags")
|
|
6857
|
+
def tags(self) -> typing.Optional[typing.List[_CfnTag_f6864754]]:
|
|
6858
|
+
'''Metadata that can be used to manage the state template.'''
|
|
6859
|
+
return typing.cast(typing.Optional[typing.List[_CfnTag_f6864754]], jsii.get(self, "tags"))
|
|
6860
|
+
|
|
6861
|
+
@tags.setter
|
|
6862
|
+
def tags(self, value: typing.Optional[typing.List[_CfnTag_f6864754]]) -> None:
|
|
6863
|
+
if __debug__:
|
|
6864
|
+
type_hints = typing.get_type_hints(_typecheckingstub__5ef4f2ac55a1c6e0b59ca37f1b5ee09c02856c397d9352b10181d8135c6c0f1a)
|
|
6865
|
+
check_type(argname="argument value", value=value, expected_type=type_hints["value"])
|
|
6866
|
+
jsii.set(self, "tags", value) # pyright: ignore[reportArgumentType]
|
|
6867
|
+
|
|
6868
|
+
|
|
6869
|
+
@jsii.data_type(
|
|
6870
|
+
jsii_type="aws-cdk-lib.aws_iotfleetwise.CfnStateTemplateProps",
|
|
6871
|
+
jsii_struct_bases=[],
|
|
6872
|
+
name_mapping={
|
|
6873
|
+
"name": "name",
|
|
6874
|
+
"signal_catalog_arn": "signalCatalogArn",
|
|
6875
|
+
"state_template_properties": "stateTemplateProperties",
|
|
6876
|
+
"data_extra_dimensions": "dataExtraDimensions",
|
|
6877
|
+
"description": "description",
|
|
6878
|
+
"metadata_extra_dimensions": "metadataExtraDimensions",
|
|
6879
|
+
"tags": "tags",
|
|
6880
|
+
},
|
|
6881
|
+
)
|
|
6882
|
+
class CfnStateTemplateProps:
|
|
6883
|
+
def __init__(
|
|
6884
|
+
self,
|
|
6885
|
+
*,
|
|
6886
|
+
name: builtins.str,
|
|
6887
|
+
signal_catalog_arn: builtins.str,
|
|
6888
|
+
state_template_properties: typing.Sequence[builtins.str],
|
|
6889
|
+
data_extra_dimensions: typing.Optional[typing.Sequence[builtins.str]] = None,
|
|
6890
|
+
description: typing.Optional[builtins.str] = None,
|
|
6891
|
+
metadata_extra_dimensions: typing.Optional[typing.Sequence[builtins.str]] = None,
|
|
6892
|
+
tags: typing.Optional[typing.Sequence[typing.Union[_CfnTag_f6864754, typing.Dict[builtins.str, typing.Any]]]] = None,
|
|
6893
|
+
) -> None:
|
|
6894
|
+
'''Properties for defining a ``CfnStateTemplate``.
|
|
6895
|
+
|
|
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.
|
|
6903
|
+
|
|
6904
|
+
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotfleetwise-statetemplate.html
|
|
6905
|
+
:exampleMetadata: fixture=_generated
|
|
6906
|
+
|
|
6907
|
+
Example::
|
|
6908
|
+
|
|
6909
|
+
# The code below shows an example of how to instantiate this type.
|
|
6910
|
+
# The values are placeholders you should change.
|
|
6911
|
+
from aws_cdk import aws_iotfleetwise as iotfleetwise
|
|
6912
|
+
|
|
6913
|
+
cfn_state_template_props = iotfleetwise.CfnStateTemplateProps(
|
|
6914
|
+
name="name",
|
|
6915
|
+
signal_catalog_arn="signalCatalogArn",
|
|
6916
|
+
state_template_properties=["stateTemplateProperties"],
|
|
6917
|
+
|
|
6918
|
+
# the properties below are optional
|
|
6919
|
+
data_extra_dimensions=["dataExtraDimensions"],
|
|
6920
|
+
description="description",
|
|
6921
|
+
metadata_extra_dimensions=["metadataExtraDimensions"],
|
|
6922
|
+
tags=[CfnTag(
|
|
6923
|
+
key="key",
|
|
6924
|
+
value="value"
|
|
6925
|
+
)]
|
|
6926
|
+
)
|
|
6927
|
+
'''
|
|
6928
|
+
if __debug__:
|
|
6929
|
+
type_hints = typing.get_type_hints(_typecheckingstub__d460b80d8ef556736d4731940c4f3633bb3bc5319ff699845840b25f0e684be4)
|
|
6930
|
+
check_type(argname="argument name", value=name, expected_type=type_hints["name"])
|
|
6931
|
+
check_type(argname="argument signal_catalog_arn", value=signal_catalog_arn, expected_type=type_hints["signal_catalog_arn"])
|
|
6932
|
+
check_type(argname="argument state_template_properties", value=state_template_properties, expected_type=type_hints["state_template_properties"])
|
|
6933
|
+
check_type(argname="argument data_extra_dimensions", value=data_extra_dimensions, expected_type=type_hints["data_extra_dimensions"])
|
|
6934
|
+
check_type(argname="argument description", value=description, expected_type=type_hints["description"])
|
|
6935
|
+
check_type(argname="argument metadata_extra_dimensions", value=metadata_extra_dimensions, expected_type=type_hints["metadata_extra_dimensions"])
|
|
6936
|
+
check_type(argname="argument tags", value=tags, expected_type=type_hints["tags"])
|
|
6937
|
+
self._values: typing.Dict[builtins.str, typing.Any] = {
|
|
6938
|
+
"name": name,
|
|
6939
|
+
"signal_catalog_arn": signal_catalog_arn,
|
|
6940
|
+
"state_template_properties": state_template_properties,
|
|
6941
|
+
}
|
|
6942
|
+
if data_extra_dimensions is not None:
|
|
6943
|
+
self._values["data_extra_dimensions"] = data_extra_dimensions
|
|
6944
|
+
if description is not None:
|
|
6945
|
+
self._values["description"] = description
|
|
6946
|
+
if metadata_extra_dimensions is not None:
|
|
6947
|
+
self._values["metadata_extra_dimensions"] = metadata_extra_dimensions
|
|
6948
|
+
if tags is not None:
|
|
6949
|
+
self._values["tags"] = tags
|
|
6950
|
+
|
|
6951
|
+
@builtins.property
|
|
6952
|
+
def name(self) -> builtins.str:
|
|
6953
|
+
'''The unique alias of the state template.
|
|
6954
|
+
|
|
6955
|
+
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotfleetwise-statetemplate.html#cfn-iotfleetwise-statetemplate-name
|
|
6956
|
+
'''
|
|
6957
|
+
result = self._values.get("name")
|
|
6958
|
+
assert result is not None, "Required property 'name' is missing"
|
|
6959
|
+
return typing.cast(builtins.str, result)
|
|
6960
|
+
|
|
6961
|
+
@builtins.property
|
|
6962
|
+
def signal_catalog_arn(self) -> builtins.str:
|
|
6963
|
+
'''The Amazon Resource Name (ARN) of the signal catalog associated with the state template.
|
|
6964
|
+
|
|
6965
|
+
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotfleetwise-statetemplate.html#cfn-iotfleetwise-statetemplate-signalcatalogarn
|
|
6966
|
+
'''
|
|
6967
|
+
result = self._values.get("signal_catalog_arn")
|
|
6968
|
+
assert result is not None, "Required property 'signal_catalog_arn' is missing"
|
|
6969
|
+
return typing.cast(builtins.str, result)
|
|
6970
|
+
|
|
6971
|
+
@builtins.property
|
|
6972
|
+
def state_template_properties(self) -> typing.List[builtins.str]:
|
|
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
|
+
|
|
6977
|
+
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotfleetwise-statetemplate.html#cfn-iotfleetwise-statetemplate-statetemplateproperties
|
|
6978
|
+
'''
|
|
6979
|
+
result = self._values.get("state_template_properties")
|
|
6980
|
+
assert result is not None, "Required property 'state_template_properties' is missing"
|
|
6981
|
+
return typing.cast(typing.List[builtins.str], result)
|
|
6982
|
+
|
|
6983
|
+
@builtins.property
|
|
6984
|
+
def data_extra_dimensions(self) -> typing.Optional[typing.List[builtins.str]]:
|
|
6985
|
+
'''A list of vehicle attributes associated with the payload published on the state template's MQTT topic.
|
|
6986
|
+
|
|
6987
|
+
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotfleetwise-statetemplate.html#cfn-iotfleetwise-statetemplate-dataextradimensions
|
|
6988
|
+
'''
|
|
6989
|
+
result = self._values.get("data_extra_dimensions")
|
|
6990
|
+
return typing.cast(typing.Optional[typing.List[builtins.str]], result)
|
|
6991
|
+
|
|
6992
|
+
@builtins.property
|
|
6993
|
+
def description(self) -> typing.Optional[builtins.str]:
|
|
6994
|
+
'''A brief description of the state template.
|
|
6995
|
+
|
|
6996
|
+
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotfleetwise-statetemplate.html#cfn-iotfleetwise-statetemplate-description
|
|
6997
|
+
'''
|
|
6998
|
+
result = self._values.get("description")
|
|
6999
|
+
return typing.cast(typing.Optional[builtins.str], result)
|
|
7000
|
+
|
|
7001
|
+
@builtins.property
|
|
7002
|
+
def metadata_extra_dimensions(self) -> typing.Optional[typing.List[builtins.str]]:
|
|
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
|
+
|
|
7007
|
+
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotfleetwise-statetemplate.html#cfn-iotfleetwise-statetemplate-metadataextradimensions
|
|
7008
|
+
'''
|
|
7009
|
+
result = self._values.get("metadata_extra_dimensions")
|
|
7010
|
+
return typing.cast(typing.Optional[typing.List[builtins.str]], result)
|
|
7011
|
+
|
|
7012
|
+
@builtins.property
|
|
7013
|
+
def tags(self) -> typing.Optional[typing.List[_CfnTag_f6864754]]:
|
|
7014
|
+
'''Metadata that can be used to manage the state template.
|
|
7015
|
+
|
|
7016
|
+
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotfleetwise-statetemplate.html#cfn-iotfleetwise-statetemplate-tags
|
|
7017
|
+
'''
|
|
7018
|
+
result = self._values.get("tags")
|
|
7019
|
+
return typing.cast(typing.Optional[typing.List[_CfnTag_f6864754]], result)
|
|
7020
|
+
|
|
7021
|
+
def __eq__(self, rhs: typing.Any) -> builtins.bool:
|
|
7022
|
+
return isinstance(rhs, self.__class__) and rhs._values == self._values
|
|
7023
|
+
|
|
7024
|
+
def __ne__(self, rhs: typing.Any) -> builtins.bool:
|
|
7025
|
+
return not (rhs == self)
|
|
7026
|
+
|
|
7027
|
+
def __repr__(self) -> str:
|
|
7028
|
+
return "CfnStateTemplateProps(%s)" % ", ".join(
|
|
7029
|
+
k + "=" + repr(v) for k, v in self._values.items()
|
|
7030
|
+
)
|
|
7031
|
+
|
|
7032
|
+
|
|
7033
|
+
@jsii.implements(_IInspectable_c2943556, _ITaggable_36806126)
|
|
7034
|
+
class CfnVehicle(
|
|
7035
|
+
_CfnResource_9df397a6,
|
|
7036
|
+
metaclass=jsii.JSIIMeta,
|
|
7037
|
+
jsii_type="aws-cdk-lib.aws_iotfleetwise.CfnVehicle",
|
|
7038
|
+
):
|
|
7039
|
+
'''Creates a vehicle, which is an instance of a vehicle model (model manifest).
|
|
7040
|
+
|
|
7041
|
+
Vehicles created from the same vehicle model consist of the same signals inherited from the vehicle model.
|
|
7042
|
+
.. epigraph::
|
|
7043
|
+
|
|
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.
|
|
7045
|
+
|
|
7046
|
+
For more information, see `Vehicles <https://docs.aws.amazon.com/iot-fleetwise/latest/developerguide/vehicles.html>`_ in the *AWS IoT FleetWise Developer Guide* .
|
|
7047
|
+
|
|
7048
|
+
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotfleetwise-vehicle.html
|
|
7049
|
+
:cloudformationResource: AWS::IoTFleetWise::Vehicle
|
|
7050
|
+
:exampleMetadata: fixture=_generated
|
|
7051
|
+
|
|
7052
|
+
Example::
|
|
7053
|
+
|
|
7054
|
+
# The code below shows an example of how to instantiate this type.
|
|
7055
|
+
# The values are placeholders you should change.
|
|
7056
|
+
from aws_cdk import aws_iotfleetwise as iotfleetwise
|
|
7057
|
+
|
|
7058
|
+
cfn_vehicle = iotfleetwise.CfnVehicle(self, "MyCfnVehicle",
|
|
7059
|
+
decoder_manifest_arn="decoderManifestArn",
|
|
7060
|
+
model_manifest_arn="modelManifestArn",
|
|
7061
|
+
name="name",
|
|
7062
|
+
|
|
7063
|
+
# the properties below are optional
|
|
7064
|
+
association_behavior="associationBehavior",
|
|
7065
|
+
attributes={
|
|
7066
|
+
"attributes_key": "attributes"
|
|
7067
|
+
},
|
|
7068
|
+
tags=[CfnTag(
|
|
7069
|
+
key="key",
|
|
7070
|
+
value="value"
|
|
7071
|
+
)]
|
|
7072
|
+
)
|
|
7073
|
+
'''
|
|
7074
|
+
|
|
7075
|
+
def __init__(
|
|
7076
|
+
self,
|
|
7077
|
+
scope: _constructs_77d1e7e8.Construct,
|
|
7078
|
+
id: builtins.str,
|
|
7079
|
+
*,
|
|
7080
|
+
decoder_manifest_arn: builtins.str,
|
|
7081
|
+
model_manifest_arn: builtins.str,
|
|
7082
|
+
name: builtins.str,
|
|
7083
|
+
association_behavior: typing.Optional[builtins.str] = None,
|
|
7084
|
+
attributes: typing.Optional[typing.Union[_IResolvable_da3f097b, typing.Mapping[builtins.str, builtins.str]]] = None,
|
|
7085
|
+
tags: typing.Optional[typing.Sequence[typing.Union[_CfnTag_f6864754, typing.Dict[builtins.str, typing.Any]]]] = None,
|
|
7086
|
+
) -> None:
|
|
7087
|
+
'''
|
|
7088
|
+
:param scope: Scope in which this resource is defined.
|
|
7089
|
+
:param id: Construct identifier for this resource (unique in its scope).
|
|
7090
|
+
:param decoder_manifest_arn: The Amazon Resource Name (ARN) of a decoder manifest associated with the vehicle to create.
|
|
7091
|
+
:param model_manifest_arn: The Amazon Resource Name (ARN) of the vehicle model (model manifest) to create the vehicle from.
|
|
7092
|
+
:param name: The unique ID of the vehicle.
|
|
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.
|
|
7096
|
+
'''
|
|
7097
|
+
if __debug__:
|
|
7098
|
+
type_hints = typing.get_type_hints(_typecheckingstub__c7269c48709f71a558e1053c22bd1ef391024711944714eff09133981d39ff54)
|
|
7099
|
+
check_type(argname="argument scope", value=scope, expected_type=type_hints["scope"])
|
|
7100
|
+
check_type(argname="argument id", value=id, expected_type=type_hints["id"])
|
|
7101
|
+
props = CfnVehicleProps(
|
|
7102
|
+
decoder_manifest_arn=decoder_manifest_arn,
|
|
7103
|
+
model_manifest_arn=model_manifest_arn,
|
|
7104
|
+
name=name,
|
|
7105
|
+
association_behavior=association_behavior,
|
|
7106
|
+
attributes=attributes,
|
|
7107
|
+
tags=tags,
|
|
7108
|
+
)
|
|
7109
|
+
|
|
7110
|
+
jsii.create(self.__class__, self, [scope, id, props])
|
|
7111
|
+
|
|
7112
|
+
@jsii.member(jsii_name="inspect")
|
|
7113
|
+
def inspect(self, inspector: _TreeInspector_488e0dd5) -> None:
|
|
7114
|
+
'''Examines the CloudFormation resource and discloses attributes.
|
|
7115
|
+
|
|
7116
|
+
:param inspector: tree inspector to collect and process attributes.
|
|
7117
|
+
'''
|
|
7118
|
+
if __debug__:
|
|
7119
|
+
type_hints = typing.get_type_hints(_typecheckingstub__b9b760c35be3bf4d0675af37ba807d0a1697ff44f4ca74c19616752539cb068e)
|
|
7120
|
+
check_type(argname="argument inspector", value=inspector, expected_type=type_hints["inspector"])
|
|
7121
|
+
return typing.cast(None, jsii.invoke(self, "inspect", [inspector]))
|
|
7122
|
+
|
|
7123
|
+
@jsii.member(jsii_name="renderProperties")
|
|
7124
|
+
def _render_properties(
|
|
7125
|
+
self,
|
|
7126
|
+
props: typing.Mapping[builtins.str, typing.Any],
|
|
7127
|
+
) -> typing.Mapping[builtins.str, typing.Any]:
|
|
7128
|
+
'''
|
|
7129
|
+
:param props: -
|
|
7130
|
+
'''
|
|
7131
|
+
if __debug__:
|
|
7132
|
+
type_hints = typing.get_type_hints(_typecheckingstub__95af86f45386152805565188e4a1543fd1b5baf694bb584c01d1362547cffb8a)
|
|
7133
|
+
check_type(argname="argument props", value=props, expected_type=type_hints["props"])
|
|
7134
|
+
return typing.cast(typing.Mapping[builtins.str, typing.Any], jsii.invoke(self, "renderProperties", [props]))
|
|
7135
|
+
|
|
7136
|
+
@jsii.python.classproperty
|
|
7137
|
+
@jsii.member(jsii_name="CFN_RESOURCE_TYPE_NAME")
|
|
7138
|
+
def CFN_RESOURCE_TYPE_NAME(cls) -> builtins.str:
|
|
7139
|
+
'''The CloudFormation resource type name for this resource class.'''
|
|
7140
|
+
return typing.cast(builtins.str, jsii.sget(cls, "CFN_RESOURCE_TYPE_NAME"))
|
|
7141
|
+
|
|
7142
|
+
@builtins.property
|
|
7143
|
+
@jsii.member(jsii_name="attrArn")
|
|
7144
|
+
def attr_arn(self) -> builtins.str:
|
|
7145
|
+
'''The Amazon Resource Name (ARN) of the vehicle.
|
|
7146
|
+
|
|
7147
|
+
:cloudformationAttribute: Arn
|
|
7148
|
+
'''
|
|
7149
|
+
return typing.cast(builtins.str, jsii.get(self, "attrArn"))
|
|
7150
|
+
|
|
7151
|
+
@builtins.property
|
|
7152
|
+
@jsii.member(jsii_name="attrCreationTime")
|
|
7153
|
+
def attr_creation_time(self) -> builtins.str:
|
|
7154
|
+
'''The time the vehicle was created in seconds since epoch (January 1, 1970 at midnight UTC time).
|
|
7155
|
+
|
|
7156
|
+
:cloudformationAttribute: CreationTime
|
|
7157
|
+
'''
|
|
7158
|
+
return typing.cast(builtins.str, jsii.get(self, "attrCreationTime"))
|
|
7159
|
+
|
|
7160
|
+
@builtins.property
|
|
7161
|
+
@jsii.member(jsii_name="attrLastModificationTime")
|
|
7162
|
+
def attr_last_modification_time(self) -> builtins.str:
|
|
7163
|
+
'''The time the vehicle was last updated in seconds since epoch (January 1, 1970 at midnight UTC time).
|
|
7164
|
+
|
|
7165
|
+
:cloudformationAttribute: LastModificationTime
|
|
7166
|
+
'''
|
|
7167
|
+
return typing.cast(builtins.str, jsii.get(self, "attrLastModificationTime"))
|
|
7168
|
+
|
|
7169
|
+
@builtins.property
|
|
7170
|
+
@jsii.member(jsii_name="cfnProperties")
|
|
7171
|
+
def _cfn_properties(self) -> typing.Mapping[builtins.str, typing.Any]:
|
|
7172
|
+
return typing.cast(typing.Mapping[builtins.str, typing.Any], jsii.get(self, "cfnProperties"))
|
|
7173
|
+
|
|
7174
|
+
@builtins.property
|
|
7175
|
+
@jsii.member(jsii_name="tags")
|
|
7176
|
+
def tags(self) -> _TagManager_0a598cb3:
|
|
7177
|
+
'''Tag Manager which manages the tags for this resource.'''
|
|
7178
|
+
return typing.cast(_TagManager_0a598cb3, jsii.get(self, "tags"))
|
|
7179
|
+
|
|
7180
|
+
@builtins.property
|
|
7181
|
+
@jsii.member(jsii_name="decoderManifestArn")
|
|
7182
|
+
def decoder_manifest_arn(self) -> builtins.str:
|
|
7183
|
+
'''The Amazon Resource Name (ARN) of a decoder manifest associated with the vehicle to create.'''
|
|
7184
|
+
return typing.cast(builtins.str, jsii.get(self, "decoderManifestArn"))
|
|
7185
|
+
|
|
7186
|
+
@decoder_manifest_arn.setter
|
|
7187
|
+
def decoder_manifest_arn(self, value: builtins.str) -> None:
|
|
7188
|
+
if __debug__:
|
|
7189
|
+
type_hints = typing.get_type_hints(_typecheckingstub__07dfd0df1edc272a1b88da28d8fb52906df9f9da3594e4adc19e6bed64630a13)
|
|
7190
|
+
check_type(argname="argument value", value=value, expected_type=type_hints["value"])
|
|
7191
|
+
jsii.set(self, "decoderManifestArn", value) # pyright: ignore[reportArgumentType]
|
|
7192
|
+
|
|
7193
|
+
@builtins.property
|
|
7194
|
+
@jsii.member(jsii_name="modelManifestArn")
|
|
7195
|
+
def model_manifest_arn(self) -> builtins.str:
|
|
7196
|
+
'''The Amazon Resource Name (ARN) of the vehicle model (model manifest) to create the vehicle from.'''
|
|
7197
|
+
return typing.cast(builtins.str, jsii.get(self, "modelManifestArn"))
|
|
7198
|
+
|
|
7199
|
+
@model_manifest_arn.setter
|
|
7200
|
+
def model_manifest_arn(self, value: builtins.str) -> None:
|
|
7201
|
+
if __debug__:
|
|
7202
|
+
type_hints = typing.get_type_hints(_typecheckingstub__44d29d9f9e6bcafa63b7a5a0e813e2a6bc9bf4dce13cba6bf0c8f3674cb8ab42)
|
|
7203
|
+
check_type(argname="argument value", value=value, expected_type=type_hints["value"])
|
|
7204
|
+
jsii.set(self, "modelManifestArn", value) # pyright: ignore[reportArgumentType]
|
|
7205
|
+
|
|
7206
|
+
@builtins.property
|
|
7207
|
+
@jsii.member(jsii_name="name")
|
|
7208
|
+
def name(self) -> builtins.str:
|
|
7209
|
+
'''The unique ID of the vehicle.'''
|
|
7210
|
+
return typing.cast(builtins.str, jsii.get(self, "name"))
|
|
7211
|
+
|
|
7212
|
+
@name.setter
|
|
7213
|
+
def name(self, value: builtins.str) -> None:
|
|
7214
|
+
if __debug__:
|
|
7215
|
+
type_hints = typing.get_type_hints(_typecheckingstub__4505759fcded180f5aeb7d85f70fe4449363a0030d04d86046e82cc83a56ab92)
|
|
7216
|
+
check_type(argname="argument value", value=value, expected_type=type_hints["value"])
|
|
7217
|
+
jsii.set(self, "name", value) # pyright: ignore[reportArgumentType]
|
|
7218
|
+
|
|
7219
|
+
@builtins.property
|
|
7220
|
+
@jsii.member(jsii_name="associationBehavior")
|
|
7221
|
+
def association_behavior(self) -> typing.Optional[builtins.str]:
|
|
7222
|
+
'''An option to create a new AWS IoT thing when creating a vehicle, or to validate an existing thing as a vehicle.'''
|
|
7223
|
+
return typing.cast(typing.Optional[builtins.str], jsii.get(self, "associationBehavior"))
|
|
7224
|
+
|
|
7225
|
+
@association_behavior.setter
|
|
7226
|
+
def association_behavior(self, value: typing.Optional[builtins.str]) -> None:
|
|
7227
|
+
if __debug__:
|
|
7228
|
+
type_hints = typing.get_type_hints(_typecheckingstub__58744563e98ef419016bcbd09088b8ed734d062980dbe0b3fa2e4ff0fe8f722d)
|
|
7229
|
+
check_type(argname="argument value", value=value, expected_type=type_hints["value"])
|
|
7230
|
+
jsii.set(self, "associationBehavior", value) # pyright: ignore[reportArgumentType]
|
|
7231
|
+
|
|
7232
|
+
@builtins.property
|
|
7233
|
+
@jsii.member(jsii_name="attributes")
|
|
7234
|
+
def attributes(
|
|
7235
|
+
self,
|
|
6677
7236
|
) -> typing.Optional[typing.Union[_IResolvable_da3f097b, typing.Mapping[builtins.str, builtins.str]]]:
|
|
6678
|
-
'''
|
|
7237
|
+
'''Static information about a vehicle in a key-value pair.'''
|
|
6679
7238
|
return typing.cast(typing.Optional[typing.Union[_IResolvable_da3f097b, typing.Mapping[builtins.str, builtins.str]]], jsii.get(self, "attributes"))
|
|
6680
7239
|
|
|
6681
7240
|
@attributes.setter
|
|
@@ -6691,7 +7250,7 @@ class CfnVehicle(
|
|
|
6691
7250
|
@builtins.property
|
|
6692
7251
|
@jsii.member(jsii_name="tagsRaw")
|
|
6693
7252
|
def tags_raw(self) -> typing.Optional[typing.List[_CfnTag_f6864754]]:
|
|
6694
|
-
'''
|
|
7253
|
+
'''Metadata which can be used to manage the vehicle.'''
|
|
6695
7254
|
return typing.cast(typing.Optional[typing.List[_CfnTag_f6864754]], jsii.get(self, "tagsRaw"))
|
|
6696
7255
|
|
|
6697
7256
|
@tags_raw.setter
|
|
@@ -6730,9 +7289,9 @@ class CfnVehicleProps:
|
|
|
6730
7289
|
:param decoder_manifest_arn: The Amazon Resource Name (ARN) of a decoder manifest associated with the vehicle to create.
|
|
6731
7290
|
:param model_manifest_arn: The Amazon Resource Name (ARN) of the vehicle model (model manifest) to create the vehicle from.
|
|
6732
7291
|
:param name: The unique ID of the vehicle.
|
|
6733
|
-
:param association_behavior:
|
|
6734
|
-
:param attributes:
|
|
6735
|
-
: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.
|
|
6736
7295
|
|
|
6737
7296
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotfleetwise-vehicle.html
|
|
6738
7297
|
:exampleMetadata: fixture=_generated
|
|
@@ -6811,7 +7370,7 @@ class CfnVehicleProps:
|
|
|
6811
7370
|
|
|
6812
7371
|
@builtins.property
|
|
6813
7372
|
def association_behavior(self) -> typing.Optional[builtins.str]:
|
|
6814
|
-
'''
|
|
7373
|
+
'''An option to create a new AWS IoT thing when creating a vehicle, or to validate an existing thing as a vehicle.
|
|
6815
7374
|
|
|
6816
7375
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotfleetwise-vehicle.html#cfn-iotfleetwise-vehicle-associationbehavior
|
|
6817
7376
|
'''
|
|
@@ -6822,7 +7381,7 @@ class CfnVehicleProps:
|
|
|
6822
7381
|
def attributes(
|
|
6823
7382
|
self,
|
|
6824
7383
|
) -> typing.Optional[typing.Union[_IResolvable_da3f097b, typing.Mapping[builtins.str, builtins.str]]]:
|
|
6825
|
-
'''
|
|
7384
|
+
'''Static information about a vehicle in a key-value pair.
|
|
6826
7385
|
|
|
6827
7386
|
For example: ``"engine Type"`` : ``"v6"``
|
|
6828
7387
|
|
|
@@ -6833,7 +7392,7 @@ class CfnVehicleProps:
|
|
|
6833
7392
|
|
|
6834
7393
|
@builtins.property
|
|
6835
7394
|
def tags(self) -> typing.Optional[typing.List[_CfnTag_f6864754]]:
|
|
6836
|
-
'''
|
|
7395
|
+
'''Metadata which can be used to manage the vehicle.
|
|
6837
7396
|
|
|
6838
7397
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotfleetwise-vehicle.html#cfn-iotfleetwise-vehicle-tags
|
|
6839
7398
|
'''
|
|
@@ -6863,6 +7422,8 @@ __all__ = [
|
|
|
6863
7422
|
"CfnModelManifestProps",
|
|
6864
7423
|
"CfnSignalCatalog",
|
|
6865
7424
|
"CfnSignalCatalogProps",
|
|
7425
|
+
"CfnStateTemplate",
|
|
7426
|
+
"CfnStateTemplateProps",
|
|
6866
7427
|
"CfnVehicle",
|
|
6867
7428
|
"CfnVehicleProps",
|
|
6868
7429
|
]
|
|
@@ -7198,6 +7759,7 @@ def _typecheckingstub__bd0d8efce6baca0fa606fb0cf95bebcdeda196fcde2fb7e1854233433
|
|
|
7198
7759
|
*,
|
|
7199
7760
|
model_manifest_arn: builtins.str,
|
|
7200
7761
|
name: builtins.str,
|
|
7762
|
+
default_for_unmapped_signals: typing.Optional[builtins.str] = None,
|
|
7201
7763
|
description: typing.Optional[builtins.str] = None,
|
|
7202
7764
|
network_interfaces: typing.Optional[typing.Union[_IResolvable_da3f097b, typing.Sequence[typing.Union[_IResolvable_da3f097b, typing.Union[CfnDecoderManifest.NetworkInterfacesItemsProperty, typing.Dict[builtins.str, typing.Any]]]]]] = None,
|
|
7203
7765
|
signal_decoders: typing.Optional[typing.Union[_IResolvable_da3f097b, typing.Sequence[typing.Union[_IResolvable_da3f097b, typing.Union[CfnDecoderManifest.SignalDecodersItemsProperty, typing.Dict[builtins.str, typing.Any]]]]]] = None,
|
|
@@ -7231,6 +7793,12 @@ def _typecheckingstub__9a5a43cce0da85f8ef5934babccfc93088317c19ae303a38ae3adc573
|
|
|
7231
7793
|
"""Type checking stubs"""
|
|
7232
7794
|
pass
|
|
7233
7795
|
|
|
7796
|
+
def _typecheckingstub__3d210b3f11bc1efe8c19f629b502c0e1e1fbcf1c23ae2d514eb28d3b59482cfc(
|
|
7797
|
+
value: typing.Optional[builtins.str],
|
|
7798
|
+
) -> None:
|
|
7799
|
+
"""Type checking stubs"""
|
|
7800
|
+
pass
|
|
7801
|
+
|
|
7234
7802
|
def _typecheckingstub__b1e4501ad7312a6dac9b29817aed239a25a724386677541e036223da190a2d9b(
|
|
7235
7803
|
value: typing.Optional[builtins.str],
|
|
7236
7804
|
) -> None:
|
|
@@ -7375,6 +7943,7 @@ def _typecheckingstub__1be5cfb3ca0441a2fdb0856303c08c4449592f7472588f5c0659c42af
|
|
|
7375
7943
|
*,
|
|
7376
7944
|
model_manifest_arn: builtins.str,
|
|
7377
7945
|
name: builtins.str,
|
|
7946
|
+
default_for_unmapped_signals: typing.Optional[builtins.str] = None,
|
|
7378
7947
|
description: typing.Optional[builtins.str] = None,
|
|
7379
7948
|
network_interfaces: typing.Optional[typing.Union[_IResolvable_da3f097b, typing.Sequence[typing.Union[_IResolvable_da3f097b, typing.Union[CfnDecoderManifest.NetworkInterfacesItemsProperty, typing.Dict[builtins.str, typing.Any]]]]]] = None,
|
|
7380
7949
|
signal_decoders: typing.Optional[typing.Union[_IResolvable_da3f097b, typing.Sequence[typing.Union[_IResolvable_da3f097b, typing.Union[CfnDecoderManifest.SignalDecodersItemsProperty, typing.Dict[builtins.str, typing.Any]]]]]] = None,
|
|
@@ -7653,6 +8222,88 @@ def _typecheckingstub__9bd41091fa8f71325a3bfb8a9da99b2637a4ed068a31b5c7427bae209
|
|
|
7653
8222
|
"""Type checking stubs"""
|
|
7654
8223
|
pass
|
|
7655
8224
|
|
|
8225
|
+
def _typecheckingstub__abb7c39bd72174c6927a0144336547ba8eb6d6e1a1e3b03c36137d528cc0517e(
|
|
8226
|
+
scope: _constructs_77d1e7e8.Construct,
|
|
8227
|
+
id: builtins.str,
|
|
8228
|
+
*,
|
|
8229
|
+
name: builtins.str,
|
|
8230
|
+
signal_catalog_arn: builtins.str,
|
|
8231
|
+
state_template_properties: typing.Sequence[builtins.str],
|
|
8232
|
+
data_extra_dimensions: typing.Optional[typing.Sequence[builtins.str]] = None,
|
|
8233
|
+
description: typing.Optional[builtins.str] = None,
|
|
8234
|
+
metadata_extra_dimensions: typing.Optional[typing.Sequence[builtins.str]] = None,
|
|
8235
|
+
tags: typing.Optional[typing.Sequence[typing.Union[_CfnTag_f6864754, typing.Dict[builtins.str, typing.Any]]]] = None,
|
|
8236
|
+
) -> None:
|
|
8237
|
+
"""Type checking stubs"""
|
|
8238
|
+
pass
|
|
8239
|
+
|
|
8240
|
+
def _typecheckingstub__023876b0892019068eae11329147db15c493a19f3c3aaa1f07c72970b12e3bda(
|
|
8241
|
+
inspector: _TreeInspector_488e0dd5,
|
|
8242
|
+
) -> None:
|
|
8243
|
+
"""Type checking stubs"""
|
|
8244
|
+
pass
|
|
8245
|
+
|
|
8246
|
+
def _typecheckingstub__240ffae6c05a011b97e9e81ad3f007590f273d8b4efcb1e11ad4b4323e088ff0(
|
|
8247
|
+
props: typing.Mapping[builtins.str, typing.Any],
|
|
8248
|
+
) -> None:
|
|
8249
|
+
"""Type checking stubs"""
|
|
8250
|
+
pass
|
|
8251
|
+
|
|
8252
|
+
def _typecheckingstub__36385bddc5b397b7f956fb1c0b04069c9ebf5960aab30ef12f2493e28595e1f1(
|
|
8253
|
+
value: builtins.str,
|
|
8254
|
+
) -> None:
|
|
8255
|
+
"""Type checking stubs"""
|
|
8256
|
+
pass
|
|
8257
|
+
|
|
8258
|
+
def _typecheckingstub__27a840727f29e62be6bbd510f866836050b8857803605fea1417134dea96d266(
|
|
8259
|
+
value: builtins.str,
|
|
8260
|
+
) -> None:
|
|
8261
|
+
"""Type checking stubs"""
|
|
8262
|
+
pass
|
|
8263
|
+
|
|
8264
|
+
def _typecheckingstub__5965939ee8e58624ca94131bf3a1a550feb2416fc464e55dbb973bea62bc3ea0(
|
|
8265
|
+
value: typing.List[builtins.str],
|
|
8266
|
+
) -> None:
|
|
8267
|
+
"""Type checking stubs"""
|
|
8268
|
+
pass
|
|
8269
|
+
|
|
8270
|
+
def _typecheckingstub__19421b7dfae3a07d6c498f1f38a62544c446c06d6e43b6a9ae138bca4a765472(
|
|
8271
|
+
value: typing.Optional[typing.List[builtins.str]],
|
|
8272
|
+
) -> None:
|
|
8273
|
+
"""Type checking stubs"""
|
|
8274
|
+
pass
|
|
8275
|
+
|
|
8276
|
+
def _typecheckingstub__efec27c415a19def60c4cdf390d49a1cfe3a88e80f44e798e0a30ca90f7f44b2(
|
|
8277
|
+
value: typing.Optional[builtins.str],
|
|
8278
|
+
) -> None:
|
|
8279
|
+
"""Type checking stubs"""
|
|
8280
|
+
pass
|
|
8281
|
+
|
|
8282
|
+
def _typecheckingstub__54306b96085449c8906b2e1feda97b6033703ecaf9d0f0ba4130192827b1521a(
|
|
8283
|
+
value: typing.Optional[typing.List[builtins.str]],
|
|
8284
|
+
) -> None:
|
|
8285
|
+
"""Type checking stubs"""
|
|
8286
|
+
pass
|
|
8287
|
+
|
|
8288
|
+
def _typecheckingstub__5ef4f2ac55a1c6e0b59ca37f1b5ee09c02856c397d9352b10181d8135c6c0f1a(
|
|
8289
|
+
value: typing.Optional[typing.List[_CfnTag_f6864754]],
|
|
8290
|
+
) -> None:
|
|
8291
|
+
"""Type checking stubs"""
|
|
8292
|
+
pass
|
|
8293
|
+
|
|
8294
|
+
def _typecheckingstub__d460b80d8ef556736d4731940c4f3633bb3bc5319ff699845840b25f0e684be4(
|
|
8295
|
+
*,
|
|
8296
|
+
name: builtins.str,
|
|
8297
|
+
signal_catalog_arn: builtins.str,
|
|
8298
|
+
state_template_properties: typing.Sequence[builtins.str],
|
|
8299
|
+
data_extra_dimensions: typing.Optional[typing.Sequence[builtins.str]] = None,
|
|
8300
|
+
description: typing.Optional[builtins.str] = None,
|
|
8301
|
+
metadata_extra_dimensions: typing.Optional[typing.Sequence[builtins.str]] = None,
|
|
8302
|
+
tags: typing.Optional[typing.Sequence[typing.Union[_CfnTag_f6864754, typing.Dict[builtins.str, typing.Any]]]] = None,
|
|
8303
|
+
) -> None:
|
|
8304
|
+
"""Type checking stubs"""
|
|
8305
|
+
pass
|
|
8306
|
+
|
|
7656
8307
|
def _typecheckingstub__c7269c48709f71a558e1053c22bd1ef391024711944714eff09133981d39ff54(
|
|
7657
8308
|
scope: _constructs_77d1e7e8.Construct,
|
|
7658
8309
|
id: builtins.str,
|