aws-cdk-lib.aws_iottwinmaker.CfnComponentTypeProps

interface CfnComponentTypeProps

LanguageType name
.NETAmazon.CDK.AWS.IoTTwinMaker.CfnComponentTypeProps
Gogithub.com/aws/aws-cdk-go/awscdk/v2/awsiottwinmaker#CfnComponentTypeProps
Javasoftware.amazon.awscdk.services.iottwinmaker.CfnComponentTypeProps
Pythonaws_cdk.aws_iottwinmaker.CfnComponentTypeProps
TypeScript aws-cdk-lib » aws_iottwinmaker » CfnComponentTypeProps

Properties for defining a CfnComponentType.

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_iottwinmaker as iottwinmaker } from 'aws-cdk-lib';

declare const dataTypeProperty_: iottwinmaker.CfnComponentType.DataTypeProperty;
declare const dataValueProperty_: iottwinmaker.CfnComponentType.DataValueProperty;
declare const relationshipValue: any;
const cfnComponentTypeProps: iottwinmaker.CfnComponentTypeProps = {
  componentTypeId: 'componentTypeId',
  workspaceId: 'workspaceId',

  // the properties below are optional
  description: 'description',
  extendsFrom: ['extendsFrom'],
  functions: {
    functionsKey: {
      implementedBy: {
        isNative: false,
        lambda: {
          arn: 'arn',
        },
      },
      requiredProperties: ['requiredProperties'],
      scope: 'scope',
    },
  },
  isSingleton: false,
  propertyDefinitions: {
    propertyDefinitionsKey: {
      configurations: {
        configurationsKey: 'configurations',
      },
      dataType: {
        type: 'type',

        // the properties below are optional
        allowedValues: [{
          booleanValue: false,
          doubleValue: 123,
          expression: 'expression',
          integerValue: 123,
          listValue: [dataValueProperty_],
          longValue: 123,
          mapValue: {
            mapValueKey: dataValueProperty_,
          },
          relationshipValue: relationshipValue,
          stringValue: 'stringValue',
        }],
        nestedType: dataTypeProperty_,
        relationship: {
          relationshipType: 'relationshipType',
          targetComponentTypeId: 'targetComponentTypeId',
        },
        unitOfMeasure: 'unitOfMeasure',
      },
      defaultValue: {
        booleanValue: false,
        doubleValue: 123,
        expression: 'expression',
        integerValue: 123,
        listValue: [dataValueProperty_],
        longValue: 123,
        mapValue: {
          mapValueKey: dataValueProperty_,
        },
        relationshipValue: relationshipValue,
        stringValue: 'stringValue',
      },
      isExternalId: false,
      isRequiredInEntity: false,
      isStoredExternally: false,
      isTimeSeries: false,
    },
  },
  propertyGroups: {
    propertyGroupsKey: {
      groupType: 'groupType',
      propertyNames: ['propertyNames'],
    },
  },
  tags: {
    tagsKey: 'tags',
  },
};

Properties

NameTypeDescription
componentTypeIdstringThe ID of the component type.
workspaceIdstringThe ID of the workspace.
description?stringThe description of the component type.
extendsFrom?string[]The name of the parent component type that this component type extends.
functions?IResolvable | { [string]: IResolvable | FunctionProperty }An object that maps strings to the functions in the component type.
isSingleton?boolean | IResolvableA boolean value that specifies whether an entity can have more than one component of this type.
propertyDefinitions?IResolvable | { [string]: IResolvable | PropertyDefinitionProperty }An object that maps strings to the property definitions in the component type.
propertyGroups?IResolvable | { [string]: IResolvable | PropertyGroupProperty }An object that maps strings to the property groups in the component type.
tags?{ [string]: string }The ComponentType tags.

componentTypeId

Type: string

The ID of the component type.


workspaceId

Type: string

The ID of the workspace.


description?

Type: string (optional)

The description of the component type.


extendsFrom?

Type: string[] (optional)

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


functions?

Type: IResolvable | { [string]: IResolvable | FunctionProperty } (optional)

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 API reference.


isSingleton?

Type: boolean | IResolvable (optional)

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


propertyDefinitions?

Type: IResolvable | { [string]: IResolvable | PropertyDefinitionProperty } (optional)

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 API reference.


propertyGroups?

Type: IResolvable | { [string]: IResolvable | PropertyGroupProperty } (optional)

An object that maps strings to the property groups in the component type.

Each string in the mapping must be unique to this object.


tags?

Type: { [string]: string } (optional)

The ComponentType tags.