CfnSignalCatalog

class aws_cdk.aws_iotfleetwise.CfnSignalCatalog(scope, id, *, description=None, name=None, node_counts=None, nodes=None, tags=None)

Bases: CfnResource

A CloudFormation AWS::IoTFleetWise::SignalCatalog.

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

CloudformationResource:: AWS::IoTFleetWise::SignalCatalog
Link:: 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.
import aws_cdk.aws_iotfleetwise as iotfleetwise

cfn_signal_catalog = iotfleetwise.CfnSignalCatalog(self, "MyCfnSignalCatalog",
    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"
    )]
)

Create a new AWS::IoTFleetWise::SignalCatalog.

Parameters:

scope (Construct) –
- scope in which this resource is defined.
id (str) –
- scoped id of the resource.
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.

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

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 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: 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 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:: 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

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::SignalCatalog'

attr_arn

The Amazon Resource Name (ARN) of the signal catalog.

CloudformationAttribute:: Arn

attr_creation_time

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

CloudformationAttribute:: CreationTime

attr_last_modification_time

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

CloudformationAttribute:: LastModificationTime

attr_node_counts_total_actuators

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

CloudformationAttribute:: NodeCounts.TotalActuators

attr_node_counts_total_attributes

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

CloudformationAttribute:: NodeCounts.TotalAttributes

attr_node_counts_total_branches

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

CloudformationAttribute:: NodeCounts.TotalBranches

attr_node_counts_total_nodes

The total number of nodes in a vehicle network.

CloudformationAttribute:: NodeCounts.TotalNodes

attr_node_counts_total_sensors

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

CloudformationAttribute:: NodeCounts.TotalSensors

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 signal catalog.

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

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.

name

(Optional) The name of the signal catalog.

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

node: The construct tree node associated with this construct.

node_counts

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

Link:: 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.

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

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 }).

stack

The stack in which this element is defined.

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

tags

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

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

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(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

ActuatorProperty

class CfnSignalCatalog.ActuatorProperty(*, data_type, fully_qualified_name, allowed_values=None, assigned_value=None, description=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:

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

Link:

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.
import aws_cdk.aws_iotfleetwise as iotfleetwise

actuator_property = 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"
)

Attributes

allowed_values

(Optional) A list of possible values an actuator can take.

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

assigned_value

(Optional) A specified value for the actuator.

Link:: 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.

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

description

(Optional) A brief description of the actuator.

Link:: 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 .

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

max

(Optional) The specified possible maximum value of an actuator.

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

min

(Optional) The specified possible minimum value of an actuator.

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

unit

(Optional) The scientific unit for the actuator.

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

AttributeProperty

class CfnSignalCatalog.AttributeProperty(*, data_type, fully_qualified_name, allowed_values=None, assigned_value=None, default_value=None, description=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:

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

Link:

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.
import aws_cdk.aws_iotfleetwise as iotfleetwise

attribute_property = 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"
)

Attributes

allowed_values

(Optional) A list of possible values an attribute can be assigned.

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

assigned_value

(Optional) A specified value for the attribute.

Link:: 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.

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

default_value

(Optional) The default value of the attribute.

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

description

(Optional) A brief description of the attribute.

Link:: 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 .

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

max

(Optional) The specified possible maximum value of the attribute.

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

min

(Optional) The specified possible minimum value of the attribute.

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

unit

(Optional) The scientific unit for the attribute.

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

BranchProperty

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

Bases: object

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

Parameters:

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

Link:

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.
import aws_cdk.aws_iotfleetwise as iotfleetwise

branch_property = iotfleetwise.CfnSignalCatalog.BranchProperty(
    fully_qualified_name="fullyQualifiedName",

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

Attributes

description

(Optional) A brief description of the branch.

Link:: 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 .

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

NodeCountsProperty

class CfnSignalCatalog.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]) – (Optional) The total number of nodes in a vehicle network that represent actuators.
total_attributes (Union[int, float, None]) – (Optional) The total number of nodes in a vehicle network that represent attributes.
total_branches (Union[int, float, None]) – (Optional) The total number of nodes in a vehicle network that represent branches.
total_nodes (Union[int, float, None]) – (Optional) The total number of nodes in a vehicle network.
total_sensors (Union[int, float, None]) – (Optional) The total number of nodes in a vehicle network that represent sensors.

Link:

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.
import aws_cdk.aws_iotfleetwise as iotfleetwise

node_counts_property = iotfleetwise.CfnSignalCatalog.NodeCountsProperty(
    total_actuators=123,
    total_attributes=123,
    total_branches=123,
    total_nodes=123,
    total_sensors=123
)

Attributes

total_actuators

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

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

total_attributes

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

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

total_branches

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

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

total_nodes

(Optional) The total number of nodes in a vehicle network.

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

total_sensors

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

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

NodeProperty

class CfnSignalCatalog.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]) – (Optional) 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]) – (Optional) 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]) – (Optional) 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]) – (Optional) 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.

Link:

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.
import aws_cdk.aws_iotfleetwise as iotfleetwise

node_property = 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"
    )
)

Attributes

actuator

(Optional) Information about a node specified as an actuator.

An actuator is a digital representation of a vehicle device.

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

attribute

(Optional) Information about a node specified as an attribute.

An attribute represents static information about a vehicle.

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

branch

(Optional) Information about a node specified as a branch.

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

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

sensor

(Optional) 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.

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

SensorProperty

class CfnSignalCatalog.SensorProperty(*, data_type, fully_qualified_name, allowed_values=None, description=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:

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

Link:

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.
import aws_cdk.aws_iotfleetwise as iotfleetwise

sensor_property = 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"
)