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	awscc.iotfleetwise.fleets

Fields

get (all properties)

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.

list (identifiers only)

Name	Datatype	Description
id	string
region	string	AWS region.

For more information, see AWS::IoTFleetWise::Fleet.

Methods

Name	Resource	Accessible by	Required Params
create_resource	fleets	INSERT	Id, SignalCatalogArn, region
delete_resource	fleets	DELETE	Identifier, region
update_resource	fleets	UPDATE	Identifier, PatchDocument, region
list_resources	fleets_list_only	SELECT	region
get_resource	fleets	SELECT	Identifier, region

SELECT examples

get (all properties)

Gets all properties from an individual fleet.

SELECT
  region,
  arn,
  creation_time,
  description,
  id,
  last_modification_time,
  signal_catalog_arn,
  tags
FROM awscc.iotfleetwise.fleets
WHERE
  region = '{{ region }}' AND
  Identifier = '{{ id }}';

list (identifiers only)

Lists all fleets in a region.

SELECT
  region,
  id
FROM awscc.iotfleetwise.fleets_list_only
WHERE
  region = '{{ region }}';

INSERT example

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

Required Properties

/*+ create */
INSERT INTO awscc.iotfleetwise.fleets (
  Id,
  SignalCatalogArn,
  region
)
SELECT
  '{{ id }}',
  '{{ signal_catalog_arn }}',
  '{{ region }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

All Properties

/*+ create */
INSERT INTO awscc.iotfleetwise.fleets (
  Description,
  Id,
  SignalCatalogArn,
  Tags,
  region
)
SELECT
  '{{ description }}',
  '{{ id }}',
  '{{ signal_catalog_arn }}',
  '{{ tags }}',
  '{{ region }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

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: signal_catalog_arn
      value: '{{ signal_catalog_arn }}'
    - name: tags
      value:
        - key: '{{ key }}'
          value: '{{ value }}'

UPDATE example

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

/*+ update */
UPDATE awscc.iotfleetwise.fleets
SET PatchDocument = string('{{ {
    "Description": description,
    "Tags": tags
} | generate_patch_document }}')
WHERE
  region = '{{ region }}' AND
  Identifier = '{{ id }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

DELETE example

/*+ delete */
DELETE FROM awscc.iotfleetwise.fleets
WHERE
  Identifier = '{{ id }}' AND
  region = '{{ region }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

Additional Parameters

Mutable resources in the Cloud Control provider support additional optional parameters which can be supplied with INSERT, UPDATE, or DELETE operations. These include:

Parameter	Description
ClientToken	A unique identifier to ensure the idempotency of the resource request. This allows the provider to accurately distinguish between retries and new requests. A client token is valid for 36 hours once used. After that, a resource request with the same client token is treated as a new request. If you do not specify a client token, one is generated for inclusion in the request.
RoleArn	The ARN of the IAM role used to perform this resource operation. The role specified must have the permissions required for this operation. If you do not specify a role, a temporary session is created using your AWS user credentials.
TypeVersionId	For private resource types, the type version to use in this resource operation. If you do not specify a resource version, the default version is used.

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