CfnSignalCatalogPropsMixin

class aws_cdk.mixins_preview.aws_iotfleetwise.mixins.CfnSignalCatalogPropsMixin(props, *, strategy=None)

Bases: Mixin

Creates a collection of standardized signals that can be reused to create vehicle models.

For more information, see Signal catalogs in the AWS IoT FleetWise Developer Guide .

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotfleetwise-signalcatalog.html
CloudformationResource:: AWS::IoTFleetWise::SignalCatalog
Mixin:: true
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.mixins_preview import mixins
from aws_cdk.mixins_preview.aws_iotfleetwise import mixins as iotfleetwise_mixins

cfn_signal_catalog_props_mixin = iotfleetwise_mixins.CfnSignalCatalogPropsMixin(iotfleetwise_mixins.CfnSignalCatalogMixinProps(
    description="description",
    name="name",
    node_counts=iotfleetwise_mixins.CfnSignalCatalogPropsMixin.NodeCountsProperty(
        total_actuators=123,
        total_attributes=123,
        total_branches=123,
        total_nodes=123,
        total_sensors=123
    ),
    nodes=[iotfleetwise_mixins.CfnSignalCatalogPropsMixin.NodeProperty(
        actuator=iotfleetwise_mixins.CfnSignalCatalogPropsMixin.ActuatorProperty(
            allowed_values=["allowedValues"],
            assigned_value="assignedValue",
            data_type="dataType",
            description="description",
            fully_qualified_name="fullyQualifiedName",
            max=123,
            min=123,
            unit="unit"
        ),
        attribute=iotfleetwise_mixins.CfnSignalCatalogPropsMixin.AttributeProperty(
            allowed_values=["allowedValues"],
            assigned_value="assignedValue",
            data_type="dataType",
            default_value="defaultValue",
            description="description",
            fully_qualified_name="fullyQualifiedName",
            max=123,
            min=123,
            unit="unit"
        ),
        branch=iotfleetwise_mixins.CfnSignalCatalogPropsMixin.BranchProperty(
            description="description",
            fully_qualified_name="fullyQualifiedName"
        ),
        sensor=iotfleetwise_mixins.CfnSignalCatalogPropsMixin.SensorProperty(
            allowed_values=["allowedValues"],
            data_type="dataType",
            description="description",
            fully_qualified_name="fullyQualifiedName",
            max=123,
            min=123,
            unit="unit"
        )
    )],
    tags=[CfnTag(
        key="key",
        value="value"
    )]
),
    strategy=mixins.PropertyMergeStrategy.OVERRIDE
)

Create a mixin to apply properties to AWS::IoTFleetWise::SignalCatalog.

Parameters:

props (Union[CfnSignalCatalogMixinProps, Dict[str, Any]]) – L1 properties to apply.
strategy (Optional[PropertyMergeStrategy]) – (experimental) Strategy for merging nested properties. Default: - PropertyMergeStrategy.MERGE

Methods

apply_to(construct)

Apply the mixin properties to the construct.

Parameters:: construct (IConstruct)
Return type:: IConstruct

supports(construct)

Check if this mixin supports the given construct.

Parameters:: construct (IConstruct)
Return type:: bool

Attributes

CFN_PROPERTY_KEYS = ['description', 'name', 'nodeCounts', 'nodes', 'tags']

Static Methods

classmethod is_mixin(x)

(experimental) Checks if x is a Mixin.

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

ActuatorProperty

class CfnSignalCatalogPropsMixin.ActuatorProperty(*, allowed_values=None, assigned_value=None, data_type=None, description=None, fully_qualified_name=None, max=None, min=None, unit=None)

Bases: object

A signal that represents a vehicle device such as the engine, heater, and door locks.

Data from an actuator reports the state of a certain vehicle device. .. epigraph:

Updating actuator data can change the state of a device. For example, you can turn on or off the heater by updating its actuator data.

Parameters:

