software.amazon.awscdk.services.iotfleetwise

Class CfnDecoderManifest

java.lang.Object

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

@Generated(value="jsii-pacmak/1.74.0 (build 6d08790)",
           date="2023-03-22T19:35:37.006Z")
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();
 

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CfnDecoderManifest.Builder A fluent builder for CfnDecoderManifest.
static interface	CfnDecoderManifest.CanInterfaceProperty A single controller area network (CAN) device interface.
static interface	CfnDecoderManifest.CanSignalProperty Information about a single controller area network (CAN) signal and the messages it receives and transmits.
static interface	CfnDecoderManifest.NetworkInterfacesItemsProperty Example:
static interface	CfnDecoderManifest.ObdInterfaceProperty A network interface that specifies the On-board diagnostic (OBD) II network protocol.
static interface	CfnDecoderManifest.ObdSignalProperty Information about signal messages using the on-board diagnostics (OBD) II protocol in a vehicle.
static interface	CfnDecoderManifest.SignalDecodersItemsProperty Example:

Nested classes/interfaces inherited from interface software.amazon.awscdk.core.IInspectable

IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

Nested classes/interfaces inherited from interface software.amazon.awscdk.core.IConstruct

IConstruct.Jsii$Default

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	CFN_RESOURCE_TYPE_NAME The CloudFormation resource type name for this resource class.

Constructor Summary

Constructors

Modifier	Constructor and Description
	CfnDecoderManifest(Construct scope, java.lang.String id, CfnDecoderManifestProps props) Create a new `AWS::IoTFleetWise::DecoderManifest`.
protected	CfnDecoderManifest(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnDecoderManifest(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method and Description
java.lang.String	getAttrArn()
java.lang.String	getAttrCreationTime()
java.lang.String	getAttrLastModificationTime()
protected java.util.Map<java.lang.String,java.lang.Object>	getCfnProperties()
java.lang.String	getDescription() A brief description of the decoder manifest.
java.lang.String	getModelManifestArn() The ARN of a vehicle model (model manifest) associated with the decoder manifest.
java.lang.String	getName() The name of the decoder manifest.
java.lang.Object	getNetworkInterfaces() `AWS::IoTFleetWise::DecoderManifest.NetworkInterfaces`.
java.lang.Object	getSignalDecoders() `AWS::IoTFleetWise::DecoderManifest.SignalDecoders`.
java.lang.String	getStatus() The state of the decoder manifest.
TagManager	getTags() `AWS::IoTFleetWise::DecoderManifest.Tags`.
void	inspect(TreeInspector inspector) Examines the CloudFormation resource and discloses attributes.
protected java.util.Map<java.lang.String,java.lang.Object>	renderProperties(java.util.Map<java.lang.String,java.lang.Object> props)
void	setDescription(java.lang.String value) A brief description of the decoder manifest.
void	setModelManifestArn(java.lang.String value) The ARN of a vehicle model (model manifest) associated with the decoder manifest.
void	setName(java.lang.String value) The name of the decoder manifest.
void	setNetworkInterfaces(IResolvable value) `AWS::IoTFleetWise::DecoderManifest.NetworkInterfaces`.
void	setNetworkInterfaces(java.util.List<java.lang.Object> value) `AWS::IoTFleetWise::DecoderManifest.NetworkInterfaces`.
void	setSignalDecoders(IResolvable value) `AWS::IoTFleetWise::DecoderManifest.SignalDecoders`.
void	setSignalDecoders(java.util.List<java.lang.Object> value) `AWS::IoTFleetWise::DecoderManifest.SignalDecoders`.
void	setStatus(java.lang.String value) The state of the decoder manifest.

Methods inherited from class software.amazon.awscdk.core.CfnResource

addDeletionOverride, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, isCfnResource, shouldSynthesize, toString, validateProperties

Methods inherited from class software.amazon.awscdk.core.CfnRefElement

getRef

Methods inherited from class software.amazon.awscdk.core.CfnElement

getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId

Methods inherited from class software.amazon.awscdk.core.Construct

getNode, isConstruct, onPrepare, onSynthesize, onValidate, prepare, synthesize, validate

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

CFN_RESOURCE_TYPE_NAME

public static final java.lang.String CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

Constructor Detail

CfnDecoderManifest

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

CfnDecoderManifest

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

CfnDecoderManifest

public CfnDecoderManifest(Construct scope,
                          java.lang.String id,
                          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 Detail

inspect

public void inspect(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

protected java.util.Map<java.lang.String,java.lang.Object> renderProperties(java.util.Map<java.lang.String,java.lang.Object> props)

Overrides:

renderProperties in class CfnResource

Parameters:

props - This parameter is required.

getAttrArn

public java.lang.String getAttrArn()

getAttrCreationTime

public java.lang.String getAttrCreationTime()

getAttrLastModificationTime

public java.lang.String getAttrLastModificationTime()

getCfnProperties

protected java.util.Map<java.lang.String,java.lang.Object> getCfnProperties()

Overrides:

getCfnProperties in class CfnResource

getTags

public TagManager getTags()

`AWS::IoTFleetWise::DecoderManifest.Tags`.

getModelManifestArn

public java.lang.String getModelManifestArn()

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

setModelManifestArn

public void setModelManifestArn(java.lang.String value)

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

getName

public java.lang.String getName()

The name of the decoder manifest.

setName

public void setName(java.lang.String value)

The name of the decoder manifest.

getDescription

public java.lang.String getDescription()

A brief description of the decoder manifest.

setDescription

public void setDescription(java.lang.String value)

A brief description of the decoder manifest.

getNetworkInterfaces

public java.lang.Object getNetworkInterfaces()

`AWS::IoTFleetWise::DecoderManifest.NetworkInterfaces`.

setNetworkInterfaces

public void setNetworkInterfaces(IResolvable value)

`AWS::IoTFleetWise::DecoderManifest.NetworkInterfaces`.

setNetworkInterfaces

public void setNetworkInterfaces(java.util.List<java.lang.Object> value)

`AWS::IoTFleetWise::DecoderManifest.NetworkInterfaces`.

getSignalDecoders

public java.lang.Object getSignalDecoders()

`AWS::IoTFleetWise::DecoderManifest.SignalDecoders`.

setSignalDecoders

public void setSignalDecoders(IResolvable value)

`AWS::IoTFleetWise::DecoderManifest.SignalDecoders`.

setSignalDecoders

public void setSignalDecoders(java.util.List<java.lang.Object> value)

`AWS::IoTFleetWise::DecoderManifest.SignalDecoders`.

getStatus

public java.lang.String getStatus()

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

public void setStatus(java.lang.String value)

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.