interface CfnEntityProps
Language | Type name |
---|---|
![]() | Amazon.CDK.AWS.IoTTwinMaker.CfnEntityProps |
![]() | github.com/aws/aws-cdk-go/awscdk/v2/awsiottwinmaker#CfnEntityProps |
![]() | software.amazon.awscdk.services.iottwinmaker.CfnEntityProps |
![]() | aws_cdk.aws_iottwinmaker.CfnEntityProps |
![]() | aws-cdk-lib » aws_iottwinmaker » CfnEntityProps |
Properties for defining a CfnEntity
.
See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iottwinmaker-entity.html
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 dataValueProperty_: iottwinmaker.CfnEntity.DataValueProperty;
declare const definition: any;
declare const error: any;
declare const relationshipValue: any;
const cfnEntityProps: iottwinmaker.CfnEntityProps = {
entityName: 'entityName',
workspaceId: 'workspaceId',
// the properties below are optional
components: {
componentsKey: {
componentName: 'componentName',
componentTypeId: 'componentTypeId',
definedIn: 'definedIn',
description: 'description',
properties: {
propertiesKey: {
definition: definition,
value: {
booleanValue: false,
doubleValue: 123,
expression: 'expression',
integerValue: 123,
listValue: [dataValueProperty_],
longValue: 123,
mapValue: {
mapValueKey: dataValueProperty_,
},
relationshipValue: relationshipValue,
stringValue: 'stringValue',
},
},
},
propertyGroups: {
propertyGroupsKey: {
groupType: 'groupType',
propertyNames: ['propertyNames'],
},
},
status: {
error: error,
state: 'state',
},
},
},
compositeComponents: {
compositeComponentsKey: {
componentName: 'componentName',
componentPath: 'componentPath',
componentTypeId: 'componentTypeId',
description: 'description',
properties: {
propertiesKey: {
definition: definition,
value: {
booleanValue: false,
doubleValue: 123,
expression: 'expression',
integerValue: 123,
listValue: [dataValueProperty_],
longValue: 123,
mapValue: {
mapValueKey: dataValueProperty_,
},
relationshipValue: relationshipValue,
stringValue: 'stringValue',
},
},
},
propertyGroups: {
propertyGroupsKey: {
groupType: 'groupType',
propertyNames: ['propertyNames'],
},
},
status: {
error: error,
state: 'state',
},
},
},
description: 'description',
entityId: 'entityId',
parentEntityId: 'parentEntityId',
tags: {
tagsKey: 'tags',
},
};
Properties
Name | Type | Description |
---|---|---|
entity | string | The entity name. |
workspace | string | The ID of the workspace that contains the entity. |
components? | IResolvable | { [string]: IResolvable | Component } | An object that maps strings to the components in the entity. |
composite | IResolvable | { [string]: IResolvable | Composite } | Maps string to compositeComponent updates in the request. |
description? | string | The description of the entity. |
entity | string | The ID of the entity. |
parent | string | The ID of the parent entity. |
tags? | { [string]: string } | Metadata that you can use to manage the entity. |
entityName
Type:
string
The entity name.
workspaceId
Type:
string
The ID of the workspace that contains the entity.
components?
Type:
IResolvable
| { [string]:
IResolvable
|
Component
}
(optional)
An object that maps strings to the components in the entity.
Each string in the mapping must be unique to this object.
For information on the component object see the component API reference.
compositeComponents?
Type:
IResolvable
| { [string]:
IResolvable
|
Composite
}
(optional)
Maps string to compositeComponent
updates in the request.
Each key of the map represents the componentPath
of the compositeComponent
.
description?
Type:
string
(optional)
The description of the entity.
entityId?
Type:
string
(optional)
The ID of the entity.
parentEntityId?
Type:
string
(optional)
The ID of the parent entity.
tags?
Type:
{ [string]: string }
(optional)
Metadata that you can use to manage the entity.