allowed_values (Optional[Sequence[str]]) – A list of possible values an actuator can take.
assigned_value (Optional[str]) – A specified value for the actuator.
data_type (Optional[str]) – The specified data type of the actuator.
description (Optional[str]) – A brief description of the actuator.
fully_qualified_name (Optional[str]) – The fully qualified name of the actuator. For example, the fully qualified name of an actuator might be Vehicle.Front.Left.Door.Lock .
max (Union[int, float, None]) – The specified possible maximum value of an actuator.
min (Union[int, float, None]) – The specified possible minimum value of an actuator.
unit (Optional[str]) – The scientific unit for the actuator.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotfleetwise-signalcatalog-actuator.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.mixins_preview.aws_iotfleetwise import mixins as iotfleetwise_mixins

actuator_property = iotfleetwise_mixins.CfnSignalCatalogPropsMixin.ActuatorProperty(
    allowed_values=["allowedValues"],
    assigned_value="assignedValue",
    data_type="dataType",
    description="description",
    fully_qualified_name="fullyQualifiedName",
    max=123,
    min=123,
    unit="unit"
)

Attributes

allowed_values

A list of possible values an actuator can take.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotfleetwise-signalcatalog-actuator.html#cfn-iotfleetwise-signalcatalog-actuator-allowedvalues

assigned_value

A specified value for the actuator.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotfleetwise-signalcatalog-actuator.html#cfn-iotfleetwise-signalcatalog-actuator-assignedvalue

data_type

The specified data type of the actuator.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotfleetwise-signalcatalog-actuator.html#cfn-iotfleetwise-signalcatalog-actuator-datatype

description

A brief description of the actuator.

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

fully_qualified_name

The fully qualified name of the actuator.

For example, the fully qualified name of an actuator might be Vehicle.Front.Left.Door.Lock .

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

max

The specified possible maximum value of an actuator.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotfleetwise-signalcatalog-actuator.html#cfn-iotfleetwise-signalcatalog-actuator-max

min

The specified possible minimum value of an actuator.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotfleetwise-signalcatalog-actuator.html#cfn-iotfleetwise-signalcatalog-actuator-min

unit

The scientific unit for the actuator.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotfleetwise-signalcatalog-actuator.html#cfn-iotfleetwise-signalcatalog-actuator-unit

AttributeProperty

class CfnSignalCatalogPropsMixin.AttributeProperty(*, allowed_values=None, assigned_value=None, data_type=None, default_value=None, description=None, fully_qualified_name=None, max=None, min=None, unit=None)

Bases: object

A signal that represents static information about the vehicle, such as engine type or manufacturing date.

Parameters:

allowed_values (Optional[Sequence[str]]) – A list of possible values an attribute can be assigned.
assigned_value (Optional[str]) – A specified value for the attribute.
data_type (Optional[str]) – The specified data type of the attribute.
default_value (Optional[str]) – The default value of the attribute.
description (Optional[str]) – A brief description of the attribute.
fully_qualified_name (Optional[str]) – The fully qualified name of the attribute. For example, the fully qualified name of an attribute might be Vehicle.Body.Engine.Type .
max (Union[int, float, None]) – The specified possible maximum value of the attribute.
min (Union[int, float, None]) – The specified possible minimum value of the attribute.
unit (Optional[str]) – The scientific unit for the attribute.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotfleetwise-signalcatalog-attribute.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.mixins_preview.aws_iotfleetwise import mixins as iotfleetwise_mixins

attribute_property = iotfleetwise_mixins.CfnSignalCatalogPropsMixin.AttributeProperty(
    allowed_values=["allowedValues"],
    assigned_value="assignedValue",
    data_type="dataType",
    default_value="defaultValue",
    description="description",
    fully_qualified_name="fullyQualifiedName",
    max=123,
    min=123,
    unit="unit"
)

Attributes

allowed_values

A list of possible values an attribute can be assigned.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotfleetwise-signalcatalog-attribute.html#cfn-iotfleetwise-signalcatalog-attribute-allowedvalues

assigned_value

A specified value for the attribute.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotfleetwise-signalcatalog-attribute.html#cfn-iotfleetwise-signalcatalog-attribute-assignedvalue

