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	awscc.workspacesweb.browser_settings

Fields

get (all properties)

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.

list (identifiers only)

Name	Datatype	Description
browser_settings_arn	string
region	string	AWS region.

For more information, see AWS::WorkSpacesWeb::BrowserSettings.

Methods

Name	Resource	Accessible by	Required Params
create_resource	browser_settings	INSERT	region
delete_resource	browser_settings	DELETE	Identifier, region
update_resource	browser_settings	UPDATE	Identifier, PatchDocument, region
list_resources	browser_settings_list_only	SELECT	region
get_resource	browser_settings	SELECT	Identifier, region

SELECT examples

get (all properties)

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 awscc.workspacesweb.browser_settings
WHERE
  region = '{{ region }}' AND
  Identifier = '{{ browser_settings_arn }}';

list (identifiers only)

Lists all browser_settings in a region.

SELECT
  region,
  browser_settings_arn
FROM awscc.workspacesweb.browser_settings_list_only
WHERE
  region = '{{ region }}';

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 awscc.workspacesweb.browser_settings (
  AdditionalEncryptionContext,
  BrowserPolicy,
  CustomerManagedKey,
  Tags,
  region
)
SELECT
  '{{ additional_encryption_context }}',
  '{{ browser_policy }}',
  '{{ customer_managed_key }}',
  '{{ tags }}',
  '{{ region }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

All Properties

/*+ create */
INSERT INTO awscc.workspacesweb.browser_settings (
  AdditionalEncryptionContext,
  BrowserPolicy,
  CustomerManagedKey,
  Tags,
  region
)
SELECT
  '{{ additional_encryption_context }}',
  '{{ browser_policy }}',
  '{{ customer_managed_key }}',
  '{{ tags }}',
  '{{ region }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

Manifest

version: 1
name: stack name
description: stack description
providers:
- aws
globals:
- name: region
  value: '{{ vars.AWS_REGION }}'
resources:
- name: browser_setting
  props:
    - name: additional_encryption_context
      value: {}
    - name: browser_policy
      value: '{{ browser_policy }}'
    - name: customer_managed_key
      value: '{{ customer_managed_key }}'
    - name: tags
      value:
        - key: '{{ key }}'
          value: '{{ value }}'

UPDATE example

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

/*+ update */
UPDATE awscc.workspacesweb.browser_settings
SET PatchDocument = string('{{ {
    "BrowserPolicy": browser_policy,
    "Tags": tags
} | generate_patch_document }}')
WHERE
  region = '{{ region }}' AND
  Identifier = '{{ browser_settings_arn }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

DELETE example

/*+ delete */
DELETE FROM awscc.workspacesweb.browser_settings
WHERE
  Identifier = '{{ browser_settings_arn }}' AND
  region = '{{ region }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

Additional Parameters

Mutable resources in the Cloud Control provider support additional optional parameters which can be supplied with INSERT, UPDATE, or DELETE operations. These include:

Parameter	Description
ClientToken	A unique identifier to ensure the idempotency of the resource request. This allows the provider to accurately distinguish between retries and new requests. A client token is valid for 36 hours once used. After that, a resource request with the same client token is treated as a new request. If you do not specify a client token, one is generated for inclusion in the request.
RoleArn	The ARN of the IAM role used to perform this resource operation. The role specified must have the permissions required for this operation. If you do not specify a role, a temporary session is created using your AWS user credentials.
TypeVersionId	For private resource types, the type version to use in this resource operation. If you do not specify a resource version, the default version is used.

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:DescribeKey,
kms:GenerateDataKey,
kms:Decrypt,
kms:GenerateDataKeyWithoutPlaintext,
kms:ReEncryptTo,
kms:ReEncryptFrom

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,
kms:Decrypt,
kms:DescribeKey