Package software.amazon.awscdk.services.iotfleetwise

Interface CfnSignalCatalogProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnSignalCatalogProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.98.0 (build 00b106d)",
           date="2024-05-30T02:11:08.865Z")
@Stability(Stable)
public interface CfnSignalCatalogProps
extends software.amazon.jsii.JsiiSerializable

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 software.amazon.awscdk.services.iotfleetwise.*;
 CfnSignalCatalogProps cfnSignalCatalogProps = CfnSignalCatalogProps.builder()
         .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:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotfleetwise-signalcatalog.html

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnSignalCatalogProps.Builder	A builder for CfnSignalCatalogProps
static final class	CfnSignalCatalogProps.Jsii$Proxy	An implementation for CfnSignalCatalogProps

Method Summary

Modifier and Type	Method	Description
static CfnSignalCatalogProps.Builder	builder()
default String	getDescription()	(Optional) A brief description of the signal catalog.
default String	getName()	(Optional) The name of the signal catalog.
default Object	getNodeCounts()	(Optional) Information about the number of nodes and node types in a vehicle network.
default Object	getNodes()	(Optional) A list of information about nodes, which are a general abstraction of signals.
default List<CfnTag>	getTags()	(Optional) Metadata that can be used to manage the signal catalog.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getDescription

@Stability(Stable)
@Nullable
default String getDescription()

(Optional) A brief description of the signal catalog.

See Also:

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

getName

@Stability(Stable)
@Nullable
default String getName()

(Optional) The name of the signal catalog.

See Also:

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

getNodeCounts

@Stability(Stable)
@Nullable
default Object getNodeCounts()

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

See Also:

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

getNodes

@Stability(Stable)
@Nullable
default Object getNodes()

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

See Also:

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

getTags

@Stability(Stable)
@Nullable
default List<CfnTag> getTags()

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

See Also:

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

builder

@Stability(Stable)
static CfnSignalCatalogProps.Builder builder()

Returns:

a CfnSignalCatalogProps.Builder of CfnSignalCatalogProps