software.amazon.awscdk.services.iotfleetwise

Class CfnSignalCatalog

java.lang.Object

software.constructs.Construct

software.amazon.awscdk.core.Construct

software.amazon.awscdk.core.CfnElement

software.amazon.awscdk.core.CfnRefElement

software.amazon.awscdk.core.CfnResource

software.amazon.awscdk.services.iotfleetwise.CfnSignalCatalog

All Implemented Interfaces:

IConstruct, IDependable, IInspectable

@Generated(value="jsii-pacmak/1.74.0 (build 6d08790)",
           date="2023-03-22T19:35:37.029Z")
public class CfnSignalCatalog
extends CfnResource
implements IInspectable

A CloudFormation `AWS::IoTFleetWise::SignalCatalog`.

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

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.*;
 CfnSignalCatalog cfnSignalCatalog = CfnSignalCatalog.Builder.create(this, "MyCfnSignalCatalog")
         .description("description")
         .name("name")
         .nodeCounts(NodeCountsProperty.builder()
                 .totalActuators(123)
                 .totalAttributes(123)
                 .totalBranches(123)
                 .totalNodes(123)
                 .totalSensors(123)
                 .build())
         .nodes(List.of(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()))
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	CfnSignalCatalog.ActuatorProperty A signal that represents a vehicle device such as the engine, heater, and door locks.
static interface	CfnSignalCatalog.AttributeProperty A signal that represents static information about the vehicle, such as engine type or manufacturing date.
static interface	CfnSignalCatalog.BranchProperty A group of signals that are defined in a hierarchical structure.
static class	CfnSignalCatalog.Builder A fluent builder for CfnSignalCatalog.
static interface	CfnSignalCatalog.NodeCountsProperty Information about the number of nodes and node types in a vehicle network.
static interface	CfnSignalCatalog.NodeProperty A general abstraction of a signal.
static interface	CfnSignalCatalog.SensorProperty An input component that reports the environmental condition of a vehicle.

Nested classes/interfaces inherited from interface software.amazon.awscdk.core.IInspectable

IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

Nested classes/interfaces inherited from interface software.amazon.awscdk.core.IConstruct

IConstruct.Jsii$Default

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	CFN_RESOURCE_TYPE_NAME The CloudFormation resource type name for this resource class.

Constructor Summary

Constructors

Modifier	Constructor and Description
	CfnSignalCatalog(Construct scope, java.lang.String id) Create a new `AWS::IoTFleetWise::SignalCatalog`.
	CfnSignalCatalog(Construct scope, java.lang.String id, CfnSignalCatalogProps props) Create a new `AWS::IoTFleetWise::SignalCatalog`.
