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	aws.workspacesweb.data_protection_settings

Fields

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.

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

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 data_protection_settings in a region.

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 aws.workspacesweb.data_protection_settings
WHERE region = 'us-east-1';

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 aws.workspacesweb.data_protection_settings
WHERE region = 'us-east-1' AND data__Identifier = '<DataProtectionSettingsArn>';

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 aws.workspacesweb.data_protection_settings (
 AdditionalEncryptionContext,
 CustomerManagedKey,
 Description,
 DisplayName,
 InlineRedactionConfiguration,
 Tags,
 region
)
SELECT 
'{{ AdditionalEncryptionContext }}',
 '{{ CustomerManagedKey }}',
 '{{ Description }}',
 '{{ DisplayName }}',
 '{{ InlineRedactionConfiguration }}',
 '{{ Tags }}',
'{{ region }}';

All Properties

/*+ create */
INSERT INTO aws.workspacesweb.data_protection_settings (
 AdditionalEncryptionContext,
 CustomerManagedKey,
 Description,
 DisplayName,
 InlineRedactionConfiguration,
 Tags,
 region
)
SELECT 
 '{{ AdditionalEncryptionContext }}',
 '{{ CustomerManagedKey }}',
 '{{ Description }}',
 '{{ DisplayName }}',
 '{{ InlineRedactionConfiguration }}',
 '{{ 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: AdditionalEncryptionContext
        value: {}
      - name: CustomerManagedKey
        value: '{{ CustomerManagedKey }}'
      - name: Description
        value: '{{ Description }}'
      - name: DisplayName
        value: '{{ DisplayName }}'
      - name: InlineRedactionConfiguration
        value:
          InlineRedactionPatterns:
            - BuiltInPatternId: '{{ BuiltInPatternId }}'
              CustomPattern:
                PatternName: '{{ PatternName }}'
                PatternRegex: '{{ PatternRegex }}'
                PatternDescription: '{{ PatternDescription }}'
                KeywordRegex: '{{ KeywordRegex }}'
              RedactionPlaceHolder:
                RedactionPlaceHolderType: '{{ RedactionPlaceHolderType }}'
                RedactionPlaceHolderText: '{{ RedactionPlaceHolderText }}'
              EnforcedUrls:
                - '{{ EnforcedUrls[0] }}'
              ExemptUrls:
                - '{{ ExemptUrls[0] }}'
              ConfidenceLevel: null
          GlobalEnforcedUrls:
            - '{{ GlobalEnforcedUrls[0] }}'
          GlobalExemptUrls:
            - '{{ GlobalExemptUrls[0] }}'
          GlobalConfidenceLevel: null
      - name: Tags
        value:
          - Key: '{{ Key }}'
            Value: '{{ Value }}'

DELETE example

/*+ delete */
DELETE FROM aws.workspacesweb.data_protection_settings
WHERE data__Identifier = '<DataProtectionSettingsArn>'
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