Package software.amazon.awscdk.services.iotfleetwise

Class CfnDecoderManifest

java.lang.Object
software.amazon.jsii.JsiiObject
software.constructs.Construct
software.amazon.awscdk.core.Construct
software.amazon.awscdk.core.CfnElement
software.amazon.awscdk.core.CfnRefElement
software.amazon.awscdk.core.CfnResource
software.amazon.awscdk.services.iotfleetwise.CfnDecoderManifest
All Implemented Interfaces:
IConstruct, IDependable, IInspectable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct
@Generated(value="jsii-pacmak/1.84.0 (build 5404dcf)", date="2023-06-19T16:29:57.844Z") @Stability(Stable) public class CfnDecoderManifest extends CfnResource implements IInspectable
A 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.

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.*;
 CfnDecoderManifest cfnDecoderManifest = CfnDecoderManifest.Builder.create(this, "MyCfnDecoderManifest")
         .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();

  • Field Details

    • CFN_RESOURCE_TYPE_NAME

      @Stability(Stable) public static final String CFN_RESOURCE_TYPE_NAME
      The CloudFormation resource type name for this resource class.

  • Constructor Details

    • CfnDecoderManifest

      protected CfnDecoderManifest(software.amazon.jsii.JsiiObjectRef objRef)

    • CfnDecoderManifest

      protected CfnDecoderManifest(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

    • CfnDecoderManifest

      @Stability(Stable) public CfnDecoderManifest(@NotNull Construct scope, @NotNull String id, @NotNull CfnDecoderManifestProps props)
      Create a new AWS::IoTFleetWise::DecoderManifest.

      Parameters:
      scope -
      • scope in which this resource is defined.
      This parameter is required.
      id -
      • scoped id of the resource.
      This parameter is required.
      props -
      • resource properties.
      This parameter is required.

  • Method Details

    • inspect

      @Stability(Stable) public void inspect(@NotNull TreeInspector inspector)
      Examines the CloudFormation resource and discloses attributes.

      Specified by:
      inspect in interface IInspectable
      Parameters:
      inspector -
      • tree inspector to collect and process attributes.
      This parameter is required.

    • renderProperties

      @Stability(Stable) @NotNull protected Map<String,Object> renderProperties(@NotNull Map<String,Object> props)
      Overrides:
      renderProperties in class CfnResource
      Parameters:
      props - This parameter is required.

    • getAttrArn

      @Stability(Stable) @NotNull public String getAttrArn()
      The Amazon Resource Name (ARN) of the decoder manifest.

    • getAttrCreationTime

      @Stability(Stable) @NotNull public String getAttrCreationTime()
      The time the decoder manifest was created in seconds since epoch (January 1, 1970 at midnight UTC time).

    • getAttrLastModificationTime

      @Stability(Stable) @NotNull public String getAttrLastModificationTime()
      The time the decoder manifest was last updated in seconds since epoch (January 1, 1970 at midnight UTC time).

    • getCfnProperties

      @Stability(Stable) @NotNull protected Map<String,Object> getCfnProperties()
      Overrides:
      getCfnProperties in class CfnResource

    • getTags

      @Stability(Stable) @NotNull public TagManager getTags()
      (Optional) Metadata that can be used to manage the decoder manifest.

    • getModelManifestArn

      @Stability(Stable) @NotNull public String getModelManifestArn()
      The Amazon Resource Name (ARN) of a vehicle model (model manifest) associated with the decoder manifest.

    • setModelManifestArn

      @Stability(Stable) public void setModelManifestArn(@NotNull String value)
      The Amazon Resource Name (ARN) of a vehicle model (model manifest) associated with the decoder manifest.

    • getName

      @Stability(Stable) @NotNull public String getName()
      The name of the decoder manifest.

    • setName

      @Stability(Stable) public void setName(@NotNull String value)
      The name of the decoder manifest.

    • getDescription

      @Stability(Stable) @Nullable public String getDescription()
      (Optional) A brief description of the decoder manifest.

    • setDescription

      @Stability(Stable) public void setDescription(@Nullable String value)
      (Optional) A brief description of the decoder manifest.

    • getNetworkInterfaces

      @Stability(Stable) @Nullable public Object getNetworkInterfaces()
      (Optional) A list of information about available network interfaces.

    • setNetworkInterfaces

      @Stability(Stable) public void setNetworkInterfaces(@Nullable IResolvable value)
      (Optional) A list of information about available network interfaces.

    • setNetworkInterfaces

      @Stability(Stable) public void setNetworkInterfaces(@Nullable List<Object> value)
      (Optional) A list of information about available network interfaces.

    • getSignalDecoders

      @Stability(Stable) @Nullable public Object getSignalDecoders()
      (Optional) A list of information about signal decoders.

    • setSignalDecoders

      @Stability(Stable) public void setSignalDecoders(@Nullable IResolvable value)
      (Optional) A list of information about signal decoders.

    • setSignalDecoders

      @Stability(Stable) public void setSignalDecoders(@Nullable List<Object> value)
      (Optional) A list of information about signal decoders.

    • getStatus

      @Stability(Stable) @Nullable public 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.

    • setStatus

      @Stability(Stable) public void setStatus(@Nullable String value)
      (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.