Package software.amazon.awscdk.cfnpropertymixins.services.iotfleetwise

Interface CfnStateTemplateMixinProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnStateTemplateMixinProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.127.0 (build 2117ad5)",
           date="2026-03-11T13:20:00.429Z")
@Stability(Stable)
public interface CfnStateTemplateMixinProps
extends software.amazon.jsii.JsiiSerializable

Properties for CfnStateTemplatePropsMixin.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.cfnpropertymixins.services.iotfleetwise.*;
 CfnStateTemplateMixinProps cfnStateTemplateMixinProps = CfnStateTemplateMixinProps.builder()
         .dataExtraDimensions(List.of("dataExtraDimensions"))
         .description("description")
         .metadataExtraDimensions(List.of("metadataExtraDimensions"))
         .name("name")
         .signalCatalogArn("signalCatalogArn")
         .stateTemplateProperties(List.of("stateTemplateProperties"))
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .build();
 

See Also:

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

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static CfnStateTemplateMixinProps.Builder	builder()
default List<String>	getDataExtraDimensions()	A list of vehicle attributes associated with the payload published on the state template's MQTT topic.
default String	getDescription()	A brief description of the state template.
default 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.
default String	getName()	The unique alias of the state template.
default String	getSignalCatalogArn()	The Amazon Resource Name (ARN) of the signal catalog associated with the state template.
default List<String>	getStateTemplateProperties()	A list of signals from which data is collected.
default List<CfnTag>	getTags()	Metadata that can be used to manage the state template.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getDataExtraDimensions

@Stability(Stable)
@Nullable
default List<String> getDataExtraDimensions()

A list of vehicle attributes associated with the payload published on the state template's MQTT topic.

See Also:

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

getDescription

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

A brief description of the state template.

See Also:

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

getMetadataExtraDimensions

@Stability(Stable)
@Nullable
default 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.

For example, if you add Vehicle.Attributes.Make and Vehicle.Attributes.Model attributes, these attributes are included as user properties with the MQTT message.

See Also:

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

getName

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

The unique alias of the state template.

See Also:

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

getSignalCatalogArn

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

The Amazon Resource Name (ARN) of the signal catalog associated with the state template.

See Also:

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

getStateTemplateProperties

@Stability(Stable)
@Nullable
default List<String> getStateTemplateProperties()

A list of signals from which data is collected.

The state template properties contain the fully qualified names of the signals.

See Also:

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

getTags

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

Metadata that can be used to manage the state template.

See Also:

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

builder

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

Returns:

a CfnStateTemplateMixinProps.Builder of CfnStateTemplateMixinProps