CfnEntity

class aws_cdk.aws_iottwinmaker.CfnEntity(scope, id, *, entity_name, workspace_id, components=None, composite_components=None, description=None, entity_id=None, parent_entity_id=None, tags=None)

Bases: CfnResource

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

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 import aws_iottwinmaker as iottwinmaker

# data_value_property_: iottwinmaker.CfnEntity.DataValueProperty
# definition: Any
# error: Any
# relationship_value: Any

cfn_entity = iottwinmaker.CfnEntity(self, "MyCfnEntity",
    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"
            )
        )
    },
    composite_components={
        "composite_components_key": iottwinmaker.CfnEntity.CompositeComponentProperty(
            component_name="componentName",
            component_path="componentPath",
            component_type_id="componentTypeId",
            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"
    }
)
Parameters:

  • scope (Construct) – Scope in which this resource is defined.

  • id (str) – Construct identifier for this resource (unique in its scope).

  • entity_name (str) – The entity name.

  • workspace_id (str) – The ID of the workspace that contains the entity.

  • 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 to compositeComponent updates in the request. Each key of the map represents the componentPath of the compositeComponent .

  • description (Optional[str]) – The description of the entity.

  • entity_id (Optional[str]) – The ID of the entity.

  • 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.

Methods

add_deletion_override(path)

Syntactic sugar for addOverride(path, undefined).

Parameters:

path (str) – The path of the value to delete.

Return type:

None

add_dependency(target)

Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.

This can be used for resources across stacks (or nested stack) boundaries and the dependency will automatically be transferred to the relevant scope.

Parameters:

target (CfnResource) –

Return type:

None

add_depends_on(target)

(deprecated) Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.

Parameters:

target (CfnResource) –

Deprecated:

use addDependency

Stability:

deprecated

Return type:

None

add_metadata(key, value)

Add a value to the CloudFormation Resource Metadata.

Parameters:

  • key (str) –

  • value (Any) –

See:

Return type:

None

https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html

Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.

add_override(path, value)

Adds an override to the synthesized CloudFormation resource.

To add a property override, either use addPropertyOverride or prefix path with “Properties.” (i.e. Properties.TopicName).

If the override is nested, separate each nested level using a dot (.) in the path parameter. If there is an array as part of the nesting, specify the index in the path.

To include a literal . in the property name, prefix with a \. In most programming languages you will need to write this as "\\." because the \ itself will need to be escaped.

For example:

cfn_resource.add_override("Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes", ["myattribute"])
cfn_resource.add_override("Properties.GlobalSecondaryIndexes.1.ProjectionType", "INCLUDE")

would add the overrides Example:

"Properties": {
  "GlobalSecondaryIndexes": [
    {
      "Projection": {
        "NonKeyAttributes": [ "myattribute" ]
        ...
      }
      ...
    },
    {
      "ProjectionType": "INCLUDE"
      ...
    },
  ]
  ...
}

The value argument to addOverride will not be processed or translated in any way. Pass raw JSON values in here with the correct capitalization for CloudFormation. If you pass CDK classes or structs, they will be rendered with lowercased key names, and CloudFormation will reject the template.

Parameters:

  • path (str) –

    • The path of the property, you can use dot notation to override values in complex types. Any intermediate keys will be created as needed.

  • value (Any) –

    • The value. Could be primitive or complex.

Return type:

None

add_property_deletion_override(property_path)

Adds an override that deletes the value of a property from the resource definition.

Parameters:

property_path (str) – The path to the property.

Return type:

None

add_property_override(property_path, value)

Adds an override to a resource property.

Syntactic sugar for addOverride("Properties.<...>", value).

Parameters:

  • property_path (str) – The path of the property.

  • value (Any) – The value.

Return type:

None

apply_removal_policy(policy=None, *, apply_to_update_replace_policy=None, default=None)

Sets the deletion policy of the resource based on the removal policy specified.

The Removal Policy controls what happens to this resource when it stops being managed by CloudFormation, either because you’ve removed it from the CDK application or because you’ve made a change that requires the resource to be replaced.

