CfnStateTemplateProps

class aws_cdk.aws_iotfleetwise.CfnStateTemplateProps(*, name, signal_catalog_arn, state_template_properties, data_extra_dimensions=None, description=None, metadata_extra_dimensions=None, tags=None)

Bases: object

Properties for defining a CfnStateTemplate.

Parameters:

  • name (str) – The unique alias of the state template.

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

  • state_template_properties (Sequence[str]) – A list of signals from which data is collected. The state template properties contain the fully qualified names of the signals.

  • data_extra_dimensions (Optional[Sequence[str]]) – A list of vehicle attributes associated with the payload published on the state template’s MQTT topic.

  • description (Optional[str]) – A brief description of the state template.

  • metadata_extra_dimensions (Optional[Sequence[str]]) – 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.

  • tags (Optional[Sequence[Union[CfnTag, Dict[str, Any]]]]) – Metadata that can be used to manage the state template.

See:

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

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_iotfleetwise as iotfleetwise

cfn_state_template_props = iotfleetwise.CfnStateTemplateProps(
    name="name",
    signal_catalog_arn="signalCatalogArn",
    state_template_properties=["stateTemplateProperties"],

    # the properties below are optional
    data_extra_dimensions=["dataExtraDimensions"],
    description="description",
    metadata_extra_dimensions=["metadataExtraDimensions"],
    tags=[CfnTag(
        key="key",
        value="value"
    )]
)

Attributes

data_extra_dimensions

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

See:

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

description

A brief description of the state template.

See:

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

metadata_extra_dimensions

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:

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

name

The unique alias of the state template.

See:

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

signal_catalog_arn

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

See:

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

state_template_properties

A list of signals from which data is collected.

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

See:

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

tags

Metadata that can be used to manage the state template.

See:

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