Class CfnDecoderManifestProps

Properties for defining a CfnDecoderManifest.

Inheritance

object

CfnDecoderManifestProps

Implements

ICfnDecoderManifestProps

Inherited Members

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Namespace: Amazon.CDK.AWS.IoTFleetWise

Assembly: Amazon.CDK.Lib.dll

Syntax (csharp)

public class CfnDecoderManifestProps : ICfnDecoderManifestProps

Syntax (vb)

Public Class CfnDecoderManifestProps Implements ICfnDecoderManifestProps

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotfleetwise-decodermanifest.html

ExampleMetadata: fixture=_generated

Examples

// The code below shows an example of how to instantiate this type.
             // The values are placeholders you should change.
             using Amazon.CDK.AWS.IoTFleetWise;

             var cfnDecoderManifestProps = new CfnDecoderManifestProps {
                 ModelManifestArn = "modelManifestArn",
                 Name = "name",

                 // the properties below are optional
                 DefaultForUnmappedSignals = "defaultForUnmappedSignals",
                 Description = "description",
                 NetworkInterfaces = new [] { new NetworkInterfacesItemsProperty {
                     InterfaceId = "interfaceId",
                     Type = "type",

                     // the properties below are optional
                     CanInterface = new CanInterfaceProperty {
                         Name = "name",

                         // the properties below are optional
                         ProtocolName = "protocolName",
                         ProtocolVersion = "protocolVersion"
                     },
                     ObdInterface = new ObdInterfaceProperty {
                         Name = "name",
                         RequestMessageId = "requestMessageId",

                         // the properties below are optional
                         DtcRequestIntervalSeconds = "dtcRequestIntervalSeconds",
                         HasTransmissionEcu = "hasTransmissionEcu",
                         ObdStandard = "obdStandard",
                         PidRequestIntervalSeconds = "pidRequestIntervalSeconds",
                         UseExtendedIds = "useExtendedIds"
                     }
                 } },
                 SignalDecoders = new [] { new SignalDecodersItemsProperty {
                     FullyQualifiedName = "fullyQualifiedName",
                     InterfaceId = "interfaceId",
                     Type = "type",

                     // the properties below are optional
                     CanSignal = new CanSignalProperty {
                         Factor = "factor",
                         IsBigEndian = "isBigEndian",
                         IsSigned = "isSigned",
                         Length = "length",
                         MessageId = "messageId",
                         Offset = "offset",
                         StartBit = "startBit",

                         // the properties below are optional
                         Name = "name",
                         SignalValueType = "signalValueType"
                     },
                     ObdSignal = new ObdSignalProperty {
                         ByteLength = "byteLength",
                         Offset = "offset",
                         Pid = "pid",
                         PidResponseLength = "pidResponseLength",
                         Scaling = "scaling",
                         ServiceMode = "serviceMode",
                         StartByte = "startByte",

                         // the properties below are optional
                         BitMaskLength = "bitMaskLength",
                         BitRightShift = "bitRightShift",
                         IsSigned = "isSigned",
                         SignalValueType = "signalValueType"
                     }
                 } },
                 Status = "status",
                 Tags = new [] { new CfnTag {
                     Key = "key",
                     Value = "value"
                 } }
             };

Synopsis

Constructors

CfnDecoderManifestProps()

Properties for defining a CfnDecoderManifest.

Properties

DefaultForUnmappedSignals	Use default decoders for all unmapped signals in the model.
Description	A brief description of the decoder manifest.
ModelManifestArn	The Amazon Resource Name (ARN) of a vehicle model (model manifest) associated with the decoder manifest.
Name	The name of the decoder manifest.
NetworkInterfaces	A list of information about available network interfaces.
SignalDecoders	A list of information about signal decoders.
Status	The state of the decoder manifest.
Tags	Metadata that can be used to manage the decoder manifest.

Constructors

CfnDecoderManifestProps()

Properties for defining a CfnDecoderManifest.

public CfnDecoderManifestProps()

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotfleetwise-decodermanifest.html

ExampleMetadata: fixture=_generated

Examples

