CfnComponentType
- class aws_cdk.aws_iottwinmaker.CfnComponentType(scope, id, *, component_type_id, workspace_id, composite_component_types=None, description=None, extends_from=None, functions=None, is_singleton=None, property_definitions=None, property_groups=None, tags=None)
Bases:
CfnResource
Use the
AWS::IoTTwinMaker::ComponentType
resource to declare a component type.- See:
- CloudformationResource:
AWS::IoTTwinMaker::ComponentType
- 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.CfnComponentType.DataTypeProperty # data_value_property_: iottwinmaker.CfnComponentType.DataValueProperty # relationship_value: Any cfn_component_type = iottwinmaker.CfnComponentType(self, "MyCfnComponentType", component_type_id="componentTypeId", workspace_id="workspaceId", # the properties below are optional composite_component_types={ "composite_component_types_key": iottwinmaker.CfnComponentType.CompositeComponentTypeProperty( component_type_id="componentTypeId" ) }, 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 ) }, property_groups={ "property_groups_key": iottwinmaker.CfnComponentType.PropertyGroupProperty( group_type="groupType", property_names=["propertyNames"] ) }, 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).component_type_id (
str
) – The ID of the component type.workspace_id (
str
) – The ID of the workspace that contains the component type.composite_component_types (
Union
[IResolvable
,Mapping
[str
,Union
[IResolvable
,CompositeComponentTypeProperty
,Dict
[str
,Any
]]],None
]) – Maps strings tocompositeComponentTypes
of thecomponentType
.CompositeComponentType
is referenced bycomponentTypeId
.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
[IResolvable
,Mapping
[str
,Union
[IResolvable
,FunctionProperty
,Dict
[str
,Any
]]],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.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.tags (
Optional
[Mapping
[str
,str
]]) – The ComponentType tags.
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 prefixpath
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 toaddOverride
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: truedefault (
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:
- 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:
- 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:
target (
CfnResource
) – The dependency to replace.new_target (
CfnResource
) – The new dependency to add.
- 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::ComponentType'
- attr_arn
The ARN of the component type.
- CloudformationAttribute:
Arn
- attr_creation_date_time
The date and time when the component type was created.
- CloudformationAttribute:
CreationDateTime
- attr_is_abstract
A boolean value that specifies whether the component type is abstract.
- CloudformationAttribute:
IsAbstract
- attr_is_schema_initialized
A boolean value that specifies whether the component type has a schema initializer and that the schema initializer has run.
- CloudformationAttribute:
IsSchemaInitialized
- 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 component type the update time.
- CloudformationAttribute:
UpdateDateTime
- cfn_options
Options for this resource, such as condition, update policy etc.
- cfn_resource_type
AWS resource type.
- component_type_id
The ID of the component type.
- composite_component_types
Maps strings to
compositeComponentTypes
of thecomponentType
.
- 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 component type.
- extends_from
The name of the parent component type that this component type extends.
- functions
An object that maps strings to the functions in the component type.
- is_singleton
A boolean value that specifies whether an entity can have more than one component of this type.
- 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.
- property_definitions
An object that maps strings to the property definitions in the component type.
- property_groups
An object that maps strings to the property groups in the component type.
- 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
The ComponentType tags.
- workspace_id
The ID of the workspace that contains the component type.
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 detectConstruct
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 classConstruct
in each copy of theconstructs
library is seen as a different class, and an instance of one class will not test asinstanceof
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 theconstructs
library can be accidentally installed, andinstanceof
will behave unpredictably. It is safest to avoid usinginstanceof
, 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 extendsConstruct
.
CompositeComponentTypeProperty
- class CfnComponentType.CompositeComponentTypeProperty(*, component_type_id=None)
Bases:
object
Specifies the ID of the composite component type.
- Parameters:
component_type_id (
Optional
[str
]) – The ID of the component type.- See:
- 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 composite_component_type_property = iottwinmaker.CfnComponentType.CompositeComponentTypeProperty( component_type_id="componentTypeId" )
Attributes
- component_type_id
The ID of the component type.
DataConnectorProperty
- class CfnComponentType.DataConnectorProperty(*, is_native=None, lambda_=None)
Bases:
object
The data connector.
- Parameters:
is_native (
Union
[bool
,IResolvable
,None
]) – A boolean value that specifies whether the data connector is native to IoT TwinMaker.lambda – The Lambda function associated with the data connector.
- See:
- 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_connector_property = iottwinmaker.CfnComponentType.DataConnectorProperty( is_native=False, lambda_=iottwinmaker.CfnComponentType.LambdaFunctionProperty( arn="arn" ) )
Attributes
- is_native
A boolean value that specifies whether the data connector is native to IoT TwinMaker.
- lambda_
The Lambda function associated with the data connector.
DataTypeProperty
- class CfnComponentType.DataTypeProperty(*, type, allowed_values=None, nested_type=None, relationship=None, unit_of_measure=None)
Bases:
object
An object that specifies the data type of a property.
- Parameters:
type (
str
) – The underlying type of the data type. Valid Values:RELATIONSHIP | STRING | LONG | BOOLEAN | INTEGER | DOUBLE | LIST | MAP
allowed_values (
Union
[IResolvable
,Sequence
[Union
[IResolvable
,DataValueProperty
,Dict
[str
,Any
]]],None
]) – The allowed values for this data type.nested_type (
Union
[IResolvable
,DataTypeProperty
,Dict
[str
,Any
],None
]) – The nested type in the data type.relationship (
Union
[IResolvable
,RelationshipProperty
,Dict
[str
,Any
],None
]) – A relationship that associates a component with another component.unit_of_measure (
Optional
[str
]) – The unit of measure used in this data type.
- See:
- 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.CfnComponentType.DataTypeProperty # data_value_property_: iottwinmaker.CfnComponentType.DataValueProperty # relationship_value: Any data_type_property = 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" )
Attributes
- allowed_values
The allowed values for this data type.
- nested_type
The nested type in the data type.
- relationship
A relationship that associates a component with another component.
- type
The underlying type of the data type.
Valid Values:
RELATIONSHIP | STRING | LONG | BOOLEAN | INTEGER | DOUBLE | LIST | MAP
- unit_of_measure
The unit of measure used in this data type.
DataValueProperty
- class CfnComponentType.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 multipleDataValue
objects.relationship_value (
Any
) – A value that relates a component to another component.string_value (
Optional
[str
]) – A string value.
- See:
- 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.CfnComponentType.DataValueProperty # relationship_value: Any data_value_property = 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" )
Attributes
- boolean_value
A boolean value.
- double_value
A double value.
- expression
An expression that produces the value.
- integer_value
An integer value.
- list_value
A list of multiple values.
- long_value
A long value.
- map_value
An object that maps strings to multiple
DataValue
objects.
- relationship_value
A value that relates a component to another component.
ErrorProperty
- class CfnComponentType.ErrorProperty(*, code=None, message=None)
Bases:
object
The component type error.
- Parameters:
code (
Optional
[str
]) – The component type error code.message (
Optional
[str
]) – The component type error message.
- See:
- 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.CfnComponentType.ErrorProperty( code="code", message="message" )
Attributes
- code
The component type error code.
- message
The component type error message.
FunctionProperty
- class CfnComponentType.FunctionProperty(*, implemented_by=None, required_properties=None, scope=None)
Bases:
object
The function body.
- Parameters:
implemented_by (
Union
[IResolvable
,DataConnectorProperty
,Dict
[str
,Any
],None
]) – The data connector.required_properties (
Optional
[Sequence
[str
]]) – The required properties of the function.scope (
Optional
[str
]) – The scope of the function.
- See:
- 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 function_property = iottwinmaker.CfnComponentType.FunctionProperty( implemented_by=iottwinmaker.CfnComponentType.DataConnectorProperty( is_native=False, lambda_=iottwinmaker.CfnComponentType.LambdaFunctionProperty( arn="arn" ) ), required_properties=["requiredProperties"], scope="scope" )
Attributes
- implemented_by
The data connector.
- required_properties
The required properties of the function.
LambdaFunctionProperty
- class CfnComponentType.LambdaFunctionProperty(*, arn)
Bases:
object
The Lambda function.
- Parameters:
arn (
str
) – The Lambda function ARN.- See:
- 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 lambda_function_property = iottwinmaker.CfnComponentType.LambdaFunctionProperty( arn="arn" )
Attributes
PropertyDefinitionProperty
- class CfnComponentType.PropertyDefinitionProperty(*, configurations=None, data_type=None, default_value=None, is_external_id=None, is_required_in_entity=None, is_stored_externally=None, is_time_series=None)
Bases:
object
PropertyDefinition is an object that maps strings to the property definitions in the component type.
- Parameters:
configurations (
Union
[IResolvable
,Mapping
[str
,str
],None
]) – A mapping that specifies configuration information about the property.data_type (
Union
[IResolvable
,DataTypeProperty
,Dict
[str
,Any
],None
]) – An object that specifies the data type of a property.default_value (
Union
[IResolvable
,DataValueProperty
,Dict
[str
,Any
],None
]) – A boolean value that specifies whether the property ID comes from an external data store.is_external_id (
Union
[bool
,IResolvable
,None
]) – A Boolean value that specifies whether the property ID comes from an external data source.is_required_in_entity (
Union
[bool
,IResolvable
,None
]) – A boolean value that specifies whether the property is required in an entity.is_stored_externally (
Union
[bool
,IResolvable
,None
]) – A boolean value that specifies whether the property is stored externally.is_time_series (
Union
[bool
,IResolvable
,None
]) – A boolean value that specifies whether the property consists of time series data.
- See:
- 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.CfnComponentType.DataTypeProperty # data_value_property_: iottwinmaker.CfnComponentType.DataValueProperty # relationship_value: Any property_definition_property = 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 )
Attributes
- configurations
A mapping that specifies configuration information about the property.
- data_type
An object that specifies the data type of a property.
- default_value
A boolean value that specifies whether the property ID comes from an external data store.
- is_external_id
A Boolean value that specifies whether the property ID comes from an external data source.
- is_required_in_entity
A boolean value that specifies whether the property is required in an entity.
- is_stored_externally
A boolean value that specifies whether the property is stored externally.
- is_time_series
A boolean value that specifies whether the property consists of time series data.
PropertyGroupProperty
- class CfnComponentType.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:
- 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.CfnComponentType.PropertyGroupProperty( group_type="groupType", property_names=["propertyNames"] )
Attributes
- group_type
The group type.
RelationshipProperty
- class CfnComponentType.RelationshipProperty(*, relationship_type=None, target_component_type_id=None)
Bases:
object
An object that specifies a relationship with another component type.
- Parameters:
relationship_type (
Optional
[str
]) – The type of the relationship.target_component_type_id (
Optional
[str
]) – The ID of the target component type associated with this relationship.
- See:
- 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.CfnComponentType.RelationshipProperty( relationship_type="relationshipType", target_component_type_id="targetComponentTypeId" )
Attributes
- relationship_type
The type of the relationship.
- target_component_type_id
The ID of the target component type associated with this relationship.
RelationshipValueProperty
- class CfnComponentType.RelationshipValueProperty(*, target_component_name=None, target_entity_id=None)
Bases:
object
The component type relationship value.
- Parameters:
target_component_name (
Optional
[str
]) – The target component name.target_entity_id (
Optional
[str
]) – The target entity Id.
- See:
- 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.CfnComponentType.RelationshipValueProperty( target_component_name="targetComponentName", target_entity_id="targetEntityId" )
Attributes
- target_component_name
The target component name.
StatusProperty
- class CfnComponentType.StatusProperty(*, error=None, state=None)
Bases:
object
The component type status.
- Parameters:
error (
Union
[IResolvable
,ErrorProperty
,Dict
[str
,Any
],None
]) – The component type error.state (
Optional
[str
]) – The component type status state.
- See:
- 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 status_property = iottwinmaker.CfnComponentType.StatusProperty( error=iottwinmaker.CfnComponentType.ErrorProperty( code="code", message="message" ), state="state" )
Attributes
- error
The component type error.
- state
The component type status state.