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

Fields

get (all properties)

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.

list (identifiers only)

Name	Datatype	Description
name	string
region	string	AWS region.

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

Methods

Name	Resource	Accessible by	Required Params
create_resource	signal_catalogs	INSERT	region
delete_resource	signal_catalogs	DELETE	Identifier, region
update_resource	signal_catalogs	UPDATE	Identifier, PatchDocument, region
list_resources	signal_catalogs_list_only	SELECT	region
get_resource	signal_catalogs	SELECT	Identifier, region

SELECT examples

get (all properties)

Gets all properties from an individual signal_catalog.

SELECT
  region,
  arn,
  creation_time,
  description,
  last_modification_time,
  name,
  node_counts,
  nodes,
  tags
FROM awscc.iotfleetwise.signal_catalogs
WHERE
  region = 'us-east-1' AND
  Identifier = '{{ name }}';

list (identifiers only)

Lists all signal_catalogs in a region.

SELECT
  region,
  name
FROM awscc.iotfleetwise.signal_catalogs_list_only
WHERE
  region = 'us-east-1';

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 awscc.iotfleetwise.signal_catalogs (
  Description,
  Name,
  NodeCounts,
  Nodes,
  Tags,
  region
)
SELECT
  '{{ description }}',
  '{{ name }}',
  '{{ node_counts }}',
  '{{ nodes }}',
  '{{ tags }}',
  '{{ region }}';

All Properties

/*+ create */
INSERT INTO awscc.iotfleetwise.signal_catalogs (
  Description,
  Name,
  NodeCounts,
  Nodes,
  Tags,
  region
)
SELECT
  '{{ description }}',
  '{{ name }}',
  '{{ node_counts }}',
  '{{ 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: node_counts
        value:
          total_nodes: null
          total_branches: null
          total_sensors: null
          total_attributes: null
          total_actuators: null
      - name: nodes
        value:
          - null
      - name: tags
        value:
          - key: '{{ key }}'
            value: '{{ value }}'

UPDATE example

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

/*+ update */
UPDATE awscc.iotfleetwise.signal_catalogs
SET PatchDocument = string('{{ {
    "Description": description,
    "Nodes": nodes,
    "Tags": tags
} | generate_patch_document }}')
WHERE
  region = '{{ region }}' AND
  Identifier = '{{ name }}';

DELETE example

/*+ delete */
DELETE FROM awscc.iotfleetwise.signal_catalogs
WHERE
  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