component_type
Gets an individual component_type
resource
Overview
Name | component_type |
Type | Resource |
Description | component_type |
Id | awscc.iottwinmaker.component_type |
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
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