Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. AWS Cloud Control
  3. API Docs
  4. workspacesweb
  5. getUserSettings

We recommend new projects start with resources from the AWS provider.

AWS Cloud Control v1.26.0 published on Wednesday, Mar 12, 2025 by Pulumi
pulumi/pulumi-aws-native

aws-native.workspacesweb.getUserSettings

Explore with Pulumi AI

We recommend new projects start with resources from the AWS provider.

AWS Cloud Control v1.26.0 published on Wednesday, Mar 12, 2025 by Pulumi
pulumi/pulumi-aws-native

Definition of AWS::WorkSpacesWeb::UserSettings Resource Type

Using getUserSettings

Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

function getUserSettings(args: GetUserSettingsArgs, opts?: InvokeOptions): Promise<GetUserSettingsResult>
function getUserSettingsOutput(args: GetUserSettingsOutputArgs, opts?: InvokeOptions): Output<GetUserSettingsResult>
Copy
def get_user_settings(user_settings_arn: Optional[str] = None,
                      opts: Optional[InvokeOptions] = None) -> GetUserSettingsResult
def get_user_settings_output(user_settings_arn: Optional[pulumi.Input[str]] = None,
                      opts: Optional[InvokeOptions] = None) -> Output[GetUserSettingsResult]
Copy
func LookupUserSettings(ctx *Context, args *LookupUserSettingsArgs, opts ...InvokeOption) (*LookupUserSettingsResult, error)
func LookupUserSettingsOutput(ctx *Context, args *LookupUserSettingsOutputArgs, opts ...InvokeOption) LookupUserSettingsResultOutput
Copy

> Note: This function is named LookupUserSettings in the Go SDK.

