Class CfnSignalCatalog
java.lang.Object
software.amazon.jsii.JsiiObject
software.constructs.Construct
software.amazon.awscdk.CfnElement
software.amazon.awscdk.CfnRefElement
software.amazon.awscdk.CfnResource
software.amazon.awscdk.services.iotfleetwise.CfnSignalCatalog
- All Implemented Interfaces:
IInspectable
,ITaggable
,software.amazon.jsii.JsiiSerializable
,software.constructs.IConstruct
,software.constructs.IDependable
@Generated(value="jsii-pacmak/1.103.1 (build bef2dea)",
date="2024-09-24T10:56:33.579Z")
@Stability(Stable)
public class CfnSignalCatalog
extends CfnResource
implements IInspectable, ITaggable
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();
- See Also:
-
Nested Class Summary
Modifier and TypeClassDescriptionstatic interface
A signal that represents a vehicle device such as the engine, heater, and door locks.static interface
A signal that represents static information about the vehicle, such as engine type or manufacturing date.static interface
A group of signals that are defined in a hierarchical structure.static final class
A fluent builder forCfnSignalCatalog
.static interface
Information about the number of nodes and node types in a vehicle network.static interface
A general abstraction of a signal.static interface
An input component that reports the environmental condition of a vehicle.Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject
software.amazon.jsii.JsiiObject.InitializationMode
Nested classes/interfaces inherited from interface software.constructs.IConstruct
software.constructs.IConstruct.Jsii$Default
Nested classes/interfaces inherited from interface software.amazon.awscdk.IInspectable
IInspectable.Jsii$Default, IInspectable.Jsii$Proxy
Nested classes/interfaces inherited from interface software.amazon.awscdk.ITaggable
ITaggable.Jsii$Default, ITaggable.Jsii$Proxy
-
Field Summary
Modifier and TypeFieldDescriptionstatic final String
The CloudFormation resource type name for this resource class. -
Constructor Summary
ModifierConstructorDescriptionprotected
CfnSignalCatalog
(software.amazon.jsii.JsiiObject.InitializationMode initializationMode) protected
CfnSignalCatalog
(software.amazon.jsii.JsiiObjectRef objRef) CfnSignalCatalog
(software.constructs.Construct scope, String id) CfnSignalCatalog
(software.constructs.Construct scope, String id, CfnSignalCatalogProps props) -
Method Summary
Modifier and TypeMethodDescriptionThe Amazon Resource Name (ARN) of the signal catalog.The time the signal catalog was created in seconds since epoch (January 1, 1970 at midnight UTC time).The time the signal catalog was last updated in seconds since epoch (January 1, 1970 at midnight UTC time).The total number of nodes in a vehicle network that represent actuators.The total number of nodes in a vehicle network that represent attributes.The total number of nodes in a vehicle network that represent branches.The total number of nodes in a vehicle network.The total number of nodes in a vehicle network that represent sensors.(Optional) A brief description of the signal catalog.getName()
(Optional) The name of the signal catalog.(Optional) Information about the number of nodes and node types in a vehicle network.getNodes()
(Optional) A list of information about nodes, which are a general abstraction of signals.getTags()
Tag Manager which manages the tags for this resource.(Optional) Metadata that can be used to manage the signal catalog.void
inspect
(TreeInspector inspector) Examines the CloudFormation resource and discloses attributes.renderProperties
(Map<String, Object> props) void
setDescription
(String value) (Optional) A brief description of the signal catalog.void
(Optional) The name of the signal catalog.void
setNodeCounts
(IResolvable value) (Optional) Information about the number of nodes and node types in a vehicle network.void
(Optional) Information about the number of nodes and node types in a vehicle network.void
(Optional) A list of information about nodes, which are a general abstraction of signals.void
setNodes
(IResolvable value) (Optional) A list of information about nodes, which are a general abstraction of signals.void
setTagsRaw
(List<CfnTag> value) (Optional) Metadata that can be used to manage the signal catalog.Methods inherited from class software.amazon.awscdk.CfnResource
addDeletionOverride, addDependency, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, getUpdatedProperties, isCfnResource, obtainDependencies, obtainResourceDependencies, removeDependency, replaceDependency, shouldSynthesize, toString, validateProperties
Methods inherited from class software.amazon.awscdk.CfnRefElement
getRef
Methods inherited from class software.amazon.awscdk.CfnElement
getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId
Methods inherited from class software.constructs.Construct
getNode, isConstruct
Methods inherited from class software.amazon.jsii.JsiiObject
jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
Methods inherited from interface software.amazon.jsii.JsiiSerializable
$jsii$toJson
-
Field Details
-
CFN_RESOURCE_TYPE_NAME
The CloudFormation resource type name for this resource class.
-
-
Constructor Details
-
CfnSignalCatalog
protected CfnSignalCatalog(software.amazon.jsii.JsiiObjectRef objRef) -
CfnSignalCatalog
protected CfnSignalCatalog(software.amazon.jsii.JsiiObject.InitializationMode initializationMode) -
CfnSignalCatalog
@Stability(Stable) public CfnSignalCatalog(@NotNull software.constructs.Construct scope, @NotNull String id, @Nullable CfnSignalCatalogProps props) - Parameters:
scope
- Scope in which this resource is defined. This parameter is required.id
- Construct identifier for this resource (unique in its scope). This parameter is required.props
- Resource properties.
-
CfnSignalCatalog
@Stability(Stable) public CfnSignalCatalog(@NotNull software.constructs.Construct scope, @NotNull String id) - Parameters:
scope
- Scope in which this resource is defined. This parameter is required.id
- Construct identifier for this resource (unique in its scope). This parameter is required.
-
-
Method Details
-
inspect
Examines the CloudFormation resource and discloses attributes.- Specified by:
inspect
in interfaceIInspectable
- Parameters:
inspector
- tree inspector to collect and process attributes. This parameter is required.
-
renderProperties
@Stability(Stable) @NotNull protected Map<String,Object> renderProperties(@NotNull Map<String, Object> props) - Overrides:
renderProperties
in classCfnResource
- Parameters:
props
- This parameter is required.
-
getAttrArn
The Amazon Resource Name (ARN) of the signal catalog. -
getAttrCreationTime
The time the signal catalog was created in seconds since epoch (January 1, 1970 at midnight UTC time). -
getAttrLastModificationTime
The time the signal catalog was last updated in seconds since epoch (January 1, 1970 at midnight UTC time). -
getAttrNodeCountsTotalActuators
The total number of nodes in a vehicle network that represent actuators. -
getAttrNodeCountsTotalAttributes
The total number of nodes in a vehicle network that represent attributes. -
getAttrNodeCountsTotalBranches
The total number of nodes in a vehicle network that represent branches. -
getAttrNodeCountsTotalNodes
The total number of nodes in a vehicle network. -
getAttrNodeCountsTotalSensors
The total number of nodes in a vehicle network that represent sensors. -
getCfnProperties
- Overrides:
getCfnProperties
in classCfnResource
-
getTags
Tag Manager which manages the tags for this resource. -
getDescription
(Optional) A brief description of the signal catalog. -
setDescription
(Optional) A brief description of the signal catalog. -
getName
(Optional) The name of the signal catalog. -
setName
(Optional) The name of the signal catalog. -
getNodeCounts
(Optional) Information about the number of nodes and node types in a vehicle network. -
setNodeCounts
(Optional) Information about the number of nodes and node types in a vehicle network. -
setNodeCounts
(Optional) Information about the number of nodes and node types in a vehicle network. -
getNodes
(Optional) A list of information about nodes, which are a general abstraction of signals. -
setNodes
(Optional) A list of information about nodes, which are a general abstraction of signals. -
setNodes
(Optional) A list of information about nodes, which are a general abstraction of signals. -
getTagsRaw
(Optional) Metadata that can be used to manage the signal catalog. -
setTagsRaw
(Optional) Metadata that can be used to manage the signal catalog.
-