CfnEntityPropsMixin

class aws_cdk.mixins_preview.aws_iottwinmaker.mixins.CfnEntityPropsMixin(props, *, strategy=None)

Bases: Mixin

Use the AWS::IoTTwinMaker::Entity resource to declare an entity.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iottwinmaker-entity.html
CloudformationResource:: AWS::IoTTwinMaker::Entity
Mixin:: true
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 import mixins
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_props_mixin = iottwinmaker_mixins.CfnEntityPropsMixin(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"
),
    strategy=mixins.PropertyMergeStrategy.OVERRIDE
)

Create a mixin to apply properties to AWS::IoTTwinMaker::Entity.

Parameters:

props (Union[CfnEntityMixinProps, Dict[str, Any]]) – L1 properties to apply.
strategy (Optional[PropertyMergeStrategy]) – (experimental) Strategy for merging nested properties. Default: - PropertyMergeStrategy.MERGE

Methods

apply_to(construct)

Apply the mixin properties to the construct.

Parameters:: construct (IConstruct)
Return type:: IConstruct

supports(construct)

Check if this mixin supports the given construct.

Parameters:: construct (IConstruct)
Return type:: bool

Attributes

CFN_PROPERTY_KEYS = ['components', 'compositeComponents', 'description', 'entityId', 'entityName', 'parentEntityId', 'tags', 'workspaceId']

Static Methods

classmethod is_mixin(x)

(experimental) Checks if x is a Mixin.

Parameters:: x (Any) – Any object.
Return type:: bool
Returns:: true if x is an object created from a class which extends Mixin.
Stability:: experimental

ComponentProperty

class CfnEntityPropsMixin.ComponentProperty(*, component_name=None, component_type_id=None, defined_in=None, description=None, properties=None, property_groups=None, status=None)

Bases: object

The entity component.

Parameters:

component_name (Optional[str]) – The name of the component.
component_type_id (Optional[str]) – The ID of the component type.
defined_in (Optional[str]) – The name of the property definition set in the request.
description (Optional[str]) – The description of the component.
properties (Union[IResolvable, Mapping[str, Union[IResolvable, PropertyProperty, Dict[str, Any]]], None]) – An object that maps strings to the properties to set in the component type. Each string in the mapping must be unique to this object.
property_groups (Union[IResolvable, Mapping[str, Union[IResolvable, PropertyGroupProperty, Dict[str, Any]]], None]) – An object that maps strings to the property groups in the component type. Each string in the mapping must be unique to this object.
status (Union[IResolvable, StatusProperty, Dict[str, Any], None]) – The status of the component.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iottwinmaker-entity-component.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

component_property = 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"
    )
)

Attributes

component_name

The name of the component.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iottwinmaker-entity-component.html#cfn-iottwinmaker-entity-component-componentname

component_type_id

The ID of the component type.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iottwinmaker-entity-component.html#cfn-iottwinmaker-entity-component-componenttypeid

defined_in

The name of the property definition set in the request.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iottwinmaker-entity-component.html#cfn-iottwinmaker-entity-component-definedin

description

The description of the component.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iottwinmaker-entity-component.html#cfn-iottwinmaker-entity-component-description

properties

An object that maps strings to the properties to set in the component type.

Each string in the mapping must be unique to this object.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iottwinmaker-entity-component.html#cfn-iottwinmaker-entity-component-properties

property_groups

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:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iottwinmaker-entity-component.html#cfn-iottwinmaker-entity-component-propertygroups

status

The status of the component.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iottwinmaker-entity-component.html#cfn-iottwinmaker-entity-component-status

CompositeComponentProperty

class CfnEntityPropsMixin.CompositeComponentProperty(*, component_name=None, component_path=None, component_type_id=None, description=None, properties=None, property_groups=None, status=None)

Bases: object

Information about a composite component.

Parameters:

component_name (Optional[str]) – The name of the component.
component_path (Optional[str]) – The path to the composite component, starting from the top-level component.
component_type_id (Optional[str]) – The ID of the composite component type.
description (Optional[str]) – The description of the component type.
properties (Union[IResolvable, Mapping[str, Union[IResolvable, PropertyProperty, Dict[str, Any]]], None]) – Map of strings to the properties in the component type. Each string in the mapping must be unique to this component.
property_groups (Union[IResolvable, Mapping[str, Union[IResolvable, PropertyGroupProperty, Dict[str, Any]]], None]) – The property groups.
status (Union[IResolvable, StatusProperty, Dict[str, Any], None]) – The current status of the composite component.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iottwinmaker-entity-compositecomponent.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

composite_component_property = 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"
    )
)

Attributes

component_name

The name of the component.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iottwinmaker-entity-compositecomponent.html#cfn-iottwinmaker-entity-compositecomponent-componentname

component_path

The path to the composite component, starting from the top-level component.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iottwinmaker-entity-compositecomponent.html#cfn-iottwinmaker-entity-compositecomponent-componentpath

component_type_id

The ID of the composite component type.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iottwinmaker-entity-compositecomponent.html#cfn-iottwinmaker-entity-compositecomponent-componenttypeid

description

The description of the component type.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iottwinmaker-entity-compositecomponent.html#cfn-iottwinmaker-entity-compositecomponent-description

properties

Map of strings to the properties in the component type.

Each string in the mapping must be unique to this component.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iottwinmaker-entity-compositecomponent.html#cfn-iottwinmaker-entity-compositecomponent-properties

property_groups

The property groups.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iottwinmaker-entity-compositecomponent.html#cfn-iottwinmaker-entity-compositecomponent-propertygroups

