AWS::IoTFleetWise::StateTemplateCfnStateTemplate
Creates a mechanism for vehicle owners to track the state of their vehicles. State templates determine which signal updates the vehicle sends to the cloud. 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* . > 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* .
Import
import { CfnStateTemplate } from 'aws-cdk-lib/aws-iotfleetwise';Or use the module namespace:
import * as iotfleetwise from 'aws-cdk-lib/aws-iotfleetwise';
// iotfleetwise.CfnStateTemplateProperties
Configuration passed to the constructor as CfnStateTemplateProps.
nameRequiredstringThe unique alias of the state template.
signalCatalogArnRequiredstringThe Amazon Resource Name (ARN) of the signal catalog associated with the state template.
stateTemplatePropertiesRequiredstring[]A list of signals from which data is collected. The state template properties contain the fully qualified names of the signals.
dataExtraDimensionsOptionalstring[]A list of vehicle attributes associated with the payload published on the state template's MQTT topic.
descriptionOptionalstringA brief description of the state template.
metadataExtraDimensionsOptionalstring[]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.
tagsOptionalCfnTag[]Metadata that can be used to manage the state template.
CloudFormation Resource
This L1 construct maps directly to the following CloudFormation resource type.
Learn AWS the Practical Way
Our bi-weekly newsletter teaches hands-on AWS fundamentals. No certification fluff - just practical knowledge.
Subscribe to NewsletterQuick Facts
aws-iotfleetwiseAWS::IoTFleetWise::StateTemplate