secrets_managers
Creates, updates, deletes, gets or lists a secrets_managers resource.
Overview
| Name | secrets_managers |
| Type | Resource |
| Id | fivetran.external_secrets_managers.secrets_managers |
Fields
The following fields are returned by SELECT queries:
- get
- list
| Name | Datatype | Description |
|---|---|---|
id | string | The unique identifier of the External Secrets Manager instance. (example: lucky_tiger) |
name | string | The name of the ESM instance (example: My AWS Secrets Manager) |
config | object | Provider-specific configuration. |
created_at | string (date-time) | The timestamp when the ESM instance was created. (example: 2026-05-20T00:00:00Z) |
is_hybrid_deployment | boolean | Whether this External Secrets Manager instance is compatible with Hybrid Deployment environments. |
type | string | The ESM provider type (AWS_SECRET_MANAGER, AZURE_KEY_VAULT, HASHICORP_VAULT) (example: AWS_SECRET_MANAGER) |
updated_at | string (date-time) | The timestamp when the ESM instance was last updated. (example: 2026-05-20T00:00:00Z) |
| Name | Datatype | Description |
|---|---|---|
id | string | The unique identifier of the External Secrets Manager instance. (example: lucky_tiger) |
name | string | The name of the ESM instance (example: My AWS Secrets Manager) |
config | object | Provider-specific configuration. |
created_at | string (date-time) | The timestamp when the ESM instance was created. (example: 2026-05-20T00:00:00Z) |
is_hybrid_deployment | boolean | Whether this External Secrets Manager instance is compatible with Hybrid Deployment environments. |
type | string | The ESM provider type (AWS_SECRET_MANAGER, AZURE_KEY_VAULT, HASHICORP_VAULT) (example: AWS_SECRET_MANAGER) |
updated_at | string (date-time) | The timestamp when the ESM instance was last updated. (example: 2026-05-20T00:00:00Z) |
Methods
The following methods are available for this resource:
| Name | Accessible by | Required Params | Optional Params | Description |
|---|---|---|---|---|
get | select | esm_id | Returns the details of an existing External Secrets Manager instance. | |
list | select | cursor, limit | Returns a list of all External Secrets Manager instances within your Fivetran account. | |
create | insert | config, name, type | Creates a new External Secrets Manager instance within your Fivetran account. | |
update | update | esm_id, config | Updates the configuration of an existing External Secrets Manager instance. | |
delete | delete | esm_id | Deletes an External Secrets Manager instance from your Fivetran account. The instance must not be in use by any source connections or destinations. |
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. |
cursor | string | Paging cursor, [read more about pagination](https://fivetran.com/docs/rest-api/pagination) |
limit | integer (int32) | Number of records to fetch per page. Accepts a number in the range 1..1000; the default value is 100. |
SELECT examples
- get
- list
Returns the details of an existing External Secrets Manager instance.
SELECT
id,
name,
config,
created_at,
is_hybrid_deployment,
type,
updated_at
FROM fivetran.external_secrets_managers.secrets_managers
WHERE esm_id = '{{ esm_id }}' -- required
;
Returns a list of all External Secrets Manager instances within your Fivetran account.
SELECT
id,
name,
config,
created_at,
is_hybrid_deployment,
type,
updated_at
FROM fivetran.external_secrets_managers.secrets_managers
WHERE "limit" = '{{ limit }}'
;
INSERT examples
- create
- Manifest
Creates a new External Secrets Manager instance within your Fivetran account.
INSERT INTO fivetran.external_secrets_managers.secrets_managers (
type,
name,
config,
is_hybrid_deployment
)
SELECT
'{{ type }}' /* required */,
'{{ name }}' /* required */,
'{{ config }}' /* required */,
{{ is_hybrid_deployment }}
RETURNING
id,
name,
config,
created_at,
is_hybrid_deployment,
type,
updated_at
;
# Description fields are for documentation purposes
- name: secrets_managers
props:
- name: type
value: "{{ type }}"
description: |
The ESM provider type. Supported values: AWS_SECRET_MANAGER, AZURE_KEY_VAULT, HASHICORP_VAULT.
valid_values: ['AWS_SECRET_MANAGER', 'AZURE_KEY_VAULT', 'HASHICORP_VAULT']
- name: name
value: "{{ name }}"
description: |
The name of the External Secrets Manager instance. Must be unique within the account.
- name: config
value: "{{ config }}"
description: |
Provider-specific configuration object. For AWS_SECRET_MANAGER: role_arn (required). For AZURE_KEY_VAULT: vault_url (required), tenant_id (required for SaaS). For HASHICORP_VAULT: vault_address (required), role_id and secret_id (required for SaaS), namespace (optional).
- name: is_hybrid_deployment
value: {{ is_hybrid_deployment }}
description: |
Whether this External Secrets Manager instance is compatible with Hybrid Deployment environments.
UPDATE examples
- update
Updates the configuration of an existing External Secrets Manager instance.
UPDATE fivetran.external_secrets_managers.secrets_managers
SET
config = '{{ config }}'
WHERE
esm_id = '{{ esm_id }}' --required
AND config = '{{ config }}' --required
RETURNING
id,
name,
config,
created_at,
is_hybrid_deployment,
type,
updated_at;
DELETE examples
- delete
Deletes an External Secrets Manager instance from your Fivetran account. The instance must not be in use by any source connections or destinations.
DELETE FROM fivetran.external_secrets_managers.secrets_managers
WHERE esm_id = '{{ esm_id }}' --required
;