Creates a vehicle, which is an instance of a vehicle model (model manifest). Vehicles created from the same vehicle model consist of the same signals inherited from the vehicle model.
Note
If you have an existing AWS IoT thing, you can use AWS IoT FleetWise to create a vehicle and collect data from your thing.
For more information, see Vehicles 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::Vehicle",
"Properties" : {
"AssociationBehavior" : String,
"Attributes" : {Key: Value, ...},
"DecoderManifestArn" : String,
"ModelManifestArn" : String,
"Name" : String,
"StateTemplates" : [ StateTemplateAssociation, ... ],
"Tags" : [ Tag, ... ]
}
}
YAML
Type: AWS::IoTFleetWise::Vehicle
Properties:
AssociationBehavior: String
Attributes:
Key: Value
DecoderManifestArn: String
ModelManifestArn: String
Name: String
StateTemplates:
- StateTemplateAssociation
Tags:
- Tag
Properties
AssociationBehavior-
An option to create a new AWS IoT thing when creating a vehicle, or to validate an existing thing as a vehicle.
Required: No
Type: String
Allowed values:
CreateIotThing | ValidateIotThingExistsUpdate requires: No interruption
Attributes-
Static information about a vehicle in a key-value pair. For example:
"engine Type":"v6"Required: No
Type: Object of String
Pattern:
^[a-zA-Z0-9_.-]+$Update requires: No interruption
DecoderManifestArn-
The Amazon Resource Name (ARN) of a decoder manifest associated with the vehicle to create.
Required: Yes
Type: String
Update requires: No interruption
ModelManifestArn-
The Amazon Resource Name (ARN) of the vehicle model (model manifest) to create the vehicle from.
Required: Yes
Type: String
Update requires: No interruption
Name-
The unique ID of the vehicle.
Required: Yes
Type: String
Pattern:
^[a-zA-Z\d\-_:]+$Minimum:
1Maximum:
100Update requires: Replacement
StateTemplates-
Associate state templates to track the state of the vehicle. State templates determine which signal updates the vehicle sends to the cloud.
Required: No
Type: Array of StateTemplateAssociation
Minimum:
0Maximum:
20Update requires: No interruption
-
Metadata which can be used to manage the vehicle.
Required: No
Type: Array of Tag
Minimum:
0Maximum:
50Update requires: No interruption
Return values
Ref
When you pass the logical ID of this resource to the intrinsic Ref function, Ref returns the Name.
For more information about using the Ref function, see Ref.
Fn::GetAtt
The Fn::GetAtt intrinsic function returns a value for a specified attribute of this type. The following are the available attributes and sample return values.
For more information about using the Fn::GetAtt intrinsic function, see Fn::GetAtt.
Arn-
The Amazon Resource Name (ARN) of the vehicle.
CreationTime-
The time the vehicle was created in seconds since epoch (January 1, 1970 at midnight UTC time).
LastModificationTime-
The time the vehicle was last updated in seconds since epoch (January 1, 1970 at midnight UTC time).
