CustomProperty - AWS IoT FleetWise

CustomProperty

Represents a member of the complex data structure. The data type of the property can be either primitive or another struct.

Contents

dataType

The data type for the custom property.

Type: String

Valid Values: INT8 | UINT8 | INT16 | UINT16 | INT32 | UINT32 | INT64 | UINT64 | BOOLEAN | FLOAT | DOUBLE | STRING | UNIX_TIMESTAMP | INT8_ARRAY | UINT8_ARRAY | INT16_ARRAY | UINT16_ARRAY | INT32_ARRAY | UINT32_ARRAY | INT64_ARRAY | UINT64_ARRAY | BOOLEAN_ARRAY | FLOAT_ARRAY | DOUBLE_ARRAY | STRING_ARRAY | UNIX_TIMESTAMP_ARRAY | UNKNOWN | STRUCT | STRUCT_ARRAY

Required: Yes

fullyQualifiedName

The fully qualified name of the custom property. For example, the fully qualified name of a custom property might be ComplexDataTypes.VehicleDataTypes.SVMCamera.FPS.

Type: String

Required: Yes

comment

A comment in addition to the description.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 2048.

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

Required: No

dataEncoding

Indicates whether the property is binary data.

Type: String

Valid Values: BINARY | TYPED

Required: No

deprecationMessage

The deprecation message for the node or the branch that was moved or deleted.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 2048.

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

Required: No

description

A brief description of the custom property.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 2048.

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

Required: No

structFullyQualifiedName

The fully qualified name of the struct node for the custom property if the data type of the custom property is Struct or StructArray.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 150.

Pattern: [a-zA-Z0-9_.]+

Required: No

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: