interface CfnVehicleProps

Language	Type name
.NET	Amazon.CDK.AWS.IoTFleetWise.CfnVehicleProps
Go	github.com/aws/aws-cdk-go/awscdk/v2/awsiotfleetwise#CfnVehicleProps
Java	software.amazon.awscdk.services.iotfleetwise.CfnVehicleProps
Python	aws_cdk.aws_iotfleetwise.CfnVehicleProps
TypeScript	aws-cdk-lib » aws_iotfleetwise » CfnVehicleProps

Properties for defining a CfnVehicle.

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

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_iotfleetwise as iotfleetwise } from 'aws-cdk-lib';

declare const onChange: any;
const cfnVehicleProps: iotfleetwise.CfnVehicleProps = {
  decoderManifestArn: 'decoderManifestArn',
  modelManifestArn: 'modelManifestArn',
  name: 'name',

  // the properties below are optional
  associationBehavior: 'associationBehavior',
  attributes: {
    attributesKey: 'attributes',
  },
  stateTemplates: [{
    identifier: 'identifier',
    stateTemplateUpdateStrategy: {
      onChange: onChange,
      periodic: {
        stateTemplateUpdateRate: {
          unit: 'unit',
          value: 123,
        },
      },
    },
  }],
  tags: [{
    key: 'key',
    value: 'value',
  }],
};

Properties

Name	Type	Description
decoderManifestArn	string	The Amazon Resource Name (ARN) of a decoder manifest associated with the vehicle to create.
modelManifestArn	string	The Amazon Resource Name (ARN) of the vehicle model (model manifest) to create the vehicle from.
name	string	The unique ID of the vehicle.
associationBehavior?	string	An option to create a new AWS IoT thing when creating a vehicle, or to validate an existing thing as a vehicle.
attributes?	{ [string]: string } | IResolvable	Static information about a vehicle in a key-value pair.
stateTemplates?	IResolvable | (IResolvable | StateTemplateAssociationProperty)[]	Associate state templates to track the state of the vehicle.
tags?	CfnTag[]	Metadata which can be used to manage the vehicle.

---

decoderManifestArn

Type: string

The Amazon Resource Name (ARN) of a decoder manifest associated with the vehicle to create.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotfleetwise-vehicle.html#cfn-iotfleetwise-vehicle-decodermanifestarn

---

modelManifestArn

Type: string

The Amazon Resource Name (ARN) of the vehicle model (model manifest) to create the vehicle from.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotfleetwise-vehicle.html#cfn-iotfleetwise-vehicle-modelmanifestarn

---

name

Type: string

The unique ID of the vehicle.

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

---

associationBehavior?

Type: string (optional)

An option to create a new AWS IoT thing when creating a vehicle, or to validate an existing thing as a vehicle.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotfleetwise-vehicle.html#cfn-iotfleetwise-vehicle-associationbehavior

---

attributes?

Type: { [string]: string } | IResolvable (optional)

Static information about a vehicle in a key-value pair.

For example: "engine Type" : "v6"

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotfleetwise-vehicle.html#cfn-iotfleetwise-vehicle-attributes

---

stateTemplates?

Type: IResolvable | (IResolvable | StateTemplateAssociationProperty)[] (optional)

Associate state templates to track the state of the vehicle.

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

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotfleetwise-vehicle.html#cfn-iotfleetwise-vehicle-statetemplates

---

tags?

Type: CfnTag[] (optional)

Metadata which can be used to manage the vehicle.

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