Skip to main content

component_type

Gets an individual component_type resource

Overview

Namecomponent_type
TypeResource
Descriptioncomponent_type
Idawscc.iottwinmaker.component_type

Fields

NameDatatypeDescription
workspace_idstringThe ID of the workspace that contains the component type.
component_type_idstringThe ID of the component type.
descriptionstringThe description of the component type.
extends_fromarraySpecifies the parent component type to extend.
functionsobjecta Map of functions in the component type. Each function's key must be unique to this map.
is_singletonbooleanA Boolean value that specifies whether an entity can have more than one component of this type.
property_definitionsobjectAn map of the property definitions in the component type. Each property definition's key must be unique to this map.
property_groupsobjectAn map of the property groups in the component type. Each property group's key must be unique to this map.
composite_component_typesobjectAn map of the composite component types in the component type. Each composite component type's key must be unique to this map.
arnstringThe ARN of the component type.
creation_date_timestringThe date and time when the component type was created.
update_date_timestringThe last date and time when the component type was updated.
statusobjectThe current status of the component type.
is_abstractbooleanA Boolean value that specifies whether the component type is abstract.
is_schema_initializedbooleanA Boolean value that specifies whether the component type has a schema initializer and that the schema initializer has run.
tagsobjectA map of key-value pairs to associate with a resource.
regionstringAWS region.

Methods

Currently only SELECT is supported for this resource resource.

Example

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 awscc.iottwinmaker.component_type
WHERE data__Identifier = '<WorkspaceId>|<ComponentTypeId>';

Permissions

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

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