CfnComponentTypeProps Struct
Properties for defining a CfnComponentType.
Example
ts
// 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
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: {
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',
},
};
python
# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_iottwinmaker as iottwinmaker
# data_type_property_: iottwinmaker.CfnComponentType.DataTypeProperty
# data_value_property_: iottwinmaker.CfnComponentType.DataValueProperty
# relationship_value: Any
cfn_component_type_props = iottwinmaker.CfnComponentTypeProps(
component_type_id="componentTypeId",
workspace_id="workspaceId",
# the properties below are optional
composite_component_types={
"composite_component_types_key": iottwinmaker.CfnComponentType.CompositeComponentTypeProperty(
component_type_id="componentTypeId"
)
},
description="description",
extends_from=["extendsFrom"],
functions={
"functions_key": iottwinmaker.CfnComponentType.FunctionProperty(
implemented_by=iottwinmaker.CfnComponentType.DataConnectorProperty(
is_native=False,
lambda_=iottwinmaker.CfnComponentType.LambdaFunctionProperty(
arn="arn"
)
),
required_properties=["requiredProperties"],
scope="scope"
)
},
is_singleton=False,
property_definitions={
"property_definitions_key": iottwinmaker.CfnComponentType.PropertyDefinitionProperty(
configurations={
"configurations_key": "configurations"
},
data_type=iottwinmaker.CfnComponentType.DataTypeProperty(
type="type",
# the properties below are optional
allowed_values=[iottwinmaker.CfnComponentType.DataValueProperty(
boolean_value=False,
double_value=123,
expression="expression",
integer_value=123,
list_value=[data_value_property_],
long_value=123,
map_value={
"map_value_key": data_value_property_
},
relationship_value=relationship_value,
string_value="stringValue"
)],
nested_type=data_type_property_,
relationship=iottwinmaker.CfnComponentType.RelationshipProperty(
relationship_type="relationshipType",
target_component_type_id="targetComponentTypeId"
),
unit_of_measure="unitOfMeasure"
),
default_value=iottwinmaker.CfnComponentType.DataValueProperty(
boolean_value=False,
double_value=123,
expression="expression",
integer_value=123,
list_value=[data_value_property_],
long_value=123,
map_value={
"map_value_key": data_value_property_
},
relationship_value=relationship_value,
string_value="stringValue"
),
is_external_id=False,
is_required_in_entity=False,
is_stored_externally=False,
is_time_series=False
)
},
property_groups={
"property_groups_key": iottwinmaker.CfnComponentType.PropertyGroupProperty(
group_type="groupType",
property_names=["propertyNames"]
)
},
tags={
"tags_key": "tags"
}
)
java
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import software.amazon.awscdk.services.iottwinmaker.*;
DataTypeProperty dataTypeProperty_;
DataValueProperty dataValueProperty_;
Object relationshipValue;
CfnComponentTypeProps cfnComponentTypeProps = CfnComponentTypeProps.builder()
.componentTypeId("componentTypeId")
.workspaceId("workspaceId")
// the properties below are optional
.compositeComponentTypes(Map.of(
"compositeComponentTypesKey", CompositeComponentTypeProperty.builder()
.componentTypeId("componentTypeId")
.build()))
.description("description")
.extendsFrom(List.of("extendsFrom"))
.functions(Map.of(
"functionsKey", FunctionProperty.builder()
.implementedBy(DataConnectorProperty.builder()
.isNative(false)
.lambda(LambdaFunctionProperty.builder()
.arn("arn")
.build())
.build())
.requiredProperties(List.of("requiredProperties"))
.scope("scope")
.build()))
.isSingleton(false)
.propertyDefinitions(Map.of(
"propertyDefinitionsKey", PropertyDefinitionProperty.builder()
.configurations(Map.of(
"configurationsKey", "configurations"))
.dataType(DataTypeProperty.builder()
.type("type")
// the properties below are optional
.allowedValues(List.of(DataValueProperty.builder()
.booleanValue(false)
.doubleValue(123)
.expression("expression")
.integerValue(123)
.listValue(List.of(dataValueProperty_))
.longValue(123)
.mapValue(Map.of(
"mapValueKey", dataValueProperty_))
.relationshipValue(relationshipValue)
.stringValue("stringValue")
.build()))
.nestedType(dataTypeProperty_)
.relationship(RelationshipProperty.builder()
.relationshipType("relationshipType")
.targetComponentTypeId("targetComponentTypeId")
.build())
.unitOfMeasure("unitOfMeasure")
.build())
.defaultValue(DataValueProperty.builder()
.booleanValue(false)
.doubleValue(123)
.expression("expression")
.integerValue(123)
.listValue(List.of(dataValueProperty_))
.longValue(123)
.mapValue(Map.of(
"mapValueKey", dataValueProperty_))
.relationshipValue(relationshipValue)
.stringValue("stringValue")
.build())
.isExternalId(false)
.isRequiredInEntity(false)
.isStoredExternally(false)
.isTimeSeries(false)
.build()))
.propertyGroups(Map.of(
"propertyGroupsKey", PropertyGroupProperty.builder()
.groupType("groupType")
.propertyNames(List.of("propertyNames"))
.build()))
.tags(Map.of(
"tagsKey", "tags"))
.build();
csharp
// Install: dotnet add package Amazon.CDK.Lib
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.IoTTwinMaker;
DataTypeProperty dataTypeProperty_;
DataValueProperty dataValueProperty_;
var relationshipValue;
var cfnComponentTypeProps = new CfnComponentTypeProps {
ComponentTypeId = "componentTypeId",
WorkspaceId = "workspaceId",
// the properties below are optional
CompositeComponentTypes = new Dictionary<string, object> {
{ "compositeComponentTypesKey", new CompositeComponentTypeProperty {
ComponentTypeId = "componentTypeId"
} }
},
Description = "description",
ExtendsFrom = new [] { "extendsFrom" },
Functions = new Dictionary<string, object> {
{ "functionsKey", new FunctionProperty {
ImplementedBy = new DataConnectorProperty {
IsNative = false,
Lambda = new LambdaFunctionProperty {
Arn = "arn"
}
},
RequiredProperties = new [] { "requiredProperties" },
Scope = "scope"
} }
},
IsSingleton = false,
PropertyDefinitions = new Dictionary<string, object> {
{ "propertyDefinitionsKey", new PropertyDefinitionProperty {
Configurations = new Dictionary<string, string> {
{ "configurationsKey", "configurations" }
},
DataType = new DataTypeProperty {
Type = "type",
// the properties below are optional
AllowedValues = new [] { new DataValueProperty {
BooleanValue = false,
DoubleValue = 123,
Expression = "expression",
IntegerValue = 123,
ListValue = new [] { dataValueProperty_ },
LongValue = 123,
MapValue = new Dictionary<string, object> {
{ "mapValueKey", dataValueProperty_ }
},
RelationshipValue = relationshipValue,
StringValue = "stringValue"
} },
NestedType = dataTypeProperty_,
Relationship = new RelationshipProperty {
RelationshipType = "relationshipType",
TargetComponentTypeId = "targetComponentTypeId"
},
UnitOfMeasure = "unitOfMeasure"
},
DefaultValue = new DataValueProperty {
BooleanValue = false,
DoubleValue = 123,
Expression = "expression",
IntegerValue = 123,
ListValue = new [] { dataValueProperty_ },
LongValue = 123,
MapValue = new Dictionary<string, object> {
{ "mapValueKey", dataValueProperty_ }
},
RelationshipValue = relationshipValue,
StringValue = "stringValue"
},
IsExternalId = false,
IsRequiredInEntity = false,
IsStoredExternally = false,
IsTimeSeries = false
} }
},
PropertyGroups = new Dictionary<string, object> {
{ "propertyGroupsKey", new PropertyGroupProperty {
GroupType = "groupType",
PropertyNames = new [] { "propertyNames" }
} }
},
Tags = new Dictionary<string, string> {
{ "tagsKey", "tags" }
}
};
go
// Install: go get github.com/aws/aws-cdk-go/awscdk/v2
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"
var dataTypeProperty_ DataTypeProperty
var dataValueProperty_ DataValueProperty
var relationshipValue interface{}
cfnComponentTypeProps := &CfnComponentTypeProps{
ComponentTypeId: jsii.String("componentTypeId"),
WorkspaceId: jsii.String("workspaceId"),
// the properties below are optional
CompositeComponentTypes: map[string]interface{}{
"compositeComponentTypesKey": &CompositeComponentTypeProperty{
"componentTypeId": jsii.String("componentTypeId"),
},
},
Description: jsii.String("description"),
ExtendsFrom: []*string{
jsii.String("extendsFrom"),
},
Functions: map[string]interface{}{
"functionsKey": &FunctionProperty{
"implementedBy": &DataConnectorProperty{
"isNative": jsii.Boolean(false),
"lambda": &LambdaFunctionProperty{
"arn": jsii.String("arn"),
},
},
"requiredProperties": []*string{
jsii.String("requiredProperties"),
},
"scope": jsii.String("scope"),
},
},
IsSingleton: jsii.Boolean(false),
PropertyDefinitions: map[string]interface{}{
"propertyDefinitionsKey": &PropertyDefinitionProperty{
"configurations": map[string]*string{
"configurationsKey": jsii.String("configurations"),
},
"dataType": &DataTypeProperty{
"type": jsii.String("type"),
// the properties below are optional
"allowedValues": []interface{}{
&DataValueProperty{
"booleanValue": jsii.Boolean(false),
"doubleValue": jsii.Number(123),
"expression": jsii.String("expression"),
"integerValue": jsii.Number(123),
"listValue": []interface{}{
dataValueProperty_,
},
"longValue": jsii.Number(123),
"mapValue": map[string]interface{}{
"mapValueKey": dataValueProperty_,
},
"relationshipValue": relationshipValue,
"stringValue": jsii.String("stringValue"),
},
},
"nestedType": dataTypeProperty_,
"relationship": &RelationshipProperty{
"relationshipType": jsii.String("relationshipType"),
"targetComponentTypeId": jsii.String("targetComponentTypeId"),
},
"unitOfMeasure": jsii.String("unitOfMeasure"),
},
"defaultValue": &DataValueProperty{
"booleanValue": jsii.Boolean(false),
"doubleValue": jsii.Number(123),
"expression": jsii.String("expression"),
"integerValue": jsii.Number(123),
"listValue": []interface{}{
dataValueProperty_,
},
"longValue": jsii.Number(123),
"mapValue": map[string]interface{}{
"mapValueKey": dataValueProperty_,
},
"relationshipValue": relationshipValue,
"stringValue": jsii.String("stringValue"),
},
"isExternalId": jsii.Boolean(false),
"isRequiredInEntity": jsii.Boolean(false),
"isStoredExternally": jsii.Boolean(false),
"isTimeSeries": jsii.Boolean(false),
},
},
PropertyGroups: map[string]interface{}{
"propertyGroupsKey": &PropertyGroupProperty{
"groupType": jsii.String("groupType"),
"propertyNames": []*string{
jsii.String("propertyNames"),
},
},
},
Tags: map[string]*string{
"tagsKey": jsii.String("tags"),
},
}
Properties
componentTypeIdstringcomponent_type_idstrcomponentTypeIdStringComponentTypeIdstringComponentTypeId*stringrequired#The ID of the component type.
compositeComponentTypesoptionalIResolvable | { [key: string]: IResolvable | CfnComponentType.CompositeComponentTypeProperty }composite_component_typesoptionaltyping.Union[IResolvable, typing.Mapping[str, typing.Union[IResolvable, CompositeComponentTypeProperty]]]compositeComponentTypesoptionalIResolvableCompositeComponentTypesoptionalIResolvableCompositeComponentTypesoptionalinterface{}#Maps strings to `compositeComponentTypes` of the `componentType` .
CompositeComponentType is referenced by componentTypeId .
descriptionoptionalstringdescriptionoptionalstrdescriptionoptionalStringDescriptionoptionalstringDescriptionoptional*string#The description of the component type.
extendsFromoptionalstring[]extends_fromoptionaltyping.List[str]extendsFromoptionalList<String>ExtendsFromoptionalstring[]ExtendsFromoptional*[]*string#The name of the parent component type that this component type extends.
functionsoptionalIResolvable | { [key: string]: IResolvable | CfnComponentType.FunctionProperty }functionsoptionaltyping.Union[IResolvable, typing.Mapping[str, typing.Union[IResolvable, FunctionProperty]]]functionsoptionalIResolvableFunctionsoptionalIResolvableFunctionsoptionalinterface{}#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.
isSingletonoptionalboolean | IResolvableis_singletonoptionaltyping.Union[bool, IResolvable]isSingletonoptionalBooleanIsSingletonoptionalboolIsSingletonoptionalinterface{}#A boolean value that specifies whether an entity can have more than one component of this type.
propertyDefinitionsoptionalIResolvable | { [key: string]: IResolvable | CfnComponentType.PropertyDefinitionProperty }property_definitionsoptionaltyping.Union[IResolvable, typing.Mapping[str, typing.Union[IResolvable, PropertyDefinitionProperty]]]propertyDefinitionsoptionalIResolvablePropertyDefinitionsoptionalIResolvablePropertyDefinitionsoptionalinterface{}#An object that maps strings to the property definitions in the component type.
notes
Each string in the mapping must be unique to this object.
For information about the PropertyDefinitionResponse object, see the PropertyDefinitionResponse API reference.
propertyGroupsoptionalIResolvable | { [key: string]: IResolvable | CfnComponentType.PropertyGroupProperty }property_groupsoptionaltyping.Union[IResolvable, typing.Mapping[str, typing.Union[IResolvable, PropertyGroupProperty]]]propertyGroupsoptionalIResolvablePropertyGroupsoptionalIResolvablePropertyGroupsoptionalinterface{}#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 }tagsoptionaltyping.Mapping[str, str]tagsoptionalMap<String, String>TagsoptionalIDictionary<string, string>Tagsoptional*map[string]*string#The ComponentType tags.
The ID of the workspace that contains the component type.