data_type

The specified data type of the attribute.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotfleetwise-signalcatalog-attribute.html#cfn-iotfleetwise-signalcatalog-attribute-datatype

default_value

The default value of the attribute.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotfleetwise-signalcatalog-attribute.html#cfn-iotfleetwise-signalcatalog-attribute-defaultvalue

description

A brief description of the attribute.

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

fully_qualified_name

The fully qualified name of the attribute.

For example, the fully qualified name of an attribute might be Vehicle.Body.Engine.Type .

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

max

The specified possible maximum value of the attribute.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotfleetwise-signalcatalog-attribute.html#cfn-iotfleetwise-signalcatalog-attribute-max

min

The specified possible minimum value of the attribute.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotfleetwise-signalcatalog-attribute.html#cfn-iotfleetwise-signalcatalog-attribute-min

unit

The scientific unit for the attribute.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotfleetwise-signalcatalog-attribute.html#cfn-iotfleetwise-signalcatalog-attribute-unit

BranchProperty

class CfnSignalCatalogPropsMixin.BranchProperty(*, description=None, fully_qualified_name=None)

Bases: object

A group of signals that are defined in a hierarchical structure.

Parameters:

description (Optional[str]) – A brief description of the branch.
fully_qualified_name (Optional[str]) – The fully qualified name of the branch. For example, the fully qualified name of a branch might be Vehicle.Body.Engine .

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotfleetwise-signalcatalog-branch.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.mixins_preview.aws_iotfleetwise import mixins as iotfleetwise_mixins

branch_property = iotfleetwise_mixins.CfnSignalCatalogPropsMixin.BranchProperty(
    description="description",
    fully_qualified_name="fullyQualifiedName"
)

Attributes

description

A brief description of the branch.

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

fully_qualified_name

The fully qualified name of the branch.

For example, the fully qualified name of a branch might be Vehicle.Body.Engine .

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

NodeCountsProperty

class CfnSignalCatalogPropsMixin.NodeCountsProperty(*, total_actuators=None, total_attributes=None, total_branches=None, total_nodes=None, total_sensors=None)

Bases: object

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

Parameters:

total_actuators (Union[int, float, None]) – The total number of nodes in a vehicle network that represent actuators.
total_attributes (Union[int, float, None]) – The total number of nodes in a vehicle network that represent attributes.
total_branches (Union[int, float, None]) – The total number of nodes in a vehicle network that represent branches.
total_nodes (Union[int, float, None]) – The total number of nodes in a vehicle network.
total_sensors (Union[int, float, None]) – The total number of nodes in a vehicle network that represent sensors.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotfleetwise-signalcatalog-nodecounts.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.mixins_preview.aws_iotfleetwise import mixins as iotfleetwise_mixins

node_counts_property = iotfleetwise_mixins.CfnSignalCatalogPropsMixin.NodeCountsProperty(
    total_actuators=123,
    total_attributes=123,
    total_branches=123,
    total_nodes=123,
    total_sensors=123
)

Attributes

total_actuators

The total number of nodes in a vehicle network that represent actuators.

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

total_attributes

The total number of nodes in a vehicle network that represent attributes.

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

total_branches

The total number of nodes in a vehicle network that represent branches.

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

total_nodes

The total number of nodes in a vehicle network.

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

total_sensors

The total number of nodes in a vehicle network that represent sensors.

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

NodeProperty

class CfnSignalCatalogPropsMixin.NodeProperty(*, actuator=None, attribute=None, branch=None, sensor=None)

Bases: object

A general abstraction of a signal.

A node can be specified as an actuator, attribute, branch, or sensor.

Parameters:

