Class: AWSCDK::IoTTwinMaker::CfnComponentTypeProps

Inherits:
Jsii::Struct
  • Object
show all
Defined in:
io_t_twin_maker/cfn_component_type_props.rb

Overview

Properties for defining a CfnComponentType.

See Also:

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(component_type_id:, workspace_id:, composite_component_types: nil, description: nil, extends_from: nil, functions: nil, is_singleton: nil, property_definitions: nil, property_groups: nil, tags: nil) ⇒ CfnComponentTypeProps

Returns a new instance of CfnComponentTypeProps.

Parameters:



19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
 
# File 'io_t_twin_maker/cfn_component_type_props.rb', line 19

def initialize(component_type_id:, workspace_id:, composite_component_types: nil, description: nil, extends_from: nil, functions: nil, is_singleton: nil, property_definitions: nil, property_groups: nil, tags: nil)
  @component_type_id = component_type_id
  Jsii::Type.check_type(@component_type_id, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "componentTypeId")
  @workspace_id = workspace_id
  Jsii::Type.check_type(@workspace_id, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "workspaceId")
  @composite_component_types = composite_component_types
  Jsii::Type.check_type(@composite_component_types, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImNvbGxlY3Rpb24iOnsiZWxlbWVudHR5cGUiOnsidW5pb24iOnsidHlwZXMiOlt7ImZxbiI6ImF3cy1jZGstbGliLklSZXNvbHZhYmxlIn0seyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfaW90dHdpbm1ha2VyLkNmbkNvbXBvbmVudFR5cGUuQ29tcG9zaXRlQ29tcG9uZW50VHlwZVByb3BlcnR5In1dfX0sImtpbmQiOiJtYXAifX1dfX0=")), "compositeComponentTypes") unless @composite_component_types.nil?
  @description = description
  Jsii::Type.check_type(@description, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "description") unless @description.nil?
  @extends_from = extends_from
  Jsii::Type.check_type(@extends_from, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7InByaW1pdGl2ZSI6InN0cmluZyJ9LCJraW5kIjoiYXJyYXkifX0=")), "extendsFrom") unless @extends_from.nil?
  @functions = functions
  Jsii::Type.check_type(@functions, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImNvbGxlY3Rpb24iOnsiZWxlbWVudHR5cGUiOnsidW5pb24iOnsidHlwZXMiOlt7ImZxbiI6ImF3cy1jZGstbGliLklSZXNvbHZhYmxlIn0seyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfaW90dHdpbm1ha2VyLkNmbkNvbXBvbmVudFR5cGUuRnVuY3Rpb25Qcm9wZXJ0eSJ9XX19LCJraW5kIjoibWFwIn19XX19")), "functions") unless @functions.nil?
  @is_singleton = is_singleton
  Jsii::Type.check_type(@is_singleton, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3sicHJpbWl0aXZlIjoiYm9vbGVhbiJ9LHsiZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifV19fQ==")), "isSingleton") unless @is_singleton.nil?
  @property_definitions = property_definitions
  Jsii::Type.check_type(@property_definitions, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImNvbGxlY3Rpb24iOnsiZWxlbWVudHR5cGUiOnsidW5pb24iOnsidHlwZXMiOlt7ImZxbiI6ImF3cy1jZGstbGliLklSZXNvbHZhYmxlIn0seyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfaW90dHdpbm1ha2VyLkNmbkNvbXBvbmVudFR5cGUuUHJvcGVydHlEZWZpbml0aW9uUHJvcGVydHkifV19fSwia2luZCI6Im1hcCJ9fV19fQ==")), "propertyDefinitions") unless @property_definitions.nil?
  @property_groups = property_groups
  Jsii::Type.check_type(@property_groups, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImNvbGxlY3Rpb24iOnsiZWxlbWVudHR5cGUiOnsidW5pb24iOnsidHlwZXMiOlt7ImZxbiI6ImF3cy1jZGstbGliLklSZXNvbHZhYmxlIn0seyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfaW90dHdpbm1ha2VyLkNmbkNvbXBvbmVudFR5cGUuUHJvcGVydHlHcm91cFByb3BlcnR5In1dfX0sImtpbmQiOiJtYXAifX1dfX0=")), "propertyGroups") unless @property_groups.nil?
  @tags = tags
  Jsii::Type.check_type(@tags, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7InByaW1pdGl2ZSI6InN0cmluZyJ9LCJraW5kIjoibWFwIn19")), "tags") unless @tags.nil?
end

Instance Attribute Details

#component_type_id ⇒ String (readonly)

The ID of the component type.

Returns:

  • (String)

See Also:



46
47
48
 
# File 'io_t_twin_maker/cfn_component_type_props.rb', line 46

def component_type_id
  @component_type_id
end

#composite_component_types ⇒ AWSCDK::IResolvable, ... (readonly)

Maps strings to compositeComponentTypes of the componentType .

CompositeComponentType is referenced by component_type_id .

Returns:

See Also:



58
59
60
 
# File 'io_t_twin_maker/cfn_component_type_props.rb', line 58

def composite_component_types
  @composite_component_types
end

#description ⇒ String? (readonly)

The description of the component type.

Returns:

  • (String, nil)

See Also:



63
64
65
 
# File 'io_t_twin_maker/cfn_component_type_props.rb', line 63

def description
  @description
end

#extends_from ⇒ Array<String>? (readonly)

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

Returns:

  • (Array<String>, nil)

See Also:



68
69
70
 
# File 'io_t_twin_maker/cfn_component_type_props.rb', line 68

def extends_from
  @extends_from
end

#functions ⇒ AWSCDK::IResolvable, ... (readonly)

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.

Returns:

See Also:



77
78
79
 
# File 'io_t_twin_maker/cfn_component_type_props.rb', line 77

def functions
  @functions
end

#is_singleton ⇒ Boolean, ... (readonly)

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

Returns:

See Also:



82
83
84
 
# File 'io_t_twin_maker/cfn_component_type_props.rb', line 82

def is_singleton
  @is_singleton
end

#property_definitions ⇒ AWSCDK::IResolvable, ... (readonly)

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.

Returns:

See Also:



91
92
93
 
# File 'io_t_twin_maker/cfn_component_type_props.rb', line 91

def property_definitions
  @property_definitions
end

#property_groups ⇒ AWSCDK::IResolvable, ... (readonly)

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

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

Returns:

See Also:



98
99
100
 
# File 'io_t_twin_maker/cfn_component_type_props.rb', line 98

def property_groups
  @property_groups
end

#tags ⇒ Hash{String => String}? (readonly)

The ComponentType tags.

Returns:

  • (Hash{String => String}, nil)

See Also:



103
104
105
 
# File 'io_t_twin_maker/cfn_component_type_props.rb', line 103

def tags
  @tags
end

#workspace_id ⇒ String (readonly)

The ID of the workspace that contains the component type.

Returns:

  • (String)

See Also:



51
52
53
 
# File 'io_t_twin_maker/cfn_component_type_props.rb', line 51

def workspace_id
  @workspace_id
end

Class Method Details

.jsii_properties ⇒ Object 



105
106
107
108
109
110
111
112
113
114
115
116
117
118
 
# File 'io_t_twin_maker/cfn_component_type_props.rb', line 105

def self.jsii_properties
  {
    :component_type_id => "componentTypeId",
    :workspace_id => "workspaceId",
    :composite_component_types => "compositeComponentTypes",
    :description => "description",
    :extends_from => "extendsFrom",
    :functions => "functions",
    :is_singleton => "isSingleton",
    :property_definitions => "propertyDefinitions",
    :property_groups => "propertyGroups",
    :tags => "tags",
  }
end

Instance Method Details

#to_jsii ⇒ Object 



120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
 
# File 'io_t_twin_maker/cfn_component_type_props.rb', line 120

def to_jsii
  result = {}
  result.merge!({
    "componentTypeId" => @component_type_id,
    "workspaceId" => @workspace_id,
    "compositeComponentTypes" => @composite_component_types,
    "description" => @description,
    "extendsFrom" => @extends_from,
    "functions" => @functions,
    "isSingleton" => @is_singleton,
    "propertyDefinitions" => @property_definitions,
    "propertyGroups" => @property_groups,
    "tags" => @tags,
  })
  result.compact
end