browser_settings

Creates, updates, deletes or gets a browser_setting resource or lists browser_settings in a region

Overview

Name	browser_settings
Type	Resource
Description	Definition of AWS::WorkSpacesWeb::BrowserSettings Resource Type
Id	aws.workspacesweb.browser_settings

Fields

Name	Datatype	Description
additional_encryption_context	object
associated_portal_arns	array
browser_policy	string
browser_settings_arn	string
customer_managed_key	string
tags	array
region	string	AWS region.

Methods

Name	Accessible by	Required Params
create_resource	INSERT	region
delete_resource	DELETE	data__Identifier, region
update_resource	UPDATE	data__Identifier, data__PatchDocument, region
list_resources	SELECT	region
get_resource	SELECT	data__Identifier, region

SELECT examples

Gets all browser_settings in a region.

SELECT
region,
additional_encryption_context,
associated_portal_arns,
browser_policy,
browser_settings_arn,
customer_managed_key,
tags
FROM aws.workspacesweb.browser_settings
WHERE region = 'us-east-1';

Gets all properties from an individual browser_setting.

SELECT
region,
additional_encryption_context,
associated_portal_arns,
browser_policy,
browser_settings_arn,
customer_managed_key,
tags
FROM aws.workspacesweb.browser_settings
WHERE region = 'us-east-1' AND data__Identifier = '<BrowserSettingsArn>';

INSERT example

Use the following StackQL query and manifest file to create a new browser_setting resource, using stack-deploy.

Required Properties

/*+ create */
INSERT INTO aws.workspacesweb.browser_settings (
 AdditionalEncryptionContext,
 BrowserPolicy,
 CustomerManagedKey,
 Tags,
 region
)
SELECT 
'{{ AdditionalEncryptionContext }}',
 '{{ BrowserPolicy }}',
 '{{ CustomerManagedKey }}',
 '{{ Tags }}',
'{{ region }}';

All Properties

/*+ create */
INSERT INTO aws.workspacesweb.browser_settings (
 AdditionalEncryptionContext,
 BrowserPolicy,
 CustomerManagedKey,
 Tags,
 region
)
SELECT 
 '{{ AdditionalEncryptionContext }}',
 '{{ BrowserPolicy }}',
 '{{ CustomerManagedKey }}',
 '{{ Tags }}',
 '{{ region }}';

Manifest

version: 1
name: stack name
description: stack description
providers:
  - aws
globals:
  - name: region
    value: '{{ vars.AWS_REGION }}'
resources:
  - name: browser_setting
    props:
      - name: AdditionalEncryptionContext
        value: {}
      - name: BrowserPolicy
        value: '{{ BrowserPolicy }}'
      - name: CustomerManagedKey
        value: '{{ CustomerManagedKey }}'
      - name: Tags
        value:
          - Key: '{{ Key }}'
            Value: '{{ Value }}'

DELETE example

/*+ delete */
DELETE FROM aws.workspacesweb.browser_settings
WHERE data__Identifier = '<BrowserSettingsArn>'
AND region = 'us-east-1';

Permissions

To operate on the browser_settings resource, the following permissions are required:

Create

workspaces-web:CreateBrowserSettings,
workspaces-web:GetBrowserSettings,
workspaces-web:ListTagsForResource,
workspaces-web:TagResource,
kms:CreateGrant,
kms:DescribeKey,
kms:GenerateDataKey,
kms:Decrypt

Read

workspaces-web:GetBrowserSettings,
workspaces-web:ListBrowserSettings,
workspaces-web:ListTagsForResource,
kms:CreateGrant,
kms:DescribeKey,
kms:GenerateDataKey,
kms:Decrypt

Update

workspaces-web:UpdateBrowserSettings,
workspaces-web:TagResource,
workspaces-web:UntagResource,
workspaces-web:GetBrowserSettings,
workspaces-web:ListBrowserSettings,
workspaces-web:ListTagsForResource,
kms:CreateGrant,
kms:DescribeKey,
kms:GenerateDataKey,
kms:Decrypt

Delete

workspaces-web:GetBrowserSettings,
workspaces-web:DeleteBrowserSettings,
kms:CreateGrant,
kms:DescribeKey,
kms:GenerateDataKey,
kms:Decrypt

List

workspaces-web:ListBrowserSettings