profiles_custom

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

Overview

Name	profiles_custom
Type	Resource
Id	cloudflare.zero_trust.profiles_custom

Fields

The following fields are returned by SELECT queries:

get_by_account

Custom profile response.

Name	Datatype	Description
id	string (uuid)	The id of the profile (uuid).
name	string	The name of the profile.
ai_context_enabled	boolean
allowed_match_count	integer (int32)	Related DLP policies will trigger when the match count exceeds the number set.
confidence_threshold	string	(low, medium, high, very_high) (default: low)
context_awareness	object	Scan the context of predefined entries to only return matches surrounded by keywords.
created_at	string (date-time)	When the profile was created.
data_classes	array	Data classes associated with this profile.
data_tags	array	Data tags associated with this profile.
description	string	The description of the profile.
entries	array
ocr_enabled	boolean
open_access	boolean	Whether this profile can be accessed by anyone.
sensitivity_levels	array	Sensitivity levels associated with this profile.
shared_entries	array	(x-stainless-terraform-configurability: computed)
type	string	(custom)
updated_at	string (date-time)	When the profile was lasted updated.

list

List all custom profiles response.

Name	Datatype	Description
id	string (uuid)	The id of the profile (uuid).
name	string	The name of the profile.
ai_context_enabled	boolean
allowed_match_count	integer (int32)	Related DLP policies will trigger when the match count exceeds the number set.
confidence_threshold	string	(low, medium, high, very_high) (default: low)
context_awareness	object	Scan the context of predefined entries to only return matches surrounded by keywords.
created_at	string (date-time)	When the profile was created.
data_classes	array	Data classes associated with this profile.
data_tags	array	Data tags associated with this profile.
description	string	The description of the profile.
entries	array
ocr_enabled	boolean
sensitivity_levels	array	Sensitivity levels associated with this profile.
shared_entries	array	(x-stainless-terraform-configurability: computed)
updated_at	string (date-time)	When the profile was lasted updated.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_by_account	select	account_id, profile_id		Fetches a custom DLP profile by id.
list	select	account_id		Lists all DLP custom profiles in an account.
create	insert	account_id, name		Creates a DLP custom profile.
update_by_account	replace	account_id, profile_id, name		Updates a DLP custom profile.
delete_by_account	delete	account_id, profile_id		Deletes a DLP custom profile.

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
account_id	string	The Cloudflare account ID.
profile_id	string (uuid)

SELECT examples

get_by_account

Fetches a custom DLP profile by id.

SELECT
id,
name,
ai_context_enabled,
allowed_match_count,
confidence_threshold,
context_awareness,
created_at,
data_classes,
data_tags,
description,
entries,
ocr_enabled,
open_access,
sensitivity_levels,
shared_entries,
type,
updated_at
FROM cloudflare.zero_trust.profiles_custom
WHERE account_id = '{{ account_id }}' -- required
AND profile_id = '{{ profile_id }}' -- required
;

list

Lists all DLP custom profiles in an account.

SELECT
id,
name,
ai_context_enabled,
allowed_match_count,
confidence_threshold,
context_awareness,
created_at,
data_classes,
data_tags,
description,
entries,
ocr_enabled,
sensitivity_levels,
shared_entries,
updated_at
FROM cloudflare.zero_trust.profiles_custom
WHERE account_id = '{{ account_id }}' -- required
;

INSERT examples

create

Creates a DLP custom profile.

INSERT INTO cloudflare.zero_trust.profiles_custom (
ai_context_enabled,
allowed_match_count,
confidence_threshold,
context_awareness,
data_classes,
data_tags,
description,
entries,
name,
ocr_enabled,
sensitivity_levels,
shared_entries,
account_id
)
SELECT 
{{ ai_context_enabled }},
{{ allowed_match_count }},
'{{ confidence_threshold }}',
'{{ context_awareness }}',
'{{ data_classes }}',
'{{ data_tags }}',
'{{ description }}',
'{{ entries }}',
'{{ name }}' /* required */,
{{ ocr_enabled }},
'{{ sensitivity_levels }}',
'{{ shared_entries }}',
'{{ account_id }}'
RETURNING
errors,
messages,
result,
success
;

Manifest

# Description fields are for documentation purposes
- name: profiles_custom
props:
  - name: account_id
    value: "{{ account_id }}"
    description: Required parameter for the profiles_custom resource.
  - name: ai_context_enabled
    value: {{ ai_context_enabled }}
    default: false
  - name: allowed_match_count
    value: {{ allowed_match_count }}
    description: |
      Related DLP policies will trigger when the match count exceeds the number set.
    default: 0
  - name: confidence_threshold
    value: "{{ confidence_threshold }}"
    default: low
  - name: context_awareness
    description: |
      Scan the context of predefined entries to only return matches surrounded by keywords.
    value:
      enabled: {{ enabled }}
      skip:
        files: {{ files }}
  - name: data_classes
    value:
      - "{{ data_classes }}"
    description: |
      Data class IDs to associate with the profile.
  - name: data_tags
    value:
      - "{{ data_tags }}"
    description: |
      Data tag IDs to associate with the profile.
  - name: description
    value: "{{ description }}"
    description: |
      The description of the profile.
  - name: entries
    value:
      - description: "{{ description }}"
        enabled: {{ enabled }}
        name: "{{ name }}"
        pattern:
          regex: "{{ regex }}"
          validation: "{{ validation }}"
        words: "{{ words }}"
  - name: name
    value: "{{ name }}"
  - name: ocr_enabled
    value: {{ ocr_enabled }}
    default: false
  - name: sensitivity_levels
    description: |
      Sensitivity levels to associate with the profile.
    value:
      - group_id: "{{ group_id }}"
        level_id: "{{ level_id }}"
  - name: shared_entries
    description: |
      Entries from other profiles (e.g. pre-defined Cloudflare profiles, or your Microsoft Information Protection profiles).
    value:
      - enabled: {{ enabled }}
        entry_id: "{{ entry_id }}"

REPLACE examples

update_by_account

Updates a DLP custom profile.

REPLACE cloudflare.zero_trust.profiles_custom
SET 
ai_context_enabled = {{ ai_context_enabled }},
allowed_match_count = {{ allowed_match_count }},
confidence_threshold = '{{ confidence_threshold }}',
context_awareness = '{{ context_awareness }}',
data_classes = '{{ data_classes }}',
data_tags = '{{ data_tags }}',
description = '{{ description }}',
entries = '{{ entries }}',
name = '{{ name }}',
ocr_enabled = {{ ocr_enabled }},
sensitivity_levels = '{{ sensitivity_levels }}',
shared_entries = '{{ shared_entries }}'
WHERE 
account_id = '{{ account_id }}' --required
AND profile_id = '{{ profile_id }}' --required
AND name = '{{ name }}' --required
RETURNING
errors,
messages,
result,
success;

DELETE examples

delete_by_account

Deletes a DLP custom profile.

DELETE FROM cloudflare.zero_trust.profiles_custom
WHERE account_id = '{{ account_id }}' --required
AND profile_id = '{{ profile_id }}' --required
;