interface CfnSignalCatalogProps

Language	Type name
.NET	Amazon.CDK.AWS.IoTFleetWise.CfnSignalCatalogProps
Java	software.amazon.awscdk.services.iotfleetwise.CfnSignalCatalogProps
Python	aws_cdk.aws_iotfleetwise.CfnSignalCatalogProps
TypeScript	@aws-cdk/aws-iotfleetwise » CfnSignalCatalogProps

Properties for defining a CfnSignalCatalog.

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import * as iotfleetwise from '@aws-cdk/aws-iotfleetwise';
const cfnSignalCatalogProps: iotfleetwise.CfnSignalCatalogProps = {
  description: 'description',
  name: 'name',
  nodeCounts: {
    totalActuators: 123,
    totalAttributes: 123,
    totalBranches: 123,
    totalNodes: 123,
    totalSensors: 123,
  },
  nodes: [{
    actuator: {
      dataType: 'dataType',
      fullyQualifiedName: 'fullyQualifiedName',

      // the properties below are optional
      allowedValues: ['allowedValues'],
      assignedValue: 'assignedValue',
      description: 'description',
      max: 123,
      min: 123,
      unit: 'unit',
    },
    attribute: {
      dataType: 'dataType',
      fullyQualifiedName: 'fullyQualifiedName',

      // the properties below are optional
      allowedValues: ['allowedValues'],
      assignedValue: 'assignedValue',
      defaultValue: 'defaultValue',
      description: 'description',
      max: 123,
      min: 123,
      unit: 'unit',
    },
    branch: {
      fullyQualifiedName: 'fullyQualifiedName',

      // the properties below are optional
      description: 'description',
    },
    sensor: {
      dataType: 'dataType',
      fullyQualifiedName: 'fullyQualifiedName',

      // the properties below are optional
      allowedValues: ['allowedValues'],
      description: 'description',
      max: 123,
      min: 123,
      unit: 'unit',
    },
  }],
  tags: [{
    key: 'key',
    value: 'value',
  }],
};

Properties

Name	Type	Description
description?	string	(Optional) A brief description of the signal catalog.
name?	string	(Optional) The name of the signal catalog.
nodeCounts?	IResolvable | NodeCountsProperty	(Optional) Information about the number of nodes and node types in a vehicle network.
nodes?	IResolvable | IResolvable | NodeProperty[]	(Optional) A list of information about nodes, which are a general abstraction of signals.
tags?	CfnTag[]	(Optional) Metadata that can be used to manage the signal catalog.

---

description?

Type: string (optional)

(Optional) A brief description of the signal catalog.

---

name?

Type: string (optional)

(Optional) The name of the signal catalog.

---

nodeCounts?

Type: IResolvable | NodeCountsProperty (optional)

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

---

nodes?

Type: IResolvable | IResolvable | NodeProperty[] (optional)

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

---

tags?

Type: CfnTag[] (optional)

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