vehicles

Creates, updates, deletes or gets a vehicle resource or lists vehicles in a region

Overview

Name	vehicles
Type	Resource
Description	Definition of AWS::IoTFleetWise::Vehicle Resource Type
Id	aws.iotfleetwise.vehicles

Fields

Name	Datatype	Description
arn	string
association_behavior	string
attributes	object
creation_time	string
decoder_manifest_arn	string
name	string
last_modification_time	string
model_manifest_arn	string
tags	array
region	string	AWS region.

Methods

Name	Accessible by	Required Params
create_resource	INSERT	Name, DecoderManifestArn, ModelManifestArn, region
delete_resource	DELETE	data__Identifier, region
update_resource	UPDATE	data__Identifier, data__PatchDocument, region
list_resources	SELECT	region
get_resource	SELECT	data__Identifier, region

SELECT examples

Gets all vehicles in a region.

SELECT
region,
arn,
association_behavior,
attributes,
creation_time,
decoder_manifest_arn,
name,
last_modification_time,
model_manifest_arn,
tags
FROM aws.iotfleetwise.vehicles
WHERE region = 'us-east-1';

Gets all properties from an individual vehicle.

SELECT
region,
arn,
association_behavior,
attributes,
creation_time,
decoder_manifest_arn,
name,
last_modification_time,
model_manifest_arn,
tags
FROM aws.iotfleetwise.vehicles
WHERE region = 'us-east-1' AND data__Identifier = '<Name>';

INSERT example

Use the following StackQL query and manifest file to create a new vehicle resource, using stack-deploy.

Required Properties

/*+ create */
INSERT INTO aws.iotfleetwise.vehicles (
 DecoderManifestArn,
 Name,
 ModelManifestArn,
 region
)
SELECT 
'{{ DecoderManifestArn }}',
 '{{ Name }}',
 '{{ ModelManifestArn }}',
'{{ region }}';

All Properties

/*+ create */
INSERT INTO aws.iotfleetwise.vehicles (
 AssociationBehavior,
 Attributes,
 DecoderManifestArn,
 Name,
 ModelManifestArn,
 Tags,
 region
)
SELECT 
 '{{ AssociationBehavior }}',
 '{{ Attributes }}',
 '{{ DecoderManifestArn }}',
 '{{ Name }}',
 '{{ ModelManifestArn }}',
 '{{ Tags }}',
 '{{ region }}';

Manifest

version: 1
name: stack name
description: stack description
providers:
  - aws
globals:
  - name: region
    value: '{{ vars.AWS_REGION }}'
resources:
  - name: vehicle
    props:
      - name: AssociationBehavior
        value: '{{ AssociationBehavior }}'
      - name: Attributes
        value: {}
      - name: DecoderManifestArn
        value: '{{ DecoderManifestArn }}'
      - name: Name
        value: '{{ Name }}'
      - name: ModelManifestArn
        value: '{{ ModelManifestArn }}'
      - name: Tags
        value:
          - Key: '{{ Key }}'
            Value: '{{ Value }}'

DELETE example

/*+ delete */
DELETE FROM aws.iotfleetwise.vehicles
WHERE data__Identifier = '<Name>'
AND region = 'us-east-1';

Permissions

To operate on the vehicles resource, the following permissions are required:

Create

iotfleetwise:GetVehicle,
iotfleetwise:CreateVehicle,
iot:CreateThing,
iot:DescribeThing,
iotfleetwise:ListTagsForResource,
iotfleetwise:ListVehicles,
iotfleetwise:TagResource

Read

iotfleetwise:GetVehicle,
iotfleetwise:ListTagsForResource

Update

iotfleetwise:GetVehicle,
iotfleetwise:UpdateVehicle,
iotfleetwise:ListTagsForResource,
iotfleetwise:TagResource,
iotfleetwise:UntagResource

Delete

iotfleetwise:GetVehicle,
iotfleetwise:DeleteVehicle

List

iotfleetwise:ListVehicles