ToolbarConfigurationProperty Struct
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.
| Source | Generated at build time |
|---|---|
| Type last changed | v2.182.0 · 5 Mar 2025 |
Example
ts
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_workspacesweb as workspacesweb } from 'aws-cdk-lib';
const toolbarConfigurationProperty: workspacesweb.CfnUserSettings.ToolbarConfigurationProperty = {
hiddenToolbarItems: ['hiddenToolbarItems'],
maxDisplayResolution: 'maxDisplayResolution',
toolbarType: 'toolbarType',
visualMode: 'visualMode',
};
python
# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_workspacesweb as workspacesweb
toolbar_configuration_property = workspacesweb.CfnUserSettings.ToolbarConfigurationProperty(
hidden_toolbar_items=["hiddenToolbarItems"],
max_display_resolution="maxDisplayResolution",
toolbar_type="toolbarType",
visual_mode="visualMode"
)
java
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import software.amazon.awscdk.services.workspacesweb.*;
ToolbarConfigurationProperty toolbarConfigurationProperty = ToolbarConfigurationProperty.builder()
.hiddenToolbarItems(List.of("hiddenToolbarItems"))
.maxDisplayResolution("maxDisplayResolution")
.toolbarType("toolbarType")
.visualMode("visualMode")
.build();
csharp
// Install: dotnet add package Amazon.CDK.Lib
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.WorkSpacesWeb;
var toolbarConfigurationProperty = new ToolbarConfigurationProperty {
HiddenToolbarItems = new [] { "hiddenToolbarItems" },
MaxDisplayResolution = "maxDisplayResolution",
ToolbarType = "toolbarType",
VisualMode = "visualMode"
};
go
// Install: go get github.com/aws/aws-cdk-go/awscdk/v2
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"
toolbarConfigurationProperty := &ToolbarConfigurationProperty{
HiddenToolbarItems: []*string{
jsii.String("hiddenToolbarItems"),
},
MaxDisplayResolution: jsii.String("maxDisplayResolution"),
ToolbarType: jsii.String("toolbarType"),
VisualMode: jsii.String("visualMode"),
}
Properties
hiddenToolbarItems?optionalstring[]hidden_toolbar_items?optionaltyping.List[str]hiddenToolbarItems?optionalList<String>HiddenToolbarItems?optionalstring[]HiddenToolbarItems?optional*[]*string #The list of toolbar items to be hidden.
maxDisplayResolution?optionalstringmax_display_resolution?optionalstrmaxDisplayResolution?optionalStringMaxDisplayResolution?optionalstringMaxDisplayResolution?optional*string #The maximum display resolution that is allowed for the session.
toolbarType?optionalstringtoolbar_type?optionalstrtoolbarType?optionalStringToolbarType?optionalstringToolbarType?optional*string #The type of toolbar displayed during the session.
visualMode?optionalstringvisual_mode?optionalstrvisualMode?optionalStringVisualMode?optionalstringVisualMode?optional*string #The visual mode of the toolbar.