Class: Aws::IoTTwinMaker::Types::CreateComponentTypeRequest

Inherits:
Struct
  • Object
show all
Includes:
Structure
Defined in:
lib/aws-sdk-iottwinmaker/types.rb

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#component_type_id ⇒ String

The ID of the component type.

Returns:

  • (String) 


602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
 
# File 'lib/aws-sdk-iottwinmaker/types.rb', line 602

class CreateComponentTypeRequest < Struct.new(
  :workspace_id,
  :is_singleton,
  :component_type_id,
  :description,
  :property_definitions,
  :extends_from,
  :functions,
  :tags,
  :property_groups,
  :component_type_name,
  :composite_component_types)
  SENSITIVE = []
  include Aws::Structure
end

#component_type_name ⇒ String

A friendly name for the component type.

Returns:

  • (String) 


602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
 
# File 'lib/aws-sdk-iottwinmaker/types.rb', line 602

class CreateComponentTypeRequest < Struct.new(
  :workspace_id,
  :is_singleton,
  :component_type_id,
  :description,
  :property_definitions,
  :extends_from,
  :functions,
  :tags,
  :property_groups,
  :component_type_name,
  :composite_component_types)
  SENSITIVE = []
  include Aws::Structure
end

#composite_component_types ⇒ Hash<String,Types::CompositeComponentTypeRequest>

This is an object that maps strings to ‘compositeComponentTypes` of the `componentType`. `CompositeComponentType` is referenced by `componentTypeId`.

Returns:



602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
 
# File 'lib/aws-sdk-iottwinmaker/types.rb', line 602

class CreateComponentTypeRequest < Struct.new(
  :workspace_id,
  :is_singleton,
  :component_type_id,
  :description,
  :property_definitions,
  :extends_from,
  :functions,
  :tags,
  :property_groups,
  :component_type_name,
  :composite_component_types)
  SENSITIVE = []
  include Aws::Structure
end

#description ⇒ String

The description of the component type.

Returns:

  • (String) 


602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
 
# File 'lib/aws-sdk-iottwinmaker/types.rb', line 602

class CreateComponentTypeRequest < Struct.new(
  :workspace_id,
  :is_singleton,
  :component_type_id,
  :description,
  :property_definitions,
  :extends_from,
  :functions,
  :tags,
  :property_groups,
  :component_type_name,
  :composite_component_types)
  SENSITIVE = []
  include Aws::Structure
end

#extends_from ⇒ Array<String>

Specifies the parent component type to extend.

Returns:

  • (Array<String>) 


602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
 
# File 'lib/aws-sdk-iottwinmaker/types.rb', line 602

class CreateComponentTypeRequest < Struct.new(
  :workspace_id,
  :is_singleton,
  :component_type_id,
  :description,
  :property_definitions,
  :extends_from,
  :functions,
  :tags,
  :property_groups,
  :component_type_name,
  :composite_component_types)
  SENSITIVE = []
  include Aws::Structure
end

#functions ⇒ Hash<String,Types::FunctionRequest>

An object that maps strings to the functions in the component type. Each string in the mapping must be unique to this object.

Returns:



602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
 
# File 'lib/aws-sdk-iottwinmaker/types.rb', line 602

class CreateComponentTypeRequest < Struct.new(
  :workspace_id,
  :is_singleton,
  :component_type_id,
  :description,
  :property_definitions,
  :extends_from,
  :functions,
  :tags,
  :property_groups,
  :component_type_name,
  :composite_component_types)
  SENSITIVE = []
  include Aws::Structure
end

#is_singleton ⇒ Boolean

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

Returns:

  • (Boolean) 


602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
 
# File 'lib/aws-sdk-iottwinmaker/types.rb', line 602

class CreateComponentTypeRequest < Struct.new(
  :workspace_id,
  :is_singleton,
  :component_type_id,
  :description,
  :property_definitions,
  :extends_from,
  :functions,
  :tags,
  :property_groups,
  :component_type_name,
  :composite_component_types)
  SENSITIVE = []
  include Aws::Structure
end

#property_definitions ⇒ Hash<String,Types::PropertyDefinitionRequest>

An object that maps strings to the property definitions in the component type. Each string in the mapping must be unique to this object.

Returns:



602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
 
# File 'lib/aws-sdk-iottwinmaker/types.rb', line 602

class CreateComponentTypeRequest < Struct.new(
  :workspace_id,
  :is_singleton,
  :component_type_id,
  :description,
  :property_definitions,
  :extends_from,
  :functions,
  :tags,
  :property_groups,
  :component_type_name,
  :composite_component_types)
  SENSITIVE = []
  include Aws::Structure
end

#property_groups ⇒ Hash<String,Types::PropertyGroupRequest>

Returns:



602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
 
# File 'lib/aws-sdk-iottwinmaker/types.rb', line 602

class CreateComponentTypeRequest < Struct.new(
  :workspace_id,
  :is_singleton,
  :component_type_id,
  :description,
  :property_definitions,
  :extends_from,
  :functions,
  :tags,
  :property_groups,
  :component_type_name,
  :composite_component_types)
  SENSITIVE = []
  include Aws::Structure
end

#tags ⇒ Hash<String,String>

Metadata that you can use to manage the component type.

Returns:

  • (Hash<String,String>) 


602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
 
# File 'lib/aws-sdk-iottwinmaker/types.rb', line 602

class CreateComponentTypeRequest < Struct.new(
  :workspace_id,
  :is_singleton,
  :component_type_id,
  :description,
  :property_definitions,
  :extends_from,
  :functions,
  :tags,
  :property_groups,
  :component_type_name,
  :composite_component_types)
  SENSITIVE = []
  include Aws::Structure
end

#workspace_id ⇒ String

The ID of the workspace that contains the component type.

Returns:

  • (String) 


602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
 
# File 'lib/aws-sdk-iottwinmaker/types.rb', line 602

class CreateComponentTypeRequest < Struct.new(
  :workspace_id,
  :is_singleton,
  :component_type_id,
  :description,
  :property_definitions,
  :extends_from,
  :functions,
  :tags,
  :property_groups,
  :component_type_name,
  :composite_component_types)
  SENSITIVE = []
  include Aws::Structure
end