The resource can be deleted (RemovalPolicy.DESTROY), or left in your AWS account for data recovery and cleanup later (RemovalPolicy.RETAIN). In some cases, a snapshot can be taken of the resource prior to deletion (RemovalPolicy.SNAPSHOT). A list of resources that support this policy can be found in the following link:

Parameters:

  • policy (Optional[RemovalPolicy]) –

  • apply_to_update_replace_policy (Optional[bool]) – Apply the same deletion policy to the resource’s “UpdateReplacePolicy”. Default: true

  • default (Optional[RemovalPolicy]) – The default policy to apply in case the removal policy is not defined. Default: - Default value is resource specific. To determine the default value for a resource, please consult that specific resource’s documentation.

See:

https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-deletionpolicy.html#aws-attribute-deletionpolicy-options

Return type:

None

get_att(attribute_name, type_hint=None)

Returns a token for an runtime attribute of this resource.

Ideally, use generated attribute accessors (e.g. resource.arn), but this can be used for future compatibility in case there is no generated attribute.

Parameters:

  • attribute_name (str) – The name of the attribute.

  • type_hint (Optional[ResolutionTypeHint]) –

Return type:

Reference

get_metadata(key)

Retrieve a value value from the CloudFormation Resource Metadata.

Parameters:

key (str) –

See:

Return type:

Any

https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html

Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.

inspect(inspector)

Examines the CloudFormation resource and discloses attributes.

Parameters:

inspector (TreeInspector) – tree inspector to collect and process attributes.

Return type:

None

obtain_dependencies()

Retrieves an array of resources this resource depends on.

This assembles dependencies on resources across stacks (including nested stacks) automatically.

Return type:

List[Union[Stack, CfnResource]]

obtain_resource_dependencies()

Get a shallow copy of dependencies between this resource and other resources in the same stack.

Return type:

List[CfnResource]

override_logical_id(new_logical_id)

Overrides the auto-generated logical ID with a specific ID.

Parameters:

new_logical_id (str) – The new logical ID to use for this stack element.

Return type:

None

remove_dependency(target)

Indicates that this resource no longer depends on another resource.

This can be used for resources across stacks (including nested stacks) and the dependency will automatically be removed from the relevant scope.

Parameters:

target (CfnResource) –

Return type:

None

replace_dependency(target, new_target)

Replaces one dependency with another.

Parameters:
Return type:

None

to_string()

Returns a string representation of this construct.

Return type:

str

Returns:

a string representation of this resource

Attributes

CFN_RESOURCE_TYPE_NAME = 'AWS::IoTTwinMaker::Entity'
attr_arn

The entity ARN.

CloudformationAttribute:

Arn

attr_creation_date_time

The date and time the entity was created.

CloudformationAttribute:

CreationDateTime

attr_has_child_entities

A boolean value that specifies whether the entity has child entities or not.

CloudformationAttribute:

HasChildEntities

attr_status

Status

Type:

cloudformationAttribute

attr_status_error

Status.Error

Type:

cloudformationAttribute

attr_status_error_code

Status.Error.Code

Type:

cloudformationAttribute

attr_status_error_message

Status.Error.Message

Type:

cloudformationAttribute

attr_status_state

Status.State

Type:

cloudformationAttribute

attr_update_date_time

The date and time when the component type was last updated.

CloudformationAttribute:

UpdateDateTime

cfn_options

Options for this resource, such as condition, update policy etc.

cfn_resource_type

AWS resource type.

components

An object that maps strings to the components in the entity.

composite_components

Maps string to compositeComponent updates in the request.

creation_stack

return:

the stack trace of the point where this Resource was created from, sourced from the +metadata+ entry typed +aws:cdk:logicalId+, and with the bottom-most node +internal+ entries filtered.

description

The description of the entity.

entity_id

The ID of the entity.

entity_name

The entity name.

logical_id

The logical ID for this CloudFormation stack element.

The logical ID of the element is calculated from the path of the resource node in the construct tree.

To override this value, use overrideLogicalId(newLogicalId).

Returns:

the logical ID as a stringified token. This value will only get resolved during synthesis.