actuator (Union[IResolvable, ActuatorProperty, Dict[str, Any], None]) – Information about a node specified as an actuator. .. epigraph:: An actuator is a digital representation of a vehicle device.
attribute (Union[IResolvable, AttributeProperty, Dict[str, Any], None]) – Information about a node specified as an attribute. .. epigraph:: An attribute represents static information about a vehicle.
branch (Union[IResolvable, BranchProperty, Dict[str, Any], None]) – Information about a node specified as a branch. .. epigraph:: A group of signals that are defined in a hierarchical structure.
sensor (Union[IResolvable, SensorProperty, Dict[str, Any], None]) – An input component that reports the environmental condition of a vehicle. .. epigraph:: You can collect data about fluid levels, temperatures, vibrations, or battery voltage from sensors.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotfleetwise-signalcatalog-node.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.mixins_preview.aws_iotfleetwise import mixins as iotfleetwise_mixins

node_property = iotfleetwise_mixins.CfnSignalCatalogPropsMixin.NodeProperty(
    actuator=iotfleetwise_mixins.CfnSignalCatalogPropsMixin.ActuatorProperty(
        allowed_values=["allowedValues"],
        assigned_value="assignedValue",
        data_type="dataType",
        description="description",
        fully_qualified_name="fullyQualifiedName",
        max=123,
        min=123,
        unit="unit"
    ),
    attribute=iotfleetwise_mixins.CfnSignalCatalogPropsMixin.AttributeProperty(
        allowed_values=["allowedValues"],
        assigned_value="assignedValue",
        data_type="dataType",
        default_value="defaultValue",
        description="description",
        fully_qualified_name="fullyQualifiedName",
        max=123,
        min=123,
        unit="unit"
    ),
    branch=iotfleetwise_mixins.CfnSignalCatalogPropsMixin.BranchProperty(
        description="description",
        fully_qualified_name="fullyQualifiedName"
    ),
    sensor=iotfleetwise_mixins.CfnSignalCatalogPropsMixin.SensorProperty(
        allowed_values=["allowedValues"],
        data_type="dataType",
        description="description",
        fully_qualified_name="fullyQualifiedName",
        max=123,
        min=123,
        unit="unit"
    )
)

Attributes

actuator

Information about a node specified as an actuator.

An actuator is a digital representation of a vehicle device.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotfleetwise-signalcatalog-node.html#cfn-iotfleetwise-signalcatalog-node-actuator

attribute

Information about a node specified as an attribute.

An attribute represents static information about a vehicle.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotfleetwise-signalcatalog-node.html#cfn-iotfleetwise-signalcatalog-node-attribute

branch

Information about a node specified as a branch.

A group of signals that are defined in a hierarchical structure.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotfleetwise-signalcatalog-node.html#cfn-iotfleetwise-signalcatalog-node-branch

sensor

An input component that reports the environmental condition of a vehicle.

You can collect data about fluid levels, temperatures, vibrations, or battery voltage from sensors.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotfleetwise-signalcatalog-node.html#cfn-iotfleetwise-signalcatalog-node-sensor

SensorProperty

class CfnSignalCatalogPropsMixin.SensorProperty(*, allowed_values=None, data_type=None, description=None, fully_qualified_name=None, max=None, min=None, unit=None)

Bases: object

An input component that reports the environmental condition of a vehicle.

You can collect data about fluid levels, temperatures, vibrations, or battery voltage from sensors.

Parameters:

allowed_values (Optional[Sequence[str]]) – A list of possible values a sensor can take.
data_type (Optional[str]) – The specified data type of the sensor.
description (Optional[str]) – A brief description of a sensor.
fully_qualified_name (Optional[str]) – The fully qualified name of the sensor. For example, the fully qualified name of a sensor might be Vehicle.Body.Engine.Battery .
max (Union[int, float, None]) – The specified possible maximum value of the sensor.
min (Union[int, float, None]) – The specified possible minimum value of the sensor.
unit (Optional[str]) – The scientific unit of measurement for data collected by the sensor.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotfleetwise-signalcatalog-sensor.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.mixins_preview.aws_iotfleetwise import mixins as iotfleetwise_mixins

sensor_property = iotfleetwise_mixins.CfnSignalCatalogPropsMixin.SensorProperty(
    allowed_values=["allowedValues"],
    data_type="dataType",
    description="description",
    fully_qualified_name="fullyQualifiedName",
    max=123,
    min=123,
    unit="unit"
)