Class: AWSCDK::WorkspacesWeb::CfnUserSettings::ToolbarConfigurationProperty

Inherits:
Jsii::Struct
  • Object
show all
Defined in:
workspaces_web/cfn_user_settings.rb

Overview

The configuration of the toolbar.

This allows administrators to select the toolbar type and visual mode, set maximum display resolution for sessions, and choose which items are visible to end users during their sessions. If administrators do not modify these settings, end users retain control over their toolbar preferences.

See Also:

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(hidden_toolbar_items: nil, max_display_resolution: nil, toolbar_type: nil, visual_mode: nil) ⇒ ToolbarConfigurationProperty

Returns a new instance of ToolbarConfigurationProperty.

Parameters:

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

    The list of toolbar items to be hidden.

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

    The maximum display resolution that is allowed for the session.

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

    The type of toolbar displayed during the session.

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

    The visual mode of the toolbar.



1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
 
# File 'workspaces_web/cfn_user_settings.rb', line 1142

def initialize(hidden_toolbar_items: nil, max_display_resolution: nil, toolbar_type: nil, visual_mode: nil)
  @hidden_toolbar_items = hidden_toolbar_items
  Jsii::Type.check_type(@hidden_toolbar_items, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7InByaW1pdGl2ZSI6InN0cmluZyJ9LCJraW5kIjoiYXJyYXkifX0=")), "hiddenToolbarItems") unless @hidden_toolbar_items.nil?
  @max_display_resolution = max_display_resolution
  Jsii::Type.check_type(@max_display_resolution, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "maxDisplayResolution") unless @max_display_resolution.nil?
  @toolbar_type = toolbar_type
  Jsii::Type.check_type(@toolbar_type, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "toolbarType") unless @toolbar_type.nil?
  @visual_mode = visual_mode
  Jsii::Type.check_type(@visual_mode, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "visualMode") unless @visual_mode.nil?
end

Instance Attribute Details

#hidden_toolbar_items ⇒ Array<String>? (readonly)

The list of toolbar items to be hidden.

Returns:

  • (Array<String>, nil)

See Also:



1157
1158
1159
 
# File 'workspaces_web/cfn_user_settings.rb', line 1157

def hidden_toolbar_items
  @hidden_toolbar_items
end

#max_display_resolution ⇒ String? (readonly)

The maximum display resolution that is allowed for the session.

Returns:

  • (String, nil)

See Also:



1162
1163
1164
 
# File 'workspaces_web/cfn_user_settings.rb', line 1162

def max_display_resolution
  @max_display_resolution
end

#toolbar_type ⇒ String? (readonly)

The type of toolbar displayed during the session.

Returns:

  • (String, nil)

See Also:



1167
1168
1169
 
# File 'workspaces_web/cfn_user_settings.rb', line 1167

def toolbar_type
  @toolbar_type
end

#visual_mode ⇒ String? (readonly)

The visual mode of the toolbar.

Returns:

  • (String, nil)

See Also:



1172
1173
1174
 
# File 'workspaces_web/cfn_user_settings.rb', line 1172

def visual_mode
  @visual_mode
end

Class Method Details

.jsii_properties ⇒ Object 



1174
1175
1176
1177
1178
1179
1180
1181
 
# File 'workspaces_web/cfn_user_settings.rb', line 1174

def self.jsii_properties
  {
    :hidden_toolbar_items => "hiddenToolbarItems",
    :max_display_resolution => "maxDisplayResolution",
    :toolbar_type => "toolbarType",
    :visual_mode => "visualMode",
  }
end

Instance Method Details

#to_jsii ⇒ Object 



1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
 
# File 'workspaces_web/cfn_user_settings.rb', line 1183

def to_jsii
  result = {}
  result.merge!({
    "hiddenToolbarItems" => @hidden_toolbar_items,
    "maxDisplayResolution" => @max_display_resolution,
    "toolbarType" => @toolbar_type,
    "visualMode" => @visual_mode,
  })
  result.compact
end