data_protection_settings

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

Overview

Name	data_protection_settings
Type	Resource
Id	aws.workspaces_web.data_protection_settings

Fields

The following fields are returned by SELECT queries:

get_data_protection_settings

Name	Datatype	Description
additional_encryption_context	object	The additional encryption context of the data protection settings.
associated_portal_arns	array	A list of web portal ARNs that this data protection settings resource is associated with.
creation_date	string (date-time)	The creation date timestamp of the data protection settings.
customer_managed_key	string	The customer managed key used to encrypt sensitive information in the data protection settings. (pattern: <code>arn:[\w+=/,.@-]+:kms:[a-zA-Z0-9-]*:[a-zA-Z0-9]{1,12}:key/[a-zA-Z0-9-]+</code>)
data_protection_settings_arn	string	The ARN of the data protection settings resource. (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>)
description	string	The description of the data protection settings. (pattern: <code>[ _-\d\w]+</code>)
display_name	string	The display name of the data protection settings. (pattern: <code>[ _-\d\w]+</code>)
inline_redaction_configuration	object	The configuration for in-session inline redaction.

list_data_protection_settings

Name	Datatype	Description
creation_date	string (date-time)	The creation date timestamp of the data protection settings.
data_protection_settings_arn	string	The ARN of the data protection 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>)
description	string	The description of the data protection settings. (pattern: <code>[ _-\d\w]+</code>)
display_name	string	The display name of the data protection settings. (pattern: <code>[ _-\d\w]+</code>)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_data_protection_settings	select	data_protection_settings_arn, region		Gets the data protection settings.
list_data_protection_settings	select	region	nextToken, maxResults	Retrieves a list of data protection settings.
create_data_protection_settings	insert	region		Creates a data protection settings resource that can be associated with a web portal.
associate_data_protection_settings	update	portal_arn, dataProtectionSettingsArn, region		Associates a data protection settings resource with a web portal.
disassociate_data_protection_settings	update	portal_arn, region		Disassociates data protection settings from a web portal.
update_data_protection_settings	update	data_protection_settings_arn, region		Updates data protection settings.
delete_data_protection_settings	delete	data_protection_settings_arn, region		Deletes data protection 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
dataProtectionSettingsArn	string	The ARN of the data protection settings.
data_protection_settings_arn	string	The ARN of the data protection 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_data_protection_settings

Gets the data protection settings.

SELECT
additional_encryption_context,
associated_portal_arns,
creation_date,
customer_managed_key,
data_protection_settings_arn,
description,
display_name,
inline_redaction_configuration
FROM aws.workspaces_web.data_protection_settings
WHERE data_protection_settings_arn = '{{ data_protection_settings_arn }}' -- required
AND region = '{{ region }}' -- required
;

list_data_protection_settings

Retrieves a list of data protection settings.

SELECT
creation_date,
data_protection_settings_arn,
description,
display_name
FROM aws.workspaces_web.data_protection_settings
WHERE region = '{{ region }}' -- required
AND nextToken = '{{ nextToken }}'
AND maxResults = '{{ maxResults }}'
;

INSERT examples

create_data_protection_settings

Creates a data protection settings resource that can be associated with a web portal.

INSERT INTO aws.workspaces_web.data_protection_settings (
displayName,
description,
tags,
customerManagedKey,
additionalEncryptionContext,
inlineRedactionConfiguration,
clientToken,
region
)
SELECT 
'{{ displayName }}',
'{{ description }}',
'{{ tags }}',
'{{ customerManagedKey }}',
'{{ additionalEncryptionContext }}',
'{{ inlineRedactionConfiguration }}',
'{{ clientToken }}',
'{{ region }}'
RETURNING
data_protection_settings_arn
;

Manifest

# Description fields are for documentation purposes
- name: data_protection_settings
props:
  - name: region
    value: "{{ region }}"
    description: Required parameter for the data_protection_settings resource.
  - name: displayName
    value: "{{ displayName }}"
  - name: description
    value: "{{ description }}"
  - name: tags
    value:
      - Key: "{{ Key }}"
        Value: "{{ Value }}"
  - name: customerManagedKey
    value: "{{ customerManagedKey }}"
  - name: additionalEncryptionContext
    value: "{{ additionalEncryptionContext }}"
  - name: inlineRedactionConfiguration
    description: |
      The configuration for in-session inline redaction.
    value:
      inlineRedactionPatterns:
        - builtInPatternId: "{{ builtInPatternId }}"
          customPattern:
            patternName: "{{ patternName }}"
            patternRegex: "{{ patternRegex }}"
            patternDescription: "{{ patternDescription }}"
            keywordRegex: "{{ keywordRegex }}"
          redactionPlaceHolder:
            redactionPlaceHolderType: "{{ redactionPlaceHolderType }}"
            redactionPlaceHolderText: "{{ redactionPlaceHolderText }}"
          enforcedUrls: "{{ enforcedUrls }}"
          exemptUrls: "{{ exemptUrls }}"
          confidenceLevel: {{ confidenceLevel }}
      globalEnforcedUrls:
        - "{{ globalEnforcedUrls }}"
      globalExemptUrls:
        - "{{ globalExemptUrls }}"
      globalConfidenceLevel: {{ globalConfidenceLevel }}
  - name: clientToken
    value: "{{ clientToken }}"

UPDATE examples

associate_data_protection_settings

Associates a data protection settings resource with a web portal.

UPDATE aws.workspaces_web.data_protection_settings
SET 
-- No updatable properties
WHERE 
portal_arn = '{{ portal_arn }}' --required
AND dataProtectionSettingsArn = '{{ dataProtectionSettingsArn }}' --required
AND region = '{{ region }}' --required
RETURNING
data_protection_settings_arn,
portal_arn;

disassociate_data_protection_settings

Disassociates data protection settings from a web portal.

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

update_data_protection_settings

Updates data protection settings.

UPDATE aws.workspaces_web.data_protection_settings
SET 
inlineRedactionConfiguration = '{{ inlineRedactionConfiguration }}',
displayName = '{{ displayName }}',
description = '{{ description }}',
clientToken = '{{ clientToken }}'
WHERE 
data_protection_settings_arn = '{{ data_protection_settings_arn }}' --required
AND region = '{{ region }}' --required
RETURNING
data_protection_settings;

DELETE examples

delete_data_protection_settings

Deletes data protection settings.

DELETE FROM aws.workspaces_web.data_protection_settings
WHERE data_protection_settings_arn = '{{ data_protection_settings_arn }}' --required
AND region = '{{ region }}' --required
;