Package software.amazon.awscdk.services.iotfleetwise

Class CfnStateTemplate

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.CfnStateTemplate
All Implemented Interfaces:
IInspectable, ITaggableV2, IStateTemplateRef, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable
@Generated(value="jsii-pacmak/1.116.0 (build 0eddcff)", date="2025-10-24T13:34:40.364Z") @Stability(Stable) public class CfnStateTemplate extends CfnResource implements IInspectable, IStateTemplateRef, ITaggableV2
Creates a mechanism for vehicle owners to track the state of their vehicles.

State templates determine which signal updates the vehicle sends to the cloud.

For more information, see State templates in the AWS IoT FleetWise Developer Guide .

Access to certain AWS IoT FleetWise features is currently gated. For more information, see AWS Region and feature availability in the AWS IoT FleetWise Developer Guide .

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.*;
 CfnStateTemplate cfnStateTemplate = CfnStateTemplate.Builder.create(this, "MyCfnStateTemplate")
         .name("name")
         .signalCatalogArn("signalCatalogArn")
         .stateTemplateProperties(List.of("stateTemplateProperties"))
         // the properties below are optional
         .dataExtraDimensions(List.of("dataExtraDimensions"))
         .description("description")
         .metadataExtraDimensions(List.of("metadataExtraDimensions"))
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .build();

See Also:

  • 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

    • CfnStateTemplate

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

    • CfnStateTemplate

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

    • CfnStateTemplate

      @Stability(Stable) public CfnStateTemplate(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull CfnStateTemplateProps 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. 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 state template.

    • getAttrCreationTime

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

    • getAttrId

      @Stability(Stable) @NotNull public String getAttrId()
      The unique ID of the state template.

    • getAttrLastModificationTime

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

    • getCdkTagManager

      @Stability(Stable) @NotNull public TagManager getCdkTagManager()
      Tag Manager which manages the tags for this resource.
      Specified by:
      getCdkTagManager in interface ITaggableV2

    • getCfnProperties

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

    • getStateTemplateRef

      @Stability(Stable) @NotNull public StateTemplateReference getStateTemplateRef()
      A reference to a StateTemplate resource.
      Specified by:
      getStateTemplateRef in interface IStateTemplateRef

    • getName

      @Stability(Stable) @NotNull public String getName()
      The unique alias of the state template.

    • setName

      @Stability(Stable) public void setName(@NotNull String value)
      The unique alias of the state template.

    • getSignalCatalogArn

      @Stability(Stable) @NotNull public String getSignalCatalogArn()
      The Amazon Resource Name (ARN) of the signal catalog associated with the state template.

    • setSignalCatalogArn

      @Stability(Stable) public void setSignalCatalogArn(@NotNull String value)
      The Amazon Resource Name (ARN) of the signal catalog associated with the state template.

    • getStateTemplateProperties

      @Stability(Stable) @NotNull public List<String> getStateTemplateProperties()
      A list of signals from which data is collected.

    • setStateTemplateProperties

      @Stability(Stable) public void setStateTemplateProperties(@NotNull List<String> value)
      A list of signals from which data is collected.

    • getDataExtraDimensions

      @Stability(Stable) @Nullable public List<String> getDataExtraDimensions()
      A list of vehicle attributes associated with the payload published on the state template's MQTT topic.

    • setDataExtraDimensions

      @Stability(Stable) public void setDataExtraDimensions(@Nullable List<String> value)
      A list of vehicle attributes associated with the payload published on the state template's MQTT topic.

    • getDescription

      @Stability(Stable) @Nullable public String getDescription()
      A brief description of the state template.

    • setDescription

      @Stability(Stable) public void setDescription(@Nullable String value)
      A brief description of the state template.

    • getMetadataExtraDimensions

      @Stability(Stable) @Nullable public List<String> getMetadataExtraDimensions()
      A list of vehicle attributes to associate with the user properties of the messages published on the state template's MQTT topic.

    • setMetadataExtraDimensions

      @Stability(Stable) public void setMetadataExtraDimensions(@Nullable List<String> value)
      A list of vehicle attributes to associate with the user properties of the messages published on the state template's MQTT topic.

    • getTags

      @Stability(Stable) @Nullable public List<CfnTag> getTags()
      Metadata that can be used to manage the state template.

    • setTags

      @Stability(Stable) public void setTags(@Nullable List<CfnTag> value)
      Metadata that can be used to manage the state template.