Class: AWSCDK::Connect::CfnWorkspaceProps

Inherits:
Jsii::Struct
  • Object
show all
Defined in:
connect/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(instance_arn:, name:, associations: nil, description: nil, media: nil, pages: nil, tags: nil, theme: nil, title: nil, visibility: nil) ⇒ CfnWorkspaceProps

Returns a new instance of CfnWorkspaceProps.

Parameters:



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

def initialize(instance_arn:, name:, associations: nil, description: nil, media: nil, pages: nil, tags: nil, theme: nil, title: nil, visibility: nil)
  @instance_arn = instance_arn
  Jsii::Type.check_type(@instance_arn, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "instanceArn")
  @name = name
  Jsii::Type.check_type(@name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "name")
  @associations = associations
  Jsii::Type.check_type(@associations, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7InByaW1pdGl2ZSI6InN0cmluZyJ9LCJraW5kIjoiYXJyYXkifX0=")), "associations") unless @associations.nil?
  @description = description
  Jsii::Type.check_type(@description, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "description") unless @description.nil?
  @media = media
  Jsii::Type.check_type(@media, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImNvbGxlY3Rpb24iOnsiZWxlbWVudHR5cGUiOnsidW5pb24iOnsidHlwZXMiOlt7ImZxbiI6ImF3cy1jZGstbGliLklSZXNvbHZhYmxlIn0seyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfY29ubmVjdC5DZm5Xb3Jrc3BhY2UuTWVkaWFJdGVtUHJvcGVydHkifV19fSwia2luZCI6ImFycmF5In19XX19")), "media") unless @media.nil?
  @pages = pages
  Jsii::Type.check_type(@pages, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImNvbGxlY3Rpb24iOnsiZWxlbWVudHR5cGUiOnsidW5pb24iOnsidHlwZXMiOlt7ImZxbiI6ImF3cy1jZGstbGliLklSZXNvbHZhYmxlIn0seyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfY29ubmVjdC5DZm5Xb3Jrc3BhY2UuV29ya3NwYWNlUGFnZVByb3BlcnR5In1dfX0sImtpbmQiOiJhcnJheSJ9fV19fQ==")), "pages") unless @pages.nil?
  @tags = tags.is_a?(Array) ? tags.map { |jsii_v0| jsii_v0.is_a?(Hash) ? ::AWSCDK::CfnTag.new(**jsii_v0.transform_keys(&:to_sym)) : jsii_v0 } : tags
  Jsii::Type.check_type(@tags, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7ImZxbiI6ImF3cy1jZGstbGliLkNmblRhZyJ9LCJraW5kIjoiYXJyYXkifX0=")), "tags") unless @tags.nil?
  @theme = theme.is_a?(Hash) ? ::AWSCDK::Connect::CfnWorkspace::WorkspaceThemeProperty.new(**theme.transform_keys(&:to_sym)) : theme
  Jsii::Type.check_type(@theme, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19jb25uZWN0LkNmbldvcmtzcGFjZS5Xb3Jrc3BhY2VUaGVtZVByb3BlcnR5In1dfX0=")), "theme") unless @theme.nil?
  @title = title
  Jsii::Type.check_type(@title, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "title") unless @title.nil?
  @visibility = visibility
  Jsii::Type.check_type(@visibility, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "visibility") unless @visibility.nil?
end

Instance Attribute Details

#associations ⇒ Array<String>? (readonly)

The resource ARNs associated with the workspace.

Returns:

  • (Array<String>, nil)

See Also:



56
57
58
 
# File 'connect/cfn_workspace_props.rb', line 56

def associations
  @associations
end

#description ⇒ String? (readonly)

The description of the workspace.

Returns:

  • (String, nil)

See Also:



61
62
63
 
# File 'connect/cfn_workspace_props.rb', line 61

def description
  @description
end

#instance_arn ⇒ String (readonly)

The Amazon Resource Name (ARN) of the instance.

Returns:

  • (String)

See Also:



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

def instance_arn
  @instance_arn
end

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

The media items for the workspace.

Returns:

See Also:



66
67
68
 
# File 'connect/cfn_workspace_props.rb', line 66

def media
  @media
end

#name ⇒ String (readonly)

The name of the workspace.

Returns:

  • (String)

See Also:



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

def name
  @name
end

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

The pages associated with the workspace.

Returns:

See Also:



71
72
73
 
# File 'connect/cfn_workspace_props.rb', line 71

def pages
  @pages
end

#tags ⇒ Array<AWSCDK::CfnTag>? (readonly)

The tags used to organize, track, or control access for the workspace.

Returns:

See Also:



76
77
78
 
# File 'connect/cfn_workspace_props.rb', line 76

def tags
  @tags
end

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

The theme configuration for the workspace, including colors and styling.

Returns:

See Also:



81
82
83
 
# File 'connect/cfn_workspace_props.rb', line 81

def theme
  @theme
end

#title ⇒ String? (readonly)

The title displayed for the workspace.

Returns:

  • (String, nil)

See Also:



86
87
88
 
# File 'connect/cfn_workspace_props.rb', line 86

def title
  @title
end

#visibility ⇒ String? (readonly)

Controls who can access the workspace.

Valid values are: ALL (all users), ASSIGNED (only assigned users and routing profiles), and NONE (not visible).

Returns:

  • (String, nil)

See Also:



93
94
95
 
# File 'connect/cfn_workspace_props.rb', line 93

def visibility
  @visibility
end

Class Method Details

.jsii_properties ⇒ Object 



95
96
97
98
99
100
101
102
103
104
105
106
107
108
 
# File 'connect/cfn_workspace_props.rb', line 95

def self.jsii_properties
  {
    :instance_arn => "instanceArn",
    :name => "name",
    :associations => "associations",
    :description => "description",
    :media => "media",
    :pages => "pages",
    :tags => "tags",
    :theme => "theme",
    :title => "title",
    :visibility => "visibility",
  }
end

Instance Method Details

#to_jsii ⇒ Object 



110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
 
# File 'connect/cfn_workspace_props.rb', line 110

def to_jsii
  result = {}
  result.merge!({
    "instanceArn" => @instance_arn,
    "name" => @name,
    "associations" => @associations,
    "description" => @description,
    "media" => @media,
    "pages" => @pages,
    "tags" => @tags,
    "theme" => @theme,
    "title" => @title,
    "visibility" => @visibility,
  })
  result.compact
end