CfnDecoderManifest

class aws_cdk.aws_iotfleetwise.CfnDecoderManifest(scope, id, *, model_manifest_arn, name, description=None, network_interfaces=None, signal_decoders=None, status=None, tags=None)

Bases: CfnResource

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.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotfleetwise-decodermanifest.html
CloudformationResource:: AWS::IoTFleetWise::DecoderManifest
ExampleMetadata:: fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_iotfleetwise as iotfleetwise

cfn_decoder_manifest = iotfleetwise.CfnDecoderManifest(self, "MyCfnDecoderManifest",
    model_manifest_arn="modelManifestArn",
    name="name",

    # the properties below are optional
    description="description",
    network_interfaces=[iotfleetwise.CfnDecoderManifest.NetworkInterfacesItemsProperty(
        interface_id="interfaceId",
        type="type",

        # the properties below are optional
        can_interface=iotfleetwise.CfnDecoderManifest.CanInterfaceProperty(
            name="name",

            # the properties below are optional
            protocol_name="protocolName",
            protocol_version="protocolVersion"
        ),
        obd_interface=iotfleetwise.CfnDecoderManifest.ObdInterfaceProperty(
            name="name",
            request_message_id="requestMessageId",

            # the properties below are optional
            dtc_request_interval_seconds="dtcRequestIntervalSeconds",
            has_transmission_ecu="hasTransmissionEcu",
            obd_standard="obdStandard",
            pid_request_interval_seconds="pidRequestIntervalSeconds",
            use_extended_ids="useExtendedIds"
        )
    )],
    signal_decoders=[iotfleetwise.CfnDecoderManifest.SignalDecodersItemsProperty(
        fully_qualified_name="fullyQualifiedName",
        interface_id="interfaceId",
        type="type",

        # the properties below are optional
        can_signal=iotfleetwise.CfnDecoderManifest.CanSignalProperty(
            factor="factor",
            is_big_endian="isBigEndian",
            is_signed="isSigned",
            length="length",
            message_id="messageId",
            offset="offset",
            start_bit="startBit",

            # the properties below are optional
            name="name"
        ),
        obd_signal=iotfleetwise.CfnDecoderManifest.ObdSignalProperty(
            byte_length="byteLength",
            offset="offset",
            pid="pid",
            pid_response_length="pidResponseLength",
            scaling="scaling",
            service_mode="serviceMode",
            start_byte="startByte",

            # the properties below are optional
            bit_mask_length="bitMaskLength",
            bit_right_shift="bitRightShift"
        )
    )],
    status="status",
    tags=[CfnTag(
        key="key",
        value="value"
    )]
)

Parameters:

