thing_types

Creates, updates, deletes or gets a thing_type resource or lists thing_types in a region

Overview

Name	thing_types
Type	Resource
Description	Resource Type definition for AWS::IoT::ThingType
Id	awscc.iot.thing_types

Fields

get (all properties)

Name	Datatype	Description
id	string
arn	string
thing_type_name	string
deprecate_thing_type	boolean
▶thing_type_properties	object
▶tags	array	An array of key-value pairs to apply to this resource.
region	string	AWS region.

list (identifiers only)

Name	Datatype	Description
thing_type_name	string
region	string	AWS region.

For more information, see AWS::IoT::ThingType.

Methods

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

SELECT examples

get (all properties)

Gets all properties from an individual thing_type.

SELECT
  region,
  id,
  arn,
  thing_type_name,
  deprecate_thing_type,
  thing_type_properties,
  tags
FROM awscc.iot.thing_types
WHERE
  region = 'us-east-1' AND
  Identifier = '{{ thing_type_name }}';

list (identifiers only)

Lists all thing_types in a region.

SELECT
  region,
  thing_type_name
FROM awscc.iot.thing_types_list_only
WHERE
  region = 'us-east-1';

INSERT example

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

Required Properties

/*+ create */
INSERT INTO awscc.iot.thing_types (
  ThingTypeName,
  DeprecateThingType,
  ThingTypeProperties,
  Tags,
  region
)
SELECT
  '{{ thing_type_name }}',
  '{{ deprecate_thing_type }}',
  '{{ thing_type_properties }}',
  '{{ tags }}',
  '{{ region }}';

All Properties

/*+ create */
INSERT INTO awscc.iot.thing_types (
  ThingTypeName,
  DeprecateThingType,
  ThingTypeProperties,
  Tags,
  region
)
SELECT
  '{{ thing_type_name }}',
  '{{ deprecate_thing_type }}',
  '{{ thing_type_properties }}',
  '{{ tags }}',
  '{{ region }}';

Manifest

version: 1
name: stack name
description: stack description
providers:
  - aws
globals:
  - name: region
    value: '{{ vars.AWS_REGION }}'
resources:
  - name: thing_type
    props:
      - name: thing_type_name
        value: '{{ thing_type_name }}'
      - name: deprecate_thing_type
        value: '{{ deprecate_thing_type }}'
      - name: thing_type_properties
        value:
          searchable_attributes:
            - '{{ searchable_attributes[0] }}'
          thing_type_description: '{{ thing_type_description }}'
          mqtt5_configuration:
            propagating_attributes:
              - user_property_key: '{{ user_property_key }}'
                thing_attribute: '{{ thing_attribute }}'
                connection_attribute: '{{ connection_attribute }}'
      - name: tags
        value:
          - key: '{{ key }}'
            value: '{{ value }}'

UPDATE example

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

/*+ update */
UPDATE awscc.iot.thing_types
SET PatchDocument = string('{{ {
    "DeprecateThingType": deprecate_thing_type,
    "ThingTypeProperties": thing_type_properties,
    "Tags": tags
} | generate_patch_document }}')
WHERE
  region = '{{ region }}' AND
  Identifier = '{{ thing_type_name }}';

DELETE example

/*+ delete */
DELETE FROM awscc.iot.thing_types
WHERE
  Identifier = '{{ thing_type_name }}' AND
  region = 'us-east-1';

Permissions

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

Create

iot:DescribeThingType,
iot:ListTagsForResource,
iot:CreateThingType,
iot:DeprecateThingType,
iot:TagResource

Delete

iot:DescribeThingType,
iot:DeleteThingType,
iot:DeprecateThingType

List

iot:ListThingTypes,
iot:ListTagsForResource

Read

iot:DescribeThingType,
iot:ListTagsForResource

Update

iot:DescribeThingType,
iot:UpdateThingType,
iot:ListTagsForResource,
iot:TagResource,
iot:UntagResource,
iot:DeprecateThingType