// The code below shows an example of how to instantiate this type.
             // The values are placeholders you should change.
             using Amazon.CDK.AWS.IoTFleetWise;

             var cfnDecoderManifestProps = new CfnDecoderManifestProps {
                 ModelManifestArn = "modelManifestArn",
                 Name = "name",

                 // the properties below are optional
                 DefaultForUnmappedSignals = "defaultForUnmappedSignals",
                 Description = "description",
                 NetworkInterfaces = new [] { new NetworkInterfacesItemsProperty {
                     InterfaceId = "interfaceId",
                     Type = "type",

                     // the properties below are optional
                     CanInterface = new CanInterfaceProperty {
                         Name = "name",

                         // the properties below are optional
                         ProtocolName = "protocolName",
                         ProtocolVersion = "protocolVersion"
                     },
                     ObdInterface = new ObdInterfaceProperty {
                         Name = "name",
                         RequestMessageId = "requestMessageId",

                         // the properties below are optional
                         DtcRequestIntervalSeconds = "dtcRequestIntervalSeconds",
                         HasTransmissionEcu = "hasTransmissionEcu",
                         ObdStandard = "obdStandard",
                         PidRequestIntervalSeconds = "pidRequestIntervalSeconds",
                         UseExtendedIds = "useExtendedIds"
                     }
                 } },
                 SignalDecoders = new [] { new SignalDecodersItemsProperty {
                     FullyQualifiedName = "fullyQualifiedName",
                     InterfaceId = "interfaceId",
                     Type = "type",

                     // the properties below are optional
                     CanSignal = new CanSignalProperty {
                         Factor = "factor",
                         IsBigEndian = "isBigEndian",
                         IsSigned = "isSigned",
                         Length = "length",
                         MessageId = "messageId",
                         Offset = "offset",
                         StartBit = "startBit",

                         // the properties below are optional
                         Name = "name",
                         SignalValueType = "signalValueType"
                     },
                     ObdSignal = new ObdSignalProperty {
                         ByteLength = "byteLength",
                         Offset = "offset",
                         Pid = "pid",
                         PidResponseLength = "pidResponseLength",
                         Scaling = "scaling",
                         ServiceMode = "serviceMode",
                         StartByte = "startByte",

                         // the properties below are optional
                         BitMaskLength = "bitMaskLength",
                         BitRightShift = "bitRightShift",
                         IsSigned = "isSigned",
                         SignalValueType = "signalValueType"
                     }
                 } },
                 Status = "status",
                 Tags = new [] { new CfnTag {
                     Key = "key",
                     Value = "value"
                 } }
             };

Properties

DefaultForUnmappedSignals

Use default decoders for all unmapped signals in the model.

public string? DefaultForUnmappedSignals { get; set; }

Property Value

string

Remarks

You don't need to provide any detailed decoding information.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotfleetwise-decodermanifest.html#cfn-iotfleetwise-decodermanifest-defaultforunmappedsignals

Description

A brief description of the decoder manifest.

public string? Description { get; set; }

Property Value

string

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotfleetwise-decodermanifest.html#cfn-iotfleetwise-decodermanifest-description

ModelManifestArn

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

public string ModelManifestArn { get; set; }

Property Value

string

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotfleetwise-decodermanifest.html#cfn-iotfleetwise-decodermanifest-modelmanifestarn

Name

The name of the decoder manifest.

public string Name { get; set; }

Property Value

string

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotfleetwise-decodermanifest.html#cfn-iotfleetwise-decodermanifest-name

NetworkInterfaces

A list of information about available network interfaces.

public object? NetworkInterfaces { get; set; }

Property Value

object

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotfleetwise-decodermanifest.html#cfn-iotfleetwise-decodermanifest-networkinterfaces

SignalDecoders

A list of information about signal decoders.

public object? SignalDecoders { get; set; }

Property Value

object

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotfleetwise-decodermanifest.html#cfn-iotfleetwise-decodermanifest-signaldecoders

Status

The state of the decoder manifest.

public string? Status { get; set; }

Property Value

string

Remarks

If the status is ACTIVE , the decoder manifest can't be edited. If the status is marked DRAFT , you can edit the decoder manifest.

Default: - "DRAFT"

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotfleetwise-decodermanifest.html#cfn-iotfleetwise-decodermanifest-status

Tags

Metadata that can be used to manage the decoder manifest.

public ICfnTag[]? Tags { get; set; }

Property Value

ICfnTag[]

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotfleetwise-decodermanifest.html#cfn-iotfleetwise-decodermanifest-tags

Implements

ICfnDecoderManifestProps