signal_catalogs

Creates, updates, deletes or gets a signal_catalog resource or lists signal_catalogs in a region

Overview

Name	signal_catalogs
Type	Resource
Description	Definition of AWS::IoTFleetWise::SignalCatalog Resource Type
Id	aws.iotfleetwise.signal_catalogs

Fields

Name	Datatype	Description
arn	string
creation_time	string
description	string
last_modification_time	string
name	string
node_counts	object
nodes	array
tags	array
region	string	AWS region.

Methods

Name	Accessible by	Required Params
create_resource	INSERT	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 signal_catalogs in a region.

SELECT
region,
arn,
creation_time,
description,
last_modification_time,
name,
node_counts,
nodes,
tags
FROM aws.iotfleetwise.signal_catalogs
WHERE region = 'us-east-1';

Gets all properties from an individual signal_catalog.

SELECT
region,
arn,
creation_time,
description,
last_modification_time,
name,
node_counts,
nodes,
tags
FROM aws.iotfleetwise.signal_catalogs
WHERE region = 'us-east-1' AND data__Identifier = '<Name>';

INSERT example

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

Required Properties

/*+ create */
INSERT INTO aws.iotfleetwise.signal_catalogs (
 Description,
 Name,
 NodeCounts,
 Nodes,
 Tags,
 region
)
SELECT 
'{{ Description }}',
 '{{ Name }}',
 '{{ NodeCounts }}',
 '{{ Nodes }}',
 '{{ Tags }}',
'{{ region }}';

All Properties

/*+ create */
INSERT INTO aws.iotfleetwise.signal_catalogs (
 Description,
 Name,
 NodeCounts,
 Nodes,
 Tags,
 region
)
SELECT 
 '{{ Description }}',
 '{{ Name }}',
 '{{ NodeCounts }}',
 '{{ Nodes }}',
 '{{ Tags }}',
 '{{ region }}';

Manifest

version: 1
name: stack name
description: stack description
providers:
  - aws
globals:
  - name: region
    value: '{{ vars.AWS_REGION }}'
resources:
  - name: signal_catalog
    props:
      - name: Description
        value: '{{ Description }}'
      - name: Name
        value: '{{ Name }}'
      - name: NodeCounts
        value:
          TotalNodes: null
          TotalBranches: null
          TotalSensors: null
          TotalAttributes: null
          TotalActuators: null
      - name: Nodes
        value:
          - null
      - name: Tags
        value:
          - Key: '{{ Key }}'
            Value: '{{ Value }}'

DELETE example

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

Permissions

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

Create

iotfleetwise:GetSignalCatalog,
iotfleetwise:CreateSignalCatalog,
iotfleetwise:ListSignalCatalogNodes,
iotfleetwise:ListTagsForResource,
iotfleetwise:TagResource

Read

iotfleetwise:GetSignalCatalog,
iotfleetwise:ListSignalCatalogNodes,
iotfleetwise:ListTagsForResource

Update

iotfleetwise:GetSignalCatalog,
iotfleetwise:UpdateSignalCatalog,
iotfleetwise:ListSignalCatalogNodes,
iotfleetwise:ListTagsForResource,
iotfleetwise:TagResource,
iotfleetwise:UntagResource

Delete

iotfleetwise:GetSignalCatalog,
iotfleetwise:DeleteSignalCatalog

List

iotfleetwise:ListSignalCatalogs