fleets

Creates, updates, deletes or gets a fleet resource or lists fleets in a region

Overview

Name	fleets
Type	Resource
Description	Definition of AWS::IoTFleetWise::Fleet Resource Type
Id	aws.iotfleetwise.fleets

Fields

Name	Datatype	Description
arn	string
creation_time	string
description	string
id	string
last_modification_time	string
signal_catalog_arn	string
tags	array
region	string	AWS region.

Methods

Name	Accessible by	Required Params
create_resource	INSERT	Id, SignalCatalogArn, 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 fleets in a region.

SELECT
region,
arn,
creation_time,
description,
id,
last_modification_time,
signal_catalog_arn,
tags
FROM aws.iotfleetwise.fleets
WHERE region = 'us-east-1';

Gets all properties from an individual fleet.

SELECT
region,
arn,
creation_time,
description,
id,
last_modification_time,
signal_catalog_arn,
tags
FROM aws.iotfleetwise.fleets
WHERE region = 'us-east-1' AND data__Identifier = '<Id>';

INSERT example

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

Required Properties

/*+ create */
INSERT INTO aws.iotfleetwise.fleets (
 Id,
 SignalCatalogArn,
 region
)
SELECT 
'{{ Id }}',
 '{{ SignalCatalogArn }}',
'{{ region }}';

All Properties

/*+ create */
INSERT INTO aws.iotfleetwise.fleets (
 Description,
 Id,
 SignalCatalogArn,
 Tags,
 region
)
SELECT 
 '{{ Description }}',
 '{{ Id }}',
 '{{ SignalCatalogArn }}',
 '{{ Tags }}',
 '{{ region }}';

Manifest

version: 1
name: stack name
description: stack description
providers:
  - aws
globals:
  - name: region
    value: '{{ vars.AWS_REGION }}'
resources:
  - name: fleet
    props:
      - name: Description
        value: '{{ Description }}'
      - name: Id
        value: '{{ Id }}'
      - name: SignalCatalogArn
        value: '{{ SignalCatalogArn }}'
      - name: Tags
        value:
          - Key: '{{ Key }}'
            Value: '{{ Value }}'

DELETE example

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

Permissions

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

Create

iotfleetwise:GetFleet,
iotfleetwise:CreateFleet,
iotfleetwise:ListTagsForResource,
iotfleetwise:ListVehiclesInFleet,
iotfleetwise:TagResource

Read

iotfleetwise:GetFleet,
iotfleetwise:ListTagsForResource

Update

iotfleetwise:GetFleet,
iotfleetwise:UpdateFleet,
iotfleetwise:ListTagsForResource,
iotfleetwise:TagResource,
iotfleetwise:UntagResource

Delete

iotfleetwise:GetFleet,
iotfleetwise:DeleteFleet

List

iotfleetwise:ListFleets