entities

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

Overview

Name	entities
Type	Resource
Id	fivetran.external_secrets_managers.entities

Fields

The following fields are returned by SELECT queries:

list_by_esm

Name	Datatype	Description
id	string	The unique identifier of the source connection or destination. (example: connection_id)
name	string	The schema name of the source connection, or the name of the destination group. (example: my_schema)
secret_manager_id	string	The unique identifier of the External Secrets Manager instance. (example: lucky_tiger)
created_at	string (date-time)	Timestamp when the entity was created (example: 2024-01-01T00:00:00Z)
enabled	boolean	Whether the source connection or destination is currently active and connected.
type	string	The type of entity using this External Secrets Manager. Possible values: SOURCE, DESTINATION. (SOURCE, DESTINATION) (example: SOURCE)

list

Name	Datatype	Description
id	string	The unique identifier of the source connection or destination. (example: connection_id)
name	string	The schema name of the source connection, or the name of the destination group. (example: my_schema)
secret_manager_id	string	The unique identifier of the External Secrets Manager instance. (example: lucky_tiger)
created_at	string (date-time)	Timestamp when the entity was created (example: 2024-01-01T00:00:00Z)
enabled	boolean	Whether the source connection or destination is currently active and connected.
type	string	The type of entity using this External Secrets Manager. Possible values: SOURCE, DESTINATION. (SOURCE, DESTINATION) (example: SOURCE)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
list_by_esm	select	esm_id	type	Returns a list of source connections and destinations that are using a specific External Secrets Manager.
list	select		esm_id, type	Returns a list of all source connections and destinations that are using any External Secrets Manager within your Fivetran 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
esm_id	string	The unique identifier of the External Secrets Manager instance.
esm_id	string	Filter by a specific External Secrets Manager ID.
type	string	Filter by entity type. Accepted values are source, destination, or all.

SELECT examples

list_by_esm

Returns a list of source connections and destinations that are using a specific External Secrets Manager.

SELECT
id,
name,
secret_manager_id,
created_at,
enabled,
type
FROM fivetran.external_secrets_managers.entities
WHERE esm_id = '{{ esm_id }}' -- required
AND type = '{{ type }}'
;

list

Returns a list of all source connections and destinations that are using any External Secrets Manager within your Fivetran account.

SELECT
id,
name,
secret_manager_id,
created_at,
enabled,
type
FROM fivetran.external_secrets_managers.entities
WHERE esm_id = '{{ esm_id }}'
AND type = '{{ type }}'
;