AWS Fundamentals Logo
AWS Fundamentals
L1 ConstructAWS::IoTTwinMaker::ComponentType

CfnComponentType

Use the `AWS::IoTTwinMaker::ComponentType` resource to declare a component type.

Import

import { CfnComponentType } from 'aws-cdk-lib/aws-iottwinmaker';

Or use the module namespace:

import * as iottwinmaker from 'aws-cdk-lib/aws-iottwinmaker';
// iottwinmaker.CfnComponentType

Properties

Configuration passed to the constructor as CfnComponentTypeProps.

componentTypeIdRequired
string

The ID of the component type.

workspaceIdRequired
string

The ID of the workspace that contains the component type.

compositeComponentTypesOptional
IResolvable | { [key: string]: IResolvable | CompositeComponentTypeProperty }

Maps strings to `compositeComponentTypes` of the `componentType` . `CompositeComponentType` is referenced by `componentTypeId` .

descriptionOptional
string

The description of the component type.

extendsFromOptional
string[]

The name of the parent component type that this component type extends.

functionsOptional
IResolvable | { [key: string]: IResolvable | FunctionProperty }

An object that maps strings to the functions in the component type. Each string in the mapping must be unique to this object. For information on the FunctionResponse object see the [FunctionResponse](https://docs.aws.amazon.com//iot-twinmaker/latest/apireference/API_FunctionResponse.html) API reference.

isSingletonOptional
boolean | IResolvable

A boolean value that specifies whether an entity can have more than one component of this type.

propertyDefinitionsOptional
IResolvable | { [key: string]: IResolvable | PropertyDefinitionProperty }

An object that maps strings to the property definitions in the component type. Each string in the mapping must be unique to this object. For information about the PropertyDefinitionResponse object, see the [PropertyDefinitionResponse](https://docs.aws.amazon.com//iot-twinmaker/latest/apireference/API_PropertyDefinitionResponse.html) API reference.

propertyGroupsOptional
IResolvable | { [key: string]: IResolvable | PropertyGroupProperty }

An object that maps strings to the property groups in the component type. Each string in the mapping must be unique to this object.

tagsOptional
{ [key: string]: string }

The ComponentType tags.

CloudFormation Resource

This L1 construct maps directly to the following CloudFormation resource type.

AWS::IoTTwinMaker::ComponentTypeView in CloudFormation Explorer

Learn AWS the Practical Way

Our bi-weekly newsletter teaches hands-on AWS fundamentals. No certification fluff - just practical knowledge.

Subscribe to Newsletter

Quick Facts

LevelL1 (CloudFormation)
Moduleaws-iottwinmaker
CFN TypeAWS::IoTTwinMaker::ComponentType
Properties10

Related Constructs

Explore This Service

External Links