CfnComponentTypeProps

class aws_cdk.aws_iottwinmaker.CfnComponentTypeProps(*, component_type_id, workspace_id, description=None, extends_from=None, functions=None, is_singleton=None, property_definitions=None, tags=None)

Bases: object

Properties for defining a CfnComponentType.

Parameters
  • component_type_id (str) – The ID of the component type.

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

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

  • extends_from (Optional[Sequence[str]]) – The name of the parent component type that this component type extends.

  • functions (Union[Mapping[str, Union[IResolvable, FunctionProperty, Dict[str, Any]]], IResolvable, None]) – An object that maps strings to the functions in the component type. Each string in the mapping must be unique to this object. For information on the FunctionResponse object see the FunctionResponse API reference.

  • is_singleton (Union[bool, IResolvable, None]) – A boolean value that specifies whether an entity can have more than one component of this type.

  • property_definitions (Union[IResolvable, Mapping[str, Union[IResolvable, PropertyDefinitionProperty, Dict[str, Any]]], None]) – An object that maps strings to the property definitions in the component type. Each string in the mapping must be unique to this object. For information about the PropertyDefinitionResponse object, see the PropertyDefinitionResponse API reference.

  • tags (Optional[Mapping[str, str]]) – The ComponentType tags.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iottwinmaker-componenttype.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_type_property_: iottwinmaker.CfnComponentType.DataTypeProperty
# data_value_property_: iottwinmaker.CfnComponentType.DataValueProperty
# relationship_value: Any

cfn_component_type_props = iottwinmaker.CfnComponentTypeProps(
    component_type_id="componentTypeId",
    workspace_id="workspaceId",

    # the properties below are optional
    description="description",
    extends_from=["extendsFrom"],
    functions={
        "functions_key": iottwinmaker.CfnComponentType.FunctionProperty(
            implemented_by=iottwinmaker.CfnComponentType.DataConnectorProperty(
                is_native=False,
                lambda_=iottwinmaker.CfnComponentType.LambdaFunctionProperty(
                    arn="arn"
                )
            ),
            required_properties=["requiredProperties"],
            scope="scope"
        )
    },
    is_singleton=False,
    property_definitions={
        "property_definitions_key": iottwinmaker.CfnComponentType.PropertyDefinitionProperty(
            configurations={
                "configurations_key": "configurations"
            },
            data_type=iottwinmaker.CfnComponentType.DataTypeProperty(
                type="type",

                # the properties below are optional
                allowed_values=[iottwinmaker.CfnComponentType.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.CfnComponentType.RelationshipProperty(
                    relationship_type="relationshipType",
                    target_component_type_id="targetComponentTypeId"
                ),
                unit_of_measure="unitOfMeasure"
            ),
            default_value=iottwinmaker.CfnComponentType.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_required_in_entity=False,
            is_stored_externally=False,
            is_time_series=False
        )
    },
    tags={
        "tags_key": "tags"
    }
)

Attributes

component_type_id

The ID of the component type.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iottwinmaker-componenttype.html#cfn-iottwinmaker-componenttype-componenttypeid

Return type

str

description

The description of the component type.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iottwinmaker-componenttype.html#cfn-iottwinmaker-componenttype-description

Return type

Optional[str]

extends_from

The name of the parent component type that this component type extends.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iottwinmaker-componenttype.html#cfn-iottwinmaker-componenttype-extendsfrom

Return type

Optional[List[str]]

functions

An object that maps strings to the functions in the component type.

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

For information on the FunctionResponse object see the FunctionResponse API reference.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iottwinmaker-componenttype.html#cfn-iottwinmaker-componenttype-functions

Return type

Union[Mapping[str, Union[IResolvable, FunctionProperty]], IResolvable, None]

is_singleton

A boolean value that specifies whether an entity can have more than one component of this type.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iottwinmaker-componenttype.html#cfn-iottwinmaker-componenttype-issingleton

Return type

Union[bool, IResolvable, None]

property_definitions

An object that maps strings to the property definitions in the component type.

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

For information about the PropertyDefinitionResponse object, see the PropertyDefinitionResponse API reference.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iottwinmaker-componenttype.html#cfn-iottwinmaker-componenttype-propertydefinitions

Return type

Union[IResolvable, Mapping[str, Union[IResolvable, PropertyDefinitionProperty]], None]

tags

The ComponentType tags.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iottwinmaker-componenttype.html#cfn-iottwinmaker-componenttype-tags

Return type

Optional[Mapping[str, str]]

workspace_id

The ID of the workspace.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iottwinmaker-componenttype.html#cfn-iottwinmaker-componenttype-workspaceid

Return type

str