component_types

Creates, updates, deletes or gets a component_type resource or lists component_types in a region

Overview

Name	component_types
Type	Resource
Description	Resource schema for AWS::IoTTwinMaker::ComponentType
Id	aws.iottwinmaker.component_types

Fields

Name	Datatype	Description
workspace_id	string	The ID of the workspace that contains the component type.
component_type_id	string	The ID of the component type.
description	string	The description of the component type.
extends_from	array	Specifies the parent component type to extend.
functions	object	a Map of functions in the component type. Each function's key must be unique to this map.
is_singleton	boolean	A Boolean value that specifies whether an entity can have more than one component of this type.
property_definitions	object	An map of the property definitions in the component type. Each property definition's key must be unique to this map.
property_groups	object	An map of the property groups in the component type. Each property group's key must be unique to this map.
composite_component_types	object	An map of the composite component types in the component type. Each composite component type's key must be unique to this map.
arn	string	The ARN of the component type.
creation_date_time	string	The date and time when the component type was created.
update_date_time	string	The last date and time when the component type was updated.
status	object	The current status of the component type.
is_abstract	boolean	A Boolean value that specifies whether the component type is abstract.
is_schema_initialized	boolean	A Boolean value that specifies whether the component type has a schema initializer and that the schema initializer has run.
tags	object	A map of key-value pairs to associate with a resource.
region	string	AWS region.

Methods

Name	Accessible by	Required Params
create_resource	INSERT	WorkspaceId, ComponentTypeId, 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 component_types in a region.

SELECT
region,
workspace_id,
component_type_id,
description,
extends_from,
functions,
is_singleton,
property_definitions,
property_groups,
composite_component_types,
arn,
creation_date_time,
update_date_time,
status,
is_abstract,
is_schema_initialized,
tags
FROM aws.iottwinmaker.component_types
WHERE region = 'us-east-1';

Gets all properties from an individual component_type.

SELECT
region,
workspace_id,
component_type_id,
description,
extends_from,
functions,
is_singleton,
property_definitions,
property_groups,
composite_component_types,
arn,
creation_date_time,
update_date_time,
status,
is_abstract,
is_schema_initialized,
tags
FROM aws.iottwinmaker.component_types
WHERE region = 'us-east-1' AND data__Identifier = '<WorkspaceId>|<ComponentTypeId>';

INSERT example

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

Required Properties

/*+ create */
INSERT INTO aws.iottwinmaker.component_types (
 WorkspaceId,
 ComponentTypeId,
 region
)
SELECT 
'{{ WorkspaceId }}',
 '{{ ComponentTypeId }}',
'{{ region }}';

All Properties

/*+ create */
INSERT INTO aws.iottwinmaker.component_types (
 WorkspaceId,
 ComponentTypeId,
 Description,
 ExtendsFrom,
 Functions,
 IsSingleton,
 PropertyDefinitions,
 PropertyGroups,
 CompositeComponentTypes,
 Tags,
 region
)
SELECT 
 '{{ WorkspaceId }}',
 '{{ ComponentTypeId }}',
 '{{ Description }}',
 '{{ ExtendsFrom }}',
 '{{ Functions }}',
 '{{ IsSingleton }}',
 '{{ PropertyDefinitions }}',
 '{{ PropertyGroups }}',
 '{{ CompositeComponentTypes }}',
 '{{ Tags }}',
 '{{ region }}';

Manifest

version: 1
name: stack name
description: stack description
providers:
  - aws
globals:
  - name: region
    value: '{{ vars.AWS_REGION }}'
resources:
  - name: component_type
    props:
      - name: WorkspaceId
        value: '{{ WorkspaceId }}'
      - name: ComponentTypeId
        value: '{{ ComponentTypeId }}'
      - name: Description
        value: '{{ Description }}'
      - name: ExtendsFrom
        value:
          - '{{ ExtendsFrom[0] }}'
      - name: Functions
        value: {}
      - name: IsSingleton
        value: '{{ IsSingleton }}'
      - name: PropertyDefinitions
        value: {}
      - name: PropertyGroups
        value: {}
      - name: CompositeComponentTypes
        value: {}
      - name: Tags
        value: {}

DELETE example

/*+ delete */
DELETE FROM aws.iottwinmaker.component_types
WHERE data__Identifier = '<WorkspaceId|ComponentTypeId>'
AND region = 'us-east-1';

Permissions

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

Create

iottwinmaker:CreateComponentType,
iottwinmaker:GetComponentType,
iottwinmaker:GetWorkspace,
iottwinmaker:ListTagsForResource,
iottwinmaker:TagResource

Read

iottwinmaker:GetComponentType,
iottwinmaker:GetWorkspace,
iottwinmaker:ListTagsForResource

Update

iottwinmaker:GetComponentType,
iottwinmaker:GetWorkspace,
iottwinmaker:ListTagsForResource,
iottwinmaker:TagResource,
iottwinmaker:UntagResource,
iottwinmaker:UpdateComponentType

Delete

iottwinmaker:DeleteComponentType,
iottwinmaker:GetComponentType,
iottwinmaker:GetWorkspace

List

iottwinmaker:GetComponentType,
iottwinmaker:GetWorkspace,
iottwinmaker:ListComponentTypes,
iottwinmaker:ListTagsForResource