data_protection_settings

Creates, updates, deletes or gets a data_protection_setting resource or lists data_protection_settings in a region

Overview

Name	data_protection_settings
Type	Resource
Description	Definition of AWS::WorkSpacesWeb::DataProtectionSettings Resource Type
Id	awscc.workspacesweb.data_protection_settings

Fields

get (all properties)

Name	Datatype	Description
additional_encryption_context	object
associated_portal_arns	array
creation_date	string
customer_managed_key	string
data_protection_settings_arn	string
description	string
display_name	string
▶inline_redaction_configuration	object
▶tags	array
region	string	AWS region.

list (identifiers only)

Name	Datatype	Description
data_protection_settings_arn	string
region	string	AWS region.

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

Methods

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

SELECT examples

get (all properties)

Gets all properties from an individual data_protection_setting.

SELECT
  region,
  additional_encryption_context,
  associated_portal_arns,
  creation_date,
  customer_managed_key,
  data_protection_settings_arn,
  description,
  display_name,
  inline_redaction_configuration,
  tags
FROM awscc.workspacesweb.data_protection_settings
WHERE
  region = 'us-east-1' AND
  Identifier = '{{ data_protection_settings_arn }}';

list (identifiers only)

Lists all data_protection_settings in a region.

SELECT
  region,
  data_protection_settings_arn
FROM awscc.workspacesweb.data_protection_settings_list_only
WHERE
  region = 'us-east-1';

INSERT example

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

Required Properties

/*+ create */
INSERT INTO awscc.workspacesweb.data_protection_settings (
  AdditionalEncryptionContext,
  CustomerManagedKey,
  Description,
  DisplayName,
  InlineRedactionConfiguration,
  Tags,
  region
)
SELECT
  '{{ additional_encryption_context }}',
  '{{ customer_managed_key }}',
  '{{ description }}',
  '{{ display_name }}',
  '{{ inline_redaction_configuration }}',
  '{{ tags }}',
  '{{ region }}';

All Properties

/*+ create */
INSERT INTO awscc.workspacesweb.data_protection_settings (
  AdditionalEncryptionContext,
  CustomerManagedKey,
  Description,
  DisplayName,
  InlineRedactionConfiguration,
  Tags,
  region
)
SELECT
  '{{ additional_encryption_context }}',
  '{{ customer_managed_key }}',
  '{{ description }}',
  '{{ display_name }}',
  '{{ inline_redaction_configuration }}',
  '{{ tags }}',
  '{{ region }}';

Manifest

version: 1
name: stack name
description: stack description
providers:
  - aws
globals:
  - name: region
    value: '{{ vars.AWS_REGION }}'
resources:
  - name: data_protection_setting
    props:
      - name: additional_encryption_context
        value: {}
      - name: customer_managed_key
        value: '{{ customer_managed_key }}'
      - name: description
        value: '{{ description }}'
      - name: display_name
        value: '{{ display_name }}'
      - name: inline_redaction_configuration
        value:
          inline_redaction_patterns:
            - built_in_pattern_id: '{{ built_in_pattern_id }}'
              custom_pattern:
                pattern_name: '{{ pattern_name }}'
                pattern_regex: '{{ pattern_regex }}'
                pattern_description: '{{ pattern_description }}'
                keyword_regex: '{{ keyword_regex }}'
              redaction_place_holder:
                redaction_place_holder_type: '{{ redaction_place_holder_type }}'
                redaction_place_holder_text: '{{ redaction_place_holder_text }}'
              enforced_urls:
                - '{{ enforced_urls[0] }}'
              exempt_urls:
                - '{{ exempt_urls[0] }}'
              confidence_level: null
          global_enforced_urls:
            - '{{ global_enforced_urls[0] }}'
          global_exempt_urls:
            - '{{ global_exempt_urls[0] }}'
          global_confidence_level: null
      - name: tags
        value:
          - key: '{{ key }}'
            value: '{{ value }}'

UPDATE example

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

/*+ update */
UPDATE awscc.workspacesweb.data_protection_settings
SET PatchDocument = string('{{ {
    "Description": description,
    "DisplayName": display_name,
    "InlineRedactionConfiguration": inline_redaction_configuration,
    "Tags": tags
} | generate_patch_document }}')
WHERE
  region = '{{ region }}' AND
  Identifier = '{{ data_protection_settings_arn }}';

DELETE example

/*+ delete */
DELETE FROM awscc.workspacesweb.data_protection_settings
WHERE
  Identifier = '{{ data_protection_settings_arn }}' AND
  region = 'us-east-1';

Permissions

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

Create

workspaces-web:CreateDataProtectionSettings,
workspaces-web:GetDataProtectionSettings,
workspaces-web:ListDataProtectionSettings,
workspaces-web:ListTagsForResource,
workspaces-web:TagResource,
kms:DescribeKey,
kms:GenerateDataKey,
kms:Decrypt,
kms:GenerateDataKeyWithoutPlaintext,
kms:ReEncryptTo,
kms:ReEncryptFrom

Read

workspaces-web:GetDataProtectionSettings,
workspaces-web:ListDataProtectionSettings,
workspaces-web:ListTagsForResource,
kms:DescribeKey,
kms:GenerateDataKey,
kms:Decrypt

Update

workspaces-web:UpdateDataProtectionSettings,
workspaces-web:GetDataProtectionSettings,
workspaces-web:ListDataProtectionSettings,
workspaces-web:TagResource,
workspaces-web:UntagResource,
workspaces-web:ListTagsForResource,
kms:DescribeKey,
kms:GenerateDataKey,
kms:Decrypt

Delete

workspaces-web:GetDataProtectionSettings,
workspaces-web:ListDataProtectionSettings,
workspaces-web:DeleteDataProtectionSettings,
kms:DescribeKey,
kms:GenerateDataKey,
kms:Decrypt

List

workspaces-web:ListDataProtectionSettings,
kms:Decrypt,
kms:DescribeKey