protected	CfnSignalCatalog(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnSignalCatalog(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method and Description
java.lang.String	getAttrArn()
java.lang.String	getAttrCreationTime()
java.lang.String	getAttrLastModificationTime()
IResolvable	getAttrNodeCountsTotalActuators()
IResolvable	getAttrNodeCountsTotalAttributes()
IResolvable	getAttrNodeCountsTotalBranches()
IResolvable	getAttrNodeCountsTotalNodes()
IResolvable	getAttrNodeCountsTotalSensors()
protected java.util.Map<java.lang.String,java.lang.Object>	getCfnProperties()
java.lang.String	getDescription() `AWS::IoTFleetWise::SignalCatalog.Description`.
java.lang.String	getName() The name of the signal catalog.
java.lang.Object	getNodeCounts() `AWS::IoTFleetWise::SignalCatalog.NodeCounts`.
java.lang.Object	getNodes() `AWS::IoTFleetWise::SignalCatalog.Nodes`.
TagManager	getTags() `AWS::IoTFleetWise::SignalCatalog.Tags`.
void	inspect(TreeInspector inspector) Examines the CloudFormation resource and discloses attributes.
protected java.util.Map<java.lang.String,java.lang.Object>	renderProperties(java.util.Map<java.lang.String,java.lang.Object> props)
void	setDescription(java.lang.String value) `AWS::IoTFleetWise::SignalCatalog.Description`.
void	setName(java.lang.String value) The name of the signal catalog.
void	setNodeCounts(CfnSignalCatalog.NodeCountsProperty value) `AWS::IoTFleetWise::SignalCatalog.NodeCounts`.
void	setNodeCounts(IResolvable value) `AWS::IoTFleetWise::SignalCatalog.NodeCounts`.
void	setNodes(IResolvable value) `AWS::IoTFleetWise::SignalCatalog.Nodes`.
void	setNodes(java.util.List<java.lang.Object> value) `AWS::IoTFleetWise::SignalCatalog.Nodes`.

Methods inherited from class software.amazon.awscdk.core.CfnResource

addDeletionOverride, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, isCfnResource, shouldSynthesize, toString, validateProperties

Methods inherited from class software.amazon.awscdk.core.CfnRefElement

getRef

Methods inherited from class software.amazon.awscdk.core.CfnElement

getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId

Methods inherited from class software.amazon.awscdk.core.Construct

getNode, isConstruct, onPrepare, onSynthesize, onValidate, prepare, synthesize, validate

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

CFN_RESOURCE_TYPE_NAME

public static final java.lang.String CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

Constructor Detail

CfnSignalCatalog

protected CfnSignalCatalog(software.amazon.jsii.JsiiObjectRef objRef)

CfnSignalCatalog

protected CfnSignalCatalog(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

CfnSignalCatalog

public CfnSignalCatalog(Construct scope,
                        java.lang.String id,
                        CfnSignalCatalogProps props)

Create a new `AWS::IoTFleetWise::SignalCatalog`.

Parameters:

scope - - scope in which this resource is defined. This parameter is required.

id - - scoped id of the resource. This parameter is required.

props - - resource properties.

CfnSignalCatalog

public CfnSignalCatalog(Construct scope,
                        java.lang.String id)

Create a new `AWS::IoTFleetWise::SignalCatalog`.

Parameters:

scope - - scope in which this resource is defined. This parameter is required.

id - - scoped id of the resource. This parameter is required.

Method Detail

inspect

public void inspect(TreeInspector inspector)

Examines the CloudFormation resource and discloses attributes.

Specified by:

inspect in interface IInspectable

Parameters:

inspector - - tree inspector to collect and process attributes. This parameter is required.

renderProperties

protected java.util.Map<java.lang.String,java.lang.Object> renderProperties(java.util.Map<java.lang.String,java.lang.Object> props)

Overrides:

renderProperties in class CfnResource

Parameters:

props - This parameter is required.

getAttrArn

public java.lang.String getAttrArn()

getAttrCreationTime

public java.lang.String getAttrCreationTime()

getAttrLastModificationTime

public java.lang.String getAttrLastModificationTime()

getAttrNodeCountsTotalActuators

public IResolvable getAttrNodeCountsTotalActuators()

getAttrNodeCountsTotalAttributes

public IResolvable getAttrNodeCountsTotalAttributes()

getAttrNodeCountsTotalBranches

public IResolvable getAttrNodeCountsTotalBranches()

getAttrNodeCountsTotalNodes

public IResolvable getAttrNodeCountsTotalNodes()

getAttrNodeCountsTotalSensors

public IResolvable getAttrNodeCountsTotalSensors()

getCfnProperties

protected java.util.Map<java.lang.String,java.lang.Object> getCfnProperties()

Overrides:

getCfnProperties in class CfnResource

getTags

public TagManager getTags()

`AWS::IoTFleetWise::SignalCatalog.Tags`.

getDescription

public java.lang.String getDescription()

`AWS::IoTFleetWise::SignalCatalog.Description`.

setDescription

public void setDescription(java.lang.String value)

`AWS::IoTFleetWise::SignalCatalog.Description`.

getName

public java.lang.String getName()

The name of the signal catalog.

setName

public void setName(java.lang.String value)

The name of the signal catalog.

getNodeCounts

public java.lang.Object getNodeCounts()

`AWS::IoTFleetWise::SignalCatalog.NodeCounts`.

setNodeCounts

public void setNodeCounts(IResolvable value)

`AWS::IoTFleetWise::SignalCatalog.NodeCounts`.

setNodeCounts

public void setNodeCounts(CfnSignalCatalog.NodeCountsProperty value)

`AWS::IoTFleetWise::SignalCatalog.NodeCounts`.

getNodes

public java.lang.Object getNodes()

`AWS::IoTFleetWise::SignalCatalog.Nodes`.

setNodes

public void setNodes(IResolvable value)

`AWS::IoTFleetWise::SignalCatalog.Nodes`.

setNodes

public void setNodes(java.util.List<java.lang.Object> value)

`AWS::IoTFleetWise::SignalCatalog.Nodes`.