interface CfnComponentTypeMixinProps

Language	Type name
.NET	Amazon.CDK.Mixins.Preview.AWS.IoTTwinMaker.Mixins.CfnComponentTypeMixinProps
Go	github.com/aws/aws-cdk-go/awscdkmixinspreview/v2/awsiottwinmaker/mixins#CfnComponentTypeMixinProps
Java	software.amazon.awscdk.mixins.preview.services.iottwinmaker.mixins.CfnComponentTypeMixinProps
Python	aws_cdk.mixins_preview.aws_iottwinmaker.mixins.CfnComponentTypeMixinProps
TypeScript	@aws-cdk/mixins-preview » aws_iottwinmaker » mixins » CfnComponentTypeMixinProps

Properties for CfnComponentTypePropsMixin.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iottwinmaker-componenttype.html

Example

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

declare const dataTypeProperty_: iottwinmaker_mixins.CfnComponentTypePropsMixin.DataTypeProperty;
declare const dataValueProperty_: iottwinmaker_mixins.CfnComponentTypePropsMixin.DataValueProperty;
declare const relationshipValue: any;
const cfnComponentTypeMixinProps: iottwinmaker_mixins.CfnComponentTypeMixinProps = {
  componentTypeId: 'componentTypeId',
  compositeComponentTypes: {
    compositeComponentTypesKey: {
      componentTypeId: 'componentTypeId',
    },
  },
  description: 'description',
  extendsFrom: ['extendsFrom'],
  functions: {
    functionsKey: {
      implementedBy: {
        isNative: false,
        lambda: {
          arn: 'arn',
        },
      },
      requiredProperties: ['requiredProperties'],
      scope: 'scope',
    },
  },
  isSingleton: false,
  propertyDefinitions: {
    propertyDefinitionsKey: {
      configurations: {
        configurationsKey: 'configurations',
      },
      dataType: {
        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',
        },
        type: 'type',
        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',
  },
  workspaceId: 'workspaceId',
};

Properties

Name	Type	Description
componentTypeId?	string	The ID of the component type.
compositeComponentTypes?	IResolvable | { [string]: IResolvable | CompositeComponentTypeProperty }	Maps strings to compositeComponentTypes of the componentType .
description?	string	The 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 | IResolvable	A 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.
workspaceId?	string	The ID of the workspace that contains the component type.

---

componentTypeId?

Type: string (optional)

The ID of the component type.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iottwinmaker-componenttype.html#cfn-iottwinmaker-componenttype-componenttypeid

---

compositeComponentTypes?

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

Maps strings to compositeComponentTypes of the componentType .

CompositeComponentType is referenced by componentTypeId .

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iottwinmaker-componenttype.html#cfn-iottwinmaker-componenttype-compositecomponenttypes

---

description?

Type: string (optional)

The description of the component type.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iottwinmaker-componenttype.html#cfn-iottwinmaker-componenttype-description

---

extendsFrom?

Type: string[] (optional)

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

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iottwinmaker-componenttype.html#cfn-iottwinmaker-componenttype-extendsfrom

---

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.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iottwinmaker-componenttype.html#cfn-iottwinmaker-componenttype-functions

---

isSingleton?

Type: boolean | IResolvable (optional)

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

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iottwinmaker-componenttype.html#cfn-iottwinmaker-componenttype-issingleton

---

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.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iottwinmaker-componenttype.html#cfn-iottwinmaker-componenttype-propertydefinitions

---

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.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iottwinmaker-componenttype.html#cfn-iottwinmaker-componenttype-propertygroups

---

tags?

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

The ComponentType tags.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iottwinmaker-componenttype.html#cfn-iottwinmaker-componenttype-tags

---

workspaceId?

Type: string (optional)

The ID of the workspace that contains the component type.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iottwinmaker-componenttype.html#cfn-iottwinmaker-componenttype-workspaceid