Package software.amazon.awscdk.services.iotfleetwise

Interface CfnSignalCatalog.NodeProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnSignalCatalog.NodeProperty.Jsii$Proxy

Enclosing class:

CfnSignalCatalog

@Stability(Stable)
public static interface CfnSignalCatalog.NodeProperty
extends software.amazon.jsii.JsiiSerializable

A general abstraction of a signal.

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

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.iotfleetwise.*;
 NodeProperty nodeProperty = NodeProperty.builder()
         .actuator(ActuatorProperty.builder()
                 .dataType("dataType")
                 .fullyQualifiedName("fullyQualifiedName")
                 // the properties below are optional
                 .allowedValues(List.of("allowedValues"))
                 .assignedValue("assignedValue")
                 .description("description")
                 .max(123)
                 .min(123)
                 .unit("unit")
                 .build())
         .attribute(AttributeProperty.builder()
                 .dataType("dataType")
                 .fullyQualifiedName("fullyQualifiedName")
                 // the properties below are optional
                 .allowedValues(List.of("allowedValues"))
                 .assignedValue("assignedValue")
                 .defaultValue("defaultValue")
                 .description("description")
                 .max(123)
                 .min(123)
                 .unit("unit")
                 .build())
         .branch(BranchProperty.builder()
                 .fullyQualifiedName("fullyQualifiedName")
                 // the properties below are optional
                 .description("description")
                 .build())
         .sensor(SensorProperty.builder()
                 .dataType("dataType")
                 .fullyQualifiedName("fullyQualifiedName")
                 // the properties below are optional
                 .allowedValues(List.of("allowedValues"))
                 .description("description")
                 .max(123)
                 .min(123)
                 .unit("unit")
                 .build())
         .build();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotfleetwise-signalcatalog-node.html

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnSignalCatalog.NodeProperty.Builder	A builder for CfnSignalCatalog.NodeProperty
static final class	CfnSignalCatalog.NodeProperty.Jsii$Proxy	An implementation for CfnSignalCatalog.NodeProperty

Method Summary

Modifier and Type	Method	Description
static CfnSignalCatalog.NodeProperty.Builder	builder()
default Object	getActuator()	(Optional) Information about a node specified as an actuator.
default Object	getAttribute()	(Optional) Information about a node specified as an attribute.
default Object	getBranch()	(Optional) Information about a node specified as a branch.
default Object	getSensor()	(Optional) An input component that reports the environmental condition of a vehicle.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getActuator

@Stability(Stable)
@Nullable
default Object getActuator()

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

An actuator is a digital representation of a vehicle device.

See Also:

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

getAttribute

@Stability(Stable)
@Nullable
default Object getAttribute()

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

An attribute represents static information about a vehicle.

See Also:

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

getBranch

@Stability(Stable)
@Nullable
default Object getBranch()

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

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

See Also:

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

getSensor

@Stability(Stable)
@Nullable
default Object getSensor()

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

See Also:

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

builder

@Stability(Stable)
static CfnSignalCatalog.NodeProperty.Builder builder()

Returns:

a CfnSignalCatalog.NodeProperty.Builder of CfnSignalCatalog.NodeProperty