CfnSignalCatalogProps

class aws_cdk.aws_iotfleetwise.CfnSignalCatalogProps(*, description=None, name=None, node_counts=None, nodes=None, tags=None)

Bases: object

Properties for defining a CfnSignalCatalog.

Parameters:
  • description (Optional[str]) – (Optional) A brief description of the signal catalog.

  • name (Optional[str]) – (Optional) The name of the signal catalog.

  • node_counts (Union[IResolvable, NodeCountsProperty, Dict[str, Any], None]) – (Optional) Information about the number of nodes and node types in a vehicle network.

  • nodes (Union[IResolvable, Sequence[Union[IResolvable, NodeProperty, Dict[str, Any]]], None]) – (Optional) A list of information about nodes, which are a general abstraction of signals.

  • tags (Optional[Sequence[Union[CfnTag, Dict[str, Any]]]]) – (Optional) Metadata that can be used to manage the signal catalog.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotfleetwise-signalcatalog.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

cfn_signal_catalog_props = iotfleetwise.CfnSignalCatalogProps(
    description="description",
    name="name",
    node_counts=iotfleetwise.CfnSignalCatalog.NodeCountsProperty(
        total_actuators=123,
        total_attributes=123,
        total_branches=123,
        total_nodes=123,
        total_sensors=123
    ),
    nodes=[iotfleetwise.CfnSignalCatalog.NodeProperty(
        actuator=iotfleetwise.CfnSignalCatalog.ActuatorProperty(
            data_type="dataType",
            fully_qualified_name="fullyQualifiedName",

            # the properties below are optional
            allowed_values=["allowedValues"],
            assigned_value="assignedValue",
            description="description",
            max=123,
            min=123,
            unit="unit"
        ),
        attribute=iotfleetwise.CfnSignalCatalog.AttributeProperty(
            data_type="dataType",
            fully_qualified_name="fullyQualifiedName",

            # the properties below are optional
            allowed_values=["allowedValues"],
            assigned_value="assignedValue",
            default_value="defaultValue",
            description="description",
            max=123,
            min=123,
            unit="unit"
        ),
        branch=iotfleetwise.CfnSignalCatalog.BranchProperty(
            fully_qualified_name="fullyQualifiedName",

            # the properties below are optional
            description="description"
        ),
        sensor=iotfleetwise.CfnSignalCatalog.SensorProperty(
            data_type="dataType",
            fully_qualified_name="fullyQualifiedName",

            # the properties below are optional
            allowed_values=["allowedValues"],
            description="description",
            max=123,
            min=123,
            unit="unit"
        )
    )],
    tags=[CfnTag(
        key="key",
        value="value"
    )]
)

Attributes

description

(Optional) A brief description of the signal catalog.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotfleetwise-signalcatalog.html#cfn-iotfleetwise-signalcatalog-description

name

(Optional) The name of the signal catalog.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotfleetwise-signalcatalog.html#cfn-iotfleetwise-signalcatalog-name

node_counts

(Optional) Information about the number of nodes and node types in a vehicle network.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotfleetwise-signalcatalog.html#cfn-iotfleetwise-signalcatalog-nodecounts

nodes

(Optional) A list of information about nodes, which are a general abstraction of signals.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotfleetwise-signalcatalog.html#cfn-iotfleetwise-signalcatalog-nodes

tags

(Optional) Metadata that can be used to manage the signal catalog.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotfleetwise-signalcatalog.html#cfn-iotfleetwise-signalcatalog-tags