interface CfnStateTemplateMixinProps

Language	Type name
.NET	`Amazon.CDK.Mixins.Preview.AWS.IoTFleetWise.Mixins.CfnStateTemplateMixinProps`
Go	`github.com/aws/aws-cdk-go/awscdkmixinspreview/v2/awsiotfleetwise/mixins#CfnStateTemplateMixinProps`
Java	`software.amazon.awscdk.mixins.preview.services.iotfleetwise.mixins.CfnStateTemplateMixinProps`
Python	`aws_cdk.mixins_preview.aws_iotfleetwise.mixins.CfnStateTemplateMixinProps`
TypeScript	`@aws-cdk/mixins-preview` » `aws_iotfleetwise` » `mixins` » `CfnStateTemplateMixinProps`

Properties for CfnStateTemplatePropsMixin.

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

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { mixins as iotfleetwise_mixins } from '@aws-cdk/mixins-preview/aws-iotfleetwise';
const cfnStateTemplateMixinProps: iotfleetwise_mixins.CfnStateTemplateMixinProps = {
  dataExtraDimensions: ['dataExtraDimensions'],
  description: 'description',
  metadataExtraDimensions: ['metadataExtraDimensions'],
  name: 'name',
  signalCatalogArn: 'signalCatalogArn',
  stateTemplateProperties: ['stateTemplateProperties'],
  tags: [{
    key: 'key',
    value: 'value',
  }],
};

Properties

Name	Type	Description
dataExtraDimensions?	`string[]`	A list of vehicle attributes associated with the payload published on the state template's MQTT topic.
description?	`string`	A brief description of the state template.
metadataExtraDimensions?	`string[]`	A list of vehicle attributes to associate with the user properties of the messages published on the state template's MQTT topic.
name?	`string`	The unique alias of the state template.
signalCatalogArn?	`string`	The Amazon Resource Name (ARN) of the signal catalog associated with the state template.
stateTemplateProperties?	`string[]`	A list of signals from which data is collected.
tags?	`CfnTag[]`	Metadata that can be used to manage the state template.

dataExtraDimensions?

Type: string[] (optional)

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

description?

Type: string (optional)

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

metadataExtraDimensions?

Type: string[] (optional)

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