AWS::IoTFleetWise::StateTemplate - AWS CloudFormation
SyntaxPropertiesReturn values

AWS::IoTFleetWise::StateTemplate

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 in the AWS IoT FleetWise Developer Guide.

Important

Access to certain AWS IoT FleetWise features is currently gated. For more information, see AWS Region and feature availability in the AWS IoT FleetWise Developer Guide.

Syntax

To declare this entity in your AWS CloudFormation template, use the following syntax:

JSON

{
  "Type" : "AWS::IoTFleetWise::StateTemplate",
  "Properties" : {
      "DataExtraDimensions" : [ String, ... ],
      "Description" : String,
      "MetadataExtraDimensions" : [ String, ... ],
      "Name" : String,
      "SignalCatalogArn" : String,
      "StateTemplateProperties" : [ String, ... ],
      "Tags" : [ Tag, ... ]
    }
}

YAML

Type: AWS::IoTFleetWise::StateTemplate
Properties:
  DataExtraDimensions: 
    - String
  Description: String
  MetadataExtraDimensions: 
    - String
  Name: String
  SignalCatalogArn: String
  StateTemplateProperties: 
    - String
  Tags: 
    - Tag

Properties

DataExtraDimensions

A list of vehicle attributes associated with the payload published on the state template's MQTT topic.

Required: No

Type: Array of String

Minimum: 1 | 0

Maximum: 150 | 5

Update requires: No interruption

Description

A brief description of the state template.

Required: No

Type: String

Pattern: ^[^\u0000-\u001F\u007F]+$

Minimum: 1

Maximum: 2048

Update requires: No interruption

MetadataExtraDimensions

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.

Required: No

Type: Array of String

Minimum: 1 | 0

Maximum: 150 | 5

Update requires: No interruption

Name

The unique alias of the state template.

Required: Yes

Type: String

Pattern: ^[a-zA-Z\d\-_:]+$

Minimum: 1

Maximum: 100

Update requires: Replacement

SignalCatalogArn

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

Required: Yes

Type: String

Update requires: Replacement

StateTemplateProperties

A list of signals from which data is collected. The state template properties contain the fully qualified names of the signals.

Required: Yes

Type: Array of String

Minimum: 1 | 1

Maximum: 150 | 500

Update requires: No interruption

Tags

Metadata that can be used to manage the state template.

Required: No

Type: Array of Tag

Minimum: 0

Maximum: 50

Update requires: No interruption

Return values

Ref

Fn::GetAtt

Arn

The Amazon Resource Name (ARN) of the state template.

CreationTime

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

LastModificationTime

The time the state template was last updated, in seconds since epoch (January 1, 1970 at midnight UTC time).