BrowserSettings class
Resource for managing an AWS WorkSpaces Web Browser Settings resource.
Example Usage
Basic Usage
import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";
const example = new aws.workspacesweb.BrowserSettings("example", {browserPolicy: JSON.stringify({
AdditionalSettings: {
DownloadsSettings: {
Behavior: "DISABLE",
},
},
})});
import pulumi
import json
import pulumi_aws as aws
example = aws.workspacesweb.BrowserSettings("example", browser_policy=json.dumps({
"AdditionalSettings": {
"DownloadsSettings": {
"Behavior": "DISABLE",
},
},
}))
using System.Collections.Generic;
using System.Linq;
using System.Text.Json;
using Pulumi;
using Aws = Pulumi.Aws;
return await Deployment.RunAsync(() =>
{
var example = new Aws.WorkSpacesWeb.BrowserSettings("example", new()
{
BrowserPolicy = JsonSerializer.Serialize(new Dictionary<string, object?>
{
["AdditionalSettings"] = new Dictionary<string, object?>
{
["DownloadsSettings"] = new Dictionary<string, object?>
{
["Behavior"] = "DISABLE",
},
},
}),
});
});
package main
import (
"encoding/json"
"github.com/pulumi/pulumi-aws/sdk/v7/go/aws/workspacesweb"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
tmpJSON0, err := json.Marshal(map[string]map[string]map[string]string{
"AdditionalSettings": map[string]map[string]string{
"DownloadsSettings": map[string]string{
"Behavior": "DISABLE",
},
},
})
if err != nil {
return err
}
json0 := string(tmpJSON0)
_, err = workspacesweb.NewBrowserSettings(ctx, "example", &workspacesweb.BrowserSettingsArgs{
BrowserPolicy: pulumi.String(json0),
})
if err != nil {
return err
}
return nil
})
}
pulumi {
required_providers {
aws = {
source = "pulumi/aws"
}
}
}
resource "aws_workspacesweb_browsersettings" "example" {
browser_policy = jsonencode({
"AdditionalSettings" = {
"DownloadsSettings" = {
"Behavior" = "DISABLE"
}
}
})
}
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.workspacesweb.BrowserSettings;
import com.pulumi.aws.workspacesweb.BrowserSettingsArgs;
import static com.pulumi.codegen.internal.Serialization.*;
import java.util.ArrayList;
import java.util.Arrays;
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 BrowserSettings("example", BrowserSettingsArgs.builder()
.browserPolicy(serializeJson(
jsonObject(
jsonProperty("AdditionalSettings", jsonObject(
jsonProperty("DownloadsSettings", jsonObject(
jsonProperty("Behavior", "DISABLE")
))
))
)))
.build());
}
}
resources:
example:
type: aws:workspacesweb:BrowserSettings
properties:
browserPolicy:
fn::toJSON:
AdditionalSettings:
DownloadsSettings:
Behavior: DISABLE
With All Arguments
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 Browser Settings",
deletionWindowInDays: 7,
});
const exampleBrowserSettings = new aws.workspacesweb.BrowserSettings("example", {
browserPolicy: JSON.stringify({
chromePolicies: {
DefaultDownloadDirectory: {
value: "/home/as2-streaming-user/MyFiles/TemporaryFiles1",
},
},
}),
customerManagedKey: example.arn,
additionalEncryptionContext: {
Environment: "Production",
},
tags: {
Name: "example-browser-settings",
},
});
import pulumi
import json
import pulumi_aws as aws
example = aws.kms.Key("example",
description="KMS key for WorkSpaces Web Browser Settings",
deletion_window_in_days=7)
example_browser_settings = aws.workspacesweb.BrowserSettings("example",
browser_policy=json.dumps({
"chromePolicies": {
"DefaultDownloadDirectory": {
"value": "/home/as2-streaming-user/MyFiles/TemporaryFiles1",
},
},
}),
customer_managed_key=example.arn,
additional_encryption_context={
"Environment": "Production",
},
tags={
"Name": "example-browser-settings",
})
using System.Collections.Generic;
using System.Linq;
using System.Text.Json;
using Pulumi;
using Aws = Pulumi.Aws;
return await Deployment.RunAsync(() =>
{
var example = new Aws.Kms.Key("example", new()
{
Description = "KMS key for WorkSpaces Web Browser Settings",
DeletionWindowInDays = 7,
});
var exampleBrowserSettings = new Aws.WorkSpacesWeb.BrowserSettings("example", new()
{
BrowserPolicy = JsonSerializer.Serialize(new Dictionary<string, object?>
{
["chromePolicies"] = new Dictionary<string, object?>
{
["DefaultDownloadDirectory"] = new Dictionary<string, object?>
{
["value"] = "/home/as2-streaming-user/MyFiles/TemporaryFiles1",
},
},
}),
CustomerManagedKey = example.Arn,
AdditionalEncryptionContext =
{
{ "Environment", "Production" },
},
Tags =
{
{ "Name", "example-browser-settings" },
},
});
});
package main
import (
"encoding/json"
"github.com/pulumi/pulumi-aws/sdk/v7/go/aws/kms"
"github.com/pulumi/pulumi-aws/sdk/v7/go/aws/workspacesweb"
"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 Browser Settings"),
DeletionWindowInDays: pulumi.Int(7),
})
if err != nil {
return err
}
tmpJSON0, err := json.Marshal(map[string]map[string]map[string]string{
"chromePolicies": map[string]map[string]string{
"DefaultDownloadDirectory": map[string]string{
"value": "/home/as2-streaming-user/MyFiles/TemporaryFiles1",
},
},
})
if err != nil {
return err
}
json0 := string(tmpJSON0)
_, err = workspacesweb.NewBrowserSettings(ctx, "example", &workspacesweb.BrowserSettingsArgs{
BrowserPolicy: pulumi.String(json0),
CustomerManagedKey: example.Arn,
AdditionalEncryptionContext: pulumi.StringMap{
"Environment": pulumi.String("Production"),
},
Tags: pulumi.StringMap{
"Name": pulumi.String("example-browser-settings"),
},
})
if err != nil {
return err
}
return nil
})
}
pulumi {
required_providers {
aws = {
source = "pulumi/aws"
}
}
}
resource "aws_kms_key" "example" {
description = "KMS key for WorkSpaces Web Browser Settings"
deletion_window_in_days = 7
}
resource "aws_workspacesweb_browsersettings" "example" {
browser_policy = jsonencode({
"chromePolicies" = {
"DefaultDownloadDirectory" = {
"value" = "/home/as2-streaming-user/MyFiles/TemporaryFiles1"
}
}
})
customer_managed_key = aws_kms_key.example.arn
additional_encryption_context = {
"Environment" = "Production"
}
tags = {
"Name" = "example-browser-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.workspacesweb.BrowserSettings;
import com.pulumi.aws.workspacesweb.BrowserSettingsArgs;
import static com.pulumi.codegen.internal.Serialization.*;
import java.util.ArrayList;
import java.util.Arrays;
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 Browser Settings")
.deletionWindowInDays(7)
.build());
var exampleBrowserSettings = new BrowserSettings("exampleBrowserSettings", BrowserSettingsArgs.builder()
.browserPolicy(serializeJson(
jsonObject(
jsonProperty("chromePolicies", jsonObject(
jsonProperty("DefaultDownloadDirectory", jsonObject(
jsonProperty("value", "/home/as2-streaming-user/MyFiles/TemporaryFiles1")
))
))
)))
.customerManagedKey(example.arn())
.additionalEncryptionContext(Map.of("Environment", "Production"))
.tags(Map.of("Name", "example-browser-settings"))
.build());
}
}
resources:
example:
type: aws:kms:Key
properties:
description: KMS key for WorkSpaces Web Browser Settings
deletionWindowInDays: 7
exampleBrowserSettings:
type: aws:workspacesweb:BrowserSettings
name: example
properties:
browserPolicy:
fn::toJSON:
chromePolicies:
DefaultDownloadDirectory:
value: /home/as2-streaming-user/MyFiles/TemporaryFiles1
customerManagedKey: ${example.arn}
additionalEncryptionContext:
Environment: Production
tags:
Name: example-browser-settings
Import
Using pulumi import, import WorkSpaces Web Browser Settings using the browserSettingsArn. For example:
$ pulumi import aws:workspacesweb/browserSettings:BrowserSettings example arn:aws:workspacesweb:us-west-2:123456789012:browsersettings/abcdef12345
Constructors
- BrowserSettings(String name, {BrowserSettingsArgs? args, CustomResourceOptions? options})
-
Creates a new BrowserSettings.
nameThe Pulumi resource name.argsArguments used to configure this BrowserSettings. The set of arguments for BrowserSettings.optionsResource options controlling this resource's behavior. - BrowserSettings.reference(String urn)
- Creates a typed reference to an existing BrowserSettings resource.
Properties
-
additionalEncryptionContext
↔ Output<
Map< String, String> ?> -
Additional encryption context for the browser settings.
latefinal
-
associatedPortalArns
↔ Output<
List< String> > -
List of web portal ARNs to associate with the browser settings.
latefinal
-
browserPolicy
↔ Output<
String> -
Browser policy for the browser settings. This is a JSON string that defines the browser settings policy.
latefinal
-
browserSettingsArn
↔ Output<
String> -
ARN of the browser settings resource.
latefinal
-
childResources
→ Set<
Resource> -
finalinherited
-
completionSources
↔ Map<
String, IOutputCompletionSource> -
latefinalinherited
-
customerManagedKey
↔ Output<
String?> -
ARN of the customer managed KMS key.
latefinal
- hashCode → int
-
The hash code for this object.
no setterinherited
-
id
↔ Output<
String> -
getter/setter pairinherited
- isCustom → bool
-
Returns whether this resource is provider-managed.
no setterinherited
- isProtected → bool
-
Returns whether this resource is protected from deletion.
no setterinherited
- isRemote → bool
-
Whether this resource is registered as remote.
no setterinherited
- isResourceReference → bool
-
Whether this instance represents a resource value returned over RPC.
finalinherited
-
region
↔ Output<
String> -
Region where this resource will be managed. Defaults to the Region set in the provider configuration.
latefinal
-
resourceTransforms
→ List<
ResourceTransform> -
Inherited/explicit async transforms.
no setterinherited
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
-
Map of tags assigned to the resource. If configured with a provider
defaultTagsconfiguration block present, tags with matching keys will overwrite those defined at the provider-level.latefinal -
Map of tags assigned to the resource, including those inherited from the provider
defaultTagsconfiguration block.latefinal -
transformations
→ List<
ResourceTransformation> -
Inherited/explicit legacy transformations.
no setterinherited
-
urn
↔ Output<
String> -
latefinalinherited
Methods
-
failId(
Object error) → void -
Completes this resource ID with an error when registration fails.
inherited
-
failOutputs(
Object error) → void -
Completes all output properties with
error.inherited -
failUrn(
Object error) → void -
Completes this resource URN with an error when registration fails.
inherited
-
getProvider(
String moduleMember) → ProviderResource? -
Returns provider for
moduleMember's package, if configured.inherited -
getResourceName(
) → String -
Returns this resource's logical name.
inherited
-
getResourceType(
) → String -
Returns this resource's Pulumi type token.
inherited
-
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
registerOutput<
T> (String propertyName, {Object? decoder(Object?)?, bool isSecret = false}) → Output< T> -
Registers a dynamic output property for this resource.
inherited
-
resolveId(
String? value, {required bool isKnown}) → void -
Resolves the provider-assigned ID for this resource.
inherited
-
resolveOutputs(
Struct outputs) → void -
Resolves all output properties from a monitor response payload.
inherited
-
resolveUrn(
String value) → void -
Resolves this resource's URN once assigned by the engine.
inherited
-
serializeProperties(
Map< String, dynamic> properties) → Future<Struct> -
Serializes resource properties for RPC transmission.
inherited
-
toString(
) → String -
A string representation of this object.
inherited
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited
Static Methods
-
get(
String name, Input< String> id, {BrowserSettingsState? state, CustomResourceOptions? options}) → BrowserSettings -
Gets an existing BrowserSettings resource's state with the given
nameandid.