We recommend new projects start with resources from the AWS provider.
aws-native.workspacesweb.UserSettings
Explore with Pulumi AI
We recommend new projects start with resources from the AWS provider.
Definition of AWS::WorkSpacesWeb::UserSettings Resource Type
Create UserSettings Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new UserSettings(name: string, args: UserSettingsArgs, opts?: CustomResourceOptions);@overload
def UserSettings(resource_name: str,
                 args: UserSettingsArgs,
                 opts: Optional[ResourceOptions] = None)
@overload
def UserSettings(resource_name: str,
                 opts: Optional[ResourceOptions] = None,
                 print_allowed: Optional[UserSettingsEnabledType] = None,
                 copy_allowed: Optional[UserSettingsEnabledType] = None,
                 download_allowed: Optional[UserSettingsEnabledType] = None,
                 paste_allowed: Optional[UserSettingsEnabledType] = None,
                 upload_allowed: Optional[UserSettingsEnabledType] = None,
                 cookie_synchronization_configuration: Optional[UserSettingsCookieSynchronizationConfigurationArgs] = None,
                 customer_managed_key: Optional[str] = None,
                 deep_link_allowed: Optional[UserSettingsEnabledType] = None,
                 disconnect_timeout_in_minutes: Optional[float] = None,
                 idle_disconnect_timeout_in_minutes: Optional[float] = None,
                 additional_encryption_context: Optional[Mapping[str, str]] = None,
                 tags: Optional[Sequence[_root_inputs.TagArgs]] = None,
                 toolbar_configuration: Optional[UserSettingsToolbarConfigurationArgs] = None)func NewUserSettings(ctx *Context, name string, args UserSettingsArgs, opts ...ResourceOption) (*UserSettings, error)public UserSettings(string name, UserSettingsArgs args, CustomResourceOptions? opts = null)
