AWS::IoTFleetWise::SignalCatalog - AWS CloudFormation
SyntaxPropertiesReturn values

This is the new AWS CloudFormation Template Reference Guide. Please update your bookmarks and links. For help getting started with CloudFormation, see the AWS CloudFormation User Guide.

AWS::IoTFleetWise::SignalCatalog

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.

Syntax

To declare this entity in your AWS CloudFormation template, use the following syntax:

JSON

{
  "Type" : "AWS::IoTFleetWise::SignalCatalog",
  "Properties" : {
      "Description" : String,
      "Name" : String,
      "NodeCounts" : NodeCounts,
      "Nodes" : [ Node, ... ],
      "Tags" : [ Tag, ... ]
    }
}

YAML

Type: AWS::IoTFleetWise::SignalCatalog
Properties:
  Description: String
  Name: String
  NodeCounts: 
    NodeCounts
  Nodes: 
    - Node
  Tags: 
    - Tag

Properties

Description

A brief description of the signal catalog.

Required: No

Type: String

Pattern: ^[^\u0000-\u001F\u007F]+$

Minimum: 1

Maximum: 2048

Update requires: No interruption

Name

The name of the signal catalog.

Required: No

Type: String

Pattern: ^[a-zA-Z\d\-_:]+$

Minimum: 1

Maximum: 100

Update requires: Replacement

NodeCounts

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

Required: No

Type: NodeCounts

Update requires: No interruption

Nodes

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

Required: No

Type: Array of Node

Minimum: 1

Maximum: 5000

Update requires: No interruption

Tags

Metadata that can be used to manage the signal catalog.

Required: No

Type: Array of Tag

Minimum: 0

Maximum: 50

Update requires: No interruption

Return values

Ref

When you pass the logical ID of this resource to the intrinsic Ref function, Ref returns the Name.

For more information about using the Ref function, see Ref.

Fn::GetAtt

The Fn::GetAtt intrinsic function returns a value for a specified attribute of this type. The following are the available attributes and sample return values.

For more information about using the Fn::GetAtt intrinsic function, see Fn::GetAtt.

Arn

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

CreationTime

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

LastModificationTime

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

NodeCounts.TotalActuators

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

NodeCounts.TotalAttributes

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

NodeCounts.TotalBranches

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

NodeCounts.TotalNodes

The total number of nodes in a vehicle network.

NodeCounts.TotalSensors

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