opentdf_configs

Creates, updates, deletes, gets or lists an opentdf_configs resource.

Overview

Name	opentdf_configs
Type	Resource
Id	aws.wickr.opentdf_configs

Fields

The following fields are returned by SELECT queries:

get_opentdf_config

Name	Datatype	Description
client_id	string	The OIDC client ID used for authenticating with the OpenTDF provider. (pattern: <code>[\S\s]*</code>)
client_secret	string	The OIDC client secret used for authenticating with the OpenTDF provider. (pattern: <code>[\S\s]*</code>)
domain	string	The domain of the OpenTDF server. (pattern: <code>[\S\s]*</code>)
provider	string	The provider of the OpenTDF platform. (pattern: <code>[\S\s]*</code>)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_opentdf_config	select	network_id, region		Retrieves the OpenTDF integration configuration for a Wickr network.
register_opentdf_config	insert	network_id, region, clientId, clientSecret, domain, provider	dryRun	Registers and saves OpenTDF configuration for a Wickr network, enabling attribute-based access control for Wickr through an OpenTDF provider.

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
network_id	string	The ID of the Wickr network for which OpenTDF integration will be configured.
region	string	AWS region (default: us-east-1)
dryRun	boolean	Perform dry-run test connection of OpenTDF configuration (optional).

SELECT examples

get_opentdf_config

Retrieves the OpenTDF integration configuration for a Wickr network.

SELECT
client_id,
client_secret,
domain,
provider
FROM aws.wickr.opentdf_configs
WHERE network_id = '{{ network_id }}' -- required
AND region = '{{ region }}' -- required
;

INSERT examples

register_opentdf_config

Registers and saves OpenTDF configuration for a Wickr network, enabling attribute-based access control for Wickr through an OpenTDF provider.

INSERT INTO aws.wickr.opentdf_configs (
clientId,
clientSecret,
domain,
provider,
network_id,
region,
dryRun
)
SELECT 
'{{ clientId }}' /* required */,
'{{ clientSecret }}' /* required */,
'{{ domain }}' /* required */,
'{{ provider }}' /* required */,
'{{ network_id }}',
'{{ region }}',
'{{ dryRun }}'
RETURNING
client_id,
client_secret,
domain,
provider
;

Manifest

# Description fields are for documentation purposes
- name: opentdf_configs
props:
  - name: network_id
    value: "{{ network_id }}"
    description: Required parameter for the opentdf_configs resource.
  - name: region
    value: "{{ region }}"
    description: Required parameter for the opentdf_configs resource.
  - name: clientId
    value: "{{ clientId }}"
  - name: clientSecret
    value: "{{ clientSecret }}"
  - name: domain
    value: "{{ domain }}"
  - name: provider
    value: "{{ provider }}"
  - name: dryRun
    value: {{ dryRun }}
    description: Perform dry-run test connection of OpenTDF configuration (optional).
    description: Perform dry-run test connection of OpenTDF configuration (optional).