profiles_predefined

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

Overview

Name	profiles_predefined
Type	Resource
Id	cloudflare.zero_trust.profiles_predefined

Fields

The following fields are returned by SELECT queries:

get

Predefined 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.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	account_id, profile_id		Fetches a predefined DLP profile by id.
dlp_profiles_create_predefined_profile	insert	account_id, profile_id		Creates a DLP predefined profile. Only supports enabling/disabling entries.
delete_by_account	delete	account_id, profile_id		This is a no-op as predefined profiles can't be deleted but is needed for our generated terraform API.

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

Fetches a predefined 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_predefined
WHERE account_id = '{{ account_id }}' -- required
AND profile_id = '{{ profile_id }}' -- required
;

INSERT examples

dlp_profiles_create_predefined_profile

Creates a DLP predefined profile. Only supports enabling/disabling entries.

INSERT INTO cloudflare.zero_trust.profiles_predefined (
ai_context_enabled,
allowed_match_count,
confidence_threshold,
context_awareness,
entries,
ocr_enabled,
profile_id,
account_id
)
SELECT 
{{ ai_context_enabled }},
{{ allowed_match_count }},
'{{ confidence_threshold }}',
'{{ context_awareness }}',
'{{ entries }}',
{{ ocr_enabled }},
'{{ profile_id }}' /* required */,
'{{ account_id }}'
RETURNING
errors,
messages,
result,
success
;

Manifest

# Description fields are for documentation purposes
- name: profiles_predefined
props:
  - name: account_id
    value: "{{ account_id }}"
    description: Required parameter for the profiles_predefined resource.
  - name: ai_context_enabled
    value: {{ ai_context_enabled }}
    default: false
  - name: allowed_match_count
    value: {{ allowed_match_count }}
    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: entries
    value:
      - enabled: {{ enabled }}
        id: "{{ id }}"
  - name: ocr_enabled
    value: {{ ocr_enabled }}
    default: false
  - name: profile_id
    value: "{{ profile_id }}"

DELETE examples

delete_by_account

This is a no-op as predefined profiles can't be deleted but is needed for our generated terraform API.

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