Class: AWSCDK::IoTTwinMaker::CfnSceneProps

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

Overview

Properties for defining a CfnScene.

See Also:

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(content_location:, scene_id:, workspace_id:, capabilities: nil, description: nil, scene_metadata: nil, tags: nil) ⇒ CfnSceneProps

Returns a new instance of CfnSceneProps.

Parameters:

  • content_location (String) —

    The relative path that specifies the location of the content definition file.

  • scene_id (String) —

    The ID of the scene.

  • workspace_id (String) —

    The ID of the workspace.

  • capabilities (Array<String>, nil) (defaults to: nil) —

    A list of capabilities that the scene uses to render.

  • description (String, nil) (defaults to: nil) —

    The description of this scene.

  • scene_metadata (AWSCDK::IResolvable, Hash{String => String}, nil) (defaults to: nil) —

    The scene metadata.

  • tags (Hash{String => String}, nil) (defaults to: nil) —

    The ComponentType tags.



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

def initialize(content_location:, scene_id:, workspace_id:, capabilities: nil, description: nil, scene_metadata: nil, tags: nil)
  @content_location = content_location
  Jsii::Type.check_type(@content_location, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "contentLocation")
  @scene_id = scene_id
  Jsii::Type.check_type(@scene_id, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "sceneId")
  @workspace_id = workspace_id
  Jsii::Type.check_type(@workspace_id, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "workspaceId")
  @capabilities = capabilities
  Jsii::Type.check_type(@capabilities, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7InByaW1pdGl2ZSI6InN0cmluZyJ9LCJraW5kIjoiYXJyYXkifX0=")), "capabilities") unless @capabilities.nil?
  @description = description
  Jsii::Type.check_type(@description, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "description") unless @description.nil?
  @scene_metadata = scene_metadata
  Jsii::Type.check_type(@scene_metadata, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImNvbGxlY3Rpb24iOnsiZWxlbWVudHR5cGUiOnsicHJpbWl0aXZlIjoic3RyaW5nIn0sImtpbmQiOiJtYXAifX1dfX0=")), "sceneMetadata") unless @scene_metadata.nil?
  @tags = tags
  Jsii::Type.check_type(@tags, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7InByaW1pdGl2ZSI6InN0cmluZyJ9LCJraW5kIjoibWFwIn19")), "tags") unless @tags.nil?
end

Instance Attribute Details

#capabilities ⇒ Array<String>? (readonly)

A list of capabilities that the scene uses to render.

Returns:

  • (Array<String>, nil)

See Also:



52
53
54
 
# File 'io_t_twin_maker/cfn_scene_props.rb', line 52

def capabilities
  @capabilities
end

#content_location ⇒ String (readonly)

The relative path that specifies the location of the content definition file.

Returns:

  • (String)

See Also:



37
38
39
 
# File 'io_t_twin_maker/cfn_scene_props.rb', line 37

def content_location
  @content_location
end

#description ⇒ String? (readonly)

The description of this scene.

Returns:

  • (String, nil)

See Also:



57
58
59
 
# File 'io_t_twin_maker/cfn_scene_props.rb', line 57

def description
  @description
end

#scene_id ⇒ String (readonly)

The ID of the scene.

Returns:

  • (String)

See Also:



42
43
44
 
# File 'io_t_twin_maker/cfn_scene_props.rb', line 42

def scene_id
  @scene_id
end

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

The scene metadata.

Returns:

See Also:



62
63
64
 
# File 'io_t_twin_maker/cfn_scene_props.rb', line 62

def scene_metadata
  @scene_metadata
end

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

The ComponentType tags.

Returns:

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

See Also:



67
68
69
 
# File 'io_t_twin_maker/cfn_scene_props.rb', line 67

def tags
  @tags
end

#workspace_id ⇒ String (readonly)

The ID of the workspace.

Returns:

  • (String)

See Also:



47
48
49
 
# File 'io_t_twin_maker/cfn_scene_props.rb', line 47

def workspace_id
  @workspace_id
end

Class Method Details

.jsii_properties ⇒ Object 



69
70
71
72
73
74
75
76
77
78
79
 
# File 'io_t_twin_maker/cfn_scene_props.rb', line 69

def self.jsii_properties
  {
    :content_location => "contentLocation",
    :scene_id => "sceneId",
    :workspace_id => "workspaceId",
    :capabilities => "capabilities",
    :description => "description",
    :scene_metadata => "sceneMetadata",
    :tags => "tags",
  }
end

Instance Method Details

#to_jsii ⇒ Object 



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

def to_jsii
  result = {}
  result.merge!({
    "contentLocation" => @content_location,
    "sceneId" => @scene_id,
    "workspaceId" => @workspace_id,
    "capabilities" => @capabilities,
    "description" => @description,
    "sceneMetadata" => @scene_metadata,
    "tags" => @tags,
  })
  result.compact
end