Class CfnSignalCatalog

A CloudFormation AWS::IoTFleetWise::SignalCatalog.

Inheritance
System.Object
Construct
CfnElement
CfnRefElement
CfnResource
CfnSignalCatalog
Implements
Constructs.IConstruct
Inherited Members
Namespace: Amazon.CDK.AWS.IoTFleetWise
Assembly: Amazon.CDK.AWS.IoTFleetWise.dll
Syntax (csharp)
public class CfnSignalCatalog : CfnResource, IConstruct, IDependable, IInspectable
Syntax (vb)
Public Class CfnSignalCatalog
    Inherits CfnResource
    Implements IConstruct, IDependable, IInspectable
Remarks

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

Examples
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.IoTFleetWise;

var cfnSignalCatalog = new CfnSignalCatalog(this, "MyCfnSignalCatalog", new CfnSignalCatalogProps {
    Description = "description",
    Name = "name",
    NodeCounts = new NodeCountsProperty {
        TotalActuators = 123,
        TotalAttributes = 123,
        TotalBranches = 123,
        TotalNodes = 123,
        TotalSensors = 123
    },
    Nodes = new [] { new NodeProperty {
        Actuator = new ActuatorProperty {
            DataType = "dataType",
            FullyQualifiedName = "fullyQualifiedName",

            // the properties below are optional
            AllowedValues = new [] { "allowedValues" },
            AssignedValue = "assignedValue",
            Description = "description",
            Max = 123,
            Min = 123,
            Unit = "unit"
        },
        Attribute = new AttributeProperty {
            DataType = "dataType",
            FullyQualifiedName = "fullyQualifiedName",

            // the properties below are optional
            AllowedValues = new [] { "allowedValues" },
            AssignedValue = "assignedValue",
            DefaultValue = "defaultValue",
            Description = "description",
            Max = 123,
            Min = 123,
            Unit = "unit"
        },
        Branch = new BranchProperty {
            FullyQualifiedName = "fullyQualifiedName",

            // the properties below are optional
            Description = "description"
        },
        Sensor = new SensorProperty {
            DataType = "dataType",
            FullyQualifiedName = "fullyQualifiedName",

            // the properties below are optional
            AllowedValues = new [] { "allowedValues" },
            Description = "description",
            Max = 123,
            Min = 123,
            Unit = "unit"
        }
    } },
    Tags = new [] { new CfnTag {
        Key = "key",
        Value = "value"
    } }
});

Synopsis

Constructors

CfnSignalCatalog(Construct, String, ICfnSignalCatalogProps)

Create a new AWS::IoTFleetWise::SignalCatalog.
CfnSignalCatalog(ByRefValue)

Used by jsii to construct an instance of this class from a Javascript-owned object reference
CfnSignalCatalog(DeputyBase.DeputyProps)

Used by jsii to construct an instance of this class from DeputyProps

Properties

AttrArn

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

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

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

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

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

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

The total number of nodes in a vehicle network.
AttrNodeCountsTotalSensors

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

The CloudFormation resource type name for this resource class.
CfnProperties
Description

(Optional) A brief description of the signal catalog.
Name

(Optional) The name of the signal catalog.
NodeCounts

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

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

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

Methods

Inspect(TreeInspector)

Examines the CloudFormation resource and discloses attributes.
RenderProperties(IDictionary<String, Object>)

Constructors

CfnSignalCatalog(Construct, String, ICfnSignalCatalogProps)

Create a new AWS::IoTFleetWise::SignalCatalog.

public CfnSignalCatalog(Construct scope, string id, ICfnSignalCatalogProps props = null)
Parameters
scope Construct
  • scope in which this resource is defined.
id System.String
  • scoped id of the resource.
props ICfnSignalCatalogProps
  • resource properties.

CfnSignalCatalog(ByRefValue)

Used by jsii to construct an instance of this class from a Javascript-owned object reference

protected CfnSignalCatalog(ByRefValue reference)
Parameters
reference Amazon.JSII.Runtime.Deputy.ByRefValue

The Javascript-owned object reference

CfnSignalCatalog(DeputyBase.DeputyProps)

Used by jsii to construct an instance of this class from DeputyProps

protected CfnSignalCatalog(DeputyBase.DeputyProps props)
Parameters
props Amazon.JSII.Runtime.Deputy.DeputyBase.DeputyProps

The deputy props

Properties

AttrArn

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

public virtual string AttrArn { get; }
Property Value

System.String

Remarks

CloudformationAttribute: Arn

AttrCreationTime

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

public virtual string AttrCreationTime { get; }
Property Value

System.String

Remarks

CloudformationAttribute: CreationTime

AttrLastModificationTime

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

public virtual string AttrLastModificationTime { get; }
Property Value

System.String

Remarks

CloudformationAttribute: LastModificationTime

AttrNodeCountsTotalActuators

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

public virtual IResolvable AttrNodeCountsTotalActuators { get; }
Property Value

IResolvable

Remarks

CloudformationAttribute: NodeCounts.TotalActuators

AttrNodeCountsTotalAttributes

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

public virtual IResolvable AttrNodeCountsTotalAttributes { get; }
Property Value

IResolvable

Remarks

CloudformationAttribute: NodeCounts.TotalAttributes

AttrNodeCountsTotalBranches

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

public virtual IResolvable AttrNodeCountsTotalBranches { get; }
Property Value

IResolvable

Remarks

CloudformationAttribute: NodeCounts.TotalBranches

AttrNodeCountsTotalNodes

The total number of nodes in a vehicle network.

public virtual IResolvable AttrNodeCountsTotalNodes { get; }
Property Value

IResolvable

Remarks

CloudformationAttribute: NodeCounts.TotalNodes

AttrNodeCountsTotalSensors

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

public virtual IResolvable AttrNodeCountsTotalSensors { get; }
Property Value

IResolvable

Remarks

CloudformationAttribute: NodeCounts.TotalSensors

CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

public static string CFN_RESOURCE_TYPE_NAME { get; }
Property Value

System.String

CfnProperties

protected override IDictionary<string, object> CfnProperties { get; }
Property Value

System.Collections.Generic.IDictionary<System.String, System.Object>

Overrides

Description

(Optional) A brief description of the signal catalog.

public virtual string Description { get; set; }
Property Value

System.String

Remarks

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

Name

(Optional) The name of the signal catalog.

public virtual string Name { get; set; }
Property Value

System.String

Remarks

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

NodeCounts

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

public virtual object NodeCounts { get; set; }
Property Value

System.Object

Remarks

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.

public virtual object Nodes { get; set; }
Property Value

System.Object

Remarks

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

Tags

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

public virtual TagManager Tags { get; }
Property Value

TagManager

Remarks

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

Methods

Inspect(TreeInspector)

Examines the CloudFormation resource and discloses attributes.

public virtual void Inspect(TreeInspector inspector)
Parameters
inspector TreeInspector
  • tree inspector to collect and process attributes.

RenderProperties(IDictionary<String, Object>)

protected override IDictionary<string, object> RenderProperties(IDictionary<string, object> props)
Parameters
props System.Collections.Generic.IDictionary<System.String, System.Object>
Returns

System.Collections.Generic.IDictionary<System.String, System.Object>

Overrides

Implements

Constructs.IConstruct