scope (Construct) – Scope in which this resource is defined.
id (str) – Construct identifier for this resource (unique in its scope).
model_manifest_arn (str) – The Amazon Resource Name (ARN) of a vehicle model (model manifest) associated with the decoder manifest.
name (str) – The name of the decoder manifest.
description (Optional[str]) – (Optional) A brief description of the decoder manifest.
network_interfaces (Union[IResolvable, Sequence[Union[IResolvable, NetworkInterfacesItemsProperty, Dict[str, Any]]], None]) – (Optional) A list of information about available network interfaces.
signal_decoders (Union[IResolvable, Sequence[Union[IResolvable, SignalDecodersItemsProperty, Dict[str, Any]]], None]) – (Optional) A list of information about signal decoders.
status (Optional[str]) – (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. Default: - “DRAFT”
tags (Optional[Sequence[Union[CfnTag, Dict[str, Any]]]]) – (Optional) Metadata that can be used to manage the decoder manifest.

Methods

add_deletion_override(path)

Syntactic sugar for addOverride(path, undefined).

Parameters:: path (str) – The path of the value to delete.
Return type:: None

add_dependency(target)

Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.

This can be used for resources across stacks (or nested stack) boundaries and the dependency will automatically be transferred to the relevant scope.

Parameters:

target (CfnResource) –

Return type:

None

add_depends_on(target)

(deprecated) Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.

Parameters:

target (CfnResource) –

Deprecated:

use addDependency

Stability:

deprecated

Return type:

None

add_metadata(key, value)

Add a value to the CloudFormation Resource Metadata.

Parameters:

key (str) –
value (Any) –

See:

Return type:

None

https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html

Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.

add_override(path, value)

Adds an override to the synthesized CloudFormation resource.

To add a property override, either use addPropertyOverride or prefix path with “Properties.” (i.e. Properties.TopicName).

If the override is nested, separate each nested level using a dot (.) in the path parameter. If there is an array as part of the nesting, specify the index in the path.

To include a literal . in the property name, prefix with a \. In most programming languages you will need to write this as "\\." because the \ itself will need to be escaped.

For example:

cfn_resource.add_override("Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes", ["myattribute"])
cfn_resource.add_override("Properties.GlobalSecondaryIndexes.1.ProjectionType", "INCLUDE")

would add the overrides Example:

"Properties": {
  "GlobalSecondaryIndexes": [
    {
      "Projection": {
        "NonKeyAttributes": [ "myattribute" ]
        ...
      }
      ...
    },
    {
      "ProjectionType": "INCLUDE"
      ...
    },
  ]
  ...
}

The value argument to addOverride will not be processed or translated in any way. Pass raw JSON values in here with the correct capitalization for CloudFormation. If you pass CDK classes or structs, they will be rendered with lowercased key names, and CloudFormation will reject the template.

Parameters:

path (str) –
- The path of the property, you can use dot notation to override values in complex types. Any intermediate keys will be created as needed.
value (Any) –
- The value. Could be primitive or complex.

Return type:

None

add_property_deletion_override(property_path)

Adds an override that deletes the value of a property from the resource definition.

Parameters:: property_path (str) – The path to the property.
Return type:: None

add_property_override(property_path, value)

Adds an override to a resource property.

Syntactic sugar for addOverride("Properties.<...>", value).

Parameters:

property_path (str) – The path of the property.
value (Any) – The value.

Return type:

None

apply_removal_policy(policy=None, *, apply_to_update_replace_policy=None, default=None)

Sets the deletion policy of the resource based on the removal policy specified.

The Removal Policy controls what happens to this resource when it stops being managed by CloudFormation, either because you’ve removed it from the CDK application or because you’ve made a change that requires the resource to be replaced.

The resource can be deleted (RemovalPolicy.DESTROY), or left in your AWS account for data recovery and cleanup later (RemovalPolicy.RETAIN). In some cases, a snapshot can be taken of the resource prior to deletion (RemovalPolicy.SNAPSHOT). A list of resources that support this policy can be found in the following link:

Parameters:

policy (Optional[RemovalPolicy]) –
apply_to_update_replace_policy (Optional[bool]) – Apply the same deletion policy to the resource’s “UpdateReplacePolicy”. Default: true
default (Optional[RemovalPolicy]) – The default policy to apply in case the removal policy is not defined. Default: - Default value is resource specific. To determine the default value for a resource, please consult that specific resource’s documentation.

See:

https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-deletionpolicy.html#aws-attribute-deletionpolicy-options

Return type:

None

get_att(attribute_name, type_hint=None)

Returns a token for an runtime attribute of this resource.

Ideally, use generated attribute accessors (e.g. resource.arn), but this can be used for future compatibility in case there is no generated attribute.

Parameters:

attribute_name (str) – The name of the attribute.
type_hint (Optional[ResolutionTypeHint]) –

Return type:

Reference

get_metadata(key)

Retrieve a value value from the CloudFormation Resource Metadata.

Parameters:

key (str) –

See:

Return type:

Any

https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html

Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.

inspect(inspector)

Examines the CloudFormation resource and discloses attributes.

Parameters:: inspector (TreeInspector) – tree inspector to collect and process attributes.
Return type:: None

obtain_dependencies()

Retrieves an array of resources this resource depends on.

This assembles dependencies on resources across stacks (including nested stacks) automatically.

Return type:: List[Union[Stack, CfnResource]]

obtain_resource_dependencies()

Get a shallow copy of dependencies between this resource and other resources in the same stack.

Return type:: List[CfnResource]

override_logical_id(new_logical_id)

Overrides the auto-generated logical ID with a specific ID.

Parameters:: new_logical_id (str) – The new logical ID to use for this stack element.
Return type:: None

remove_dependency(target)

Indicates that this resource no longer depends on another resource.

This can be used for resources across stacks (including nested stacks) and the dependency will automatically be removed from the relevant scope.

Parameters:

target (CfnResource) –

Return type:

None

replace_dependency(target, new_target)

Replaces one dependency with another.

Parameters:

target (CfnResource) – The dependency to replace.
new_target (CfnResource) – The new dependency to add.

Return type:

None

to_string()

Returns a string representation of this construct.

Return type:: str
Returns:: a string representation of this resource

Attributes

CFN_RESOURCE_TYPE_NAME = 'AWS::IoTFleetWise::DecoderManifest'

attr_arn

The Amazon Resource Name (ARN) of the decoder manifest.

CloudformationAttribute:: Arn

attr_creation_time

The time the decoder manifest was created in seconds since epoch (January 1, 1970 at midnight UTC time).

CloudformationAttribute:: CreationTime

attr_last_modification_time

The time the decoder manifest was last updated in seconds since epoch (January 1, 1970 at midnight UTC time).

CloudformationAttribute:: LastModificationTime

cfn_options: Options for this resource, such as condition, update policy etc.

cfn_resource_type: AWS resource type.

creation_stack

return:

the stack trace of the point where this Resource was created from, sourced from the +metadata+ entry typed +aws:cdk:logicalId+, and with the bottom-most node +internal+ entries filtered.

description: (Optional) A brief description of the decoder manifest.

logical_id

The logical ID for this CloudFormation stack element.

The logical ID of the element is calculated from the path of the resource node in the construct tree.

To override this value, use overrideLogicalId(newLogicalId).

Returns:

the logical ID as a stringified token. This value will only get resolved during synthesis.

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

name: The name of the decoder manifest.

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

node: The tree node.

ref

Return a string that will be resolved to a CloudFormation { Ref } for this element.

If, by any chance, the intrinsic reference of a resource is not a string, you could coerce it to an IResolvable through Lazy.any({ produce: resource.ref }).

signal_decoders: (Optional) A list of information about signal decoders.

stack

The stack in which this element is defined.

CfnElements must be defined within a stack scope (directly or indirectly).

status: (Optional) The state of the decoder manifest.

tags: Tag Manager which manages the tags for this resource.

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

Static Methods

classmethod is_cfn_element(x)

Returns true if a construct is a stack element (i.e. part of the synthesized cloudformation template).

Uses duck-typing instead of instanceof to allow stack elements from different versions of this library to be included in the same stack.

Parameters:

x (Any) –

Return type:

bool

Returns:

The construct as a stack element or undefined if it is not a stack element.

classmethod is_cfn_resource(x)

Check whether the given object is a CfnResource.

Parameters:

x (Any) –

Return type:

bool

classmethod is_construct(x)

Checks if x is a construct.

Use this method instead of instanceof to properly detect Construct instances, even when the construct library is symlinked.

Explanation: in JavaScript, multiple copies of the constructs library on disk are seen as independent, completely different libraries. As a consequence, the class Construct in each copy of the constructs library is seen as a different class, and an instance of one class will not test as instanceof the other class. npm install will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the constructs library can be accidentally installed, and instanceof will behave unpredictably. It is safest to avoid using instanceof, and using this type-testing method instead.

Parameters:: x (Any) – Any object.
Return type:: bool
Returns:: true if x is an object created from a class which extends Construct.

CanInterfaceProperty

class CfnDecoderManifest.CanInterfaceProperty(*, name, protocol_name=None, protocol_version=None)

Bases: object

A single controller area network (CAN) device interface.

Parameters:

name (str) – The unique name of the interface.
protocol_name (Optional[str]) – (Optional) The name of the communication protocol for the interface.
protocol_version (Optional[str]) – (Optional) The version of the communication protocol for the interface.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotfleetwise-decodermanifest-caninterface.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_iotfleetwise as iotfleetwise

can_interface_property = iotfleetwise.CfnDecoderManifest.CanInterfaceProperty(
    name="name",

    # the properties below are optional
    protocol_name="protocolName",
    protocol_version="protocolVersion"
)

Attributes

name

The unique name of the interface.

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

protocol_name

(Optional) The name of the communication protocol for the interface.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotfleetwise-decodermanifest-caninterface.html#cfn-iotfleetwise-decodermanifest-caninterface-protocolname

protocol_version

(Optional) The version of the communication protocol for the interface.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotfleetwise-decodermanifest-caninterface.html#cfn-iotfleetwise-decodermanifest-caninterface-protocolversion

CanNetworkInterfaceProperty

class CfnDecoderManifest.CanNetworkInterfaceProperty(*, can_interface, interface_id, type)

Bases: object

Represents a node and its specifications in an in-vehicle communication network.

All signal decoders must be associated with a network node.

To return this information about all the network interfaces specified in a decoder manifest, use the ListDecoderManifestNetworkInterfaces in the AWS IoT FleetWise API Reference .

Parameters:

can_interface (Union[IResolvable, CanInterfaceProperty, Dict[str, Any]]) – Information about a network interface specified by the Controller Area Network (CAN) protocol.
interface_id (str) – The ID of the network interface.
type (str) – The network protocol for the vehicle. For example, CAN_SIGNAL specifies a protocol that defines how data is communicated between electronic control units (ECUs). OBD_SIGNAL specifies a protocol that defines how self-diagnostic data is communicated between ECUs.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotfleetwise-decodermanifest-cannetworkinterface.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_iotfleetwise as iotfleetwise

can_network_interface_property = iotfleetwise.CfnDecoderManifest.CanNetworkInterfaceProperty(
    can_interface=iotfleetwise.CfnDecoderManifest.CanInterfaceProperty(
        name="name",

        # the properties below are optional
        protocol_name="protocolName",
        protocol_version="protocolVersion"
    ),
    interface_id="interfaceId",
    type="type"
)

Attributes

can_interface

Information about a network interface specified by the Controller Area Network (CAN) protocol.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotfleetwise-decodermanifest-cannetworkinterface.html#cfn-iotfleetwise-decodermanifest-cannetworkinterface-caninterface

interface_id

The ID of the network interface.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotfleetwise-decodermanifest-cannetworkinterface.html#cfn-iotfleetwise-decodermanifest-cannetworkinterface-interfaceid

type

The network protocol for the vehicle.

For example, CAN_SIGNAL specifies a protocol that defines how data is communicated between electronic control units (ECUs). OBD_SIGNAL specifies a protocol that defines how self-diagnostic data is communicated between ECUs.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotfleetwise-decodermanifest-cannetworkinterface.html#cfn-iotfleetwise-decodermanifest-cannetworkinterface-type

CanSignalDecoderProperty

class CfnDecoderManifest.CanSignalDecoderProperty(*, can_signal, fully_qualified_name, interface_id, type)

Bases: object

Information about signal decoder using the Controller Area Network (CAN) protocol.

Parameters:

can_signal (Union[IResolvable, CanSignalProperty, Dict[str, Any]]) – Information about a single controller area network (CAN) signal and the messages it receives and transmits.
fully_qualified_name (str) – The fully qualified name of a signal decoder as defined in a vehicle model.
interface_id (str) – The ID of a network interface that specifies what network protocol a vehicle follows.
type (str) – The network protocol for the vehicle. For example, CAN_SIGNAL specifies a protocol that defines how data is communicated between electronic control units (ECUs). OBD_SIGNAL specifies a protocol that defines how self-diagnostic data is communicated between ECUs.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotfleetwise-decodermanifest-cansignaldecoder.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_iotfleetwise as iotfleetwise

can_signal_decoder_property = iotfleetwise.CfnDecoderManifest.CanSignalDecoderProperty(
    can_signal=iotfleetwise.CfnDecoderManifest.CanSignalProperty(
        factor="factor",
        is_big_endian="isBigEndian",
        is_signed="isSigned",
        length="length",
        message_id="messageId",
        offset="offset",
        start_bit="startBit",

        # the properties below are optional
        name="name"
    ),
    fully_qualified_name="fullyQualifiedName",
    interface_id="interfaceId",
    type="type"
)

Attributes

can_signal

Information about a single controller area network (CAN) signal and the messages it receives and transmits.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotfleetwise-decodermanifest-cansignaldecoder.html#cfn-iotfleetwise-decodermanifest-cansignaldecoder-cansignal

fully_qualified_name

The fully qualified name of a signal decoder as defined in a vehicle model.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotfleetwise-decodermanifest-cansignaldecoder.html#cfn-iotfleetwise-decodermanifest-cansignaldecoder-fullyqualifiedname

interface_id

The ID of a network interface that specifies what network protocol a vehicle follows.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotfleetwise-decodermanifest-cansignaldecoder.html#cfn-iotfleetwise-decodermanifest-cansignaldecoder-interfaceid

type

The network protocol for the vehicle.

For example, CAN_SIGNAL specifies a protocol that defines how data is communicated between electronic control units (ECUs). OBD_SIGNAL specifies a protocol that defines how self-diagnostic data is communicated between ECUs.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotfleetwise-decodermanifest-cansignaldecoder.html#cfn-iotfleetwise-decodermanifest-cansignaldecoder-type

CanSignalProperty

class CfnDecoderManifest.CanSignalProperty(*, factor, is_big_endian, is_signed, length, message_id, offset, start_bit, name=None)

Bases: object

(Optional) Information about a single controller area network (CAN) signal and the messages it receives and transmits.

Parameters:

factor (str) – A multiplier used to decode the CAN message.
is_big_endian (str) – Whether the byte ordering of a CAN message is big-endian.
is_signed (str) – Whether the message data is specified as a signed value.
length (str) – How many bytes of data are in the message.
message_id (str) – The ID of the message.
offset (str) – The offset used to calculate the signal value. Combined with factor, the calculation is value = raw_value * factor + offset .
start_bit (str) – Indicates the beginning of the CAN message.
name (Optional[str]) – (Optional) The name of the signal.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotfleetwise-decodermanifest-cansignal.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_iotfleetwise as iotfleetwise

can_signal_property = iotfleetwise.CfnDecoderManifest.CanSignalProperty(
    factor="factor",
    is_big_endian="isBigEndian",
    is_signed="isSigned",
    length="length",
    message_id="messageId",
    offset="offset",
    start_bit="startBit",

    # the properties below are optional
    name="name"
)

Attributes

factor

A multiplier used to decode the CAN message.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotfleetwise-decodermanifest-cansignal.html#cfn-iotfleetwise-decodermanifest-cansignal-factor

is_big_endian

Whether the byte ordering of a CAN message is big-endian.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotfleetwise-decodermanifest-cansignal.html#cfn-iotfleetwise-decodermanifest-cansignal-isbigendian

is_signed

Whether the message data is specified as a signed value.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotfleetwise-decodermanifest-cansignal.html#cfn-iotfleetwise-decodermanifest-cansignal-issigned

length

How many bytes of data are in the message.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotfleetwise-decodermanifest-cansignal.html#cfn-iotfleetwise-decodermanifest-cansignal-length

message_id

The ID of the message.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotfleetwise-decodermanifest-cansignal.html#cfn-iotfleetwise-decodermanifest-cansignal-messageid

name

(Optional) The name of the signal.

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

offset

The offset used to calculate the signal value.

Combined with factor, the calculation is value = raw_value * factor + offset .

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotfleetwise-decodermanifest-cansignal.html#cfn-iotfleetwise-decodermanifest-cansignal-offset

start_bit

Indicates the beginning of the CAN message.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotfleetwise-decodermanifest-cansignal.html#cfn-iotfleetwise-decodermanifest-cansignal-startbit

NetworkInterfacesItemsProperty

class CfnDecoderManifest.NetworkInterfacesItemsProperty(*, interface_id, type, can_interface=None, obd_interface=None)

Bases: object

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

Parameters:

interface_id (str) –
type (str) –
can_interface (Union[IResolvable, CanInterfaceProperty, Dict[str, Any], None]) –
obd_interface (Union[IResolvable, ObdInterfaceProperty, Dict[str, Any], None]) –

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotfleetwise-decodermanifest-networkinterfacesitems.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_iotfleetwise as iotfleetwise

network_interfaces_items_property = iotfleetwise.CfnDecoderManifest.NetworkInterfacesItemsProperty(
    interface_id="interfaceId",
    type="type",

    # the properties below are optional
    can_interface=iotfleetwise.CfnDecoderManifest.CanInterfaceProperty(
        name="name",

        # the properties below are optional
        protocol_name="protocolName",
        protocol_version="protocolVersion"
    ),
    obd_interface=iotfleetwise.CfnDecoderManifest.ObdInterfaceProperty(
        name="name",
        request_message_id="requestMessageId",

        # the properties below are optional
        dtc_request_interval_seconds="dtcRequestIntervalSeconds",
        has_transmission_ecu="hasTransmissionEcu",
        obd_standard="obdStandard",
        pid_request_interval_seconds="pidRequestIntervalSeconds",
        use_extended_ids="useExtendedIds"
    )
)

Attributes

can_interface

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotfleetwise-decodermanifest-networkinterfacesitems.html#cfn-iotfleetwise-decodermanifest-networkinterfacesitems-caninterface

Type:: see

interface_id

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotfleetwise-decodermanifest-networkinterfacesitems.html#cfn-iotfleetwise-decodermanifest-networkinterfacesitems-interfaceid

Type:: see

obd_interface

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotfleetwise-decodermanifest-networkinterfacesitems.html#cfn-iotfleetwise-decodermanifest-networkinterfacesitems-obdinterface

Type:: see

type

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotfleetwise-decodermanifest-networkinterfacesitems.html#cfn-iotfleetwise-decodermanifest-networkinterfacesitems-type

Type:: see

ObdInterfaceProperty

class CfnDecoderManifest.ObdInterfaceProperty(*, name, request_message_id, dtc_request_interval_seconds=None, has_transmission_ecu=None, obd_standard=None, pid_request_interval_seconds=None, use_extended_ids=None)

Bases: object

A network interface that specifies the On-board diagnostic (OBD) II network protocol.

Parameters:

name (str) – The name of the interface.
request_message_id (str) – The ID of the message requesting vehicle data.
dtc_request_interval_seconds (Optional[str]) – (Optional) The maximum number message requests per diagnostic trouble code per second.
has_transmission_ecu (Optional[str]) – (Optional) Whether the vehicle has a transmission control module (TCM).
obd_standard (Optional[str]) – (Optional) The standard OBD II PID.
pid_request_interval_seconds (Optional[str]) – (Optional) The maximum number message requests per second.
use_extended_ids (Optional[str]) – (Optional) Whether to use extended IDs in the message.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotfleetwise-decodermanifest-obdinterface.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_iotfleetwise as iotfleetwise

obd_interface_property = iotfleetwise.CfnDecoderManifest.ObdInterfaceProperty(
    name="name",
    request_message_id="requestMessageId",

    # the properties below are optional
    dtc_request_interval_seconds="dtcRequestIntervalSeconds",
    has_transmission_ecu="hasTransmissionEcu",
    obd_standard="obdStandard",
    pid_request_interval_seconds="pidRequestIntervalSeconds",
    use_extended_ids="useExtendedIds"
)

Attributes

dtc_request_interval_seconds

(Optional) The maximum number message requests per diagnostic trouble code per second.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotfleetwise-decodermanifest-obdinterface.html#cfn-iotfleetwise-decodermanifest-obdinterface-dtcrequestintervalseconds

has_transmission_ecu

(Optional) Whether the vehicle has a transmission control module (TCM).

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotfleetwise-decodermanifest-obdinterface.html#cfn-iotfleetwise-decodermanifest-obdinterface-hastransmissionecu

name

The name of the interface.

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

obd_standard

(Optional) The standard OBD II PID.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotfleetwise-decodermanifest-obdinterface.html#cfn-iotfleetwise-decodermanifest-obdinterface-obdstandard

pid_request_interval_seconds

(Optional) The maximum number message requests per second.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotfleetwise-decodermanifest-obdinterface.html#cfn-iotfleetwise-decodermanifest-obdinterface-pidrequestintervalseconds

request_message_id

The ID of the message requesting vehicle data.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotfleetwise-decodermanifest-obdinterface.html#cfn-iotfleetwise-decodermanifest-obdinterface-requestmessageid

use_extended_ids

(Optional) Whether to use extended IDs in the message.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotfleetwise-decodermanifest-obdinterface.html#cfn-iotfleetwise-decodermanifest-obdinterface-useextendedids

ObdNetworkInterfaceProperty

class CfnDecoderManifest.ObdNetworkInterfaceProperty(*, interface_id, obd_interface, type)

Bases: object

Information about a network interface specified by the On-board diagnostic (OBD) II protocol.

Parameters:

interface_id (str) – The ID of the network interface.
obd_interface (Union[IResolvable, ObdInterfaceProperty, Dict[str, Any]]) – (Optional) Information about a network interface specified by the On-board diagnostic (OBD) II protocol.
type (str) – The network protocol for the vehicle. For example, CAN_SIGNAL specifies a protocol that defines how data is communicated between electronic control units (ECUs). OBD_SIGNAL specifies a protocol that defines how self-diagnostic data is communicated between ECUs.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotfleetwise-decodermanifest-obdnetworkinterface.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_iotfleetwise as iotfleetwise

obd_network_interface_property = iotfleetwise.CfnDecoderManifest.ObdNetworkInterfaceProperty(
    interface_id="interfaceId",
    obd_interface=iotfleetwise.CfnDecoderManifest.ObdInterfaceProperty(
        name="name",
        request_message_id="requestMessageId",

        # the properties below are optional
        dtc_request_interval_seconds="dtcRequestIntervalSeconds",
        has_transmission_ecu="hasTransmissionEcu",
        obd_standard="obdStandard",
        pid_request_interval_seconds="pidRequestIntervalSeconds",
        use_extended_ids="useExtendedIds"
    ),
    type="type"
)

Attributes

interface_id

The ID of the network interface.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotfleetwise-decodermanifest-obdnetworkinterface.html#cfn-iotfleetwise-decodermanifest-obdnetworkinterface-interfaceid

obd_interface

(Optional) Information about a network interface specified by the On-board diagnostic (OBD) II protocol.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotfleetwise-decodermanifest-obdnetworkinterface.html#cfn-iotfleetwise-decodermanifest-obdnetworkinterface-obdinterface

type

The network protocol for the vehicle.

For example, CAN_SIGNAL specifies a protocol that defines how data is communicated between electronic control units (ECUs). OBD_SIGNAL specifies a protocol that defines how self-diagnostic data is communicated between ECUs.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotfleetwise-decodermanifest-obdnetworkinterface.html#cfn-iotfleetwise-decodermanifest-obdnetworkinterface-type

ObdSignalDecoderProperty

class CfnDecoderManifest.ObdSignalDecoderProperty(*, fully_qualified_name, interface_id, obd_signal, type)

Bases: object

A list of information about signal decoders.

Parameters:

fully_qualified_name (str) –
interface_id (str) –
obd_signal (Union[IResolvable, ObdSignalProperty, Dict[str, Any]]) – Information about signal messages using the on-board diagnostics (OBD) II protocol in a vehicle.
type (str) –

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotfleetwise-decodermanifest-obdsignaldecoder.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_iotfleetwise as iotfleetwise

obd_signal_decoder_property = iotfleetwise.CfnDecoderManifest.ObdSignalDecoderProperty(
    fully_qualified_name="fullyQualifiedName",
    interface_id="interfaceId",
    obd_signal=iotfleetwise.CfnDecoderManifest.ObdSignalProperty(
        byte_length="byteLength",
        offset="offset",
        pid="pid",
        pid_response_length="pidResponseLength",
        scaling="scaling",
        service_mode="serviceMode",
        start_byte="startByte",

        # the properties below are optional
        bit_mask_length="bitMaskLength",
        bit_right_shift="bitRightShift"
    ),
    type="type"
)

Attributes

fully_qualified_name

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotfleetwise-decodermanifest-obdsignaldecoder.html#cfn-iotfleetwise-decodermanifest-obdsignaldecoder-fullyqualifiedname

Type:: see

interface_id

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotfleetwise-decodermanifest-obdsignaldecoder.html#cfn-iotfleetwise-decodermanifest-obdsignaldecoder-interfaceid

Type:: see

obd_signal

Information about signal messages using the on-board diagnostics (OBD) II protocol in a vehicle.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotfleetwise-decodermanifest-obdsignaldecoder.html#cfn-iotfleetwise-decodermanifest-obdsignaldecoder-obdsignal

type

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotfleetwise-decodermanifest-obdsignaldecoder.html#cfn-iotfleetwise-decodermanifest-obdsignaldecoder-type

Type:: see

ObdSignalProperty

class CfnDecoderManifest.ObdSignalProperty(*, byte_length, offset, pid, pid_response_length, scaling, service_mode, start_byte, bit_mask_length=None, bit_right_shift=None)

Bases: object

Information about signal messages using the on-board diagnostics (OBD) II protocol in a vehicle.

Parameters:

byte_length (str) – The length of a message.
offset (str) – The offset used to calculate the signal value. Combined with scaling, the calculation is value = raw_value * scaling + offset .
pid (str) – The diagnostic code used to request data from a vehicle for this signal.
pid_response_length (str) – The length of the requested data.
scaling (str) – A multiplier used to decode the message.
service_mode (str) – The mode of operation (diagnostic service) in a message.
start_byte (str) – Indicates the beginning of the message.
bit_mask_length (Optional[str]) – (Optional) The number of bits to mask in a message.
bit_right_shift (Optional[str]) – (Optional) The number of positions to shift bits in the message.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotfleetwise-decodermanifest-obdsignal.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_iotfleetwise as iotfleetwise

obd_signal_property = iotfleetwise.CfnDecoderManifest.ObdSignalProperty(
    byte_length="byteLength",
    offset="offset",
    pid="pid",
    pid_response_length="pidResponseLength",
    scaling="scaling",
    service_mode="serviceMode",
    start_byte="startByte",

    # the properties below are optional
    bit_mask_length="bitMaskLength",
    bit_right_shift="bitRightShift"
)

Attributes

bit_mask_length

(Optional) The number of bits to mask in a message.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotfleetwise-decodermanifest-obdsignal.html#cfn-iotfleetwise-decodermanifest-obdsignal-bitmasklength

bit_right_shift

(Optional) The number of positions to shift bits in the message.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotfleetwise-decodermanifest-obdsignal.html#cfn-iotfleetwise-decodermanifest-obdsignal-bitrightshift

byte_length

The length of a message.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotfleetwise-decodermanifest-obdsignal.html#cfn-iotfleetwise-decodermanifest-obdsignal-bytelength

offset

The offset used to calculate the signal value.

Combined with scaling, the calculation is value = raw_value * scaling + offset .

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotfleetwise-decodermanifest-obdsignal.html#cfn-iotfleetwise-decodermanifest-obdsignal-offset

pid

The diagnostic code used to request data from a vehicle for this signal.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotfleetwise-decodermanifest-obdsignal.html#cfn-iotfleetwise-decodermanifest-obdsignal-pid

pid_response_length

The length of the requested data.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotfleetwise-decodermanifest-obdsignal.html#cfn-iotfleetwise-decodermanifest-obdsignal-pidresponselength

scaling

A multiplier used to decode the message.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotfleetwise-decodermanifest-obdsignal.html#cfn-iotfleetwise-decodermanifest-obdsignal-scaling

service_mode

The mode of operation (diagnostic service) in a message.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotfleetwise-decodermanifest-obdsignal.html#cfn-iotfleetwise-decodermanifest-obdsignal-servicemode

start_byte

Indicates the beginning of the message.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotfleetwise-decodermanifest-obdsignal.html#cfn-iotfleetwise-decodermanifest-obdsignal-startbyte

SignalDecodersItemsProperty

class CfnDecoderManifest.SignalDecodersItemsProperty(*, fully_qualified_name, interface_id, type, can_signal=None, obd_signal=None)

Bases: object

Information about a signal decoder.

Parameters:

fully_qualified_name (str) –
interface_id (str) –
type (str) –
can_signal (Union[IResolvable, CanSignalProperty, Dict[str, Any], None]) –
obd_signal (Union[IResolvable, ObdSignalProperty, Dict[str, Any], None]) –

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotfleetwise-decodermanifest-signaldecodersitems.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_iotfleetwise as iotfleetwise

signal_decoders_items_property = iotfleetwise.CfnDecoderManifest.SignalDecodersItemsProperty(
    fully_qualified_name="fullyQualifiedName",
    interface_id="interfaceId",
    type="type",

    # the properties below are optional
    can_signal=iotfleetwise.CfnDecoderManifest.CanSignalProperty(
        factor="factor",
        is_big_endian="isBigEndian",
        is_signed="isSigned",
        length="length",
        message_id="messageId",
        offset="offset",
        start_bit="startBit",

        # the properties below are optional
        name="name"
    ),
    obd_signal=iotfleetwise.CfnDecoderManifest.ObdSignalProperty(
        byte_length="byteLength",
        offset="offset",
        pid="pid",
        pid_response_length="pidResponseLength",
        scaling="scaling",
        service_mode="serviceMode",
        start_byte="startByte",

        # the properties below are optional
        bit_mask_length="bitMaskLength",
        bit_right_shift="bitRightShift"
    )
)