browser_settings

Creates, updates, deletes, gets or lists a browser_settings resource.

Overview

Name	browser_settings
Type	Resource
Id	aws.workspaces_web.browser_settings

Fields

The following fields are returned by SELECT queries:

get_browser_settings

Name	Datatype	Description
additional_encryption_context	object	The additional encryption context of the browser settings.
associated_portal_arns	array	A list of web portal ARNs that this browser settings is associated with.
browser_policy	string	A JSON string containing Chrome Enterprise policies that will be applied to all streaming sessions. (pattern: <code>&#123;[\S\s]&#125;\s</code>)
browser_settings_arn	string	The ARN of the browser settings. (pattern: <code>arn:[\w+=/,.@-]+:[a-zA-Z0-9-]+:[a-zA-Z0-9-]*:[a-zA-Z0-9]{1,12}:[a-zA-Z]+(/[a-fA-F0-9-]{36})+</code>)
customer_managed_key	string	The customer managed key used to encrypt sensitive information in the browser settings. (pattern: <code>arn:[\w+=/,.@-]+:kms:[a-zA-Z0-9-]*:[a-zA-Z0-9]{1,12}:key/[a-zA-Z0-9-]+</code>)
web_content_filtering_policy	object	The policy that specifies which URLs end users are allowed to access or which URLs or domain categories they are restricted from accessing for enhanced security.

list_browser_settings

Name	Datatype	Description
browser_settings	array	The browser settings.
next_token	string	The pagination token used to retrieve the next page of results for this operation. (pattern: <code>\S+</code>)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_browser_settings	select	browser_settings_arn, region		Gets browser settings.
list_browser_settings	select	region	nextToken, maxResults	Retrieves a list of browser settings.
create_browser_settings	insert	region		Creates a browser settings resource that can be associated with a web portal. Once associated with a web portal, browser settings control how the browser will behave once a user starts a streaming session for the web portal.
associate_browser_settings	update	portal_arn, browserSettingsArn, region		Associates a browser settings resource with a web portal.
disassociate_browser_settings	update	portal_arn, region		Disassociates browser settings from a web portal.
update_browser_settings	update	browser_settings_arn, region		Updates browser settings.
delete_browser_settings	delete	browser_settings_arn, region		Deletes browser settings.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
browserSettingsArn	string	The ARN of the browser settings.
browser_settings_arn	string	The ARN of the browser settings.
portal_arn	string	The ARN of the web portal.
region	string	AWS region (default: us-east-1)
maxResults	integer	The maximum number of results to be included in the next page.
nextToken	string	The pagination token used to retrieve the next page of results for this operation.

SELECT examples

get_browser_settings

Gets browser settings.

SELECT
additional_encryption_context,
associated_portal_arns,
browser_policy,
browser_settings_arn,
customer_managed_key,
web_content_filtering_policy
FROM aws.workspaces_web.browser_settings
WHERE browser_settings_arn = '{{ browser_settings_arn }}' -- required
AND region = '{{ region }}' -- required
;

list_browser_settings

Retrieves a list of browser settings.

SELECT
browser_settings,
next_token
FROM aws.workspaces_web.browser_settings
WHERE region = '{{ region }}' -- required
AND nextToken = '{{ nextToken }}'
AND maxResults = '{{ maxResults }}'
;

INSERT examples

create_browser_settings

Creates a browser settings resource that can be associated with a web portal. Once associated with a web portal, browser settings control how the browser will behave once a user starts a streaming session for the web portal.

INSERT INTO aws.workspaces_web.browser_settings (
tags,
customerManagedKey,
additionalEncryptionContext,
browserPolicy,
clientToken,
webContentFilteringPolicy,
region
)
SELECT 
'{{ tags }}',
'{{ customerManagedKey }}',
'{{ additionalEncryptionContext }}',
'{{ browserPolicy }}',
'{{ clientToken }}',
'{{ webContentFilteringPolicy }}',
'{{ region }}'
RETURNING
browser_settings_arn
;

Manifest

# Description fields are for documentation purposes
- name: browser_settings
props:
  - name: region
    value: "{{ region }}"
    description: Required parameter for the browser_settings resource.
  - name: tags
    value:
      - Key: "{{ Key }}"
        Value: "{{ Value }}"
  - name: customerManagedKey
    value: "{{ customerManagedKey }}"
  - name: additionalEncryptionContext
    value: "{{ additionalEncryptionContext }}"
  - name: browserPolicy
    value: "{{ browserPolicy }}"
  - name: clientToken
    value: "{{ clientToken }}"
  - name: webContentFilteringPolicy
    description: |
      The policy that specifies which URLs end users are allowed to access or which URLs or domain categories they are restricted from accessing for enhanced security.
    value:
      blockedCategories:
        - "{{ blockedCategories }}"
      allowedUrls:
        - "{{ allowedUrls }}"
      blockedUrls:
        - "{{ blockedUrls }}"

UPDATE examples

associate_browser_settings

Associates a browser settings resource with a web portal.

UPDATE aws.workspaces_web.browser_settings
SET 
-- No updatable properties
WHERE 
portal_arn = '{{ portal_arn }}' --required
AND browserSettingsArn = '{{ browserSettingsArn }}' --required
AND region = '{{ region }}' --required
RETURNING
browser_settings_arn,
portal_arn;

disassociate_browser_settings

Disassociates browser settings from a web portal.

UPDATE aws.workspaces_web.browser_settings
SET 
-- No updatable properties
WHERE 
portal_arn = '{{ portal_arn }}' --required
AND region = '{{ region }}' --required;

update_browser_settings

Updates browser settings.

UPDATE aws.workspaces_web.browser_settings
SET 
browserPolicy = '{{ browserPolicy }}',
clientToken = '{{ clientToken }}',
webContentFilteringPolicy = '{{ webContentFilteringPolicy }}'
WHERE 
browser_settings_arn = '{{ browser_settings_arn }}' --required
AND region = '{{ region }}' --required
RETURNING
browser_settings;

DELETE examples

delete_browser_settings

Deletes browser settings.

DELETE FROM aws.workspaces_web.browser_settings
WHERE browser_settings_arn = '{{ browser_settings_arn }}' --required
AND region = '{{ region }}' --required
;