Class: AWSCDK::IoTTwinMaker::CfnWorkspaceProps

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

Overview

Properties for defining a CfnWorkspace.

See Also:

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(role:, s3_location:, workspace_id:, description: nil, tags: nil) ⇒ CfnWorkspaceProps

Returns a new instance of CfnWorkspaceProps.

Parameters:

  • role (String, AWSCDK::Interfaces::AWSIAM::IRoleRef) —

    The ARN of the execution role associated with the workspace.

  • s3_location (String, AWSCDK::Interfaces::AWSS3::IBucketRef) —

    The ARN of the S3 bucket where resources associated with the workspace are stored.

  • workspace_id (String) —

    The ID of the workspace.

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

    The description of the workspace.

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

    Metadata that you can use to manage the workspace.



14
15
16
17
18
19
20
21
22
23
24
25
 
# File 'io_t_twin_maker/cfn_workspace_props.rb', line 14

def initialize(role:, s3_location:, workspace_id:, description: nil, tags: nil)
  @role = role
  Jsii::Type.check_type(@role, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3sicHJpbWl0aXZlIjoic3RyaW5nIn0seyJmcW4iOiJhd3MtY2RrLWxpYi5pbnRlcmZhY2VzLmF3c19pYW0uSVJvbGVSZWYifV19fQ==")), "role")
  @s3_location = s3_location
  Jsii::Type.check_type(@s3_location, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3sicHJpbWl0aXZlIjoic3RyaW5nIn0seyJmcW4iOiJhd3MtY2RrLWxpYi5pbnRlcmZhY2VzLmF3c19zMy5JQnVja2V0UmVmIn1dfX0=")), "s3Location")
  @workspace_id = workspace_id
  Jsii::Type.check_type(@workspace_id, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "workspaceId")
  @description = description
  Jsii::Type.check_type(@description, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "description") unless @description.nil?
  @tags = tags
  Jsii::Type.check_type(@tags, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7InByaW1pdGl2ZSI6InN0cmluZyJ9LCJraW5kIjoibWFwIn19")), "tags") unless @tags.nil?
end

Instance Attribute Details

#description ⇒ String? (readonly)

The description of the workspace.

Returns:

  • (String, nil)

See Also:



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

def description
  @description
end

#role ⇒ String, AWSCDK::Interfaces::AWSIAM::IRoleRef (readonly)

The ARN of the execution role associated with the workspace.

Returns:

See Also:



31
32
33
 
# File 'io_t_twin_maker/cfn_workspace_props.rb', line 31

def role
  @role
end

#s3_location ⇒ String, AWSCDK::Interfaces::AWSS3::IBucketRef (readonly)

The ARN of the S3 bucket where resources associated with the workspace are stored.

Returns:

See Also:



36
37
38
 
# File 'io_t_twin_maker/cfn_workspace_props.rb', line 36

def s3_location
  @s3_location
end

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

Metadata that you can use to manage the workspace.

Returns:

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

See Also:



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

def tags
  @tags
end

#workspace_id ⇒ String (readonly)

The ID of the workspace.

Returns:

  • (String)

See Also:



41
42
43
 
# File 'io_t_twin_maker/cfn_workspace_props.rb', line 41

def workspace_id
  @workspace_id
end

Class Method Details

.jsii_properties ⇒ Object 



53
54
55
56
57
58
59
60
61
 
# File 'io_t_twin_maker/cfn_workspace_props.rb', line 53

def self.jsii_properties
  {
    :role => "role",
    :s3_location => "s3Location",
    :workspace_id => "workspaceId",
    :description => "description",
    :tags => "tags",
  }
end

Instance Method Details

#to_jsii ⇒ Object 



63
64
65
66
67
68
69
70
71
72
73
 
# File 'io_t_twin_maker/cfn_workspace_props.rb', line 63

def to_jsii
  result = {}
  result.merge!({
    "role" => @role,
    "s3Location" => @s3_location,
    "workspaceId" => @workspace_id,
    "description" => @description,
    "tags" => @tags,
  })
  result.compact
end