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:
CfnResourceA 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.
- CloudformationResource:
AWS::IoTFleetWise::DecoderManifest
- Link:
- ExampleMetadata:
fixture=_generated
Example:
# The code below shows an example of how to instantiate this type. # The values are placeholders you should change. import aws_cdk.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" )] )
Create a new
AWS::IoTFleetWise::DecoderManifest.- Parameters:
scope (
Construct) –scope in which this resource is defined.
id (
str) –scoped id of the resource.
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 isACTIVE, the decoder manifest can’t be edited. If the status is markedDRAFT, you can edit the decoder manifest.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_depends_on(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_metadata(key, value)
Add a value to the CloudFormation Resource Metadata.
- Parameters:
key (
str)value (
Any)
- See:
- Return type:
None
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
addPropertyOverrideor prefixpathwith “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
valueargument toaddOverridewill 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 intermdediate 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).- Parameters:
policy (
Optional[RemovalPolicy])apply_to_update_replace_policy (
Optional[bool]) – Apply the same deletion policy to the resource’s “UpdateReplacePolicy”. Default: truedefault (
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 resoure, please consult that specific resource’s documentation.
- Return type:
None
- get_att(attribute_name)
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.- Return type:
- get_metadata(key)
Retrieve a value value from the CloudFormation Resource Metadata.
- Parameters:
key (
str)- See:
- Return type:
Any
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
- 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
- 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 construct tree node associated with this construct.
- 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.
If the status is
ACTIVE, the decoder manifest can’t be edited. If the status is markedDRAFT, you can edit the decoder manifest.
- tags
(Optional) Metadata that can be used to manage the decoder manifest.
Static Methods
- classmethod is_cfn_element(x)
Returns
trueif a construct is a stack element (i.e. part of the synthesized cloudformation template).Uses duck-typing instead of
instanceofto 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(construct)
Check whether the given construct is a CfnResource.
- Parameters:
construct (
IConstruct)- Return type:
bool
- classmethod is_construct(x)
Return whether the given object is a Construct.
- Parameters:
x (
Any)- Return type:
bool
CanInterfaceProperty
- class CfnDecoderManifest.CanInterfaceProperty(*, name, protocol_name=None, protocol_version=None)
Bases:
objectA 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.
- Link:
- ExampleMetadata:
fixture=_generated
Example:
# The code below shows an example of how to instantiate this type. # The values are placeholders you should change. import aws_cdk.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.
- protocol_name
(Optional) The name of the communication protocol for the interface.
- protocol_version
(Optional) The version of the communication protocol for the interface.
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 isvalue = raw_value * factor + offset.start_bit (
str) – Indicates the beginning of the CAN message.name (
Optional[str]) – (Optional) The name of the signal.
- Link:
- ExampleMetadata:
fixture=_generated
Example:
# The code below shows an example of how to instantiate this type. # The values are placeholders you should change. import aws_cdk.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.
- is_big_endian
Whether the byte ordering of a CAN message is big-endian.
- is_signed
Whether the message data is specified as a signed value.
- length
How many bytes of data are in the message.
- message_id
The ID of the message.
- name
(Optional) The name of the signal.
- offset
The offset used to calculate the signal value.
Combined with factor, the calculation is
value = raw_value * factor + offset.
- start_bit
Indicates the beginning of the CAN message.
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) – The ID of the network interface.type (
str) – The network protocol for the vehicle. For example,CAN_SIGNALspecifies a protocol that defines how data is communicated between electronic control units (ECUs).OBD_SIGNALspecifies a protocol that defines how self-diagnostic data is communicated between ECUs.can_interface (
Union[IResolvable,CanInterfaceProperty,Dict[str,Any],None]) – (Optional) Information about a network interface specified by the Controller Area Network (CAN) protocol.obd_interface (
Union[IResolvable,ObdInterfaceProperty,Dict[str,Any],None]) – (Optional) Information about a network interface specified by the On-board diagnostic (OBD) II protocol.
- Link:
- ExampleMetadata:
fixture=_generated
Example:
# The code below shows an example of how to instantiate this type. # The values are placeholders you should change. import aws_cdk.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
(Optional) Information about a network interface specified by the Controller Area Network (CAN) protocol.
- interface_id
The ID of the network interface.
- obd_interface
(Optional) Information about a network interface specified by the On-board diagnostic (OBD) II protocol.
- type
The network protocol for the vehicle.
For example,
CAN_SIGNALspecifies a protocol that defines how data is communicated between electronic control units (ECUs).OBD_SIGNALspecifies a protocol that defines how self-diagnostic data is communicated between ECUs.
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:
objectA 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.
- Link:
- ExampleMetadata:
fixture=_generated
Example:
# The code below shows an example of how to instantiate this type. # The values are placeholders you should change. import aws_cdk.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.
- has_transmission_ecu
(Optional) Whether the vehicle has a transmission control module (TCM).
- name
The name of the interface.
- obd_standard
(Optional) The standard OBD II PID.
- pid_request_interval_seconds
(Optional) The maximum number message requests per second.
- request_message_id
The ID of the message requesting vehicle data.
- use_extended_ids
(Optional) Whether to use extended IDs in the message.
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:
objectInformation 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 isvalue = 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.
- Link:
- ExampleMetadata:
fixture=_generated
Example:
# The code below shows an example of how to instantiate this type. # The values are placeholders you should change. import aws_cdk.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.
- bit_right_shift
(Optional) The number of positions to shift bits in the message.
- byte_length
The length of a message.
- offset
The offset used to calculate the signal value.
Combined with scaling, the calculation is
value = raw_value * scaling + offset.
- pid
The diagnostic code used to request data from a vehicle for this signal.
- pid_response_length
The length of the requested data.
- scaling
A multiplier used to decode the message.
- service_mode
The mode of operation (diagnostic service) in a message.
- start_byte
Indicates the beginning of the message.
SignalDecodersItemsProperty
- class CfnDecoderManifest.SignalDecodersItemsProperty(*, fully_qualified_name, interface_id, type, can_signal=None, obd_signal=None)
Bases:
objectInformation about a signal decoder.
- Parameters:
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_SIGNALspecifies a protocol that defines how data is communicated between electronic control units (ECUs).OBD_SIGNALspecifies a protocol that defines how self-diagnostic data is communicated between ECUs.can_signal (
Union[IResolvable,CanSignalProperty,Dict[str,Any],None]) – (Optional) Information about a single controller area network (CAN) signal and the messages it receives and transmits.obd_signal (
Union[IResolvable,ObdSignalProperty,Dict[str,Any],None]) – (Optional) Information about signal messages using the on-board diagnostics (OBD) II protocol in a vehicle.
- Link:
- ExampleMetadata:
fixture=_generated
Example:
# The code below shows an example of how to instantiate this type. # The values are placeholders you should change. import aws_cdk.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" ) )
Attributes
- can_signal
(Optional) Information about a single controller area network (CAN) signal and the messages it receives and transmits.
- fully_qualified_name
The fully qualified name of a signal decoder as defined in a vehicle model.
- interface_id
The ID of a network interface that specifies what network protocol a vehicle follows.
- obd_signal
(Optional) Information about signal messages using the on-board diagnostics (OBD) II protocol in a vehicle.
- type
The network protocol for the vehicle.
For example,
CAN_SIGNALspecifies a protocol that defines how data is communicated between electronic control units (ECUs).OBD_SIGNALspecifies a protocol that defines how self-diagnostic data is communicated between ECUs.