Package software.amazon.awscdk.services.iotfleetwise

Interface CfnDecoderManifestProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnDecoderManifestProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.84.0 (build 5404dcf)",
           date="2023-06-19T16:29:57.852Z")
@Stability(Stable)
public interface CfnDecoderManifestProps
extends software.amazon.jsii.JsiiSerializable

Properties for defining a CfnDecoderManifest.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.iotfleetwise.*;
 CfnDecoderManifestProps cfnDecoderManifestProps = CfnDecoderManifestProps.builder()
         .modelManifestArn("modelManifestArn")
         .name("name")
         // the properties below are optional
         .description("description")
         .networkInterfaces(List.of(NetworkInterfacesItemsProperty.builder()
                 .interfaceId("interfaceId")
                 .type("type")
                 // the properties below are optional
                 .canInterface(CanInterfaceProperty.builder()
                         .name("name")
                         // the properties below are optional
                         .protocolName("protocolName")
                         .protocolVersion("protocolVersion")
                         .build())
                 .obdInterface(ObdInterfaceProperty.builder()
                         .name("name")
                         .requestMessageId("requestMessageId")
                         // the properties below are optional
                         .dtcRequestIntervalSeconds("dtcRequestIntervalSeconds")
                         .hasTransmissionEcu("hasTransmissionEcu")
                         .obdStandard("obdStandard")
                         .pidRequestIntervalSeconds("pidRequestIntervalSeconds")
                         .useExtendedIds("useExtendedIds")
                         .build())
                 .build()))
         .signalDecoders(List.of(SignalDecodersItemsProperty.builder()
                 .fullyQualifiedName("fullyQualifiedName")
                 .interfaceId("interfaceId")
                 .type("type")
                 // the properties below are optional
                 .canSignal(CanSignalProperty.builder()
                         .factor("factor")
                         .isBigEndian("isBigEndian")
                         .isSigned("isSigned")
                         .length("length")
                         .messageId("messageId")
                         .offset("offset")
                         .startBit("startBit")
                         // the properties below are optional
                         .name("name")
                         .build())
                 .obdSignal(ObdSignalProperty.builder()
                         .byteLength("byteLength")
                         .offset("offset")
                         .pid("pid")
                         .pidResponseLength("pidResponseLength")
                         .scaling("scaling")
                         .serviceMode("serviceMode")
                         .startByte("startByte")
                         // the properties below are optional
                         .bitMaskLength("bitMaskLength")
                         .bitRightShift("bitRightShift")
                         .build())
                 .build()))
         .status("status")
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnDecoderManifestProps.Builder	A builder for CfnDecoderManifestProps
static final class	CfnDecoderManifestProps.Jsii$Proxy	An implementation for CfnDecoderManifestProps

Method Summary

Modifier and Type	Method	Description
static CfnDecoderManifestProps.Builder	builder()
default String	getDescription()	(Optional) A brief description of the decoder manifest.
String	getModelManifestArn()	The Amazon Resource Name (ARN) of a vehicle model (model manifest) associated with the decoder manifest.
String	getName()	The name of the decoder manifest.
default Object	getNetworkInterfaces()	(Optional) A list of information about available network interfaces.
default Object	getSignalDecoders()	(Optional) A list of information about signal decoders.
default String	getStatus()	(Optional) The state of the decoder manifest.
default List<CfnTag>	getTags()	(Optional) Metadata that can be used to manage the decoder manifest.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getModelManifestArn

@Stability(Stable)
@NotNull
String getModelManifestArn()

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

getName

@Stability(Stable)
@NotNull
String getName()

The name of the decoder manifest.

getDescription

@Stability(Stable)
@Nullable
default String getDescription()

(Optional) A brief description of the decoder manifest.

getNetworkInterfaces

@Stability(Stable)
@Nullable
default Object getNetworkInterfaces()

(Optional) A list of information about available network interfaces.

getSignalDecoders

@Stability(Stable)
@Nullable
default Object getSignalDecoders()

(Optional) A list of information about signal decoders.

getStatus

@Stability(Stable)
@Nullable
default String getStatus()

(Optional) 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.

getTags

@Stability(Stable)
@Nullable
default List<CfnTag> getTags()

(Optional) Metadata that can be used to manage the decoder manifest.

builder

@Stability(Stable)
static CfnDecoderManifestProps.Builder builder()

Returns:

a CfnDecoderManifestProps.Builder of CfnDecoderManifestProps