Property description
The providers asset configures the settings of data ingestion providers on the connection selection page. This asset can be added only to core packages.
Minimal JSON
{
"key": "",
"name": "",
"ingestionTypeKey": "",
"connectionTemplate": {}
}{
"key": "core_amazon_s3",
"name": "Amazon S3",
"description": " ",
"ingestionTypeKey": "message_type_json",
"iconKey": "core_amazon_data_lake_storage_gen2",
"providerCategoryKey": "storage",
"isInstalled": false,
"connectionTemplate": {}
}Example taken from the core package.
Nested properties
| Property | Description | Values | Mandatory |
|---|---|---|---|
key | Key of the data ingestion provider. Supported values are: core_amazon_redshift, core_databricks, core_dbt, core_google_bigquery, core_keboola, core_mongodb, core_mysql, core_oracle, core_postgresql, core_power_bi, core_sap_hana, core_snowflake, core_sql_server, core_tableau | string | Yes |
name | Name of the asset, used as the default EN translation. | string | Yes |
ingestionTypeKey | Key of the ingestion type. Supported values are: message_type_json, raw_json | string | Yes |
connectionTemplate | Template of the provider’s card in the list of available connections. When left empty, the default template will contain: provider icon, provider name and description, installation status, Connect button | json | Yes |
description | Provider description. | string | No |
documentationUrl | URL of the documentation page detailing the configuration of the provider. | string | No |
iconKey | Key of the icon used to visually represent the asset. Use predefined icons from Settings > Configuration > Icons, or define custom ones in the icons asset. | string | No |
isInstalled | Determines whether the provider is installed in the environment. | boolean | No |
providerCategoryKey | Key of the category the provider belongs to. | string | No |
translations | Array of translation keys and their definitions that determine how the text is displayed in the UI for the specific asset. For more information, see Translations. | array | No |