node

The tree node.

parent_entity_id

The ID of the parent entity.

ref

Return a string that will be resolved to a CloudFormation { Ref } for this element.

If, by any chance, the intrinsic reference of a resource is not a string, you could coerce it to an IResolvable through Lazy.any({ produce: resource.ref }).

stack

The stack in which this element is defined.

CfnElements must be defined within a stack scope (directly or indirectly).

tags

Tag Manager which manages the tags for this resource.

tags_raw

Metadata that you can use to manage the entity.

workspace_id

The ID of the workspace that contains the entity.

Static Methods

classmethod is_cfn_element(x)

Returns true if a construct is a stack element (i.e. part of the synthesized cloudformation template).

Uses duck-typing instead of instanceof to allow stack elements from different versions of this library to be included in the same stack.

Parameters:

x (Any) –

Return type:

bool

Returns:

The construct as a stack element or undefined if it is not a stack element.

classmethod is_cfn_resource(x)

Check whether the given object is a CfnResource.

Parameters:

x (Any) –

Return type:

bool

classmethod is_construct(x)

Checks if x is a construct.

Use this method instead of instanceof to properly detect Construct instances, even when the construct library is symlinked.

Explanation: in JavaScript, multiple copies of the constructs library on disk are seen as independent, completely different libraries. As a consequence, the class Construct in each copy of the constructs library is seen as a different class, and an instance of one class will not test as instanceof the other class. npm install will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the constructs library can be accidentally installed, and instanceof will behave unpredictably. It is safest to avoid using instanceof, and using this type-testing method instead.

Parameters:

x (Any) – Any object.

Return type:

bool

Returns:

true if x is an object created from a class which extends Construct.

ComponentProperty

class CfnEntity.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 import aws_iottwinmaker as iottwinmaker

# data_value_property_: iottwinmaker.CfnEntity.DataValueProperty
# definition: Any
# error: Any
# relationship_value: Any

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

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 CfnEntity.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 import aws_iottwinmaker as iottwinmaker

# data_value_property_: iottwinmaker.CfnEntity.DataValueProperty
# definition: Any
# error: Any
# relationship_value: Any

composite_component_property = iottwinmaker.CfnEntity.CompositeComponentProperty(
    component_name="componentName",
    component_path="componentPath",
    component_type_id="componentTypeId",
    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"
    )
)

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

DataTypeProperty

class CfnEntity.DataTypeProperty(*, allowed_values=None, nested_type=None, relationship=None, type=None, unit_of_measure=None)

Bases: object

The entity data type.

Parameters:
See:

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

# data_type_property_: iottwinmaker.CfnEntity.DataTypeProperty
# data_value_property_: iottwinmaker.CfnEntity.DataValueProperty
# relationship_value: Any

data_type_property = iottwinmaker.CfnEntity.DataTypeProperty(
    allowed_values=[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"
    )],
    nested_type=data_type_property_,
    relationship=iottwinmaker.CfnEntity.RelationshipProperty(
        relationship_type="relationshipType",
        target_component_type_id="targetComponentTypeId"
    ),
    type="type",
    unit_of_measure="unitOfMeasure"
)

Attributes

allowed_values

The allowed values.

See:

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

nested_type

The nested type.

See:

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

relationship

The relationship.

See:

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

type

The entity type.

See:

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

unit_of_measure

The unit of measure.

See:

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

DataValueProperty

class CfnEntity.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 import aws_iottwinmaker as iottwinmaker

# data_value_property_: iottwinmaker.CfnEntity.DataValueProperty
# relationship_value: Any

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

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

DefinitionProperty

class CfnEntity.DefinitionProperty(*, configuration=None, data_type=None, default_value=None, is_external_id=None, is_final=None, is_imported=None, is_inherited=None, is_required_in_entity=None, is_stored_externally=None, is_time_series=None)

Bases: object

The entity definition.

