aws.workspaces.WebUserSettings
Explore with Pulumi AI
Resource for managing an AWS WorkSpaces Web User Settings resource. Once associated with a web portal, user settings control how users can transfer data between a streaming session and their local devices.
Example Usage
Basic Usage
import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";
const example = new aws.workspaces.WebUserSettings("example", {
copyAllowed: "Enabled",
downloadAllowed: "Enabled",
pasteAllowed: "Enabled",
printAllowed: "Enabled",
uploadAllowed: "Enabled",
});
import pulumi
import pulumi_aws as aws
example = aws.workspaces.WebUserSettings("example",
copy_allowed="Enabled",
download_allowed="Enabled",
paste_allowed="Enabled",
print_allowed="Enabled",
upload_allowed="Enabled")
package main
import (
"github.com/pulumi/pulumi-aws/sdk/v6/go/aws/workspaces"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
_, err := workspaces.NewWebUserSettings(ctx, "example", &workspaces.WebUserSettingsArgs{
CopyAllowed: pulumi.String("Enabled"),
DownloadAllowed: pulumi.String("Enabled"),
PasteAllowed: pulumi.String("Enabled"),
PrintAllowed: pulumi.String("Enabled"),
UploadAllowed: pulumi.String("Enabled"),
})
if err != nil {
return err
}
return nil
})
}
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;
return await Deployment.RunAsync(() =>
{
var example = new Aws.Workspaces.WebUserSettings("example", new()
{
CopyAllowed = "Enabled",
DownloadAllowed = "Enabled",
PasteAllowed = "Enabled",
PrintAllowed = "Enabled",
UploadAllowed = "Enabled",
});
});
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.workspaces.WebUserSettings;
import com.pulumi.aws.workspaces.WebUserSettingsArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;
public class App {
public static void main(String[] args) {
Pulumi.run(App::stack);
}
public static void stack(Context ctx) {
var example = new WebUserSettings("example", WebUserSettingsArgs.builder()
.copyAllowed("Enabled")
.downloadAllowed("Enabled")
.pasteAllowed("Enabled")
.printAllowed("Enabled")
.uploadAllowed("Enabled")
.build());
}
}
resources:
example:
type: aws:workspaces:WebUserSettings
properties:
copyAllowed: Enabled
downloadAllowed: Enabled
pasteAllowed: Enabled
printAllowed: Enabled
uploadAllowed: Enabled
With Toolbar Configuration
import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";
const example = new aws.workspaces.WebUserSettings("example", {
copyAllowed: "Enabled",
downloadAllowed: "Enabled",
pasteAllowed: "Enabled",
printAllowed: "Enabled",
uploadAllowed: "Enabled",
toolbarConfiguration: {
toolbarType: "Docked",
visualMode: "Dark",
hiddenToolbarItems: [
"Webcam",
"Microphone",
],
},
});
import pulumi
import pulumi_aws as aws
example = aws.workspaces.WebUserSettings("example",
copy_allowed="Enabled",
download_allowed="Enabled",
paste_allowed="Enabled",
print_allowed="Enabled",
upload_allowed="Enabled",
toolbar_configuration={
"toolbar_type": "Docked",
"visual_mode": "Dark",
"hidden_toolbar_items": [
"Webcam",
"Microphone",
],
})
package main
import (
"github.com/pulumi/pulumi-aws/sdk/v6/go/aws/workspaces"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
_, err := workspaces.NewWebUserSettings(ctx, "example", &workspaces.WebUserSettingsArgs{
CopyAllowed: pulumi.String("Enabled"),
DownloadAllowed: pulumi.String("Enabled"),
PasteAllowed: pulumi.String("Enabled"),
PrintAllowed: pulumi.String("Enabled"),
UploadAllowed: pulumi.String("Enabled"),
ToolbarConfiguration: &workspaces.WebUserSettingsToolbarConfigurationArgs{
ToolbarType: pulumi.String("Docked"),
VisualMode: pulumi.String("Dark"),
HiddenToolbarItems: pulumi.StringArray{
pulumi.String("Webcam"),
pulumi.String("Microphone"),
},
},
})
if err != nil {
return err
}
return nil
})
}
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;
return await Deployment.RunAsync(() =>
{
var example = new Aws.Workspaces.WebUserSettings("example", new()
{
CopyAllowed = "Enabled",
DownloadAllowed = "Enabled",
PasteAllowed = "Enabled",
PrintAllowed = "Enabled",
UploadAllowed = "Enabled",
ToolbarConfiguration = new Aws.Workspaces.Inputs.WebUserSettingsToolbarConfigurationArgs
{
ToolbarType = "Docked",
VisualMode = "Dark",
HiddenToolbarItems = new[]
{
"Webcam",
"Microphone",
},
},
});
});
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.workspaces.WebUserSettings;
import com.pulumi.aws.workspaces.WebUserSettingsArgs;
import com.pulumi.aws.workspaces.inputs.WebUserSettingsToolbarConfigurationArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;
public class App {
public static void main(String[] args) {
Pulumi.run(App::stack);
}
public static void stack(Context ctx) {
var example = new WebUserSettings("example", WebUserSettingsArgs.builder()
.copyAllowed("Enabled")
.downloadAllowed("Enabled")
.pasteAllowed("Enabled")
.printAllowed("Enabled")
.uploadAllowed("Enabled")
.toolbarConfiguration(WebUserSettingsToolbarConfigurationArgs.builder()
.toolbarType("Docked")
.visualMode("Dark")
.hiddenToolbarItems(
"Webcam",
"Microphone")
.build())
.build());
}
}
resources:
example:
type: aws:workspaces:WebUserSettings
properties:
copyAllowed: Enabled
downloadAllowed: Enabled
pasteAllowed: Enabled
printAllowed: Enabled
uploadAllowed: Enabled
toolbarConfiguration:
toolbarType: Docked
visualMode: Dark
hiddenToolbarItems:
- Webcam
- Microphone
Complete Example
import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";
const example = new aws.kms.Key("example", {
description: "KMS key for WorkSpaces Web User Settings",
deletionWindowInDays: 7,
});
const exampleWebUserSettings = new aws.workspaces.WebUserSettings("example", {
copyAllowed: "Enabled",
downloadAllowed: "Enabled",
pasteAllowed: "Enabled",
printAllowed: "Enabled",
uploadAllowed: "Enabled",
deepLinkAllowed: "Enabled",
disconnectTimeoutInMinutes: 30,
idleDisconnectTimeoutInMinutes: 15,
customerManagedKey: example.arn,
additionalEncryptionContext: {
Environment: "Production",
},
toolbarConfiguration: {
toolbarType: "Docked",
visualMode: "Dark",
hiddenToolbarItems: [
"Webcam",
"Microphone",
],
maxDisplayResolution: "size1920X1080",
},
cookieSynchronizationConfiguration: {
allowlists: [{
domain: "example.com",
path: "/path",
}],
blocklists: [{
domain: "blocked.com",
}],
},
tags: {
Name: "example-user-settings",
},
});
import pulumi
import pulumi_aws as aws
example = aws.kms.Key("example",
description="KMS key for WorkSpaces Web User Settings",
deletion_window_in_days=7)
example_web_user_settings = aws.workspaces.WebUserSettings("example",
copy_allowed="Enabled",
download_allowed="Enabled",
paste_allowed="Enabled",
print_allowed="Enabled",
upload_allowed="Enabled",
deep_link_allowed="Enabled",
disconnect_timeout_in_minutes=30,
idle_disconnect_timeout_in_minutes=15,
customer_managed_key=example.arn,
additional_encryption_context={
"Environment": "Production",
},
toolbar_configuration={
"toolbar_type": "Docked",
"visual_mode": "Dark",
"hidden_toolbar_items": [
"Webcam",
"Microphone",
],
"max_display_resolution": "size1920X1080",
},
cookie_synchronization_configuration={
"allowlists": [{
"domain": "example.com",
"path": "/path",
}],
"blocklists": [{
"domain": "blocked.com",
}],
},
tags={
"Name": "example-user-settings",
})
package main
import (
"github.com/pulumi/pulumi-aws/sdk/v6/go/aws/kms"
"github.com/pulumi/pulumi-aws/sdk/v6/go/aws/workspaces"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
example, err := kms.NewKey(ctx, "example", &kms.KeyArgs{
Description: pulumi.String("KMS key for WorkSpaces Web User Settings"),
DeletionWindowInDays: pulumi.Int(7),
})
if err != nil {
return err
}
_, err = workspaces.NewWebUserSettings(ctx, "example", &workspaces.WebUserSettingsArgs{
CopyAllowed: pulumi.String("Enabled"),
DownloadAllowed: pulumi.String("Enabled"),
PasteAllowed: pulumi.String("Enabled"),
PrintAllowed: pulumi.String("Enabled"),
UploadAllowed: pulumi.String("Enabled"),
DeepLinkAllowed: pulumi.String("Enabled"),
DisconnectTimeoutInMinutes: pulumi.Int(30),
IdleDisconnectTimeoutInMinutes: pulumi.Int(15),
CustomerManagedKey: example.Arn,
AdditionalEncryptionContext: pulumi.StringMap{
"Environment": pulumi.String("Production"),
},
ToolbarConfiguration: &workspaces.WebUserSettingsToolbarConfigurationArgs{
ToolbarType: pulumi.String("Docked"),
VisualMode: pulumi.String("Dark"),
HiddenToolbarItems: pulumi.StringArray{
pulumi.String("Webcam"),
pulumi.String("Microphone"),
},
MaxDisplayResolution: pulumi.String("size1920X1080"),
},
CookieSynchronizationConfiguration: &workspaces.WebUserSettingsCookieSynchronizationConfigurationArgs{
Allowlists: workspaces.WebUserSettingsCookieSynchronizationConfigurationAllowlistArray{
&workspaces.WebUserSettingsCookieSynchronizationConfigurationAllowlistArgs{
Domain: pulumi.String("example.com"),
Path: pulumi.String("/path"),
},
},
Blocklists: workspaces.WebUserSettingsCookieSynchronizationConfigurationBlocklistArray{
&workspaces.WebUserSettingsCookieSynchronizationConfigurationBlocklistArgs{
Domain: pulumi.String("blocked.com"),
},
},
},
Tags: pulumi.StringMap{
"Name": pulumi.String("example-user-settings"),
},
})
if err != nil {
return err
}
return nil
})
}
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;
return await Deployment.RunAsync(() =>
{
var example = new Aws.Kms.Key("example", new()
{
Description = "KMS key for WorkSpaces Web User Settings",
DeletionWindowInDays = 7,
});
var exampleWebUserSettings = new Aws.Workspaces.WebUserSettings("example", new()
{
CopyAllowed = "Enabled",
DownloadAllowed = "Enabled",
PasteAllowed = "Enabled",
PrintAllowed = "Enabled",
UploadAllowed = "Enabled",
DeepLinkAllowed = "Enabled",
DisconnectTimeoutInMinutes = 30,
IdleDisconnectTimeoutInMinutes = 15,
CustomerManagedKey = example.Arn,
AdditionalEncryptionContext =
{
{ "Environment", "Production" },
},
ToolbarConfiguration = new Aws.Workspaces.Inputs.WebUserSettingsToolbarConfigurationArgs
{
ToolbarType = "Docked",
VisualMode = "Dark",
HiddenToolbarItems = new[]
{
"Webcam",
"Microphone",
},
MaxDisplayResolution = "size1920X1080",
},
CookieSynchronizationConfiguration = new Aws.Workspaces.Inputs.WebUserSettingsCookieSynchronizationConfigurationArgs
{
Allowlists = new[]
{
new Aws.Workspaces.Inputs.WebUserSettingsCookieSynchronizationConfigurationAllowlistArgs
{
Domain = "example.com",
Path = "/path",
},
},
Blocklists = new[]
{
new Aws.Workspaces.Inputs.WebUserSettingsCookieSynchronizationConfigurationBlocklistArgs
{
Domain = "blocked.com",
},
},
},
Tags =
{
{ "Name", "example-user-settings" },
},
});
});
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.kms.Key;
import com.pulumi.aws.kms.KeyArgs;
import com.pulumi.aws.workspaces.WebUserSettings;
import com.pulumi.aws.workspaces.WebUserSettingsArgs;
import com.pulumi.aws.workspaces.inputs.WebUserSettingsToolbarConfigurationArgs;
import com.pulumi.aws.workspaces.inputs.WebUserSettingsCookieSynchronizationConfigurationArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;
public class App {
public static void main(String[] args) {
Pulumi.run(App::stack);
}
public static void stack(Context ctx) {
var example = new Key("example", KeyArgs.builder()
.description("KMS key for WorkSpaces Web User Settings")
.deletionWindowInDays(7)
.build());
var exampleWebUserSettings = new WebUserSettings("exampleWebUserSettings", WebUserSettingsArgs.builder()
.copyAllowed("Enabled")
.downloadAllowed("Enabled")
.pasteAllowed("Enabled")
.printAllowed("Enabled")
.uploadAllowed("Enabled")
.deepLinkAllowed("Enabled")
.disconnectTimeoutInMinutes(30)
.idleDisconnectTimeoutInMinutes(15)
.customerManagedKey(example.arn())
.additionalEncryptionContext(Map.of("Environment", "Production"))
.toolbarConfiguration(WebUserSettingsToolbarConfigurationArgs.builder()
.toolbarType("Docked")
.visualMode("Dark")
.hiddenToolbarItems(
"Webcam",
"Microphone")
.maxDisplayResolution("size1920X1080")
.build())
.cookieSynchronizationConfiguration(WebUserSettingsCookieSynchronizationConfigurationArgs.builder()
.allowlists(WebUserSettingsCookieSynchronizationConfigurationAllowlistArgs.builder()
.domain("example.com")
.path("/path")
.build())
.blocklists(WebUserSettingsCookieSynchronizationConfigurationBlocklistArgs.builder()
.domain("blocked.com")
.build())
.build())
.tags(Map.of("Name", "example-user-settings"))
.build());
}
}
resources:
example:
type: aws:kms:Key
properties:
description: KMS key for WorkSpaces Web User Settings
deletionWindowInDays: 7
exampleWebUserSettings:
type: aws:workspaces:WebUserSettings
name: example
properties:
copyAllowed: Enabled
downloadAllowed: Enabled
pasteAllowed: Enabled
printAllowed: Enabled
uploadAllowed: Enabled
deepLinkAllowed: Enabled
disconnectTimeoutInMinutes: 30
idleDisconnectTimeoutInMinutes: 15
customerManagedKey: ${example.arn}
additionalEncryptionContext:
Environment: Production
toolbarConfiguration:
toolbarType: Docked
visualMode: Dark
hiddenToolbarItems:
- Webcam
- Microphone
maxDisplayResolution: size1920X1080
cookieSynchronizationConfiguration:
allowlists:
- domain: example.com
path: /path
blocklists:
- domain: blocked.com
tags:
Name: example-user-settings
Create WebUserSettings Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new WebUserSettings(name: string, args: WebUserSettingsArgs, opts?: CustomResourceOptions);
@overload
def WebUserSettings(resource_name: str,
args: WebUserSettingsArgs,
opts: Optional[ResourceOptions] = None)
@overload
def WebUserSettings(resource_name: str,
opts: Optional[ResourceOptions] = None,
print_allowed: Optional[str] = None,
copy_allowed: Optional[str] = None,
download_allowed: Optional[str] = None,
paste_allowed: Optional[str] = None,
upload_allowed: Optional[str] = None,
cookie_synchronization_configuration: Optional[WebUserSettingsCookieSynchronizationConfigurationArgs] = None,
customer_managed_key: Optional[str] = None,
deep_link_allowed: Optional[str] = None,
disconnect_timeout_in_minutes: Optional[int] = None,
idle_disconnect_timeout_in_minutes: Optional[int] = None,
additional_encryption_context: Optional[Mapping[str, str]] = None,
tags: Optional[Mapping[str, str]] = None,
toolbar_configuration: Optional[WebUserSettingsToolbarConfigurationArgs] = None)
func NewWebUserSettings(ctx *Context, name string, args WebUserSettingsArgs, opts ...ResourceOption) (*WebUserSettings, error)
public WebUserSettings(string name, WebUserSettingsArgs args, CustomResourceOptions? opts = null)
public WebUserSettings(String name, WebUserSettingsArgs args)
public WebUserSettings(String name, WebUserSettingsArgs args, CustomResourceOptions options)
type: aws:workspaces:WebUserSettings
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 WebUserSettingsArgs
- 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 WebUserSettingsArgs
- 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 WebUserSettingsArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args WebUserSettingsArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args WebUserSettingsArgs
- The arguments to resource properties.
- options CustomResourceOptions
- Bag of options to control resource's behavior.
Constructor example
The following reference example uses placeholder values for all input properties.
var webUserSettingsResource = new Aws.Workspaces.WebUserSettings("webUserSettingsResource", new()
{
PrintAllowed = "string",
CopyAllowed = "string",
DownloadAllowed = "string",
PasteAllowed = "string",
UploadAllowed = "string",
CookieSynchronizationConfiguration = new Aws.Workspaces.Inputs.WebUserSettingsCookieSynchronizationConfigurationArgs
{
Allowlists = new[]
{
new Aws.Workspaces.Inputs.WebUserSettingsCookieSynchronizationConfigurationAllowlistArgs
{
Domain = "string",
Name = "string",
Path = "string",
},
},
Blocklists = new[]
{
new Aws.Workspaces.Inputs.WebUserSettingsCookieSynchronizationConfigurationBlocklistArgs
{
Domain = "string",
Name = "string",
Path = "string",
},
},
},
CustomerManagedKey = "string",
DeepLinkAllowed = "string",
DisconnectTimeoutInMinutes = 0,
IdleDisconnectTimeoutInMinutes = 0,
AdditionalEncryptionContext =
{
{ "string", "string" },
},
Tags =
{
{ "string", "string" },
},
ToolbarConfiguration = new Aws.Workspaces.Inputs.WebUserSettingsToolbarConfigurationArgs
{
HiddenToolbarItems = new[]
{
"string",
},
MaxDisplayResolution = "string",
ToolbarType = "string",
VisualMode = "string",
},
});
example, err := workspaces.NewWebUserSettings(ctx, "webUserSettingsResource", &workspaces.WebUserSettingsArgs{
PrintAllowed: pulumi.String("string"),
CopyAllowed: pulumi.String("string"),
DownloadAllowed: pulumi.String("string"),
PasteAllowed: pulumi.String("string"),
UploadAllowed: pulumi.String("string"),
CookieSynchronizationConfiguration: &workspaces.WebUserSettingsCookieSynchronizationConfigurationArgs{
Allowlists: workspaces.WebUserSettingsCookieSynchronizationConfigurationAllowlistArray{
&workspaces.WebUserSettingsCookieSynchronizationConfigurationAllowlistArgs{
Domain: pulumi.String("string"),
Name: pulumi.String("string"),
Path: pulumi.String("string"),
},
},
Blocklists: workspaces.WebUserSettingsCookieSynchronizationConfigurationBlocklistArray{
&workspaces.WebUserSettingsCookieSynchronizationConfigurationBlocklistArgs{
Domain: pulumi.String("string"),
Name: pulumi.String("string"),
Path: pulumi.String("string"),
},
},
},
CustomerManagedKey: pulumi.String("string"),
DeepLinkAllowed: pulumi.String("string"),
DisconnectTimeoutInMinutes: pulumi.Int(0),
IdleDisconnectTimeoutInMinutes: pulumi.Int(0),
AdditionalEncryptionContext: pulumi.StringMap{
"string": pulumi.String("string"),
},
Tags: pulumi.StringMap{
"string": pulumi.String("string"),
},
ToolbarConfiguration: &workspaces.WebUserSettingsToolbarConfigurationArgs{
HiddenToolbarItems: pulumi.StringArray{
pulumi.String("string"),
},
MaxDisplayResolution: pulumi.String("string"),
ToolbarType: pulumi.String("string"),
VisualMode: pulumi.String("string"),
},
})
var webUserSettingsResource = new WebUserSettings("webUserSettingsResource", WebUserSettingsArgs.builder()
.printAllowed("string")
.copyAllowed("string")
.downloadAllowed("string")
.pasteAllowed("string")
.uploadAllowed("string")
.cookieSynchronizationConfiguration(WebUserSettingsCookieSynchronizationConfigurationArgs.builder()
.allowlists(WebUserSettingsCookieSynchronizationConfigurationAllowlistArgs.builder()
.domain("string")
.name("string")
.path("string")
.build())
.blocklists(WebUserSettingsCookieSynchronizationConfigurationBlocklistArgs.builder()
.domain("string")
.name("string")
.path("string")
.build())
.build())
.customerManagedKey("string")
.deepLinkAllowed("string")
.disconnectTimeoutInMinutes(0)
.idleDisconnectTimeoutInMinutes(0)
.additionalEncryptionContext(Map.of("string", "string"))
.tags(Map.of("string", "string"))
.toolbarConfiguration(WebUserSettingsToolbarConfigurationArgs.builder()
.hiddenToolbarItems("string")
.maxDisplayResolution("string")
.toolbarType("string")
.visualMode("string")
.build())
.build());
web_user_settings_resource = aws.workspaces.WebUserSettings("webUserSettingsResource",
print_allowed="string",
copy_allowed="string",
download_allowed="string",
paste_allowed="string",
upload_allowed="string",
cookie_synchronization_configuration={
"allowlists": [{
"domain": "string",
"name": "string",
"path": "string",
}],
"blocklists": [{
"domain": "string",
"name": "string",
"path": "string",
}],
},
customer_managed_key="string",
deep_link_allowed="string",
disconnect_timeout_in_minutes=0,
idle_disconnect_timeout_in_minutes=0,
additional_encryption_context={
"string": "string",
},
tags={
"string": "string",
},
toolbar_configuration={
"hidden_toolbar_items": ["string"],
"max_display_resolution": "string",
"toolbar_type": "string",
"visual_mode": "string",
})
const webUserSettingsResource = new aws.workspaces.WebUserSettings("webUserSettingsResource", {
printAllowed: "string",
copyAllowed: "string",
downloadAllowed: "string",
pasteAllowed: "string",
uploadAllowed: "string",
cookieSynchronizationConfiguration: {
allowlists: [{
domain: "string",
name: "string",
path: "string",
}],
blocklists: [{
domain: "string",
name: "string",
path: "string",
}],
},
customerManagedKey: "string",
deepLinkAllowed: "string",
disconnectTimeoutInMinutes: 0,
idleDisconnectTimeoutInMinutes: 0,
additionalEncryptionContext: {
string: "string",
},
tags: {
string: "string",
},
toolbarConfiguration: {
hiddenToolbarItems: ["string"],
maxDisplayResolution: "string",
toolbarType: "string",
visualMode: "string",
},
});
type: aws:workspaces:WebUserSettings
properties:
additionalEncryptionContext:
string: string
cookieSynchronizationConfiguration:
allowlists:
- domain: string
name: string
path: string
blocklists:
- domain: string
name: string
path: string
copyAllowed: string
customerManagedKey: string
deepLinkAllowed: string
disconnectTimeoutInMinutes: 0
downloadAllowed: string
idleDisconnectTimeoutInMinutes: 0
pasteAllowed: string
printAllowed: string
tags:
string: string
toolbarConfiguration:
hiddenToolbarItems:
- string
maxDisplayResolution: string
toolbarType: string
visualMode: string
uploadAllowed: string
WebUserSettings 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 WebUserSettings resource accepts the following input properties:
- Copy
Allowed string - Specifies whether the user can copy text from the streaming session to the local device. Valid values are
Enabled
orDisabled
. - Download
Allowed string - Specifies whether the user can download files from the streaming session to the local device. Valid values are
Enabled
orDisabled
. - Paste
Allowed string - Specifies whether the user can paste text from the local device to the streaming session. Valid values are
Enabled
orDisabled
. - Print
Allowed string - Specifies whether the user can print to the local device. Valid values are
Enabled
orDisabled
. - Upload
Allowed string Specifies whether the user can upload files from the local device to the streaming session. Valid values are
Enabled
orDisabled
.The following arguments are optional:
- Additional
Encryption Dictionary<string, string>Context - Additional encryption context for the user settings.
- Web
User Settings Cookie Synchronization Configuration - Configuration that specifies which cookies should be synchronized from the end user's local browser to the remote browser. Detailed below.
- Customer
Managed stringKey - ARN of the customer managed KMS key.
- Deep
Link stringAllowed - Specifies whether the user can use deep links that open automatically when connecting to a session. Valid values are
Enabled
orDisabled
. - Disconnect
Timeout intIn Minutes - Amount of time that a streaming session remains active after users disconnect. Value must be between 1 and 600 minutes.
- Idle
Disconnect intTimeout In Minutes - Amount of time that users can be idle before they are disconnected from their streaming session. Value must be between 0 and 60 minutes.
- Dictionary<string, string>
- Map of tags assigned to the resource. If configured with a provider
default_tags
configuration block present, tags with matching keys will overwrite those defined at the provider-level. - Toolbar
Configuration WebUser Settings Toolbar Configuration - Configuration of the toolbar. Detailed below.
- Copy
Allowed string - Specifies whether the user can copy text from the streaming session to the local device. Valid values are
Enabled
orDisabled
. - Download
Allowed string - Specifies whether the user can download files from the streaming session to the local device. Valid values are
Enabled
orDisabled
. - Paste
Allowed string - Specifies whether the user can paste text from the local device to the streaming session. Valid values are
Enabled
orDisabled
. - Print
Allowed string - Specifies whether the user can print to the local device. Valid values are
Enabled
orDisabled
. - Upload
Allowed string Specifies whether the user can upload files from the local device to the streaming session. Valid values are
Enabled
orDisabled
.The following arguments are optional:
- Additional
Encryption map[string]stringContext - Additional encryption context for the user settings.
- Web
User Settings Cookie Synchronization Configuration Args - Configuration that specifies which cookies should be synchronized from the end user's local browser to the remote browser. Detailed below.
- Customer
Managed stringKey - ARN of the customer managed KMS key.
- Deep
Link stringAllowed - Specifies whether the user can use deep links that open automatically when connecting to a session. Valid values are
Enabled
orDisabled
. - Disconnect
Timeout intIn Minutes - Amount of time that a streaming session remains active after users disconnect. Value must be between 1 and 600 minutes.
- Idle
Disconnect intTimeout In Minutes - Amount of time that users can be idle before they are disconnected from their streaming session. Value must be between 0 and 60 minutes.
- map[string]string
- Map of tags assigned to the resource. If configured with a provider
default_tags
configuration block present, tags with matching keys will overwrite those defined at the provider-level. - Toolbar
Configuration WebUser Settings Toolbar Configuration Args - Configuration of the toolbar. Detailed below.
- copy
Allowed String - Specifies whether the user can copy text from the streaming session to the local device. Valid values are
Enabled
orDisabled
. - download
Allowed String - Specifies whether the user can download files from the streaming session to the local device. Valid values are
Enabled
orDisabled
. - paste
Allowed String - Specifies whether the user can paste text from the local device to the streaming session. Valid values are
Enabled
orDisabled
. - print
Allowed String - Specifies whether the user can print to the local device. Valid values are
Enabled
orDisabled
. - upload
Allowed String Specifies whether the user can upload files from the local device to the streaming session. Valid values are
Enabled
orDisabled
.The following arguments are optional:
- additional
Encryption Map<String,String>Context - Additional encryption context for the user settings.
- Web
User Settings Cookie Synchronization Configuration - Configuration that specifies which cookies should be synchronized from the end user's local browser to the remote browser. Detailed below.
- customer
Managed StringKey - ARN of the customer managed KMS key.
- deep
Link StringAllowed - Specifies whether the user can use deep links that open automatically when connecting to a session. Valid values are
Enabled
orDisabled
. - disconnect
Timeout IntegerIn Minutes - Amount of time that a streaming session remains active after users disconnect. Value must be between 1 and 600 minutes.
- idle
Disconnect IntegerTimeout In Minutes - Amount of time that users can be idle before they are disconnected from their streaming session. Value must be between 0 and 60 minutes.
- Map<String,String>
- Map of tags assigned to the resource. If configured with a provider
default_tags
configuration block present, tags with matching keys will overwrite those defined at the provider-level. - toolbar
Configuration WebUser Settings Toolbar Configuration - Configuration of the toolbar. Detailed below.
- copy
Allowed string - Specifies whether the user can copy text from the streaming session to the local device. Valid values are
Enabled
orDisabled
. - download
Allowed string - Specifies whether the user can download files from the streaming session to the local device. Valid values are
Enabled
orDisabled
. - paste
Allowed string - Specifies whether the user can paste text from the local device to the streaming session. Valid values are
Enabled
orDisabled
. - print
Allowed string - Specifies whether the user can print to the local device. Valid values are
Enabled
orDisabled
. - upload
Allowed string Specifies whether the user can upload files from the local device to the streaming session. Valid values are
Enabled
orDisabled
.The following arguments are optional:
- additional
Encryption {[key: string]: string}Context - Additional encryption context for the user settings.
- Web
User Settings Cookie Synchronization Configuration - Configuration that specifies which cookies should be synchronized from the end user's local browser to the remote browser. Detailed below.
- customer
Managed stringKey - ARN of the customer managed KMS key.
- deep
Link stringAllowed - Specifies whether the user can use deep links that open automatically when connecting to a session. Valid values are
Enabled
orDisabled
. - disconnect
Timeout numberIn Minutes - Amount of time that a streaming session remains active after users disconnect. Value must be between 1 and 600 minutes.
- idle
Disconnect numberTimeout In Minutes - Amount of time that users can be idle before they are disconnected from their streaming session. Value must be between 0 and 60 minutes.
- {[key: string]: string}
- Map of tags assigned to the resource. If configured with a provider
default_tags
configuration block present, tags with matching keys will overwrite those defined at the provider-level. - toolbar
Configuration WebUser Settings Toolbar Configuration - Configuration of the toolbar. Detailed below.
- copy_
allowed str - Specifies whether the user can copy text from the streaming session to the local device. Valid values are
Enabled
orDisabled
. - download_
allowed str - Specifies whether the user can download files from the streaming session to the local device. Valid values are
Enabled
orDisabled
. - paste_
allowed str - Specifies whether the user can paste text from the local device to the streaming session. Valid values are
Enabled
orDisabled
. - print_
allowed str - Specifies whether the user can print to the local device. Valid values are
Enabled
orDisabled
. - upload_
allowed str Specifies whether the user can upload files from the local device to the streaming session. Valid values are
Enabled
orDisabled
.The following arguments are optional:
- additional_
encryption_ Mapping[str, str]context - Additional encryption context for the user settings.
- Web
User Settings Cookie Synchronization Configuration Args - Configuration that specifies which cookies should be synchronized from the end user's local browser to the remote browser. Detailed below.
- customer_
managed_ strkey - ARN of the customer managed KMS key.
- deep_
link_ strallowed - Specifies whether the user can use deep links that open automatically when connecting to a session. Valid values are
Enabled
orDisabled
. - disconnect_
timeout_ intin_ minutes - Amount of time that a streaming session remains active after users disconnect. Value must be between 1 and 600 minutes.
- idle_
disconnect_ inttimeout_ in_ minutes - Amount of time that users can be idle before they are disconnected from their streaming session. Value must be between 0 and 60 minutes.
- Mapping[str, str]
- Map of tags assigned to the resource. If configured with a provider
default_tags
configuration block present, tags with matching keys will overwrite those defined at the provider-level. - toolbar_
configuration WebUser Settings Toolbar Configuration Args - Configuration of the toolbar. Detailed below.
- copy
Allowed String - Specifies whether the user can copy text from the streaming session to the local device. Valid values are
Enabled
orDisabled
. - download
Allowed String - Specifies whether the user can download files from the streaming session to the local device. Valid values are
Enabled
orDisabled
. - paste
Allowed String - Specifies whether the user can paste text from the local device to the streaming session. Valid values are
Enabled
orDisabled
. - print
Allowed String - Specifies whether the user can print to the local device. Valid values are
Enabled
orDisabled
. - upload
Allowed String Specifies whether the user can upload files from the local device to the streaming session. Valid values are
Enabled
orDisabled
.The following arguments are optional:
- additional
Encryption Map<String>Context - Additional encryption context for the user settings.
- Property Map
- Configuration that specifies which cookies should be synchronized from the end user's local browser to the remote browser. Detailed below.
- customer
Managed StringKey - ARN of the customer managed KMS key.
- deep
Link StringAllowed - Specifies whether the user can use deep links that open automatically when connecting to a session. Valid values are
Enabled
orDisabled
. - disconnect
Timeout NumberIn Minutes - Amount of time that a streaming session remains active after users disconnect. Value must be between 1 and 600 minutes.
- idle
Disconnect NumberTimeout In Minutes - Amount of time that users can be idle before they are disconnected from their streaming session. Value must be between 0 and 60 minutes.
- Map<String>
- Map of tags assigned to the resource. If configured with a provider
default_tags
configuration block present, tags with matching keys will overwrite those defined at the provider-level. - toolbar
Configuration Property Map - Configuration of the toolbar. Detailed below.
Outputs
All input properties are implicitly available as output properties. Additionally, the WebUserSettings resource produces the following output properties:
- Associated
Portal List<string>Arns - List of web portal ARNs to associate with the user settings.
- Id string
- The provider-assigned unique ID for this managed resource.
- Dictionary<string, string>
- Map of tags assigned to the resource, including those inherited from the provider
default_tags
configuration block. - User
Settings stringArn - ARN of the user settings resource.
- Associated
Portal []stringArns - List of web portal ARNs to associate with the user settings.
- Id string
- The provider-assigned unique ID for this managed resource.
- map[string]string
- Map of tags assigned to the resource, including those inherited from the provider
default_tags
configuration block. - User
Settings stringArn - ARN of the user settings resource.
- associated
Portal List<String>Arns - List of web portal ARNs to associate with the user settings.
- id String
- The provider-assigned unique ID for this managed resource.
- Map<String,String>
- Map of tags assigned to the resource, including those inherited from the provider
default_tags
configuration block. - user
Settings StringArn - ARN of the user settings resource.
- associated
Portal string[]Arns - List of web portal ARNs to associate with the user settings.
- id string
- The provider-assigned unique ID for this managed resource.
- {[key: string]: string}
- Map of tags assigned to the resource, including those inherited from the provider
default_tags
configuration block. - user
Settings stringArn - ARN of the user settings resource.
- associated_
portal_ Sequence[str]arns - List of web portal ARNs to associate with the user settings.
- id str
- The provider-assigned unique ID for this managed resource.
- Mapping[str, str]
- Map of tags assigned to the resource, including those inherited from the provider
default_tags
configuration block. - user_
settings_ strarn - ARN of the user settings resource.
- associated
Portal List<String>Arns - List of web portal ARNs to associate with the user settings.
- id String
- The provider-assigned unique ID for this managed resource.
- Map<String>
- Map of tags assigned to the resource, including those inherited from the provider
default_tags
configuration block. - user
Settings StringArn - ARN of the user settings resource.
Look up Existing WebUserSettings Resource
Get an existing WebUserSettings resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.
public static get(name: string, id: Input<ID>, state?: WebUserSettingsState, opts?: CustomResourceOptions): WebUserSettings
@staticmethod
def get(resource_name: str,
id: str,
opts: Optional[ResourceOptions] = None,
additional_encryption_context: Optional[Mapping[str, str]] = None,
associated_portal_arns: Optional[Sequence[str]] = None,
cookie_synchronization_configuration: Optional[WebUserSettingsCookieSynchronizationConfigurationArgs] = None,
copy_allowed: Optional[str] = None,
customer_managed_key: Optional[str] = None,
deep_link_allowed: Optional[str] = None,
disconnect_timeout_in_minutes: Optional[int] = None,
download_allowed: Optional[str] = None,
idle_disconnect_timeout_in_minutes: Optional[int] = None,
paste_allowed: Optional[str] = None,
print_allowed: Optional[str] = None,
tags: Optional[Mapping[str, str]] = None,
tags_all: Optional[Mapping[str, str]] = None,
toolbar_configuration: Optional[WebUserSettingsToolbarConfigurationArgs] = None,
upload_allowed: Optional[str] = None,
user_settings_arn: Optional[str] = None) -> WebUserSettings
func GetWebUserSettings(ctx *Context, name string, id IDInput, state *WebUserSettingsState, opts ...ResourceOption) (*WebUserSettings, error)
public static WebUserSettings Get(string name, Input<string> id, WebUserSettingsState? state, CustomResourceOptions? opts = null)
public static WebUserSettings get(String name, Output<String> id, WebUserSettingsState state, CustomResourceOptions options)
resources: _: type: aws:workspaces:WebUserSettings get: id: ${id}
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- resource_name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- Additional
Encryption Dictionary<string, string>Context - Additional encryption context for the user settings.
- Associated
Portal List<string>Arns - List of web portal ARNs to associate with the user settings.
- Web
User Settings Cookie Synchronization Configuration - Configuration that specifies which cookies should be synchronized from the end user's local browser to the remote browser. Detailed below.
- Copy
Allowed string - Specifies whether the user can copy text from the streaming session to the local device. Valid values are
Enabled
orDisabled
. - Customer
Managed stringKey - ARN of the customer managed KMS key.
- Deep
Link stringAllowed - Specifies whether the user can use deep links that open automatically when connecting to a session. Valid values are
Enabled
orDisabled
. - Disconnect
Timeout intIn Minutes - Amount of time that a streaming session remains active after users disconnect. Value must be between 1 and 600 minutes.
- Download
Allowed string - Specifies whether the user can download files from the streaming session to the local device. Valid values are
Enabled
orDisabled
. - Idle
Disconnect intTimeout In Minutes - Amount of time that users can be idle before they are disconnected from their streaming session. Value must be between 0 and 60 minutes.
- Paste
Allowed string - Specifies whether the user can paste text from the local device to the streaming session. Valid values are
Enabled
orDisabled
. - Print
Allowed string - Specifies whether the user can print to the local device. Valid values are
Enabled
orDisabled
. - Dictionary<string, string>
- Map of tags assigned to the resource. If configured with a provider
default_tags
configuration block present, tags with matching keys will overwrite those defined at the provider-level. - Dictionary<string, string>
- Map of tags assigned to the resource, including those inherited from the provider
default_tags
configuration block. - Toolbar
Configuration WebUser Settings Toolbar Configuration - Configuration of the toolbar. Detailed below.
- Upload
Allowed string Specifies whether the user can upload files from the local device to the streaming session. Valid values are
Enabled
orDisabled
.The following arguments are optional:
- User
Settings stringArn - ARN of the user settings resource.
- Additional
Encryption map[string]stringContext - Additional encryption context for the user settings.
- Associated
Portal []stringArns - List of web portal ARNs to associate with the user settings.
- Web
User Settings Cookie Synchronization Configuration Args - Configuration that specifies which cookies should be synchronized from the end user's local browser to the remote browser. Detailed below.
- Copy
Allowed string - Specifies whether the user can copy text from the streaming session to the local device. Valid values are
Enabled
orDisabled
. - Customer
Managed stringKey - ARN of the customer managed KMS key.
- Deep
Link stringAllowed - Specifies whether the user can use deep links that open automatically when connecting to a session. Valid values are
Enabled
orDisabled
. - Disconnect
Timeout intIn Minutes - Amount of time that a streaming session remains active after users disconnect. Value must be between 1 and 600 minutes.
- Download
Allowed string - Specifies whether the user can download files from the streaming session to the local device. Valid values are
Enabled
orDisabled
. - Idle
Disconnect intTimeout In Minutes - Amount of time that users can be idle before they are disconnected from their streaming session. Value must be between 0 and 60 minutes.
- Paste
Allowed string - Specifies whether the user can paste text from the local device to the streaming session. Valid values are
Enabled
orDisabled
. - Print
Allowed string - Specifies whether the user can print to the local device. Valid values are
Enabled
orDisabled
. - map[string]string
- Map of tags assigned to the resource. If configured with a provider
default_tags
configuration block present, tags with matching keys will overwrite those defined at the provider-level. - map[string]string
- Map of tags assigned to the resource, including those inherited from the provider
default_tags
configuration block. - Toolbar
Configuration WebUser Settings Toolbar Configuration Args - Configuration of the toolbar. Detailed below.
- Upload
Allowed string Specifies whether the user can upload files from the local device to the streaming session. Valid values are
Enabled
orDisabled
.The following arguments are optional:
- User
Settings stringArn - ARN of the user settings resource.
- additional
Encryption Map<String,String>Context - Additional encryption context for the user settings.
- associated
Portal List<String>Arns - List of web portal ARNs to associate with the user settings.
- Web
User Settings Cookie Synchronization Configuration - Configuration that specifies which cookies should be synchronized from the end user's local browser to the remote browser. Detailed below.
- copy
Allowed String - Specifies whether the user can copy text from the streaming session to the local device. Valid values are
Enabled
orDisabled
. - customer
Managed StringKey - ARN of the customer managed KMS key.
- deep
Link StringAllowed - Specifies whether the user can use deep links that open automatically when connecting to a session. Valid values are
Enabled
orDisabled
. - disconnect
Timeout IntegerIn Minutes - Amount of time that a streaming session remains active after users disconnect. Value must be between 1 and 600 minutes.
- download
Allowed String - Specifies whether the user can download files from the streaming session to the local device. Valid values are
Enabled
orDisabled
. - idle
Disconnect IntegerTimeout In Minutes - Amount of time that users can be idle before they are disconnected from their streaming session. Value must be between 0 and 60 minutes.
- paste
Allowed String - Specifies whether the user can paste text from the local device to the streaming session. Valid values are
Enabled
orDisabled
. - print
Allowed String - Specifies whether the user can print to the local device. Valid values are
Enabled
orDisabled
. - Map<String,String>
- Map of tags assigned to the resource. If configured with a provider
default_tags
configuration block present, tags with matching keys will overwrite those defined at the provider-level. - Map<String,String>
- Map of tags assigned to the resource, including those inherited from the provider
default_tags
configuration block. - toolbar
Configuration WebUser Settings Toolbar Configuration - Configuration of the toolbar. Detailed below.
- upload
Allowed String Specifies whether the user can upload files from the local device to the streaming session. Valid values are
Enabled
orDisabled
.The following arguments are optional:
- user
Settings StringArn - ARN of the user settings resource.
- additional
Encryption {[key: string]: string}Context - Additional encryption context for the user settings.
- associated
Portal string[]Arns - List of web portal ARNs to associate with the user settings.
- Web
User Settings Cookie Synchronization Configuration - Configuration that specifies which cookies should be synchronized from the end user's local browser to the remote browser. Detailed below.
- copy
Allowed string - Specifies whether the user can copy text from the streaming session to the local device. Valid values are
Enabled
orDisabled
. - customer
Managed stringKey - ARN of the customer managed KMS key.
- deep
Link stringAllowed - Specifies whether the user can use deep links that open automatically when connecting to a session. Valid values are
Enabled
orDisabled
. - disconnect
Timeout numberIn Minutes - Amount of time that a streaming session remains active after users disconnect. Value must be between 1 and 600 minutes.
- download
Allowed string - Specifies whether the user can download files from the streaming session to the local device. Valid values are
Enabled
orDisabled
. - idle
Disconnect numberTimeout In Minutes - Amount of time that users can be idle before they are disconnected from their streaming session. Value must be between 0 and 60 minutes.
- paste
Allowed string - Specifies whether the user can paste text from the local device to the streaming session. Valid values are
Enabled
orDisabled
. - print
Allowed string - Specifies whether the user can print to the local device. Valid values are
Enabled
orDisabled
. - {[key: string]: string}
- Map of tags assigned to the resource. If configured with a provider
default_tags
configuration block present, tags with matching keys will overwrite those defined at the provider-level. - {[key: string]: string}
- Map of tags assigned to the resource, including those inherited from the provider
default_tags
configuration block. - toolbar
Configuration WebUser Settings Toolbar Configuration - Configuration of the toolbar. Detailed below.
- upload
Allowed string Specifies whether the user can upload files from the local device to the streaming session. Valid values are
Enabled
orDisabled
.The following arguments are optional:
- user
Settings stringArn - ARN of the user settings resource.
- additional_
encryption_ Mapping[str, str]context - Additional encryption context for the user settings.
- associated_
portal_ Sequence[str]arns - List of web portal ARNs to associate with the user settings.
- Web
User Settings Cookie Synchronization Configuration Args - Configuration that specifies which cookies should be synchronized from the end user's local browser to the remote browser. Detailed below.
- copy_
allowed str - Specifies whether the user can copy text from the streaming session to the local device. Valid values are
Enabled
orDisabled
. - customer_
managed_ strkey - ARN of the customer managed KMS key.
- deep_
link_ strallowed - Specifies whether the user can use deep links that open automatically when connecting to a session. Valid values are
Enabled
orDisabled
. - disconnect_
timeout_ intin_ minutes - Amount of time that a streaming session remains active after users disconnect. Value must be between 1 and 600 minutes.
- download_
allowed str - Specifies whether the user can download files from the streaming session to the local device. Valid values are
Enabled
orDisabled
. - idle_
disconnect_ inttimeout_ in_ minutes - Amount of time that users can be idle before they are disconnected from their streaming session. Value must be between 0 and 60 minutes.
- paste_
allowed str - Specifies whether the user can paste text from the local device to the streaming session. Valid values are
Enabled
orDisabled
. - print_
allowed str - Specifies whether the user can print to the local device. Valid values are
Enabled
orDisabled
. - Mapping[str, str]
- Map of tags assigned to the resource. If configured with a provider
default_tags
configuration block present, tags with matching keys will overwrite those defined at the provider-level. - Mapping[str, str]
- Map of tags assigned to the resource, including those inherited from the provider
default_tags
configuration block. - toolbar_
configuration WebUser Settings Toolbar Configuration Args - Configuration of the toolbar. Detailed below.
- upload_
allowed str Specifies whether the user can upload files from the local device to the streaming session. Valid values are
Enabled
orDisabled
.The following arguments are optional:
- user_
settings_ strarn - ARN of the user settings resource.
- additional
Encryption Map<String>Context - Additional encryption context for the user settings.
- associated
Portal List<String>Arns - List of web portal ARNs to associate with the user settings.
- Property Map
- Configuration that specifies which cookies should be synchronized from the end user's local browser to the remote browser. Detailed below.
- copy
Allowed String - Specifies whether the user can copy text from the streaming session to the local device. Valid values are
Enabled
orDisabled
. - customer
Managed StringKey - ARN of the customer managed KMS key.
- deep
Link StringAllowed - Specifies whether the user can use deep links that open automatically when connecting to a session. Valid values are
Enabled
orDisabled
. - disconnect
Timeout NumberIn Minutes - Amount of time that a streaming session remains active after users disconnect. Value must be between 1 and 600 minutes.
- download
Allowed String - Specifies whether the user can download files from the streaming session to the local device. Valid values are
Enabled
orDisabled
. - idle
Disconnect NumberTimeout In Minutes - Amount of time that users can be idle before they are disconnected from their streaming session. Value must be between 0 and 60 minutes.
- paste
Allowed String - Specifies whether the user can paste text from the local device to the streaming session. Valid values are
Enabled
orDisabled
. - print
Allowed String - Specifies whether the user can print to the local device. Valid values are
Enabled
orDisabled
. - Map<String>
- Map of tags assigned to the resource. If configured with a provider
default_tags
configuration block present, tags with matching keys will overwrite those defined at the provider-level. - Map<String>
- Map of tags assigned to the resource, including those inherited from the provider
default_tags
configuration block. - toolbar
Configuration Property Map - Configuration of the toolbar. Detailed below.
- upload
Allowed String Specifies whether the user can upload files from the local device to the streaming session. Valid values are
Enabled
orDisabled
.The following arguments are optional:
- user
Settings StringArn - ARN of the user settings resource.
Supporting Types
WebUserSettingsCookieSynchronizationConfiguration, WebUserSettingsCookieSynchronizationConfigurationArgs
- Allowlists
List<Web
User Settings Cookie Synchronization Configuration Allowlist> - List of cookie specifications that are allowed to be synchronized to the remote browser.
- Blocklists
List<Web
User Settings Cookie Synchronization Configuration Blocklist> - List of cookie specifications that are blocked from being synchronized to the remote browser.
- Allowlists
[]Web
User Settings Cookie Synchronization Configuration Allowlist - List of cookie specifications that are allowed to be synchronized to the remote browser.
- Blocklists
[]Web
User Settings Cookie Synchronization Configuration Blocklist - List of cookie specifications that are blocked from being synchronized to the remote browser.
- allowlists
List<Web
User Settings Cookie Synchronization Configuration Allowlist> - List of cookie specifications that are allowed to be synchronized to the remote browser.
- blocklists
List<Web
User Settings Cookie Synchronization Configuration Blocklist> - List of cookie specifications that are blocked from being synchronized to the remote browser.
- allowlists
Web
User Settings Cookie Synchronization Configuration Allowlist[] - List of cookie specifications that are allowed to be synchronized to the remote browser.
- blocklists
Web
User Settings Cookie Synchronization Configuration Blocklist[] - List of cookie specifications that are blocked from being synchronized to the remote browser.
- allowlists
Sequence[Web
User Settings Cookie Synchronization Configuration Allowlist] - List of cookie specifications that are allowed to be synchronized to the remote browser.
- blocklists
Sequence[Web
User Settings Cookie Synchronization Configuration Blocklist] - List of cookie specifications that are blocked from being synchronized to the remote browser.
- allowlists List<Property Map>
- List of cookie specifications that are allowed to be synchronized to the remote browser.
- blocklists List<Property Map>
- List of cookie specifications that are blocked from being synchronized to the remote browser.
WebUserSettingsCookieSynchronizationConfigurationAllowlist, WebUserSettingsCookieSynchronizationConfigurationAllowlistArgs
WebUserSettingsCookieSynchronizationConfigurationBlocklist, WebUserSettingsCookieSynchronizationConfigurationBlocklistArgs
WebUserSettingsToolbarConfiguration, WebUserSettingsToolbarConfigurationArgs
- List<string>
- List of toolbar items to be hidden.
- Max
Display stringResolution - Maximum display resolution that is allowed for the session.
- Toolbar
Type string - Type of toolbar displayed during the session.
- Visual
Mode string - Visual mode of the toolbar.
- []string
- List of toolbar items to be hidden.
- Max
Display stringResolution - Maximum display resolution that is allowed for the session.
- Toolbar
Type string - Type of toolbar displayed during the session.
- Visual
Mode string - Visual mode of the toolbar.
- List<String>
- List of toolbar items to be hidden.
- max
Display StringResolution - Maximum display resolution that is allowed for the session.
- toolbar
Type String - Type of toolbar displayed during the session.
- visual
Mode String - Visual mode of the toolbar.
- string[]
- List of toolbar items to be hidden.
- max
Display stringResolution - Maximum display resolution that is allowed for the session.
- toolbar
Type string - Type of toolbar displayed during the session.
- visual
Mode string - Visual mode of the toolbar.
- Sequence[str]
- List of toolbar items to be hidden.
- max_
display_ strresolution - Maximum display resolution that is allowed for the session.
- toolbar_
type str - Type of toolbar displayed during the session.
- visual_
mode str - Visual mode of the toolbar.
- List<String>
- List of toolbar items to be hidden.
- max
Display StringResolution - Maximum display resolution that is allowed for the session.
- toolbar
Type String - Type of toolbar displayed during the session.
- visual
Mode String - Visual mode of the toolbar.
Import
Using pulumi import
, import WorkSpaces Web User Settings using the user_settings_arn
. For example:
$ pulumi import aws:workspaces/webUserSettings:WebUserSettings example arn:aws:workspacesweb:us-west-2:123456789012:usersettings/abcdef12345
To learn more about importing existing cloud resources, see Importing resources.
Package Details
- Repository
- AWS Classic pulumi/pulumi-aws
- License
- Apache-2.0
- Notes
- This Pulumi package is based on the
aws
Terraform Provider.