CfnEntityMixinProps
- class aws_cdk.mixins_preview.aws_iottwinmaker.mixins.CfnEntityMixinProps(*, components=None, composite_components=None, description=None, entity_id=None, entity_name=None, parent_entity_id=None, tags=None, workspace_id=None)
Bases:
objectProperties for CfnEntityPropsMixin.
- Parameters:
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.composite_components (
Union[IResolvable,Mapping[str,Union[IResolvable,CompositeComponentProperty,Dict[str,Any]]],None]) – Maps string tocompositeComponentupdates in the request. Each key of the map represents thecomponentPathof thecompositeComponent.description (
Optional[str]) – The description of the entity.entity_id (
Optional[str]) – The ID of the entity.entity_name (
Optional[str]) – The entity name.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.workspace_id (
Optional[str]) – The ID of the workspace that contains the entity.
- See:
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. from aws_cdk.mixins_preview.aws_iottwinmaker import mixins as iottwinmaker_mixins # data_value_property_: iottwinmaker_mixins.CfnEntityPropsMixin.DataValueProperty # definition: Any # error: Any # relationship_value: Any cfn_entity_mixin_props = iottwinmaker_mixins.CfnEntityMixinProps( components={ "components_key": iottwinmaker_mixins.CfnEntityPropsMixin.ComponentProperty( component_name="componentName", component_type_id="componentTypeId", defined_in="definedIn", description="description", properties={ "properties_key": iottwinmaker_mixins.CfnEntityPropsMixin.PropertyProperty( definition=definition, value=iottwinmaker_mixins.CfnEntityPropsMixin.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_mixins.CfnEntityPropsMixin.PropertyGroupProperty( group_type="groupType", property_names=["propertyNames"] ) }, status=iottwinmaker_mixins.CfnEntityPropsMixin.StatusProperty( error=error, state="state" ) ) }, composite_components={ "composite_components_key": iottwinmaker_mixins.CfnEntityPropsMixin.CompositeComponentProperty( component_name="componentName", component_path="componentPath", component_type_id="componentTypeId", description="description", properties={ "properties_key": iottwinmaker_mixins.CfnEntityPropsMixin.PropertyProperty( definition=definition, value=iottwinmaker_mixins.CfnEntityPropsMixin.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_mixins.CfnEntityPropsMixin.PropertyGroupProperty( group_type="groupType", property_names=["propertyNames"] ) }, status=iottwinmaker_mixins.CfnEntityPropsMixin.StatusProperty( error=error, state="state" ) ) }, description="description", entity_id="entityId", entity_name="entityName", parent_entity_id="parentEntityId", tags={ "tags_key": "tags" }, workspace_id="workspaceId" )
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.
- composite_components
Maps string to
compositeComponentupdates in the request.Each key of the map represents the
componentPathof thecompositeComponent.
- description
The description of the entity.
- entity_id
The ID of the entity.
- 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 that contains the entity.