Package software.amazon.awscdk.services.iotfleetwise

Class CfnSignalCatalog

java.lang.Object
software.amazon.jsii.JsiiObject
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, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct
@Generated(value="jsii-pacmak/1.84.0 (build 5404dcf)", date="2023-06-19T16:29:57.858Z") @Stability(Stable) 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();

  • Field Details

    • CFN_RESOURCE_TYPE_NAME

      @Stability(Stable) public static final String 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 Construct scope, @NotNull String id, @Nullable 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

      @Stability(Stable) public CfnSignalCatalog(@NotNull Construct scope, @NotNull 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 Details

    • inspect

      @Stability(Stable) public void inspect(@NotNull 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

      @Stability(Stable) @NotNull protected Map<String,Object> renderProperties(@NotNull Map<String,Object> props)
      Overrides:
      renderProperties in class CfnResource
      Parameters:
      props - This parameter is required.

    • getAttrArn

      @Stability(Stable) @NotNull public String getAttrArn()
      The Amazon Resource Name (ARN) of the signal catalog.

    • getAttrCreationTime

      @Stability(Stable) @NotNull public String getAttrCreationTime()
      The time the signal catalog was created in seconds since epoch (January 1, 1970 at midnight UTC time).

    • getAttrLastModificationTime

      @Stability(Stable) @NotNull public String getAttrLastModificationTime()
      The time the signal catalog was last updated in seconds since epoch (January 1, 1970 at midnight UTC time).

    • getAttrNodeCountsTotalActuators

      @Stability(Stable) @NotNull public IResolvable getAttrNodeCountsTotalActuators()
      The total number of nodes in a vehicle network that represent actuators.

    • getAttrNodeCountsTotalAttributes

      @Stability(Stable) @NotNull public IResolvable getAttrNodeCountsTotalAttributes()
      The total number of nodes in a vehicle network that represent attributes.

    • getAttrNodeCountsTotalBranches

      @Stability(Stable) @NotNull public IResolvable getAttrNodeCountsTotalBranches()
      The total number of nodes in a vehicle network that represent branches.

    • getAttrNodeCountsTotalNodes

      @Stability(Stable) @NotNull public IResolvable getAttrNodeCountsTotalNodes()
      The total number of nodes in a vehicle network.

    • getAttrNodeCountsTotalSensors

      @Stability(Stable) @NotNull public IResolvable getAttrNodeCountsTotalSensors()
      The total number of nodes in a vehicle network that represent sensors.

    • getCfnProperties

      @Stability(Stable) @NotNull protected Map<String,Object> getCfnProperties()
      Overrides:
      getCfnProperties in class CfnResource

    • getTags

      @Stability(Stable) @NotNull public TagManager getTags()
      (Optional) Metadata that can be used to manage the signal catalog.

    • getDescription

      @Stability(Stable) @Nullable public String getDescription()
      (Optional) A brief description of the signal catalog.

    • setDescription

      @Stability(Stable) public void setDescription(@Nullable String value)
      (Optional) A brief description of the signal catalog.

    • getName

      @Stability(Stable) @Nullable public String getName()
      (Optional) The name of the signal catalog.

    • setName

      @Stability(Stable) public void setName(@Nullable String value)
      (Optional) The name of the signal catalog.

    • getNodeCounts

      @Stability(Stable) @Nullable public Object getNodeCounts()
      (Optional) Information about the number of nodes and node types in a vehicle network.

    • setNodeCounts

      @Stability(Stable) public void setNodeCounts(@Nullable IResolvable value)
      (Optional) Information about the number of nodes and node types in a vehicle network.

    • setNodeCounts

      @Stability(Stable) public void setNodeCounts(@Nullable CfnSignalCatalog.NodeCountsProperty value)
      (Optional) Information about the number of nodes and node types in a vehicle network.

    • getNodes

      @Stability(Stable) @Nullable public Object getNodes()
      (Optional) A list of information about nodes, which are a general abstraction of signals.

    • setNodes

      @Stability(Stable) public void setNodes(@Nullable IResolvable value)
      (Optional) A list of information about nodes, which are a general abstraction of signals.

    • setNodes

      @Stability(Stable) public void setNodes(@Nullable List<Object> value)
      (Optional) A list of information about nodes, which are a general abstraction of signals.