dlp_settings

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

Overview

Name	dlp_settings
Type	Resource
Id	aws.quicksight.dlp_settings

Fields

The following fields are returned by SELECT queries:

describe_dlp_setting

Name	Datatype	Description
dlp_setting	object	The full configuration of the requested DLP setting, returned as a DlpSettingDetails object.
request_id	string	The Amazon Web Services request ID for this operation.

list_dlp_settings

Name	Datatype	Description
arn	string	The Amazon Resource Name (ARN) of the DLP setting.
created_at	string (date-time)	The date and time that the DLP setting was created, in ISO 8601 format.
dlp_setting_id	string	The ID of the DLP setting. (pattern: <code>[a-zA-Z0-9-_]+</code>)
name	string	The display name of the DLP setting. (pattern: <code>[A-Za-z0-9](?:[\w- &]*[A-Za-z0-9])?</code>)
provider_type	string	The type of external DLP provider used for sensitivity label classification. (MICROSOFT_PURVIEW)
status	string	The status of the DLP setting. Valid values are ACTIVE and INACTIVE. (ACTIVE, INACTIVE)
updated_at	string (date-time)	The date and time that the DLP setting was most recently updated, in ISO 8601 format.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
describe_dlp_setting	select	aws_account_id, dlp_setting_id, region		Describes the full configuration of a DLP setting in an Amazon Web Services account.
list_dlp_settings	select	aws_account_id, region	next-token, max-results	Lists all DLP settings in an Amazon Web Services account.
create_dlp_setting	insert	aws_account_id, dlp_setting_id, region, ProviderType, ProviderConfig, ProviderOutageAction, Enabled		Creates a data loss prevention (DLP) setting configuration for an Amazon Web Services account. A DLP setting defines the DLP provider, the enforcement behavior, and the Quick capabilities that the setting applies to.
update_dlp_setting	update	aws_account_id, dlp_setting_id, region		Updates an existing DLP setting configuration in an Amazon Web Services account. Fields that are omitted from the request retain their current values.
delete_dlp_setting	delete	aws_account_id, dlp_setting_id, region		Deletes a DLP setting configuration from an Amazon Web Services account.

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
aws_account_id	string	The ID of the Amazon Web Services account that contains the DLP setting that you want to delete.
dlp_setting_id	string	The ID of the DLP setting that you want to delete.
region	string	AWS region (default: us-east-1)
max-results	integer	The maximum number of results to return per request.
next-token	string	The token for the next set of results, or null if there are no more results.

SELECT examples

describe_dlp_setting

Describes the full configuration of a DLP setting in an Amazon Web Services account.

SELECT
dlp_setting,
request_id
FROM aws.quicksight.dlp_settings
WHERE aws_account_id = '{{ aws_account_id }}' -- required
AND dlp_setting_id = '{{ dlp_setting_id }}' -- required
AND region = '{{ region }}' -- required
;

list_dlp_settings

Lists all DLP settings in an Amazon Web Services account.

SELECT
arn,
created_at,
dlp_setting_id,
name,
provider_type,
status,
updated_at
FROM aws.quicksight.dlp_settings
WHERE aws_account_id = '{{ aws_account_id }}' -- required
AND region = '{{ region }}' -- required
AND `next-token` = '{{ next-token }}'
AND `max-results` = '{{ max-results }}'
;

INSERT examples

create_dlp_setting

Creates a data loss prevention (DLP) setting configuration for an Amazon Web Services account. A DLP setting defines the DLP provider, the enforcement behavior, and the Quick capabilities that the setting applies to.

INSERT INTO aws.quicksight.dlp_settings (
Name,
ProviderType,
ProviderConfig,
ProviderOutageAction,
Enabled,
Tags,
aws_account_id,
dlp_setting_id,
region
)
SELECT 
'{{ Name }}',
'{{ ProviderType }}' /* required */,
'{{ ProviderConfig }}' /* required */,
'{{ ProviderOutageAction }}' /* required */,
{{ Enabled }} /* required */,
'{{ Tags }}',
'{{ aws_account_id }}',
'{{ dlp_setting_id }}',
'{{ region }}'
RETURNING
arn,
dlp_setting_id,
request_id
;

Manifest

# Description fields are for documentation purposes
- name: dlp_settings
props:
  - name: aws_account_id
    value: "{{ aws_account_id }}"
    description: Required parameter for the dlp_settings resource.
  - name: dlp_setting_id
    value: "{{ dlp_setting_id }}"
    description: Required parameter for the dlp_settings resource.
  - name: region
    value: "{{ region }}"
    description: Required parameter for the dlp_settings resource.
  - name: Name
    value: "{{ Name }}"
  - name: ProviderType
    value: "{{ ProviderType }}"
    valid_values: ['MICROSOFT_PURVIEW']
  - name: ProviderConfig
    description: |
      The provider-specific configuration for a DLP integration. This is a union type structure. For this structure to be valid, only one of the attributes can be defined.
    value:
      MicrosoftPurview:
        Credentials:
          SecretArn: "{{ SecretArn }}"
        LabelActionMappings:
          - LabelId: "{{ LabelId }}"
            LabelName: "{{ LabelName }}"
            Action: "{{ Action }}"
        UnmappedAction: "{{ UnmappedAction }}"
  - name: ProviderOutageAction
    value: "{{ ProviderOutageAction }}"
    valid_values: ['ALLOW', 'WARN', 'BLOCK']
  - name: Enabled
    value: {{ Enabled }}
  - name: Tags
    value:
      - Key: "{{ Key }}"
        Value: "{{ Value }}"

UPDATE examples

update_dlp_setting

Updates an existing DLP setting configuration in an Amazon Web Services account. Fields that are omitted from the request retain their current values.

UPDATE aws.quicksight.dlp_settings
SET 
Name = '{{ Name }}',
ProviderType = '{{ ProviderType }}',
ProviderConfig = '{{ ProviderConfig }}',
ProviderOutageAction = '{{ ProviderOutageAction }}',
Enabled = {{ Enabled }}
WHERE 
aws_account_id = '{{ aws_account_id }}' --required
AND dlp_setting_id = '{{ dlp_setting_id }}' --required
AND region = '{{ region }}' --required
RETURNING
arn,
dlp_setting_id,
request_id;

DELETE examples

delete_dlp_setting

Deletes a DLP setting configuration from an Amazon Web Services account.

DELETE FROM aws.quicksight.dlp_settings
WHERE aws_account_id = '{{ aws_account_id }}' --required
AND dlp_setting_id = '{{ dlp_setting_id }}' --required
AND region = '{{ region }}' --required
;