public static class GetUserSettings 
{
    public static Task<GetUserSettingsResult> InvokeAsync(GetUserSettingsArgs args, InvokeOptions? opts = null)
    public static Output<GetUserSettingsResult> Invoke(GetUserSettingsInvokeArgs args, InvokeOptions? opts = null)
}
Copy
public static CompletableFuture<GetUserSettingsResult> getUserSettings(GetUserSettingsArgs args, InvokeOptions options)
public static Output<GetUserSettingsResult> getUserSettings(GetUserSettingsArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: aws-native:workspacesweb:getUserSettings
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

UserSettingsArn This property is required. string
The ARN of the user settings.
UserSettingsArn This property is required. string
The ARN of the user settings.
userSettingsArn This property is required. String
The ARN of the user settings.
userSettingsArn This property is required. string
The ARN of the user settings.
user_settings_arn This property is required. str
The ARN of the user settings.
userSettingsArn This property is required. String
The ARN of the user settings.

getUserSettings Result

The following output properties are available:

AdditionalEncryptionContext Dictionary<string, string>
The additional encryption context of the user settings.
AssociatedPortalArns List<string>
A list of web portal ARNs that this user settings resource is associated with.
CookieSynchronizationConfiguration Pulumi.AwsNative.WorkSpacesWeb.Outputs.UserSettingsCookieSynchronizationConfiguration
The configuration that specifies which cookies should be synchronized from the end user's local browser to the remote browser.
CopyAllowed Pulumi.AwsNative.WorkSpacesWeb.UserSettingsEnabledType
Specifies whether the user can copy text from the streaming session to the local device.
CustomerManagedKey string
The customer managed key used to encrypt sensitive information in the user settings.
DeepLinkAllowed Pulumi.AwsNative.WorkSpacesWeb.UserSettingsEnabledType
Specifies whether the user can use deep links that open automatically when connecting to a session.
DisconnectTimeoutInMinutes double
The amount of time that a streaming session remains active after users disconnect.
DownloadAllowed Pulumi.AwsNative.WorkSpacesWeb.UserSettingsEnabledType
Specifies whether the user can download files from the streaming session to the local device.
IdleDisconnectTimeoutInMinutes double
The amount of time that users can be idle (inactive) before they are disconnected from their streaming session and the disconnect timeout interval begins.
PasteAllowed Pulumi.AwsNative.WorkSpacesWeb.UserSettingsEnabledType
Specifies whether the user can paste text from the local device to the streaming session.
PrintAllowed Pulumi.AwsNative.WorkSpacesWeb.UserSettingsEnabledType
Specifies whether the user can print to the local device.
Tags List<Pulumi.AwsNative.Outputs.Tag>
The tags to add to the user settings resource. A tag is a key-value pair.
ToolbarConfiguration Pulumi.AwsNative.WorkSpacesWeb.Outputs.UserSettingsToolbarConfiguration
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.
UploadAllowed Pulumi.AwsNative.WorkSpacesWeb.UserSettingsEnabledType
Specifies whether the user can upload files from the local device to the streaming session.
UserSettingsArn string
The ARN of the user settings.
AdditionalEncryptionContext map[string]string
The additional encryption context of the user settings.
AssociatedPortalArns []string
A list of web portal ARNs that this user settings resource is associated with.
CookieSynchronizationConfiguration UserSettingsCookieSynchronizationConfiguration
The configuration that specifies which cookies should be synchronized from the end user's local browser to the remote browser.
CopyAllowed UserSettingsEnabledType
Specifies whether the user can copy text from the streaming session to the local device.
CustomerManagedKey string
The customer managed key used to encrypt sensitive information in the user settings.
DeepLinkAllowed UserSettingsEnabledType
Specifies whether the user can use deep links that open automatically when connecting to a session.
DisconnectTimeoutInMinutes float64
The amount of time that a streaming session remains active after users disconnect.
DownloadAllowed UserSettingsEnabledType
Specifies whether the user can download files from the streaming session to the local device.
IdleDisconnectTimeoutInMinutes float64
The amount of time that users can be idle (inactive) before they are disconnected from their streaming session and the disconnect timeout interval begins.
PasteAllowed UserSettingsEnabledType
Specifies whether the user can paste text from the local device to the streaming session.
PrintAllowed UserSettingsEnabledType
Specifies whether the user can print to the local device.
Tags Tag
The tags to add to the user settings resource. A tag is a key-value pair.
ToolbarConfiguration UserSettingsToolbarConfiguration
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.
UploadAllowed UserSettingsEnabledType
Specifies whether the user can upload files from the local device to the streaming session.
UserSettingsArn string
The ARN of the user settings.
additionalEncryptionContext Map<String,String>
The additional encryption context of the user settings.
associatedPortalArns List<String>
A list of web portal ARNs that this user settings resource is associated with.
cookieSynchronizationConfiguration UserSettingsCookieSynchronizationConfiguration
The configuration that specifies which cookies should be synchronized from the end user's local browser to the remote browser.
copyAllowed UserSettingsEnabledType
Specifies whether the user can copy text from the streaming session to the local device.
customerManagedKey String
The customer managed key used to encrypt sensitive information in the user settings.
deepLinkAllowed UserSettingsEnabledType
Specifies whether the user can use deep links that open automatically when connecting to a session.
disconnectTimeoutInMinutes Double
The amount of time that a streaming session remains active after users disconnect.
downloadAllowed UserSettingsEnabledType
Specifies whether the user can download files from the streaming session to the local device.
idleDisconnectTimeoutInMinutes Double
The amount of time that users can be idle (inactive) before they are disconnected from their streaming session and the disconnect timeout interval begins.
pasteAllowed UserSettingsEnabledType
Specifies whether the user can paste text from the local device to the streaming session.
printAllowed UserSettingsEnabledType
Specifies whether the user can print to the local device.
tags List<Tag>
The tags to add to the user settings resource. A tag is a key-value pair.
toolbarConfiguration UserSettingsToolbarConfiguration
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.
uploadAllowed UserSettingsEnabledType
Specifies whether the user can upload files from the local device to the streaming session.
userSettingsArn String
The ARN of the user settings.
additionalEncryptionContext {[key: string]: string}
The additional encryption context of the user settings.
associatedPortalArns string[]
A list of web portal ARNs that this user settings resource is associated with.
cookieSynchronizationConfiguration UserSettingsCookieSynchronizationConfiguration
The configuration that specifies which cookies should be synchronized from the end user's local browser to the remote browser.
copyAllowed UserSettingsEnabledType
Specifies whether the user can copy text from the streaming session to the local device.
customerManagedKey string
The customer managed key used to encrypt sensitive information in the user settings.
deepLinkAllowed UserSettingsEnabledType
Specifies whether the user can use deep links that open automatically when connecting to a session.
disconnectTimeoutInMinutes number
The amount of time that a streaming session remains active after users disconnect.
downloadAllowed UserSettingsEnabledType
Specifies whether the user can download files from the streaming session to the local device.
idleDisconnectTimeoutInMinutes number
The amount of time that users can be idle (inactive) before they are disconnected from their streaming session and the disconnect timeout interval begins.
pasteAllowed UserSettingsEnabledType
Specifies whether the user can paste text from the local device to the streaming session.
printAllowed UserSettingsEnabledType
Specifies whether the user can print to the local device.
tags Tag[]
The tags to add to the user settings resource. A tag is a key-value pair.
toolbarConfiguration UserSettingsToolbarConfiguration
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.
uploadAllowed UserSettingsEnabledType
Specifies whether the user can upload files from the local device to the streaming session.
userSettingsArn string
The ARN of the user settings.
additional_encryption_context Mapping[str, str]
The additional encryption context of the user settings.
associated_portal_arns Sequence[str]
A list of web portal ARNs that this user settings resource is associated with.
cookie_synchronization_configuration UserSettingsCookieSynchronizationConfiguration
The configuration that specifies which cookies should be synchronized from the end user's local browser to the remote browser.
copy_allowed UserSettingsEnabledType
Specifies whether the user can copy text from the streaming session to the local device.
customer_managed_key str
The customer managed key used to encrypt sensitive information in the user settings.
deep_link_allowed UserSettingsEnabledType
Specifies whether the user can use deep links that open automatically when connecting to a session.
disconnect_timeout_in_minutes float
The amount of time that a streaming session remains active after users disconnect.
download_allowed UserSettingsEnabledType
Specifies whether the user can download files from the streaming session to the local device.
idle_disconnect_timeout_in_minutes float
The amount of time that users can be idle (inactive) before they are disconnected from their streaming session and the disconnect timeout interval begins.
paste_allowed UserSettingsEnabledType
Specifies whether the user can paste text from the local device to the streaming session.
print_allowed UserSettingsEnabledType
Specifies whether the user can print to the local device.
tags Sequence[root_Tag]
The tags to add to the user settings resource. A tag is a key-value pair.
toolbar_configuration UserSettingsToolbarConfiguration
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.
upload_allowed UserSettingsEnabledType
Specifies whether the user can upload files from the local device to the streaming session.
user_settings_arn str
The ARN of the user settings.
additionalEncryptionContext Map<String>
The additional encryption context of the user settings.
associatedPortalArns List<String>
A list of web portal ARNs that this user settings resource is associated with.
cookieSynchronizationConfiguration Property Map
The configuration that specifies which cookies should be synchronized from the end user's local browser to the remote browser.
copyAllowed "Disabled" | "Enabled"
Specifies whether the user can copy text from the streaming session to the local device.
customerManagedKey String
The customer managed key used to encrypt sensitive information in the user settings.
deepLinkAllowed "Disabled" | "Enabled"
Specifies whether the user can use deep links that open automatically when connecting to a session.
disconnectTimeoutInMinutes Number
The amount of time that a streaming session remains active after users disconnect.
downloadAllowed "Disabled" | "Enabled"
Specifies whether the user can download files from the streaming session to the local device.
idleDisconnectTimeoutInMinutes Number
The amount of time that users can be idle (inactive) before they are disconnected from their streaming session and the disconnect timeout interval begins.
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.
tags 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.
uploadAllowed "Disabled" | "Enabled"
Specifies whether the user can upload files from the local device to the streaming session.
userSettingsArn String
The ARN of the user settings.

Supporting Types

Tag

Key This property is required. string
The key name of the tag
Value This property is required. string
The value of the tag
Key This property is required. string
The key name of the tag
Value This property is required. string
The value of the tag
key This property is required. String
The key name of the tag
value This property is required. String
The value of the tag
key This property is required. string
The key name of the tag
value This property is required. string
The value of the tag
key This property is required. str
The key name of the tag
value This property is required. str
The value of the tag
key This property is required. String
The key name of the tag
value This property is required. String
The value of the tag

UserSettingsCookieSpecification

Domain This property is required. string
The domain of the cookie.
Name string
The name of the cookie.
Path string
The path of the cookie.
Domain This property is required. string
The domain of the cookie.
Name string
The name of the cookie.
Path string
The path of the cookie.
domain This property is required. String
The domain of the cookie.
name String
The name of the cookie.
path String
The path of the cookie.
domain This property is required. string
The domain of the cookie.
name string
The name of the cookie.
path string
The path of the cookie.
domain This property is required. str
The domain of the cookie.
name str
The name of the cookie.
path str
The path of the cookie.
domain This property is required. String
The domain of the cookie.
name String
The name of the cookie.
path String
The path of the cookie.

UserSettingsCookieSynchronizationConfiguration

Allowlist This property is required. List<Pulumi.AwsNative.WorkSpacesWeb.Inputs.UserSettingsCookieSpecification>
The list of cookie specifications that are allowed to be synchronized to the remote browser.
Blocklist List<Pulumi.AwsNative.WorkSpacesWeb.Inputs.UserSettingsCookieSpecification>
The list of cookie specifications that are blocked from being synchronized to the remote browser.
Allowlist This property is required. []UserSettingsCookieSpecification
The list of cookie specifications that are allowed to be synchronized to the remote browser.
Blocklist []UserSettingsCookieSpecification
The list of cookie specifications that are blocked from being synchronized to the remote browser.
allowlist This property is required. List<UserSettingsCookieSpecification>
The list of cookie specifications that are allowed to be synchronized to the remote browser.
blocklist List<UserSettingsCookieSpecification>
The list of cookie specifications that are blocked from being synchronized to the remote browser.
allowlist This property is required. UserSettingsCookieSpecification[]
The list of cookie specifications that are allowed to be synchronized to the remote browser.
blocklist UserSettingsCookieSpecification[]
The list of cookie specifications that are blocked from being synchronized to the remote browser.
allowlist This property is required. Sequence[UserSettingsCookieSpecification]
The list of cookie specifications that are allowed to be synchronized to the remote browser.
blocklist Sequence[UserSettingsCookieSpecification]
The list of cookie specifications that are blocked from being synchronized to the remote browser.
allowlist This property is required. 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

UserSettingsMaxDisplayResolution

UserSettingsToolbarConfiguration

HiddenToolbarItems []UserSettingsToolbarItem
The list of toolbar items to be hidden.
MaxDisplayResolution UserSettingsMaxDisplayResolution
The maximum display resolution that is allowed for the session.
ToolbarType UserSettingsToolbarType
The type of toolbar displayed during the session.
VisualMode UserSettingsVisualMode
The visual mode of the toolbar.
hiddenToolbarItems List<UserSettingsToolbarItem>
The list of toolbar items to be hidden.
maxDisplayResolution UserSettingsMaxDisplayResolution
The maximum display resolution that is allowed for the session.
toolbarType UserSettingsToolbarType
The type of toolbar displayed during the session.
visualMode UserSettingsVisualMode
The visual mode of the toolbar.
hiddenToolbarItems UserSettingsToolbarItem[]
The list of toolbar items to be hidden.
maxDisplayResolution UserSettingsMaxDisplayResolution
The maximum display resolution that is allowed for the session.
toolbarType UserSettingsToolbarType
The type of toolbar displayed during the session.
visualMode UserSettingsVisualMode
The visual mode of the toolbar.
hidden_toolbar_items Sequence[UserSettingsToolbarItem]
The list of toolbar items to be hidden.
max_display_resolution UserSettingsMaxDisplayResolution
The maximum display resolution that is allowed for the session.
toolbar_type UserSettingsToolbarType
The type of toolbar displayed during the session.
visual_mode UserSettingsVisualMode
The visual mode of the toolbar.

UserSettingsToolbarItem

UserSettingsToolbarType

UserSettingsVisualMode

Package Details

Repository
AWS Native pulumi/pulumi-aws-native
License
Apache-2.0

We recommend new projects start with resources from the AWS provider.

AWS Cloud Control v1.26.0 published on Wednesday, Mar 12, 2025 by Pulumi
pulumi/pulumi-aws-native