public UserSettings(String name, UserSettingsArgs args)
public UserSettings(String name, UserSettingsArgs args, CustomResourceOptions options)
type: aws-native:workspacesweb:UserSettings
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
Parameters
- name string
- The unique name of the resource.
- args UserSettingsArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- resource_name str
- The unique name of the resource.
- args UserSettingsArgs
- The arguments to resource properties.
- opts ResourceOptions
- Bag of options to control resource's behavior.
- ctx Context
- Context object for the current deployment.
- name string
- The unique name of the resource.
- args UserSettingsArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args UserSettingsArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args UserSettingsArgs
- The arguments to resource properties.
- options CustomResourceOptions
- Bag of options to control resource's behavior.
UserSettings Resource Properties
To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.
Inputs
In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.
The UserSettings resource accepts the following input properties:
- CopyAllowed Pulumi.Aws Native. Work Spaces Web. User Settings Enabled Type 
- Specifies whether the user can copy text from the streaming session to the local device.
- DownloadAllowed Pulumi.Aws Native. Work Spaces Web. User Settings Enabled Type 
- Specifies whether the user can download files from the streaming session to the local device.
- PasteAllowed Pulumi.Aws Native. Work Spaces Web. User Settings Enabled Type 
- Specifies whether the user can paste text from the local device to the streaming session.
- PrintAllowed Pulumi.Aws Native. Work Spaces Web. User Settings Enabled Type 
- Specifies whether the user can print to the local device.
- UploadAllowed Pulumi.Aws Native. Work Spaces Web. User Settings Enabled Type 
- Specifies whether the user can upload files from the local device to the streaming session.
- AdditionalEncryption Dictionary<string, string>Context 
- The additional encryption context of the user settings.
- 
Pulumi.Aws Native. Work Spaces Web. Inputs. User Settings Cookie Synchronization Configuration 
- The configuration that specifies which cookies should be synchronized from the end user's local browser to the remote browser.
- CustomerManaged stringKey 
- The customer managed key used to encrypt sensitive information in the user settings.
- DeepLink Pulumi.Allowed Aws Native. Work Spaces Web. User Settings Enabled Type 
- Specifies whether the user can use deep links that open automatically when connecting to a session.
- DisconnectTimeout doubleIn Minutes 
- The amount of time that a streaming session remains active after users disconnect.
- IdleDisconnect doubleTimeout In Minutes 
- The amount of time that users can be idle (inactive) before they are disconnected from their streaming session and the disconnect timeout interval begins.
- 
List<Pulumi.Aws Native. Inputs. Tag> 
- The tags to add to the user settings resource. A tag is a key-value pair.
- ToolbarConfiguration Pulumi.Aws Native. Work Spaces Web. Inputs. User Settings Toolbar Configuration 
- 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.
- CopyAllowed UserSettings Enabled Type 
- Specifies whether the user can copy text from the streaming session to the local device.
- DownloadAllowed UserSettings Enabled Type 
- Specifies whether the user can download files from the streaming session to the local device.
- PasteAllowed UserSettings Enabled Type 
- Specifies whether the user can paste text from the local device to the streaming session.
- PrintAllowed UserSettings Enabled Type 
- Specifies whether the user can print to the local device.
- UploadAllowed UserSettings Enabled Type 
- Specifies whether the user can upload files from the local device to the streaming session.
- AdditionalEncryption map[string]stringContext 
- The additional encryption context of the user settings.
- 
UserSettings Cookie Synchronization Configuration Args 
- The configuration that specifies which cookies should be synchronized from the end user's local browser to the remote browser.
- CustomerManaged stringKey 
- The customer managed key used to encrypt sensitive information in the user settings.
- DeepLink UserAllowed Settings Enabled Type 
- Specifies whether the user can use deep links that open automatically when connecting to a session.
- DisconnectTimeout float64In Minutes 
- The amount of time that a streaming session remains active after users disconnect.
- IdleDisconnect float64Timeout In Minutes 
- The amount of time that users can be idle (inactive) before they are disconnected from their streaming session and the disconnect timeout interval begins.
- 
TagArgs 
- The tags to add to the user settings resource. A tag is a key-value pair.
- ToolbarConfiguration UserSettings Toolbar Configuration Args 
- 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.
- copyAllowed UserSettings Enabled Type 
- Specifies whether the user can copy text from the streaming session to the local device.
- downloadAllowed UserSettings Enabled Type 
- Specifies whether the user can download files from the streaming session to the local device.
- pasteAllowed UserSettings Enabled Type 
- Specifies whether the user can paste text from the local device to the streaming session.
- printAllowed UserSettings Enabled Type 
- Specifies whether the user can print to the local device.
- uploadAllowed UserSettings Enabled Type 
- Specifies whether the user can upload files from the local device to the streaming session.
- additionalEncryption Map<String,String>Context 
- The additional encryption context of the user settings.
- 
UserSettings Cookie Synchronization Configuration 
- The configuration that specifies which cookies should be synchronized from the end user's local browser to the remote browser.
- customerManaged StringKey 
- The customer managed key used to encrypt sensitive information in the user settings.
- deepLink UserAllowed Settings Enabled Type 
- Specifies whether the user can use deep links that open automatically when connecting to a session.
- disconnectTimeout DoubleIn Minutes 
- The amount of time that a streaming session remains active after users disconnect.
- idleDisconnect DoubleTimeout In Minutes 
- The amount of time that users can be idle (inactive) before they are disconnected from their streaming session and the disconnect timeout interval begins.
- List<Tag>
- The tags to add to the user settings resource. A tag is a key-value pair.
- toolbarConfiguration UserSettings Toolbar Configuration 
- 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.
- copyAllowed UserSettings Enabled Type 
- Specifies whether the user can copy text from the streaming session to the local device.
- downloadAllowed UserSettings Enabled Type 
- Specifies whether the user can download files from the streaming session to the local device.
- pasteAllowed UserSettings Enabled Type 
- Specifies whether the user can paste text from the local device to the streaming session.
- printAllowed UserSettings Enabled Type 
- Specifies whether the user can print to the local device.
- uploadAllowed UserSettings Enabled Type 
- Specifies whether the user can upload files from the local device to the streaming session.
- additionalEncryption {[key: string]: string}Context 
- The additional encryption context of the user settings.
- 
UserSettings Cookie Synchronization Configuration 
- The configuration that specifies which cookies should be synchronized from the end user's local browser to the remote browser.
- customerManaged stringKey 
- The customer managed key used to encrypt sensitive information in the user settings.
- deepLink UserAllowed Settings Enabled Type 
- Specifies whether the user can use deep links that open automatically when connecting to a session.
- disconnectTimeout numberIn Minutes 
- The amount of time that a streaming session remains active after users disconnect.
- idleDisconnect numberTimeout In Minutes 
- The amount of time that users can be idle (inactive) before they are disconnected from their streaming session and the disconnect timeout interval begins.
- Tag[]
- The tags to add to the user settings resource. A tag is a key-value pair.
- toolbarConfiguration UserSettings Toolbar Configuration 
- 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.
- copy_allowed UserSettings Enabled Type 
- Specifies whether the user can copy text from the streaming session to the local device.
- download_allowed UserSettings Enabled Type 
- Specifies whether the user can download files from the streaming session to the local device.
- paste_allowed UserSettings Enabled Type 
- Specifies whether the user can paste text from the local device to the streaming session.
- print_allowed UserSettings Enabled Type 
- Specifies whether the user can print to the local device.
- upload_allowed UserSettings Enabled Type 
- Specifies whether the user can upload files from the local device to the streaming session.
- additional_encryption_ Mapping[str, str]context 
- The additional encryption context of the user settings.
- 
UserSettings Cookie Synchronization Configuration Args 
- The configuration that specifies which cookies should be synchronized from the end user's local browser to the remote browser.
- customer_managed_ strkey 
- The customer managed key used to encrypt sensitive information in the user settings.
- deep_link_ Userallowed Settings Enabled Type 
- Specifies whether the user can use deep links that open automatically when connecting to a session.
- disconnect_timeout_ floatin_ minutes 
- The amount of time that a streaming session remains active after users disconnect.
- idle_disconnect_ floattimeout_ in_ minutes 
- The amount of time that users can be idle (inactive) before they are disconnected from their streaming session and the disconnect timeout interval begins.
- 
Sequence[TagArgs] 
- The tags to add to the user settings resource. A tag is a key-value pair.
- toolbar_configuration UserSettings Toolbar Configuration Args 
- 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.
- copyAllowed "Disabled" | "Enabled"
- Specifies whether the user can copy text from the streaming session to the local device.
- downloadAllowed "Disabled" | "Enabled"
- Specifies whether the user can download files from the streaming session to the local device.
- pasteAllowed "Disabled" | "Enabled"
- Specifies whether the user can paste text from the local device to the streaming session.
- printAllowed "Disabled" | "Enabled"
- Specifies whether the user can print to the local device.
- uploadAllowed "Disabled" | "Enabled"
- Specifies whether the user can upload files from the local device to the streaming session.
- additionalEncryption Map<String>Context 
- The additional encryption context of the user settings.
- Property Map
- The configuration that specifies which cookies should be synchronized from the end user's local browser to the remote browser.
- customerManaged StringKey 
- The customer managed key used to encrypt sensitive information in the user settings.
- deepLink "Disabled" | "Enabled"Allowed 
- Specifies whether the user can use deep links that open automatically when connecting to a session.
- disconnectTimeout NumberIn Minutes 
- The amount of time that a streaming session remains active after users disconnect.
- idleDisconnect NumberTimeout In Minutes 
- The amount of time that users can be idle (inactive) before they are disconnected from their streaming session and the disconnect timeout interval begins.
- List<Property Map>
- The tags to add to the user settings resource. A tag is a key-value pair.
- toolbarConfiguration Property Map
- 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.
Outputs
All input properties are implicitly available as output properties. Additionally, the UserSettings resource produces the following output properties:
- AssociatedPortal List<string>Arns 
- A list of web portal ARNs that this user settings resource is associated with.
- Id string
- The provider-assigned unique ID for this managed resource.
- UserSettings stringArn 
- The ARN of the user settings.
- AssociatedPortal []stringArns 
- A list of web portal ARNs that this user settings resource is associated with.
- Id string
- The provider-assigned unique ID for this managed resource.
- UserSettings stringArn 
- The ARN of the user settings.
- associatedPortal List<String>Arns 
- A list of web portal ARNs that this user settings resource is associated with.
- id String
- The provider-assigned unique ID for this managed resource.
- userSettings StringArn 
- The ARN of the user settings.
- associatedPortal string[]Arns 
- A list of web portal ARNs that this user settings resource is associated with.
- id string
- The provider-assigned unique ID for this managed resource.
- userSettings stringArn 
- The ARN of the user settings.
- associated_portal_ Sequence[str]arns 
- A list of web portal ARNs that this user settings resource is associated with.
- id str
- The provider-assigned unique ID for this managed resource.
- user_settings_ strarn 
- The ARN of the user settings.
- associatedPortal List<String>Arns 
- A list of web portal ARNs that this user settings resource is associated with.
- id String
- The provider-assigned unique ID for this managed resource.
- userSettings StringArn 
- The ARN of the user settings.
Supporting Types
Tag, TagArgs  
UserSettingsCookieSpecification, UserSettingsCookieSpecificationArgs        
UserSettingsCookieSynchronizationConfiguration, UserSettingsCookieSynchronizationConfigurationArgs          
- Allowlist
List<Pulumi.Aws Native. Work Spaces Web. Inputs. User Settings Cookie Specification> 
- The list of cookie specifications that are allowed to be synchronized to the remote browser.
- Blocklist
List<Pulumi.Aws Native. Work Spaces Web. Inputs. User Settings Cookie Specification> 
- The list of cookie specifications that are blocked from being synchronized to the remote browser.
- Allowlist
[]UserSettings Cookie Specification 
- The list of cookie specifications that are allowed to be synchronized to the remote browser.
- Blocklist
[]UserSettings Cookie Specification 
- The list of cookie specifications that are blocked from being synchronized to the remote browser.
- allowlist
List<UserSettings Cookie Specification> 
- The list of cookie specifications that are allowed to be synchronized to the remote browser.
- blocklist
List<UserSettings Cookie Specification> 
- The list of cookie specifications that are blocked from being synchronized to the remote browser.
- allowlist
UserSettings Cookie Specification[] 
- The list of cookie specifications that are allowed to be synchronized to the remote browser.
- blocklist
UserSettings Cookie Specification[] 
- The list of cookie specifications that are blocked from being synchronized to the remote browser.
- allowlist
Sequence[UserSettings Cookie Specification] 
- The list of cookie specifications that are allowed to be synchronized to the remote browser.
- blocklist
Sequence[UserSettings Cookie Specification] 
- The list of cookie specifications that are blocked from being synchronized to the remote browser.
- allowlist List<Property Map>
- The list of cookie specifications that are allowed to be synchronized to the remote browser.
- blocklist List<Property Map>
- The list of cookie specifications that are blocked from being synchronized to the remote browser.
UserSettingsEnabledType, UserSettingsEnabledTypeArgs        
- Disabled
- Disabled
- Enabled
- Enabled
- UserSettings Enabled Type Disabled 
- Disabled
- UserSettings Enabled Type Enabled 
- Enabled
- Disabled
- Disabled
- Enabled
- Enabled
- Disabled
- Disabled
- Enabled
- Enabled
- DISABLED
- Disabled
- ENABLED
- Enabled
- "Disabled"
- Disabled
- "Enabled"
- Enabled
UserSettingsMaxDisplayResolution, UserSettingsMaxDisplayResolutionArgs          
- Size4096x2160
- size4096X2160
- Size3840x2160
- size3840X2160
- Size3440x1440
- size3440X1440
- Size2560x1440
- size2560X1440
- Size1920x1080
- size1920X1080
- Size1280x720
- size1280X720
- Size1024x768
- size1024X768
- Size800x600
- size800X600
- UserSettings Max Display Resolution Size4096x2160 
- size4096X2160
- UserSettings Max Display Resolution Size3840x2160 
- size3840X2160
- UserSettings Max Display Resolution Size3440x1440 
- size3440X1440
- UserSettings Max Display Resolution Size2560x1440 
- size2560X1440
- UserSettings Max Display Resolution Size1920x1080 
- size1920X1080
- UserSettings Max Display Resolution Size1280x720 
- size1280X720
- UserSettings Max Display Resolution Size1024x768 
- size1024X768
- UserSettings Max Display Resolution Size800x600 
- size800X600
- Size4096x2160
- size4096X2160
- Size3840x2160
- size3840X2160
- Size3440x1440
- size3440X1440
- Size2560x1440
- size2560X1440
- Size1920x1080
- size1920X1080
- Size1280x720
- size1280X720
- Size1024x768
- size1024X768
- Size800x600
- size800X600
- Size4096x2160
- size4096X2160
- Size3840x2160
- size3840X2160
- Size3440x1440
- size3440X1440
- Size2560x1440
- size2560X1440
- Size1920x1080
- size1920X1080
- Size1280x720
- size1280X720
- Size1024x768
- size1024X768
- Size800x600
- size800X600
- SIZE4096X2160
- size4096X2160
- SIZE3840X2160
- size3840X2160
- SIZE3440X1440
- size3440X1440
- SIZE2560X1440
- size2560X1440
- SIZE1920X1080
- size1920X1080
- SIZE1280X720
- size1280X720
- SIZE1024X768
- size1024X768
- SIZE800X600
- size800X600
- "size4096X2160"
- size4096X2160
- "size3840X2160"
- size3840X2160
- "size3440X1440"
- size3440X1440
- "size2560X1440"
- size2560X1440
- "size1920X1080"
- size1920X1080
- "size1280X720"
- size1280X720
- "size1024X768"
- size1024X768
- "size800X600"
- size800X600
UserSettingsToolbarConfiguration, UserSettingsToolbarConfigurationArgs        
- 
List<Pulumi.Aws Native. Work Spaces Web. User Settings Toolbar Item> 
- The list of toolbar items to be hidden.
- MaxDisplay Pulumi.Resolution Aws Native. Work Spaces Web. User Settings Max Display Resolution 
- The maximum display resolution that is allowed for the session.
- ToolbarType Pulumi.Aws Native. Work Spaces Web. User Settings Toolbar Type 
- The type of toolbar displayed during the session.
- VisualMode Pulumi.Aws Native. Work Spaces Web. User Settings Visual Mode 
- The visual mode of the toolbar.
- 
[]UserSettings Toolbar Item 
- The list of toolbar items to be hidden.
- MaxDisplay UserResolution Settings Max Display Resolution 
- The maximum display resolution that is allowed for the session.
- ToolbarType UserSettings Toolbar Type 
- The type of toolbar displayed during the session.
- VisualMode UserSettings Visual Mode 
- The visual mode of the toolbar.
- 
List<UserSettings Toolbar Item> 
- The list of toolbar items to be hidden.
- maxDisplay UserResolution Settings Max Display Resolution 
- The maximum display resolution that is allowed for the session.
- toolbarType UserSettings Toolbar Type 
- The type of toolbar displayed during the session.
- visualMode UserSettings Visual Mode 
- The visual mode of the toolbar.
- 
UserSettings Toolbar Item[] 
- The list of toolbar items to be hidden.
- maxDisplay UserResolution Settings Max Display Resolution 
- The maximum display resolution that is allowed for the session.
- toolbarType UserSettings Toolbar Type 
- The type of toolbar displayed during the session.
- visualMode UserSettings Visual Mode 
- The visual mode of the toolbar.
- 
Sequence[UserSettings Toolbar Item] 
- The list of toolbar items to be hidden.
- max_display_ Userresolution Settings Max Display Resolution 
- The maximum display resolution that is allowed for the session.
- toolbar_type UserSettings Toolbar Type 
- The type of toolbar displayed during the session.
- visual_mode UserSettings Visual Mode 
- The visual mode of the toolbar.
- 
List<"Windows" | "DualMonitor" | "Full Screen" | "Webcam" | "Microphone"> 
- The list of toolbar items to be hidden.
- maxDisplay "size4096X2160" | "size3840X2160" | "size3440X1440" | "size2560X1440" | "size1920X1080" | "size1280X720" | "size1024X768" | "size800X600"Resolution 
- The maximum display resolution that is allowed for the session.
- toolbarType "Floating" | "Docked"
- The type of toolbar displayed during the session.
- visualMode "Dark" | "Light"
- The visual mode of the toolbar.
UserSettingsToolbarItem, UserSettingsToolbarItemArgs        
- Windows
- Windows
- DualMonitor 
- DualMonitor
- FullScreen 
- FullScreen
- Webcam
- Webcam
- Microphone
- Microphone
- UserSettings Toolbar Item Windows 
- Windows
- UserSettings Toolbar Item Dual Monitor 
- DualMonitor
- UserSettings Toolbar Item Full Screen 
- FullScreen
- UserSettings Toolbar Item Webcam 
- Webcam
- UserSettings Toolbar Item Microphone 
- Microphone
- Windows
- Windows
- DualMonitor 
- DualMonitor
- FullScreen 
- FullScreen
- Webcam
- Webcam
- Microphone
- Microphone
- Windows
- Windows
- DualMonitor 
- DualMonitor
- FullScreen 
- FullScreen
- Webcam
- Webcam
- Microphone
- Microphone
- WINDOWS
- Windows
- DUAL_MONITOR
- DualMonitor
- FULL_SCREEN
- FullScreen
- WEBCAM
- Webcam
- MICROPHONE
- Microphone
- "Windows"
- Windows
- "DualMonitor" 
- DualMonitor
- "FullScreen" 
- FullScreen
- "Webcam"
- Webcam
- "Microphone"
- Microphone
UserSettingsToolbarType, UserSettingsToolbarTypeArgs        
- Floating
- Floating
- Docked
- Docked
- UserSettings Toolbar Type Floating 
- Floating
- UserSettings Toolbar Type Docked 
- Docked
- Floating
- Floating
- Docked
- Docked
- Floating
- Floating
- Docked
- Docked
- FLOATING
- Floating
- DOCKED
- Docked
- "Floating"
- Floating
- "Docked"
- Docked
UserSettingsVisualMode, UserSettingsVisualModeArgs        
- Dark
- Dark
- Light
- Light
- UserSettings Visual Mode Dark 
- Dark
- UserSettings Visual Mode Light 
- Light
- Dark
- Dark
- Light
- Light
- Dark
- Dark
- Light
- Light
- DARK
- Dark
- LIGHT
- Light
- "Dark"
- Dark
- "Light"
- Light
Package Details
- Repository
- AWS Native pulumi/pulumi-aws-native
- License
- Apache-2.0
We recommend new projects start with resources from the AWS provider.