Parameters:

  • configuration (Union[IResolvable, Mapping[str, str], None]) – The configuration.

  • data_type (Union[IResolvable, DataTypeProperty, Dict[str, Any], None]) – The data type.

  • default_value (Union[IResolvable, DataValueProperty, Dict[str, Any], None]) – The default value.

  • is_external_id (Union[bool, IResolvable, None]) – Displays if the entity has a external Id.

  • is_final (Union[bool, IResolvable, None]) – Displays if the entity is final.

  • is_imported (Union[bool, IResolvable, None]) – Displays if the entity is imported.

  • is_inherited (Union[bool, IResolvable, None]) – Displays if the entity is inherited.

  • is_required_in_entity (Union[bool, IResolvable, None]) – Displays if the entity is a required entity.

  • is_stored_externally (Union[bool, IResolvable, None]) – Displays if the entity is tored externally.

  • is_time_series (Union[bool, IResolvable, None]) – Displays if the entity.

See:

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

# data_type_property_: iottwinmaker.CfnEntity.DataTypeProperty
# data_value_property_: iottwinmaker.CfnEntity.DataValueProperty
# relationship_value: Any

definition_property = iottwinmaker.CfnEntity.DefinitionProperty(
    configuration={
        "configuration_key": "configuration"
    },
    data_type=iottwinmaker.CfnEntity.DataTypeProperty(
        allowed_values=[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"
        )],
        nested_type=data_type_property_,
        relationship=iottwinmaker.CfnEntity.RelationshipProperty(
            relationship_type="relationshipType",
            target_component_type_id="targetComponentTypeId"
        ),
        type="type",
        unit_of_measure="unitOfMeasure"
    ),
    default_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"
    ),
    is_external_id=False,
    is_final=False,
    is_imported=False,
    is_inherited=False,
    is_required_in_entity=False,
    is_stored_externally=False,
    is_time_series=False
)

Attributes

configuration

The configuration.

See:

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

data_type

The data type.

See:

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

default_value

The default value.

See:

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

is_external_id

Displays if the entity has a external Id.

See:

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

is_final

Displays if the entity is final.

See:

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

is_imported

Displays if the entity is imported.

See:

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

is_inherited

Displays if the entity is inherited.

See:

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

is_required_in_entity

Displays if the entity is a required entity.

See:

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

is_stored_externally

Displays if the entity is tored externally.

See:

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

is_time_series

Displays if the entity.

See:

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

ErrorProperty

class CfnEntity.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 import aws_iottwinmaker as iottwinmaker

error_property = iottwinmaker.CfnEntity.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 CfnEntity.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 import aws_iottwinmaker as iottwinmaker

property_group_property = iottwinmaker.CfnEntity.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 CfnEntity.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 import aws_iottwinmaker as iottwinmaker

# data_value_property_: iottwinmaker.CfnEntity.DataValueProperty
# definition: Any
# relationship_value: Any

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

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

RelationshipProperty

class CfnEntity.RelationshipProperty(*, relationship_type=None, target_component_type_id=None)

Bases: object

The entity relationship.

Parameters:

  • relationship_type (Optional[str]) – The relationship type.

  • target_component_type_id (Optional[str]) – the component type Id target.

See:

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

relationship_property = iottwinmaker.CfnEntity.RelationshipProperty(
    relationship_type="relationshipType",
    target_component_type_id="targetComponentTypeId"
)

Attributes

relationship_type

The relationship type.

See:

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

target_component_type_id

the component type Id target.

See:

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

RelationshipValueProperty

class CfnEntity.RelationshipValueProperty(*, target_component_name=None, target_entity_id=None)

Bases: object

The entity relationship.

Parameters:

  • target_component_name (Optional[str]) – The target component name.

  • target_entity_id (Optional[str]) – The target entity Id.

See:

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

relationship_value_property = iottwinmaker.CfnEntity.RelationshipValueProperty(
    target_component_name="targetComponentName",
    target_entity_id="targetEntityId"
)

Attributes

target_component_name

The target component name.

See:

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

target_entity_id

The target entity Id.

See:

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

StatusProperty

class CfnEntity.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 import aws_iottwinmaker as iottwinmaker

# error: Any

status_property = iottwinmaker.CfnEntity.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