status

The current status of the composite component.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iottwinmaker-entity-compositecomponent.html#cfn-iottwinmaker-entity-compositecomponent-status

DataValueProperty

class CfnEntityPropsMixin.DataValueProperty(*, boolean_value=None, double_value=None, expression=None, integer_value=None, list_value=None, long_value=None, map_value=None, relationship_value=None, string_value=None)

Bases: object

An object that specifies a value for a property.

Parameters:

boolean_value (Union[bool, IResolvable, None]) – A boolean value.
double_value (Union[int, float, None]) – A double value.
expression (Optional[str]) – An expression that produces the value.
integer_value (Union[int, float, None]) – An integer value.
list_value (Union[IResolvable, Sequence[Union[IResolvable, DataValueProperty, Dict[str, Any]]], None]) – A list of multiple values.
long_value (Union[int, float, None]) – A long value.
map_value (Union[IResolvable, Mapping[str, Union[IResolvable, DataValueProperty, Dict[str, Any]]], None]) – An object that maps strings to multiple DataValue objects.
relationship_value (Any) – A value that relates a component to another component.
string_value (Optional[str]) – A string value.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iottwinmaker-entity-datavalue.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
# relationship_value: Any

data_value_property = 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"
)

Attributes

boolean_value

A boolean value.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iottwinmaker-entity-datavalue.html#cfn-iottwinmaker-entity-datavalue-booleanvalue

double_value

A double value.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iottwinmaker-entity-datavalue.html#cfn-iottwinmaker-entity-datavalue-doublevalue

expression

An expression that produces the value.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iottwinmaker-entity-datavalue.html#cfn-iottwinmaker-entity-datavalue-expression

integer_value

An integer value.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iottwinmaker-entity-datavalue.html#cfn-iottwinmaker-entity-datavalue-integervalue

list_value

A list of multiple values.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iottwinmaker-entity-datavalue.html#cfn-iottwinmaker-entity-datavalue-listvalue

long_value

A long value.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iottwinmaker-entity-datavalue.html#cfn-iottwinmaker-entity-datavalue-longvalue

map_value

An object that maps strings to multiple DataValue objects.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iottwinmaker-entity-datavalue.html#cfn-iottwinmaker-entity-datavalue-mapvalue

relationship_value

A value that relates a component to another component.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iottwinmaker-entity-datavalue.html#cfn-iottwinmaker-entity-datavalue-relationshipvalue

string_value

A string value.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iottwinmaker-entity-datavalue.html#cfn-iottwinmaker-entity-datavalue-stringvalue

ErrorProperty

class CfnEntityPropsMixin.ErrorProperty(*, code=None, message=None)

Bases: object

The entity error.

Parameters:

code (Optional[str]) – The entity error code.
message (Optional[str]) – The entity error message.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iottwinmaker-entity-error.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

error_property = iottwinmaker_mixins.CfnEntityPropsMixin.ErrorProperty(
    code="code",
    message="message"
)

Attributes

code

The entity error code.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iottwinmaker-entity-error.html#cfn-iottwinmaker-entity-error-code

message

The entity error message.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iottwinmaker-entity-error.html#cfn-iottwinmaker-entity-error-message

PropertyGroupProperty

class CfnEntityPropsMixin.PropertyGroupProperty(*, group_type=None, property_names=None)

Bases: object

The property group.

Parameters:

group_type (Optional[str]) – The group type.
property_names (Optional[Sequence[str]]) – The property names.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iottwinmaker-entity-propertygroup.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

property_group_property = iottwinmaker_mixins.CfnEntityPropsMixin.PropertyGroupProperty(
    group_type="groupType",
    property_names=["propertyNames"]
)

Attributes

group_type

The group type.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iottwinmaker-entity-propertygroup.html#cfn-iottwinmaker-entity-propertygroup-grouptype

property_names

The property names.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iottwinmaker-entity-propertygroup.html#cfn-iottwinmaker-entity-propertygroup-propertynames

PropertyProperty

class CfnEntityPropsMixin.PropertyProperty(*, definition=None, value=None)

Bases: object

An object that sets information about a property.

Parameters:

definition (Any) – An object that specifies information about a property.
value (Union[IResolvable, DataValueProperty, Dict[str, Any], None]) – An object that contains information about a value for a time series property.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iottwinmaker-entity-property.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
# relationship_value: Any

property_property = 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"
    )
)

Attributes

definition

An object that specifies information about a property.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iottwinmaker-entity-property.html#cfn-iottwinmaker-entity-property-definition

value

An object that contains information about a value for a time series property.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iottwinmaker-entity-property.html#cfn-iottwinmaker-entity-property-value

StatusProperty

class CfnEntityPropsMixin.StatusProperty(*, error=None, state=None)

Bases: object

The current status of the entity.

Parameters:

error (Any) – The error message.
state (Optional[str]) – The current state of the entity, component, component type, or workspace. Valid Values: CREATING | UPDATING | DELETING | ACTIVE | ERROR

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iottwinmaker-entity-status.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

# error: Any

status_property = iottwinmaker_mixins.CfnEntityPropsMixin.StatusProperty(
    error=error,
    state="state"
)

Attributes

error

The error message.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iottwinmaker-entity-status.html#cfn-iottwinmaker-entity-status-error

state

The current state of the entity, component, component type, or workspace.

Valid Values: CREATING | UPDATING | DELETING | ACTIVE | ERROR

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iottwinmaker-entity-status.html#cfn-iottwinmaker-entity-status-state