CfnEntityProps
- class aws_cdk.aws_iottwinmaker.CfnEntityProps(*, entity_name, workspace_id, components=None, description=None, entity_id=None, parent_entity_id=None, tags=None)
Bases:
object
Properties for defining a
CfnEntity
.- Parameters:
entity_name (
str
) – The entity name.workspace_id (
str
) – The ID of the workspace.components (
Union
[IResolvable
,Mapping
[str
,Union
[IResolvable
,ComponentProperty
,Dict
[str
,Any
]]],None
]) – 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.description (
Optional
[str
]) – The description of the entity.entity_id (
Optional
[str
]) – The entity ID.parent_entity_id (
Optional
[str
]) – The ID of the parent entity.tags (
Optional
[Mapping
[str
,str
]]) – Metadata that you can use to manage the entity.
- Link:
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iottwinmaker-entity.html
- ExampleMetadata:
fixture=_generated
Example:
# The code below shows an example of how to instantiate this type. # The values are placeholders you should change. import aws_cdk.aws_iottwinmaker as iottwinmaker # data_value_property_: iottwinmaker.CfnEntity.DataValueProperty # definition: Any # error: Any # relationship_value: Any cfn_entity_props = iottwinmaker.CfnEntityProps( entity_name="entityName", workspace_id="workspaceId", # the properties below are optional components={ "components_key": iottwinmaker.CfnEntity.ComponentProperty( component_name="componentName", component_type_id="componentTypeId", defined_in="definedIn", description="description", properties={ "properties_key": iottwinmaker.CfnEntity.PropertyProperty( definition=definition, value=iottwinmaker.CfnEntity.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" ) ) }, property_groups={ "property_groups_key": iottwinmaker.CfnEntity.PropertyGroupProperty( group_type="groupType", property_names=["propertyNames"] ) }, status=iottwinmaker.CfnEntity.StatusProperty( error=error, state="state" ) ) }, description="description", entity_id="entityId", parent_entity_id="parentEntityId", tags={ "tags_key": "tags" } )
Attributes
- components
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.
- description
The description of the entity.
- entity_id
The entity ID.
- entity_name
The entity name.
- parent_entity_id
The ID of the parent entity.
- tags
Metadata that you can use to manage the entity.
- workspace_id
The ID of the workspace.