state_templates

Creates, updates, deletes or gets a state_template resource or lists state_templates in a region

Overview

Name	state_templates
Type	Resource
Description	Definition of AWS::IoTFleetWise::StateTemplate Resource Type
Id	awscc.iotfleetwise.state_templates

Fields

get (all properties)

Name	Datatype	Description
arn	string
creation_time	string
description	string
last_modification_time	string
name	string
id	string
signal_catalog_arn	string
state_template_properties	array
data_extra_dimensions	array
metadata_extra_dimensions	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::StateTemplate.

Methods

Name	Resource	Accessible by	Required Params
create_resource	state_templates	INSERT	Name, SignalCatalogArn, StateTemplateProperties, region
delete_resource	state_templates	DELETE	Identifier, region
update_resource	state_templates	UPDATE	Identifier, PatchDocument, region
list_resources	state_templates_list_only	SELECT	region
get_resource	state_templates	SELECT	Identifier, region

SELECT examples

get (all properties)

Gets all properties from an individual state_template.

SELECT
  region,
  arn,
  creation_time,
  description,
  last_modification_time,
  name,
  id,
  signal_catalog_arn,
  state_template_properties,
  data_extra_dimensions,
  metadata_extra_dimensions,
  tags
FROM awscc.iotfleetwise.state_templates
WHERE
  region = 'us-east-1' AND
  Identifier = '{{ name }}';

list (identifiers only)

Lists all state_templates in a region.

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

INSERT example

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

Required Properties

/*+ create */
INSERT INTO awscc.iotfleetwise.state_templates (
  Name,
  SignalCatalogArn,
  StateTemplateProperties,
  region
)
SELECT
  '{{ name }}',
  '{{ signal_catalog_arn }}',
  '{{ state_template_properties }}',
  '{{ region }}';

All Properties

/*+ create */
INSERT INTO awscc.iotfleetwise.state_templates (
  Description,
  Name,
  SignalCatalogArn,
  StateTemplateProperties,
  DataExtraDimensions,
  MetadataExtraDimensions,
  Tags,
  region
)
SELECT
  '{{ description }}',
  '{{ name }}',
  '{{ signal_catalog_arn }}',
  '{{ state_template_properties }}',
  '{{ data_extra_dimensions }}',
  '{{ metadata_extra_dimensions }}',
  '{{ tags }}',
  '{{ region }}';

Manifest

version: 1
name: stack name
description: stack description
providers:
  - aws
globals:
  - name: region
    value: '{{ vars.AWS_REGION }}'
resources:
  - name: state_template
    props:
      - name: description
        value: '{{ description }}'
      - name: name
        value: '{{ name }}'
      - name: signal_catalog_arn
        value: '{{ signal_catalog_arn }}'
      - name: state_template_properties
        value:
          - '{{ state_template_properties[0] }}'
      - name: data_extra_dimensions
        value:
          - '{{ data_extra_dimensions[0] }}'
      - name: metadata_extra_dimensions
        value:
          - '{{ metadata_extra_dimensions[0] }}'
      - name: tags
        value:
          - key: '{{ key }}'
            value: '{{ value }}'

UPDATE example

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

/*+ update */
UPDATE awscc.iotfleetwise.state_templates
SET PatchDocument = string('{{ {
    "Description": description,
    "StateTemplateProperties": state_template_properties,
    "DataExtraDimensions": data_extra_dimensions,
    "MetadataExtraDimensions": metadata_extra_dimensions,
    "Tags": tags
} | generate_patch_document }}')
WHERE
  region = '{{ region }}' AND
  Identifier = '{{ name }}';

DELETE example

/*+ delete */
DELETE FROM awscc.iotfleetwise.state_templates
WHERE
  Identifier = '{{ name }}' AND
  region = 'us-east-1';

Permissions

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

Create

iotfleetwise:GetStateTemplate,
iotfleetwise:CreateStateTemplate,
iotfleetwise:ListTagsForResource,
iotfleetwise:TagResource

Read

iotfleetwise:GetStateTemplate,
iotfleetwise:ListTagsForResource

Update

iotfleetwise:UpdateStateTemplate,
iotfleetwise:GetStateTemplate,
iotfleetwise:ListTagsForResource,
iotfleetwise:TagResource,
iotfleetwise:UntagResource

Delete

iotfleetwise:DeleteStateTemplate,
iotfleetwise:GetStateTemplate

List

iotfleetwise:ListStateTemplates