AWS::IoTFleetWise::DecoderManifest - AWS CloudFormation

AWS::IoTFleetWise::DecoderManifest

Creates the decoder manifest associated with a model manifest. To create a decoder manifest, the following must be true:

  • Every signal decoder has a unique name.

  • Each signal decoder is associated with a network interface.

  • Each network interface has a unique ID.

  • The signal decoders are specified in the model manifest.

For more information, see Decoder manifests 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::DecoderManifest", "Properties" : { "DefaultForUnmappedSignals" : String, "Description" : String, "ModelManifestArn" : String, "Name" : String, "NetworkInterfaces" : [ NetworkInterfacesItems, ... ], "SignalDecoders" : [ SignalDecodersItems, ... ], "Status" : String, "Tags" : [ Tag, ... ] } }

YAML

Type: AWS::IoTFleetWise::DecoderManifest Properties: DefaultForUnmappedSignals: String Description: String ModelManifestArn: String Name: String NetworkInterfaces: - NetworkInterfacesItems SignalDecoders: - SignalDecodersItems Status: String Tags: - Tag

Properties

DefaultForUnmappedSignals

Use default decoders for all unmapped signals in the model. You don't need to provide any detailed decoding information.

Required: No

Type: String

Allowed values: CUSTOM_DECODING

Update requires: No interruption

Description

A brief description of the decoder manifest.

Required: No

Type: String

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

Minimum: 1

Maximum: 2048

Update requires: No interruption

ModelManifestArn

The Amazon Resource Name (ARN) of a vehicle model (model manifest) associated with the decoder manifest.

Required: Yes

Type: String

Update requires: Replacement

Name

The name of the decoder manifest.

Required: Yes

Type: String

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

Minimum: 1

Maximum: 100

Update requires: Replacement

NetworkInterfaces

A list of information about available network interfaces.

Required: No

Type: Array of NetworkInterfacesItems

Minimum: 1

Maximum: 5000

Update requires: No interruption

SignalDecoders

A list of information about signal decoders.

Required: No

Type: Array of SignalDecodersItems

Minimum: 1

Maximum: 5000

Update requires: No interruption

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.

Required: No

Type: String

Allowed values: ACTIVE | DRAFT

Update requires: No interruption

Tags

Metadata that can be used to manage the decoder manifest.

Required: No

Type: Array of Tag

Minimum: 0

Maximum: 50

Update 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 decoder manifest.

CreationTime

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

LastModificationTime

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