Class: AWSCDK::IoTTwinMaker::CfnEntityProps

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

Overview

Properties for defining a CfnEntity.

See Also:

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(entity_name:, workspace_id:, components: nil, composite_components: nil, description: nil, entity_id: nil, parent_entity_id: nil, tags: nil) ⇒ CfnEntityProps

Returns a new instance of CfnEntityProps.

Parameters:



17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
 
# File 'io_t_twin_maker/cfn_entity_props.rb', line 17

def initialize(entity_name:, workspace_id:, components: nil, composite_components: nil, description: nil, entity_id: nil, parent_entity_id: nil, tags: nil)
  @entity_name = entity_name
  Jsii::Type.check_type(@entity_name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "entityName")
  @workspace_id = workspace_id
  Jsii::Type.check_type(@workspace_id, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "workspaceId")
  @components = components
  Jsii::Type.check_type(@components, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImNvbGxlY3Rpb24iOnsiZWxlbWVudHR5cGUiOnsidW5pb24iOnsidHlwZXMiOlt7ImZxbiI6ImF3cy1jZGstbGliLklSZXNvbHZhYmxlIn0seyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfaW90dHdpbm1ha2VyLkNmbkVudGl0eS5Db21wb25lbnRQcm9wZXJ0eSJ9XX19LCJraW5kIjoibWFwIn19XX19")), "components") unless @components.nil?
  @composite_components = composite_components
  Jsii::Type.check_type(@composite_components, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImNvbGxlY3Rpb24iOnsiZWxlbWVudHR5cGUiOnsidW5pb24iOnsidHlwZXMiOlt7ImZxbiI6ImF3cy1jZGstbGliLklSZXNvbHZhYmxlIn0seyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfaW90dHdpbm1ha2VyLkNmbkVudGl0eS5Db21wb3NpdGVDb21wb25lbnRQcm9wZXJ0eSJ9XX19LCJraW5kIjoibWFwIn19XX19")), "compositeComponents") unless @composite_components.nil?
  @description = description
  Jsii::Type.check_type(@description, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "description") unless @description.nil?
  @entity_id = entity_id
  Jsii::Type.check_type(@entity_id, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "entityId") unless @entity_id.nil?
  @parent_entity_id = parent_entity_id
  Jsii::Type.check_type(@parent_entity_id, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "parentEntityId") unless @parent_entity_id.nil?
  @tags = tags
  Jsii::Type.check_type(@tags, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7InByaW1pdGl2ZSI6InN0cmluZyJ9LCJraW5kIjoibWFwIn19")), "tags") unless @tags.nil?
end

Instance Attribute Details

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

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.

Returns:

See Also:



54
55
56
 
# File 'io_t_twin_maker/cfn_entity_props.rb', line 54

def components
  @components
end

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

Maps string to compositeComponent updates in the request.

Each key of the map represents the component_path of the composite_component .

Returns:

See Also:



61
62
63
 
# File 'io_t_twin_maker/cfn_entity_props.rb', line 61

def composite_components
  @composite_components
end

#description ⇒ String? (readonly)

The description of the entity.

Returns:

  • (String, nil)

See Also:



66
67
68
 
# File 'io_t_twin_maker/cfn_entity_props.rb', line 66

def description
  @description
end

#entity_id ⇒ String? (readonly)

The ID of the entity.

Returns:

  • (String, nil)

See Also:



71
72
73
 
# File 'io_t_twin_maker/cfn_entity_props.rb', line 71

def entity_id
  @entity_id
end

#entity_name ⇒ String (readonly)

The entity name.

Returns:

  • (String)

See Also:



40
41
42
 
# File 'io_t_twin_maker/cfn_entity_props.rb', line 40

def entity_name
  @entity_name
end

#parent_entity_id ⇒ String? (readonly)

The ID of the parent entity.

Returns:

  • (String, nil)

See Also:



76
77
78
 
# File 'io_t_twin_maker/cfn_entity_props.rb', line 76

def parent_entity_id
  @parent_entity_id
end

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

Metadata that you can use to manage the entity.

Returns:

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

See Also:



81
82
83
 
# File 'io_t_twin_maker/cfn_entity_props.rb', line 81

def tags
  @tags
end

#workspace_id ⇒ String (readonly)

The ID of the workspace that contains the entity.

Returns:

  • (String)

See Also:



45
46
47
 
# File 'io_t_twin_maker/cfn_entity_props.rb', line 45

def workspace_id
  @workspace_id
end

Class Method Details

.jsii_properties ⇒ Object 



83
84
85
86
87
88
89
90
91
92
93
94
 
# File 'io_t_twin_maker/cfn_entity_props.rb', line 83

def self.jsii_properties
  {
    :entity_name => "entityName",
    :workspace_id => "workspaceId",
    :components => "components",
    :composite_components => "compositeComponents",
    :description => "description",
    :entity_id => "entityId",
    :parent_entity_id => "parentEntityId",
    :tags => "tags",
  }
end

Instance Method Details

#to_jsii ⇒ Object 



96
97
98
99
100
101
102
103
104
105
106
107
108
109
 
# File 'io_t_twin_maker/cfn_entity_props.rb', line 96

def to_jsii
  result = {}
  result.merge!({
    "entityName" => @entity_name,
    "workspaceId" => @workspace_id,
    "components" => @components,
    "compositeComponents" => @composite_components,
    "description" => @description,
    "entityId" => @entity_id,
    "parentEntityId" => @parent_entity_id,
    "tags" => @tags,
  })
  result.compact
end