import * as outputs from "../types/output";
export interface ConnectionDestinationSchema {
/**
* The connection schema name in destination. Has to be unique within the group (destination). Required for connection creation.
*/
name?: string;
/**
* The connection schema prefix has to be unique within the group (destination). Each replicated schema is prefixed with the provided value. Required for connection creation.
*/
prefix?: string;
/**
* The table name unique within the schema to which connection will sync the data. Required for connection creation.
*/
table?: string;
/**
* Table group name.
*/
tableGroupName?: string;
}
export interface ConnectorAuth {
/**
* Field usage depends on `service` value:
* - Service `amazon_dsp`: Your Amazon DSP access token.
* - Service `autodesk_bim_360`: Your Autodesk BIM 360 Access Token.
* - Service `azure_sql_db`: The long-lived Access token carries the information necessary to access API resources.
* - Service `azure_sql_managed_db`: The long-lived Access token carries the information necessary to access API resources.
* - Service `billing_platform`: Your BillingPlatform access token.
* - Service `calendly`: Your Calendly access token.
* - Service `docebo`: Your Docebo Access Token.
* - Service `drift`: Your Drift access token.
* - Service `employment_hero`: Your Employment Hero access token.
* - Service `facebook_ads`: The long-lived `Access token` along with the `client_id` and `client_secret` parameters carry the information necessary to query the Facebook Ads API. Use either `access_token` or `user_access_token`, not both at the same time.
* - Service `facebook_pages`: The `Access Token` carries the information necessary for API resources to fetch data
* - Service `freshbooks`: Your FreshBooks Access Token.
* - Service `gitlab`: Your GitLab access token.
* - Service `gmail`: The `Access Token` that carries the information necessary for API resources to fetch data.
* - Service `google_business_profile`: Your Google Business Profile Access token.
* - Service `google_calendar`: Your Google Calendar access token.
* - Service `google_classroom`: The `Access Token` that carries the information necessary for API resources to fetch data.
* - Service `google_tasks`: The access token that carries the information necessary for API resources to your Google Tasks fetch data.
* - Service `instagram_business`: The `Access Token` carries the information necessary for API resources to fetch data
* - Service `intercom`: The long-lived `Access Token` carries the information necessary for API resources to fetch data.
* - Service `lightspeed_retail_xseries`: Your Lightspeed Retail X-Series access token.
* - Service `medallia`: Your Medallia access token that contains all the information necessary for the API resources to fetch your data.
* - Service `pinterest_organic`: Your Pinterest access token.
* - Service `ramp`: Your Ramp access token.
* - Service `ringcentral`: The long-lived `Access token` carries the information necessary to access API resources.
* - Service `shopify`: The Shopify access token.
* - Service `slack`: Your Slack access token.
* - Service `stripe`: The Stripe API Restricted Key
* - Service `stripe_test`: The Stripe API Restricted Key
* - Service `survey_monkey`: The long-lived `Access token` carries the information necessary to access API resources.
* - Service `tiktok_ads`: The long-lived `Access token` carries the information necessary to access API resources.
* - Service `tiktok_organic_app`: Your TikTok Organic access token.
* - Service `tremendous`: Your Tremendous access token.
* - Service `typeform`: The Typeform API access token.
* - Service `yahoo_search_ads_yahoo_japan`: Your Yahoo Search Ads Access Token.
* - Service `zendesk`: The long-lived `Access token` carries the information necessary to access API resources.
* - Service `zendesk_chat`: The long-lived `Access token` carries the information necessary to access API resources.
* - Service `zendesk_sell`: The long-lived `Access token` carries the information necessary to access API resources.
* - Service `zoom`: Your Zoom Access token.
*/
accessToken?: string;
/**
* Field usage depends on `service` value:
* - Service `elastic_cloud`: The Elasticsearch API key. If omitted, then basic user and password authentication will apply.
* - Service `es_self_hosted`: The Elasticsearch API key. If omitted, then basic user and password authentication will apply.
*/
apiKey?: string;
/**
* Field usage depends on `service` value:
* - Service `amazon_selling_partner`: `Application ID` of the public application registered in the Amazon Selling Partner Appstore that you want to use for authentication of your connection. Use this parameter along with `Client ID` and `Client Secret` only if you want to use your own public application for authorisation via Connect Card.
*/
applicationId?: string;
/**
* Field usage depends on `service` value:
* - Service `google_play`: Authentication Method
*/
authenticationMethod?: string;
/**
* Field usage depends on `service` value:
* - Service `amazon_selling_partner`: `AWS Access Key` of your AWS Account User.
*/
awsAccessKey?: string;
/**
* Field usage depends on `service` value:
* - Service `amazon_selling_partner`: `AWS Secret Key` of your AWS Account User.
*/
awsSecretKey?: string;
clientAccess?: outputs.ConnectorAuthClientAccess;
/**
* Field usage depends on `service` value:
* - Service `amazon_selling_partner`: `Client ID` of your Amazon Seller/Vendor Central client application.
* - Service `apple_search_ads`: Apple Search Ads REST API Client ID. Must be populated if `is_auth2_enabled` is set to `true`.
* - Service `azure_blob_storage`: `Client ID` of your Microsoft client application.
* - Service `microsoft_dynamics_365_fno`: `Client ID` of your Microsoft client application.
* - Service `workday`: Client ID
* - Service `workday_financial_management`: ID of your Workday Client App
* - Service `workday_hcm`: ID of your Workday Client App
* - Service `yahoo_dsp`: Your Yahoo DSP Client ID.
*/
clientId?: string;
/**
* Field usage depends on `service` value:
* - Service `amazon_selling_partner`: `Client Secret` of your Amazon Seller/Vendor Central client application.
* - Service `azure_blob_storage`: `Client Secret` of your Microsoft client application.
* - Service `microsoft_dynamics_365_fno`: `Client Secret` of your Microsoft client application.
* - Service `workday`: Client Secret
* - Service `workday_financial_management`: Secret of your Workday Client App
* - Service `workday_hcm`: Secret of your Workday Client App
* - Service `yahoo_dsp`: Your Yahoo DSP Client Secret.
*/
clientSecret?: string;
/**
* Field usage depends on `service` value:
* - Service `twitter`: API Key of your app
* - Service `twitter_ads`: The Twitter App consumer key.
*/
consumerKey?: string;
/**
* Field usage depends on `service` value:
* - Service `twitter`: API Secret of your app
* - Service `twitter_ads`: The Twitter App consumer secret.
*/
consumerSecret?: string;
/**
* Field usage depends on `service` value:
* - Service `apple_search_ads`: Apple Search Ads REST API Key ID. Must be populated if `is_auth2_enabled` is set to `true`.
*/
keyId?: string;
/**
* Field usage depends on `service` value:
* - Service `azure_sql_db`: User Assigned Managed Identity Client ID.
* - Service `azure_sql_managed_db`: User Assigned Managed Identity Client ID.
*/
managedIdentityUserAssigned?: string;
/**
* Field usage depends on `service` value:
* - Service `twitter`: The Twitter App access token.
* - Service `twitter_ads`: The Twitter App access token.
*/
oauthToken?: string;
/**
* Field usage depends on `service` value:
* - Service `twitter`: The Twitter App access token secret.
* - Service `twitter_ads`: The Twitter App access token secret.
*/
oauthTokenSecret?: string;
ocapiAccessToken?: string;
ocapiRefreshToken?: string;
/**
* Field usage depends on `service` value:
* - Service `dynamics_365`: Previous `Refresh token` of your application.
*/
previousRefreshToken?: string;
/**
* Field usage depends on `service` value:
* - Service `quickbooks`: `Realm ID` of your QuickBooks application.
*/
realmId?: string;
/**
* Field usage depends on `service` value:
* - Service `adroll`: The long-lived `Refresh token` along with the `client_id` and `client_secret` parameters carry the information necessary to get a new access token for API resources.
* - Service `airtable`: The long-lived refresh token along with the client ID and client secret carry the information necessary to get a new access token for API resources.
* - Service `amazon_ads`: The long-lived `Refresh token` along with the `client_id` and `client_secret` parameters carry the information necessary to get a new access token for API resources.
* - Service `amazon_dsp`: Your Amazon DSP refresh token.
* - Service `amazon_selling_partner`: The long-lived `Refresh token` along with the `client_id` and `client_secret` parameters carry the information necessary to get a new access token for API resources.
* - Service `asana`: The long-lived `Refresh token` along with the `client_id` and `client_secret` parameters carry the information necessary to get a new access token for API resources.
* - Service `autodesk_bim_360`: Your Autodesk BIM 360 Refresh Token.
* - Service `azure_service_bus`: The refresh token. Required if the authentication type is `AzureActiveDirectory`
* - Service `azure_sql_db`: The long-lived Refresh token carries the information necessary to get a new access token for API resources.
* - Service `azure_sql_managed_db`: The long-lived Refresh token carries the information necessary to get a new access token for API resources.
* - Service `billing_platform`: Your BillingPlatform refresh token.
* - Service `bingads`: The long-lived `Refresh token` along with the `client_id` and `client_secret` parameters carry the information necessary to get a new access token for API resources.
* - Service `business_central`: The long-lived refresh token along with the client ID and client secret parameters carry the information necessary to get a new access token for API resources.
* - Service `calendly`: Your Calendly refresh token.
* - Service `docebo`: Your Docebo Refresh Token.
* - Service `double_click_campaign_manager`: The long-lived `Refresh token` along with the `client_id` and `client_secret` parameters carry the information necessary to get a new access token for API resources.
* - Service `double_click_publishers`: The long-lived `Refresh token` along with the `client_id` and `client_secret` parameters carry the information necessary to get a new access token for API resources.
* - Service `drift`: Your Drift refresh token.
* - Service `dropbox`: The long-lived `Refresh token` along with the `client_id` and `client_secret` parameters carry the information necessary to get a new access token for API resources.
* - Service `dynamics_365`: The long-lived `Refresh token` along with the `client_id` and `client_secret` parameters carry the information necessary to get a new access token for API resources.
* - Service `employment_hero`: Your Employment Hero refresh token.
* - Service `financial_force`: The long-lived `Refresh token` along with the `client_id` and `client_secret` parameters carry the information necessary to get a new access token for API resources.
* - Service `freshbooks`: Your FreshBooks Refresh Token.
* - Service `front`: The long-lived `Refresh token` along with the `client_id` and `client_secret` parameters carry the information necessary to get a new access token for API resources.
* - Service `gitlab`: Your GitLab refresh token.
* - Service `gmail`: The long-lived `Refresh token` of your Gmail client application.
* - Service `google_ads`: The long-lived `Refresh token` along with the `client_id` and `client_secret` parameters carry the information necessary to get a new access token for API resources.
* - Service `google_analytics`: The long-lived `Refresh token` along with the `client_id` and `client_secret` parameters carry the information necessary to get a new access token for API resources.
* - Service `google_analytics_4`: The long-lived `Refresh token` along with the `client_id` and `client_secret` parameters carry the information necessary to get a new access token for API resources.
* - Service `google_analytics_mcf`: The long-lived `Refresh token` along with the `client_id` and `client_secret` parameters carry the information necessary to get a new access token for API resources.
* - Service `google_business_profile`: Your Google Business Profile Refresh token.
* - Service `google_calendar`: Your Google Calendar refresh token.
* - Service `google_classroom`: The long-lived `Refresh token` of your Google Calendar client application.
* - Service `google_display_and_video_360`: The long-lived `Refresh token` along with the `client_id` and `client_secret` parameters carry the information necessary to get a new access token for API resources.
* - Service `google_play`: The long-lived `Refresh token` along with the `client_id` and `client_secret` parameters carry the information necessary to get a new access token for API resources.
* - Service `google_search_ads_360`: The long-lived `Refresh token` along with the `client_id` and `client_secret` parameters carry the information necessary to get a new access token for API resources.
* - Service `google_sheets`: The long-lived `Refresh token` along with the `client_id` and `client_secret` parameters carry the information necessary to get a new access token for API resources.
* - Service `google_tasks`: The long-lived refresh token of your Google Tasks client application.
* - Service `helpscout`: The long-lived `refresh token` along with the `client_id` and `client_secret` parameters carry the information necessary to get a new access token for API resources.
* - Service `hubspot`: The long-lived `Refresh token` along with the `client_id` and `client_secret` parameters carry the information necessary to get a new access token for API resources.
* - Service `lightspeed_retail_xseries`: Your Lightspeed Retail X-Series refresh token.
* - Service `linkedin_ads`: The long-lived `Refresh token` along with the `client_id` and `client_secret` parameters carry the information necessary to get a new access token for API resources.
* - Service `linkedin_company_pages`: The long-lived `Refresh token` along with the `client_id` and `client_secret` parameters carry the information necessary to get a new access token for API resources.
* - Service `microsoft_lists`: The long-lived Refresh token carries the information necessary to get a new access token for API resources.
* - Service `one_drive`: The long-lived `Refresh token` carries the information necessary to get a new access token for API resources.
* - Service `optimizely`: The long-lived `Refresh token` along with the `client_id` and `client_secret` parameters carry the information necessary to get a new access token for API resources.
* - Service `outreach`: The long-lived `Refresh token` along with the `client_id` and `client_secret` parameters carry the information necessary to get a new access token for API resources.
* - Service `pinterest_ads`: The long-lived `Refresh token` along with the `client_id` and `client_secret` parameters carry the information necessary to get a new access token for API resources.
* - Service `pinterest_organic`: Your Pinterest refresh token.
* - Service `pipedrive`: The long-lived `Refresh token` along with the `client_id` and `client_secret` parameters carry the information necessary to get a new access token for API resources.
* - Service `qualtrics`: The long-lived `Refresh token` along with the `client_id` and `client_secret` parameters carry the information necessary to get a new access token for API resources.
* - Service `quickbooks`: The long-lived `Refresh token` along with the `client_id` and `client_secret` parameters carry the information necessary to get a new access token for API resources.
* - Service `ramp`: Your Ramp refresh token.
* - Service `reddit_ads`: The long-lived `Refresh token` along with the `client_id` and `client_secret` parameters carry the information necessary to get a new access token for API resources.
* - Service `salesforce`: The long-lived `Refresh token` along with the `client_id` and `client_secret` parameters carry the information necessary to get a new access token for API resources.
* - Service `salesforce_sandbox`: The long-lived `Refresh token` along with the `client_id` and `client_secret` parameters carry the information necessary to get a new access token for API resources.
* - Service `salesloft`: The long-lived `Refresh token` along with the `client_id` and `client_secret` parameters carry the information necessary to get a new access token for API resources.
* - Service `share_point`: The long-lived Refresh token carries the information necessary to get a new access token for API resources.
* - Service `slack`: Your Slack refresh token.
* - Service `snapchat_ads`: The long-lived `Refresh token` along with the `client_id` and `client_secret` parameters carry the information necessary to get a new access token for API resources.
* - Service `spotify_ads`: The long-lived `Refresh token` along with the `client_id` and `client_secret` parameters carry the information necessary to get a new access token for API resources.
* - Service `tiktok_organic_app`: Your TikTok Organic refresh token.
* - Service `tremendous`: Your Tremendous refresh token.
* - Service `typeform`: The Typeform API refresh token.
* - Service `workday`: OAuth Refresh Token
* - Service `yahoo_search_ads_yahoo_japan`: Your Yahoo Search Ads Refresh Token.
* - Service `youtube_analytics`: The long-lived `Refresh token` along with the `client_id` and `client_secret` parameters carry the information necessary to get a new access token for API resources.
* - Service `zoho_crm`: The long-lived `Refresh token`, along with the `client_id` and `client_secret` parameters, carries the information necessary to get a new access token for API resources.
* - Service `zoom`: Your Zoom Refresh token.
*/
refreshToken?: string;
/**
* Field usage depends on `service` value:
* - Service `amazon_selling_partner`: `IAM Role ARN` of your AWS Account.
*/
roleArn?: string;
/**
* Field usage depends on `service` value:
* - Service `azure_sql_db`: Contents of Service Principal Client Certificate Private Key.
* - Service `azure_sql_managed_db`: Contents of Service Principal Client Certificate Private Key.
*/
servicePrincipalClientCertPvtKey?: string;
/**
* Field usage depends on `service` value:
* - Service `azure_sql_db`: Contents of Service Principal Client Certificate.
* - Service `azure_sql_managed_db`: Contents of Service Principal Client Certificate.
*/
servicePrincipalClientCertificate?: string;
/**
* Field usage depends on `service` value:
* - Service `azure_sql_db`: Service Principal Client Secret.
* - Service `azure_sql_managed_db`: Service Principal Client Secret.
*/
servicePrincipalClientSecret?: string;
/**
* Field usage depends on `service` value:
* - Service `azure_sql_db`: Service Principal Client ID.
* - Service `azure_sql_managed_db`: Service Principal Client ID.
*/
servicePrincipalId?: string;
/**
* Field usage depends on `service` value:
* - Service `google_play`: Service account secret key
*/
svcAccSecretKey?: string;
systemUserAccessToken?: string;
/**
* Field usage depends on `service` value:
* - Service `apple_search_ads`: Apple Search Ads REST API Team ID. Must be populated if `is_auth2_enabled` is set to `true`.
*/
teamId?: string;
/**
* Field usage depends on `service` value:
* - Service `azure_blob_storage`: `Tenant ID` of your Microsoft client application.
* - Service `microsoft_dynamics_365_fno`: `Tenant ID` of your Microsoft client application.
* - Service `microsoft_lists`: `Tenant ID` of your Microsoft client application.
* - Service `share_point`: `Tenant ID` of your Microsoft client application.
*/
tenantId?: string;
/**
* Field usage depends on `service` value:
* - Service `facebook_ads`: System User Token. Use in combination with `client_id` and `client_secret`. Use either `user_access_token` (for system token) or `access_token` (for user access token), not both at the same time.
*/
userAccessToken?: string;
}
export interface ConnectorAuthClientAccess {
/**
* Field usage depends on `service` value:
* - Service `adroll`: `Client ID` of your AdRoll client application.
* - Service `airtable`: `Client ID` of your Airtable client application.
* - Service `amazon_ads`: `Client ID` of your Amazon Ads client application.
* - Service `asana`: `Client ID` of your Asana client application.
* - Service `azure_service_bus`: `Client ID` of your Azure application. Required if the authentication type is `AzureActiveDirectory`
* - Service `bingads`: `Client ID` of your Microsoft Advertising client application.
* - Service `business_central`: `Client ID` of your Airtable client application.
* - Service `double_click_campaign_manager`: `Client ID` of your Google Campaign Manager 360 client application.
* - Service `double_click_publishers`: `Client ID` of your Google Ad Manager client application.
* - Service `dropbox`: `Client ID` of your Dropbox client application.
* - Service `dynamics_365`: Client ID of your Dynamics 365 client application, or service principal.
* - Service `facebook_ads`: `Client ID` of your Facebook client application.
* - Service `facebook_pages`: `Client ID` of your Facebook client application.
* - Service `financial_force`: `Client ID` of your Salesforce client application.
* - Service `front`: `Client ID` of your Front client application.
* - Service `gmail`: `Client ID` of your Gmail client application.
* - Service `google_ads`: `Client ID` of your Google Ads client application.
* - Service `google_analytics`: `Client ID` of your Google Analytics client application.
* - Service `google_analytics_4`: `Client ID` of your Google Analytics client application.
* - Service `google_analytics_mcf`: `Client ID` of your Google Analytics client application.
* - Service `google_display_and_video_360`: `Client ID` of your Google Display & Video 360 client application.
* - Service `google_play`: `Client ID` of your Google Play client application.
* - Service `google_search_ads_360`: `Client ID` of your Google Search Ads 360 client application.
* - Service `google_search_console`: `Client ID` of your Google Search Console client application.
* - Service `google_sheets`: `Client ID` of your Google Sheets client application.
* - Service `helpscout`: `Client ID` of your Help Scout client application.
* - Service `hubspot`: `Client ID` of your HubSpot client application.
* - Service `instagram_business`: `Client ID` of your Facebook client application.
* - Service `lightspeed_retail_xseries`: `Client ID` of your Lightspeed Retail X-Series client application.
* - Service `linkedin_ads`: `Client ID` of your LinkedIn client application.
* - Service `linkedin_company_pages`: `Client ID` of your LinkedIn client application.
* - Service `microsoft_lists`: `Client ID` of your Microsoft client application.
* - Service `one_drive`: `Client ID` of your Microsoft OneDrive client application.
* - Service `optimizely`: `Client ID` of your Optimizely client application.
* - Service `outreach`: `Client ID` of your Outreach client application.
* - Service `pardot`: `Client ID` of your Pardot client application.
* - Service `pardot_sandbox`: `Client ID` of your Pardot client application.
* - Service `pinterest_ads`: `Client ID` of your Pinterest client application.
* - Service `pipedrive`: `Client ID` of your Pipedrive client application.
* - Service `qualtrics`: `Client ID` of your Qualtrics client application.
* - Service `quickbooks`: `Client ID` of your QuickBooks client application.
* - Service `reddit_ads`: `Client ID` of your Reddit Ads client application.
* - Service `salesforce`: `Client ID` of your Salesforce client application.
* - Service `salesforce_sandbox`: `Client ID` of your Salesforce client application.
* - Service `share_point`: `Client ID` of your Microsoft client application.
* - Service `snapchat_ads`: `Client ID` of your Snapchat Ads client application.
* - Service `spotify_ads`: `Client ID` of your Ad Studio application.
* - Service `survey_monkey`: `Client ID` of your SurveyMonkey client application.
* - Service `tiktok_ads`: `Client ID` of your TikTok Ads client application.
* - Service `twitter`: `Client ID` of your Twitter client application.
* - Service `twitter_ads`: `Client ID` of your Twitter Ads client application.
* - Service `typeform`: The Typeform client ID.
* - Service `yahoo_gemini`: `Client ID` of your Yahoo Gemini client application.
* - Service `youtube_analytics`: `Client ID` of your Youtube client application.
* - Service `zendesk`: `Identifier` of your Zendesk Confidential OAuth client app.
* - Service `zoho_crm`: `Client ID` of your Zoho client application.
*/
clientId?: string;
/**
* Field usage depends on `service` value:
* - Service `adroll`: `Client Secret` of your AdRoll client application.
* - Service `airtable`: `Client Secret` of your Airtable client application.
* - Service `amazon_ads`: `Client Secret` of your Amazon Ads client application.
* - Service `asana`: `Client Secret` of your Asana client application.
* - Service `azure_service_bus`: `Client Secret` of your Azure application. Required if the authentication type is `AzureActiveDirectory`
* - Service `bingads`: `Client Secret` of your Microsoft Advertising client application.
* - Service `business_central`: `Client Secret` of your Airtable client application.
* - Service `double_click_campaign_manager`: `Client Secret` of your Google Campaign Manager 360 client application.
* - Service `double_click_publishers`: `Client Secret` of your Google Ad Manager client application.
* - Service `dropbox`: `Client Secret` of your Dropbox client application.
* - Service `dynamics_365`: Client Secret of your Dynamics 365 client application, or service principal.
* - Service `facebook_ads`: `Client Secret` of your Facebook client application.
* - Service `facebook_pages`: `Client Secret` of your Facebook client application.
* - Service `financial_force`: `Client Secret` of your Salesforce client application.
* - Service `front`: `Client Secret` of your Front client application.
* - Service `gmail`: `Client Secret` of your Gmail client application.
* - Service `google_ads`: `Client Secret` of your Google Ads client application.
* - Service `google_analytics`: `Client Secret` of your Google Analytics client application.
* - Service `google_analytics_4`: `Client Secret` of your Google Analytics client application.
* - Service `google_analytics_mcf`: `Client Secret` of your Google Analytics client application.
* - Service `google_display_and_video_360`: `Client Secret` of your Google Display & Video 360 client application.
* - Service `google_play`: `Client Secret` of your Google Play client application.
* - Service `google_search_ads_360`: `Client Secret` of your Google Search Ads 360 client application.
* - Service `google_search_console`: `Client Secret` of your Google Search Console client application.
* - Service `google_sheets`: `Client Secret` of your Google Sheets client application.
* - Service `helpscout`: `Client Secret` of your Help Scout client application.
* - Service `hubspot`: `Client Secret` of your HubSpot client application.
* - Service `instagram_business`: `Client Secret` of your Facebook client application.
* - Service `lightspeed_retail_xseries`: `Client Secret` of your Lightspeed Retail X-Series client application.
* - Service `linkedin_ads`: `Client Secret` of your LinkedIn client application.
* - Service `linkedin_company_pages`: `Client Secret` of your LinkedIn client application.
* - Service `microsoft_lists`: `Client Secret` of your Microsoft client application.
* - Service `one_drive`: `Client Secret` of your Microsoft OneDrive client application.
* - Service `optimizely`: `Client Secret` of your Optimizely client application.
* - Service `outreach`: `Client Secret` of your Outreach client application.
* - Service `pardot`: `Client Secret` of your Pardot client application.
* - Service `pardot_sandbox`: `Client Secret` of your Pardot client application.
* - Service `pinterest_ads`: `Client Secret` of your Pinterest client application.
* - Service `pipedrive`: `Client Secret` of your Pipedrive client application.
* - Service `qualtrics`: `Client Secret` of your Qualtrics client application.
* - Service `quickbooks`: `Client Secret` of your QuickBooks client application.
* - Service `reddit_ads`: `Client Secret` of your Reddit Ads client application.
* - Service `salesforce`: `Client Secret` of your Salesforce client application.
* - Service `salesforce_sandbox`: `Client Secret` of your Salesforce client application.
* - Service `share_point`: `Client Secret` of your Microsoft client application.
* - Service `snapchat_ads`: `Client Secret` of your Snapchat Ads client application.
* - Service `spotify_ads`: `Client Secret` of your Ad Studio application.
* - Service `survey_monkey`: `Client Secret` of your SurveyMonkey client application.
* - Service `tiktok_ads`: `Client Secret` of your TikTok Ads client application.
* - Service `twitter`: `Client Secret` of your Twitter client application.
* - Service `twitter_ads`: `Client Secret` of your Twitter Ads client application.
* - Service `typeform`: The Typeform client secret.
* - Service `yahoo_gemini`: `Client Secret` of your Yahoo Gemini client application.
* - Service `youtube_analytics`: `Client Secret` of your Youtube client application.
* - Service `zendesk`: `Client Secret` of your Zendesk Confidential OAuth client app.
* - Service `zoho_crm`: `Client Secret` of your Zoho client application.
*/
clientSecret?: string;
/**
* Field usage depends on `service` value:
* - Service `google_ads`: Not required. You can provide your own developer token with your custom client.
*/
developerToken?: string;
/**
* Field usage depends on `service` value:
* - Service `google_ads`: Your company's name in your Google Ads client application.
*/
userAgent?: string;
}
export interface ConnectorCertificatesCertificate {
/**
* Base64 encoded certificate.
*/
encodedCert: string;
/**
* Hash of the certificate.
*/
hash: string;
/**
* Certificate name.
*/
name: string;
/**
* The SSH public key.
*/
publicKey: string;
/**
* Certificate sha1.
*/
sha1: string;
/**
* Certificate sha256.
*/
sha256: string;
/**
* Type of the certificate.
*/
type: string;
/**
* User name who validated the certificate.
*/
validatedBy: string;
/**
* The date when certificate was approved.
*/
validatedDate: string;
}
export interface ConnectorConfig {
/**
* Field usage depends on `service` value:
* - Service `adobe_analytics_data_feed`: Azure Blob Storage connection method
*/
absConnectionMethod?: string;
/**
* Field usage depends on `service` value:
* - Service `adobe_analytics_data_feed`: Azure Blob Storage connection string.
* - Service `braze`: Connection String
*/
absConnectionString: string;
/**
* Field usage depends on `service` value:
* - Service `adobe_analytics_data_feed`: Azure Blob Storage container address
*/
absContainerAddress?: string;
/**
* Field usage depends on `service` value:
* - Service `adobe_analytics_data_feed`: Azure Blob Storage container name.
* - Service `braze`: Container Name
*/
absContainerName: string;
/**
* Field usage depends on `service` value:
* - Service `adobe_analytics_data_feed`: Azure Blob Storage host IP
*/
absHostIp?: string;
/**
* Field usage depends on `service` value:
* - Service `adobe_analytics_data_feed`: Azure Blob Storage username
*/
absHostUser?: string;
/**
* Field usage depends on `service` value:
* - Service `braze`: Prefix
*/
absPrefix?: string;
/**
* Field usage depends on `service` value:
* - Service `adobe_analytics_data_feed`: Azure Blob Storage public key
*/
absPublicKey?: string;
/**
* Field usage depends on `service` value:
* - Service `workramp`: Your WorkRamp academy ID.
*/
academyId?: string;
/**
* Field usage depends on `service` value:
* - Service `ceridian_dayforce`: Your confirmation that you have granted Fivetran access to all the RESTful services and fields you want to sync. Possible values: `true`, `false`.
*/
accessConfirmation?: string;
/**
* Field usage depends on `service` value:
* - Service `planful`: Your Planful access ID.
*/
accessId?: string;
/**
* Field usage depends on `service` value:
* - Service `gainsight_customer_success`: The access key for API authentication.
* - Service `gongio`: Your Gongio Access key.
* - Service `line_ads`: Your LINE Ads access key.
* - Service `planful`: Your Planful access key.
* - Service `retailnext`: Your RetailNext access key.
*/
accessKey: string;
/**
* Field usage depends on `service` value:
* - Service `appsflyer`: Your AWS access key ID.
* - Service `aws_cost_report`: Access Key ID
* - Service `checkout`: Your Checkout.com access key ID.
* - Service `cloudtalk`: Your CloudTalk Access Key ID.
* - Service `nice`: Your NICE access key ID.
* - Service `s3`: Access Key ID
* - Service `s3_compatible_storage`: Access Key ID
* - Service `validio`: Your Validio access key ID.
* - Service `wasabi_cloud_storage`: Access Key ID
*/
accessKeyId: string;
/**
* Field usage depends on `service` value:
* - Service `aws_cost_report`: Access Key Secret
* - Service `checkout`: Your Checkout.com access key secret.
* - Service `cloudtalk`: Your CloudTalk Access Key Secret.
* - Service `gongio`: Your Gongio Access Key Secret.
* - Service `nice`: Your NICE access key secret.
* - Service `s3`: Access Key Secret
* - Service `s3_compatible_storage`: Access Key Secret
* - Service `wasabi_cloud_storage`: Access Key Secret
*/
accessKeySecret?: string;
/**
* Field usage depends on `service` value:
* - Service `7shifts`: Your 7shifts access token.
* - Service `attio`: Your Attio bearer token
* - Service `big_commerce`: Your [API access token ](https://fivetran.com/docs/connectors/applications/big-commerce/setup-guide#createaccesstoken).
* - Service `bitly`: Your Bitly access token.
* - Service `calabrio`: Your Calabrio access token.
* - Service `coalesce`: Your Coalesce access token.
* - Service `coheris`: Your Coheris access token.
* - Service `coupa`: Your Coupa access token fetched using client_id and client_secret
* - Service `deputy`: Your Deputy API access token.
* - Service `getfeedback`: Your GetFeedback Access token.
* - Service `gocardless`: Your GoCardless API token.
* - Service `higher_logic_vanilla`: Your Higher Logic Vanilla access token.
* - Service `ironclad`: Your Ironclad access token.
* - Service `khoros_marketing`: Your Khoros Marketing access token.
* - Service `kustomer`: Your Kustomer API key.
* - Service `lattice`: Your Lattice API access token.
* - Service `launchdarkly`: Your LaunchDarkly access token.
* - Service `leap_crm`: Your Leap CRM access token.
* - Service `nylas`: Your Nylas access_token.
* - Service `planhat`: Your Planhat access token.
* - Service `poplar`: Your Poplar access token.
* - Service `rollbar`: Your Rollbar Access Token.
* - Service `samsara`: Your Samsara API token.
* - Service `slab`: Your Slab API key.
* - Service `stripe`: The Stripe API Restricted Key
* - Service `stripe_test`: The Stripe API Restricted Key
* - Service `talkwalker`: Your Talkwalker access token.
* - Service `workable`: Your Workable Access Token.
* - Service `workramp`: Your WorkRamp access token.
*/
accessToken: string;
/**
* Field usage depends on `service` value:
* - Service `share_point`: Access Type
*/
accessType?: string;
/**
* Field usage depends on `service` value:
* - Service `netsuite_suiteanalytics`: The NetSuite Account ID.
* - Service `ordway`: Your Ordway account type.
*/
account: string;
/**
* Field usage depends on `service` value:
* - Service `rollbar`: Your Rollbar account access token.
*/
accountAccessToken?: string;
/**
* Field usage depends on `service` value:
* - Service `appcues`: Your Appcues Account ID.
* - Service `bizzabo_app`: Your Bizzabo account ID.
* - Service `bizzabo_v2`: Your Bizzabo account ID.
* - Service `brightcove`: Your Brightcove account ID.
* - Service `cin7core`: Your Cin7 Core account ID.
* - Service `dear`: Your Dear Account ID.
* - Service `harvest`: Your Harvest Account ID.
* - Service `optimizely`: Your Optimizely account ID.
* - Service `rokt`: Your Rokt account ID.
* - Service `udemy_business`: Your Udemy Business account ID.
*/
accountId: string;
/**
* Field usage depends on `service` value:
* - Service `taboola`: Specific Account IDs to sync. Must be populated if `syncMode` is set to `SpecificAccounts`.
*/
accountIds?: string[];
/**
* Field usage depends on `service` value:
* - Service `cosmos`: The read-only primary or secondary account key for the database account. Required for the `ACCOUNT_KEY` data access method.
* - Service `simplesat`: Your Simplesat account key.
*/
accountKey: string;
/**
* Field usage depends on `service` value:
* - Service `eventsforce`: Your Eventsforce account name.
* - Service `freshdesk_contact_center`: Your Freshdesk Contact Center account name.
* - Service `happyfox`: Your HappyFox account name.
* - Service `helpjuice`: Your Helpjuice account name.
* - Service `maxio_saasoptics`: Your Maxio SaaSOptics account name.
* - Service `talkdesk`: Your Talkdesk Account Name.
* - Service `udemy_business`: Your Udemy Business account name.
*/
accountName?: string;
/**
* Field usage depends on `service` value:
* - Service `tymeshift`: Your Tymeshift account plan.
*/
accountPlan?: string;
/**
* Field usage depends on `service` value:
* - Service `iterable`: If your Iterable account URL starts with `https://app.eu.iterable.com` then provide `EU` else `US`
*/
accountRegion: string;
/**
* Field usage depends on `service` value:
* - Service `fone_dynamics`: Your Fone Dynamics account SID.
* - Service `impact_partner`: Your Impact Partner account SID
*/
accountSid?: string;
/**
* Field usage depends on `service` value:
* - Service `itunes_connect`: Account Sync Mode
* - Service `snapchat_ads`: Whether to sync all accounts or specific accounts. Default value: `AllAccounts`.
*/
accountSyncMode?: string;
/**
* Field usage depends on `service` value:
* - Service `konnect_insights`: Your Konnect Insights Account Token.
*/
accountToken?: string;
/**
* Field usage depends on `service` value:
* - Service `freightview`: Your Freightview account type.
*/
accountType: string;
/**
* Field usage depends on `service` value:
* - Service `bingads`: Specific accounts to sync. Must be populated if `syncMode` is set to `SpecificAccounts`.
* - Service `facebook`: List of accounts of which connector will sync the data.
* - Service `facebook_ad_account`: Specific accounts to sync. Must be populated if `sync_mode` is set to `SpecificAccounts`.
* - Service `facebook_ads`: List of accounts of which connector will sync the data.
* - Service `google_ads`: The list of Account IDs to sync. Must be populated if `sync_mode` is set to `SpecificAccounts`.
* - Service `google_analytics`: The list of specific Account IDs to sync. Must be populated if `syncMode` is set to `SpecificAccounts`.
* - Service `google_analytics_4`: The list of specific Account IDs to sync. Must be populated if `sync_mode` is set to `SPECIFIC_ACCOUNTS`.
* - Service `google_analytics_mcf`: Specific Account IDs to sync. Must be populated if `sync_mode` is set to `SPECIFIC_ACCOUNTS`.
* - Service `google_search_ads_360`: Specific accounts to sync. Must be populated if `accountsSyncMode` is set to `SPECIFIC_ACCOUNTS`.
* - Service `instagram_business`: Specific accounts to sync. Must be populated if `sync_mode` is set to `SpecificAccounts`.
* - Service `itunes_connect`: Accounts
* - Service `linkedin_ads`: Specific Account IDs to sync. Must be populated if `syncMode` is set to `SpecificAccounts`.
* - Service `snapchat_ads`: Specific accounts IDs to sync. Must be populated if `accountSyncMode` is set to `SpecificAccounts`.
* - Service `spotify_ads`: The list of Ad Account IDs to sync. Must be populated if `sync_mode` is set to `SPECIFIC_ACCOUNTS`.
* - Service `tiktok_ads`: Specific accounts to sync. Must be populated if `sync_mode` is set to `SpecificAccounts`.
* - Service `twilio`: Specific Accounts to sync. Must be populated if `sync_mode` is set to `SpecificAccounts`.
* - Service `twitter`: Specific accounts to sync. Must be populated if `sync_mode` is set to `SpecificAccounts`.
* - Service `twitter_ads`: Specific Accounts to sync. Must be populated if `sync_mode` is set to `SpecificAccounts`.
*/
accounts?: string[];
accountsRedditAds?: outputs.ConnectorConfigAccountsRedditAd[];
/**
* Field usage depends on `service` value:
* - Service `google_search_ads_360`: Whether to sync all accounts or specific.
*/
accountsSyncMode?: string;
/**
* Field usage depends on `service` value:
* - Service `facebook`: List of action_breakdowns which connector will sync. [Possible action_breakdowns values](https://fivetran.com/docs/applications/facebook-ad-insights/api-config#actionbreakdowns).
*/
actionBreakdowns?: string[];
/**
* Field usage depends on `service` value:
* - Service `facebook`: The report time of action stats. [Possible action_report time values](https://fivetran.com/docs/applications/facebook-ad-insights/api-config#actionreporttime).
*/
actionReportTime: string;
/**
* Field usage depends on `service` value:
* - Service `linkedin_ads`: Whether to sync all analytic reports or specific. Default value: `AllReports`
*/
adAnalytics?: string;
/**
* Field usage depends on `service` value:
* - Service `double_click_publishers`: Ad unit view for the report.
*/
adUnitView?: string;
/**
* Field usage depends on `service` value:
* - Service `splitio`: Your Split admin api key.
*/
adminApiKey?: string;
/**
* Field usage depends on `service` value:
* - Service `brivo`: Your Brivo Admin username.
*/
adminUsername?: string;
adobeAnalyticsConfigurations?: outputs.ConnectorConfigAdobeAnalyticsConfiguration[];
/**
* Field usage depends on `service` value:
* - Service `adroll`: Specific advertisables to sync. Must be populated if `sync_mode` is set to `SpecificAdvertisables`.
*/
advertisables?: string[];
/**
* Field usage depends on `service` value:
* - Service `google_display_and_video_360`: The list of advertisers to include into a sync. This parameter only takes effect when `config_method` is set to `CREATE_NEW`.
* - Service `google_search_ads_360`: Specific advertisers to sync. Must be populated if `advertisersSyncMode` is set to `SPECIFIC_ADVERTISERS`.
* - Service `pinterest_ads`: Specific Advertisers to sync. Must be populated if `sync_mode` is set to `SpecificAdvertisers`.
*/
advertisers?: string[];
/**
* Field usage depends on `service` value:
* - Service `yahoo_gemini`: Specific Advertiser IDs to sync. Must be populated if `syncMode` is set to `SpecificAccounts`.
*/
advertisersIds?: string[];
/**
* Field usage depends on `service` value:
* - Service `google_search_ads_360`: Whether to sync all or specific advertisers.
*/
advertisersSyncMode?: string;
/**
* Field usage depends on `service` value:
* - Service `yahoo_dsp`: Specific Advertisers to sync. Must be populated if `sync_mode_advertiser` is set to `SPECIFIC_ADVERTISERS`. Pay attention to the format: `AdvertiserId:SeatId`
*/
advertisersWithSeats?: string[];
agentConfigMethod: string;
/**
* Field usage depends on `service` value:
* - Service `db2i_hva`: The agent host.
* - Service `db2i_sap_hva`: The host of the agent. This is the same as the database host, since the agent must be installed on the same machine as the source database.
* - Service `hana_sap_hva_b1`: The host of the agent. This is the same as the database host, since the agent must be installed on the same machine as the source database.
* - Service `hana_sap_hva_ecc`: The host of the agent. This is the same as the database host, since the agent must be installed on the same machine as the source database.
* - Service `hana_sap_hva_ecc_netweaver`: The host of the agent. This is the same as the database host, since the agent must be installed on the same machine as the source database.
* - Service `hana_sap_hva_s4`: The host of the agent. This is the same as the database host, since the agent must be installed on the same machine as the source database.
* - Service `hana_sap_hva_s4_netweaver`: The host of the agent. This is the same as the database host, since the agent must be installed on the same machine as the source database.
* - Service `oracle_hva`: The host of the agent. This is the same as database host, since the agent must be installed in the same machine as source database.
* - Service `oracle_sap_hva`: The host of the agent. This is the same as the database host, since the agent must be installed on the same machine as the source database.
* - Service `oracle_sap_hva_netweaver`: The host of the agent. This is the same as the database host, since the agent must be installed on the same machine as the source database.
* - Service `sql_server_hva`: The host address of the machine running the agent. Often the same as the DB host.
* - Service `sql_server_sap_ecc_hva`: The host address of the machine running the agent. Often the same as the DB host.
*/
agentHost: string;
/**
* Field usage depends on `service` value:
* - Service `phoenix_ads`: Your Phoenix Ads Agent ID.
*/
agentId?: string;
/**
* Field usage depends on `service` value:
* - Service `oracle_hva`: The home directory of the Oracle database.
* - Service `oracle_sap_hva`: The home directory of the Oracle database.
*/
agentOraHome: string;
/**
* Field usage depends on `service` value:
* - Service `db2i_hva`: The agent password.
* - Service `db2i_sap_hva`: The agent user's password. It must have a minimum length of 10 characters.
* - Service `hana_sap_hva_b1`: The agent user's password. It must have a minimum length of 10 characters.
* - Service `hana_sap_hva_ecc`: The agent user's password. It must have a minimum length of 10 characters.
* - Service `hana_sap_hva_ecc_netweaver`: The agent user's password. It must have a minimum length of 10 characters.
* - Service `hana_sap_hva_s4`: The agent user's password. It must have a minimum length of 10 characters.
* - Service `hana_sap_hva_s4_netweaver`: The agent user's password. It must have a minimum length of 10 characters.
* - Service `oracle_hva`: The agent user's password. It should have a minimum length of 10 characters.
* - Service `oracle_sap_hva`: The agent user's password. It must have a minimum length of 10 characters.
* - Service `oracle_sap_hva_netweaver`: The agent user's password. It must have a minimum length of 10 characters.
* - Service `sql_server_hva`: The password for the agent user.
* - Service `sql_server_sap_ecc_hva`: The password for the agent user.
*/
agentPassword: string;
/**
* Field usage depends on `service` value:
* - Service `db2i_hva`: The agent port.
* - Service `db2i_sap_hva`: The port number of the agent.
* - Service `hana_sap_hva_b1`: The port number of the agent.
* - Service `hana_sap_hva_ecc`: The port number of the agent.
* - Service `hana_sap_hva_ecc_netweaver`: The port number of the agent.
* - Service `hana_sap_hva_s4`: The port number of the agent.
* - Service `hana_sap_hva_s4_netweaver`: The port number of the agent.
* - Service `oracle_hva`: The port number of the agent.
* - Service `oracle_sap_hva`: The port number of the agent.
* - Service `oracle_sap_hva_netweaver`: The port number of the agent.
* - Service `sql_server_hva`: The port that the agent has open for Fivetran's connection. Default value is 4343.
* - Service `sql_server_sap_ecc_hva`: The port that the agent has open for Fivetran's connection. Default value is 4343.
*/
agentPort: number;
/**
* Field usage depends on `service` value:
* - Service `db2i_hva`: The public certificate for the agent.
* - Service `db2i_sap_hva`: The agent public certificate.
* - Service `hana_sap_hva_b1`: The agent public certificate.
* - Service `hana_sap_hva_ecc`: The agent public certificate.
* - Service `hana_sap_hva_ecc_netweaver`: The agent public certificate.
* - Service `hana_sap_hva_s4`: The agent public certificate.
* - Service `hana_sap_hva_s4_netweaver`: The agent public certificate.
* - Service `oracle_hva`: The agent public certificate.
* - Service `oracle_sap_hva`: The agent public certificate.
* - Service `oracle_sap_hva_netweaver`: The agent public certificate.
* - Service `sql_server_hva`: The public certificate generated by the agent.
* - Service `sql_server_sap_ecc_hva`: The public certificate generated by the agent.
*/
agentPublicCert: string;
/**
* Field usage depends on `service` value:
* - Service `db2i_hva`: The agent user name.
* - Service `db2i_sap_hva`: The agent's user.
* - Service `hana_sap_hva_b1`: The agent's user.
* - Service `hana_sap_hva_ecc`: The agent's user.
* - Service `hana_sap_hva_ecc_netweaver`: The agent's user.
* - Service `hana_sap_hva_s4`: The agent's user.
* - Service `hana_sap_hva_s4_netweaver`: The agent's user.
* - Service `oracle_hva`: The agent's user.
* - Service `oracle_sap_hva`: The agent's user.
* - Service `oracle_sap_hva_netweaver`: The agent's user.
* - Service `sql_server_hva`: The agent's username.
* - Service `sql_server_sap_ecc_hva`: The agent's username.
*/
agentUser: string;
/**
* Field usage depends on `service` value:
* - Service `facebook`: Options to select aggregation duration. [Possible aggregation values](https://fivetran.com/docs/applications/facebook-ad-insights/api-config#aggregation).
*/
aggregation: string;
/**
* Field usage depends on `service` value:
* - Service `economic`: Your E-conomic X-AgreementGrantToken goes here.
*/
agreementGrantToken?: string;
/**
* Field usage depends on `service` value:
* - Service `webhooks`: HMAC algorithm used for generating the HMAC signature. Supported algorithms INFER_FROM_HEADER, MD5, SHA_1, SHA_224, SHA_256, SHA_384, SHA_512. Default: SHA_256
*/
algorithm: string;
/**
* Field usage depends on `service` value:
* - Service `aurora`: Require TLS through Tunnel
* - Service `aurora_postgres`: Require TLS through Tunnel
* - Service `aveva_pi`: Require TLS.
* - Service `azure_cosmos_for_mongo`: Require TLS
* - Service `azure_postgres`: Require TLS through Tunnel
* - Service `azure_sql_db`: Require TLS through Tunnel.
* - Service `azure_sql_managed_db`: Require TLS.
* - Service `clarity`: Require TLS through Tunnel.
* - Service `cockroachdb`: Require TLS
* - Service `db2i_hva`: Require TLS through Tunnel
* - Service `db2i_sap_hva`: Require TLS through Tunnel
* - Service `db2luw`: Require TLS through Tunnel
* - Service `db2z`: Require TLS
* - Service `documentdb`: Require TLS encryption.
* - Service `dynamics_365_fo`: Require TLS through Tunnel.
* - Service `ehr`: Require TLS through Tunnel.
* - Service `elastic_cloud`: Default value: true. Set to false if TLS is not required when using an SSH tunnel.
* - Service `epic_clarity`: Require TLS through Tunnel.
* - Service `es_self_hosted`: Default value: true. Set to false if TLS is not required when using an SSH tunnel.
* - Service `google_cloud_mysql`: Require TLS through Tunnel
* - Service `google_cloud_postgresql`: Require TLS through Tunnel
* - Service `google_cloud_sqlserver`: Require TLS.
* - Service `heroku_postgres`: Require TLS through Tunnel
* - Service `magento_mysql`: Require TLS through Tunnel
* - Service `magento_mysql_rds`: Require TLS through Tunnel
* - Service `maria`: Require TLS through Tunnel
* - Service `maria_azure`: Require TLS through Tunnel
* - Service `maria_rds`: Require TLS through Tunnel
* - Service `mongo`: Require TLS
* - Service `mongo_sharded`: Require TLS through Tunnel
* - Service `mysql`: Require TLS through Tunnel
* - Service `mysql_azure`: Require TLS through Tunnel
* - Service `mysql_rds`: Require TLS through Tunnel
* - Service `opendistro`: Default value: true. Set to false if TLS is not required when using an SSH tunnel.
* - Service `opensearch`: Default value: true. Set to false if TLS is not required when using an SSH tunnel.
* - Service `oracle`: Require TLS through Tunnel
* - Service `oracle_ebs`: Require TLS through Tunnel
* - Service `oracle_hva`: Require TLS through Tunnel
* - Service `oracle_rac`: Require TLS through Tunnel
* - Service `oracle_rds`: Require TLS through Tunnel
* - Service `oracle_sap_hva`: Require TLS through Tunnel
* - Service `oracle_sap_hva_netweaver`: Require TLS.
* - Service `postgres`: Require TLS through Tunnel
* - Service `postgres_rds`: Require TLS through Tunnel
* - Service `sql_server`: Require TLS.
* - Service `sql_server_hva`: Require TLS.
* - Service `sql_server_rds`: Require TLS.
* - Service `sql_server_sap_ecc_hva`: Require TLS.
*/
alwaysEncrypted: boolean;
/**
* Field usage depends on `service` value:
* - Service `freshsuccess`: Set this parameter to `api`.
*/
api?: string;
/**
* Field usage depends on `service` value:
* - Service `device_magic`: Your Device Magic API access token.
* - Service `flywheel_digital`: Your Flywheel Digital API access token.
* - Service `shopify`: API access token of your custom app.
* - Service `square`: The Square API access token of your application.
*/
apiAccessToken: string;
/**
* Field usage depends on `service` value:
* - Service `afterpay`: Your Afterpay API environment.
* - Service `tiktok_organic`: Your TikTok Organic API environment.
* - Service `tiktok_organic_app`: Your TikTok Organic API environment.
*/
apiEnvironment: string;
/**
* Field usage depends on `service` value:
* - Service `aircall`: Your Aircall API ID.
*/
apiId?: string;
/**
* Field usage depends on `service` value:
* - Service `onetrust`: Your OneTrust API integration type.
*/
apiIntegrationType: string;
/**
* Field usage depends on `service` value:
* - Service `15five`: Your 15five API key.
* - Service `360learning`: Your 360Learning API Key.
* - Service `6sense`: Your 6sense API Key.
* - Service `acculynx`: Your Acculynx API key.
* - Service `activecampaign`: Your ActiveCampaign API key.
* - Service `affinity`: Your Affinity API key.
* - Service `airtable`: API key of the Airtable account.
* - Service `algolia`: Your Algolia API key.
* - Service `alida`: Your Alida API key.
* - Service `anvyl`: Your Anvyl API key.
* - Service `apollo`: Your Apollo API key.
* - Service `appcues`: Your Appcues API key.
* - Service `applovin`: Your AppLovin API key.
* - Service `ascend_by_partnerize`: Your Ascend by Partnerize API Key
* - Service `ashby`: Your Ashby API key.
* - Service `assembled`: Your Assembled API key.
* - Service `atlassian_jira_align`: Your Jira Align API key.
* - Service `atlassian_ops_genie`: Your Opsgenie API key
* - Service `attentive`: Your Attentive API key.
* - Service `aumni`: Your Aumni API key.
* - Service `avantlink`: Your AvantLink API key.
* - Service `ballotready`: Your BallotReady API token.
* - Service `bamboohr`: Your API Key.
* - Service `bazaarvoice`: Your Bazaarvoice API key.
* - Service `betterworks`: Your Betterworks API key.
* - Service `bigmarker`: Your BigMarker API key.
* - Service `bizzabo`: Your Bizzabo API key.
* - Service `brave_ads`: Your Brave Ads API key
* - Service `braze`: Your Braze API Key.
* - Service `brevo`: Your Brevo API key.
* - Service `brivo`: Your Brivo API key.
* - Service `bubble`: Your Bubble API token.
* - Service `buildium`: Your Buildium private API key.
* - Service `callrail`: Your CallRail API key.
* - Service `campaignmonitor`: Your Campaign Monitor API key.
* - Service `campfire`: Your Campfire API key.
* - Service `canny`: Your Canny API key.
* - Service `chargebee_product_catalog_1`: Your Chargebee Product Catalog 1 API key.
* - Service `chargebee_product_catalog_2`: Your Chargebee API key.
* - Service `charthop`: Your ChartHop app API key.
* - Service `chartmogul`: Your ChartMogul API key.
* - Service `chorusai`: Your Chorus API key.
* - Service `churnkey`: Your Churnkey API Key.
* - Service `churnzero`: Your ChurnZero API key.
* - Service `cimis`: Your Cimis API key.
* - Service `circleci`: Your CircleCI API Key.
* - Service `clickup`: Your ClickUp API key.
* - Service `clockify`: Your Clockify API key.
* - Service `clockodo`: Your Clockodo API key.
* - Service `close`: Your Close API key.
* - Service `cloudbeds`: Your Cloudbeds API key.
* - Service `clubspeed`: Your Clubspeed API key.
* - Service `coassemble`: Your Coassemble API key.
* - Service `codefresh`: Your Codefresh API Key.
* - Service `column`: Your Column API key.
* - Service `concord`: Your Concord API key.
* - Service `confluent_cloud`: API Key
* - Service `consensus_demo_automation_platform`: Your Consensus Demo Automation Platform API key.
* - Service `contrast_security`: Your Contrast Security API Key.
* - Service `copper`: Your Copper API key.
* - Service `coupa`: Your Coupa API key.
* - Service `crunchbase`: Your Crunchbase API key.
* - Service `datadog`: Your Datadog API key.
* - Service `dbt_cloud`: Your dbt Cloud service token.
* - Service `dcl_logistics`: Your DCL Logistics API key.
* - Service `delighted`: API Key for your Delighted account
* - Service `destini`: Your Destini API Key.
* - Service `discourse`: Your Discourse API key.
* - Service `donus`: Your Donus API key.
* - Service `doorloop`: Your DoorLoop API key.
* - Service `drata`: Your Drata API Key.
* - Service `dropbox_sign`: Your Dropbox Sign API key.
* - Service `duoplane`: Your Duoplane API key.
* - Service `dutchie`: Your Dutchie API key.
* - Service `easypost`: Your EasyPost API Key.
* - Service `electronic_tenant_solutions`: Your Electronic Tenant Solutions API key.
* - Service `eventsforce`: Your Eventsforce API secret key.
* - Service `everflow`: Your Everflow API key.
* - Service `everhour`: Your Everhour API Token.
* - Service `expensein`: Your ExpenseIn API key.
* - Service `factorial`: Your Factorial API key.
* - Service `fireflies`: Your Fireflies API key.
* - Service `firehydrant`: Your FireHydrant API key.
* - Service `float`: Your Float API key.
* - Service `forj_community`: Your Forj Community API key.
* - Service `fourkites`: Your FourKites API key.
* - Service `freightview`: Your Freightview API key.
* - Service `freshdesk`: Your Freshdesk API Key.
* - Service `freshdesk_contact_center`: Your Freshdesk Contact Center API key.
* - Service `freshsales`: Your Freshsales API key.
* - Service `freshservice`: Your Freshservice API Key.
* - Service `freshsuccess`: Your Freshsuccess API key.
* - Service `freshteam`: Your Freshteam API key.
* - Service `friendbuy`: Your Friendbuy API key.
* - Service `fulfil`: Your Fulfil API key.
* - Service `fullstory`: Your Fullstory API key.
* - Service `gainsight_product_experience`: Your Gainsight Product Experience API key.
* - Service `gem`: Your Gem API key.
* - Service `goldcast`: Your Goldcast API key.
* - Service `gorgias`: Your Gorgias API key.
* - Service `greenhouse`: Your Greenhouse API key.
* - Service `grepsr`: Your Grepsr API Key.
* - Service `grin`: Your Grin API key.
* - Service `happyfox`: Your HappyFox API key.
* - Service `healthie`: Your Healthie API key.
* - Service `height`: Your Height API key.
* - Service `helpjuice`: Your Helpjuice API key.
* - Service `helpshift`: Your Helpshift API Key.
* - Service `incidentio`: Your incident.io API key.
* - Service `infobip`: Your Infobip API key.
* - Service `insightly`: Your Insightly API key.
* - Service `integrate`: Your Integrate API key.
* - Service `invoiced`: Your Invoiced API key.
* - Service `iterable`: Your Iterable API key.
* - Service `ivanti`: Your Ivanti API Key.
* - Service `jobnimbus`: Your JobNimbus API key.
* - Service `jotform`: Your Jotform API key.
* - Service `justcall`: Your JustCall API key.
* - Service `katana`: Your Katana API key.
* - Service `kevel`: Your Kevel API key.
* - Service `keypay`: Your KeyPay API key.
* - Service `kisi`: Your Kisi API key.
* - Service `klaviyo`: Your Klaviyo API key.
* - Service `learnupon`: Your LearnUpon API key.
* - Service `lemlist`: Your Lemlist API key.
* - Service `lever`: Your Lever API key.
* - Service `liftoff`: Your Liftoff API key.
* - Service `linear`: Your Linear API key.
* - Service `linksquares`: Your LinkSquares API key.
* - Service `listen360`: Your Listen360 API key.
* - Service `lob`: Your Lob API key.
* - Service `loop`: Your Loop API key.
* - Service `lucca`: Your Lucca API key.
* - Service `luma`: Your Luma API key.
* - Service `maileon`: Your Maileon API key.
* - Service `mailgun`: Your Mailgun API key.
* - Service `mailjet`: Your Mailjet API key.
* - Service `malomo`: Your Malomo API key.
* - Service `mambu`: Your Mambu API key.
* - Service `mandrill`: Your Mandrill API key.
* - Service `maxio_chargify`: Enter Your API Key.
* - Service `messagebird`: Your MessageBird API key.
* - Service `moloco`: Your Moloco api_key
* - Service `mountain`: Your MNTN API key.
* - Service `myosh`: Your myosh API key.
* - Service `okendo`: Your Okendo API key.
* - Service `ometria`: Your Ometria API Key.
* - Service `oncehub`: Your OnceHub API key.
* - Service `openai`: Your OpenAI Admin API key.
* - Service `ordergroove`: Your Ordergroove API key.
* - Service `ordway`: Your Ordway API key.
* - Service `ortto`: Your Ortto API key.
* - Service `paddle`: Your Paddle API key.
* - Service `pagerduty`: Your PagerDuty API key.
* - Service `pandadoc`: Your PandaDoc API key.
* - Service `papershift`: Your Papershift API Key
* - Service `partnerize`: Your Partnerize user API key.
* - Service `peopleforce`: Your PeopleForce API key.
* - Service `persona`: Your Persona API key.
* - Service `picqer`: Your Picqer API key.
* - Service `pigment`: Your Pigment API key.
* - Service `pinpoint`: Your Pinpoint API key.
* - Service `pipe17`: The Pipe17 API key.
* - Service `placerai`: Your Placer.ai API key.
* - Service `playvox`: Your Playvox API Key.
* - Service `posthog`: Your PostHog API key.
* - Service `prive`: Your Prive API key.
* - Service `prosperstack`: Your ProsperStack API key.
* - Service `qualaroo`: Your Qualaroo API Key.
* - Service `quorum`: Your Quorum API key.
* - Service `rebound_returns`: Your ReBound Returns API key.
* - Service `recurly`: The Recurly API key.
* - Service `refiner`: Your Refiner API key.
* - Service `replyio`: Your Reply API key.
* - Service `revenuecat`: Your RevenueCat API key.
* - Service `reviewsio`: Your REVIEWS.io API key.
* - Service `revops`: Your RevOps bearer token.
* - Service `ricochet360`: Your Ricochet360 API key.
* - Service `ringover`: Your Ringover API key.
* - Service `rippling`: Your Rippling API token.
* - Service `rocketlane`: Your Rocketlane API key.
* - Service `rootly`: Your Rootly API key.
* - Service `ruddr`: Your Ruddr API key.
* - Service `safebase`: Your SafeBase API key.
* - Service `sage_hr`: Your Sage HR API key.
* - Service `sailthru`: The Sailthru API key.
* - Service `salsify`: Your Salsify API Key.
* - Service `security_journey`: Your Security Journey API key.
* - Service `sendgrid`: The SendGrid API key.
* - Service `sendinblue`: Your Sendinblue API key.
* - Service `shortcut`: Your Shortcut API token.
* - Service `shortio`: Your Short.io API key.
* - Service `simplesat`: Your Simplesat API key.
* - Service `sistrix`: Your SISTRIX API key.
* - Service `skilljar`: Your Skilljar API key.
* - Service `smartwaiver`: Your Smartwaiver API key.
* - Service `snyk`: Your Snyk API key.
* - Service `sonarqube`: Your Sonarqube API key.
* - Service `sparkpost`: Your SparkPost API key.
* - Service `squarespace`: Your Squarespace API key.
* - Service `stackadapt`: Your StackAdapt API key.
* - Service `stackadapt_graphql`: Your StackAdapt API key.
* - Service `statuspage`: Your Statuspage API Key.
* - Service `stripe`: Restricted API key
* - Service `stripe_test`: Restricted API key
* - Service `subscript`: Your Subscript API key.
* - Service `survicate`: Your Survicate API Key.
* - Service `teads`: Your Teads API key.
* - Service `teamtailor`: Your Teamtailor API key.
* - Service `testrail`: Your TestRail API key.
* - Service `ticket_tailor`: Your Ticket Tailor API key.
* - Service `transcend`: Your Transcend API key.
* - Service `trello`: Your TRELLO api key.
* - Service `triple_whale`: Your Triple Whale API key.
* - Service `upland`: Your Upland Software API key.
* - Service `uppromote`: Your UpPromote API key.
* - Service `veeqo`: Your Veeqo API key.
* - Service `venminder`: Your Venminder API key.
* - Service `visit_by_ges`: Your Visit by GES API key.
* - Service `vitally`: Your Vitally API key.
* - Service `vonage`: Your Vonage API Key.
* - Service `vts`: Your VTS API key.
* - Service `webconnex`: Your Webconnex API key.
* - Service `wicked_reports`: Your Wicked Reports API key.
* - Service `workleap_officevibe`: Your Workleap Officevibe API key.
* - Service `writesonic`: Your Writesonic API key.
* - Service `xsolla`: Your Xsolla API key.
* - Service `yext`: Your Yext API key.
* - Service `yougov_sport`: Your Yougov Sport API key.
* - Service `zingtree`: Your Zingtree API key.
* - Service `zip`: Your Zip API key.
*/
apiKey: string;
/**
* Field usage depends on `service` value:
* - Service `revel`: Your Revel Systems API Key and API Secret.
*/
apiKeyApiSecret?: string;
/**
* Field usage depends on `service` value:
* - Service `mandrill`: Comma-separated list of API keys. Required if `use_api_keys` is set to `true`.
*/
apiKeys?: string[];
/**
* Field usage depends on `service` value:
* - Service `duoplane`: Your Duoplane API password.
*/
apiPassword?: string;
/**
* Field usage depends on `service` value:
* - Service `marketo`: Allowed number of API requests to Marketo instance per day, the default value is 10000.
*/
apiQuota: number;
/**
* Field usage depends on `service` value:
* - Service `the_movie_database`: Your The Movie Database API read access token.
*/
apiReadAccessToken?: string;
/**
* Field usage depends on `service` value:
* - Service `qualtrics`: Allowed number of API requests to Qualtrics per minute, the default value is 2000. Maximum allowed number is 3000 because brands may make up to 3000 API requests per minute across all of its API calls.
*/
apiRequestsPerMinute: number;
/**
* Field usage depends on `service` value:
* - Service `zuora`: The API role assigned to the integration user.
* - Service `zuora_sandbox`: The API role assigned to the integration user.
*/
apiRole?: string;
/**
* Field usage depends on `service` value:
* - Service `confluent_cloud`: API Secret
* - Service `consensus_demo_automation_platform`: Your Consensus Demo Automation Platform API secret.
* - Service `forj_community`: Your Forj Community API secret.
* - Service `friendbuy`: Your Friendbuy API secret.
* - Service `integrate`: Your Integrate API secret.
* - Service `justcall`: Your JustCall API secret.
* - Service `liftoff`: Your Liftoff API secret.
* - Service `mixpanel`: Mixpanel API Secret.
* - Service `qualaroo`: Your Qualaroo API Secret.
* - Service `sailthru`: The Sailthru API secret.
* - Service `shareasale`: Your ShareASale API secret.
* - Service `vonage`: Your Vonage API Secret.
*/
apiSecret: string;
/**
* Field usage depends on `service` value:
* - Service `alchemer`: Your Alchemer API Secret key.
*/
apiSecretKey?: string;
/**
* Field usage depends on `service` value:
* - Service `sigma_computing_source`: Your Sigma Computing api server.
*/
apiServer: string;
/**
* Field usage depends on `service` value:
* - Service `aha`: Your Aha! API key.
* - Service `aircall`: Your Aircall API token.
* - Service `appsflyer`: API Token for AppsFlyer's PULL API.
* - Service `aura_from_unity`: Your Aura from Unity API token.
* - Service `awin`: Your Awin API Token.
* - Service `backbone_plm`: Your Backbone PLM API token.
* - Service `brex`: Your Brex API token
* - Service `buildkite`: Your Buildkite API token.
* - Service `buzzsprout`: Your Buzzsprout API token.
* - Service `centra`: Your Centra API token.
* - Service `chameleon`: Your Chameleon API token.
* - Service `clari`: Your Clari API token.
* - Service `cloudflare_analytics`: Your Cloudflare Analytics API token.
* - Service `confluence`: The Confluence API token.
* - Service `dixa`: Your Dixa API token.
* - Service `drip`: Your Drip API Token.
* - Service `factbird`: Your Factbird API token.
* - Service `fone_dynamics`: Your Fone Dynamics API token.
* - Service `forethought`: Your Forethought API token.
* - Service `fountain`: Your Fountain API token.
* - Service `g2`: Your G2 API token.
* - Service `gladly`: Your Gladly API Token.
* - Service `hibob`: Your Hibob API token.
* - Service `kandji`: Your Kandji API token.
* - Service `livechat`: Your Livechat Access token.
* - Service `livechat_partner`: Your Livechat Partner API Token.
* - Service `maxio_saasoptics`: Your Maxio SaaSOptics API token.
* - Service `megaphone`: Your Megaphone API token.
* - Service `missive`: Your Missive API token.
* - Service `mixmax`: Mixmax API token.
* - Service `okta`: Your Okta API token.
* - Service `ordway`: Your Ordway API token.
* - Service `packiyo`: Your Packiyo API token.
* - Service `pipedrive`: (Optional)Your Pipedrive personal API token
* - Service `pivotal_tracker`: Pivotal Tracker API token.
* - Service `postmark`: Your Postmark account API token.
* - Service `productive`: Your Productive API token.
* - Service `pylon_support_platform`: Your Pylon Support Platform API token.
* - Service `qualtrics`: API token of the Qualtrics account.
* - Service `rakutenadvertising`: Your Rakuten Advertising API token.
* - Service `recharge`: The Recharge API token.
* - Service `referralhero`: Your Referralhero API token.
* - Service `resource_management_by_smartsheet`: Your Resource Management by Smartsheet API token.
* - Service `retently`: Your Retently API token.
* - Service `reviewsai`: Your REVIEWS.ai API token.
* - Service `rundeck`: Your Rundeck API token.
* - Service `safetyculture`: Your SafetyCulture API token.
* - Service `sensor_tower`: Your Sensor Tower API token.
* - Service `sentry`: Your Sentry auth token.
* - Service `simplecast`: Your Simplecast API token.
* - Service `smartsheet`: API token generated from your Smartsheet account.
* - Service `snyk`: Your Snyk API token.
* - Service `textus`: Your TextUs API token.
* - Service `toggl_track`: Your Toggl Track API token
* - Service `trello`: Your TRELLO api token.
* - Service `trisolute`: Your Trisolute API token.
* - Service `vwo`: Your VWO API token.
* - Service `web_scraper`: Your Web Scraper API token.
* - Service `zendesk`: Deprecated: Use Confidential OAuth client authentication instead. Zendesk API tokens are auto-generated passwords in the Support admin interface.
* - Service `zendesk_sunshine`: Zendesk API tokens are auto-generated passwords in the Support admin interface.
* - Service `zendesk_workforce_management`: Your Zendesk Workforce Management API token.
*/
apiToken: string;
apiType: string;
/**
* Field usage depends on `service` value:
* - Service `braze`: Your Braze API URL.
*/
apiUrl: string;
/**
* Field usage depends on `service` value:
* - Service `amazon_dsp`: Your Amazon DSP API URL region.
*/
apiUrlRegion: string;
/**
* Field usage depends on `service` value:
* - Service `zendesk`: Maximum Zendesk Api Usage allowed
*/
apiUsage: string;
/**
* Field usage depends on `service` value:
* - Service `salesforce`: (Optional) The percentage of your Salesforce [daily API limit](https://developer.salesforce.com/docs/atlas.en-us.salesforce_app_limits_cheatsheet.meta/salesforce_app_limits_cheatsheet/salesforce_app_limits_platform_api.htm) that Fivetran should consume. Value must be between 50 and 90 (default value = `90`)
* - Service `salesforce_sandbox`: (Optional) The percentage of your Salesforce [daily API limit](https://developer.salesforce.com/docs/atlas.en-us.salesforce_app_limits_cheatsheet.meta/salesforce_app_limits_cheatsheet/salesforce_app_limits_platform_api.htm) that Fivetran should consume. Value must be between 50 and 90 (default value = `90`)
*/
apiUsageLimit: number;
/**
* Field usage depends on `service` value:
* - Service `shipnetwork`: Your ShipNetwork API user identifier.
*/
apiUserIdentifier?: string;
/**
* Field usage depends on `service` value:
* - Service `shipnetwork`: Your ShipNetwork API user secret.
*/
apiUserSecret?: string;
/**
* Field usage depends on `service` value:
* - Service `discourse`: Your Discourse API username.
*/
apiUsername?: string;
/**
* Field usage depends on `service` value:
* - Service `kustomer`: Api Utilization Percentage
*/
apiUtilizationPercentage: string;
/**
* Field usage depends on `service` value:
* - Service `pardot`: API Version
* - Service `pardot_sandbox`: API Version
*/
apiVersion: string;
/**
* Field usage depends on `service` value:
* - Service `churnkey`: Your Churnkey APP ID.
* - Service `open_exchange_rates`: Your Open Exchange Rates App Id.
* - Service `rokt`: Your Rokt app ID.
* - Service `tiktok_organic`: Your Tiktok Organic app ID.
*/
appId?: string;
/**
* Field usage depends on `service` value:
* - Service `pendo`: Specific App IDs to sync. Must be populated if `sync_mode` is set to `SpecificAppIds`.
*/
appIds?: string[];
appIdsAppsflyers?: outputs.ConnectorConfigAppIdsAppsflyer[];
/**
* Field usage depends on `service` value:
* - Service `loopio`: Your Loopio App Key.
* - Service `servicetitan`: Your ServiceTitan app key.
* - Service `yotpo`: Your Yotpo app key.
* - Service `yotpo_app`: Your Yotpo App key.
*/
appKey?: string;
/**
* Field usage depends on `service` value:
* - Service `brightpearl`: Your Brightpearl app reference.
*/
appReference?: string;
/**
* Field usage depends on `service` value:
* - Service `rokt`: Your Rokt app secret.
*/
appSecret?: string;
/**
* Field usage depends on `service` value:
* - Service `economic`: Your E-conomic X-AppSecretToken goes here.
*/
appSecretToken?: string;
/**
* Field usage depends on `service` value:
* - Service `itunes_connect`: Your app-specific password
*/
appSpecificPassword?: string;
/**
* Field usage depends on `service` value:
* - Service `itunes_connect`: Whether to sync all apps or specific apps.
*/
appSyncMode: string;
/**
* Field usage depends on `service` value:
* - Service `shopify`: App store url of your public app
*/
appUrl?: string;
/**
* Field usage depends on `service` value:
* - Service `aws_cost_report`: If you know that the source completely overwrites the same file with new data, you can append the changes instead of upserting based on filename and line number.
* - Service `azure_blob_storage`: If you know that the source completely over-writes the same file with new data, you can append the changes instead of upserting based on filename and line number.
* - Service `box`: If you know that the source completely over-writes the same file with new data, you can append the changes instead of upserting based on filename and line number.
* - Service `dropbox`: If you know that the source completely over-writes the same file with new data, you can append the changes instead of upserting based on filename and line number.
* - Service `email`: If you know that the source completely over-writes the same file with new data, you can append the changes instead of upserting based on filename and line number.
* - Service `ftp`: If you know that the source completely over-writes the same file with new data, you can append the changes instead of upserting based on filename and line number.
* - Service `gcs`: If you know that the source completely over-writes the same file with new data, you can append the changes instead of upserting based on filename and line number.
* - Service `google_drive`: If you know that the source completely over-writes the same file with new data, you can append the changes instead of upserting based on filename and line number.
* - Service `kinesis`: If you know that the source completely over-writes the same file with new data, you can append the changes instead of upserting based on filename and line number.
* - Service `s3`: If you know that the source completely over-writes the same file with new data, you can append the changes instead of upserting based on filename and line number.
* - Service `s3_compatible_storage`: If you know that the source completely over-writes the same file with new data, you can append the changes instead of upserting based on filename and line number.
* - Service `sftp`: If you know that the source completely over-writes the same file with new data, you can append the changes instead of upserting based on filename and line number.
* - Service `share_point`: If you know that the source completely over-writes the same file with new data, you can append the changes instead of upserting based on filename and line number.
* - Service `wasabi_cloud_storage`: If you know that the source completely over-writes the same file with new data, you can append the changes instead of upserting based on filename and line number.
*/
appendFileOption: string;
/**
* Field usage depends on `service` value:
* - Service `algolia`: Your Algolia application ID.
* - Service `xactly`: Your Xactly Application ID.
*/
applicationId?: string;
/**
* Field usage depends on `service` value:
* - Service `cin7core`: Your Cin7 Core application key.
* - Service `datadog`: Your Datadog application key.
* - Service `dear`: Your Dear Application key.
* - Service `partnerize`: Your Partnerize user application key.
*/
applicationKey?: string;
/**
* Field usage depends on `service` value:
* - Service `db2z`: The application name used to generate an RACF PassTicket for user authentication. Specify only when `authentication_method` is `LEGACY_PASS_TICKET` or `ENHANCED_PASS_TICKET`.
*/
applicationName?: string;
/**
* Field usage depends on `service` value:
* - Service `itunes_connect`: Specific apps to sync. Must be populated if `app_sync_mode` is set to `SpecificApps`.
*/
apps?: string[];
/**
* Field usage depends on `service` value:
* - Service `oracle_hva`: Archive log format.
* - Service `oracle_sap_hva`: Archive log format.
* - Service `oracle_sap_hva_netweaver`: Archive log format.
* - Service `sql_server_hva`: Format for archive log file names
* - Service `sql_server_sap_ecc_hva`: Format for archive log file names
*/
archiveLogFormat?: string;
/**
* Field usage depends on `service` value:
* - Service `oracle_hva`: Archive log path.
* - Service `oracle_sap_hva`: Archive log path.
* - Service `oracle_sap_hva_netweaver`: Archive log path.
* - Service `sql_server_hva`: Directory where archive logs are located
* - Service `sql_server_sap_ecc_hva`: Directory where archive logs are located
*/
archiveLogPath?: string;
/**
* Field usage depends on `service` value:
* - Service `aws_cost_report`: Optional. Files inside of compressed archives with filenames matching this regular expression will be synced.
* - Service `azure_blob_storage`: Files inside of compressed archives with filenames matching this regular expression will be synced.
* - Service `box`: Files inside of compressed archives with filenames matching this regular expression will be synced.
* - Service `dropbox`: Files inside of compressed archives with filenames matching this regular expression will be synced.
* - Service `email`: Files inside of compressed archives with filenames matching this regular expression will be synced.
* - Service `ftp`: Files inside of compressed archives with filenames matching this regular expression will be synced.
* - Service `gcs`: Files inside of compressed archives with filenames matching this regular expression will be synced.
* - Service `google_drive`: Files inside of compressed archives with filenames matching this regular expression will be synced.
* - Service `kinesis`: Optional. Files inside of compressed archives with filenames matching this regular expression will be synced.
* - Service `s3`: Files inside compressed archives with filenames matching this regular expression will be synced.
* - Service `s3_compatible_storage`: Files inside compressed archives with filenames matching this regular expression will be synced.
* - Service `sftp`: Files inside of compressed archives with filenames matching this regular expression will be synced.
* - Service `share_point`: Files inside of compressed archives with filenames matching this regular expression will be synced.
* - Service `wasabi_cloud_storage`: Files inside compressed archives with filenames matching this regular expression will be synced.
*/
archivePattern: string;
/**
* Field usage depends on `service` value:
* - Service `marketo`: Marketo SOAP credentials provided.
*/
areSoapCredentialsProvided: boolean;
/**
* Field usage depends on `service` value:
* - Service `azure_service_bus`: The IP address (or) the URL of ASB namespace
*/
asbIp?: string;
/**
* Field usage depends on `service` value:
* - Service `oracle_hva`: Default value: `false`. Set to `true` if you're using ASM on a non-RAC instance.
* - Service `oracle_sap_hva`: Default value: `false`. Set to `true` if you are using ASM on a non-RAC instance.
*/
asmOption: boolean;
/**
* Field usage depends on `service` value:
* - Service `oracle_hva`: ASM Oracle Home path.
* - Service `oracle_sap_hva`: The Oracle ASM home directory.
*/
asmOracleHome: string;
/**
* Field usage depends on `service` value:
* - Service `oracle_hva`: ASM password. Mandatory if `use_oracle_rac` or `asm_option` is set to `true`.
* - Service `oracle_sap_hva`: The ASM user's password. Mandatory if `use_oracle_rac` or `asm_option` is set to `true`.
*/
asmPassword: string;
/**
* Field usage depends on `service` value:
* - Service `oracle_hva`: ASM TNS.
* - Service `oracle_sap_hva`: ASM TNS.
*/
asmTns: string;
/**
* Field usage depends on `service` value:
* - Service `oracle_hva`: ASM user. Mandatory if `use_oracle_rac` or `asm_option` is set to `true`.
* - Service `oracle_sap_hva`: The ASM user. Mandatory if `use_oracle_rac` or `asm_option` is set to `true`.
*/
asmUser: string;
/**
* Field usage depends on `service` value:
* - Service `amazon_ads`: Time period used to attribute conversions based on clicks.
*/
attributionWindow?: string;
/**
* Field usage depends on `service` value:
* - Service `tiktok_ads`: Rollback sync duration to capture conversions. Set this to your configured attribution window in TikTok Ads. The default value is 7 days.
*/
attributionWindowSize?: string;
/**
* Field usage depends on `service` value:
* - Service `auth0`: Your Auth0 API audience.
*/
audience?: string;
/**
* Field usage depends on `service` value:
* - Service `databricks_db`: Token-based authentication type
* - Service `gitlab`: Your GitLab auth type.
* - Service `redshift_db`: Password-based authentication type
* - Service `snowflake_db`: Password-based or key-based authentication type
*/
auth: string;
/**
* Field usage depends on `service` value:
* - Service `happyfox`: Your HappyFox auth code.
*/
authCode?: string;
/**
* Field usage depends on `service` value:
* - Service `younium`: Your Younium auth environment.
*/
authEnvironment: string;
/**
* Field usage depends on `service` value:
* - Service `webhooks`: Set if you use HMAC/token-based auth methods. This is used to retrieve a key in headers
*/
authHeaderKey?: string;
/**
* Field usage depends on `service` value:
* - Service `aurora`: Database authentication method
* - Service `aurora_postgres`: Database authentication method
* - Service `azure_blob_storage`: Authentication Method
* - Service `azure_postgres`: Database authentication method
* - Service `azure_sql_db`: Authentication Method.
* - Service `azure_sql_managed_db`: Authentication Method.
* - Service `google_cloud_mysql`: Database authentication method
* - Service `google_cloud_postgresql`: Database authentication method
* - Service `heroku_postgres`: Database authentication method
* - Service `magento_mysql`: Database authentication method
* - Service `magento_mysql_rds`: Database authentication method
* - Service `maria`: Database authentication method
* - Service `maria_azure`: Database authentication method
* - Service `maria_rds`: Database authentication method
* - Service `microsoft_dynamics_365_fno`: Authentication Method
* - Service `microsoft_lists`: Authentication Method
* - Service `mysql`: Database authentication method
* - Service `mysql_azure`: Database authentication method
* - Service `mysql_rds`: Database authentication method
* - Service `postgres`: Database authentication method
* - Service `postgres_rds`: Database authentication method
* - Service `sql_server_hva`: Authentication Method
* - Service `sql_server_sap_ecc_hva`: Authentication Method
* - Service `webhooks`: The authentication mechanism you want to use
*/
authMethod?: string;
/**
* Field usage depends on `service` value:
* - Service `anaplan`: The Anaplan authentication method.
* - Service `concur`: The Authentication Mode used by SAP Concur. It can be PasswordGrant or CompanyLevel auth mode
* - Service `github`: Authorization type.
* - Service `smartsheet`: Authorization type.
* - Service `workday`: Authentication Mode
* - Service `workday_financial_management`: Authentication Mode
* - Service `workday_hcm`: Authentication Mode
*/
authMode: string;
/**
* Field usage depends on `service` value:
* - Service `webhooks`: The secret you want to use for HMAC/token-based auth methods
*/
authSecret?: string;
/**
* Field usage depends on `service` value:
* - Service `impact_partner`: Your Impact Partner auth token
* - Service `zonka_feedback`: Your Zonka Feedback auth token.
*/
authToken?: string;
/**
* Field usage depends on `service` value:
* - Service `360learning`: Your 360Learning auth type.
* - Service `airtable`: Type of authentication being used by connector
* - Service `amqp`: Authentication method (BasicAuth or MutualTLS).
* - Service `aws_cost_report`: Access approach
* - Service `azure_service_bus`: The authentication mode to access the topic
* - Service `dynamics_365`: Authentication mechanism. Either one of `OAUTH2`, or `SERVICE_PRINCIPAL`. Default value `OAUTH2`
* - Service `gcs`: Authorization type. Required for storage bucket authentication.
* - Service `google_sheets`: The `OAuth` value must be specified for this type of authorization.
* - Service `jira`: Authorization type.
* - Service `mixpanel`: Authentication Method
* - Service `pardot`: Authenticate using OAuth or HTTP Basic
* - Service `pardot_sandbox`: Authenticate using OAuth or HTTP Basic
* - Service `qualtrics`: Type of authentication being used by connector
* - Service `s3`: Access approach
* - Service `s3_compatible_storage`: Access approach
* - Service `upland`: Authentication method you want to use for your connection.
* - Service `wasabi_cloud_storage`: The Wasabi Cloud Storage Access approach. Required for connector creation. Default value: `ACCESS_KEY`.
*/
authType: string;
/**
* Field usage depends on `service` value:
* - Service `amazon_dsp`: Your Amazon DSP auth grant URL region.
*/
authUrlRegion: string;
/**
* Field usage depends on `service` value:
* - Service `adobe_analytics`: Authentication Method
* - Service `db2z`: User authentication method. Supported values:`PASSWORD`- Authenticate with the database server using an RACF user ID and password. If the parameter is omitted, `PASSWORD` is used by default. `LEGACY_PASS_TICKET`- Authenticate with the database server using an RACF user ID and legacy PassTicket. `ENHANCED_PASS_TICKET`- Authenticate with the database server using an RACF user ID and an enhanced PassTicket. Enhanced PassTickets are more secure than legacy PassTickets.
* - Service `elastic_cloud`: The authentication method used to connect to your cluster.
* - Service `es_self_hosted`: The authentication method used to connect to your cluster.
* - Service `gainsight_customer_success`: The authentication method to use. Can be either OAUTH or API_KEY.
* - Service `opendistro`: The authentication method used to connect to your cluster.
* - Service `opensearch`: The authentication method used to connect to your cluster.
* - Service `oracle_fusion_cloud_apps_crm`: The Oracle Fusion Cloud authentication method.
* - Service `oracle_fusion_cloud_apps_fscm`: The Oracle Fusion Cloud authentication method.
* - Service `oracle_fusion_cloud_apps_hcm`: The Oracle Fusion Cloud authentication method.
* - Service `salesforce`: (Optional) Authentication type (default value = `STANDARD`)
* - Service `salesforce_sandbox`: (Optional) Authentication type (default value = `STANDARD`)
*/
authenticationMethod: string;
authorizationMethod: string;
/**
* Field usage depends on `service` value:
* - Service `tiktok_organic`: The authorization URL of the app registered in your TikTok developer account.
* - Service `workday`: Authorization URL
*/
authorizationUrl?: string;
awsCredentials?: outputs.ConnectorConfigAwsCredentials;
/**
* Field usage depends on `service` value:
* - Service `aurora`: The AWS region code for your RDS instance. Required if the authentication method is `AWS_IAM`.
* - Service `dynamodb`: The AWS region code for the DynamoDB instance, e.g. `us-east-1`.
* - Service `magento_mysql_rds`: The AWS region code for your RDS instance. Required if the authentication method is `AWS_IAM`.
* - Service `maria_rds`: The AWS region code for your RDS instance. Required if the authentication method is `AWS_IAM`.
* - Service `mysql_rds`: The AWS region code for your RDS instance. Required if the authentication method is `AWS_IAM`.
*/
awsRegionCode: string;
azureCredentials?: outputs.ConnectorConfigAzureCredentials;
backintConfigurationPath?: string;
backintExecutablePath?: string;
/**
* Field usage depends on `service` value:
* - Service `sql_server`: Filename pattern for transaction log backup files.
*/
backupLogFormat?: string;
/**
* Field usage depends on `service` value:
* - Service `sql_server`: Full path to the local directory containing transaction log backup files. Required if `backup_storage_type` is `ALTERNATE_LOCATION`
*/
backupLogPath?: string;
/**
* Field usage depends on `service` value:
* - Service `sql_server`: Location of transaction log backup files when using BACKUP binary log type. Possible values: `"AZURE"`, `"ALTERNATE_LOCATION"`, `"AWS"`.
*/
backupStorageType: string;
/**
* Field usage depends on `service` value:
* - Service `amazon_selling_partner`: The earliest date to sync data from, in YYYY-MM-DD format. Cannot be before 1994-01-01 or in the future.
* - Service `shopify`: Limit of the Historical Sync Time for selected tables
* - Service `stripe`: Limit of the Historical Sync Time for selected tables
* - Service `stripe_test`: Limit of the Historical Sync Time for selected tables
* - Service `zendesk`: Date Limit of the Historical Sync Time for selected tables. The format should be YYYY-MM-DD.
*/
backwardSyncLimit?: string;
/**
* Field usage depends on `service` value:
* - Service `hubspot`: Date Limit of the Historical Sync Time for selected tables. The Format should be YYYY-MM-DD.
* - Service `mixpanel`: Date from which data needs to be synced.
* - Service `pendo`: The start date (YYYY-MM-DD) from which to sync historical data.
*/
backwardSyncLimitDate?: string;
/**
* Field usage depends on `service` value:
* - Service `open_exchange_rates`: Your Open Exchange Rates Base Currency.
*/
baseCurrency?: string;
/**
* Field usage depends on `service` value:
* - Service `freshteam`: Your company's Freshteam base domain name (usually **company**.freshteam.com).
*/
baseDomain?: string;
/**
* Field usage depends on `service` value:
* - Service `airtable`: ID of base in Airtable
*/
baseId?: string;
/**
* Field usage depends on `service` value:
* - Service `360learning`: Your 360Learning base URL.
* - Service `aha`: Your Aha! subdomain.
* - Service `akeneo`: Your Akeneo base URL.
* - Service `bigmarker`: Your BigMarker base URL.
* - Service `billing_platform`: Your BillingPlatform subdomain.
* - Service `boostr`: Your Boostr base URL.
* - Service `brex`: Your Brex Base URL
* - Service `centra`: Your Centra base URL.
* - Service `coalesce`: Your Coalesce base URL.
* - Service `coheris`: Your Coheris base URL.
* - Service `cornerstone`: Your Cornerstone base URL.
* - Service `culture_amp`: Your Culture Amp base URL.
* - Service `datadog`: Your Datadog base url.
* - Service `factbird`: Your Factbird base url.
* - Service `fillout`: Your Fillout Base URL.
* - Service `financial_force`: (Optional) The custom Salesforce domain. Make sure that the `base_url` starts with `https://`.
* - Service `freshsales`: Your Freshsales product.
* - Service `gitlab`: Your GitLab base URL.
* - Service `gongio`: Your Gong API Base URL.
* - Service `higher_logic_vanilla`: Your Higher Logic Vanilla base URL.
* - Service `ironclad`: Your Ironclad base url.
* - Service `jotform`: Your Jotform base URL.
* - Service `mailgun`: Your Mailgun base URL.
* - Service `nice`: Your NICE base URL.
* - Service `ortto`: Your Ortto base URL. Possible values: `api`, `api.au`, `api.eu`.
* - Service `prisma_cloud`: Your Prisma Cloud admin console URL.
* - Service `salesforce`: (Optional) The custom Salesforce domain. Make sure that the `base_url` starts with `https://`.
* - Service `salesforce_sandbox`: (Optional) The custom Salesforce domain. Make sure that the `base_url` starts with `https://`.
* - Service `stickyio`: Your sticky.io base URL .
* - Service `veeva_vault`: Base URL
* - Service `veevavault`: Your Veeva Vault base URL.
* - Service `vitally`: Your Vitally base URL.
*/
baseUrl: string;
/**
* Field usage depends on `service` value:
* - Service `ada`: Your Ada API key.
* - Service `crowddev`: Your crowd.dev Auth Token.
* - Service `customerio`: Your Customer.io App API Key.
* - Service `freshchat`: Your Freshchat API Token.
* - Service `hopin`: Your Hopin API key.
* - Service `orbit`: Your Orbit API Token.
* - Service `productboard`: Your Productboard API key.
* - Service `smarthr`: Your SmartHR access token.
* - Service `sprout`: Your Sprout Social API Access Token.
* - Service `zenefits`: Your Zenefits bearer token.
*/
bearerToken?: string;
/**
* Field usage depends on `service` value:
* - Service `sql_server`: Determine who is responsible for truncating the online transaction log. Possible values: `"FIVETRAN"`, `"USER_MANAGED"`, `"SQL_SERVER_AGENT"`. Default value is `"FIVETRAN"`.
*/
binaryLogTruncater: string;
/**
* Field usage depends on `service` value:
* - Service `sql_server`: Source of transaction log data when using Binary Log Reader. Possible values: `"ONLINE"`, `"BACKUP"`. Default value is `"ONLINE"`.
*/
binaryLogType: string;
/**
* Field usage depends on `service` value:
* - Service `azure_cosmos_for_mongo`: How binary data is represented in the database. Possible values: 'Base64' (default), 'Uuid'.
* - Service `mongo`: How binary data is represented in the database. Possible values: 'Base64' (default), 'Uuid'.
* - Service `mongo_sharded`: How binary data is represented in the database. Possible values: 'Base64' (default), 'Uuid'.
*/
binaryRepresentation: string;
/**
* Field usage depends on `service` value:
* - Service `webhooks`: The blob SAS URL of your Azure container. Required if `bucket_service` is set to `AZURE`.
*/
blobSasUrl?: string;
/**
* Field usage depends on `service` value:
* - Service `rarible`: Your Rarible Blockchain.
*/
blockchain: string;
/**
* Field usage depends on `service` value:
* - Service `oracle_moat_analytics`: Your Oracle Moat Analytics Brand ID.
*/
brandId?: string;
/**
* Field usage depends on `service` value:
* - Service `facebook`: List of breakdowns which connector will sync. [Possible breakdowns values](https://fivetran.com/docs/applications/facebook-ad-insights/api-config#breakdowns).
*/
breakdowns?: string[];
/**
* Field usage depends on `service` value:
* - Service `appsflyer`: Customer S3 Bucket
* - Service `aws_cloudtrail`: The AWS bucket name which is configured for AWS CloudTrail.
* - Service `aws_cost_report`: The S3 bucket name with the AWS Cost and Usage Report
* - Service `aws_inventory`: The AWS bucket name that is configured for AWS Config.
* - Service `aws_lambda`: S3 Bucket
* - Service `cloudfront`: The bucket name for CloudFront.
* - Service `gcs`: The name of the GCS bucket.
* - Service `google_play`: The Google Cloud Storage source bucket.
* - Service `heap`: The S3 bucket name.
* - Service `kinesis`: The name of the Kinesis bucket.
* - Service `s3`: The S3 bucket name. Required for connector creation.
* - Service `s3_compatible_storage`: The S3-Compatible Storage bucket name. Required for connector creation.
* - Service `segment`: The name of the Segment bucket. Must be populated if `sync_type` is set to `S3`.
* - Service `sql_server`: The name of the S3 bucket.
* - Service `wasabi_cloud_storage`: The Wasabi Cloud Storage bucket name. Required for connector creation.
*/
bucket: string;
/**
* Field usage depends on `service` value:
* - Service `adjust`: Your AWS S3 or GCS bucket.
* - Service `google_analytics_360`: The name of the bucket.
* - Service `google_analytics_4_export`: The name of the bucket.
*/
bucketName: string;
/**
* Field usage depends on `service` value:
* - Service `webhooks`: Whether to store the events in Fivetran's container service or your S3 bucket. Default value: `Fivetran`.
*/
bucketService: string;
/**
* Field usage depends on `service` value:
* - Service `reddit_ads`: Specific Accounts to sync. Must be populated if `sync_mode` is set to `SpecificAccounts`.
*/
businessAccounts?: string[];
/**
* Field usage depends on `service` value:
* - Service `tiktok_organic_app`: The TikTok business category whose data you want to sync.
*/
businessCategory: string;
/**
* Field usage depends on `service` value:
* - Service `birdeye`: Your Birdeye Business ID.
*/
businessId?: string;
/**
* Field usage depends on `service` value:
* - Service `deposco`: Your Deposco business unit.
*/
businessUnit?: string;
/**
* Field usage depends on `service` value:
* - Service `pardot`: Business Unit Id
* - Service `pardot_sandbox`: Business Unit Id
*/
businessUnitId?: string;
/**
* Field usage depends on `service` value:
* - Service `sailthru`: The number of days to look back for campaign query data during incremental syncs. Valid range: 2-90. Default: 60.
*/
campaignQueryLookbackWindowInDays: number;
/**
* Field usage depends on `service` value:
* - Service `databricks_db`: catalog to sync
*/
catalog?: string;
/**
* Field usage depends on `service` value:
* - Service `anaplan`: The contents of your PEM certificate file. Must be populated if `auth_mode` is set to `Certificate`.
* - Service `db2z`: Db2 for z/OS host certificate
* - Service `qualtrics`: Your Client Certificate
* - Service `salesforce`: Provide content of the `.pem` certificate (only when authentication_method = `ADVANCED`).
* - Service `salesforce_sandbox`: Provide content of the `.pem` certificate (only when authentication_method = `ADVANCED`).
*/
certificate: string;
/**
* Field usage depends on `service` value:
* - Service `netsuite_suiteanalytics`: Certificate Id
*/
certificateId?: string;
/**
* Field usage depends on `service` value:
* - Service `facebook`: Time period to attribute conversions based on clicks. [Possible click_attribution_window values](https://fivetran.com/docs/applications/facebook-ad-insights/api-config#clickattributionwindow).
* - Service `pinterest_ads`: The number of days to use as the conversion attribution window for a 'click' action.
*/
clickAttributionWindow: string;
client?: string;
/**
* Field usage depends on `service` value:
* - Service `apache_kafka`: Kafka client certificate.
* - Service `heroku_kafka`: Heroku Kafka client certificate. Required for `TLS` security protocol.
*/
clientCert?: string;
/**
* Field usage depends on `service` value:
* - Service `apache_kafka`: Kafka client certificate key.
* - Service `heroku_kafka`: Heroku Kafka client certificate key. Required for `TLS` security protocol.
*/
clientCertKey?: string;
/**
* Field usage depends on `service` value:
* - Service `amqp`: Client certificate for mutual TLS authentication.
* - Service `gitlab`: Your GitLab client certificate content.
* - Service `share_point`: `Client Certificate` of your Microsoft client application.
*/
clientCertificate?: string;
/**
* Field usage depends on `service` value:
* - Service `share_point`: `Certificate Private Key` of your Microsoft client application.
*/
clientCertificatePrivateKey?: string;
/**
* Field usage depends on `service` value:
* - Service `ceridian_dayforce`: Your Ceridian Dayforce client host.
*/
clientHost?: string;
/**
* Field usage depends on `service` value:
* - Service `360learning`: Your 360Learning client ID.
* - Service `acumatica`: Your Acumatica client ID.
* - Service `adform`: Your Adform client ID.
* - Service `adobe_analytics`: Client ID from the OAuth Server-to-Server credentials of your Adobe Project.
* - Service `adobe_experience_platform`: Your Adobe Experience Platform client ID.
* - Service `adobe_workfront`: Your Adobe Workfront client ID.
* - Service `adp_workforce_now`: Your ADP Client ID.
* - Service `akamai`: Your Akamai client ID.
* - Service `akeneo`: Your Akeneo client ID.
* - Service `alation`: Client ID of the OAuth client application registered in Alation for this connection.
* - Service `auth0`: Your Auth0 client ID.
* - Service `autodesk_bim_360`: Your Autodesk BIM 360 & Construction Cloud client ID.
* - Service `bigin_by_zoho_crm`: Your Bigin by Zoho CRM Client Id
* - Service `billing_platform`: Your BillingPlatform client ID.
* - Service `bing_webmaster_tools`: Your Bing Webmaster Tools client ID.
* - Service `bizzabo_app`: Your Bizzabo client ID.
* - Service `bizzabo_v2`: Your Bizzabo client ID.
* - Service `brightcove`: Your Brightcove client ID.
* - Service `brightflag`: Your Brightflag client ID.
* - Service `brightpearl`: Your Brightpearl client ID.
* - Service `brivo`: Your Brivo client ID.
* - Service `buildium`: Your Buildium API client ID.
* - Service `bynder`: Client ID of the OAuth app that you created in Bynder for the connection.
* - Service `cabcharge`: Your Cabcharge client ID.
* - Service `canvas_by_instructure`: Your Canvas by Instructure client ID.
* - Service `canvas_data_2_by_instructure`: Your Canvas Data 2 by Instructure client ID.
* - Service `castor_edc`: Your Castor EDC client Id.
* - Service `classy`: Your Classy client ID.
* - Service `clazar`: Your Clazar client ID.
* - Service `cloudbeds`: Your Cloudbeds client ID.
* - Service `commercetools`: Your commercetools client ID.
* - Service `concur`: The SAP Concur Client ID.
* - Service `constant_contact`: Your Constant Contact client ID.
* - Service `cornerstone`: Your Cornerstone client ID.
* - Service `coupa`: Your Coupa client_id
* - Service `credly`: Enter your Credly Client ID
* - Service `criteo`: Your Criteo Client ID.
* - Service `criteo_retail_media`: Your Criteo Retail Media client ID.
* - Service `cube`: Your Cube client ID.
* - Service `cube_software`: Your Cube client ID.
* - Service `culture_amp`: Your Culture Amp client ID.
* - Service `cvent`: Your Cvent client ID.
* - Service `d2l_brightspace`: Your D2L Brightspace client ID.
* - Service `dialpad`: Your Dialpad client ID.
* - Service `ebay`: Your eBay app ID.
* - Service `exact_online`: Your Exact Online client ID.
* - Service `fillout`: Your Fillout client ID.
* - Service `flexport`: The Flexport API Key.
* - Service `formstack`: Your Formstack client ID.
* - Service `fortnox`: Your Fortnox client ID.
* - Service `genesys`: Your Genesys client ID.
* - Service `github`: GitHub App Client ID
* - Service `gofundme_pro`: Client ID of the API application in your GoFundMe Pro account.
* - Service `h_level`: Your HighLevel client ID.
* - Service `hana_sap_hva_ecc_netweaver`: Three-digit (000-999) identifier of the SAP client, which is sent to an AS ABAP upon logon.
* - Service `hana_sap_hva_s4_netweaver`: Three-digit (000-999) identifier of the SAP client, which is sent to an AS ABAP upon logon.
* - Service `helpdesk`: Your HelpDesk client ID.
* - Service `hilti_ontrack`: Your Hilti On!Track client ID.
* - Service `ibacos`: Your Ibacos Client ID.
* - Service `ilevel`: Your iLevel Client ID.
* - Service `instructure`: Your Instructure client ID.
* - Service `integral_ad_science`: Your integral_ad_science client id.
* - Service `ironclad`: Your Ironclad client ID.
* - Service `jama_software`: Your Jama Software client ID.
* - Service `jibble`: Your Jibble client ID.
* - Service `khoros_communities`: Your Khoros Communities client ID.
* - Service `learn_amp`: Your Learn Amp client ID.
* - Service `looker_source`: Your Looker Client ID.
* - Service `marketo`: Marketo REST API Client Id.
* - Service `medallia`: Medallia Client ID
* - Service `microsoft_entra_id`: Your Microsoft Entra ID Client ID.
* - Service `microsoft_power_bi`: Your Microsoft Power BI client ID.
* - Service `microsoft_teams`: Your Microsoft Teams client ID.
* - Service `navan`: Your Navan client ID.
* - Service `nice`: Your NICE client ID.
* - Service `on24`: Your ON24 client ID.
* - Service `onetrust`: Your OneTrust client ID.
* - Service `oracle_fusion_field_service`: Your Oracle Fusion Field Service client ID.
* - Service `oracle_netsuite_openair`: Your NetSuite SuiteProjects Pro client ID.
* - Service `oracle_sap_hva_netweaver`: Three-digit (000-999) identifier of the SAP client, which is sent to an AS ABAP upon logon.
* - Service `paychex`: Your Paychex client ID.
* - Service `paylocity`: Your Paylocity client ID.
* - Service `paypal`: `Client ID` of your PayPal client application.
* - Service `paypal_sandbox`: Client ID of your PayPal client application.
* - Service `personio`: Your Personio Client ID.
* - Service `piwik_pro`: Your Piwik PRO client ID.
* - Service `podio`: Your Podio client ID.
* - Service `power_reviews_enterprise`: Your PowerReviews Enterprise Client ID.
* - Service `prisma_cloud`: Your Prisma Cloud access key ID.
* - Service `procore`: Your Procore client ID.
* - Service `quickbooks`: Client ID of your QuickBooks client application.
* - Service `quora_ads`: Your Quora Ads client ID.
* - Service `reltio`: Your Reltio client ID.
* - Service `salesforce_commerce_cloud`: The Salesforce Commerce Cloud Client ID.
* - Service `salesforce_marketing_cloud`: The Salesforce Marketing Cloud client ID.
* - Service `salesloft`: `Client ID` of your Salesloft client application.
* - Service `sana`: Your Sana client ID.
* - Service `sap_success_factors`: Your SAP SuccessFactors Client ID.
* - Service `servicenow`: ServiceNow Client ID.
* - Service `servicetitan`: Your ServiceTitan client ID.
* - Service `sharetribe`: Your Sharetribe client ID.
* - Service `shipnetwork`: Your ShipNetwork client ID.
* - Service `shopify`: Client ID of your public app
* - Service `showpad`: Your Showpad client ID.
* - Service `siemens_building_x_openness`: Your Siemens Building X Openness client ID.
* - Service `sigma_computing_source`: Your Sigma Computing client ID.
* - Service `skillstx`: Your SkillsTX client ID.
* - Service `skimlinks`: Your Skimlinks client ID.
* - Service `slack_app`: Your Slack app Client ID.
* - Service `smartrecruiters`: Your SmartRecruiters client ID.
* - Service `splash`: Your Splash client ID.
* - Service `square`: The Application ID of your organization.
* - Service `standard_metrics`: Your Standard Metrics Client ID.
* - Service `sugarcrm`: Your SugarCRM client ID.
* - Service `swoogo`: Your Swoogo client Id.
* - Service `taboola`: The Taboola client ID.
* - Service `talkdesk`: The Client ID of your OAuth Client
* - Service `tive`: Your Tive client ID.
* - Service `toast`: Your Toast client ID.
* - Service `trelica`: Your Trelica client ID.
* - Service `tremendous`: Your Tremendous client ID.
* - Service `tymeshift`: Your Tymeshift email.
* - Service `udemy_business`: Your Udemy Business client ID.
* - Service `ukg_pro_workforce_management`: Your UKG Pro Workforce Management client ID.
* - Service `vimeo`: Your Vimeo client ID.
* - Service `visma`: Your Visma client ID.
* - Service `vonage_contact_center`: Your Vonage Contact Center client ID.
* - Service `walmart_marketplace`: Your Walmart Marketplace client ID.
* - Service `xero`: your clientId
* - Service `xray`: Your Xray Client ID.
* - Service `yahoo_display_ads_on_yahoo_japan`: Your Yahoo Display Ads on Yahoo Japan client ID.
* - Service `yougov_sport`: Your Yougov Sport client ID.
* - Service `zendesk_chat`: Your Zendesk client ID.
* - Service `zoho_books`: Your Zoho Books Client ID.
* - Service `zoho_campaigns`: Your Zoho Campaigns Client ID.
* - Service `zoho_desk`: Your Zoho Desk Client Id.
* - Service `zoho_inventory`: Your Zoho Inventory client ID.
* - Service `zoho_recruit`: Your Zoho Recruit client ID.
* - Service `zuora`: Zuora Client ID.
* - Service `zuora_sandbox`: Zuora Client ID.
*/
clientId: string;
/**
* Field usage depends on `service` value:
* - Service `appfigures`: Your Appfigures Client Key.
* - Service `thinkific`: Your Thinkific client key.
* - Service `yougov_sport`: Your Yougov Sport client key.
*/
clientKey?: string;
/**
* Field usage depends on `service` value:
* - Service `destini`: Your Destini Client Name.
* - Service `medallia`: Medallia company name
* - Service `zuora`: The name of your organization as registered with Zuora Revenue.
* - Service `zuora_sandbox`: The name of your organization as registered with Zuora Revenue.
*/
clientName: string;
/**
* Field usage depends on `service` value:
* - Service `ceridian_dayforce`: Your Ceridian Dayforce client namespace.
*/
clientNamespace?: string;
/**
* Field usage depends on `service` value:
* - Service `amqp`: Client private key for mutual TLS authentication.
* - Service `aurora`: Client Private Key in .pem format.
* - Service `aurora_postgres`: Client Private Key in .pem format.
* - Service `azure_postgres`: Client Private Key in .pem format.
* - Service `gitlab`: Your GitLab client private key content.
* - Service `google_cloud_mysql`: Client Private Key in .pem format.
* - Service `google_cloud_postgresql`: Client Private Key in .pem format.
* - Service `heroku_postgres`: Client Private Key in .pem format.
* - Service `magento_mysql`: Client Private Key in .pem format.
* - Service `magento_mysql_rds`: Client Private Key in .pem format.
* - Service `maria`: Client Private Key in .pem format.
* - Service `maria_azure`: Client Private Key in .pem format.
* - Service `maria_rds`: Client Private Key in .pem format.
* - Service `mysql`: Client Private Key in .pem format.
* - Service `mysql_azure`: Client Private Key in .pem format.
* - Service `mysql_rds`: Client Private Key in .pem format.
* - Service `postgres`: Client Private Key in .pem format.
* - Service `postgres_rds`: Client Private Key in .pem format.
*/
clientPrivateKey?: string;
/**
* Field usage depends on `service` value:
* - Service `aurora`: Client Certificate in .pem format.
* - Service `aurora_postgres`: Client Certificate in .pem format.
* - Service `azure_postgres`: Client Certificate in .pem format.
* - Service `google_cloud_mysql`: Client Certificate in .pem format.
* - Service `google_cloud_postgresql`: Client Certificate in .pem format.
* - Service `heroku_postgres`: Client Certificate in .pem format.
* - Service `magento_mysql`: Client Certificate in .pem format.
* - Service `magento_mysql_rds`: Client Certificate in .pem format.
* - Service `maria`: Client Certificate in .pem format.
* - Service `maria_azure`: Client Certificate in .pem format.
* - Service `maria_rds`: Client Certificate in .pem format.
* - Service `mysql`: Client Certificate in .pem format.
* - Service `mysql_azure`: Client Certificate in .pem format.
* - Service `mysql_rds`: Client Certificate in .pem format.
* - Service `postgres`: Client Certificate in .pem format.
* - Service `postgres_rds`: Client Certificate in .pem format.
*/
clientPublicCertificate?: string;
/**
* Field usage depends on `service` value:
* - Service `360learning`: Your 360Learning client secret.
* - Service `acumatica`: Your Acumatica client secret.
* - Service `adform`: Your Adform client secret.
* - Service `adobe_analytics`: Client Secret from the OAuth Server-to-Server credentials of your Adobe Project.
* - Service `adobe_experience_platform`: Your Adobe Experience Platform client secret.
* - Service `adobe_workfront`: Your Adobe Workfront client secret.
* - Service `adp_workforce_now`: Your ADP Client Secret.
* - Service `akamai`: Your Akamai client secret.
* - Service `akeneo`: Your Akeneo client secret.
* - Service `alation`: Client secret of the OAuth client application registered in Alation for this connection.
* - Service `auth0`: Your Auth0 client secret.
* - Service `autodesk_bim_360`: Your Autodesk BIM 360 & Construction Cloud client secret.
* - Service `bigin_by_zoho_crm`: Your Bigin by Zoho CRM Client Secret
* - Service `billing_platform`: Your BillingPlatform client secret.
* - Service `bing_webmaster_tools`: Your Bing Webmaster Tools client secret.
* - Service `bizzabo_app`: Your Bizzabo client secret.
* - Service `bizzabo_v2`: Your Bizzabo client secret.
* - Service `brightcove`: Your Brightcove client secret.
* - Service `brightflag`: Your Brightflag client secret.
* - Service `brightpearl`: Your Brightpearl client secret.
* - Service `brivo`: Your Brivo client secret.
* - Service `bynder`: Client secret of the OAuth app that you created in Bynder for the connection.
* - Service `canvas_by_instructure`: Your Canvas by Instructure client secret.
* - Service `castor_edc`: Your Castor EDC client secret.
* - Service `classy`: Your Classy client secret.
* - Service `clazar`: Your Clazar client secret.
* - Service `cloudbeds`: Your Cloudbeds client secret.
* - Service `commercetools`: Your commercetools client secret.
* - Service `concur`: The SAP Concur Client secret.
* - Service `constant_contact`: Your Constant Contact client secret.
* - Service `cornerstone`: Your Cornerstone client secret.
* - Service `coupa`: Your Coupa client_id
* - Service `credly`: Enter your Credly Client Secret
* - Service `criteo`: Your Criteo client secret key.
* - Service `criteo_retail_media`: Your Criteo Retail Media client secret.
* - Service `cube`: Your Cube client secret.
* - Service `cube_software`: Your Cube client secret.
* - Service `culture_amp`: Your Culture Amp client secret.
* - Service `cvent`: Your Cvent client secret.
* - Service `d2l_brightspace`: Your D2L Brightspace client secret.
* - Service `dialpad`: Your Dialpad client secret.
* - Service `ebay`: Your eBay cert ID.
* - Service `exact_online`: Your Exact Online client secret.
* - Service `fillout`: Your Fillout client secret
* - Service `flexport`: The Flexport API Secret.
* - Service `formstack`: Your Formstack client secret.
* - Service `fortnox`: Your Fortnox client secret.
* - Service `genesys`: Your Genesys client secret.
* - Service `gofundme_pro`: Client secret of the API application in your GoFundMe Pro account.
* - Service `h_level`: Your HighLevel client secret.
* - Service `helpdesk`: Your HelpDesk client secret.
* - Service `hilti_ontrack`: Your Hilti On!Track client secret.
* - Service `hubspot`: Client secret for private custom app authentication.
* - Service `ibacos`: Your Ibacos Client secret.
* - Service `ilevel`: Your iLevel Client Secret.
* - Service `instructure`: Your Instructure client secret.
* - Service `integral_ad_science`: Your integral_ad_science client secret.
* - Service `ironclad`: Your Ironclad client secret.
* - Service `jama_software`: Your Jama Software client secret.
* - Service `jibble`: Your Jibble client secret.
* - Service `learn_amp`: Your Learn Amp client secret.
* - Service `looker_source`: Your Looker Client Secret.
* - Service `marketo`: Marketo REST API Client Secret.
* - Service `medallia`: Medallia Client Secret key
* - Service `microsoft_entra_id`: Your Microsoft Entra ID Client Secret.
* - Service `microsoft_power_bi`: Your Microsoft Power BI client secret.
* - Service `microsoft_teams`: Your Microsoft Teams client secret.
* - Service `navan`: Your Navan client secret.
* - Service `nice`: Your NICE client secret.
* - Service `onetrust`: Your OneTrust client secret.
* - Service `oracle_fusion_field_service`: Your Oracle Fusion Field Service client secret.
* - Service `oracle_netsuite_openair`: Your NetSuite SuiteProjects Pro client secret.
* - Service `paychex`: Your Paychex client secret.
* - Service `paylocity`: Your Paylocity client secret.
* - Service `personio`: Your Personio secret.
* - Service `piwik_pro`: Your Piwik PRO client secret.
* - Service `podio`: Your Podio client secret.
* - Service `power_reviews_enterprise`: Your PowerReviews Enterprise Client Secret.
* - Service `prisma_cloud`: Your Prisma Cloud secret access Key.
* - Service `procore`: Your Procore client secret.
* - Service `quickbooks`: Client Secret of your QuickBooks client application.
* - Service `quora_ads`: Your Quora Ads client secret.
* - Service `reltio`: Your Reltio client secret.
* - Service `salesforce_commerce_cloud`: The Salesforce Commerce Cloud Client secret.
* - Service `salesforce_marketing_cloud`: The Salesforce Marketing Cloud client secret.
* - Service `salesloft`: `Client Secret` of your Salesloft client application.
* - Service `sana`: Your Sana client secret.
* - Service `sap_success_factors`: Your SAP SuccessFactors Client Secret that you generated through SAML Assertion.
* - Service `servicenow`: ServiceNow Client Secret.
* - Service `servicetitan`: Your ServiceTitan secret key.
* - Service `sharetribe`: Your Sharetribe client secret.
* - Service `shopify`: Client secret of your public app
* - Service `showpad`: Your Showpad client secret.
* - Service `siemens_building_x_openness`: Your Siemens Building X Openness client secret.
* - Service `sigma_computing_source`: Your Sigma Computing client secret.
* - Service `skillstx`: Your SkillsTX client secret.
* - Service `skimlinks`: Your Skimlinks client secret.
* - Service `slack_app`: Your Slack app Client Secret.
* - Service `smartrecruiters`: Your SmartRecruiters client secret.
* - Service `splash`: Your Splash client secret.
* - Service `square`: The Application Secret of your organization.
* - Service `standard_metrics`: Your Standard Metrics Client secret.
* - Service `sugarcrm`: Your SugarCRM client secret.
* - Service `swoogo`: Your Swoogo Client Secret.
* - Service `taboola`: The Taboola client secret.
* - Service `talkdesk`: The Client Secret of your OAuth Client
* - Service `thinkific`: Your Thinkific client secret.
* - Service `tive`: Your Tive client secret.
* - Service `toast`: Your Toast client secret.
* - Service `trelica`: Your Trelica client secret.
* - Service `tremendous`: Your Tremendous client secret.
* - Service `tymeshift`: Your Tymeshift password.
* - Service `udemy_business`: Your Udemy Business client secret.
* - Service `ukg_pro_workforce_management`: Your UKG Pro Workforce Management client secret.
* - Service `vimeo`: Your Vimeo client secret.
* - Service `visma`: Your Visma client secret.
* - Service `vonage_contact_center`: Your Vonage Contact Center client secret.
* - Service `walmart_marketplace`: Your Walmart Marketplace client secret.
* - Service `xero`: your clientSecret
* - Service `xray`: Your Xray Client Secret.
* - Service `yahoo_display_ads_on_yahoo_japan`: Your Yahoo Display Ads on Yahoo Japan client secret.
* - Service `zendesk_chat`: Your Zendesk client secret.
* - Service `zoho_books`: Your Zoho Books Client Secret.
* - Service `zoho_campaigns`: Your Zoho Campaigns Client Secret.
* - Service `zoho_desk`: Your Zoho Desk Client secret.
* - Service `zoho_inventory`: Your Zoho Inventory client secret.
* - Service `zoho_recruit`: Your Zoho Recruit client secret.
* - Service `zuora`: Zuora Client Secret.
* - Service `zuora_sandbox`: Zuora Client Secret.
*/
clientSecret: string;
/**
* Field usage depends on `service` value:
* - Service `braze`: Cloud storage type Braze Current is connected to.
*/
cloudStorageType: string;
/**
* Field usage depends on `service` value:
* - Service `rarible`: Your Rarible Collection Address.
*/
collectionAddress?: string;
/**
* Field usage depends on `service` value:
* - Service `double_click_publishers`: Columns provide all trafficking statistics and revenue information available for the chosen Dimensions.
*/
columns?: string[];
/**
* Field usage depends on `service` value:
* - Service `alida`: Your Alida community API key name.
*/
communityApiKeyName?: string;
/**
* Field usage depends on `service` value:
* - Service `khoros_communities`: Your Khoros Communities community domain.
*/
communityDomain?: string;
/**
* Field usage depends on `service` value:
* - Service `khoros_communities`: Your Khoros Communities community ID.
*/
communityId?: string;
/**
* Field usage depends on `service` value:
* - Service `business_central`: List of companies to sync
*/
companies?: string[];
/**
* Field usage depends on `service` value:
* - Service `ordway`: Your Ordway company name.
*/
company?: string;
/**
* Field usage depends on `service` value:
* - Service `360learning`: Your 360Learning company ID.
* - Service `cube`: Your Cube company ID.
* - Service `cube_software`: Your Cube company ID.
* - Service `oracle_netsuite_openair`: Your NetSuite SuiteProjects Pro company ID.
* - Service `paylocity`: Your Paylocity company ID.
* - Service `sage_intacct`: Company ID
* - Service `sap_success_factors`: Your SAP SuccessFactors Company ID.
*/
companyId: string;
/**
* Field usage depends on `service` value:
* - Service `cj_commission_detail`: Your CJ Commission Detail company IDs.
*/
companyIds?: string;
/**
* Field usage depends on `service` value:
* - Service `khoros_care`: Your Khoros Care companyKey.
* - Service `upland`: Your Upland Software company key.
*/
companyKey?: string;
/**
* Field usage depends on `service` value:
* - Service `clockodo`: Your Clockodo company name.
*/
companyName?: string;
/**
* Field usage depends on `service` value:
* - Service `concur`: The SAP Concur Company Request Token
*/
companyRequestToken?: string;
/**
* Field usage depends on `service` value:
* - Service `concur`: The SAP Concur Company UUID
*/
companyUuid?: string;
/**
* Field usage depends on `service` value:
* - Service `aws_cost_report`: If your files are compressed, but do not have extensions indicating the compression method, you can force them to be uncompressed according to the selected compression algorithm. Leave the value as infer if your files are saved with the correct compression extensions.
* - Service `azure_blob_storage`: The secrets that should be passed to the function at runtime.
* - Service `box`: The compression format is used to let Fivetran know that even files without a compression extension should be decompressed using the selected compression format.
* - Service `dropbox`: The compression format is used to let Fivetran know that even files without a compression extension should be decompressed using the selected compression format.
* - Service `email`: The secrets that should be passed to the function at runtime.
* - Service `ftp`: The secrets that should be passed to the function at runtime.
* - Service `gcs`: The secrets that should be passed to the function at runtime.
* - Service `google_drive`: The compression format is used to let Fivetran know that even files without a compression extension should be decompressed using the selected compression format.
* - Service `kinesis`: If your files are compressed, but do not have extensions indicating the compression method, you can force them to be uncompressed according to the selected compression algorithm. Leave the value as infer if your files are saved with the correct compression extensions.
* - Service `s3`: The compression format is used to let Fivetran know that even files without a compression extension should be decompressed using the selected compression format.
* - Service `s3_compatible_storage`: The compression format is used to let Fivetran know that even files without a compression extension should be decompressed using the selected compression format.
* - Service `sftp`: The secrets that should be passed to the function at runtime.
* - Service `share_point`: The compression format is used to let Fivetran know that even files without a compression extension should be decompressed using the selected compression format.
* - Service `wasabi_cloud_storage`: The compression format is used to let Fivetran know that even files without a compression extension should be decompressed using the selected compression format.
*/
compression: string;
/**
* Field usage depends on `service` value:
* - Service `google_display_and_video_360`: The report configuration method. Specifies whether a new configuration is defined manually or an existing configuration is reused. The default value is `CREATE_NEW`.
*/
configMethod: string;
/**
* Field usage depends on `service` value:
* - Service `snowplow`: Public repository URL containing JSON configuration files.
*/
configRepositoryUrl?: string;
/**
* Field usage depends on `service` value:
* - Service `facebook`: Option to select Prebuilt Reports or Custom Reports. [Possible config_type values](https://fivetran.com/docs/applications/facebook-ad-insights/api-config#configtype).
* - Service `google_analytics`: Whether to use the [Prebuilt Reports or Custom Reports](https://fivetran.com/docs/connectors/applications/google-analytics#schemainformation).
*/
configType: string;
/**
* Field usage depends on `service` value:
* - Service `xactly`: Your Xactly Connect password.
*/
connectPassword?: string;
/**
* Field usage depends on `service` value:
* - Service `xactly`: Your Xactly Connect username.
*/
connectUsername?: string;
connectingUser?: string;
connectingUserEmail?: string;
/**
* Field usage depends on `service` value:
* - Service `aws_msk`: How Fivetran connects to your message brokers in the cluster
* - Service `azure_blob_storage`: Connection Method. Possible values: `DIRECT`: Fivetran will connect directly to your storage container, `SSH_TUNNEL`: Fivetran will connect to your storage container using a host machine (commonly used for VPN connections), `PRIVATE_LINK`: Fivetran will connect to your storage container using PrivateLink.
* - Service `azure_function`: Connection Method. Possible values: `DIRECT`: Fivetran will connect directly to your function, `PRIVATE_LINK`: Fivetran will connect to your storage container using PrivateLink.
* - Service `azure_service_bus`: The connection method
* - Service `sftp`: The connection method used to connect to SFTP Server.
*/
connectionMethod: string;
/**
* Field usage depends on `service` value:
* - Service `appsflyer`: Your Data Locker Connection Name. Default value: `data-locker-hourly/
*/
connectionName?: string;
/**
* Field usage depends on `service` value:
* - Service `azure_blob_storage`: The blob storage container connection string.
* - Service `azure_event_hub`: Connection string of the Event Hub Namespace you want to sync.
* - Service `azure_service_bus`: The connection string used for authentication. Required if the authentication type is `ConnectionString`
* - Service `microsoft_dynamics_365_fno`: The blob storage container's connection string.
* - Service `microsoft_dynamics_365_fo`: The blob storage container connection string.
* - Service `sql_server`: The Azure Blob Storage container connection string.
*/
connectionString: string;
/**
* Field usage depends on `service` value:
* - Service `aurora`: Possible values:`Directly`, `PrivateLink`, `SshTunnel`. `SshTunnel` is used as a value if this parameter is omitted in the request and any of the following parameter's values is specified: `tunnel_host`, `tunnel_port`, `tunnel_user`. Otherwise, `Directly` is used as a value if the parameter is omitted.
* - Service `aurora_postgres`: Possible values:`Directly`, `PrivateLink`, `SshTunnel`. `SshTunnel` is used as a value if this parameter is omitted in the request and any of the following parameter's values is specified: `tunnel_host`, `tunnel_port`, `tunnel_user`. Otherwise, `Directly` is used as a value if the parameter is omitted.
* - Service `aveva_pi`: Possible values: `Directly`, `PrivateLink`
* - Service `aws_cost_report`: Connection method. Default value: `Directly`.
* - Service `aws_lambda`: Connection method. Default value: `Directly`.
* - Service `azure_blob_storage`: Connection method. Default value: `Directly`.
* - Service `azure_cosmos_for_mongo`: Possible values:`Directly`, `PrivateLink`. `Directly` is the default value
* - Service `azure_postgres`: Possible values:`Directly`, `PrivateLink`, `SshTunnel`. `SshTunnel` is used as a value if this parameter is omitted in the request and any of the following parameter's values is specified: `tunnel_host`, `tunnel_port`, `tunnel_user`. Otherwise, `Directly` is used as a value if the parameter is omitted.
* - Service `azure_sql_db`: Possible values: `Directly`, `PrivateLink`, `SshTunnel`. `SshTunnel` is used as a value if this parameter is omitted in the request and any of the following parameter's values is specified: `tunnel_host`, `tunnel_port`, `tunnel_user`. Otherwise, `Directly` is used as a value if the parameter is omitted.
* - Service `azure_sql_managed_db`: Possible values: `Directly`, `PrivateLink`, `SshTunnel`. `SshTunnel` is used as a value if this parameter is omitted in the request and any of the following parameter's values is specified: `tunnel_host`, `tunnel_port`, `tunnel_user`. Otherwise, `Directly` is used as a value if the parameter is omitted.
* - Service `bigquery_db`: Direct or PrivateLink connection
* - Service `clarity`: Possible values: `Directly`, `PrivateLink`, `SshTunnel`. `SshTunnel` is used as a value if this parameter is omitted in the request and any of the following parameter's values is specified: `tunnel_host`, `tunnel_port`, `tunnel_user`. Otherwise, `Directly` is used as a value if the parameter is omitted.
* - Service `cockroachdb`: Possible values:`Directly`, `SshTunnel`. `SshTunnel` is used as a value if this parameter is omitted in the request and any of the following parameter's values is specified: `tunnel_host`, `tunnel_port`, `tunnel_user`. Otherwise, `Directly` is used as a value if the parameter is omitted.
* - Service `db2i_hva`: Possible values:`SshTunnel`. `SshTunnel` is used as a value if this parameter is omitted in the request and the following parameter's values are specified: `tunnel_host`, `tunnel_port`, `tunnel_user`.
* - Service `db2i_sap_hva`: Possible values:`SshTunnel`. `SshTunnel` is used as a value if this parameter is omitted in the request and any of the following parameter's values is specified: `tunnel_host`, `tunnel_port`, `tunnel_user`.
* - Service `db2luw`: Possible values:`SshTunnel`. `SshTunnel` is used as a value if this parameter is omitted in the request and the following parameter's values are specified: `tunnel_host`, `tunnel_port`, `tunnel_user`.
* - Service `db2z`: Possible values: `Directly`, `SshTunnel`. `SshTunnel` is used as a value if this parameter is omitted in the request and any of the following parameter's values is specified: `tunnel_host`, `tunnel_port`, `tunnel_user`. Otherwise, `Directly` is used as a value if the parameter is omitted.
* - Service `documentdb`: Possible values:`SshTunnel`, `PrivateLink` . `SshTunnel` is used as a value if this parameter is omitted in the request and the following parameter's values are specified: `tunnel_host`, `tunnel_port`, `tunnel_user`.
* - Service `dynamics_365_fo`: Possible values: `Directly`, `PrivateLink`, `SshTunnel`. `SshTunnel` is used as a value if this parameter is omitted in the request and any of the following parameter's values is specified: `tunnel_host`, `tunnel_port`, `tunnel_user`. Otherwise, `Directly` is used as a value if the parameter is omitted.
* - Service `ehr`: Possible values: `Directly`, `PrivateLink`, `SshTunnel`. `SshTunnel` is used as a value if this parameter is omitted in the request and any of the following parameter's values is specified: `tunnel_host`, `tunnel_port`, `tunnel_user`. Otherwise, `Directly` is used as a value if the parameter is omitted.
* - Service `elastic_cloud`: Possible values:`Directly`, `SshTunnel`. `SshTunnel` is used as a value if this parameter is omitted in the request and any of the following parameter's values is specified: `tunnel_host`, `tunnel_port`, `tunnel_user`. Otherwise, `Directly` is used as a value if the parameter is omitted.
* - Service `email`: Connection method. Default value: `Directly`.
* - Service `epic_clarity`: Possible values: `Directly`, `PrivateLink`, `SshTunnel`. `SshTunnel` is used as a value if this parameter is omitted in the request and any of the following parameter's values is specified: `tunnel_host`, `tunnel_port`, `tunnel_user`. Otherwise, `Directly` is used as a value if the parameter is omitted.
* - Service `es_self_hosted`: Possible values:`Directly`, `SshTunnel`. `SshTunnel` is used as a value if this parameter is omitted in the request and any of the following parameter's values is specified: `tunnel_host`, `tunnel_port`, `tunnel_user`. Otherwise, `Directly` is used as a value if the parameter is omitted.
* - Service `google_cloud_mysql`: Possible values:`Directly`, `PrivateLink`, `SshTunnel`. `SshTunnel` is used as a value if this parameter is omitted in the request and any of the following parameter's values is specified: `tunnel_host`, `tunnel_port`, `tunnel_user`. Otherwise, `Directly` is used as a value if the parameter is omitted.
* - Service `google_cloud_postgresql`: Possible values:`Directly`, `PrivateLink`, `SshTunnel`. `SshTunnel` is used as a value if this parameter is omitted in the request and any of the following parameter's values is specified: `tunnel_host`, `tunnel_port`, `tunnel_user`. Otherwise, `Directly` is used as a value if the parameter is omitted.
* - Service `google_cloud_sqlserver`: Possible values: `Directly`, `PrivateLink`, `SshTunnel`. `SshTunnel` is used as a value if this parameter is omitted in the request and any of the following parameter's values is specified: `tunnel_host`, `tunnel_port`, `tunnel_user`. Otherwise, `Directly` is used as a value if the parameter is omitted.
* - Service `hana_sap_hva_b1`: Possible values: `Directly`, `PrivateLink`, `SshTunnel`. `SshTunnel` is used as a value if this parameter is omitted in the request and any of the following parameter's values is specified: `tunnel_host`, `tunnel_port`, `tunnel_user`. Otherwise, `Directly` is used as a value if the parameter is omitted.
* - Service `hana_sap_hva_ecc`: Possible values: `Directly`, `PrivateLink`, `SshTunnel`. `SshTunnel` is used as a value if this parameter is omitted in the request and any of the following parameter's values is specified: `tunnel_host`, `tunnel_port`, `tunnel_user`. Otherwise, `Directly` is used as a value if the parameter is omitted.
* - Service `hana_sap_hva_ecc_netweaver`: Possible values: `Directly`, `PrivateLink`, `SshTunnel`. `SshTunnel` is used as a value if this parameter is omitted in the request and any of the following parameter's values is specified: `tunnel_host`, `tunnel_port`, `tunnel_user`. Otherwise, `Directly` is used as a value if the parameter is omitted.
* - Service `hana_sap_hva_s4`: Possible values: `Directly`, `PrivateLink`, `SshTunnel`. `SshTunnel` is used as a value if this parameter is omitted in the request and any of the following parameter's values is specified: `tunnel_host`, `tunnel_port`, `tunnel_user`. Otherwise, `Directly` is used as a value if the parameter is omitted.
* - Service `hana_sap_hva_s4_netweaver`: Possible values: `Directly`, `PrivateLink`, `SshTunnel`. `SshTunnel` is used as a value if this parameter is omitted in the request and any of the following parameter's values is specified: `tunnel_host`, `tunnel_port`, `tunnel_user`. Otherwise, `Directly` is used as a value if the parameter is omitted.
* - Service `heroku_postgres`: Possible values:`Directly`, `PrivateLink`, `SshTunnel`. `SshTunnel` is used as a value if this parameter is omitted in the request and any of the following parameter's values is specified: `tunnel_host`, `tunnel_port`, `tunnel_user`. Otherwise, `Directly` is used as a value if the parameter is omitted.
* - Service `kinesis`: Connection method. Default value: `Directly`.
* - Service `magento_mysql`: Possible values:`Directly`, `PrivateLink`, `SshTunnel`. `SshTunnel` is used as a value if this parameter is omitted in the request and any of the following parameter's values is specified: `tunnel_host`, `tunnel_port`, `tunnel_user`. Otherwise, `Directly` is used as a value if the parameter is omitted.
* - Service `magento_mysql_rds`: Possible values:`Directly`, `PrivateLink`, `SshTunnel`. `SshTunnel` is used as a value if this parameter is omitted in the request and any of the following parameter's values is specified: `tunnel_host`, `tunnel_port`, `tunnel_user`. Otherwise, `Directly` is used as a value if the parameter is omitted.
* - Service `maria`: Possible values:`Directly`, `PrivateLink`, `SshTunnel`. `SshTunnel` is used as a value if this parameter is omitted in the request and any of the following parameter's values is specified: `tunnel_host`, `tunnel_port`, `tunnel_user`. Otherwise, `Directly` is used as a value if the parameter is omitted.
* - Service `maria_azure`: Possible values:`Directly`, `PrivateLink`, `SshTunnel`. `SshTunnel` is used as a value if this parameter is omitted in the request and any of the following parameter's values is specified: `tunnel_host`, `tunnel_port`, `tunnel_user`. Otherwise, `Directly` is used as a value if the parameter is omitted.
* - Service `maria_rds`: Possible values:`Directly`, `PrivateLink`, `SshTunnel`. `SshTunnel` is used as a value if this parameter is omitted in the request and any of the following parameter's values is specified: `tunnel_host`, `tunnel_port`, `tunnel_user`. Otherwise, `Directly` is used as a value if the parameter is omitted.
* - Service `mongo`: Possible values:`Directly`, `PrivateLink`, `SshTunnel`. `SshTunnel` is used as a value if this parameter is omitted in the request and any of the following parameter's values is specified: `tunnel_host`, `tunnel_port`, `tunnel_user`. Otherwise, `Directly` is used as a value if the parameter is omitted.
* - Service `mongo_sharded`: Possible values:`Directly`, `PrivateLink`, `SshTunnel`. `SshTunnel` is used as a value if this parameter is omitted in the request and any of the following parameter's values is specified: `tunnel_host`, `tunnel_port`, `tunnel_user`. Otherwise, `Directly` is used as a value if the parameter is omitted.
* - Service `mysql`: Possible values:`Directly`, `PrivateLink`, `SshTunnel`. `SshTunnel` is used as a value if this parameter is omitted in the request and any of the following parameter's values is specified: `tunnel_host`, `tunnel_port`, `tunnel_user`. Otherwise, `Directly` is used as a value if the parameter is omitted.
* - Service `mysql_azure`: Possible values:`Directly`, `PrivateLink`, `SshTunnel`. `SshTunnel` is used as a value if this parameter is omitted in the request and any of the following parameter's values is specified: `tunnel_host`, `tunnel_port`, `tunnel_user`. Otherwise, `Directly` is used as a value if the parameter is omitted.
* - Service `mysql_rds`: Possible values:`Directly`, `PrivateLink`, `SshTunnel`. `SshTunnel` is used as a value if this parameter is omitted in the request and any of the following parameter's values is specified: `tunnel_host`, `tunnel_port`, `tunnel_user`. Otherwise, `Directly` is used as a value if the parameter is omitted.
* - Service `opendistro`: Possible values:`Directly`, `SshTunnel`. `SshTunnel` is used as a value if this parameter is omitted in the request and any of the following parameter's values is specified: `tunnel_host`, `tunnel_port`, `tunnel_user`. Otherwise, `Directly` is used as a value if the parameter is omitted.
* - Service `opensearch`: Possible values:`Directly`, `SshTunnel`. `SshTunnel` is used as a value if this parameter is omitted in the request and any of the following parameter's values is specified: `tunnel_host`, `tunnel_port`, `tunnel_user`. Otherwise, `Directly` is used as a value if the parameter is omitted.
* - Service `oracle`: Possible values:`Directly`, `PrivateLink`, `SshTunnel`. `SshTunnel` is used as a value if this parameter is omitted in the request and any of the following parameter's values is specified: `tunnel_host`, `tunnel_port`, `tunnel_user`. Otherwise, `Directly` is used as a value if the parameter is omitted.
* - Service `oracle_ebs`: Possible values:`Directly`, `PrivateLink`, `SshTunnel`. `SshTunnel` is used as a value if this parameter is omitted in the request and any of the following parameter's values is specified: `tunnel_host`, `tunnel_port`, `tunnel_user`. Otherwise, `Directly` is used as a value if the parameter is omitted.
* - Service `oracle_hva`: Possible values:`Directly`, `PrivateLink`, `SshTunnel`. `SshTunnel` is used as a value if this parameter is omitted in the request and any of the following parameter's values is specified: `tunnel_host`, `tunnel_port`, `tunnel_user`. Otherwise, `Directly` is used as a value if the parameter is omitted.
* - Service `oracle_rac`: Possible values:`Directly`, `PrivateLink`, `SshTunnel`. `SshTunnel` is used as a value if this parameter is omitted in the request and any of the following parameter's values is specified: `tunnel_host`, `tunnel_port`, `tunnel_user`. Otherwise, `Directly` is used as a value if the parameter is omitted.
* - Service `oracle_rds`: Possible values:`Directly`, `PrivateLink`, `SshTunnel`. `SshTunnel` is used as a value if this parameter is omitted in the request and any of the following parameter's values is specified: `tunnel_host`, `tunnel_port`, `tunnel_user`. Otherwise, `Directly` is used as a value if the parameter is omitted.
* - Service `oracle_sap_hva`: Possible values: `Directly`, `PrivateLink`, `SshTunnel`. `SshTunnel` is used as a value if this parameter is omitted in the request and any of the following parameter's values is specified: `tunnel_host`, `tunnel_port`, `tunnel_user`. Otherwise, `Directly` is used as a value if the parameter is omitted.
* - Service `oracle_sap_hva_netweaver`: Possible values: `Directly`, `PrivateLink`, `SshTunnel`. `SshTunnel` is used as a value if this parameter is omitted in the request and any of the following parameter's values is specified: `tunnel_host`, `tunnel_port`, `tunnel_user`. Otherwise, `Directly` is used as a value if the parameter is omitted.
* - Service `postgres`: Possible values:`Directly`, `PrivateLink`, `SshTunnel`. `SshTunnel` is used as a value if this parameter is omitted in the request and any of the following parameter's values is specified: `tunnel_host`, `tunnel_port`, `tunnel_user`. Otherwise, `Directly` is used as a value if the parameter is omitted.
* - Service `postgres_rds`: Possible values:`Directly`, `PrivateLink`, `SshTunnel`. `SshTunnel` is used as a value if this parameter is omitted in the request and any of the following parameter's values is specified: `tunnel_host`, `tunnel_port`, `tunnel_user`. Otherwise, `Directly` is used as a value if the parameter is omitted.
* - Service `redshift_db`: Directly or Private Link
* - Service `s3`: Connection method. Default value: `Directly`.
* - Service `sap_hana`: Possible values:`Directly`, `PrivateLink`, `SshTunnel`. `SshTunnel` is used as a value if this parameter is omitted in the request and any of the following parameter's values is specified: `tunnel_host`, `tunnel_port`, `tunnel_user`. Otherwise, `Directly` is used as a value if the parameter is omitted.
* - Service `sap_s4hana`: Connection Method
* - Service `snowflake_db`: Directly or Private Link
* - Service `sql_server`: Possible values: `Directly`, `PrivateLink`, `SshTunnel`. `SshTunnel` is used as a value if this parameter is omitted in the request and any of the following parameter's values is specified: `tunnel_host`, `tunnel_port`, `tunnel_user`. Otherwise, `Directly` is used as a value if the parameter is omitted.
* - Service `sql_server_hva`: Possible values: `Directly`, `PrivateLink`, `SshTunnel`. `SshTunnel` is used as a value if this parameter is omitted in the request and any of the following parameter's values is specified: `tunnel_host`, `tunnel_port`, `tunnel_user`. Otherwise, `Directly` is used as a value if the parameter is omitted.
* - Service `sql_server_rds`: Possible values: `Directly`, `PrivateLink`, `SshTunnel`. `SshTunnel` is used as a value if this parameter is omitted in the request and any of the following parameter's values is specified: `tunnel_host`, `tunnel_port`, `tunnel_user`. Otherwise, `Directly` is used as a value if the parameter is omitted.
* - Service `sql_server_sap_ecc_hva`: Possible values: `Directly`, `PrivateLink`, `SshTunnel`. `SshTunnel` is used as a value if this parameter is omitted in the request and any of the following parameter's values is specified: `tunnel_host`, `tunnel_port`, `tunnel_user`. Otherwise, `Directly` is used as a value if the parameter is omitted.
*/
connectionType: string;
/**
* Field usage depends on `service` value:
* - Service `prisma_cloud`: Your Prisma Cloud console URL.
*/
consoleUrl?: string;
/**
* Field usage depends on `service` value:
* - Service `apache_kafka`: Kafka consumer group name.
* - Service `aws_msk`: The name of consumer group created for Fivetran.
* - Service `azure_event_hub`: Name of consumer group created for Fivetran.
* - Service `confluent_cloud`: Confluent Cloud consumer group name.
* - Service `heroku_kafka`: Heroku Kafka consumer group name.
*/
consumerGroup: string;
/**
* Field usage depends on `service` value:
* - Service `netsuite_suiteanalytics`: Consumer Key
* - Service `odoo`: Your Odoo consumer key.
* - Service `twitter`: API Key of your app
* - Service `twitter_ads`: The Twitter App consumer key.
* - Service `woocommerce`: Your WooCommerce Consumer key.
*/
consumerKey: string;
/**
* Field usage depends on `service` value:
* - Service `xactly`: Your Xactly Connect consumer name.
*/
consumerName?: string;
/**
* Field usage depends on `service` value:
* - Service `netsuite_suiteanalytics`: Consumer Secret
* - Service `odoo`: Your Odoo consumer secret.
* - Service `twitter`: API Secret of your app
* - Service `twitter_ads`: The Twitter App consumer secret.
* - Service `woocommerce`: Your WooCommerce Consumer secret.
*/
consumerSecret: string;
/**
* Field usage depends on `service` value:
* - Service `azure_blob_storage`: IP address of the Azure Storage Container which is accessible from host machine.
*/
containerAddress?: string;
/**
* Field usage depends on `service` value:
* - Service `azure_blob_storage`: The name of the blob container.
* - Service `microsoft_dynamics_365_fno`: The name of the blob container.
* - Service `microsoft_dynamics_365_fo`: The name of the blob container.
* - Service `sql_server`: The name of the Azure Blob Storage container.
*/
containerName: string;
/**
* Field usage depends on `service` value:
* - Service `youtube_analytics`: Used only for Content Owner reports. The ID of the content owner for whom the API request is being made.
*/
contentOwnerId?: string;
/**
* Field usage depends on `service` value:
* - Service `acumatica`: Your Acumatica contract version.
*/
contractVersion?: string;
/**
* Field usage depends on `service` value:
* - Service `helpscout`: Your conversation webhook URL
*/
conversationWebhookUrl?: string;
/**
* Field usage depends on `service` value:
* - Service `double_click_campaign_manager`: Conversion Dimensions.
*/
conversionDimensions?: string[];
/**
* Field usage depends on `service` value:
* - Service `pinterest_ads`: The date that the user interacted with the ad OR completed a conversion event.
*/
conversionReportTime: string;
/**
* Field usage depends on `service` value:
* - Service `google_ads`: A period of time in days during which a conversion is recorded.
*/
conversionWindowSize: number;
convertDatsTypeToDate: boolean;
/**
* Field usage depends on `service` value:
* - Service `sistrix`: Your SISTRIX country code.
*/
country: string;
/**
* Field usage depends on `service` value:
* - Service `adjust`: CSV definition for the CSV export (https://help.adjust.com/en/article/csv-uploads#how-do-i-format-my-csv-definition).
*/
csvDefinition: string;
/**
* Field usage depends on `service` value:
* - Service `criteo`: Currency
* - Service `rokt`: Your Rokt currency.
*/
currency?: string;
/**
* Field usage depends on `service` value:
* - Service `coalesce`: Your Coalesce custom base URL.
* - Service `datadog`: Your Datadog custom base url.
* - Service `deposco`: Your Deposco custom base URL.
* - Service `gitlab`: Your GitLab custom base URL.
*/
customBaseUrl?: string;
/**
* Field usage depends on `service` value:
* - Service `double_click_publishers`: The list of custom dimension key IDs included in the report. Custom dimension keys can only be selected with the CUSTOM_DIMENSION dimension.
*/
customDimensionKeyIds?: string[];
/**
* Field usage depends on `service` value:
* - Service `iterable`: Custom Events Sync Mode.
*/
customEventSyncMode?: string;
/**
* Field usage depends on `service` value:
* - Service `iterable`: List of custom events to sync. Should be specified when `custom_event_sync_mode` is `SelectedEvents`
*/
customEvents?: string[];
/**
* Field usage depends on `service` value:
* - Service `double_click_publishers`: The list of custom field IDs included in the report. Custom fields can only be selected with their corresponding dimensions.
*/
customFieldIds?: string[];
/**
* Field usage depends on `service` value:
* - Service `double_click_campaign_manager`: Custom Floodlight variables enable you to capture information beyond the basics (visits and revenue) that you can collect with standard parameters in your tags.
*/
customFloodlightVariables?: string[];
customPayloads?: outputs.ConnectorConfigCustomPayload[];
/**
* Field usage depends on `service` value:
* - Service `toggl_track`: Your Toggl Track custom rate limit. Supports only numeric characters (0-9).
*/
customRateLimit?: string;
/**
* Field usage depends on `service` value:
* - Service `learnupon`: Your LearnUpon custom region.
*/
customRegion?: string;
customReports?: outputs.ConnectorConfigCustomReport[];
customTables?: outputs.ConnectorConfigCustomTable[];
/**
* Field usage depends on `service` value:
* - Service `dbt_cloud`: Your dbt Cloud access url.
* - Service `factbird`: Your Factbird custom base url.
* - Service `jotform`: Your Jotform custom base URL.
*/
customUrl?: string;
/**
* Field usage depends on `service` value:
* - Service `ukg_pro`: Your UKG Pro Customer API key.
*/
customerApiKey?: string;
/**
* Field usage depends on `service` value:
* - Service `google_ads`: ID of the customer, can be retrieved from your AdWords dashboard.
*/
customerId: string;
/**
* Field usage depends on `service` value:
* - Service `salesforce_commerce_cloud`: The parameter to retrieve customer details.
*/
customerListId: string;
dailyApiCallLimit: number;
/**
* Field usage depends on `service` value:
* - Service `cosmos`: The source data access method. Supported values:`ACCOUNT_KEY`- Data access method that uses account keys to authenticate to the source database. It comes in both read-write and read-only variants.`RESOURCE_TOKEN`- Fine-grained permission model based on native Azure Cosmos DB users and permissions. Learn more in our [Azure Cosmos DB Data Access Methods documentation](https://fivetran.com/docs/connectors/databases/cosmos#dataaccessmethods).
*/
dataAccessMethod: string;
/**
* Field usage depends on `service` value:
* - Service `brightpearl`: Your Brightpearl data center.
* - Service `qualtrics`: Data center ID of the Qualtrics account. Can be found in the URL before `qualtrics.com`. (For example, if your URL is `youraccount.ca1.qualtrics.com`, then the data center is `ca1`.)
* - Service `zoho_crm`: Data Center, depending on the Domain name
*/
dataCenter: string;
/**
* Field usage depends on `service` value:
* - Service `zonka_feedback`: Your Zonka Feedback data center ID.
*/
dataCenterId: string;
dataModelPathAliasLists?: outputs.ConnectorConfigDataModelPathAliasList[];
/**
* Field usage depends on `service` value:
* - Service `intercom`: The Intercom region for your app. Options - empty string (US/default), 'eu' (Europe), 'au' (Australia). Based on your Intercom app URL (app.intercom.io for US, app.eu.intercom.io for EU, app.au.intercom.io for AU). Cannot be changed after initial connection creation.
*/
dataRegion: string;
/**
* Field usage depends on `service` value:
* - Service `bigquery_db`: Data set name
*/
dataSetName?: string;
/**
* Field usage depends on `service` value:
* - Service `aurora`: The database name.
* - Service `aurora_postgres`: The database name.
* - Service `azure_cosmos_for_mongo`: Authentication database for the source. Usually 'admin'.
* - Service `azure_postgres`: The database name.
* - Service `azure_sql_db`: The database name.
* - Service `azure_sql_managed_db`: The database name.
* - Service `clarity`: The database name.
* - Service `cockroachdb`: The database name.
* - Service `db2i_hva`: The database name.
* - Service `db2i_sap_hva`: The database name.
* - Service `db2luw`: The database name.
* - Service `db2z`: The database name.
* - Service `dynamics_365_fo`: The database name.
* - Service `ehr`: The database name.
* - Service `epic_clarity`: The database name.
* - Service `google_cloud_mysql`: The database name.
* - Service `google_cloud_postgresql`: The database name.
* - Service `google_cloud_sqlserver`: The database name.
* - Service `hana_sap_hva_b1`: The Hana database name.
* - Service `hana_sap_hva_ecc`: The Hana database name.
* - Service `hana_sap_hva_ecc_netweaver`: The Hana database name.
* - Service `hana_sap_hva_s4`: The Hana database name.
* - Service `hana_sap_hva_s4_netweaver`: The Hana database name.
* - Service `heroku_postgres`: The database name.
* - Service `magento_mysql`: The database name.
* - Service `magento_mysql_rds`: The database name.
* - Service `maria`: The database name.
* - Service `maria_azure`: The database name.
* - Service `maria_rds`: The database name.
* - Service `mysql`: The database name.
* - Service `mysql_azure`: The database name.
* - Service `mysql_rds`: The database name.
* - Service `oracle`: The database name.
* - Service `oracle_ebs`: The database name.
* - Service `oracle_hva`: The database name.
* - Service `oracle_rac`: The database name.
* - Service `oracle_rds`: The database name.
* - Service `oracle_sap_hva`: The database name.
* - Service `postgres`: The database name.
* - Service `postgres_rds`: The database name.
* - Service `redshift_db`: The database name: Redshift
* - Service `sap_hana`: The database name.
* - Service `sap_s4hana`: The database name.
* - Service `snowflake_db`: The database name: Snowflake
* - Service `sql_server`: The database name.
* - Service `sql_server_hva`: The database name.
* - Service `sql_server_rds`: The database name.
* - Service `sql_server_sap_ecc_hva`: The database name.
*/
database: string;
/**
* Field usage depends on `service` value:
* - Service `firebase`: Database Name
*/
databaseName?: string;
/**
* Field usage depends on `service` value:
* - Service `google_analytics_360`: The dataset ID.
* - Service `google_analytics_4_export`: The Dataset ID.
*/
datasetId: string;
/**
* Field usage depends on `service` value:
* - Service `netsuite_suiteanalytics`: The NetSuite data source value: `NetSuite.com`.
*/
datasource: string;
/**
* Field usage depends on `service` value:
* - Service `adobe_analytics`: The aggregation duration you want. Default value: `HOUR` .
*/
dateGranularity: string;
/**
* Field usage depends on `service` value:
* - Service `myosh`: Your Myosh Server variables/db .
*/
db?: string;
/**
* Field usage depends on `service` value:
* - Service `discourse`: Your Discourse default host.
*/
defaultHost?: string;
/**
* Field usage depends on `service` value:
* - Service `aws_cost_report`: Optional. You can specify your the delimiter that your CSVs use here. Fivetran generally tries to infer the delimiter, but in some cases this is impossible. If your files sync with the wrong number of columns, consider setting this value
* - Service `azure_blob_storage`: You can specify your the delimiter that your CSVs use here. Fivetran generally tries to infer the delimiter, but in some cases this is impossible.
* - Service `box`: You can specify the delimiter that your CSVs use here. Fivetran generally tries to infer the delimiter, but in some cases this is impossible.
* - Service `dropbox`: You can specify the delimiter that your CSVs use here. Fivetran generally tries to infer the delimiter, but in some cases this is impossible.
* - Service `email`: You can specify your the delimiter that your CSVs use here. Fivetran generally tries to infer the delimiter, but in some cases this is impossible.
* - Service `ftp`: You can specify your the delimiter that your CSVs use here. Fivetran generally tries to infer the delimiter, but in some cases this is impossible.
* - Service `gcs`: You can specify your the delimiter that your CSVs use here. Fivetran generally tries to infer the delimiter, but in some cases this is impossible.
* - Service `google_drive`: You can specify the delimiter that your CSVs use here. Fivetran generally tries to infer the delimiter, but in some cases this is impossible.
* - Service `kinesis`: Optional. You can specify your the delimiter that your CSVs use here. Fivetran generally tries to infer the delimiter, but in some cases this is impossible. If your files sync with the wrong number of columns, consider setting this value
* - Service `s3`: You can specify the delimiter that your CSVs use here. Fivetran generally tries to infer the delimiter, but in some cases this is impossible.
* - Service `s3_compatible_storage`: You can specify the delimiter that your CSVs use here. Fivetran generally tries to infer the delimiter, but in some cases this is impossible.
* - Service `sftp`: You can specify your the delimiter that your CSVs use here. Fivetran generally tries to infer the delimiter, but in some cases this is impossible.
* - Service `share_point`: You can specify the delimiter that your CSVs use here. Fivetran generally tries to infer the delimiter, but in some cases this is impossible.
* - Service `wasabi_cloud_storage`: You can specify the delimiter that your CSVs use here. Fivetran generally tries to infer the delimiter, but in some cases this is impossible.
*/
delimiter: string;
/**
* Field usage depends on `service` value:
* - Service `brightpearl`: Your Brightpearl dev reference.
*/
developerReference?: string;
/**
* Field usage depends on `service` value:
* - Service `double_click_publishers`: Dimension attributes provide additional fields associated with a Dimension. Dimension attributes can only be selected with their corresponding Dimensions.
*/
dimensionAttributes?: string[];
/**
* Field usage depends on `service` value:
* - Service `adroll`: The dimenstions that you want to sync.
* - Service `double_click_campaign_manager`: Report dimensions to include into a sync. The `date` dimension is mandatory for all the report types. The `advertiser` dimension is mandatory for `REACH` report type
* - Service `double_click_publishers`: Report dimensions to include in the sync. The `date` dimension is mandatory for all the report types.
* - Service `google_analytics`: The report dimensions to include into a sync. The `date` dimension is mandatory for all the report types.
* - Service `google_display_and_video_360`: The report dimensions (filters) to include into a sync. The dimension names are provided in the API format. This is a required parameter when `config_method` is set to `CREATE_NEW`.
*/
dimensions?: string[];
/**
* Field usage depends on `service` value:
* - Service `oracle_hva`: Possible values:`DIRECT`, `BFILE`, `ASM`, `ARCHIVE_ONLY`
* - Service `oracle_sap_hva`: Possible values:`DIRECT`, `BFILE`, `ASM`, `ARCHIVE_ONLY`
*/
directCaptureMethod: string;
/**
* Field usage depends on `service` value:
* - Service `qualtrics`: Set of directories to be synced when syncMode is CUSTOM
*/
directories?: string[];
/**
* Field usage depends on `service` value:
* - Service `qualtrics`: Sync mode to be used for fetching select directories. The Allowed Values are ALL and CUSTOM. If CUSTOM add the directories to be synced in the `directories` field.
*/
directorySyncMode: string;
/**
* Field usage depends on `service` value:
* - Service `cosmos`: Specifies the total number of connectors in the Distributed Connector Cluster running in parallel.
* - Service `dynamodb`: Specifies the total number of connectors in the Distributed Connector Cluster running in parallel.
*/
distributedConnectorClusterSize: number;
/**
* Field usage depends on `service` value:
* - Service `qualtrics`: Can be used to set the distributions fetch window for incremental sync. Fetch window cannot be lesser than 60 days.
*/
distributionIncrementalFetchWindowDays: number;
/**
* Field usage depends on `service` value:
* - Service `adobe_experience_platform`: Your Adobe Experience Platform environment.
* - Service `auth0`: Your Auth0 domain.
* - Service `bubble`: Your Bubble app name or domain name.
* - Service `confluence`: Your Confluence domain.
* - Service `kustomer`: Domain is the beginning of your kustomer URL going before .kustomerapp.com, e.g. for yourcompany.kustomerapp.com the domain name is yourcompany
* - Service `okta`: Your Okta domain.
* - Service `pipedrive`: Your Pipedrive domain.
* - Service `shopware`: Your Shopware domain.
* - Service `sistrix`: Your SISTRIX domain.
* - Service `solarwinds_service_desk`: Your SolarWinds Service Desk domain.
* - Service `uservoice`: Domain of your UserVoice site. If it ends with ".uservoice.com", you can specify just the subdomain ("mydomain.uservoice.com" - "mydomain")
* - Service `zendesk`: Zendesk domain.
* - Service `zendesk_sunshine`: Zendesk domain.
*/
domain: string;
/**
* Field usage depends on `service` value:
* - Service `workday`: Workday host name.
* - Service `workday_financial_management`: Workday host name.
* - Service `workday_hcm`: Workday host name.
*/
domainHostName: string;
/**
* Field usage depends on `service` value:
* - Service `calabrio`: Your Calabrio domain name
* - Service `dynamics_365`: The custom domain name associated with Dynamics 365.
* - Service `helpshift`: Your Helpshift domain name.
*/
domainName: string;
/**
* Field usage depends on `service` value:
* - Service `lightspeed_retail_xseries`: Your Lightspeed Retail X-Series store domain prefix.
*/
domainPrefix?: string;
/**
* Field usage depends on `service` value:
* - Service `medallia`: Domain type of your Medallia URL
*/
domainType: string;
/**
* Field usage depends on `service` value:
* - Service `dsv`: Your DSV Password.
*/
dsvPassword?: string;
dsvServiceAuth?: string;
dsvSubscriptionKey?: string;
/**
* Field usage depends on `service` value:
* - Service `dsv`: Your DSV Username
*/
dsvUsername?: string;
/**
* Field usage depends on `service` value:
* - Service `mailchimp`: List of IDs of the Mailchimp E-Commerce Stores to Sync
*/
ecommerceStores?: string[];
/**
* Field usage depends on `service` value:
* - Service `bigin_by_zoho_crm`: Your Bigin by Zoho CRM pricing plan
*/
edition: string;
/**
* Field usage depends on `service` value:
* - Service `oracle_fusion_cloud_apps_crm`: Select this option to extract all historical records without applying a date filter. Console allows setting this option for all datastores in the connector.
* - Service `oracle_fusion_cloud_apps_fscm`: Select this option to extract all historical records without applying a date filter. Console allows setting this option for all datastores in the connector.
* - Service `oracle_fusion_cloud_apps_hcm`: Select this option to extract all historical records without applying a date filter. Console allows setting this option for all datastores in the connector.
*/
effectiveDateDisabled: boolean;
/**
* Field usage depends on `service` value:
* - Service `sql_server`: The list of Azure Key Vault key identifiers used for TDE. Each identifier should be in the format `https://vault-name.vault.azure.net/keys/key-name` or `https://vault-name.vault.azure.net/keys/key-name/version`.
*/
ekmKeyIdentifiers?: string[];
elements?: string[];
/**
* Field usage depends on `service` value:
* - Service `appcues`: Your Appcues Email.
* - Service `asset_panda`: Your Asset Panda email.
* - Service `boostr`: Your Boostr email.
* - Service `consensus_demo_automation_platform`: The email address of the Consensus Demo Automation Platform account you want Fivetran to use to access your data.
* - Service `copper`: Your Copper email address.
* - Service `email`: Send your emails to this address.
* - Service `moloco`: Your Moloco account email.
* - Service `netsuite_suiteanalytics`: The NetSuite user's email address.
* - Service `pardot`: The email of the Pardot user.
* - Service `pardot_sandbox`: The email of the Pardot user.
* - Service `skuvault`: Your SkuVault email.
* - Service `smadex`: Your Smadex account's email ID.
* - Service `zendesk`: Zendesk email.
* - Service `zendesk_sunshine`: Zendesk email.
*/
email: string;
/**
* Field usage depends on `service` value:
* - Service `clockodo`: Your Clockodo email address.
*/
emailAddress?: string;
/**
* Field usage depends on `service` value:
* - Service `cabcharge`: Your Cabcharge email ID.
* - Service `ordway`: Your Ordway user email ID.
* - Service `planful`: Your Planful email ID.
* - Service `zendesk_workforce_management`: Email ID associated with the Zendesk Workforce Management account you want Fivetran to use to access your data.
*/
emailId?: string;
/**
* Field usage depends on `service` value:
* - Service `aws_cost_report`: Optional. If your CSV generating software doesn't provide header line for the documents, Fivetran can generate the generic column names and sync data rows with them.
* - Service `azure_blob_storage`: Optional. If your CSV generating software doesn't provide header line for the documents, Fivetran can generate the generic column names and sync data rows with them.
* - Service `box`: Optional. If your CSV generating software doesn't provide header line for the documents, Fivetran can generate the generic column names and sync data rows with them.
* - Service `dropbox`: Optional. If your CSV generating software doesn't provide header line for the documents, Fivetran can generate the generic column names and sync data rows with them.
* - Service `email`: Optional. If your CSV generating software doesn't provide header line for the documents, Fivetran can generate the generic column names and sync data rows with them.
* - Service `ftp`: Optional. If your CSV generating software doesn't provide header line for the documents, Fivetran can generate the generic column names and sync data rows with them.
* - Service `gcs`: Optional. If your CSV generating software doesn't provide header line for the documents, Fivetran can generate the generic column names and sync data rows with them.
* - Service `google_drive`: Optional. If your CSV generating software doesn't provide header line for the documents, Fivetran can generate the generic column names and sync data rows with them.
* - Service `kinesis`: Optional. If your CSV generating software doesn't provide header line for the documents, Fivetran can generate the generic column names and sync data rows with them.
* - Service `s3`: If your CSVs are headerless, set this is as `true`. When `true`, we will generate generic column names following the convention of `column_0`, `column_1`, ... `column_n` to map the rows. Default value: `false`.
* - Service `s3_compatible_storage`: If your CSVs are headerless, set this is as `true`. When `true`, we will generate generic column names following the convention of `column_0`, `column_1`, ... `column_n` to map the rows. Default value: `false`.
* - Service `sftp`: Optional. If your CSV generating software doesn't provide header line for the documents, Fivetran can generate the generic column names and sync data rows with them.
* - Service `share_point`: Optional. If your CSV generating software doesn't provide header line for the documents, Fivetran can generate the generic column names and sync data rows with them.
* - Service `wasabi_cloud_storage`: If your CSVs are headerless, set this is as `true`. When `true`, we will generate generic column names following the convention of `column_0`, `column_1`, ... `column_n` to map the rows. Default value: `false`.
*/
emptyHeader: boolean;
/**
* Field usage depends on `service` value:
* - Service `double_click_campaign_manager`: Whether to enable all reach dimension combinations in the report. Default value: `false`
*/
enableAllDimensionCombinations: boolean;
/**
* Field usage depends on `service` value:
* - Service `oracle_hva`: Default value: `false`. Set to `true` if you're using archive log only mode.
* - Service `oracle_sap_hva`: Default value: `false`. Set to `true` if you're using archive log only mode.
* - Service `oracle_sap_hva_netweaver`: Default value: `false`. Set to `true` if you're using archive log only mode.
* - Service `sql_server_hva`: Use archive log only mode
* - Service `sql_server_sap_ecc_hva`: Use archive log only mode
*/
enableArchiveLogOnly: boolean;
enableDataExtensionsSyncing: boolean;
/**
* Field usage depends on `service` value:
* - Service `cosmos`: Enable to allow the connector to join a cluster of connectors forming a Distributed Connector Cluster. This cluster allows parallel syncs from the same source to the same destination using multiple connectors.
* - Service `dynamodb`: Enable to allow the connector to join a cluster of connectors forming a Distributed Connector Cluster. This cluster allows parallel syncs from the same source to the same destination using multiple connectors.
*/
enableDistributedConnectorMode: boolean;
/**
* Field usage depends on `service` value:
* - Service `snowplow`: Enable Enrichments
*/
enableEnrichments: boolean;
/**
* Field usage depends on `service` value:
* - Service `braze`: Enable User Profile Exports
*/
enableExports: boolean;
/**
* Field usage depends on `service` value:
* - Service `gitlab`: The confirmation that you have allowed Fivetran to connect with your self-hosted instance. Possible values: `true`, `false`.
*/
enableMtlsConnection?: string;
/**
* Field usage depends on `service` value:
* - Service `sql_server`: Use transparent data encryption (TDE)
* - Service `sql_server_hva`: Using Transparent Data Encryption (TDE)
* - Service `sql_server_sap_ecc_hva`: Using Transparent Data Encryption (TDE)
*/
enableTde: boolean;
/**
* Field usage depends on `service` value:
* - Service `oracle_hva`: Default value: `false`. Set to `true` if you're using TDE encryption.
* - Service `oracle_sap_hva`: Default value: `false`. Set to `true` if you're using TDE encryption.
* - Service `oracle_sap_hva_netweaver`: Default value: `false`. Set to `true` if you're using TDE encryption.
*/
enableTdeEncryption: boolean;
/**
* Field usage depends on `service` value:
* - Service `apple_search_ads`: Use the public key to grant Fivetran access to Apple Search Ads api.
*/
encodedPublicKey?: string;
/**
* Field usage depends on `service` value:
* - Service `marketo`: Marketo SOAP API Encryption Key (Discontinued).
*/
encryptionKey: string;
/**
* Field usage depends on `service` value:
* - Service `branch`: Webhook Endpoint
* - Service `iterable`: Register the following URL for webhooks on your Iterable dashboard.
* - Service `marketo`: Marketo REST API endpoint.
* - Service `snowplow`: Connection-specific collector endpoint. The collector endpoint will have the `webhooks.fivetran.com/snowplow/endpoint_ID` format. You will need it to configure Snowplow to connect with Fivetran.
* - Service `webhooks`: You can send your events to https://webhooks.fivetran.com/webhooks/{endpoint}
*/
endpoint: string;
/**
* Field usage depends on `service` value:
* - Service `s3_compatible_storage`: S3-Compatible Storage Endpoint URL.
*/
endpointUrl?: string;
/**
* Field usage depends on `service` value:
* - Service `pinterest_ads`: The number of days to use as the conversion attribution window for an engagement (i.e. closeup or save) action.
*/
engagementAttributionWindow: string;
/**
* Field usage depends on `service` value:
* - Service `db2z`: Determines whether the Enhanced PassTicket is sent in mixed case or uppercase before authentication. Specify only when `authentication_method` is `ENHANCED_PASS_TICKET`. Supported values:`UPPER`- The generated PassTicket consist of uppercase alphanumeric characters.`MIXED`- The generated PassTicket consists of mixed-case alphanumeric characters and may include '-' and '_'.
*/
enhancedPassTicketType: string;
/**
* Field usage depends on `service` value:
* - Service `optimizely`: Enriched Events S3 bucket
*/
enrichedExport?: string;
/**
* Field usage depends on `service` value:
* - Service `checkout`: Your Checkout.com entity ID.
* - Service `zuora`: If `is_multi_entity_feature_enabled` is `true`, then it's `EntityId`.
* - Service `zuora_sandbox`: If `is_multi_entity_feature_enabled` is `true`, then it's `EntityId`.
*/
entityId: string;
/**
* Field usage depends on `service` value:
* - Service `aurora_postgres`: Registered Application ID (for Entra ID authentication).
* - Service `azure_postgres`: Registered Application ID (for Entra ID authentication).
* - Service `google_cloud_postgresql`: Registered Application ID (for Entra ID authentication).
* - Service `heroku_postgres`: Registered Application ID (for Entra ID authentication).
* - Service `postgres`: Registered Application ID (for Entra ID authentication).
* - Service `postgres_rds`: Registered Application ID (for Entra ID authentication).
*/
entraAppId?: string;
/**
* Field usage depends on `service` value:
* - Service `aurora_postgres`: Azure Tenant ID (for Entra ID authentication).
* - Service `azure_postgres`: Azure Tenant ID (for Entra ID authentication).
* - Service `google_cloud_postgresql`: Azure Tenant ID (for Entra ID authentication).
* - Service `heroku_postgres`: Azure Tenant ID (for Entra ID authentication).
* - Service `postgres`: Azure Tenant ID (for Entra ID authentication).
* - Service `postgres_rds`: Azure Tenant ID (for Entra ID authentication).
*/
entraTenantId?: string;
/**
* Field usage depends on `service` value:
* - Service `bazaarvoice`: Your Bazaarvoice environment.
* - Service `buildium`: Your Buildium environment.
* - Service `checkout`: Your Checkout.com environment.
* - Service `concord`: Your Concord environment.
* - Service `deposco`: Your Deposco environment.
* - Service `dialpad`: Your Dialpad environment.
* - Service `dsv`: Your API Development Environment.
* - Service `healthie`: Your Healthie environment.
* - Service `invoiced`: Your Invoiced environment.
* - Service `jibble`: Your Jibble environment.
* - Service `lucca`: Your Lucca environment.
* - Service `oracle_netsuite_openair`: Your NetSuite SuiteProjects Pro environment.
* - Service `ordergroove`: Your Ordergroove environment.
* - Service `paddle`: Your Paddle environment.
* - Service `procore`: Your Procore account environment.
* - Service `reltio`: Your Reltio environment.
* - Service `servicetitan`: Your ServiceTitan environment.
* - Service `smarthr`: Your SmartHR environment.
* - Service `stackadapt_graphql`: Your StackAdapt environment.
* - Service `trelica`: Your Trelica environment.
* - Service `tremendous`: Your Tremendous environment.
* - Service `vts`: Your VTS environment.
* - Service `xactly`: Your Xactly environment.
* - Service `younium`: Your Younium API environment.
* - Service `zip`: Your Zip environment.
* - Service `zuora`: Zuora Sandbox Environment. This accepts either of the two values Sandbox or Central Sandbox based on your subscription. The default environment is Sandbox.
* - Service `zuora_sandbox`: Zuora Sandbox Environment. This accepts either of the two values Sandbox or Central Sandbox based on your subscription. The default environment is Sandbox.
*/
environment: string;
/**
* Field usage depends on `service` value:
* - Service `xactly`: Your Xactly environment host.
*/
environmentHost?: string;
/**
* Field usage depends on `service` value:
* - Service `business_central`: Name of the environment
*/
environmentName?: string;
/**
* Field usage depends on `service` value:
* - Service `aws_cost_report`: Optional. If your CSV generator follows non-standard rules for escaping quotation marks, you can set the escape character here.
* - Service `azure_blob_storage`: If your CSV generator follows non-standard rules for escaping quotation marks, you can set the escape character here.
* - Service `box`: If your CSV generator follows non-standard rules for escaping quotation marks, you can set the escape character here.
* - Service `dropbox`: If your CSV generator follows non-standard rules for escaping quotation marks, you can set the escape character here.
* - Service `email`: If your CSV generator follows non-standard rules for escaping quotation marks, you can set the escape character here.
* - Service `ftp`: If your CSV generator follows non-standard rules for escaping quotation marks, you can set the escape character here.
* - Service `gcs`: If your CSV generator follows non-standard rules for escaping quotation marks, you can set the escape character here.
* - Service `google_drive`: If your CSV generator follows non-standard rules for escaping quotation marks, you can set the escape character here.
* - Service `kinesis`: Optional. If your CSV generator follows non-standard rules for escaping quotation marks, you can set the escape character here.
* - Service `s3`: If your CSV generator follows non-standard rules for escaping quotation marks, you can set the escape character here.
* - Service `s3_compatible_storage`: If your CSV generator follows non-standard rules for escaping quotation marks, you can set the escape character here.
* - Service `sftp`: If your CSV generator follows non-standard rules for escaping quotation marks, you can set the escape character here.
* - Service `share_point`: If your CSV generator follows non-standard rules for escaping quotation marks, you can set the escape character here.
* - Service `wasabi_cloud_storage`: If your CSV generator follows non-standard rules for escaping quotation marks, you can set the escape character here.
*/
escapeChar: string;
/**
* Field usage depends on `service` value:
* - Service `gcs`: Approach used by CSV parser. Default value: `CUSTOM_ESCAPE_CHAR`. required for CSV parsing when `non_standard_escape_char` is `true`.
* - Service `s3`: Approach used by CSV parser. Default value: `CUSTOM_ESCAPE_CHAR`. required for CSV parsing when `non_standard_escape_char` is `true`.
*/
escapeCharOptions: string;
/**
* Field usage depends on `service` value:
* - Service `kustomer`: Turn it on if your app is on EU region
* - Service `survey_monkey`: The SurveyMonkey account region. Specify `true`, if your account is hosted in the EU region. Default value is `false`.
*/
euRegion: boolean;
/**
* Field usage depends on `service` value:
* - Service `iterable`: List of events to sync. Should be specified when `sync_mode` is `SelectedEvents`
*/
events?: string[];
/**
* Field usage depends on `service` value:
* - Service `google_drive`: Optional. Set to true to export your Google Docs and Slides as PDF documents. By default, we export Google Docs and Slides as .docx and .pptx files, respectively.
*/
exportNativeTypesAsPdf: boolean;
/**
* Field usage depends on `service` value:
* - Service `adjust`: Your cloud storage.
* - Service `amplitude`: Your cloud storage type
* - Service `braze`: Export Storage. Required if `enable_exports` is `true`
* - Service `pendo`: Denotes which storage option is chosen
*/
exportStorageType: string;
/**
* Field usage depends on `service` value:
* - Service `appsflyer`: The external ID is a string that designates who can assume the role. For more information, click a href="http://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_create_for-user_externalid.html"here/a
* - Service `aws_cloudtrail`: This is the same as your `group_id`, used for authentication along with the `role_arn`.
* - Service `aws_cost_report`: The external ID is a string that designates who can assume the role. For more information, click a href="http://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_create_for-user_externalid.html"here/a
* - Service `aws_lambda`: The external ID is a string that designates who can assume the role.
* - Service `aws_msk`: This is the same as your `group_id`. This is required when `sasl_mechanism` is set to `IAM`.
* - Service `azure_function`: External ID.
* - Service `cloudfront`: This is the same as your `group_id`, used for authentication along with the `role_arn`.
* - Service `dynamodb`: This is the same as your `group_id`, used for authentication along with the `role_arn`.
* - Service `kinesis`: The external ID is a string that designates who can assume the role. For more information, click a href="http://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_create_for-user_externalid.html"here/a
* - Service `s3`: Used for authentication along with the `role_arn`. If not provided, it uses connector's `group_id`. Use the [List All Groups endpoint](https://fivetran.com/docs/rest-api/groups#listallgroups) to find the `group_id`.
* - Service `segment`: The external ID is a string that designates who can assume the role. For more information, see a href="http://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_create_for-user_externalid.html"Amazon's AWS Identity and Access Management User Guide/a.
* - Service `sql_server`: The external ID to be used when assuming the IAM role.
*/
externalId: string;
/**
* Field usage depends on `service` value:
* - Service `azure_blob_storage`: A regular expression with a named capture group `(?table...)` to extract table names from file paths.
* - Service `gcs`: A regular expression with a named capture group `(?table...)` to extract table names from file paths.
* - Service `s3`: A regular expression with a named capture group `(?table...)` to extract table names from file paths.
* - Service `sftp`: A regular expression with a named capture group `(?table...)` to extract table names from file paths.
*/
extractionPattern?: string;
/**
* Field usage depends on `service` value:
* - Service `unicommerce`: Your uniware facility codes.
*/
facilityCodes?: string;
/**
* Field usage depends on `service` value:
* - Service `facebook`: List of fields which connector will sync. [Possible field values](https://fivetran.com/docs/applications/facebook-ad-insights/api-config#fields).
*/
fields?: string[];
/**
* Field usage depends on `service` value:
* - Service `box`: Files will be processed and synced according to the selected file handling option. Supported values:`structured`- (Default) Extract structured data into destination tables for analysis. Commonly used.`unstructured`- Replicate files in their original format. Best for PDFs, images, and other unstructured content. Learn more about unstructured file replication in our [documentation.](https://fivetran.com/docs/using-fivetran/features/unstructured-file-replication).
* - Service `google_drive`: Files will be processed and synced according to the selected file handling option. Supported values:`structured`- (Default) Extract structured data into destination tables for analysis. Commonly used.`unstructured`- Replicate files in their original format. Best for PDFs, images, and other unstructured content. Learn more about unstructured file replication in our [documentation.](https://fivetran.com/docs/using-fivetran/features/unstructured-file-replication).
* - Service `sftp`: Files will be processed and synced according to the selected file handling option. Supported values:`structured`- (Default) Extract structured data into destination tables for analysis. Commonly used.`unstructured`- Replicate files in their original format. Best for PDFs, images, and other unstructured content. Learn more about unstructured file replication in our [documentation.](https://fivetran.com/docs/using-fivetran/features/unstructured-file-replication).
* - Service `share_point`: Files will be processed and synced according to the selected file handling option. Supported values:`structured`- (Default) Extract structured data into destination tables for analysis. Commonly used.`unstructured`- Replicate files in their original format. Best for PDFs, images, and other unstructured content. Learn more about unstructured file replication in our [documentation.](https://fivetran.com/docs/using-fivetran/features/unstructured-file-replication).
*/
fileHandling: string;
/**
* Field usage depends on `service` value:
* - Service `azure_blob_storage`: The method used to map files to destination tables. Use `DEFINE_PER_TABLE` to manually configure each table with its own file pattern, or `EXTRACT_TABLES` to automatically discover tables based on a single extraction pattern.
* - Service `gcs`: The method used to map files to destination tables. Use `DEFINE_PER_TABLE` to manually configure each table with its own file pattern, or `EXTRACT_TABLES` to automatically discover tables based on a single extraction pattern.
* - Service `s3`: The method used to map files to destination tables. Use `DEFINE_PER_TABLE` to manually configure each table with its own file pattern, or `EXTRACT_TABLES` to automatically discover tables based on a single extraction pattern.
* - Service `sftp`: The method used to map files to destination tables. Use `DEFINE_PER_TABLE` to manually configure each table with its own file pattern, or `EXTRACT_TABLES` to automatically discover tables based on a single extraction pattern.
*/
fileMappingMethod: string;
/**
* Field usage depends on `service` value:
* - Service `aws_cost_report`: If your files are saved with improper extensions, you can force them to by synced as the selected filetype. Leave the value as infer if your files have the correct extensions
* - Service `azure_blob_storage`: If your files are saved with improper extensions, you can force them to by synced as the selected file type.
* - Service `box`: If your files are saved with improper extensions, you can force them to be synced as the selected filetype.
* - Service `dropbox`: If your files are saved with improper extensions, you can force them to be synced as the selected filetype.
* - Service `email`: If your files are saved with improper extensions, you can force them to by synced as the selected file type.
* - Service `ftp`: If your files are saved with improper extensions, you can force them to by synced as the selected file type.
* - Service `gcs`: If your files are saved with improper extensions, you can force them to by synced as the selected file type.
* - Service `google_drive`: If your files are saved with improper extensions, you can force them to be synced as the selected filetype.
* - Service `kinesis`: If your files are saved with improper extensions, you can force them to by synced as the selected filetype. Leave the value as infer if your files have the correct extensions
* - Service `s3`: If your files are saved with improper extensions, you can force them to be synced as the selected file type.
* - Service `s3_compatible_storage`: If your files are saved with improper extensions, you can force them to be synced as the selected file type.
* - Service `sftp`: If your files are saved with improper extensions, you can force them to by synced as the selected file type.
* - Service `share_point`: If your files are saved with improper extensions, you can force them to be synced as the selected file type.
* - Service `wasabi_cloud_storage`: If your files are saved with improper extensions, you can force them to be synced as the selected file type.
*/
fileType: string;
files?: outputs.ConnectorConfigFile[];
/**
* Field usage depends on `service` value:
* - Service `google_analytics`: String parameter restricts the data returned for your report. To use the filter parameter, specify a dimension or metric on which to filter, followed by the filter expression
*/
filter?: string;
/**
* Field usage depends on `service` value:
* - Service `itunes_connect`: Whether to sync all finance accounts or specific finance accounts.
*/
financeAccountSyncMode: string;
/**
* Field usage depends on `service` value:
* - Service `itunes_connect`: Specific finance accounts to sync. Must be populated if `finance_account_sync_mode` is set to `SpecificFinanceAccounts`.
*/
financeAccounts?: string[];
/**
* Field usage depends on `service` value:
* - Service `dropbox`: Your Dropbox Folder URL.
*/
folder?: string;
/**
* Field usage depends on `service` value:
* - Service `box`: Folder URL
* - Service `google_drive`: Folder URL
*/
folderId: string;
/**
* Field usage depends on `service` value:
* - Service `adobe_analytics_data_feed`: Folder Path
* - Service `one_drive`: Your OneDrive folder URL
* - Service `oracle_business_intelligence_publisher`: The folder path to save data models and reports.
*/
folderPath?: string;
/**
* Field usage depends on `service` value:
* - Service `clari`: Your Clari Forecast id .
*/
forecastId?: string;
/**
* Field usage depends on `service` value:
* - Service `adobe_analytics_data_feed`: FTP host.
*/
ftpHost: string;
/**
* Field usage depends on `service` value:
* - Service `adobe_analytics_data_feed`: FTP password.
*/
ftpPassword: string;
/**
* Field usage depends on `service` value:
* - Service `adobe_analytics_data_feed`: FTP port.
*/
ftpPort: number;
/**
* Field usage depends on `service` value:
* - Service `adobe_analytics_data_feed`: FTP user.
*/
ftpUser: string;
/**
* Field usage depends on `service` value:
* - Service `aws_lambda`: The name of your AWS Lambda Function.
*/
function: string;
/**
* Field usage depends on `service` value:
* - Service `azure_function`: Function app name in Azure portal.
*/
functionApp: string;
/**
* Field usage depends on `service` value:
* - Service `azure_function`: Function key used for authorization.
*/
functionKey: string;
/**
* Field usage depends on `service` value:
* - Service `azure_function`: Name of the function to be triggered.
*/
functionName: string;
/**
* Field usage depends on `service` value:
* - Service `google_cloud_function`: The trigger URL of the cloud function.
*/
functionTrigger: string;
/**
* Field usage depends on `service` value:
* - Service `braze`: Your GCS bucket. Required if `GCS` is the `cloud_storage_type`
* - Service `webhooks`: The GCS bucket name. Required if `bucket_service` is set to `GCS`.
*/
gcsBucket: string;
gcsCredentials?: outputs.ConnectorConfigGcsCredentials;
/**
* Field usage depends on `service` value:
* - Service `braze`: Your GCS bucket. Required if `GCS` is the `export_storage_type`
*/
gcsExportBucket?: string;
/**
* Field usage depends on `service` value:
* - Service `braze`: Your GCS folder name. Required if `GCS` is the `export_storage_type`
*/
gcsExportFolder?: string;
/**
* Field usage depends on `service` value:
* - Service `braze`: Your GCS folder name. Required if `GCS` is the `cloud_storage_type`
*/
gcsFolder: string;
/**
* Field usage depends on `service` value:
* - Service `workday`: Select this option to generate a Primary Key for reports where no single column or combination of columns can be used to form a Primary Key.
*/
generateFivetranPk: boolean;
/**
* Field usage depends on `service` value:
* - Service `sap_hana_db`: SAP Logon Group name for load balancing
*/
group?: string;
/**
* Field usage depends on `service` value:
* - Service `line_ads`: Your LINE Ads group ID(s).
*/
groupId?: string;
/**
* Field usage depends on `service` value:
* - Service `fivetran_log`: (Optional) The group name of the `target_group_id`.
*/
groupName: string;
hanaBackupPassword?: string;
/**
* Field usage depends on `service` value:
* - Service `sap_hana_db`: Port number of the SAP HANA database
*/
hanaDbPort: number;
/**
* Field usage depends on `service` value:
* - Service `hana_sap_hva_b1`: The mode for connecting to HANA server. Available options: Single container (default), Multiple containers - Tenant database, Multiple containers - System database, Manual port selection - This option is used only if the database port needs to be specified manually.
* - Service `hana_sap_hva_ecc`: The mode for connecting to HANA server. Available options: Single container (default), Multiple containers - Tenant database, Multiple containers - System database, Manual port selection - This option is used only if the database port needs to be specified manually.
* - Service `hana_sap_hva_ecc_netweaver`: The mode for connecting to HANA server. Available options: Single container (default), Multiple containers - Tenant database, Multiple containers - System database, Manual port selection - This option is used only if the database port needs to be specified manually.
* - Service `hana_sap_hva_s4`: The mode for connecting to HANA server. Available options: Single container (default), Multiple containers - Tenant database, Multiple containers - System database, Manual port selection - This option is used only if the database port needs to be specified manually.
* - Service `hana_sap_hva_s4_netweaver`: The mode for connecting to HANA server. Available options: Single container (default), Multiple containers - Tenant database, Multiple containers - System database, Manual port selection - This option is used only if the database port needs to be specified manually.
*/
hanaMode: string;
/**
* Field usage depends on `service` value:
* - Service `azure_service_bus`: The boolean value specifying whether the connection string has manage permissions
*/
hasManagePermissions: boolean;
/**
* Field usage depends on `service` value:
* - Service `braze`: Range of data in history you would like to include in the initial sync.
* - Service `iterable`: The time range for which historical data should be synced. Default value: `All Time`.
* - Service `klaviyo`: Range of data in history you would like to include in the initial sync. Default value: `ALL_TIME`.
* - Service `marketo`: Range of data in history you would like to include in the initial sync. Default value: `ALL_TIME`.
* - Service `sailthru`: Range of historical data you would like to include in the initial sync. Default value: `ALL_TIME`.
* - Service `salesforce_marketing_cloud`: Range of data in history you would like to include in the initial sync. Default value: `ALL_TIME`.
*/
historicSyncTimeFrame: string;
/**
* Field usage depends on `service` value:
* - Service `braze`: Range of data in history you would like to include in the initial sync. Valid values are `ALL_TIME` and `DATE_LIMIT`
* - Service `concur`: Historical Sync Limit for the Sync
* - Service `eloqua`: Range of data in history you would like to include in the initial sync. Default value: `ALL_TIME`.
* - Service `iterable`: The time range for which historical data should be synced. Default value: `All Time`.
* - Service `klaviyo`: The time range for which historical data should be synced. Default value: `ALL_TIME`.
* - Service `marketo`: The time range for which historical data should be synced. Default value: `All Time`.
* - Service `pardot`: The time range for which historical data should be synced. Default value: `All Time`.
* - Service `pardot_sandbox`: The time range for which historical data should be synced. Default value: `All Time`.
* - Service `sage_intacct`: Historical Sync Limit for the Sync
* - Service `sailthru`: The time range for which historical data should be synced. Default value: `All Time`.
* - Service `salesforce_marketing_cloud`: The time range for which historical data should be synced. Default value: `All Time`.
*/
historicalSyncLimit: string;
/**
* Field usage depends on `service` value:
* - Service `braze`: The start date (in YYYY-MM-DD) from which to sync historical data. Only used when `historicalSyncLimit` is set to `DATE_LIMIT`.
* - Service `iterable`: The start date (YYYY-MM-DD) from which to sync historical data.
* - Service `klaviyo`: The start date (YYYY-MM-DD) from which to sync historical data.
* - Service `marketo`: The start date (YYYY-MM-DD) from which to sync historical data.
* - Service `pardot`: The start date (YYYY-MM-DD) from which to sync historical data.
* - Service `pardot_sandbox`: The start date (YYYY-MM-DD) from which to sync historical data.
* - Service `sailthru`: The start date (YYYY-MM-DD) from which to sync historical data.
* - Service `salesforce_marketing_cloud`: The start date (YYYY-MM-DD) from which to sync historical data.
*/
historicalSyncLimitDate?: string;
/**
* Field usage depends on `service` value:
* - Service `pardot`: The options for time range for which historical data should be synced. Default value: `All Time`.
* - Service `pardot_sandbox`: The options for time range for which historical data should be synced. Default value: `All Time`.
*/
historicalSyncLimitTimeFrame: string;
/**
* Field usage depends on `service` value:
* - Service `amazon_selling_partner`: The time frame for historical data synchronization. Default value: `ALL_TIME`.
* - Service `ascend_by_partnerize`: Your Ascend by Partnerize Historical sync time frame
* - Service `hubspot`: Used to configure Historical sync timeframe for selected tables.
* - Service `mixpanel`: Should sync all data or adhere to `backward_sync_limit_date`
* - Service `pendo`: The time range for which historical data should be synced. Default value: `All Time`.
* - Service `rokt`: Your Rokt historical sync time frame.
* - Service `shopify`: Used to configure Historical sync timeframe for selected tables
* - Service `skimlinks`: Your Skimlinks Historical sync time frame.
* - Service `stripe`: Used to configure Historical sync timeframe for selected tables
* - Service `stripe_test`: Used to configure Historical sync timeframe for selected tables
* - Service `vimeo`: Your Vimeo Historical sync time frame.
* - Service `zendesk`: Used to configure Historical sync timeframe for selected tables.
*/
historicalSyncTimeFrame: string;
/**
* Field usage depends on `service` value:
* - Service `appsflyer`: Your S3 home folder path of the Data Locker.
*/
homeFolder: string;
/**
* Field usage depends on `service` value:
* - Service `amqp`: AMQP broker host address.
* - Service `aurora`: DB instance host or IP address.
* - Service `aurora_postgres`: DB instance host or IP address.
* - Service `aveva_pi`: IP address of the AF Server
* - Service `azure_postgres`: DB instance host or IP address.
* - Service `azure_sql_db`: DB instance host or IP address.
* - Service `azure_sql_managed_db`: DB instance host or IP address.
* - Service `clarity`: DB instance host or IP address.
* - Service `cockroachdb`: DB instance host or IP address.
* - Service `commercetools`: Your commercetools host.
* - Service `databricks_db`: The host URL for your Databricks account.
* - Service `db2i_hva`: A host address of the primary node. It should be a DB instance host/IP address with a port number.
* - Service `db2i_sap_hva`: DB instance host or IP address.
* - Service `db2luw`: A host address of the primary node. It should be a DB instance host/IP address with a port number.
* - Service `db2z`: DB instance host or IP address.
* - Service `documentdb`: Host IP address of the primary node. Ignored if `hosts` value is provided.
* - Service `dynamics_365_fo`: DB instance host or IP address.
* - Service `ehr`: DB instance host or IP address.
* - Service `elastic_cloud`: DB instance host or IP address.
* - Service `epic_clarity`: DB instance host or IP address.
* - Service `es_self_hosted`: DB instance host or IP address.
* - Service `ftp`: FTP host address.
* - Service `google_cloud_mysql`: DB instance host or IP address.
* - Service `google_cloud_postgresql`: DB instance host or IP address.
* - Service `google_cloud_sqlserver`: DB instance host or IP address.
* - Service `hana_sap_hva_b1`: DB instance host or IP address.
* - Service `hana_sap_hva_ecc`: DB instance host or IP address.
* - Service `hana_sap_hva_ecc_netweaver`: DB instance host or IP address.
* - Service `hana_sap_hva_s4`: DB instance host or IP address.
* - Service `hana_sap_hva_s4_netweaver`: DB instance host or IP address.
* - Service `heroku_postgres`: DB instance host or IP address.
* - Service `jira`: The Jira service host address.
* - Service `magento_mysql`: DB instance host or IP address.
* - Service `magento_mysql_rds`: DB instance host or IP address.
* - Service `maria`: DB instance host or IP address.
* - Service `maria_azure`: DB instance host or IP address.
* - Service `maria_rds`: DB instance host or IP address.
* - Service `marin`: The Marin host address.
* - Service `mysql`: DB instance host or IP address.
* - Service `mysql_azure`: DB instance host or IP address.
* - Service `mysql_rds`: DB instance host or IP address.
* - Service `netsuite_suiteanalytics`: The NetSuite service host address.
* - Service `opendistro`: DB instance host or IP address.
* - Service `opensearch`: DB instance host or IP address.
* - Service `oracle`: DB instance host or IP address.
* - Service `oracle_ebs`: DB instance host or IP address.
* - Service `oracle_hva`: DB instance host or IP address.
* - Service `oracle_rac`: DB instance host or IP address.
* - Service `oracle_rds`: DB instance host or IP address.
* - Service `oracle_sap_hva`: DB instance host or IP address.
* - Service `oracle_sap_hva_netweaver`: DB instance host or IP address.
* - Service `postgres`: DB instance host or IP address.
* - Service `postgres_rds`: DB instance host or IP address.
* - Service `redshift_db`: Host name
* - Service `sap_hana`: The SAP HANA host or IP address.
* - Service `sap_s4hana`: The SAP S/4 host or IP address.
* - Service `sftp`: SFTP host address.
* - Service `snowflake_db`: Host name
* - Service `splunk`: The Splunk service host address.
* - Service `sql_server`: DB instance host or IP address.
* - Service `sql_server_hva`: DB instance host or IP address.
* - Service `sql_server_rds`: DB instance host or IP address.
* - Service `sql_server_sap_ecc_hva`: DB instance host or IP address.
*/
host: string;
/**
* Field usage depends on `service` value:
* - Service `azure_blob_storage`: IP address of host tunnel machine which is used to connect to the Storage container.
* - Service `azure_service_bus`: The IP address of the host machine which we use to connect to ASB via ssh
*/
hostIp?: string;
/**
* Field usage depends on `service` value:
* - Service `coassemble`: Your Coassemble Hostname.
* - Service `datadog`: Your Datadog host name.
* - Service `ukg_pro_workforce_management`: Your UKG Pro Workforce Management hostname.
* - Service `zuora`: The domain or URL of your Zuora Revenue instance.
* - Service `zuora_sandbox`: The domain or URL of your Zuora Revenue instance.
*/
hostName?: string;
/**
* Field usage depends on `service` value:
* - Service `adobe_commerce`: Your Adobe Commerce host url.
* - Service `github`: The GHES instance host address. Only for on-premises installations.
* - Service `sparkpost`: Your SparkPost host URL.
*/
hostUrl?: string;
/**
* Field usage depends on `service` value:
* - Service `azure_blob_storage`: Username in the host machine.
* - Service `azure_service_bus`: The username on the host machine which we use to connect to ASB via ssh
*/
hostUser?: string;
/**
* Field usage depends on `service` value:
* - Service `akamai`: Your Akamai hostname.
* - Service `discourse`: Your Discourse hostname.
* - Service `national_heavy_vehicle_regulator`: Your National Heavy Vehicle Regulator hostname.
* - Service `ukg_pro`: Your UKG Pro hostname.
*/
hostname?: string;
/**
* Field usage depends on `service` value:
* - Service `azure_cosmos_for_mongo`: A list of host addresses for Azure Cosmos DB for Mongo DB.
* - Service `mongo`: A list of host addresses of the primary node and all replicas. Each list item is either: a DB instance host/IP address with a port number, or SRV host record.
* - Service `mongo_sharded`: A list of host addresses of the primary node and all replicas. Each list item is either: a DB instance host/IP address with a port number, or SRV host record.
*/
hosts?: string[];
/**
* Field usage depends on `service` value:
* - Service `databricks_db`: http path
*/
httpPath?: string;
/**
* Field usage depends on `service` value:
* - Service `playvox_workforce_management`: Your Playvox Workforce Management client identifier.
* - Service `statistics_netherlands_cbs`: Your Statistics Netherlands CBS catalog identifier.
*/
identifier?: string;
/**
* Field usage depends on `service` value:
* - Service `marketo`: Marketo REST API identity url.
*/
identity: string;
/**
* Field usage depends on `service` value:
* - Service `servicenow`: (Immutable) Include inherited columns.
*/
includeInheritedColumns: boolean;
/**
* Field usage depends on `service` value:
* - Service `salesforce_commerce_cloud`: Whether to sync data through OCAPI endpoints.
*/
includeOcapiEndpoints: boolean;
/**
* Field usage depends on `service` value:
* - Service `acumatica`: Your Acumatica instance name.
* - Service `coupa`: The instance name of your Coupa account in the URL.
* - Service `flywheel_digital`: Your Flywheel Digital instance.
* - Service `salesforce_marketing_cloud`: The Salesforce Marketing Cloud instance ID
* - Service `servicenow`: ServiceNow Instance ID.
*/
instance: string;
/**
* Field usage depends on `service` value:
* - Service `workday_adaptive`: Instance code for Workday Adaptive Planning.
*/
instanceCode?: string;
/**
* Field usage depends on `service` value:
* - Service `hana_sap_hva_b1`: Two-digit number (00-97) of the SAP instance within its host.
* - Service `hana_sap_hva_ecc`: Two-digit number (00-97) of the SAP instance within its host.
* - Service `hana_sap_hva_ecc_netweaver`: Two-digit number (00-97) of the SAP instance within its host.
* - Service `hana_sap_hva_s4`: Two-digit number (00-97) of the SAP instance within its host.
* - Service `hana_sap_hva_s4_netweaver`: Two-digit number (00-97) of the SAP instance within its host.
* - Service `oracle_sap_hva_netweaver`: Two-digit number (00-97) of the SAP instance within its host.
*/
instanceNumber?: string;
/**
* Field usage depends on `service` value:
* - Service `sap_business_by_design`: The SAP Business ByDesign instance URL.
*/
instanceUrl?: string;
/**
* Field usage depends on `service` value:
* - Service `pendo`: The integration key of the Pendo account.
*/
integrationKey: string;
/**
* Field usage depends on `service` value:
* - Service `aveva_pi`: IP address of the AF Server
*/
ipAddress?: string;
/**
* Field usage depends on `service` value:
* - Service `fivetran_log`: (Optional) Retrieve account-level logs.
*/
isAccountLevelConnector: boolean;
/**
* Field usage depends on `service` value:
* - Service `apple_search_ads`: The contents of your PEM certificate file. Default value: `false`
*/
isAuth2Enabled: boolean;
/**
* Field usage depends on `service` value:
* - Service `twitter_ads`: Custom API credentials
*/
isCustomApiCredentials: boolean;
/**
* Field usage depends on `service` value:
* - Service `pardot`: Whether the `EXTERNAL_ACTIVITY` table must be synced or not.
* - Service `pardot_sandbox`: Whether the `EXTERNAL_ACTIVITY` table must be synced or not.
*/
isExternalActivitiesEndpointSelected: boolean;
/**
* Field usage depends on `service` value:
* - Service `adobe_analytics_data_feed`: Use Secure FTP (FTPS).
*/
isFtps: boolean;
/**
* Field usage depends on `service` value:
* - Service `sftp`: Whether to use a key pair for authentication. When `true`, do not use `password`.
*/
isKeypair: boolean;
/**
* Field usage depends on `service` value:
* - Service `zuora`: Set to `true` if there are multiple entities in your Zuora account and you only want to use one entity. Otherwise, set to `false`.
* - Service `zuora_sandbox`: Set to `true` if there are multiple entities in your Zuora account and you only want to use one entity. Otherwise, set to `false`.
*/
isMultiEntityFeatureEnabled: boolean;
/**
* Field usage depends on `service` value:
* - Service `salesforce_marketing_cloud`: Indicates that that your installed package uses OAuth 2.0. Default value: `false`
*/
isNewPackage: boolean;
/**
* Field usage depends on `service` value:
* - Service `snowflake_db`: Indicates that a private key is encrypted. The default value: `false`. The field can be specified if authentication type is `KEY_PAIR`.
*/
isPrivateKeyEncrypted: boolean;
/**
* Field usage depends on `service` value:
* - Service `aws_lambda`: We use PrivateLink by default if your AWS Lambda is in the same region as Fivetran. Turning on this toggle ensures that Fivetran always connects to AWS lambda over PrivateLink. Learn more in our [PrivateLink documentation](https://fivetran.com/docs/connectors/databases/connection-options/aws-private-link).
* - Service `dynamodb`: We use PrivateLink by default if your DynamoDB instance is in the same region as Fivetran. Turning on this toggle ensures that Fivetran always connects to DynamoDB over PrivateLink. Learn more in our [PrivateLink documentation](https://fivetran.com/docs/connectors/databases/connection-options/aws-private-link).
* - Service `s3`: Set to `true` if you want to connect to S3 bucket over PrivateLink. Default value: `false`.
*/
isPrivateLinkRequired: boolean;
/**
* Field usage depends on `service` value:
* - Service `aws_cost_report`: Whether you are syncing from a public bucket. Default value: `false`.
* - Service `kinesis`: Is the bucket public? (you don't need an AWS account for syncing public buckets!)
* - Service `s3`: Whether you are syncing from a public bucket. Default value: `false`.
*/
isPublic: boolean;
/**
* Field usage depends on `service` value:
* - Service `sailthru`: Enable this if you want to sync Sailthru Connect
*/
isSailthruConnectEnabled: boolean;
/**
* Field usage depends on `service` value:
* - Service `ftp`: Whether the server supports FTPS.
*/
isSecure: boolean;
/**
* Field usage depends on `service` value:
* - Service `salesforce_marketing_cloud`: Provide SFTP credentials
*/
isSftpCredsAvailable: boolean;
/**
* Field usage depends on `service` value:
* - Service `box`: Allows the creation of connector using Merge Mode strategy.
* - Service `dropbox`: Allows the creation of connector using Merge Mode strategy.
* - Service `google_drive`: Allows the creation of connector using Merge Mode strategy.
* - Service `sftp`: Allows the creation of connector using the specified Sync strategy.
* - Service `share_point`: Allows the creation of connector using Merge Mode strategy.
*/
isSingleTableMode: boolean;
/**
* Field usage depends on `service` value:
* - Service `adyen`: Whether or not your Adyen Account is a Test Account. Default value: `false`.
*/
isTestAccount: boolean;
/**
* Field usage depends on `service` value:
* - Service `amazon_selling_partner`: Whether or not you have a Vendor Account. Default value: `false`.
*/
isVendor: boolean;
/**
* Field usage depends on `service` value:
* - Service `oracle_fusion_cloud_apps_crm`: The Oracle Fusion Cloud issuer name.
* - Service `oracle_fusion_cloud_apps_fscm`: The Oracle Fusion Cloud issuer name.
* - Service `oracle_fusion_cloud_apps_hcm`: The Oracle Fusion Cloud issuer name.
*/
issuer?: string;
/**
* Field usage depends on `service` value:
* - Service `itunes_connect`: Your Issuer ID
*/
issuerId?: string;
/**
* Field usage depends on `service` value:
* - Service `amqp`: JSON delivery mode (Packed or Unpacked).
* - Service `aws_cost_report`: Control how your JSON data is delivered into your destination
* - Service `azure_blob_storage`: Control how your JSON data is delivered into your destination
* - Service `box`: Control how your JSON data is delivered into your destination
* - Service `dropbox`: Control how your JSON data is delivered into your destination
* - Service `email`: Control how your JSON data is delivered into your destination
* - Service `ftp`: Control how your JSON data is delivered into your destination
* - Service `gcs`: Control how your JSON data is delivered into your destination
* - Service `google_drive`: Control how your JSON data is delivered into your destination
* - Service `kinesis`: Control how your JSON data is delivered into your destination
* - Service `s3`: Control how your JSON data is delivered into your destination
* - Service `s3_compatible_storage`: Control how your JSON data is delivered into your destination
* - Service `sftp`: Control how your JSON data is delivered into your destination
* - Service `share_point`: Control how your JSON data is delivered into your destination
* - Service `wasabi_cloud_storage`: Specifies how Fivetran should handle your JSON data. Default value: `Packed`.
*/
jsonDeliveryMode?: string;
/**
* Field usage depends on `service` value:
* - Service `uservoice`: The UserVoice API key.
*/
key: string;
/**
* Field usage depends on `service` value:
* - Service `itunes_connect`: Your Key ID
*/
keyId?: string;
/**
* Field usage depends on `service` value:
* - Service `aws_msk`: If `security_protocol` is set to `TLS`, enter your `Key Password`.
*/
keyPassword?: string;
/**
* Field usage depends on `service` value:
* - Service `heroku_kafka`: Key Store Type
*/
keyStoreType?: string;
/**
* Field usage depends on `service` value:
* - Service `aws_msk`: If `security_protocol` is set to `TLS`, add the `Keystore File` as Base64 encoded string.
*/
keystore?: string;
/**
* Field usage depends on `service` value:
* - Service `aws_msk`: If `security_protocol` is set to `TLS`, enter your `Keystore Password`.
*/
keystorePassword?: string;
lastSyncedChangesUtc_: string;
latestVersion: string;
/**
* Field usage depends on `service` value:
* - Service `younium`: Your Younium legal entity ID.
*/
legalEntityId?: string;
/**
* Field usage depends on `service` value:
* - Service `pardot`: API limit for the external activities endpoint.
* - Service `pardot_sandbox`: API limit for the external activities endpoint.
*/
limitForApiCallsToExternalActivitiesEndpoint: number;
/**
* Field usage depends on `service` value:
* - Service `aws_cost_report`: You can specify the custom line separator for your CSV files. The line separator is used in files to separate one row from the next.
* - Service `azure_blob_storage`: You can specify the custom line separator for your CSV files. The line separator is used in files to separate one row from the next.
* - Service `box`: You can specify the custom line separator for your CSV files. The line separator is used in files to separate one row from the next.
* - Service `dropbox`: You can specify the custom line separator for your CSV files. The line separator is used in files to separate one row from the next.
* - Service `email`: You can specify the custom line separator for your CSV files. The line separator is used in files to separate one row from the next.
* - Service `ftp`: You can specify the custom line separator for your CSV files. The line separator is used in files to separate one row from the next.
* - Service `gcs`: You can specify the custom line separator for your CSV files. The line separator is used in files to separate one row from the next.
* - Service `google_drive`: You can specify the custom line separator for your CSV files. The line separator is used in files to separate one row from the next.
* - Service `kinesis`: You can specify the custom line separator for your CSV files. The line separator is used in files to separate one row from the next.
* - Service `s3`: You can specify the custom line separator for your CSV files. The line separator is used in files to separate one row from the next.
* - Service `s3_compatible_storage`: You can specify the custom line separator for your CSV files. The line separator is used in files to separate one row from the next.
* - Service `sftp`: You can specify the custom line separator for your CSV files. The line separator is used in files to separate one row from the next.
* - Service `share_point`: You can specify the custom line separator for your CSV files. The line separator is used in files to separate one row from the next.
* - Service `wasabi_cloud_storage`: You can specify the custom line separator for your CSV files. The line separator is used in files to separate one row from the next.
*/
lineSeparator?: string;
/**
* Field usage depends on `service` value:
* - Service `pigment`: Your Pigment list ID.
*/
listId?: string;
/**
* Field usage depends on `service` value:
* - Service `cj_commission_detail`: Your CJ Commission Detail list of company IDs.
*/
listOfCompanyIds?: string;
/**
* Field usage depends on `service` value:
* - Service `aws_cost_report`: Optional. If you have a file structure where new files are always named in lexicographically increasing order such as files being named in increasing order of time, you can select codetime_based_pattern_listing/code.
* - Service `kinesis`: Optional. If you have a file structure where new files are always named in lexicographically increasing order such as files being named in increasing order of time, you can select codetime_based_pattern_listing/code.
* - Service `s3`: The listing strategy you want to use. Default value: `complete_listing`.
* - Service `s3_compatible_storage`: The listing strategy you want to use. Default value: `complete_listing`.
*/
listStrategy: string;
/**
* Field usage depends on `service` value:
* - Service `google_analytics_4_export`: The Sync Mode
*/
listSyncMode?: string;
/**
* Field usage depends on `service` value:
* - Service `h_level`: Your HighLevel location ID.
*/
locationIds?: string;
/**
* Field usage depends on `service` value:
* - Service `db2i_hva`: The log journal name.
* - Service `db2i_sap_hva`: The log journal name.
*/
logJournal?: string;
/**
* Field usage depends on `service` value:
* - Service `db2i_hva`: The log journal schema.
* - Service `db2i_sap_hva`: The log journal schema.
*/
logJournalSchema?: string;
/**
* Field usage depends on `service` value:
* - Service `hana_sap_hva_ecc_netweaver`: Name of the SAP logon group. The default value is PUBLIC. This field is optional.
* - Service `hana_sap_hva_s4_netweaver`: Name of the SAP logon group. The default value is PUBLIC. This field is optional.
*/
logOnGroup?: string;
/**
* Field usage depends on `service` value:
* - Service `rebound_returns`: Your ReBound Returns login.
* - Service `the_trade_desk`: The Trade Desk email. It is a part of the login credentials.
* - Service `walmart_dsp`: Walmart DSP email. It is a part of the login credentials.
* - Service `workday_adaptive`: User email address
*/
login?: string;
/**
* Field usage depends on `service` value:
* - Service `concur`: The SAP Concur password.
* - Service `sage_intacct`: The login password. It is a part of the login credentials.
*/
loginPassword: string;
/**
* Field usage depends on `service` value:
* - Service `sage_intacct`: Lookback window for GL Batch endpoint lookback sync
*/
lookBackWindowForGlBatchEndpoint: number;
/**
* Field usage depends on `service` value:
* - Service `google_ads`: The list of the Manager Account IDs whose clients will be synced. Must be populated if `sync_mode` is set to `ManagerAccounts`.
*/
managerAccounts?: string[];
/**
* Field usage depends on `service` value:
* - Service `reltio`: Maximum API requests per day
*/
maxApiRequestsPerDay: number;
/**
* Field usage depends on `service` value:
* - Service `afterpay`: Your Afterpay Merchant ID.
* - Service `amazon_selling_partner`: The Merchant ID or Vendor Code.
* - Service `avantlink`: Your AvantLink Merchant ID.
* - Service `braintree`: Your Braintree merchant ID.
* - Service `braintree_sandbox`: Your Braintree merchant ID.
* - Service `shareasale`: Your ShareASale merchant ID.
* - Service `xsolla`: Your Xsolla Merchant ID.
*/
merchantId: string;
/**
* Field usage depends on `service` value:
* - Service `amqp`: Message type (Text or JSON).
* - Service `apache_kafka`: Kafka message type.
* - Service `aws_msk`: The Message type.
* - Service `azure_event_hub`: Message type.
* - Service `azure_service_bus`: The format of messages in the topic
* - Service `confluent_cloud`: Confluent Cloud message type.
* - Service `heroku_kafka`: Heroku Kafka message type.
*/
messageType: string;
/**
* Field usage depends on `service` value:
* - Service `pigment`: Your Pigment metric ID.
*/
metricId?: string;
/**
* Field usage depends on `service` value:
* - Service `adroll`: The metrics that you want to sync.
* - Service `criteo`: Metrics
* - Service `double_click_campaign_manager`: Report metrics to include into a sync.
* - Service `google_analytics`: The report metrics to include into a sync.
* - Service `google_display_and_video_360`: The report metrics to include into a sync. The metric names are provided in the API format. This is a required parameter when `config_method` is set to `CREATE_NEW`.
*/
metrics?: string[];
/**
* Field usage depends on `service` value:
* - Service `sap_hana_db`: SAP Message Server host name
*/
msHost?: string;
/**
* Field usage depends on `service` value:
* - Service `sap_hana_db`: SAP Message Server service port number
*/
msServ?: string;
/**
* Field usage depends on `service` value:
* - Service `google_sheets`: The name of the named data range on the sheet that contains the data to be synced.
*/
namedRange: string;
/**
* Field usage depends on `service` value:
* - Service `amqp`: AMQP namespace or virtual host.
* - Service `azure_service_bus`: The ASB namespace which we have to sync. Required for `AzureActiveDirectory` authentication.
*/
namespace?: string;
/**
* Field usage depends on `service` value:
* - Service `double_click_publishers`: Network code is a unique, numeric identifier for your Ad Manager network.
*/
networkCode: number;
/**
* Field usage depends on `service` value:
* - Service `gcs`: Use this if your CSV generator uses non-standard ways of escaping characters. Default value: `false`.
* - Service `s3`: Use this if your CSV generator uses non-standard ways of escaping characters. Default value: `false`.
*/
nonStandardEscapeChar: boolean;
/**
* Field usage depends on `service` value:
* - Service `aws_cost_report`: Optional. If your CSVs use a special value indicating null, you can specify it here.
* - Service `azure_blob_storage`: If your CSVs use a special value indicating null, you can specify it here.
* - Service `box`: If your CSVs use a special value indicating null, you can specify it here.
* - Service `dropbox`: If your CSVs use a special value indicating null, you can specify it here.
* - Service `email`: If your CSVs use a special value indicating null, you can specify it here.
* - Service `ftp`: If your CSVs use a special value indicating null, you can specify it here.
* - Service `gcs`: If your CSVs use a special value indicating null, you can specify it here.
* - Service `google_drive`: If your CSVs use a special value indicating null, you can specify it here.
* - Service `kinesis`: Optional. If your CSVs use a special value indicating null, you can specify it here.
* - Service `s3`: If your CSVs use a special value indicating null, you can specify it here.
* - Service `s3_compatible_storage`: If your CSVs use a special value indicating null, you can specify it here.
* - Service `sftp`: If your CSVs use a special value indicating null, you can specify it here.
* - Service `share_point`: If your CSVs use a special value indicating null, you can specify it here.
* - Service `wasabi_cloud_storage`: If your CSVs use a special value indicating null, you can specify it here.
*/
nullSequence: string;
/**
* Field usage depends on `service` value:
* - Service `dsv`: Your OAuth subscription key.
*/
oauthSubscriptionKey?: string;
oauthToken: string;
oauthTokenSecret: string;
/**
* Field usage depends on `service` value:
* - Service `salesforce_commerce_cloud`: The Salesforce Commerce Cloud OCAPI Client ID.
*/
ocapiClientId?: string;
/**
* Field usage depends on `service` value:
* - Service `salesforce_commerce_cloud`: The Salesforce Commerce Cloud OCAPI Client secret.
*/
ocapiClientSecret?: string;
/**
* Field usage depends on `service` value:
* - Service `salesforce_commerce_cloud`: The Salesforce Commerce Cloud OCAPI custom object types.
*/
ocapiCustomObjectTypes?: string;
/**
* Field usage depends on `service` value:
* - Service `salesforce_commerce_cloud`: The Salesforce Commerce Cloud OCAPI hostname.
*/
ocapiHostname?: string;
/**
* Field usage depends on `service` value:
* - Service `hana_sap_hva_b1`: ODBC manager library path
* - Service `hana_sap_hva_ecc`: ODBC manager library path
* - Service `hana_sap_hva_s4`: ODBC manager library path
*/
odbcDriverManagerLibraryPath?: string;
/**
* Field usage depends on `service` value:
* - Service `hana_sap_hva_b1`: odbc.ini and odbcsinst.ini location
* - Service `hana_sap_hva_ecc`: odbc.ini and odbcsinst.ini location
* - Service `hana_sap_hva_s4`: odbc.ini and odbcsinst.ini location
*/
odbcSysIniPath?: string;
/**
* Field usage depends on `service` value:
* - Service `aws_cost_report`: If you know that your files contain some errors, you can choose to have poorly formatted lines skipped. We recommend leaving the value as fail unless you are certain that you have undesirable, malformed data.
* - Service `azure_blob_storage`: If you know that your files contain some errors, you can choose to have poorly formatted lines skipped. We recommend leaving the value as fail unless you are certain that you have undesirable, malformed data.
* - Service `box`: If you know that your files contain some errors, you can choose to have poorly formatted lines skipped. We recommend leaving the value as fail unless you are certain that you have undesirable, malformed data.
* - Service `dropbox`: If you know that your files contain some errors, you can choose to have poorly formatted lines skipped. We recommend leaving the value as fail unless you are certain that you have undesirable, malformed data.
* - Service `ftp`: If you know that your files contain some errors, you can choose to have poorly formatted lines skipped. We recommend leaving the value as fail unless you are certain that you have undesirable, malformed data.
* - Service `gcs`: If you know that your files contain some errors, you can choose to have poorly formatted lines skipped. We recommend leaving the value as fail unless you are certain that you have undesirable, malformed data.
* - Service `google_drive`: If you know that your files contain some errors, you can choose to have poorly formatted lines skipped. We recommend leaving the value as fail unless you are certain that you have undesirable, malformed data.
* - Service `kinesis`: If you know that your files contain some errors, you can choose to have poorly formatted lines skipped. We recommend leaving the value as fail unless you are certain that you have undesirable, malformed data.
* - Service `s3`: If you know that your files contain some errors, you can choose to have poorly formatted lines skipped. We recommend leaving the value as `fail` unless you are certain that you have undesirable, malformed data.
* - Service `s3_compatible_storage`: If you know that your files contain some errors, you can choose to have poorly formatted lines skipped. We recommend leaving the value as `fail` unless you are certain that you have undesirable, malformed data.
* - Service `sftp`: If you know that your files contain some errors, you can choose to have poorly formatted lines skipped. We recommend leaving the value as fail unless you are certain that you have undesirable, malformed data.
* - Service `share_point`: If you know that your files contain some errors, you can choose to have poorly formatted lines skipped. We recommend leaving the value as fail unless you are certain that you have undesirable, malformed data.
* - Service `wasabi_cloud_storage`: If you know that your files contain some errors, you can choose to have poorly formatted lines skipped. We recommend leaving the value as `fail` unless you are certain that you have undesirable, malformed data.
*/
onError: string;
/**
* Field usage depends on `service` value:
* - Service `jira`: Whether the Jira instance is local or in cloud.
*/
onPremise: boolean;
/**
* Field usage depends on `service` value:
* - Service `adobe_experience_platform`: Your Adobe Experience Platform organization ID.
*/
orgId?: string;
/**
* Field usage depends on `service` value:
* - Service `gladly`: Your Gladly Organization Name.
* - Service `statuspage`: Your Statuspage Organization ID.
*/
organization: string;
/**
* Field usage depends on `service` value:
* - Service `adobe_workfront`: Your Adobe Workfront organization domain.
*/
organizationDomain?: string;
/**
* Field usage depends on `service` value:
* - Service `adobe_analytics`: Organization ID from the Service Account (JWT) credentials of your Adobe Project.
* - Service `device_magic`: Your Device Magic organization ID.
* - Service `integrate`: Your Integrate organization ID.
* - Service `megaphone`: Your Megaphone organization ID.
* - Service `productive`: Your Productive Organization ID.
* - Service `salesforce_commerce_cloud`: The organization ID from Salesforce Commerce Cloud account.
* - Service `sentry`: Your Sentry organization ID.
* - Service `zoho_books`: Your Zoho Books Organization ID.
* - Service `zoho_inventory`: Your Zoho Inventory organization ID.
*/
organizationId: string;
/**
* Field usage depends on `service` value:
* - Service `brightpearl`: Your Brightpearl organization name.
* - Service `confluence`: Your Confluence organization name.
*/
organizationName?: string;
/**
* Field usage depends on `service` value:
* - Service `apple_search_ads`: Organizations
* - Service `snapchat_ads`: Specific organizations IDs to sync. Must be populated if `syncMode` is set to `SpecificOrganizations`.
*/
organizations?: string[];
packageId?: string;
/**
* Field usage depends on `service` value:
* - Service `azure_cosmos_for_mongo`: List of tables to be synced in packed mode; format:`db.table`(case-sensitive).
* - Service `dynamodb`: List of tables to be synced in packed mode.
* - Service `firebase`: Specific tables to sync. Must be populated if `packing_mode` is set to `SelectTablesForPackedMode`.
* - Service `mongo`: List of tables to be synced in packed mode; format:`db.table`(case-sensitive).
* - Service `mongo_sharded`: List of tables to be synced in packed mode; format:`db.table`(case-sensitive).
*/
packedModeTables?: string[];
/**
* Field usage depends on `service` value:
* - Service `azure_cosmos_for_mongo`: Indicates the desired sync pack mode. Accepted values are `UsePackedModeOnly` and `UseUnpackedModeOnly`. `SelectTablesForPackedMode` is deprecated.
* - Service `firebase`: Whether to sync all tables in unpacked mode or specific tables in packed mode. Default value: `UseUnpackedModeOnly`.
* - Service `klaviyo`: Packing mode for EVENT and PERSON tables.
* - Service `mongo`: Whether to sync all tables in unpacked mode only, all tables in packed mode only, or specific tables in packed mode. Default value: `UseUnpackedModeOnly`.
* - Service `mongo_sharded`: Whether to sync all tables in unpacked mode only, all tables in packed mode only, or specific tables in packed mode. Default value: `UseUnpackedModeOnly`.
* - Service `optimizely`: Packing mode for conversion and decision tables.
* - Service `sailthru`: Packing mode for LIST_STATE and USER tables.
*/
packingMode?: string;
/**
* Field usage depends on `service` value:
* - Service `facebook_pages`: Specific pages to sync. Must be populated if `sync_mode` is set to `SpecificPages`.
*/
pages?: string[];
/**
* Field usage depends on `service` value:
* - Service `care_quality_commission`: Your Care Quality Commission partner code.
*/
partnerCode?: string;
/**
* Field usage depends on `service` value:
* - Service `expensify`: Your Expensify partnerUserID.
*/
partnerUserId?: string;
/**
* Field usage depends on `service` value:
* - Service `expensify`: Your Expensify partnerUserSecret.
*/
partnerUserSecret?: string;
/**
* Field usage depends on `service` value:
* - Service `google_display_and_video_360`: The list of partners to include into a sync. This parameter only takes effect when `config_method` is set to `CREATE_NEW`.
* - Service `the_trade_desk`: Specific Partner IDs to sync. Must be populated if `syncMode` is set to `SpecificAccounts`.
* - Service `walmart_dsp`: Specific Partner IDs to sync. Must be populated if `syncMode` is set to `SpecificAccounts`.
*/
partners?: string[];
/**
* Field usage depends on `service` value:
* - Service `qualtrics`: Pass Phrase
*/
passPhrase?: string;
/**
* Field usage depends on `service` value:
* - Service `snowflake_db`: In case private key is encrypted, you are required to enter passphrase that was used to encrypt the private key. The field can be specified if authentication type is `KEY_PAIR`.
*/
passphrase: string;
/**
* Field usage depends on `service` value:
* - Service `absorb_lms`: Your Absorb LMS password.
* - Service `adobe_commerce`: Your Adobe Commerce password.
* - Service `akeneo`: Your Akeneo password.
* - Service `alida`: Your Alida client secret.
* - Service `amqp`: Password for basic authentication.
* - Service `anaplan`: Your Anaplan password. Must be populated if `auth_mode` is set to `Basic`.
* - Service `appfigures`: Your Appfigures Password.
* - Service `asset_panda`: Your Asset Panda password.
* - Service `aurora`: The user's password.
* - Service `aurora_postgres`: The user's password.
* - Service `azure_cosmos_for_mongo`: Password used for source database authentication.
* - Service `azure_postgres`: The user's password.
* - Service `azure_sql_db`: The user's password.
* - Service `azure_sql_managed_db`: The user's password.
* - Service `boostr`: Your Boostr password.
* - Service `brivo`: Your Brivo password.
* - Service `cabcharge`: Your Cabcharge password.
* - Service `ceridian_dayforce`: Your Ceridian Dayforce password.
* - Service `cin7`: Your Cin7 API Key.
* - Service `clarity`: The user's password.
* - Service `cockroachdb`: The user's password.
* - Service `collibra`: Your collibra password.
* - Service `compliance_checkpoint`: Your Compliance Checkpoint account password.
* - Service `contrast_security`: Your Contrast Security API Password.
* - Service `db2i_hva`: The user's password.
* - Service `db2i_sap_hva`: The user's password.
* - Service `db2luw`: The user's password.
* - Service `db2z`: The user's password. Specify only when `authentication_method` is `PASSWORD`.
* - Service `delighted`: Pass an empty string
* - Service `deposco`: Your Deposco password.
* - Service `documentdb`: The user's password.
* - Service `dynamics_365_fo`: The user's password.
* - Service `ehr`: The user's password.
* - Service `elastic_cloud`: The user's password.
* - Service `epic_clarity`: The user's password.
* - Service `es_self_hosted`: The user's password.
* - Service `ftp`: FTP password.
* - Service `globalmeet`: Your GlobalMeet Password.
* - Service `google_cloud_mysql`: The user's password.
* - Service `google_cloud_postgresql`: The user's password.
* - Service `google_cloud_sqlserver`: The user's password.
* - Service `green_power_monitor`: Your GreenPowerMonitor password.
* - Service `guru`: Your Guru password.
* - Service `hana_sap_hva_b1`: The user's password.
* - Service `hana_sap_hva_ecc`: The user's password.
* - Service `hana_sap_hva_ecc_netweaver`: The user's password.
* - Service `hana_sap_hva_s4`: The user's password.
* - Service `hana_sap_hva_s4_netweaver`: The user's password.
* - Service `heroku_postgres`: The user's password.
* - Service `hilti_ontrack`: Your Hilti On!Track password.
* - Service `impact`: Your Impact Brand Account Token
* - Service `integral_ad_science`: Your integral_ad_science password.
* - Service `itunes_connect`: Your password
* - Service `jamf`: Your Jamf password.
* - Service `jira`: The Jira user's password.
* - Service `khoros_care`: Your Khoros Care password.
* - Service `kissmetrics`: Your Kissmetrics API Password.
* - Service `klarna`: Your Klarna Password.
* - Service `lessonly`: Your Lessonly password.
* - Service `magento_mysql`: The user's password.
* - Service `magento_mysql_rds`: The user's password.
* - Service `maria`: The user's password.
* - Service `maria_azure`: The user's password.
* - Service `maria_rds`: The user's password.
* - Service `marin`: The Marin user's password.
* - Service `moloco`: Your Moloco account password.
* - Service `mongo`: The user's password.
* - Service `mongo_sharded`: The user's password.
* - Service `myosh`: Your myosh password.
* - Service `mysql`: The user's password.
* - Service `mysql_azure`: The user's password.
* - Service `mysql_rds`: The user's password.
* - Service `netsuite_suiteanalytics`: The NetSuite user's password.
* - Service `opendistro`: The user's password.
* - Service `opensearch`: The user's password.
* - Service `oracle`: The user's password.
* - Service `oracle_business_intelligence_publisher`: The Oracle Business Intelligence user password.
* - Service `oracle_ebs`: The user's password.
* - Service `oracle_fusion_cloud_apps_crm`: The Oracle Fusion Cloud user password.
* - Service `oracle_fusion_cloud_apps_fscm`: The Oracle Fusion Cloud user password.
* - Service `oracle_fusion_cloud_apps_hcm`: The Oracle Fusion Cloud user password.
* - Service `oracle_hva`: The user's password.
* - Service `oracle_rac`: The user's password.
* - Service `oracle_rds`: The user's password.
* - Service `oracle_sap_hva`: The user's password.
* - Service `oracle_sap_hva_netweaver`: The user's password.
* - Service `outbrain`: The Outbrain user's password.
* - Service `pardot`: The Pardot user's password.
* - Service `pardot_sandbox`: The Pardot user's password.
* - Service `partnerize`: Your Partnerize account's password.
* - Service `podio`: Your Podio account password.
* - Service `postgres`: The user's password.
* - Service `postgres_rds`: The user's password.
* - Service `qmatic_data_connect`: Your Qmatic Data Connect password.
* - Service `redshift_db`: The Redshift user's password.
* - Service `revx`: Your RevX Password.
* - Service `rtb_house`: Your RTB House password.
* - Service `sap_business_by_design`: The SAP Business ByDesign password.
* - Service `sap_hana`: Your SAP HANA password.
* - Service `sap_s4hana`: Your SAP S/4 password.
* - Service `scorm`: Your Scorm Secret Key.
* - Service `servicenow`: Your account password.
* - Service `servicetrade`: Your ServiceTrade password.
* - Service `sftp`: SFTP password.
* - Service `shiphero`: Your ShipHero password.
* - Service `shipstation`: Your ShipStation password.
* - Service `shopware`: Your Shopware password.
* - Service `skuvault`: Your SkuVault password.
* - Service `smadex`: Your Smadex Password.
* - Service `snowflake_db`: The Snowflake user's password.
* - Service `splash`: Your Splash password.
* - Service `splunk`: The Splunk user's password.
* - Service `sql_server`: The user's password.
* - Service `sql_server_hva`: The user's password.
* - Service `sql_server_rds`: The user's password.
* - Service `sql_server_sap_ecc_hva`: The user's password.
* - Service `starrez`: Your StarRez API password
* - Service `stickyio`: Your sticky.io password.
* - Service `stylight`: Your Stylight Password.
* - Service `sugarcrm`: Your SugarCRM password.
* - Service `teamwork`: Your Teamwork password.
* - Service `the_trade_desk`: The Trade Desk password. It is a part of the login credentials.
* - Service `toggl_track`: Your Toggl Track Password
* - Service `ukg_pro`: Your UKG Pro password.
* - Service `ukg_pro_workforce_management`: Your UKG Pro Workforce Management password.
* - Service `unicommerce`: Your uniware login password.
* - Service `upland`: Your Upland Software password.
* - Service `uptempo`: Your Uptempo password.
* - Service `veeva_vault`: Password
* - Service `veevavault`: Your Veeva Vault password.
* - Service `walmart_dsp`: Walmart DSP password. It is a part of the login credentials.
* - Service `when_i_work`: Your When I Work password.
* - Service `wherefour`: Your Wherefour password.
* - Service `workday`: Workday password.
* - Service `workday_adaptive`: User password
* - Service `workday_financial_management`: Workday password.
* - Service `workday_hcm`: Workday password.
* - Service `xandr`: Your Xandr password.
* - Service `yougov_brandindex`: Your YouGov BrandIndex password.
* - Service `younium`: Your Younium password.
* - Service `zuora`: The corresponding password for the API user.
* - Service `zuora_sandbox`: The corresponding password for the API user.
*/
password: string;
/**
* Field usage depends on `service` value:
* - Service `github`: The `Personal Access Token` generated in Github.
*/
pat: string;
/**
* Field usage depends on `service` value:
* - Service `tableau_source`: Your Tableau Source PAT Name.
*/
patName?: string;
/**
* Field usage depends on `service` value:
* - Service `tableau_source`: Your Tableau Source PAT Secret.
*/
patSecret?: string;
/**
* Field usage depends on `service` value:
* - Service `jira`: A URL subdirectory where the Jira instance is working.
*/
path: string;
/**
* Field usage depends on `service` value:
* - Service `github`: The `Personal Access Tokens`.
*/
pats?: string[];
/**
* Field usage depends on `service` value:
* - Service `aws_cost_report`: Optional. All files in your search path matching this regular expression will be synced. This parameter is optional.
* - Service `azure_blob_storage`: All files in your search path matching this regular expression will be synced.
* - Service `box`: All files in your search path matching this regular expression will be synced.
* - Service `dropbox`: All files in your search path matching this regular expression will be synced.
* - Service `email`: All files in your search path matching this regular expression will be synced. We have discontinued this field, and will delete it by Oct 31, 2025.
* - Service `ftp`: All files in your search path matching this regular expression will be synced.
* - Service `gcs`: All files in your search path matching this regular expression will be synced. We have discontinued this field, and will delete it by August 31, 2025.
* - Service `google_drive`: All files in your search path matching this regular expression will be synced. We have discontinued this field, and will delete it by August 31, 2025.
* - Service `kinesis`: Optional. All files in your search path matching this regular expression will be synced. This parameter is optional.
* - Service `s3`: All files in your search path matching this regular expression will be synced. We have discontinued this field, and will delete it by August 31, 2025.
* - Service `sftp`: All files in your search path matching this regular expression will be synced. We have discontinued this field, and will delete it by August 31, 2025.
* - Service `share_point`: All files in your search path matching this regular expression will be synced.
* - Service `wasabi_cloud_storage`: All files in your search path matching this regular expression will be synced.
*/
pattern: string;
/**
* Field usage depends on `service` value:
* - Service `oracle`: Optional: Required only for containerized database.
* - Service `oracle_ebs`: Optional: Required only for containerized database.
* - Service `oracle_hva`: (Multi-tenant databases only) The database's PDB name. Omit this parameter for single-tenant databases.
* - Service `oracle_rac`: Optional: Required only for containerized database.
* - Service `oracle_rds`: Optional: Required only for containerized database.
* - Service `oracle_sap_hva`: (Multi-tenant databases only) The database's PDB name. Exclude this parameter for single-tenant databases.
*/
pdbName: string;
/**
* Field usage depends on `service` value:
* - Service `apple_search_ads`: The contents of your PEM certificate file. Must be populated if `is_auth2_enabled` is set to `false`.
*/
pemCertificate: string;
/**
* Field usage depends on `service` value:
* - Service `apple_search_ads`: The contents of your PEM secret key file. Must be populated if `is_auth2_enabled` is set to `true`.
*/
pemPrivateKey?: string;
/**
* Field usage depends on `service` value:
* - Service `double_click_campaign_manager`: Per Interaction Dimensions.
*/
perInteractionDimensions?: string[];
/**
* Field usage depends on `service` value:
* - Service `cj_commission_detail`: Your CJ Commission Detail personal access token.
* - Service `databricks_db`: Access Token
* - Service `gitlab`: Your GitLab personal access token.
* - Service `harvest`: Your Harvest Personal Access Token.
* - Service `productive`: Your Productive personal access token.
* - Service `totango`: Your Totango personal access token.
*/
personalAccessToken?: string;
/**
* Field usage depends on `service` value:
* - Service `circleci`: Your CircleCI Personal API token.
* - Service `monday`: Your Monday.com Personal API Token.
*/
personalApiToken?: string;
/**
* Field usage depends on `service` value:
* - Service `azure_blob_storage`: The PGP passphrase used to create the key. Must be populated if `use_pgp_encryption_options` is set to `true`.
* - Service `ftp`: The PGP passphrase used to create the key. Must be populated if `use_pgp_encryption_options` is set to `true`.
* - Service `gcs`: The PGP passphrase used to create the key. Must be populated if `use_pgp_encryption_options` is set to `true`.
* - Service `s3`: The PGP passphrase used to create the key. Must be populated if `use_pgp_encryption_options` is set to `true`.
* - Service `s3_compatible_storage`: The PGP passphrase used to create the key. Must be populated if `use_pgp_encryption_options` is set to `true`.
* - Service `sftp`: The PGP passphrase used to create the key. Must be populated if `use_pgp_encryption_options` is set to `true`.
* - Service `wasabi_cloud_storage`: The PGP passphrase used to create the key. Must be populated if `use_pgp_encryption_options` is set to `true`.
*/
pgpPassPhrase?: string;
/**
* Field usage depends on `service` value:
* - Service `azure_blob_storage`: The contents of your PGP secret key file. Must be populated if `use_pgp_encryption_options` is set to `true`.
* - Service `ftp`: The contents of your PGP secret key file. Must be populated if `use_pgp_encryption_options` is set to `true`.
* - Service `gcs`: The contents of your PGP secret key file. Must be populated if `use_pgp_encryption_options` is set to `true`.
* - Service `s3`: The contents of your PGP secret key file. Must be populated if `use_pgp_encryption_options` is set to `true`.
* - Service `s3_compatible_storage`: The contents of your PGP secret key file. Must be populated if `use_pgp_encryption_options` is set to `true`.
* - Service `sftp`: The contents of your PGP secret key file. Must be populated if `use_pgp_encryption_options` is set to `true`.
* - Service `wasabi_cloud_storage`: The contents of your PGP secret key file. Must be populated if `use_pgp_encryption_options` is set to `true`.
*/
pgpSecretKey?: string;
/**
* Field usage depends on `service` value:
* - Service `itunes_connect`: Register the number on AppleId Account Page for 2FA
*/
phoneNumber?: string;
/**
* Field usage depends on `service` value:
* - Service `wrike`: Your Wrike Subscription Plan.
*/
plan: string;
/**
* Field usage depends on `service` value:
* - Service `justcall`: Your JustCall Plan Type.
*/
planType: string;
/**
* Field usage depends on `service` value:
* - Service `amqp`: AMQP broker port.
* - Service `aurora`: The port number.
* - Service `aurora_postgres`: The port number.
* - Service `aveva_pi`: Port number at which the AF Server is running
* - Service `azure_postgres`: The port number.
* - Service `azure_sql_db`: The port number.
* - Service `azure_sql_managed_db`: The port number.
* - Service `clarity`: The port number.
* - Service `cockroachdb`: The port number.
* - Service `databricks_db`: The port of your SQL warehouse.
* - Service `db2i_hva`: The port number.
* - Service `db2i_sap_hva`: The port number.
* - Service `db2luw`: The port number.
* - Service `db2z`: The port number.
* - Service `documentdb`: Port of the primary node. Ignored if `hosts` value is provided.
* - Service `dynamics_365_fo`: The port number.
* - Service `ehr`: The port number.
* - Service `elastic_cloud`: The port number.
* - Service `epic_clarity`: The port number.
* - Service `es_self_hosted`: The port number.
* - Service `ftp`: FTP port.
* - Service `google_cloud_mysql`: The port number.
* - Service `google_cloud_postgresql`: The port number.
* - Service `google_cloud_sqlserver`: The port number.
* - Service `hana_sap_hva_b1`: The port number.
* - Service `hana_sap_hva_ecc`: The port number.
* - Service `hana_sap_hva_ecc_netweaver`: The port number.
* - Service `hana_sap_hva_s4`: The port number.
* - Service `hana_sap_hva_s4_netweaver`: The port number.
* - Service `heroku_postgres`: The port number.
* - Service `jira`: The Jira service host port.
* - Service `magento_mysql`: The port number.
* - Service `magento_mysql_rds`: The port number.
* - Service `maria`: The port number.
* - Service `maria_azure`: The port number.
* - Service `maria_rds`: The port number.
* - Service `mysql`: The port number.
* - Service `mysql_azure`: The port number.
* - Service `mysql_rds`: The port number.
* - Service `netsuite_suiteanalytics`: The NetSuite service host port.
* - Service `opendistro`: The port number.
* - Service `opensearch`: The port number.
* - Service `oracle`: The port number.
* - Service `oracle_ebs`: The port number.
* - Service `oracle_hva`: The port number.
* - Service `oracle_rac`: The port number.
* - Service `oracle_rds`: The port number.
* - Service `oracle_sap_hva`: The port number.
* - Service `postgres`: The port number.
* - Service `postgres_rds`: The port number.
* - Service `redshift_db`: Port number
* - Service `sap_hana`: The SAP HANA port number.
* - Service `sap_s4hana`: The SAP S/4 port number.
* - Service `sftp`: SFTP port.
* - Service `snowflake_db`: The Snowflake optional port number.
* - Service `splunk`: The Splunk service host port.
* - Service `sql_server`: The port number.
* - Service `sql_server_hva`: The port number.
* - Service `sql_server_rds`: The port number.
* - Service `sql_server_sap_ecc_hva`: The port number.
*/
port: number;
/**
* Field usage depends on `service` value:
* - Service `linkedin_ads`: The time period to attribute conversions based on clicks. Default value: `DAY_30`
*/
postClickAttributionWindowSize: string;
/**
* Field usage depends on `service` value:
* - Service `facebook`: The name of report of which connector will sync the data. [Possible prebuilt_report values](https://fivetran.com/docs/applications/facebook-ad-insights/api-config#prebuiltreport).
* - Service `google_analytics`: The name of the Prebuilt Report from which the connector will sync the data.
*/
prebuiltReport: string;
/**
* Field usage depends on `service` value:
* - Service `aws_cloudtrail`: If prefix is present when configuring the bucket.
* - Service `aws_cost_report`: Folder path to the aws_cost_report files within the bucket.
* - Service `aws_inventory`: The prefix if you used one when configuring the bucket.
* - Service `azure_blob_storage`: All files and folders under this folder path will be searched for files to sync.
* - Service `box`: All files and folders under this folder path will be searched for files to sync.
* - Service `cloudfront`: The name of the CloudFront folder in the bucket.
* - Service `dropbox`: All files and folders under this folder path will be searched for files to sync.
* - Service `ftp`: All files and folders under this folder path will be searched for files to sync.
* - Service `gcs`: All files and folders under this folder path will be searched for files to sync.
* - Service `google_drive`: All files and folders under this folder path will be searched for files to sync, this can be the entire drive link or a folder URL
* - Service `kinesis`: Folder path to the Kinesis files within the bucket.
* - Service `marin`: Folder path to the Marin manifest file.
* - Service `microsoft_dynamics_365_fo`: Folder name in which the exported dynamics 365 data resides.
* - Service `s3`: All files and folders under this folder path will be searched for files to sync.
* - Service `s3_compatible_storage`: All files and folders under this folder path will be searched for files to sync.
* - Service `segment`: Folder path to the Segment files within the bucket. Must be populated if `sync_type` is set to `S3`.
* - Service `sftp`: All files and folders under this folder path will be searched for files to sync.
* - Service `share_point`: All files and folders under this folder path link will be searched for files to sync. This can be any shared folder link.
* - Service `wasabi_cloud_storage`: All files and folders under this folder path will be searched for files to sync.
*/
prefix: string;
/**
* Field usage depends on `service` value:
* - Service `care_quality_commission`: Your Care Quality Commission primary key.
*/
primaryKey?: string;
/**
* Field usage depends on `service` value:
* - Service `workday`: Primary Keys
*/
primaryKeys?: string[];
/**
* Field usage depends on `service` value:
* - Service `marketo`: Use BULK for both LEAD and ACTIITIES
*/
prioritiseBulkExportOverRest: boolean;
/**
* Field usage depends on `service` value:
* - Service `purple_dot`: Your PurpleDot Private access token.
*/
privateAccessToken?: string;
/**
* Field usage depends on `service` value:
* - Service `absorb_lms`: Your Absorb LMS REST API private key.
* - Service `adobe_analytics`: The complete contents of your private key file including the start and end tags (`----BEGIN PRIVATE KEY----` to `----END PRIVATE KEY----`).
* - Service `adp_workforce_now`: Private Key.
* - Service `anaplan`: The contents of your private key file. Must be populated if `auth_mode` is set to `Certificate`.
* - Service `apple_search_ads`: The contents of your secret key file. Must be populated if `is_auth2_enabled` is set to `false`.
* - Service `braintree`: The contents of your secret key file.
* - Service `braintree_sandbox`: The contents of your secret key file.
* - Service `github`: Your Private Key
* - Service `itunes_connect`: Your Private Key
* - Service `netsuite_suiteanalytics`: Private Key
* - Service `oracle_fusion_cloud_apps_crm`: The Oracle Fusion Cloud private key.
* - Service `oracle_fusion_cloud_apps_fscm`: The Oracle Fusion Cloud private key.
* - Service `oracle_fusion_cloud_apps_hcm`: The Oracle Fusion Cloud private key.
* - Service `qualtrics`: Your private key
* - Service `salesforce`: Provide content of the `.key` private key (only when authentication_method = `ADVANCED`).
* - Service `salesforce_sandbox`: Provide content of the `.key` private key (only when authentication_method = `ADVANCED`).
* - Service `snowflake_db`: Private access key. The field should be specified if authentication type is `KEY_PAIR`.
*/
privateKey: string;
/**
* Field usage depends on `service` value:
* - Service `eventbrite`: Your Eventbrite private token.
*/
privateToken?: string;
/**
* Field usage depends on `service` value:
* - Service `webconnex`: Your Webconnex product.
*/
product: string;
/**
* Field usage depends on `service` value:
* - Service `amazon_ads`: Specific User Profile IDs to sync. Must be populated if `sync_mode` is set to `SpecificProfiles`.
* - Service `google_analytics`: Specific User Profile IDs to sync. Must be populated if `syncMode` is set to `SpecificAccounts`.
* - Service `google_analytics_mcf`: Specific User Profile IDs to sync. Must be populated if `sync_mode` is set to `SPECIFIC_ACCOUNTS`.
*/
profiles?: string[];
/**
* Field usage depends on `service` value:
* - Service `amazon_dsp`: your Amazon DSP profiles pass it inside an Array list.
*/
profilesAmazonDsp?: string;
/**
* Field usage depends on `service` value:
* - Service `rollbar`: Your Rollbar project access token.
*/
projectAccessToken?: string;
projectCredentials?: outputs.ConnectorConfigProjectCredential[];
/**
* Field usage depends on `service` value:
* - Service `bigquery_db`: BigQuery project ID
* - Service `google_analytics_360`: The project ID.
* - Service `google_analytics_4_export`: The Project ID.
* - Service `mixpanel`: Project ID
*/
projectId: string;
/**
* Field usage depends on `service` value:
* - Service `sentry`: Your Sentry project IDs.
*/
projectIds?: string;
/**
* Field usage depends on `service` value:
* - Service `commercetools`: Your commercetools project key.
*/
projectKey?: string;
/**
* Field usage depends on `service` value:
* - Service `writesonic`: Website URL of your Writesonic project.
*/
projectWebsiteUrl?: string;
/**
* Field usage depends on `service` value:
* - Service `asana`: Specific Project IDs to sync. Must be populated if `syncMode` is set to `SpecificProjects`.
* - Service `jira`: Specific projects to sync. Must be populated if `syncMode` is set to `CUSTOM`.
*/
projects?: string[];
/**
* Field usage depends on `service` value:
* - Service `google_analytics_4`: The array of strings in the `properties/{id}` format where `id` is a Google Analytics 4 property identifier. Must be populated if `sync_mode` is set to `SPECIFIC_ACCOUNTS`.
*/
properties?: string[];
/**
* Field usage depends on `service` value:
* - Service `cloudbeds`: Your Cloudbeds property IDs.
*/
propertyId?: string;
/**
* Field usage depends on `service` value:
* - Service `aurora`: Public Key
* - Service `aurora_postgres`: Public Key
* - Service `azure_blob_storage`: Public key generated by Fivetran to be copied into the host-machine's authorized keys file.
* - Service `azure_cosmos_for_mongo`: Public Key
* - Service `azure_postgres`: Public Key
* - Service `azure_service_bus`: Public key generated by Fivetran to be copied into the host-machine's authorized keys file.
* - Service `azure_sql_db`: Public Key.
* - Service `azure_sql_managed_db`: Public Key.
* - Service `braintree`: The contents of your PEM certificate file.
* - Service `braintree_sandbox`: The contents of your PEM certificate file.
* - Service `clarity`: Public Key.
* - Service `cockroachdb`: Public Key
* - Service `db2i_hva`: Public Key
* - Service `db2i_sap_hva`: Public Key
* - Service `documentdb`: Public Key
* - Service `dynamics_365_fo`: Public Key.
* - Service `ehr`: Public Key.
* - Service `elastic_cloud`: Public Key
* - Service `es_self_hosted`: Public Key
* - Service `google_cloud_mysql`: Public Key
* - Service `google_cloud_postgresql`: Public Key
* - Service `google_cloud_sqlserver`: Public Key.
* - Service `hana_sap_hva_b1`: Public Key
* - Service `hana_sap_hva_ecc`: Public Key
* - Service `hana_sap_hva_ecc_netweaver`: Public Key
* - Service `hana_sap_hva_s4`: Public Key
* - Service `hana_sap_hva_s4_netweaver`: Public Key
* - Service `heroku_postgres`: Public Key
* - Service `magento_mysql`: Public Key
* - Service `magento_mysql_rds`: Public Key
* - Service `maria`: Public Key
* - Service `maria_azure`: Public Key
* - Service `maria_rds`: Public Key
* - Service `mongo`: Public Key
* - Service `mongo_sharded`: Public Key
* - Service `mysql`: Public Key
* - Service `mysql_azure`: Public Key
* - Service `mysql_rds`: Public Key
* - Service `opendistro`: Public Key
* - Service `opensearch`: Public Key
* - Service `oracle`: Public Key
* - Service `oracle_ebs`: Public Key
* - Service `oracle_fusion_cloud_apps_crm`: The Oracle Fusion Cloud public key.
* - Service `oracle_fusion_cloud_apps_fscm`: The Oracle Fusion Cloud public key.
* - Service `oracle_fusion_cloud_apps_hcm`: The Oracle Fusion Cloud public key.
* - Service `oracle_hva`: Public Key
* - Service `oracle_rac`: Public Key
* - Service `oracle_rds`: Public Key
* - Service `oracle_sap_hva`: Public Key
* - Service `partnerstack_vendor`: Your PartnerStack Vendor Public key.
* - Service `postgres`: Public Key
* - Service `postgres_rds`: Public Key
* - Service `sap_hana`: Public Key
* - Service `sap_s4hana`: Public Key
* - Service `sftp`: Public Key
* - Service `sql_server`: Public Key.
* - Service `sql_server_hva`: Public Key.
* - Service `sql_server_rds`: Public Key.
* - Service `sql_server_sap_ecc_hva`: Public Key.
*/
publicKey: string;
/**
* Field usage depends on `service` value:
* - Service `aurora_postgres`: Publication name. Specify only for `"updated_method": "WAL_PGOUTPUT"`.
* - Service `azure_postgres`: Publication name. Specify only for `"updated_method": "WAL_PGOUTPUT"`.
* - Service `google_cloud_postgresql`: Publication name. Specify only for `"updated_method": "WAL_PGOUTPUT"`.
* - Service `heroku_postgres`: Publication name. Specify only for `"updated_method": "WAL_PGOUTPUT"`.
* - Service `postgres`: Publication name. Specify only for `"updated_method": "WAL_PGOUTPUT"`.
* - Service `postgres_rds`: Publication name. Specify only for `"updated_method": "WAL_PGOUTPUT"`.
*/
publicationName: string;
/**
* Field usage depends on `service` value:
* - Service `skimlinks`: Your Skimlinks publisher ID.
*/
publisherId?: string;
/**
* Field usage depends on `service` value:
* - Service `outbrain`: Include or ignore results from archived campaigns
*/
pullArchivedCampaigns: boolean;
/**
* Field usage depends on `service` value:
* - Service `connector_sdk`: The Python version to be used at runtime.
*/
pythonVersion?: string;
/**
* Field usage depends on `service` value:
* - Service `google_display_and_video_360`: The ID of the query whose configuration you want to reuse. This is a required parameter when `config_method` is set to `REUSE_EXISTING`.
*/
queryId: string;
/**
* Field usage depends on `service` value:
* - Service `alchemer`: Your Alchemer API key.
* - Service `birdeye`: Your Birdeye query-param-value.
*/
queryParamValue?: string;
/**
* Field usage depends on `service` value:
* - Service `amqp`: AMQP queue name to consume messages from.
*/
queueName?: string;
/**
* Field usage depends on `service` value:
* - Service `bigquery_db`: Specify a different project ID to account for quota and billing of Fivetran query workload
*/
quotaProjectId?: string;
/**
* Field usage depends on `service` value:
* - Service `azure_blob_storage`: You can specify the enclosing character used in your CSVs here. Fivetran will consider " as the quote character if this field is empty and quote_character_enabled is set to true.
* - Service `box`: You can specify the enclosing character used in your CSVs here. Fivetran will consider " as the quote character if this field is empty and quote_character_enabled is set to true.
* - Service `dropbox`: You can specify the enclosing character used in your CSVs here. Fivetran will consider " as the quote character if this field is empty and quote_character_enabled is set to true.
* - Service `email`: You can specify the enclosing character used in your CSVs here. Fivetran will consider " as the quote character if this field is empty and quote_character_enabled is set to true.
* - Service `ftp`: You can specify the enclosing character used in your CSVs here. Fivetran will consider " as the quote character if this field is empty and quote_character_enabled is set to true.
* - Service `gcs`: You can specify the enclosing character used in your CSVs here. Fivetran will consider " as the quote character if this field is empty and quote_character_enabled is set to true.
* - Service `google_drive`: You can specify the enclosing character used in your CSVs here. Fivetran will consider " as the quote character if this field is empty and quote_character_enabled is set to true.
* - Service `s3`: You can specify the enclosing character used in your CSVs here. Fivetran will consider " as the quote character if this field is empty and quote_character_enabled is set to true.
* - Service `s3_compatible_storage`: You can specify the enclosing character used in your CSVs here. Fivetran will consider " as the quote character if this field is empty and quote_character_enabled is set to true.
* - Service `sftp`: You can specify the enclosing character used in your CSVs here. Fivetran will consider " as the quote character if this field is empty and quote_character_enabled is set to true.
* - Service `share_point`: You can specify the enclosing character used in your CSVs here. Fivetran will consider " as the quote character if this field is empty and quote_character_enabled is set to true.
*/
quoteChar?: string;
/**
* Field usage depends on `service` value:
* - Service `azure_blob_storage`: If you don’t want to use an enclosing character while processing the files, set the value to false. By default, the value is set to true and is considered " as a quote character.
* - Service `box`: If you don’t want to use an enclosing character while processing the files, set the value to false. By default, the value is set to true and is considered " as quote character.
* - Service `dropbox`: If you don’t want to use an enclosing character while processing the files, set the value to false. By default, the value is set to true and is considered " as quote character.
* - Service `email`: If you don’t want to use an enclosing character while processing the files, set the value to false. By default, the value is set to true and is considered " as quote character.
* - Service `ftp`: If you don’t want to use an enclosing character while processing the files, set the value to false. By default, the value is set to true and is considered " as quote character.
* - Service `gcs`: If you don’t want to use an enclosing character while processing the files, set the value to false. By default, the value is set to true and is considered " as quote character.
* - Service `google_drive`: If you don’t want to use an enclosing character while processing the files, set the value to false. By default, the value is set to true and is considered " as quote character.
* - Service `s3`: If you don’t want to use an enclosing character while processing the files, set the value to false. By default, the value is set to true and is considered " as quote character.
* - Service `s3_compatible_storage`: If you don’t want to use an enclosing character while processing the files, set the value to false. By default, the value is set to true and is considered " as quote character.
* - Service `sftp`: If you don’t want to use an enclosing character while processing the files, set the value to false. By default, the value is set to true and is considered " as quote character.
* - Service `share_point`: If you don’t want to use an enclosing character while processing the files, set the value to false. By default, the value is set to true and is considered " as quote character.
*/
quoteCharacterEnabled: boolean;
/**
* Field usage depends on `service` value:
* - Service `sap_hana_db`: SAP System ID (SID)
*/
r3Name?: string;
/**
* Field usage depends on `service` value:
* - Service `toggl_track`: Your Toggl Track plan type.
* - Service `vimeo`: Your Vimeo rate limit plan.
*/
rateLimitPlan: string;
/**
* Field usage depends on `service` value:
* - Service `ironsource`: Your Ironsource `Client Secret`.
*/
refreshToken?: string;
/**
* Field usage depends on `service` value:
* - Service `pinterest_ads`: The expiration date of the refresh token. Unix timestamp in seconds
*/
refreshTokenExpiresAt?: string;
/**
* Field usage depends on `service` value:
* - Service `algolia`: Your Algolia analytics region.
* - Service `alida`: Your Alida region.
* - Service `amazon_ads`: The region used by the Amazon Ads profile.
* - Service `amazon_selling_partner`: The region used by the Amazon Selling Partner profile.
* - Service `anaplan`: Your Anaplan account region
* - Service `appcues`: Your Appcues region.
* - Service `atlassian_ops_genie`: Your company's Osgenie region (usually **company**.opsgenie.com)
* - Service `awin`: Your Awin Region.
* - Service `aws_lambda`: The AWS region code for the DynamoDB instance.
* - Service `bigin_by_zoho_crm`: Your Bigin by Zoho CRM Region
* - Service `brightflag`: Your Brightflag region.
* - Service `concur`: The region.
* - Service `cvent`: Your Cvent region.
* - Service `everflow`: Your Everflow region.
* - Service `exact_online`: Your Exact Online region.
* - Service `getfeedback`: Your GetFeedback region.
* - Service `happyfox`: Your HappyFox region.
* - Service `keypay`: Your KeyPay region.
* - Service `learnupon`: Your LearnUpon region.
* - Service `medallia_agile_research`: Your Medallia Agile region.
* - Service `messagebird`: Your MessageBird Account region.
* - Service `mixpanel`: Data Region
* - Service `navan`: Your Navan region.
* - Service `on24`: Your ON24 region.
* - Service `pendo`: The Pendo account region.
* - Service `proofpoint_security_awareness`: Your Proofpoint Security Awareness Region.
* - Service `recurly`: Your Recurly region.
* - Service `ringover`: Your Ringover region.
* - Service `samsara`: The region of your Samsara account. For instance, if your region is `EUROPE`, provide `eu.samsara` in the `Region` field. If your region is not in Europe, provide `samsara`.
* - Service `snyk`: Your Snyk region.
* - Service `talkdesk`: Your Talkdesk region (".com",".eu","ca.com")
* - Service `totango`: Your Totango region.
* - Service `transcend`: Your Transcend region.
* - Service `vonage_contact_center`: Your Vonage Contact Center region.
* - Service `wasabi_cloud_storage`: The Wasabi Cloud Storage bucket region. Required for connector creation. Default value: `US_EAST_1`.
* - Service `workday_strategic_sourcing`: Your Workday Strategic Sourcing Region.
* - Service `xray`: Your Xray region.
* - Service `zoho_books`: Your Zoho Books application host region.
* - Service `zoho_campaigns`: Your Zoho Campaigns application host region.
* - Service `zoho_desk`: Your Zoho Desk domain.
* - Service `zoho_inventory`: Your Zoho Inventory application host region.
* - Service `zoho_recruit`: Your Zoho Recruit region.
*/
region: string;
/**
* Field usage depends on `service` value:
* - Service `amazon_attribution`: Your Amazon Attribution API URL region.
*/
regionApiUrl: string;
/**
* Field usage depends on `service` value:
* - Service `amazon_attribution`: Your Amazon Attribution auth URL region.
*/
regionAuthUrl: string;
/**
* Field usage depends on `service` value:
* - Service `amazon_attribution`: Your Amazon Attribution token URL region.
*/
regionTokenUrl: string;
/**
* Field usage depends on `service` value:
* - Service `playvox_workforce_management`: Your Playvox Workforce Management region URL.
*/
regionUrl?: string;
/**
* Field usage depends on `service` value:
* - Service `aurora`: Unique ID within the MySQL replica set. Must be an integer different from all other master and replica servers within the same group.
* - Service `google_cloud_mysql`: Unique ID within the MySQL replica set. Must be an integer different from all other master and replica servers within the same group.
* - Service `magento_mysql`: Unique ID within the MySQL replica set. Must be an integer different from all other master and replica servers within the same group.
* - Service `magento_mysql_rds`: Unique ID within the MySQL replica set. Must be an integer different from all other master and replica servers within the same group.
* - Service `maria`: Unique ID within the MySQL replica set. Must be an integer different from all other master and replica servers within the same group.
* - Service `maria_azure`: Unique ID within the MySQL replica set. Must be an integer different from all other master and replica servers within the same group.
* - Service `maria_rds`: Unique ID within the MySQL replica set. Must be an integer different from all other master and replica servers within the same group.
* - Service `mysql`: Unique ID within the MySQL replica set. Must be an integer different from all other master and replica servers within the same group.
* - Service `mysql_azure`: Unique ID within the MySQL replica set. Must be an integer different from all other master and replica servers within the same group.
* - Service `mysql_rds`: Unique ID within the MySQL replica set. Must be an integer different from all other master and replica servers within the same group.
*/
replicaId: number;
/**
* Field usage depends on `service` value:
* - Service `aurora_postgres`: Replication slot name. Specify only for `"updated_method": "WAL"` or `"WAL_PGOUTPUT"`.
* - Service `azure_postgres`: Replication slot name. Specify only for `"updated_method": "WAL_PGOUTPUT"`.
* - Service `google_cloud_postgresql`: Replication slot name. Specify only for `"updated_method": "WAL_PGOUTPUT"`.
* - Service `heroku_postgres`: Replication slot name. Specify only for `"updated_method": "WAL_PGOUTPUT"`.
* - Service `postgres`: Replication slot name. Specify only for `"updated_method": "WAL_PGOUTPUT"`.
* - Service `postgres_rds`: Replication slot name. Specify only for `"updated_method": "WAL_PGOUTPUT"`.
*/
replicationSlot: string;
reportConfigs?: outputs.ConnectorConfigReportConfig[];
/**
* Field usage depends on `service` value:
* - Service `double_click_campaign_manager`: You can select only one Floodlight Configuration ID per account.
*/
reportConfigurationIds?: string[];
/**
* Field usage depends on `service` value:
* - Service `workday`: This is to select report format from JSON and CSV. By default, report format is JSON.
*/
reportFormatType?: string;
/**
* Field usage depends on `service` value:
* - Service `pinterest_ads`: Granularity at which reports will be
*/
reportGranularity: string;
/**
* Field usage depends on `service` value:
* - Service `rakutenadvertising`: Your Rakuten Advertising report keys.
*/
reportKeys?: string;
reportLists?: outputs.ConnectorConfigReportList[];
/**
* Field usage depends on `service` value:
* - Service `adyen`: Your Report Service API key.
*/
reportServiceApiKey?: string;
reportSuites?: string[];
/**
* Field usage depends on `service` value:
* - Service `criteo`: Report Timezone
*/
reportTimezone?: string;
/**
* Field usage depends on `service` value:
* - Service `adroll`: The report type you want. Default value: `ALL_ADS`.
* - Service `double_click_campaign_manager`: Type of reporting data to sync. Default value: `STANDARD`.
* - Service `google_display_and_video_360`: The type of the report to create. This is a required parameter when `config_method` is set to `CREATE_NEW`.
* - Service `youtube_analytics`: The name of report of which connector will sync the data.
*/
reportType: string;
/**
* Field usage depends on `service` value:
* - Service `workday`: URL for a live custom report.
*/
reportUrl: string;
reports?: outputs.ConnectorConfigReport[];
/**
* Field usage depends on `service` value:
* - Service `linkedin_ads`: Specific analytics reports to sync. Must be populated if adAnalytics is set to 'SpecificReports'.
*/
reportsLinkedinAds?: string[];
/**
* Field usage depends on `service` value:
* - Service `github`: Specific Repository IDs to sync. Must be populated if `syncMode` is set to `SpecificRepositories`.
*/
repositories?: string[];
/**
* Field usage depends on `service` value:
* - Service `cosmos`: A token that provides access to a specific Azure Cosmos DB resource. Required for the `RESOURCE_TOKEN` data access method.
*/
resourceToken?: string;
/**
* Field usage depends on `service` value:
* - Service `dynamics_365`: URL at which Dynamics 365 is accessed
*/
resourceUrl: string;
/**
* Field usage depends on `service` value:
* - Service `pardot`: The number of API calls that the connector should not exceed in a day. Default REST API call limit per day: 150,000.
* - Service `pardot_sandbox`: The number of API calls that the connector should not exceed in a day. Default REST API call limit per day: 150,000.
*/
restApiLimit: number;
/**
* Field usage depends on `service` value:
* - Service `hana_sap_hva_ecc_netweaver`: Directory path containing the SAP NetWeaver RFC SDK library files.
* - Service `hana_sap_hva_s4_netweaver`: Directory path containing the SAP NetWeaver RFC SDK library files.
* - Service `oracle_sap_hva_netweaver`: Directory path containing the SAP NetWeaver RFC SDK library files.
*/
rfcLibraryPath?: string;
/**
* Field usage depends on `service` value:
* - Service `netsuite_suiteanalytics`: The NetSuite Role ID for connection.
* - Service `snowflake_db`: Snowflake Connector role name
*/
role: string;
/**
* Field usage depends on `service` value:
* - Service `appsflyer`: S3 Role ARN
* - Service `aurora`: The ARN of the IAM role with RDS permissions. Required if the authentication method is `AWS_IAM` in the SaaS Deployment model.
* - Service `aws_cloudtrail`: The Role ARN required for authentication.
* - Service `aws_cost`: The Role ARN required for authentication.
* - Service `aws_cost_report`: The Role ARN required for authentication.
* - Service `aws_inventory`: The Role ARN required for authentication.
* - Service `aws_lambda`: The Role ARN required for authentication.
* - Service `aws_msk`: If `sasl_mechanism` is set to `IAM`, enter your Role ARN
* - Service `cloudfront`: The Role ARN required for authentication.
* - Service `dynamodb`: Role ARN
* - Service `heap`: The Role ARN required for authentication.
* - Service `kinesis`: The Role ARN required for authentication.
* - Service `magento_mysql_rds`: The ARN of the IAM role with RDS permissions. Required if the authentication method is `AWS_IAM` in the SaaS Deployment model.
* - Service `maria_rds`: The ARN of the IAM role with RDS permissions. Required if the authentication method is `AWS_IAM` in the SaaS Deployment model.
* - Service `mysql_rds`: The ARN of the IAM role with RDS permissions. Required if the authentication method is `AWS_IAM` in the SaaS Deployment model.
* - Service `s3`: The Role ARN required for authentication. Required for connector creation when syncing using private bucket.
* - Service `segment`: The Role ARN required for authentication. Must be populated if `sync_type` is set to `S3`.
* - Service `sql_server`: The ARN of the IAM role that has access to the S3 bucket.
*/
roleArn: string;
/**
* Field usage depends on `service` value:
* - Service `appsflyer`: Rollback window
* - Service `servicenow`: Set a rollback window between 0 and 7 days. The default is 0 days.
*/
rollbackWindow: number;
/**
* Field usage depends on `service` value:
* - Service `bingads`: A period of time in days during which a conversion is recorded.
*/
rollbackWindowSize: number;
/**
* Field usage depends on `service` value:
* - Service `oracle_fusion_field_service`: Your Oracle Fusion Field Service rootresourceId.
*/
rootResourceId?: string;
/**
* Field usage depends on `service` value:
* - Service `webhooks`: The S3 bucket name. Required if `bucket_service` is set to `S3`.
*/
s3Bucket?: string;
/**
* Field usage depends on `service` value:
* - Service `braze`: Your S3 user export bucket. Required if `AWS_S3` is the `export_storage_type`
*/
s3ExportBucket?: string;
/**
* Field usage depends on `service` value:
* - Service `braze`: This is the same as your `group_id`, used if `export_storage_type` is `AWS_S3`
*/
s3ExportExternalId?: string;
/**
* Field usage depends on `service` value:
* - Service `braze`: Your S3 user export folder name. Required if `AWS_S3` is the `export_storage_type`
*/
s3ExportFolder?: string;
/**
* Field usage depends on `service` value:
* - Service `braze`: The Role ARN required for authentication required if `AWS_S3` is the `export_storage_type`
*/
s3ExportRoleArn?: string;
/**
* Field usage depends on `service` value:
* - Service `adjust`: Used if the `export_storage_type` is `AWS_S3`, the Role ARN required for authentication.
* - Service `webhooks`: The Role ARN required for authentication. Required if `bucket_service` is set to `S3`.
*/
s3RoleArn?: string;
/**
* Field usage depends on `service` value:
* - Service `adobe_analytics_data_feed`: The S3 bucket name.
* - Service `braze`: Your S3 bucket required if `AWS_S3` is the `cloud_storage_type`
* - Service `sailthru`: Name of the bucket configured to receive sailthru connect data.
*/
s3bucket: string;
/**
* Field usage depends on `service` value:
* - Service `braze`: This is the same as your `group_id`, used for authentication along with the `role_arn` required if `AWS_S3` is the `cloud_storage_type`
* - Service `sailthru`: The external ID is a string that designates who can assume the role.
*/
s3externalId: string;
/**
* Field usage depends on `service` value:
* - Service `braze`: Your S3 folder name required if `AWS_S3` is the `cloud_storage_type`
*/
s3folder: string;
/**
* Field usage depends on `service` value:
* - Service `sailthru`: Copy and use this to configure Sailthru Connect in your sailthru account.
*/
s3path?: string;
/**
* Field usage depends on `service` value:
* - Service `adobe_analytics_data_feed`: The Role ARN required for authentication.
* - Service `braze`: The Role ARN required for authentication required if `AWS_S3` is the `cloud_storage_type`
* - Service `sailthru`: Role ARN of the IAM role created for Fivetran.
*/
s3roleArn: string;
/**
* Field usage depends on `service` value:
* - Service `itunes_connect`: Whether to sync all sales accounts or specific sales accounts.
*/
salesAccountSyncMode: string;
/**
* Field usage depends on `service` value:
* - Service `itunes_connect`: Specific sales account to sync. Must be populated if `sales_account_sync_mode` is set to `SpecificSalesAccounts`.
*/
salesAccounts?: string[];
/**
* Field usage depends on `service` value:
* - Service `pardot`: The Pardot user's Salesforce SSO Account Security Token.
* - Service `pardot_sandbox`: The Pardot user's Salesforce SSO Account Security Token.
*/
salesforceSecurityToken?: string;
/**
* Field usage depends on `service` value:
* - Service `gocardless`: Your GoCardless account type.
*/
sandboxAccount?: string;
/**
* Field usage depends on `service` value:
* - Service `adobe_experience_platform`: Your Adobe Experience Platform sandbox name.
*/
sandboxName?: string;
/**
* Field usage depends on `service` value:
* - Service `sap_hana_db`: SAP Router connection string (format: /H/hostname/S/port)
*/
sapRouter?: string;
/**
* Field usage depends on `service` value:
* - Service `db2i_hva`: The SAP schema.
* - Service `db2i_sap_hva`: SAP schema name.
* - Service `sql_server_hva`: SAP Schema Name. Required only for High-Volume Agent SAP ECC connector.
* - Service `sql_server_sap_ecc_hva`: SAP Schema Name.
*/
sapSchema?: string;
/**
* Field usage depends on `service` value:
* - Service `hana_sap_hva_b1`: The schema name where the HANA tables reside.
* - Service `hana_sap_hva_ecc`: The Hana schema name where the SAP tables reside.
* - Service `hana_sap_hva_ecc_netweaver`: The Hana schema name where the SAP tables reside.
* - Service `hana_sap_hva_s4`: The Hana schema name where the SAP tables reside.
* - Service `hana_sap_hva_s4_netweaver`: The Hana schema name where the SAP tables reside.
*/
sapSourceSchema?: string;
/**
* Field usage depends on `service` value:
* - Service `oracle_sap_hva`: The Oracle schema name where the SAP tables reside.
*/
sapUser: string;
/**
* Field usage depends on `service` value:
* - Service `apache_kafka`: SASL Mechanism
* - Service `aws_msk`: If `security_protocol` is set to `SASL`, enter the SASL Mechanism
*/
saslMechanism?: string;
/**
* Field usage depends on `service` value:
* - Service `apache_kafka`: API Key
*/
saslPlainKey?: string;
/**
* Field usage depends on `service` value:
* - Service `apache_kafka`: API Secret
*/
saslPlainSecret?: string;
/**
* Field usage depends on `service` value:
* - Service `apache_kafka`: API Key
*/
saslScram256Key?: string;
/**
* Field usage depends on `service` value:
* - Service `apache_kafka`: API Secret
*/
saslScram256Secret?: string;
/**
* Field usage depends on `service` value:
* - Service `apache_kafka`: API Key
* - Service `aws_msk`: If `sasl_mechanism` is set to `SCRAM_SHA_512`, enter your secret's `saslScram512Key`.
*/
saslScram512Key?: string;
/**
* Field usage depends on `service` value:
* - Service `apache_kafka`: API Secret
* - Service `aws_msk`: If `sasl_mechanism` is set to `SCRAM_SHA_512`, enter your secret's `saslScram512Key`.
*/
saslScram512Secret?: string;
/**
* Field usage depends on `service` value:
* - Service `sap_hana_db`: SAP schema name
*/
schemaName?: string;
/**
* Field usage depends on `service` value:
* - Service `apache_kafka`: Schema Registry Credentials source
* - Service `aws_msk`: Schema Registry Credentials source
* - Service `confluent_cloud`: Schema Registry Credentials source
*/
schemaRegistryCredentialsSource?: string;
/**
* Field usage depends on `service` value:
* - Service `apache_kafka`: Schema Registry Key
* - Service `aws_msk`: Schema Registry Key
* - Service `azure_service_bus`: The key used to access the schema registry. Required for the `avro` and `protobuf` message types
* - Service `confluent_cloud`: Schema Registry Key
*/
schemaRegistryKey?: string;
/**
* Field usage depends on `service` value:
* - Service `apache_kafka`: Schema Registry Secret
* - Service `aws_msk`: Schema Registry Secret
* - Service `azure_service_bus`: The secret used to access the schema registry. Required for the `avro` and `protobuf` message types
* - Service `confluent_cloud`: Schema Registry Secret
*/
schemaRegistrySecret?: string;
/**
* Field usage depends on `service` value:
* - Service `apache_kafka`: Your schema registry URLs
* - Service `aws_msk`: Your schema registry URLs
* - Service `azure_service_bus`: The comma-separated list of schema registry servers in the `server:port` format
* - Service `confluent_cloud`: Your schema registry URLs
*/
schemaRegistryUrls?: string[];
/**
* Field usage depends on `service` value:
* - Service `ebay`: Your eBay scopes.
*/
scope?: string;
/**
* Field usage depends on `service` value:
* - Service `cornerstone`: Your Cornerstone scopes.
* - Service `fortnox`: Your Fortnox app scopes.
*/
scopes?: string;
/**
* Field usage depends on `service` value:
* - Service `yahoo_dsp`: Specific Seats to sync. Must be populated if `sync_mode_seat` is set to `SPECIFIC_SEATS`.
*/
seats?: string[];
/**
* Field usage depends on `service` value:
* - Service `appcues`: Your Appcues Secret.
* - Service `buildium`: Your Buildium API secret.
* - Service `canvas_data_2_by_instructure`: Your Canvas Data 2 by Instructure secret.
* - Service `loopio`: Your Loopio Secret.
* - Service `mode`: Your Mode Secret.
* - Service `playvox_workforce_management`: Your Playvox Workforce Management client secret.
* - Service `tiktok_organic`: The secret of the app registered in your TikTok developer account.
* - Service `twilio`: The Twilio API secret
* - Service `uservoice`: The UserVoice API secret.
* - Service `venminder`: Your Venminder secret.
* - Service `vts`: Your VTS secret.
*/
secret: string;
/**
* Field usage depends on `service` value:
* - Service `validio`: Your Validio secret access key.
*/
secretAccessKey?: string;
/**
* Field usage depends on `service` value:
* - Service `afterpay`: Your Afterpay Secret Key.
* - Service `appsflyer`: Your AWS secret key.
* - Service `bigquery_db`: Private key of the customer service account. If specified, your service account will be used to process the data instead of the Fivetran-managed service account.
* - Service `checkr`: Your Checkr secret key.
* - Service `ezofficeinventory`: Your EZOfficeInventory API secret key.
* - Service `gcs`: Your JSON Private Key. Used to authorize service account. Required if you use a Custom Service Account to authenticate the storage bucket.
* - Service `ironsource`: Your Ironsource `Client ID`.
* - Service `line_ads`: Your LINE Ads secret key.
* - Service `mailjet`: Your Mailjet secret key.
* - Service `partnerstack_vendor`: Your PartnerStack Vendor Secret key.
* - Service `paypal`: `Secret Key` of your PayPal client application.
* - Service `paypal_sandbox`: Secret key of your PayPal client application.
* - Service `phoenix_ads`: Your Phoenix Ads Secret key.
* - Service `retailnext`: Your RetailNext secret key.
* - Service `statsig`: Your Statsig secret key.
* - Service `yotpo`: Your Yotpo Secret key
*/
secretKey: string;
/**
* Field usage depends on `service` value:
* - Service `aws_lambda`: The secrets that should be passed to the function at runtime.
* - Service `azure_function`: The secrets that should be passed to the function at runtime.
* - Service `google_cloud_function`: The secrets that should be passed to the function at runtime.
*/
secrets: string;
secretsLists?: outputs.ConnectorConfigSecretsList[];
/**
* Field usage depends on `service` value:
* - Service `db2z`: Application secret key registered in RACF for the application. Used to generate a PassTicket when `authentication_method` is `LEGACY_PASS_TICKET` or `ENHANCED_PASS_TICKET`.
*/
securedSignonKey?: string;
/**
* Field usage depends on `service` value:
* - Service `apache_kafka`: Security protocol for Kafka interaction.
* - Service `aws_msk`: The security protocol for Kafka interaction.
* - Service `confluent_cloud`: Security protocol for Confluent Cloud interaction.
* - Service `heroku_kafka`: Security protocol for Heroku Kafka interaction.
*/
securityProtocol: string;
/**
* Field usage depends on `service` value:
* - Service `google_analytics`: A segment is a subset of your Analytics data that is made up of one or more non-destructive filters (filters that do not alter the underlying data). Those filters isolate subsets of users, sessions, and hits.
*/
segments?: string[];
/**
* Field usage depends on `service` value:
* - Service `salesforce_marketing_cloud`: Select the event types to be synced.
*/
selectedEventTypes?: string[];
/**
* Field usage depends on `service` value:
* - Service `anaplan`: The list of export IDs in the format `workspace_id_model_id_export_id` that the connector will sync. Must be populated if `sync_mode` is set to `SpecificExports`.
*/
selectedExports?: string[];
/**
* Field usage depends on `service` value:
* - Service `azure_blob_storage`: Cell reference that will be used to sync all contiguous data starting from the top-left cell in all the spreadsheets matching the name. Cell reference is in the `'sheetName'!startColumnNamestartRowName` format.
* - Service `box`: Cell reference that will be used to sync all contiguous data starting from the top-left cell in all the spreadsheets matching the name. Cell reference is in the `'sheetName'!startColumnNamestartRowName` format.
* - Service `dropbox`: Cell reference that will be used to sync all contiguous data starting from the top-left cell in all the spreadsheets matching the name. Cell reference is in the `'sheetName'!startColumnNamestartRowName` format.
* - Service `email`: Cell reference that will be used to sync all contiguous data starting from the top-left cell in all the spreadsheets matching the name. Cell reference is in the `'sheetName'!startColumnNamestartRowName` format.
* - Service `ftp`: Cell reference that will be used to sync all contiguous data starting from the top-left cell in all the spreadsheets matching the name. Cell reference is in the `'sheetName'!startColumnNamestartRowName` format.
* - Service `gcs`: Cell reference that will be used to sync all contiguous data starting from the top-left cell in all the spreadsheets matching the name. Cell reference is in the `'sheetName'!startColumnNamestartRowName` format.
* - Service `s3`: Cell reference that will be used to sync all contiguous data starting from the top-left cell in all the spreadsheets matching the name. Cell reference is in the `'sheetName'!startColumnNamestartRowName` format.
* - Service `sftp`: Cell reference that will be used to sync all contiguous data starting from the top-left cell in all the spreadsheets matching the name. Cell reference is in the `'sheetName'!startColumnNamestartRowName` format.
* - Service `share_point`: Cell reference that will be used to sync all contiguous data starting from the top-left cell in all the spreadsheets matching the name. Cell reference is in the `'sheetName'!startColumnNamestartRowName` format.
*/
selectedRange?: string;
/**
* Field usage depends on `service` value:
* - Service `sage_intacct`: Your Sender ID
*/
senderId?: string;
/**
* Field usage depends on `service` value:
* - Service `sage_intacct`: Your Sender Password
*/
senderPassword?: string;
/**
* Field usage depends on `service` value:
* - Service `castor_edc`: Your Castor EDC server.
*/
server: string;
/**
* Field usage depends on `service` value:
* - Service `tableau_source`: Your Tableau Source server address.
*/
serverAddress?: string;
/**
* Field usage depends on `service` value:
* - Service `clockify`: Your Clockify server region.
*/
serverRegion: string;
/**
* Field usage depends on `service` value:
* - Service `oracle_business_intelligence_publisher`: The Oracle Business Intelligence Instance URL.
* - Service `oracle_fusion_cloud_apps_crm`: The Oracle Fusion Cloud Instance URL.
* - Service `oracle_fusion_cloud_apps_fscm`: The Oracle Fusion Cloud Instance URL.
* - Service `oracle_fusion_cloud_apps_hcm`: The Oracle Fusion Cloud Instance URL.
*/
serverUrl: string;
/**
* Field usage depends on `service` value:
* - Service `myosh`: Your myosh server variable.
*/
serverVariable?: string;
/**
* Field usage depends on `service` value:
* - Service `apache_kafka`: Comma-separated list of Kafka servers in the format `server:port`.
* - Service `aws_msk`: Comma-separated list of Kafka servers in the `server:port` format.
* - Service `confluent_cloud`: Comma-separated list of Confluent Cloud servers in the format `server:port`.
* - Service `heroku_kafka`: Comma-separated list of Heroku Kafka servers in the format `server:port`.
*/
servers?: string[];
/**
* Field usage depends on `service` value:
* - Service `google_drive`: Share the folder with the email address
*/
serviceAccount?: string;
/**
* Field usage depends on `service` value:
* - Service `google_cloud_function`: Provide Invoker role to this service account.
*/
serviceAccountEmail?: string;
/**
* Field usage depends on `service` value:
* - Service `firebase`: The contents of your service account key file. Required for authentication.
*/
serviceAccountKey?: string;
/**
* Field usage depends on `service` value:
* - Service `mixpanel`: Service Account Secret
*/
serviceAccountSecret?: string;
/**
* Field usage depends on `service` value:
* - Service `mixpanel`: Service Account Username
*/
serviceAccountUsername?: string;
/**
* Field usage depends on `service` value:
* - Service `dsv`: A base64 encoded variant of your `username:password` string. Required for authentication.
*/
serviceAuthentication?: string;
/**
* Field usage depends on `service` value:
* - Service `hana_sap_hva_ecc_netweaver`: Unique identifier sapsid of the SAP system. This field is displayed only when the REMOTE SERVICE IDENTIFICATION is set to Service.
* - Service `hana_sap_hva_s4_netweaver`: Unique identifier sapsid of the SAP system. This field is displayed only when the REMOTE SERVICE IDENTIFICATION is set to Service.
* - Service `walmart_marketplace`: Your Walmart Marketplace service name.
*/
serviceName?: string;
serviceVersion: string;
/**
* Field usage depends on `service` value:
* - Service `adobe_analytics_data_feed`: SFTP host.
* - Service `salesforce_marketing_cloud`: Host
*/
sftpHost: string;
/**
* Field usage depends on `service` value:
* - Service `adobe_analytics_data_feed`: Log in with key pair or password
* - Service `salesforce_marketing_cloud`: Set this field if you use a key pair for logging into your SFTP server. Don't set it if you use a username and password
*/
sftpIsKeyPair: boolean;
/**
* Field usage depends on `service` value:
* - Service `adobe_analytics_data_feed`: SFTP password required if sftp_is_key_pair is false
* - Service `salesforce_marketing_cloud`: Password
*/
sftpPassword: string;
/**
* Field usage depends on `service` value:
* - Service `adobe_analytics_data_feed`: SFTP port.
* - Service `salesforce_marketing_cloud`: Port
*/
sftpPort: number;
/**
* Field usage depends on `service` value:
* - Service `adobe_analytics_data_feed`: Public Key
* - Service `salesforce_marketing_cloud`: Public Key
*/
sftpPublicKey?: string;
/**
* Field usage depends on `service` value:
* - Service `adobe_analytics_data_feed`: SFTP user.
* - Service `salesforce_marketing_cloud`: User
*/
sftpUser: string;
/**
* Field usage depends on `service` value:
* - Service `share_point`: Your SharePoint folder URL. You can find the folder URL by following the steps mentioned [here](https://fivetran.com/docs/connectors/files/share-point/setup-guide).
*/
shareUrl: string;
/**
* Field usage depends on `service` value:
* - Service `google_sheets`: The URL of the sheet that can be copied from the browser address bar, or the ID of the sheet that can be found in the sheet's URL between **/d/** and **/edit**.
*/
sheetId: string;
/**
* Field usage depends on `service` value:
* - Service `shopify`: The Shopify shop name. Can be found in the URL before **.myshopify.com**.
*/
shop: string;
/**
* Field usage depends on `service` value:
* - Service `triple_whale`: Your Triple Whale shop domain.
*/
shopDomain?: string;
/**
* Field usage depends on `service` value:
* - Service `salesforce_commerce_cloud`: The Salesforce eight-character string assigned to a realm for routing purposes.
*/
shortCode: string;
/**
* Field usage depends on `service` value:
* - Service `klaviyo`: Sync events linked to deleted profiles
*/
shouldSyncEventsWithDeletedProfiles: boolean;
/**
* Field usage depends on `service` value:
* - Service `netsuite_suiteanalytics`: Re-sync re-import tables during every sync
*/
shouldSyncReimportTables: boolean;
/**
* Field usage depends on `service` value:
* - Service `apple_search_ads`: Turn the toggle on if you want the reports to also return records without metrics.
*/
showRecordsWithNoMetrics: boolean;
/**
* Field usage depends on `service` value:
* - Service `twilio`: The Twilio API key SID
*/
sid: string;
/**
* Field usage depends on `service` value:
* - Service `webhooks`: This is used in HMAC auth method to decode and verify the signature. Supported encodings BASE64 and HEXA_DECIMAL. Default: BASE64
*/
signatureEncoding: string;
/**
* Field usage depends on `service` value:
* - Service `azure_blob_storage`: The contents of the signer's public key file. Must be populated if `use_pgp_encryption_options` is set to `true` and PGP encrypted files are signed.
* - Service `ftp`: The contents of the signer's public key file. Must be populated if `use_pgp_encryption_options` is set to `true` and PGP encrypted files are signed.
* - Service `gcs`: The contents of the signer's public key file. Must be populated if `use_pgp_encryption_options` is set to `true` and PGP encrypted files are signed.
* - Service `s3`: The contents of the signer's public key file. Must be populated if `use_pgp_encryption_options` is set to `true` and PGP encrypted files are signed.
* - Service `s3_compatible_storage`: The contents of the signer's public key file. Must be populated if `use_pgp_encryption_options` is set to `true` and PGP encrypted files are signed.
* - Service `sftp`: The contents of the signer's public key file. Must be populated if `use_pgp_encryption_options` is set to `true` and PGP encrypted files are signed.
* - Service `wasabi_cloud_storage`: The contents of the signer's public key file. Must be populated if `use_pgp_encryption_options` is set to `true` and PGP encrypted files are signed.
*/
signerPublicKey?: string;
/**
* Field usage depends on `service` value:
* - Service `teamwork`: Your Teamwork site address.
*/
siteAddress?: string;
/**
* Field usage depends on `service` value:
* - Service `microsoft_lists`: The Site ID of the SharePoint site from which you want to sync your lists. The Site ID is the `id` field in the [Graph API](https://docs.microsoft.com/en-us/graph/api/site-search?view=graph-rest-1.0&tabs=http) response for sites.
* - Service `salesforce_commerce_cloud`: The name of the site from which you want to sync data.
*/
siteId: string;
/**
* Field usage depends on `service` value:
* - Service `microsoft_lists`: The Name of the SharePoint site. The Site Name is the `name` field in the Graph API response for sites.
* - Service `tableau_source`: Your Tableau Source site name.
*/
siteName?: string;
/**
* Field usage depends on `service` value:
* - Service `google_search_console`: Specific Site URLs to sync. Must be populated if `sync_mode` is set to `SpecificSites`.
*/
siteUrls?: string[];
/**
* Field usage depends on `service` value:
* - Service `aws_cost_report`: Enter 1 or greater
* - Service `azure_blob_storage`: We will skip over the number of lines specified at the end so as to not introduce aberrant data into your destination.
* - Service `box`: We will skip over the number of lines specified at the end so as to not introduce aberrant data into your destination.
* - Service `dropbox`: We will skip over the number of lines specified at the end so as to not introduce aberrant data into your destination.
* - Service `email`: We will skip over the number of lines specified at the end so as to not introduce aberrant data into your destination.
* - Service `ftp`: We will skip over the number of lines specified at the end so as to not introduce aberrant data into your destination.
* - Service `gcs`: We will skip over the number of lines specified at the end so as to not introduce aberrant data into your destination.
* - Service `google_drive`: We will skip over the number of lines specified at the end so as to not introduce aberrant data into your destination.
* - Service `kinesis`: Enter 1 or greater
* - Service `s3`: We will skip over the number of lines specified at the end to avoid introducing aberrant data into your destination.
* - Service `s3_compatible_storage`: We will skip over the number of lines specified at the end to avoid introducing aberrant data into your destination.
* - Service `sftp`: We will skip over the number of lines specified at the end so as to not introduce aberrant data into your destination.
* - Service `share_point`: We will skip over the number of lines specified at the end so as to not introduce aberrant data into your destination.
* - Service `wasabi_cloud_storage`: We will skip over the number of lines specified at the end to avoid introducing aberrant data into your destination.
*/
skipAfter: number;
/**
* Field usage depends on `service` value:
* - Service `aws_cost_report`: Enter 1 or greater
* - Service `azure_blob_storage`: We will skip over the number of lines specified before syncing data.
* - Service `box`: We will skip over the number of lines specified before syncing data.
* - Service `dropbox`: We will skip over the number of lines specified before syncing data.
* - Service `email`: We will skip over the number of lines specified before syncing data.
* - Service `ftp`: We will skip over the number of lines specified before syncing data.
* - Service `gcs`: We will skip over the number of lines specified before syncing data.
* - Service `google_drive`: We will skip over the number of lines specified before syncing data.
* - Service `kinesis`: Enter 1 or greater
* - Service `s3`: We will skip over the number of lines specified before syncing data.
* - Service `s3_compatible_storage`: We will skip over the number of lines specified before syncing data.
* - Service `sftp`: We will skip over the number of lines specified before syncing data.
* - Service `share_point`: We will skip over the number of lines specified before syncing data.
* - Service `wasabi_cloud_storage`: We will skip over the number of lines specified before syncing data.
*/
skipBefore: number;
/**
* Field usage depends on `service` value:
* - Service `google_ads`: Toggles the ["Skip empty reports"](https://fivetran.com/docs/connectors/applications/google-ads#skipemptyreports) feature. Enabled by default
*/
skipEmptyReports: boolean;
sncCertificate?: string;
sncCertificateSource?: string;
sncFivetranName?: string;
/**
* Field usage depends on `service` value:
* - Service `hana_sap_hva_ecc_netweaver`: Path to the external security product's library.
* - Service `hana_sap_hva_s4_netweaver`: Path to the external security product's library.
*/
sncLibraryPath?: string;
sncMode: string;
sncMyName?: string;
/**
* Field usage depends on `service` value:
* - Service `hana_sap_hva_ecc_netweaver`: Client SNC name.
* - Service `hana_sap_hva_s4_netweaver`: Client SNC name.
*/
sncName?: string;
/**
* Field usage depends on `service` value:
* - Service `hana_sap_hva_ecc_netweaver`: Communication partner's SNC name.
* - Service `hana_sap_hva_s4_netweaver`: Communication partner's SNC name.
*/
sncPartnerName?: string;
sncSourceName?: string;
/**
* Field usage depends on `service` value:
* - Service `marketo`: Marketo SOAP API Endpoint (Discontinued).
*/
soapUri: string;
/**
* Field usage depends on `service` value:
* - Service `linkedin_company_pages`: The social data (UGCPosts, Shares, Comments) sync time frame in months. Default value: `SIX` .
*/
socialDataSyncTimeframe?: string;
/**
* Field usage depends on `service` value:
* - Service `adobe_analytics_data_feed`: The data source.
*/
source: string;
/**
* Field usage depends on `service` value:
* - Service `microsoft_dynamics_365_fno`: The file type of the source files. Supported file types are `CSV` and `PARQUET`.
*/
sourceFileType: string;
/**
* Field usage depends on `service` value:
* - Service `consensus_demo_automation_platform`: Your Consensus Demo Automation Platform source name.
*/
sourceName?: string;
/**
* Field usage depends on `service` value:
* - Service `azure_blob_storage`: The name of the Azure Storage account.
* - Service `microsoft_dynamics_365_fno`: The name of the Azure Storage account.
*/
storageAccountName?: string;
/**
* Field usage depends on `service` value:
* - Service `big_commerce`: The [store hash](https://fivetran.com/docs/connectors/applications/big-commerce/setup-guide#createaccesstoken) in your API path.
*/
storeHash?: string;
/**
* Field usage depends on `service` value:
* - Service `reviewsio`: Your REVIEWS.io store ID
*/
storeId?: string;
/**
* Field usage depends on `service` value:
* - Service `firebase`: List of nested collections to sync. Only specified subCollections can be synced.
*/
subCollections?: string[];
/**
* Field usage depends on `service` value:
* - Service `absorb_lms`: Your Absorb LMS subdomain.
* - Service `activecampaign`: Your ActiveCampaign sub-domain.
* - Service `acumatica`: Your Acumatica subdomain.
* - Service `ada`: Your Ada sub-domain.
* - Service `alchemer`: Your Alchemer sub-domain.
* - Service `atlassian_jira_align`: Your Jira Align base URL.
* - Service `azure_boards`: Your Azure Boards Organization Name.
* - Service `azure_devops`: Your Azure Organization Name
* - Service `betterworks`: Your Betterworks subdomain.
* - Service `bubble`: Your Bubble subdomain.
* - Service `buildium`: Your Buildium subdomain.
* - Service `canvas_by_instructure`: Your Canvas by Instructure domain.
* - Service `chargebee_product_catalog_1`: Your Chargebee Product Catalog 1 subdomain.
* - Service `chargebee_product_catalog_2`: Your Chargebee subdomain.
* - Service `checkr`: Your Checkr subdomain.
* - Service `churnzero`: Your ChurnZero subdomain
* - Service `clubspeed`: Your Clubspeed subdomain.
* - Service `collibra`: Your collibra subdomain.
* - Service `compliance_checkpoint`: Your Compliance Checkpoint subdomain.
* - Service `concord`: Your Concord Sub Domain.
* - Service `contrast_security`: Your Contrast Security subdomain.
* - Service `customerio`: Your Customer.io region-specific Subdomain.
* - Service `dbt_cloud`: Your dbt Cloud API server region.
* - Service `deputy`: Your Deputy subdomain.
* - Service `docebo`: Your Docebo subdomain.
* - Service `drata`: Your Drata sub_domain.
* - Service `eventsforce`: Your Eventsforce subdomain.
* - Service `ezofficeinventory`: Your EZOfficeInventory Subdomain.
* - Service `fountain`: Your Fountain subdomain.
* - Service `freshchat`: Your Freshchat Sub Domain
* - Service `gainsight_customer_success`: The subdomain of your Gainsight account.
* - Service `gainsight_product_experience`: Your Gainsight Product Experience subdomain.
* - Service `genesys`: Your Genesys subdomain.
* - Service `green_power_monitor`: Your GreenPowerMonitor subdomain.
* - Service `h_level`: Your HighLevel subdomain.
* - Service `heartland_retail_pos`: Your Heartland Retail POS subdomain.
* - Service `ilevel`: Your iLevel Environment.
* - Service `infobip`: Your Infobip sub_domain.
* - Service `insightly`: Your company's Insightly subdomain name.
* - Service `instructure`: The Sub domain in which your Instructure account is hosted.
* - Service `jamf`: Your Jamf subdomain.
* - Service `kandji`: Your Kandji Subdomain.
* - Service `khoros_care`: Your Khoros Care subDomain.
* - Service `lattice`: Your Lattice subdomain.
* - Service `looker_source`: Your looker SubDomain name.
* - Service `lucca`: Your Lucca subdomain.
* - Service `mailgun`: Your Mailgun subdomain.
* - Service `matomo`: Your Matomo subdomain.
* - Service `maxio_chargify`: Enter Your Subdomain.
* - Service `myosh`: Your myosh subdomain.
* - Service `namely`: Your Namely subdomain.
* - Service `nylas`: Your Nylas subdomain.
* - Service `odoo`: Your Odoo subdomain.
* - Service `okta`: Your Okta subdomain.
* - Service `onetrust`: Your OneTrust subdomain.
* - Service `oracle_fusion_field_service`: Your Oracle Fusion Field Service subDomain.
* - Service `paylocity`: Your Paylocity subdomain.
* - Service `picqer`: Your Picqer subdomain.
* - Service `pinpoint`: Your Pinpoint sub domain name.
* - Service `piwik_pro`: Your Piwik PRO subdomain.
* - Service `playvox`: Your Playvox Subdomain.
* - Service `posthog`: Your PostHog data region (`app` or `eu`).
* - Service `recurly`: Your company's Recurly subdomain.
* - Service `reltio`: Your Reltio subdomain.
* - Service `revel`: Your Revel Systems subDomain.
* - Service `rundeck`: Your Rundeck subdomain.
* - Service `sage_hr`: Your Sage HR subdomain.
* - Service `salesforce_marketing_cloud`: Your Salesforce Marketing Cloud subdomain.
* - Service `salsify`: Your Salsify Organization ID.
* - Service `sap_success_factors`: Your SAP SuccessFactors Subdomain.
* - Service `sonarqube`: Your Sonarqube subdomain.
* - Service `starrez`: Your StarRez subdomain
* - Service `sugarcrm`: Your SugarCRM subdomain.
* - Service `tableau_source`: Your Tableau Source subdomain.
* - Service `tempo`: Your Tempo subdomain.
* - Service `testrail`: Your TestRail subdomain.
* - Service `thinkific`: Your Thinkific subdomain.
* - Service `totango`: Your Totango Subdomain.
* - Service `tymeshift`: Your Tymeshift subdomain.
* - Service `upland`: Your Upland Software subdomain.
* - Service `validio`: Your Validio subdomain.
* - Service `wordpress`: Your WordPress subdomain.
* - Service `workable`: Your Workable Subdomain.
* - Service `wrike`: Your Wrike Subdomain.
*/
subDomain: string;
/**
* Field usage depends on `service` value:
* - Service `adobe_experience_platform`: Your Adobe Experience Platform IMS region.
* - Service `alation`: Your Alation base URL.
* - Service `bamboohr`: The subdomain used to access your account. If you access BambooHR at 'https://mycompany.bamboohr.com', then the subdomain is 'mycompany'.
* - Service `bynder`: Your Bynder subdomain.
* - Service `datadog`: Your Datadog subdomain.
* - Service `ebay`: Your eBay environment.
* - Service `freshdesk`: Your company's freshdesk subdomain (usually **company**.freshdesk.com).
* - Service `freshsales`: Your Freshsales domain.
* - Service `freshservice`: Your company's freshservice subdomain (usually **company**.freshservice.com).
* - Service `freshsuccess`: Your Freshsuccess subdomain.
* - Service `gorgias`: Your Gorgias subdomain.
* - Service `hex`: Your Hex subdomain.
* - Service `ibacos`: Your Ibacos subdomain.
* - Service `jama_software`: Your Jama Software subdomain.
* - Service `klarna`: Your Klarna subdomain.
* - Service `learnupon`: Your LearnUpon subdomain.
* - Service `maxio_saasoptics`: Your Maxio SaaSOptics subdomain.
* - Service `medallia`: Medallia subdomain
* - Service `packiyo`: Your Packiyo subdomain.
* - Service `qmatic_data_connect`: Your Qmatic Data Connect subdomain.
* - Service `sana`: Your Sana subdomain.
* - Service `showpad`: Your Showpad subdomain.
* - Service `skillstx`: Your SkillsTX subdomain.
* - Service `smarthr`: Your SmartHR subdomain.
* - Service `sonarqube`: Your Sonarqube subdomain.
* - Service `toast`: Your Toast domain.
* - Service `uptempo`: Your Uptempo subdomain.
* - Service `vts`: Your VTS Subdomain.
* - Service `yext`: Your Yext subdomain.
* - Service `zendesk_chat`: Your Zendesk domain.
* - Service `zendesk_workforce_management`: Your Zendesk Workforce Management subdomain.
*/
subdomain: string;
/**
* Field usage depends on `service` value:
* - Service `azure_service_bus`: The subscriber name. If the connection string does not have manage permission, you need to specify a subscriber name we can use to fetch data. If not specified, we default to `fivetran_sub_schema`
*/
subscriberName: string;
/**
* Field usage depends on `service` value:
* - Service `retailnext`: Your RetailNext subscription.
*/
subscription?: string;
/**
* Field usage depends on `service` value:
* - Service `cabcharge`: Your Cabcharge subscription key.
* - Service `dsv`: Your DSV subscription key.
* - Service `national_heavy_vehicle_regulator`: Your NHVR Portal API subscription key.
*/
subscriptionKey?: string;
/**
* Field usage depends on `service` value:
* - Service `stripe`: Sync Connected Accounts. Connected Account Documentation - https://stripe.com/docs/api/connected_accounts.
* - Service `stripe_test`: Sync Connected Accounts. Connected Account Documentation - https://stripe.com/docs/api/connected_accounts.
*/
supportConnectedAccountsSync: boolean;
/**
* Field usage depends on `service` value:
* - Service `workday`: This option is to unpack the nested columns and sync them separately. By default, we sync the nested columns as JSON objects.
*/
supportNestedColumns: boolean;
/**
* Field usage depends on `service` value:
* - Service `qualaroo`: Array of Qualaroo Survey IDs.
*/
surveyIds?: string;
/**
* Field usage depends on `service` value:
* - Service `snapchat_ads`: The time period to attribute conversions based on swipes. Default value: `DAY_28`
*/
swipeAttributionWindow: string;
/**
* Field usage depends on `service` value:
* - Service `microsoft_dynamics_365_fno`: Specify if all versions of the records should be synced. If set to `true`, all versions of the records will be synced. If set to `false`, only the latest version of the records will be synced.
*/
syncAllVersions: boolean;
/**
* Field usage depends on `service` value:
* - Service `appsflyer`: Sync AppsFlyer Data Locker. Default value is `true`, set it to `false` to sync AppsFlyer data using only webhooks.
*/
syncDataLocker: boolean;
/**
* Field usage depends on `service` value:
* - Service `webhooks`: The webhooks sync format. Default value: `Unpacked`. Unpacked messages must be valid JSON.
*/
syncFormat: string;
/**
* Field usage depends on `service` value:
* - Service `financial_force`: Enable this option to sync formula fields directly (default value = `false`)
* - Service `salesforce`: Enable this option to sync formula fields directly (default value = `false`)
* - Service `salesforce_sandbox`: Enable this option to sync formula fields directly (default value = `false`)
*/
syncFormulaFields: boolean;
/**
* Field usage depends on `service` value:
* - Service `facebook_ads`: Parameter defining whether to enable or disable metadata synchronisation. Default value: `TRUE`.
*/
syncMetadata: boolean;
/**
* Field usage depends on `service` value:
* - Service `aws_lambda`: Sync Method
*/
syncMethod: string;
/**
* Field usage depends on `service` value:
* - Service `adroll`: Whether to sync all advertisables or specific advertisables. Default value: `AllAdvertisables`.
* - Service `amazon_ads`: Option to select connector should sync all profiles or specific profiles.
* - Service `anaplan`: Whether to sync all exports or specific exports.
* - Service `apple_search_ads`: Sync Mode
* - Service `asana`: Whether to sync all projects or specific projects.
* - Service `bingads`: Whether to sync all accounts or specific accounts. Default value: `AllAccounts`.
* - Service `double_click_campaign_manager`: Whether to sync all user profiles or specific ones. Default value: `AllAccounts`.
* - Service `dynamodb`: Which packed mode setting to use. Default value: `UsePackedModeOnly`.
* - Service `facebook`: Option to select connector should sync all accounts or specific accounts. [Possible sync_mode values](https://fivetran.com/docs/applications/facebook-ad-insights/api-config#syncmode).
* - Service `facebook_ad_account`: Whether to sync all accounts or specific accounts. Default value: `AllAccounts`.
* - Service `facebook_ads`: Option to select connector should sync all accounts or specific accounts. [Possible sync_mode values](https://fivetran.com/docs/connectors/applications/facebook-ads#syncmode).
* - Service `facebook_pages`: Whether to sync all accounts or specific accounts. Default value: `AllPages`.
* - Service `github`: Whether to sync all repositories or specific repositories.
* - Service `google_ads`: Whether to sync all accounts or specific accounts.
* - Service `google_analytics`: Whether to sync all accounts or specific accounts.
* - Service `google_analytics_4`: Whether to sync all accounts or specific accounts.
* - Service `google_analytics_mcf`: Whether to sync all accounts or specific accounts. Default value: `ALL_ACCOUNTS`
* - Service `google_search_console`: Whether to sync all sites or specific sites.
* - Service `instagram_business`: Whether to sync all accounts or specific accounts. Default value: `AllAccounts`.
* - Service `iterable`: Events Sync Mode.
* - Service `jira`: Whether to sync all projects or specific projects.
* - Service `linkedin_ads`: Whether to sync all accounts or specific accounts. Default value: `AllAccounts`
* - Service `pendo`: Whether to sync all App IDs or specific App IDs. Default value: `AllAppIds`.
* - Service `pinterest_ads`: Whether to sync all advertisers or specific advertisers.
* - Service `reddit_ads`: Whether to sync all accounts or specific accounts.
* - Service `salesforce_marketing_cloud`: Select the sync mode.
* - Service `snapchat_ads`: Whether to sync all organizations or specific organizations. Default value: `AllOrganizations`.
* - Service `spotify_ads`: Whether to sync all ad accounts or specific ad accounts.
* - Service `taboola`: Whether to sync all accounts or specific accounts.
* - Service `the_trade_desk`: Whether to sync all accounts or specific accounts.
* - Service `tiktok_ads`: Whether to sync all advertiser accounts or specific accounts.
* - Service `twilio`: Whether to sync all accounts or specific accounts.
* - Service `twitter`: Whether to sync all accounts or specific accounts. Default value: `AllAccounts`.
* - Service `twitter_ads`: Whether to sync all accounts or specific accounts.
* - Service `walmart_dsp`: Whether to sync all accounts or specific accounts.
* - Service `yahoo_gemini`: Whether to sync all accounts or specific accounts. Default value: `SpecificAccounts`.
* - Service `zuora`: Select `Zuora Billing` to sync exclusively Zuora Billing related records. Choose `Zuora Revenue` for syncing only Zuora Revenue reports. If both Zuora Billing records and Zuora Revenue reports are to be synced, opt for `Both`.
* - Service `zuora_sandbox`: Select `Zuora Billing` to sync exclusively Zuora Billing related records. Choose `Zuora Revenue` for syncing only Zuora Revenue reports. If both Zuora Billing records and Zuora Revenue reports are to be synced, opt for `Both`.
*/
syncMode: string;
/**
* Field usage depends on `service` value:
* - Service `yahoo_dsp`: Whether to sync all advertisers or specific advertisers. Default value: `ALL_ADVERTISERS`.
*/
syncModeAdvertiser: string;
/**
* Field usage depends on `service` value:
* - Service `yahoo_dsp`: Whether to sync all seats or specific seats. Default value: `ALL_SEATS`.
*/
syncModeSeat: string;
/**
* Field usage depends on `service` value:
* - Service `reddit_ads`: When this parameter is set to `true`, we sync the data of the additional linked accounts. When this parameter is set to `false`, we sync only the data from the main account that was used for authorization
*/
syncMultipleAccounts: boolean;
/**
* Field usage depends on `service` value:
* - Service `box`: Optional. Set this to true to sync files from nested folders within the specified folder.
* - Service `dropbox`: Optional. Set this to true to sync files from nested folders within the specified folder.
* - Service `google_drive`: Optional. Set to true to sync files from nested folders within the specified folder.
* - Service `sftp`: Optional. Set to true to sync files from nested folders within the specified folder.
* - Service `share_point`: Optional. Set to true to sync files from nested folders within the specified folder.
*/
syncNestedFiles: boolean;
/**
* Field usage depends on `service` value:
* - Service `cosmos`: The packing mode type. Supported values:`STANDARD_UNPACKED_MODE`- Unpacks _one_ layer of nested fields and infers types.`PACKED_MODE`- Delivers packed data as a single destination column value.Learn more in our [Azure Cosmos DB Sync Pack Mode Options documentation](https://fivetran.com/docs/connectors/databases/cosmos#packmodeoptions).
* - Service `documentdb`: Indicates whether synced data will be packed into a single entry(column), or unpacked with one layer of nested fields.
*/
syncPackMode: string;
/**
* Field usage depends on `service` value:
* - Service `google_drive`: Optional. Set to true to sync per-user file access permissions to control visibility in downstream applications.
* - Service `share_point`: Optional. Set to true to sync per-user file access permissions to control visibility in downstream applications.
*/
syncPermissions: boolean;
/**
* Field usage depends on `service` value:
* - Service `appsflyer`: These options are for Appsflyer's Pull API, and are only necessary for syncing events from Pull API.
*/
syncPullApi: boolean;
/**
* Field usage depends on `service` value:
* - Service `google_analytics_4_export`: Sync Table
*/
syncTables: string;
/**
* Field usage depends on `service` value:
* - Service `apache_kafka`: Kafka sync type. Unpacked messages must be valid JSON.
* - Service `aws_msk`: The sync type. Unpacked messages must be valid JSON.
* - Service `azure_event_hub`: Sync type. Unpacked messages must be valid JSON.
* - Service `azure_service_bus`: The sync type, which is based on the message type. For `text` and `xml`, `packed` is supported. For `protobuf` and `avro`, `unpacked` is supported. For `json`, both `packed` and `unpacked` are supported
* - Service `confluent_cloud`: Kafka sync type. Unpacked messages must be valid JSON.
* - Service `heroku_kafka`: Heroku Kafka sync type. Unpacked messages must be valid JSON.
* - Service `segment`: The Segment connector sync type.
*/
syncType: string;
sysnr?: string;
/**
* Field usage depends on `service` value:
* - Service `hana_sap_hva_ecc_netweaver`: Unique identifier sapsid of the SAP system. This field is displayed only when the REMOTE SERVICE IDENTIFICATION is set to System ID.
* - Service `hana_sap_hva_s4_netweaver`: Unique identifier sapsid of the SAP system. This field is displayed only when the REMOTE SERVICE IDENTIFICATION is set to System ID.
*/
systemId?: string;
/**
* Field usage depends on `service` value:
* - Service `pigment`: Your Pigment table ID.
*/
tableId?: string;
/**
* Field usage depends on `service` value:
* - Service `airtable`: Name of table in Airtable
*/
tableName?: string;
/**
* Field usage depends on `service` value:
* - Service `hubspot`: Timestamp to indicate when tables without access was updated.
*/
tablesWithoutAccessUpdatedAt?: string;
/**
* Field usage depends on `service` value:
* - Service `culture_amp`: Your Culture Amp Target entity ID.
*/
targetEntityId: string;
/**
* Field usage depends on `service` value:
* - Service `d2l_brightspace`: Your D2L Brightspace target host.
*/
targetHost?: string;
/**
* Field usage depends on `service` value:
* - Service `sql_server`: Certificate file path used to protect a database encryption key
* - Service `sql_server_hva`: Certificate used to protect a database encryption key
* - Service `sql_server_sap_ecc_hva`: Certificate used to protect a database encryption key
*/
tdeCertificate?: string;
/**
* Field usage depends on `service` value:
* - Service `sql_server`: Certificate file used to protect a database encryption key. Used when decrypting backup logs.
*/
tdeCertificateBackup?: string;
/**
* Field usage depends on `service` value:
* - Service `sql_server_hva`: Name of the Certificate used to protect a database encryption key
* - Service `sql_server_sap_ecc_hva`: Name of the Certificate used to protect a database encryption key
*/
tdeCertificateName?: string;
/**
* Field usage depends on `service` value:
* - Service `sql_server`: Certificate file path used to protect a database encryption key. Used when decrypting online logs
*/
tdeCertificatePath?: string;
/**
* Field usage depends on `service` value:
* - Service `sql_server`: Password of the TDE private key
* - Service `sql_server_hva`: Password of the TDE private key
* - Service `sql_server_sap_ecc_hva`: Password of the TDE private key
*/
tdePassword?: string;
/**
* Field usage depends on `service` value:
* - Service `sql_server`: Private key file path associated with the TDE certificate
* - Service `sql_server_hva`: Private key associated with the TDE certificate
* - Service `sql_server_sap_ecc_hva`: Private key associated with the TDE certificate
*/
tdePrivateKey?: string;
/**
* Field usage depends on `service` value:
* - Service `sql_server`: Private key file associated with the TDE certificate. Used when decrypting backup logs.
*/
tdePrivateKeyBackup?: string;
/**
* Field usage depends on `service` value:
* - Service `sql_server`: Private key file path associated with the TDE certificate. Used when decrypting online logs.
*/
tdePrivateKeyPath?: string;
/**
* Field usage depends on `service` value:
* - Service `sql_server`: Transparent Data Encryption (TDE) setting. Possible values: `"OFF"`, `"CERTIFICATE"`. Default value is `"OFF"`.
*/
tdeSetting: string;
/**
* Field usage depends on `service` value:
* - Service `oracle_hva`: TDE wallet password. Required for password based wallet.
* - Service `oracle_sap_hva`: TDE wallet password. Required for password based wallet.
* - Service `oracle_sap_hva_netweaver`: TDE wallet password. Required for password based wallet.
*/
tdeWalletPassword?: string;
/**
* Field usage depends on `service` value:
* - Service `asana`: Team ID
*/
teamId?: string;
/**
* Field usage depends on `service` value:
* - Service `adobe_analytics`: Technical Account ID from the Service Account (JWT) credentials of your Adobe Project.
*/
technicalAccountId: string;
/**
* Field usage depends on `service` value:
* - Service `mandrill`: Provide the labels to filter the templates
*/
templateLabels?: string[];
/**
* Field usage depends on `service` value:
* - Service `microsoft_entra_id`: Your Microsoft Entra ID Tenant.
* - Service `microsoft_power_bi`: Your Microsoft Power BI tenant.
* - Service `microsoft_teams`: Your Microsoft Teams Tenant.
* - Service `unicommerce`: Your uniware tenant.
* - Service `workday`: Workday tenant name
* - Service `workday_financial_management`: Workday tenant name
* - Service `workday_hcm`: Workday tenant name
*/
tenant?: string;
/**
* Field usage depends on `service` value:
* - Service `planful`: Your Planful tenant app URL.
*/
tenantAppUrl?: string;
/**
* Field usage depends on `service` value:
* - Service `deposco`: Your Deposco tenant code.
*/
tenantCode?: string;
tenantConfigs?: outputs.ConnectorConfigTenantConfig[];
/**
* Field usage depends on `service` value:
* - Service `azure_sql_db`: Azure AD tenant ID.
* - Service `azure_sql_managed_db`: Azure AD tenant ID.
* - Service `business_central`: `Tenant ID` of your Business Central application
* - Service `crowddev`: Your crowd.dev Tenant ID.
* - Service `microsoft_teams`: Your Microsoft Teams tenant ID.
* - Service `reltio`: Your Reltio tenant ID.
* - Service `servicetitan`: Your ServiceTitan tenant ID.
* - Service `share_point`: `Tenant ID` of your Microsoft client application.
* - Service `visma`: Your Visma tenant ID.
*/
tenantId?: string;
/**
* Field usage depends on `service` value:
* - Service `mambu`: Your Mambu tenant name.
*/
tenantName?: string;
/**
* Field usage depends on `service` value:
* - Service `ivanti`: Your Ivanti Tenant URL.
* - Service `playvox_workforce_management`: Your Playvox Workforce Management tenant URL.
* - Service `reltio`: Your Reltio tenant URL.
*/
tenantUrl?: string;
/**
* Field usage depends on `service` value:
* - Service `sap_hana`: testTableName
* - Service `sap_s4hana`: testTableName
*/
testTableName: string;
/**
* Field usage depends on `service` value:
* - Service `pardot`: The time zone configured in your Pardot instance. An empty value defaults to `UTC+00:00`.
* - Service `pardot_sandbox`: The time zone configured in your Pardot instance. An empty value defaults to `UTC+00:00`.
*/
timeZone: string;
/**
* Field usage depends on `service` value:
* - Service `adobe_analytics`: Number of months' worth of reporting data you'd like to include in your initial sync. This cannot be modified once the connector has been created. Default value: `TWELVE` .
* - Service `adroll`: Number of months' worth of reporting data you'd like to include in your initial sync. This cannot be modified once the connector is created. Default value: `TWELVE`.
* - Service `apple_search_ads`: Number of months' worth of reporting data you'd like to include in your initial sync. This cannot be modified once connection is created. NOTE: The more months of reporting data you sync, the longer your initial sync will take.
* - Service `bingads`: Number of months' worth of reporting data you'd like to include in your initial sync. This cannot be modified once the connector is created. Default value: `SIX`.
* - Service `criteo`: The number of months' worth of reporting data you'd like to include in your initial sync. This cannot be modified once the connector is created. NOTE: The greater number of months means the initial sync will take more time.
* - Service `double_click_campaign_manager`: Number of months' worth of reporting data you'd like to include in your initial sync. A change of this value will trigger a re-sync for enabled reports during the next connector sync. Default value: `TWELVE`.
* - Service `double_click_publishers`: Number of months' worth of reporting data you'd like to include in your initial sync. A change of this value will trigger a re-sync for enabled reports during the next connector sync.
* - Service `facebook`: Number of months' worth of reporting data you'd like to include in your initial sync. This cannot be modified once the connector is created. Default value: `THREE`.
* - Service `facebook_ads`: Number of months' worth of reporting data you'd like to include in your initial sync. This cannot be modified once the connector is created. Default value: `THREE`.
* - Service `google_ads`: The number of months' worth of reporting data you'd like to include in your initial sync. A change of this value will trigger a re-sync for enabled custom and prebuilt reports during the next connector sync. Default value: `TWELVE`.
* - Service `google_analytics`: Number of months' worth of reporting data you'd like to include in your initial sync. A change of this value will trigger a re-sync for enabled reports during the next connector sync. The default value: `TWELVE`.
* - Service `google_analytics_4`: The number of months' worth of reporting data you'd like to include in your initial sync. A change of this value will trigger a re-sync for enabled reports during the next connector sync. The default value: `TWELVE`.
* - Service `google_analytics_mcf`: Number of months' worth of reporting data you'd like to include in your initial sync. A change of this value will trigger a re-sync for enabled reports during the next connector sync. Default value: `TWELVE`.
* - Service `google_display_and_video_360`: Number of months' worth of reporting data you'd like to include in your initial sync. A change of this value will trigger a re-sync for enabled reports during the next connector sync. NOTE: The more months of reporting data you sync, the longer your initial sync will take.
* - Service `google_search_ads_360`: Number of months' worth of reporting data you'd like to include in your initial sync. A change of this value will trigger a re-sync for enabled reports during the next connector sync.
* - Service `google_search_console`: Number of months' worth of reporting data you'd like to include in your initial sync. A change of this value will trigger a re-sync for enabled reports during the next connector sync.
* - Service `instagram_business`: Number of months' worth of data you'd like to include in your initial sync. This cannot be modified once the connector is created. Default value: `SIX`.
* - Service `itunes_connect`: Historical sync time frame in months.
* - Service `linkedin_ads`: Number of months for which to query reporting data included in the initial sync. This number cannot be modified once the connector is created. Default value: `ALL_TIME`.
* - Service `outbrain`: Number of months' worth of reporting data you'd like to include in your initial sync. This cannot be modified once connection is created. NOTE: The more months of reporting data you sync, the longer your initial sync will take.
* - Service `pinterest_ads`: Number of months' worth of reporting data you'd like to include in your initial sync. This cannot be modified once the connector is created. Default value: `THREE`.
* - Service `reddit_ads`: Number of months' worth of reporting data you'd like to include in your initial sync. This cannot be modified once the connector is created. Default value: `TWELVE`.
* - Service `snapchat_ads`: Number of months' worth of reporting data you'd like to include in your initial sync. This cannot be modified once the connector is created. Default value: `TWELVE`.
* - Service `spotify_ads`: The number of months' worth of reporting data you'd like to include in your initial sync. This cannot be modified once the connector is created. Default value: `SIX`.
* - Service `taboola`: Number of months' worth of reporting data you'd like to include in your initial sync. This cannot be modified once connection is created. NOTE: The more months of reporting data you sync, the longer your initial sync will take.
* - Service `the_trade_desk`: Number of months' worth of data you'd like to include in your initial sync. This cannot be modified once the connector is created. Default value: `THREE`.
* - Service `tiktok_ads`: Number of months' worth of reporting data you'd like to include in your initial sync. This cannot be modified once the connector is created. Default value: `THREE`.
* - Service `twitter`: Number of months' worth of data you'd like to include in your initial sync. This cannot be modified once the connector is created. Default value: `THREE`.
* - Service `twitter_ads`: Historical sync timeframe in months.
* - Service `walmart_dsp`: Number of months' worth of data you'd like to include in your initial sync. This cannot be modified once the connector is created. Default value: `THREE`.
* - Service `yahoo_dsp`: Number of months` worth of reporting data you'd like to include in your initial sync. This cannot be modified once the connector is created. Default value: `THREE`.
* - Service `yahoo_gemini`: Number of months' worth of reporting data you'd like to include in your initial sync. This cannot be modified once the connector is created. Default value: `TWELVE`.
*/
timeframeMonths: string;
/**
* Field usage depends on `service` value:
* - Service `rokt`: Your Rokt timezone.
*/
timezone: string;
/**
* Field usage depends on `service` value:
* - Service `apple_search_ads`: Determines whether to use UTC or the users timezone from the apple account
*/
timezoneMode: string;
/**
* Field usage depends on `service` value:
* - Service `oracle_hva`: Single-tenant database: The database's SID. Multi-tenant database: The database's TNS.
* - Service `oracle_sap_hva`: Single-tenant database: The database SID. Multi-tenant database: The database TNS.
*/
tns: string;
/**
* Field usage depends on `service` value:
* - Service `toast`: Your Toast Restaurant External ID.
*/
toastId?: string;
/**
* Field usage depends on `service` value:
* - Service `khoros_communities`: Your Khoros Communities token.
* - Service `matomo`: Your Matomo auth token.
* - Service `mode`: Your Mode Token.
* - Service `oracle_moat_analytics`: Your Oracle Moat Analytics Token.
* - Service `shareasale`: Your ShareASale token.
* - Service `solarwinds_service_desk`: Your SolarWinds Service Desk token.
*/
token?: string;
/**
* Field usage depends on `service` value:
* - Service `cosmos`: The container name. Required for the `RESOURCE_TOKEN` data access method.
*/
tokenAuthenticatedContainer?: string;
/**
* Field usage depends on `service` value:
* - Service `cosmos`: The database name. Required for the `RESOURCE_TOKEN` data access method.
*/
tokenAuthenticatedDatabase?: string;
/**
* Field usage depends on `service` value:
* - Service `chargedesk`: Your ChargeDesk token ID.
* - Service `mux`: Your Mux token ID
*/
tokenId?: string;
/**
* Field usage depends on `service` value:
* - Service `netsuite_suiteanalytics`: Token ID
* - Service `on24`: Your ON24 token key.
* - Service `proofpoint_security_awareness`: Your Proofpoint Security Awareness Token Key.
*/
tokenKey: string;
/**
* Field usage depends on `service` value:
* - Service `netsuite_suiteanalytics`: Token Secret
* - Service `on24`: Your ON24 token secret.
*/
tokenSecret: string;
/**
* Field usage depends on `service` value:
* - Service `mux`: Your Mux token secret key
*/
tokenSecretKey?: string;
/**
* Field usage depends on `service` value:
* - Service `amazon_dsp`: Your Amazon DSP token URL region.
*/
tokenUrlRegion: string;
/**
* Field usage depends on `service` value:
* - Service `azure_service_bus`: The comma-separated list of topics which should be synced. Required if you do not have manage permissions
*/
topics?: string[];
/**
* Field usage depends on `service` value:
* - Service `dsv`: Your DSV Tracking subscription key.
*/
trackingSubscriptionKey?: string;
/**
* Field usage depends on `service` value:
* - Service `heroku_kafka`: Trust Store Type
*/
trustStoreType?: string;
/**
* Field usage depends on `service` value:
* - Service `apache_kafka`: Kafka trusted certificate.
* - Service `heroku_kafka`: Heroku Kafka trusted certificate. Required for `TLS` security protocol.
*/
trustedCert?: string;
/**
* Field usage depends on `service` value:
* - Service `aws_msk`: If `security_protocol` is set to `TLS`, add the `Truststore File` as Base64 encoded string.
*/
truststore?: string;
/**
* Field usage depends on `service` value:
* - Service `aurora`: SSH host, specify only to connect via an SSH tunnel (do not use a load balancer).
* - Service `aurora_postgres`: SSH host, specify only to connect via an SSH tunnel (do not use a load balancer).
* - Service `aveva_pi`: SSH host, specify only to connect via an SSH tunnel (do not use a load balancer).
* - Service `azure_cosmos_for_mongo`: SSH host, specify only to connect via an SSH tunnel (do not use a load balancer).
* - Service `azure_postgres`: SSH host, specify only to connect via an SSH tunnel (do not use a load balancer).
* - Service `azure_sql_db`: SSH host, specify only to connect via an SSH tunnel (do not use a load balancer).
* - Service `azure_sql_managed_db`: SSH host, specify only to connect via an SSH tunnel (do not use a load balancer).
* - Service `clarity`: SSH host, specify only to connect via an SSH tunnel (do not use a load balancer).
* - Service `cockroachdb`: SSH host, specify only to connect via an SSH tunnel (do not use a load balancer).
* - Service `db2i_hva`: SSH host, only specify when connecting via an SSH tunnel (do not use a load balancer). Required for connector creation.
* - Service `db2i_sap_hva`: SSH host, specify only to connect via an SSH tunnel (do not use a load balancer).
* - Service `db2luw`: SSH host, only specify when connecting via an SSH tunnel (do not use a load balancer). Required for connector creation.
* - Service `db2z`: SSH host, specify only to connect via an SSH tunnel (do not use a load balancer).
* - Service `documentdb`: SSH host, only specify when connecting via an SSH tunnel (do not use a load balancer). Required for connector creation.
* - Service `dynamics_365_fo`: SSH host, specify only to connect via an SSH tunnel (do not use a load balancer).
* - Service `ehr`: SSH host, specify only to connect via an SSH tunnel (do not use a load balancer).
* - Service `elastic_cloud`: SSH host, specify only to connect using an SSH tunnel (do not use a load balancer).
* - Service `epic_clarity`: SSH host, specify only to connect via an SSH tunnel (do not use a load balancer).
* - Service `es_self_hosted`: SSH host, specify only to connect using an SSH tunnel (do not use a load balancer).
* - Service `google_cloud_mysql`: SSH host, specify only to connect via an SSH tunnel (do not use a load balancer).
* - Service `google_cloud_postgresql`: SSH host, specify only to connect via an SSH tunnel (do not use a load balancer).
* - Service `google_cloud_sqlserver`: SSH host, only specify when connecting via an SSH tunnel (do not use a load balancer).
* - Service `hana_sap_hva_b1`: SSH host, specify only to connect via an SSH tunnel (do not use a load balancer).
* - Service `hana_sap_hva_ecc`: SSH host, specify only to connect via an SSH tunnel (do not use a load balancer).
* - Service `hana_sap_hva_ecc_netweaver`: SSH host, specify only to connect via an SSH tunnel (do not use a load balancer).
* - Service `hana_sap_hva_s4`: SSH host, specify only to connect via an SSH tunnel (do not use a load balancer).
* - Service `hana_sap_hva_s4_netweaver`: SSH host, specify only to connect via an SSH tunnel (do not use a load balancer).
* - Service `heroku_postgres`: SSH host, specify only to connect via an SSH tunnel (do not use a load balancer).
* - Service `magento_mysql`: SSH host, specify only to connect via an SSH tunnel (do not use a load balancer).
* - Service `magento_mysql_rds`: SSH host, specify only to connect via an SSH tunnel (do not use a load balancer).
* - Service `maria`: SSH host, specify only to connect via an SSH tunnel (do not use a load balancer).
* - Service `maria_azure`: SSH host, specify only to connect via an SSH tunnel (do not use a load balancer).
* - Service `maria_rds`: SSH host, specify only to connect via an SSH tunnel (do not use a load balancer).
* - Service `mongo`: SSH host, specify only to connect via an SSH tunnel (do not use a load balancer).
* - Service `mongo_sharded`: SSH host, specify only to connect via an SSH tunnel (do not use a load balancer).
* - Service `mysql`: SSH host, specify only to connect via an SSH tunnel (do not use a load balancer).
* - Service `mysql_azure`: SSH host, specify only to connect via an SSH tunnel (do not use a load balancer).
* - Service `mysql_rds`: SSH host, specify only to connect via an SSH tunnel (do not use a load balancer).
* - Service `opendistro`: SSH host, specify only to connect using an SSH tunnel (do not use a load balancer).
* - Service `opensearch`: SSH host, specify only to connect using an SSH tunnel (do not use a load balancer).
* - Service `oracle`: SSH host, specify only to connect via an SSH tunnel (do not use a load balancer).
* - Service `oracle_ebs`: SSH host, specify only to connect via an SSH tunnel (do not use a load balancer).
* - Service `oracle_hva`: SSH host, specify only to connect via an SSH tunnel (do not use a load balancer).
* - Service `oracle_rac`: SSH host, specify only to connect via an SSH tunnel (do not use a load balancer).
* - Service `oracle_rds`: SSH host, specify only to connect via an SSH tunnel (do not use a load balancer).
* - Service `oracle_sap_hva`: SSH host, specify only to connect via an SSH tunnel (do not use a load balancer).
* - Service `oracle_sap_hva_netweaver`: SSH host, specify only to connect via an SSH tunnel (do not use a load balancer).
* - Service `postgres`: SSH host, specify only to connect via an SSH tunnel (do not use a load balancer).
* - Service `postgres_rds`: SSH host, specify only to connect via an SSH tunnel (do not use a load balancer).
* - Service `sap_hana`: SSH host, specify only to connect via an SSH tunnel (do not use a load balancer).
* - Service `sap_hana_db`: SSH host, specify only to connect via an SSH tunnel (do not use a load balancer).
* - Service `sap_s4hana`: SSH host, specify only to connect via an SSH tunnel (do not use a load balancer).
* - Service `sftp`: Tunnel host address, specify only to connect via SSH tunnel.
* - Service `sql_server`: SSH host, specify only to connect via an SSH tunnel (do not use a load balancer).
* - Service `sql_server_hva`: SSH host, specify only to connect via an SSH tunnel (do not use a load balancer).
* - Service `sql_server_rds`: SSH host, specify only to connect via an SSH tunnel (do not use a load balancer).
* - Service `sql_server_sap_ecc_hva`: SSH host, specify only to connect via an SSH tunnel (do not use a load balancer).
*/
tunnelHost?: string;
/**
* Field usage depends on `service` value:
* - Service `aurora`: SSH port, specify only to connect via an SSH tunnel.
* - Service `aurora_postgres`: SSH port, specify only to connect via an SSH tunnel.
* - Service `aveva_pi`: SSH port, specify only to connect via an SSH tunnel.
* - Service `azure_cosmos_for_mongo`: SSH port, specify only to connect via an SSH tunnel.
* - Service `azure_postgres`: SSH port, specify only to connect via an SSH tunnel.
* - Service `azure_sql_db`: SSH port, specify only to connect via an SSH tunnel.
* - Service `azure_sql_managed_db`: SSH port, specify only to connect via an SSH tunnel.
* - Service `clarity`: SSH port, specify only to connect via an SSH tunnel.
* - Service `cockroachdb`: SSH port, specify only to connect via an SSH tunnel.
* - Service `db2i_hva`: SSH port, only specify when connecting via an SSH tunnel. Required for connector creation.
* - Service `db2i_sap_hva`: SSH port, specify only to connect via an SSH tunnel.
* - Service `db2luw`: SSH port, only specify when connecting via an SSH tunnel. Required for connector creation.
* - Service `db2z`: SSH port, specify only to connect via an SSH tunnel.
* - Service `documentdb`: SSH port, only specify when connecting via an SSH tunnel. Required for connector creation.
* - Service `dynamics_365_fo`: SSH port, specify only to connect via an SSH tunnel.
* - Service `ehr`: SSH port, specify only to connect via an SSH tunnel.
* - Service `elastic_cloud`: SSH port, specify only to connect using an SSH tunnel.
* - Service `epic_clarity`: SSH port, specify only to connect via an SSH tunnel.
* - Service `es_self_hosted`: SSH port, specify only to connect using an SSH tunnel.
* - Service `google_cloud_mysql`: SSH port, specify only to connect via an SSH tunnel.
* - Service `google_cloud_postgresql`: SSH port, specify only to connect via an SSH tunnel.
* - Service `google_cloud_sqlserver`: SSH port, only specify when connecting via an SSH tunnel.
* - Service `hana_sap_hva_b1`: SSH port, specify only to connect via an SSH tunnel.
* - Service `hana_sap_hva_ecc`: SSH port, specify only to connect via an SSH tunnel.
* - Service `hana_sap_hva_ecc_netweaver`: SSH port, specify only to connect via an SSH tunnel.
* - Service `hana_sap_hva_s4`: SSH port, specify only to connect via an SSH tunnel.
* - Service `hana_sap_hva_s4_netweaver`: SSH port, specify only to connect via an SSH tunnel.
* - Service `heroku_postgres`: SSH port, specify only to connect via an SSH tunnel.
* - Service `magento_mysql`: SSH port, specify only to connect via an SSH tunnel.
* - Service `magento_mysql_rds`: SSH port, specify only to connect via an SSH tunnel.
* - Service `maria`: SSH port, specify only to connect via an SSH tunnel.
* - Service `maria_azure`: SSH port, specify only to connect via an SSH tunnel.
* - Service `maria_rds`: SSH port, specify only to connect via an SSH tunnel.
* - Service `mongo`: SSH port, specify only to connect via an SSH tunnel.
* - Service `mongo_sharded`: SSH port, specify only to connect via an SSH tunnel.
* - Service `mysql`: SSH port, specify only to connect via an SSH tunnel.
* - Service `mysql_azure`: SSH port, specify only to connect via an SSH tunnel.
* - Service `mysql_rds`: SSH port, specify only to connect via an SSH tunnel.
* - Service `opendistro`: SSH port, specify only to connect using an SSH tunnel.
* - Service `opensearch`: SSH port, specify only to connect using an SSH tunnel.
* - Service `oracle`: SSH port, specify only to connect via an SSH tunnel.
* - Service `oracle_ebs`: SSH port, specify only to connect via an SSH tunnel.
* - Service `oracle_hva`: SSH port, specify only to connect via an SSH tunnel.
* - Service `oracle_rac`: SSH port, specify only to connect via an SSH tunnel.
* - Service `oracle_rds`: SSH port, specify only to connect via an SSH tunnel.
* - Service `oracle_sap_hva`: SSH port, specify only to connect via an SSH tunnel.
* - Service `oracle_sap_hva_netweaver`: SSH port, specify only to connect via an SSH tunnel.
* - Service `postgres`: SSH port, specify only to connect via an SSH tunnel.
* - Service `postgres_rds`: SSH port, specify only to connect via an SSH tunnel.
* - Service `sap_hana`: SSH port, specify only to connect via an SSH tunnel.
* - Service `sap_hana_db`: SSH port, specify only to connect via an SSH tunnel.
* - Service `sap_s4hana`: SSH port, specify only to connect via an SSH tunnel.
* - Service `sftp`: Tunnel port, specify only to connect via SSH tunnel.
* - Service `sql_server`: SSH port, specify only to connect via an SSH tunnel.
* - Service `sql_server_hva`: SSH port, specify only to connect via an SSH tunnel.
* - Service `sql_server_rds`: SSH port, specify only to connect via an SSH tunnel.
* - Service `sql_server_sap_ecc_hva`: SSH port, specify only to connect via an SSH tunnel.
*/
tunnelPort: number;
/**
* Field usage depends on `service` value:
* - Service `aurora`: SSH user, specify only to connect via an SSH tunnel.
* - Service `aurora_postgres`: SSH user, specify only to connect via an SSH tunnel.
* - Service `aveva_pi`: SSH user, specify only to connect via an SSH tunnel.
* - Service `azure_cosmos_for_mongo`: SSH user, specify only to connect via an SSH tunnel.
* - Service `azure_postgres`: SSH user, specify only to connect via an SSH tunnel.
* - Service `azure_sql_db`: SSH user, specify only to connect via an SSH tunnel.
* - Service `azure_sql_managed_db`: SSH user, specify only to connect via an SSH tunnel.
* - Service `clarity`: SSH user, specify only to connect via an SSH tunnel.
* - Service `cockroachdb`: SSH user, specify only to connect via an SSH tunnel.
* - Service `db2i_hva`: SSH user, specify only to connect via an SSH tunnel. Required for connector creation.
* - Service `db2i_sap_hva`: SSH user, specify only to connect via an SSH tunnel.
* - Service `db2luw`: SSH user, specify only to connect via an SSH tunnel. Required for connector creation.
* - Service `db2z`: SSH user, specify only to connect via an SSH tunnel.
* - Service `documentdb`: SSH user, specify only to connect via an SSH tunnel. Required for connector creation.
* - Service `dynamics_365_fo`: SSH user, specify only to connect via an SSH tunnel.
* - Service `ehr`: SSH user, specify only to connect via an SSH tunnel.
* - Service `elastic_cloud`: SSH user, specify only to connect using an SSH tunnel.
* - Service `epic_clarity`: SSH user, specify only to connect via an SSH tunnel.
* - Service `es_self_hosted`: SSH user, specify only to connect using an SSH tunnel.
* - Service `google_cloud_mysql`: SSH user, specify only to connect via an SSH tunnel.
* - Service `google_cloud_postgresql`: SSH user, specify only to connect via an SSH tunnel.
* - Service `google_cloud_sqlserver`: SSH user, only specify when connecting via an SSH tunnel.
* - Service `hana_sap_hva_b1`: SSH user, specify only to connect via an SSH tunnel.
* - Service `hana_sap_hva_ecc`: SSH user, specify only to connect via an SSH tunnel.
* - Service `hana_sap_hva_ecc_netweaver`: SSH user, specify only to connect via an SSH tunnel.
* - Service `hana_sap_hva_s4`: SSH user, specify only to connect via an SSH tunnel.
* - Service `hana_sap_hva_s4_netweaver`: SSH user, specify only to connect via an SSH tunnel.
* - Service `heroku_postgres`: SSH user, specify only to connect via an SSH tunnel.
* - Service `magento_mysql`: SSH user, specify only to connect via an SSH tunnel.
* - Service `magento_mysql_rds`: SSH user, specify only to connect via an SSH tunnel.
* - Service `maria`: SSH user, specify only to connect via an SSH tunnel.
* - Service `maria_azure`: SSH user, specify only to connect via an SSH tunnel.
* - Service `maria_rds`: SSH user, specify only to connect via an SSH tunnel.
* - Service `mongo`: SSH user, specify only to connect via an SSH tunnel.
* - Service `mongo_sharded`: SSH user, specify only to connect via an SSH tunnel.
* - Service `mysql`: SSH user, specify only to connect via an SSH tunnel.
* - Service `mysql_azure`: SSH user, specify only to connect via an SSH tunnel.
* - Service `mysql_rds`: SSH user, specify only to connect via an SSH tunnel.
* - Service `opendistro`: SSH user, specify only to connect using an SSH tunnel.
* - Service `opensearch`: SSH user, specify only to connect using an SSH tunnel.
* - Service `oracle`: SSH user, specify only to connect via an SSH tunnel.
* - Service `oracle_ebs`: SSH user, specify only to connect via an SSH tunnel.
* - Service `oracle_hva`: SSH user, specify only to connect via an SSH tunnel.
* - Service `oracle_rac`: SSH user, specify only to connect via an SSH tunnel.
* - Service `oracle_rds`: SSH user, specify only to connect via an SSH tunnel.
* - Service `oracle_sap_hva`: SSH user, specify only to connect via an SSH tunnel.
* - Service `oracle_sap_hva_netweaver`: SSH user, specify only to connect via an SSH tunnel.
* - Service `postgres`: SSH user, specify only to connect via an SSH tunnel.
* - Service `postgres_rds`: SSH user, specify only to connect via an SSH tunnel.
* - Service `sap_hana`: SSH user, specify only to connect via an SSH tunnel.
* - Service `sap_hana_db`: SSH user, specify only to connect via an SSH tunnel.
* - Service `sap_s4hana`: SSH user, specify only to connect via an SSH tunnel.
* - Service `sftp`: Tunnel user, specify only to connect via SSH tunnel.
* - Service `sql_server`: SSH user, specify only to connect via an SSH tunnel.
* - Service `sql_server_hva`: SSH user, specify only to connect via an SSH tunnel.
* - Service `sql_server_rds`: SSH user, specify only to connect via an SSH tunnel.
* - Service `sql_server_sap_ecc_hva`: SSH user, specify only to connect via an SSH tunnel.
*/
tunnelUser?: string;
/**
* Field usage depends on `service` value:
* - Service `akamai`: Your Akamai type name.
* - Service `bubble`: Your Bubble type name.
*/
typeName?: string;
uniqueId: string;
/**
* Field usage depends on `service` value:
* - Service `google_display_and_video_360`: Specifies whether the configuration is updated before each sync or only when the connector settings are saved. This parameter only takes effect when `config_method` is set to `REUSE_EXISTING`. The default value is `true`.
*/
updateConfigOnEachSync: boolean;
/**
* Field usage depends on `service` value:
* - Service `aurora`: The method to detect new or changed rows. Supported values:`BINLOG` - Fivetran uses your binary logs (also called binlogs) to request only the data that has changed since our last sync. This is the default value if no value is specified. `TELEPORT` - Fivetran's proprietary replication method that uses compressed snapshots to detect and apply changes.
* - Service `aurora_postgres`: The method to detect new or changed rows. Specify only for `"service": "postgres"` or `"service": "postgres_rds"`. Supported values:`WAL_PGOUTPUT` - logical replication of the WAL using the pgoutput plugin. This method replicates new, changed, and deleted rows by tailing the write-ahead log (WAL) using a logical slot. This is more efficient than the query-based method, but requires more setup and monitoring.`QUERY_BASED` - this method replicates new, changed and deleted rows via the `xmin` and `ctid` system columns
* - Service `azure_postgres`: The method to detect new or changed rows. Specify only for `"service": "postgres"` or `"service": "postgres_rds"`. Supported values:`WAL_PGOUTPUT` - logical replication of the WAL using the pgoutput plugin. This method replicates new, changed, and deleted rows by tailing the write-ahead log (WAL) using a logical slot. This is more efficient than the query-based method, but requires more setup and monitoring.`QUERY_BASED` - this method replicates new, changed and deleted rows via the `xmin` and `ctid` system columns
* - Service `azure_sql_db`: (Optional) The incremental update method the connector will use. The possible values are `"TELEPORT"` or `"NATIVE_UPDATE"`. The type defaults to `"NATIVE_UPDATE"` if the value is set to `null` or not specified.
* - Service `azure_sql_managed_db`: (Optional) The incremental update method the connector will use. The possible values are `"TELEPORT"` or `"NATIVE_UPDATE"`. The type defaults to `"NATIVE_UPDATE"` if the value is set to `null` or not specified.
* - Service `clarity`: (Optional) The incremental update method the connector will use. The possible values are `"TELEPORT"` or `"NATIVE_UPDATE"`. The type defaults to `"NATIVE_UPDATE"` if the value is set to `null` or not specified.
* - Service `dynamics_365_fo`: Update Method
* - Service `ehr`: (Optional) The incremental update method the connector will use. The possible values are `"TELEPORT"` or `"NATIVE_UPDATE"`. The type defaults to `"NATIVE_UPDATE"` if the value is set to `null` or not specified.
* - Service `epic_clarity`: (Optional) The incremental update method the connector will use. The possible values are `"TELEPORT"` or `"NATIVE_UPDATE"`. The type defaults to `"NATIVE_UPDATE"` if the value is set to `null` or not specified.
* - Service `google_cloud_mysql`: The method to detect new or changed rows. Supported values:`BINLOG` - Fivetran uses your binary logs (also called binlogs) to request only the data that has changed since our last sync. This is the default value if no value is specified. `TELEPORT` - Fivetran's proprietary replication method that uses compressed snapshots to detect and apply changes.
* - Service `google_cloud_postgresql`: The method to detect new or changed rows. Specify only for `"service": "postgres"` or `"service": "postgres_rds"`. Supported values:`WAL_PGOUTPUT` - logical replication of the WAL using the pgoutput plugin. This method replicates new, changed, and deleted rows by tailing the write-ahead log (WAL) using a logical slot. This is more efficient than the query-based method, but requires more setup and monitoring.`QUERY_BASED` - this method replicates new, changed and deleted rows via the `xmin` and `ctid` system columns
* - Service `google_cloud_sqlserver`: (Optional) The incremental update method the connector will use. The possible values are `"TELEPORT"` or `"NATIVE_UPDATE"`. The type defaults to `"NATIVE_UPDATE"` if the value is set to `null` or not specified.
* - Service `heroku_postgres`: The method to detect new or changed rows. Specify only for `"service": "postgres"` or `"service": "postgres_rds"`. Supported values:`WAL_PGOUTPUT` - logical replication of the WAL using the pgoutput plugin. This method replicates new, changed, and deleted rows by tailing the write-ahead log (WAL) using a logical slot. This is more efficient than the query-based method, but requires more setup and monitoring.`QUERY_BASED` - this method replicates new, changed and deleted rows via the `xmin` and `ctid` system columns
* - Service `magento_mysql`: The method to detect new or changed rows. Supported values:`BINLOG` - Fivetran uses your binary logs (also called binlogs) to request only the data that has changed since our last sync. This is the default value if no value is specified. `TELEPORT` - Fivetran's proprietary replication method that uses compressed snapshots to detect and apply changes.
* - Service `magento_mysql_rds`: The method to detect new or changed rows. Supported values:`BINLOG` - Fivetran uses your binary logs (also called binlogs) to request only the data that has changed since our last sync. This is the default value if no value is specified. `TELEPORT` - Fivetran's proprietary replication method that uses compressed snapshots to detect and apply changes.
* - Service `maria`: The method to detect new or changed rows. Supported values:`BINLOG` - Fivetran uses your binary logs (also called binlogs) to request only the data that has changed since our last sync. This is the default value if no value is specified. `TELEPORT` - Fivetran's proprietary replication method that uses compressed snapshots to detect and apply changes.
* - Service `maria_azure`: The method to detect new or changed rows. Supported values:`BINLOG` - Fivetran uses your binary logs (also called binlogs) to request only the data that has changed since our last sync. This is the default value if no value is specified. `TELEPORT` - Fivetran's proprietary replication method that uses compressed snapshots to detect and apply changes.
* - Service `maria_rds`: The method to detect new or changed rows. Supported values:`BINLOG` - Fivetran uses your binary logs (also called binlogs) to request only the data that has changed since our last sync. This is the default value if no value is specified. `TELEPORT` - Fivetran's proprietary replication method that uses compressed snapshots to detect and apply changes.
* - Service `mysql`: The method to detect new or changed rows. Supported values:`BINLOG` - Fivetran uses your binary logs (also called binlogs) to request only the data that has changed since our last sync. This is the default value if no value is specified. `TELEPORT` - Fivetran's proprietary replication method that uses compressed snapshots to detect and apply changes.
* - Service `mysql_azure`: The method to detect new or changed rows. Supported values:`BINLOG` - Fivetran uses your binary logs (also called binlogs) to request only the data that has changed since our last sync. This is the default value if no value is specified. `TELEPORT` - Fivetran's proprietary replication method that uses compressed snapshots to detect and apply changes.
* - Service `mysql_rds`: The method to detect new or changed rows. Supported values:`BINLOG` - Fivetran uses your binary logs (also called binlogs) to request only the data that has changed since our last sync. This is the default value if no value is specified. `TELEPORT` - Fivetran's proprietary replication method that uses compressed snapshots to detect and apply changes.
* - Service `oracle`: The method used to detect new or changed rows. Supported values: - `LOGMINER` - Fivetran uses LogMiner, a utility that is part of Oracle Database, to detect modified rows in the source tables. - `TELEPORT` - Fivetran's proprietary replication method that uses compressed snapshots to detect and apply changes.
* - Service `oracle_ebs`: The method used to detect new or changed rows. Supported values: - `LOGMINER` - Fivetran uses LogMiner, a utility that is part of Oracle Database, to detect modified rows in the source tables. - `TELEPORT` - Fivetran's proprietary replication method that uses compressed snapshots to detect and apply changes.
* - Service `oracle_hva`: The method used to detect new or changed rows. Supported values: - `LOGMINER` - Fivetran uses LogMiner, a utility that is part of Oracle Database, to detect modified rows in the source tables. - `TELEPORT` - Fivetran's proprietary replication method that uses compressed snapshots to detect and apply changes.
* - Service `oracle_rac`: The method used to detect new or changed rows. Supported values: - `LOGMINER` - Fivetran uses LogMiner, a utility that is part of Oracle Database, to detect modified rows in the source tables. - `TELEPORT` - Fivetran's proprietary replication method that uses compressed snapshots to detect and apply changes.
* - Service `oracle_rds`: The method used to detect new or changed rows. Supported values: - `LOGMINER` - Fivetran uses LogMiner, a utility that is part of Oracle Database, to detect modified rows in the source tables. - `TELEPORT` - Fivetran's proprietary replication method that uses compressed snapshots to detect and apply changes.
* - Service `oracle_sap_hva`: The method used to detect new or changed rows. Supported values: - `LOGMINER` - Fivetran uses LogMiner, a utility that is part of Oracle Database, to detect modified rows in the source tables. - `TELEPORT` - Fivetran's proprietary replication method that uses compressed snapshots to detect and apply changes.
* - Service `postgres`: The method to detect new or changed rows. Specify only for `"service": "postgres"` or `"service": "postgres_rds"`. Supported values:`WAL_PGOUTPUT` - logical replication of the WAL using the pgoutput plugin. This method replicates new, changed, and deleted rows by tailing the write-ahead log (WAL) using a logical slot.This is more efficient than the query-based method, but requires more setup and monitoring.`QUERY_BASED` - this method replicates new, changed and deleted rows via the `xmin` and `ctid` system columns
* - Service `postgres_rds`: The method to detect new or changed rows. Specify only for `"service": "postgres"` or `"service": "postgres_rds"`. Supported values:`WAL_PGOUTPUT` - logical replication of the WAL using the pgoutput plugin. This method replicates new, changed, and deleted rows by tailing the write-ahead log (WAL) using a logical slot. This is more efficient than the query-based method, but requires more setup and monitoring.`QUERY_BASED` - this method replicates new, changed and deleted rows via the `xmin` and `ctid` system columns
* - Service `redshift_db`: Default value: `Teleport`
* - Service `snowflake_db`: Default value: `Teleport`
* - Service `sql_server`: (Optional) The incremental update method the connector will use. The possible values are `"TELEPORT"` or `"NATIVE_UPDATE"`. The type defaults to `"NATIVE_UPDATE"` if the value is set to `null` or not specified.
* - Service `sql_server_hva`: (Optional) The incremental update method the connector will use. The possible values are `"TELEPORT"` or `"NATIVE_UPDATE"`. The type defaults to `"NATIVE_UPDATE"` if the value is set to `null` or not specified.
* - Service `sql_server_rds`: (Optional) The incremental update method the connector will use. The possible values are `"TELEPORT"` or `"NATIVE_UPDATE"`. The type defaults to `"NATIVE_UPDATE"` if the value is set to `null` or not specified.
* - Service `sql_server_sap_ecc_hva`: (Optional) The incremental update method the connector will use. The possible values are `"TELEPORT"` or `"NATIVE_UPDATE"`. The type defaults to `"NATIVE_UPDATE"` if the value is set to `null` or not specified.
*/
updateMethod: string;
/**
* Field usage depends on `service` value:
* - Service `cosmos`: Cosmos resource instance address.
*/
uri: string;
/**
* Field usage depends on `service` value:
* - Service `fountain`: Your Fountain URL format.
*/
urlFormat: string;
/**
* Field usage depends on `service` value:
* - Service `mandrill`: Whether to use multiple API keys for interaction.
*/
useApiKeys: boolean;
/**
* Field usage depends on `service` value:
* - Service `amplitude`: Sync events from cloud storage
*/
useCloudStorage: boolean;
/**
* Field usage depends on `service` value:
* - Service `appsflyer`: Use Custom Bucket. Set it to 'true' if the data is being synced to your S3 bucket instead of an AppsFlyer-managed bucket.
*/
useCustomerBucket: boolean;
/**
* Field usage depends on `service` value:
* - Service `sailthru`: Enable this if you want to sync Sailthru Connect using your own" S3 bucket.
*/
useCustomerS3Bucket: boolean;
/**
* Field usage depends on `service` value:
* - Service `pendo`: Toggle field to determine whether connector is syncing from API or from Data Sync
*/
useDataSync: boolean;
/**
* Field usage depends on `service` value:
* - Service `sap_hana_db`: Enable connection via SAP Message Server for load balancing
*/
useMessageServer: boolean;
/**
* Field usage depends on `service` value:
* - Service `oracle_hva`: Default value: `false`. Set to `true` if you're using a RAC instance.
* - Service `oracle_sap_hva`: Default value: `false`. Set to `true` if you're using a RAC instance.
*/
useOracleRac: boolean;
/**
* Field usage depends on `service` value:
* - Service `oracle_hva`: Default value: `false`. Set to `true` to connect directly to a single PDB. When `true`, set `database` to the PDB name and omit the `pdbName` field. Use only for Direct or Archive Log Only capture. Not supported with TDE, ASM, or RAC.
*/
usePdbOnly: boolean;
/**
* Field usage depends on `service` value:
* - Service `azure_blob_storage`: Set to `true` if files present in the Azure Blob Storage container are encrypted using PGP. Default value: `false`.
* - Service `ftp`: Set to `true` if files are encrypted using PGP in the S3 bucket. Default value: `false`.
* - Service `gcs`: Set to `true` if files are encrypted using PGP in the GCS bucket. Default value: `false`.
* - Service `s3`: Set to `true` if files are encrypted using PGP in the S3 bucket. Default value: `false`.
* - Service `s3_compatible_storage`: Set to `true` if files are encrypted using PGP in the S3-Compatible Storage bucket. Default value: `false`.
* - Service `sftp`: Set to `true` if files present in SFTP server are encrypted using PGP. Default value: `false`.
* - Service `wasabi_cloud_storage`: Set to `true` if files are encrypted using PGP in the Wasabi Cloud Storage bucket. Default value: `false`.
*/
usePgpEncryptionOptions: boolean;
/**
* Field usage depends on `service` value:
* - Service `sap_hana_db`: Enable connection via SAP Router
*/
useSapRouter: boolean;
/**
* Field usage depends on `service` value:
* - Service `bigquery_db`: BigQuery use service account; default is false
*/
useServiceAccount: boolean;
/**
* Field usage depends on `service` value:
* - Service `mandrill`: Use template labels to filter templates for sync
*/
useTemplateLabels: boolean;
/**
* Field usage depends on `service` value:
* - Service `github`: Set to `true` to capture deletes.
* - Service `xero`: Updates to few fields like sent_to_contact in Invoice table might be missed if you don't enable this.
*/
useWebhooks: boolean;
/**
* Field usage depends on `service` value:
* - Service `bigquery_db`: Create and drop tables in a query results dataset. Default is false
* - Service `snowflake_db`: Choose a database and schema to create temporary tables for syncs.
*/
useWorkspace: boolean;
/**
* Field usage depends on `service` value:
* - Service `aurora`: The user name.
* - Service `aurora_postgres`: The user name.
* - Service `aveva_pi`: Username for the user to authenticate as with the AF Server
* - Service `azure_cosmos_for_mongo`: Username for source database access.
* - Service `azure_postgres`: The user name.
* - Service `azure_sql_db`: The user name. For Azure Databases, the format must be `user@domain`.
* - Service `azure_sql_managed_db`: The user name. For Azure Databases, the format must be `user@domain`.
* - Service `clarity`: The user name. For Azure Databases, the format must be `user@domain`.
* - Service `cockroachdb`: The user name.
* - Service `db2i_hva`: The user name.
* - Service `db2i_sap_hva`: The username.
* - Service `db2luw`: The user name.
* - Service `db2z`: The user name.
* - Service `documentdb`: The user name.
* - Service `dynamics_365_fo`: The user name. The format must be `user@domain`.
* - Service `ehr`: The user name. For Azure Databases, the format must be `user@domain`.
* - Service `elastic_cloud`: The user name.
* - Service `epic_clarity`: The user name. For Azure Databases, the format must be `user@domain`.
* - Service `es_self_hosted`: The user name.
* - Service `ftp`: FTP user.
* - Service `google_cloud_mysql`: The user name.
* - Service `google_cloud_postgresql`: The user name.
* - Service `google_cloud_sqlserver`: The user name. For Azure Databases, the format must be `user@domain`.
* - Service `hana_sap_hva_b1`: The username.
* - Service `hana_sap_hva_ecc`: The username.
* - Service `hana_sap_hva_ecc_netweaver`: The username.
* - Service `hana_sap_hva_s4`: The username.
* - Service `hana_sap_hva_s4_netweaver`: The username.
* - Service `heroku_postgres`: The user name.
* - Service `jira`: The Jira username.
* - Service `magento_mysql`: The user name.
* - Service `magento_mysql_rds`: The user name.
* - Service `maria`: The user name.
* - Service `maria_azure`: The user name.
* - Service `maria_rds`: The user name.
* - Service `marin`: The Marin username.
* - Service `mongo`: The user name.
* - Service `mongo_sharded`: The user name.
* - Service `mysql`: The user name.
* - Service `mysql_azure`: The user name.
* - Service `mysql_rds`: The user name.
* - Service `opendistro`: The user name.
* - Service `opensearch`: The user name.
* - Service `oracle`: The user name.
* - Service `oracle_ebs`: The user name.
* - Service `oracle_hva`: The user name.
* - Service `oracle_rac`: The user name.
* - Service `oracle_rds`: The user name.
* - Service `oracle_sap_hva`: The username.
* - Service `oracle_sap_hva_netweaver`: The username.
* - Service `outbrain`: The username or email of the Outbrain user.
* - Service `postgres`: The user name.
* - Service `postgres_rds`: The user name.
* - Service `redshift_db`: The Redshift username.
* - Service `sap_hana`: Your SAP HANA user name.
* - Service `sap_s4hana`: Your SAP S/4 user name.
* - Service `sftp`: SFTP user.
* - Service `snowflake_db`: The Snowflake username.
* - Service `splunk`: The Splunk username.
* - Service `sql_server`: The user name. For Azure Databases, the format must be `user@domain`.
* - Service `sql_server_hva`: The user name. For Azure Databases, the format must be `user@domain`.
* - Service `sql_server_rds`: The user name. For Azure Databases, the format must be `user@domain`.
* - Service `sql_server_sap_ecc_hva`: The user name. For Azure Databases, the format must be `user@domain`.
*/
user: string;
/**
* Field usage depends on `service` value:
* - Service `coassemble`: Your Coassemble user ID.
* - Service `gmail`: (DEPRECATED) Your Gmail user ID.
* - Service `hibob`: Your HiBob Service User Token.
* - Service `marketo`: Marketo SOAP API User Id (Discontinued).
* - Service `okendo`: Your Okendo user ID.
* - Service `playvox`: Your Playvox User ID.
* - Service `sage_intacct`: User ID
* - Service `vimeo`: Your Vimeo user ID.
*/
userId: string;
userKey: string;
/**
* Field usage depends on `service` value:
* - Service `workday`: Workday username.
*/
userName: string;
/**
* Field usage depends on `service` value:
* - Service `double_click_campaign_manager`: IDs of specific User Profiles to sync. Must be populated if `sync_mode` is set to `SpecificAccounts`.
*/
userProfiles?: string[];
/**
* Field usage depends on `service` value:
* - Service `hibob`: Your HiBob Service User ID.
* - Service `konnect_insights`: Your Konnect Insights User Token.
* - Service `sonarqube`: Your Sonarqube user token.
*/
userToken?: string;
/**
* Field usage depends on `service` value:
* - Service `absorb_lms`: Your Absorb LMS username.
* - Service `adobe_commerce`: Your Adobe Commerce username.
* - Service `akeneo`: Your Akeneo username.
* - Service `alida`: Your Alida client ID.
* - Service `amqp`: Username for basic authentication.
* - Service `anaplan`: Your Anaplan user ID. Must be populated if `auth_mode` is set to `Basic`.
* - Service `appfigures`: Your Appfigures Username.
* - Service `aveva_pi`: Username for the user to authenticate as with the AF Server
* - Service `ceridian_dayforce`: Your Ceridian Dayforce username.
* - Service `churnzero`: Your ChurnZero username.
* - Service `cin7`: Your Cin7 API Username.
* - Service `collibra`: Your collibra username.
* - Service `compliance_checkpoint`: Your Compliance Checkpoint account username.
* - Service `concur`: The SAP Concur username.
* - Service `confluence`: Your Confluence username.
* - Service `contrast_security`: Your Contrast Security API Username.
* - Service `dcl_logistics`: Your DCL Logistics username.
* - Service `deposco`: Your Deposco username.
* - Service `github`: `Login` of your GitHub profile.
* - Service `gladly`: Your Gladly Username.
* - Service `globalmeet`: Your GlobalMeet Username.
* - Service `gorgias`: Your Gorgias username.
* - Service `green_power_monitor`: Your GreenPowerMonitor username.
* - Service `guru`: Your Guru username.
* - Service `hilti_ontrack`: Your Hilti On!Track username.
* - Service `impact`: Your Impact Brand Account SID
* - Service `integral_ad_science`: Your integral_ad_science username.
* - Service `itunes_connect`: Your Apple ID
* - Service `jamf`: Your Jamf username.
* - Service `khoros_care`: Your Khoros Care username.
* - Service `kissmetrics`: Your Kissmetrics API Username.
* - Service `klarna`: Your Klarna Username.
* - Service `learnupon`: Your LearnUpon username.
* - Service `lessonly`: Your Lessonly username.
* - Service `mailgun`: Your Mailgun API username.
* - Service `myosh`: Your myosh username.
* - Service `oracle_business_intelligence_publisher`: The Oracle Business Intelligence username.
* - Service `oracle_fusion_cloud_apps_crm`: The Oracle Fusion Cloud username.
* - Service `oracle_fusion_cloud_apps_fscm`: The Oracle Fusion Cloud username.
* - Service `oracle_fusion_cloud_apps_hcm`: The Oracle Fusion Cloud username.
* - Service `partnerize`: Your Partnerize account's username.
* - Service `pingdom`: Your Pingdom Username.
* - Service `podio`: Your Podio account username.
* - Service `qmatic_data_connect`: Your Qmatic Data Connect username.
* - Service `quorum`: Your Quorum username .
* - Service `revx`: Your RevX Username.
* - Service `rtb_house`: Your RTB House username.
* - Service `sap_business_by_design`: The SAP Business ByDesign username.
* - Service `scorm`: Your Scorm App ID.
* - Service `servicenow`: Your ServiceNow User ID (username).
* - Service `servicetrade`: Your ServiceTrade username.
* - Service `shiphero`: Your ShipHero username.
* - Service `shipstation`: Your ShipStation username.
* - Service `shopware`: Your Shopware username.
* - Service `splash`: Your Splash username.
* - Service `starrez`: Your StarRez API username
* - Service `stickyio`: Your sticky.io username .
* - Service `stylight`: Your Stylight Username.
* - Service `sugarcrm`: Your SugarCRM username.
* - Service `teamwork`: Your Teamwork username.
* - Service `testrail`: Your TestRail username.
* - Service `ukg_pro`: Your UKG Pro username.
* - Service `ukg_pro_workforce_management`: Your UKG Pro Workforce Management username.
* - Service `unicommerce`: Your uniware login username.
* - Service `upland`: Your Upland Software username.
* - Service `uptempo`: Your Uptempo username.
* - Service `veeva_vault`: Username
* - Service `veevavault`: Your Veeva Vault username.
* - Service `when_i_work`: Your When I Work username.
* - Service `wherefour`: Your Wherefour username.
* - Service `workday_financial_management`: Workday username.
* - Service `workday_hcm`: Username of your Workday Integration System User account
* - Service `xandr`: Your Xandr username.
* - Service `yougov_brandindex`: Your YouGov BrandIndex username.
* - Service `younium`: Your Younium username.
* - Service `zuora`: The API username with the necessary access permissions.
* - Service `zuora_sandbox`: The API username with the necessary access permissions.
*/
username: string;
/**
* Field usage depends on `service` value:
* - Service `itunes_connect`: Your vendors id
*/
vendorsIds?: string[];
/**
* Field usage depends on `service` value:
* - Service `criteo_retail_media`: Your Criteo Retail Media version.
*/
version?: string;
/**
* Field usage depends on `service` value:
* - Service `facebook`: Time period to attribute conversions based on views. [Possible view_attribution_window values](https://fivetran.com/docs/applications/facebook-ad-insights/api-config#viewattributionwindow).
* - Service `pinterest_ads`: The number of days to use as the conversion attribution window for a 'view' action.
* - Service `snapchat_ads`: The time period to attribute conversions based on views. Default value: `DAY_1`
*/
viewAttributionWindow: string;
/**
* Field usage depends on `service` value:
* - Service `pigment`: Your Pigment view ID.
*/
viewId?: string;
/**
* Field usage depends on `service` value:
* - Service `linkedin_ads`: The time period to attribute conversions based on views. Default value: `DAY_7`
*/
viewThroughAttributionWindowSize: string;
/**
* Field usage depends on `service` value:
* - Service `adyen`: Your Adyen Web Service API key.
*/
webServiceApiKey?: string;
/**
* Field usage depends on `service` value:
* - Service `appsflyer`: Webhook Url
*/
webhookEndpoint?: string;
/**
* Field usage depends on `service` value:
* - Service `xero`: Webhook Key
*/
webhookKey?: string;
/**
* Field usage depends on `service` value:
* - Service `ordway`: Your Ordway Webhook name.
*/
webhookName?: string;
/**
* Field usage depends on `service` value:
* - Service `branch`: Webhook URL
* - Service `pipedrive`: The registered URL for webhooks in your Pipedrive dashboard.
* - Service `segment`: Webhook URL.
* - Service `xero`: (ReadOnly) The Webhook URL generated by Fivetran. You can configure this in XERO.
*/
webhookUrl?: string;
/**
* Field usage depends on `service` value:
* - Service `woocommerce`: The Site ID of your WordPress hosted WooCommerce instance or the subdomain of your self-hosted WooCommerce instance.
*/
wordPressSiteIdOrWoocommerceDomainName?: string;
/**
* Field usage depends on `service` value:
* - Service `moloco`: Your Moloco workplace ID.
*/
workplaceId?: string;
/**
* Field usage depends on `service` value:
* - Service `mode`: Your Mode Workspace.
*/
workspace?: string;
/**
* Field usage depends on `service` value:
* - Service `fulfil`: Your Fulfil workspace ID.
*/
workspaceId?: string;
/**
* Field usage depends on `service` value:
* - Service `bigquery_db`: Workspace Dataset Name
* - Service `snowflake_db`: The name of the database where the temporary tables will be created.
*/
workspaceName?: string;
/**
* Field usage depends on `service` value:
* - Service `bigquery_db`: Use the source dataset as the workspace dataset
*/
workspaceSameAsSource: boolean;
/**
* Field usage depends on `service` value:
* - Service `snowflake_db`: The name of the schema that belongs to the workspace database where the temporary tables will be created.
*/
workspaceSchema?: string;
/**
* Field usage depends on `service` value:
* - Service `hex`: Your Hex workspace token.
*/
workspaceToken?: string;
/**
* Field usage depends on `service` value:
* - Service `adp_workforce_now`: Web Services Certificate.
*/
wsCertificate?: string;
/**
* Field usage depends on `service` value:
* - Service `workday_strategic_sourcing`: Your Workday Strategic Sourcing X API key.
*/
xApiKey?: string;
/**
* Field usage depends on `service` value:
* - Service `medallia_agile_research`: Your Medallia Agile Research key.
*/
xKey?: string;
/**
* Field usage depends on `service` value:
* - Service `medallia_agile_research`: Your Medallia Agile Research master key.
*/
xMasterKey?: string;
/**
* Field usage depends on `service` value:
* - Service `workday_strategic_sourcing`: Your Workday Strategic Sourcing X User Email.
*/
xUserEmail?: string;
/**
* Field usage depends on `service` value:
* - Service `workday_strategic_sourcing`: Your Workday Strategic Sourcing X User Token.
*/
xUserToken?: string;
}
export interface ConnectorConfigAccountsRedditAd {
/**
* Field usage depends on `service` value:
* - Service `reddit_ads`: Reddit username of the additional linked account.
*/
name?: string;
}
export interface ConnectorConfigAdobeAnalyticsConfiguration {
/**
* Field usage depends on `service` value:
* - Service `adobe_analytics`: The calculated_metrics that you want to sync.
*/
calculatedMetrics?: string[];
/**
* Field usage depends on `service` value:
* - Service `adobe_analytics`: The elements that you want to sync.
*/
elements?: string[];
/**
* Field usage depends on `service` value:
* - Service `adobe_analytics`: The metrics that you want to sync.
*/
metrics?: string[];
/**
* Field usage depends on `service` value:
* - Service `adobe_analytics`: Specific report suites to sync. Must be populated if `sync_mode` is set to `SpecificReportSuites`.
*/
reportSuites?: string[];
/**
* Field usage depends on `service` value:
* - Service `adobe_analytics`: The segments that you want to sync.
*/
segments?: string[];
/**
* Field usage depends on `service` value:
* - Service `adobe_analytics`: Whether to sync all report suites or specific report suites. Default value: `AllReportSuites` .
*/
syncMode: string;
/**
* Field usage depends on `service` value:
* - Service `adobe_analytics`: The table name unique within the schema to which connector will sync the data. Required for connector creation.
*/
table?: string;
}
export interface ConnectorConfigAppIdsAppsflyer {
/**
* Field usage depends on `service` value:
* - Service `appsflyer`: Your App ID
*/
appId?: string;
}
export interface ConnectorConfigAwsCredentials {
/**
* Field usage depends on `service` value:
* - Service `amplitude`: Your AWS S3 bucket name
* - Service `pendo`: AWS bucket name
*/
bucketName?: string;
/**
* Field usage depends on `service` value:
* - Service `amplitude`: Prefix to filter out the data
* - Service `pendo`: AWS home folder
*/
homeFolder?: string;
/**
* Field usage depends on `service` value:
* - Service `amplitude`: Role ARN required for authentication
* - Service `pendo`: AWS s3 Role Arn
*/
s3RoleArn?: string;
}
export interface ConnectorConfigAzureCredentials {
/**
* Field usage depends on `service` value:
* - Service `pendo`: Azure connection string
*/
connectionString?: string;
/**
* Field usage depends on `service` value:
* - Service `pendo`: Azure container name
*/
containerName?: string;
/**
* Field usage depends on `service` value:
* - Service `pendo`: Azure home folder
*/
homeFolder?: string;
}
export interface ConnectorConfigCustomPayload {
/**
* Field usage depends on `service` value:
* - Service `aws_lambda`: Payload Key
* - Service `azure_function`: Payload Key
* - Service `google_cloud_function`: Payload Key
*/
key?: string;
/**
* Field usage depends on `service` value:
* - Service `aws_lambda`: Payload Value
* - Service `azure_function`: Payload Value
* - Service `google_cloud_function`: Payload Value
*/
value?: string;
}
export interface ConnectorConfigCustomReport {
/**
* Field usage depends on `service` value:
* - Service `snapchat_ads`: [Determines if reports will be based on imression on coversion time](https://fivetran.com/docs/connectors/applications/snapchat-ads/custom-reports)
*/
actionReportTime: string;
/**
* Field usage depends on `service` value:
* - Service `snapchat_ads`: Add fields for separate \"swipe-up\" and \"view\" variants of selected metrics
*/
addMetricVariants: boolean;
/**
* Field usage depends on `service` value:
* - Service `tiktok_ads`: Time aggregation of report
*/
aggregate?: string;
/**
* Field usage depends on `service` value:
* - Service `snapchat_ads`: [List of Core, Additional and Conversion Metrics Stats Fields](https://fivetran.com/docs/connectors/applications/snapchat-ads/custom-reports#basemetricsfields).
*/
baseMetricsFields?: string[];
/**
* Field usage depends on `service` value:
* - Service `snapchat_ads`: [Sets Breakdown on custom report](https://fivetran.com/docs/connectors/applications/snapchat-ads/custom-reports#breakdown).
*/
breakdown?: string;
/**
* Field usage depends on `service` value:
* - Service `reddit_ads`: Breakdowns are now used instead of level and segmentation. They provide a filter for report data.
*/
breakdowns?: string[];
/**
* Field usage depends on `service` value:
* - Service `snapchat_ads`: [Sets Breakout on custom report](https://fivetran.com/docs/connectors/applications/snapchat-ads/custom-reports#breakout).
*/
breakout?: string;
/**
* Field usage depends on `service` value:
* - Service `reddit_ads`: The boolean value specifying whether to enable or disable event conversions data synchronisation. Default value: `false`
*/
conversionsReportIncluded: boolean;
/**
* Field usage depends on `service` value:
* - Service `reddit_ads`: The boolean value specifying whether the custom events are included in event conversions report. Default value: `false`
*/
customEventsIncluded: boolean;
/**
* Field usage depends on `service` value:
* - Service `snapchat_ads`: [Sets Dimension on custom report](https://fivetran.com/docs/connectors/applications/snapchat-ads/custom-reports#dimension).
*/
dimension?: string;
/**
* Field usage depends on `service` value:
* - Service `tiktok_ads`: Dimensions to synced
*/
dimensions?: string[];
/**
* Field usage depends on `service` value:
* - Service `reddit_ads`: The list of events the conversion data will be synchronised for
*/
eventNames?: string[];
/**
* Field usage depends on `service` value:
* - Service `snapchat_ads`: [Sets Granularity on custom report](https://fivetran.com/docs/connectors/applications/snapchat-ads/custom-reports#granularity).
*/
granularity?: string;
/**
* Field usage depends on `service` value:
* - Service `reddit_ads`: Level of custom report.
*/
level?: string;
/**
* Field usage depends on `service` value:
* - Service `tiktok_ads`: Metrics to be synced
*/
metrics?: string[];
/**
* Field usage depends on `service` value:
* - Service `reddit_ads`: The list of fields included in custom report
*/
reportFields?: string[];
/**
* Field usage depends on `service` value:
* - Service `reddit_ads`: The table name within the schema to which connector syncs the data of the specific report.
* - Service `snapchat_ads`: Custom report name (must be unique)
*/
reportName?: string;
/**
* Field usage depends on `service` value:
* - Service `tiktok_ads`: Type of report to be generated
*/
reportType?: string;
/**
* Field usage depends on `service` value:
* - Service `reddit_ads`: Level of custom report.
*/
segmentation?: string;
/**
* Field usage depends on `service` value:
* - Service `snapchat_ads`: [List of SKAd Metrics fields in custom report](https://fivetran.com/docs/connectors/applications/snapchat-ads/custom-reports#skadmetricsfields).
*/
skAdMetricsFields?: string[];
/**
* Field usage depends on `service` value:
* - Service `tiktok_ads`: Destination Table name of report
*/
tableName?: string;
/**
* Field usage depends on `service` value:
* - Service `reddit_ads`: The specific time zone to sync report data if `useAccountTimeZone` set to `false`.
*/
timeZone?: string;
/**
* Field usage depends on `service` value:
* - Service `reddit_ads`: When this parameter is set to `ACCOUNT`, connector will use account related time zone to sync report data. Default value: `ACCOUNT`. Possible values: `ACCOUNT`, `USER`
*/
timeZoneMode: string;
}
export interface ConnectorConfigCustomTable {
/**
* Field usage depends on `service` value:
* - Service `facebook_ads`: List of action_breakdowns which connector will sync. [Possible action_breakdowns values](https://fivetran.com/docs/connectors/applications/facebook-ads#actionbreakdowns).
*/
actionBreakdowns?: string[];
/**
* Field usage depends on `service` value:
* - Service `facebook_ads`: The report time of action stats. [Possible action_report time values](https://fivetran.com/docs/connectors/applications/facebook-ads#actionreporttime).
*/
actionReportTime: string;
/**
* Field usage depends on `service` value:
* - Service `facebook_ads`: Options to select aggregation duration. [Possible aggregation values](https://fivetran.com/docs/connectors/applications/facebook-ads#aggregation).
*/
aggregation: string;
/**
* Field usage depends on `service` value:
* - Service `facebook_ads`: List of breakdowns which connector will sync. [Possible breakdowns values](https://fivetran.com/docs/connectors/applications/facebook-ads#breakdowns).
*/
breakdowns?: string[];
/**
* Field usage depends on `service` value:
* - Service `facebook_ads`: Time period to attribute conversions based on clicks. [Possible click_attribution_window values](https://fivetran.com/docs/connectors/applications/facebook-ads#clickattributionwindow).
*/
clickAttributionWindow: string;
/**
* Field usage depends on `service` value:
* - Service `facebook_ads`: Option to select Prebuilt Reports or Custom Reports. [Possible config_type values](https://fivetran.com/docs/connectors/applications/facebook-ads#configtype).
*/
configType: string;
/**
* Field usage depends on `service` value:
* - Service `facebook_ads`: Time period to attribute conversions based on engaged views. [Possible view_attribution_window values](https://fivetran.com/docs/connectors/applications/facebook-ads#engagedviewattributionwindow).
*/
engagedViewAttributionWindow: string;
/**
* Field usage depends on `service` value:
* - Service `facebook_ads`: List of fields which connector will sync. [Possible field values](https://fivetran.com/docs/connectors/applications/facebook-ads#fields).
*/
fields?: string[];
level?: string;
/**
* Field usage depends on `service` value:
* - Service `facebook_ads`: The report name to which connector will sync the data. [Possible prebuilt_report values](https://fivetran.com/docs/connectors/applications/facebook-ads#prebuiltreport).
*/
prebuiltReportName: string;
/**
* Field usage depends on `service` value:
* - Service `facebook_ads`: The table name within the schema to which the connector will sync the data. It must be unique within the connector and must comply with [Fivetran's naming conventions](https://fivetran.com/docs/getting-started/core-concepts#namingconventions).
*/
tableName: string;
useUnifiedAttributionSetting: boolean;
/**
* Field usage depends on `service` value:
* - Service `facebook_ads`: Time period to attribute conversions based on views. [Possible view_attribution_window values](https://fivetran.com/docs/connectors/applications/facebook-ads#viewattributionwindow).
*/
viewAttributionWindow: string;
}
export interface ConnectorConfigDataModelPathAliasList {
/**
* Field usage depends on `service` value:
* - Service `oracle_business_intelligence_publisher`: Schema name
*/
alias?: string;
/**
* Field usage depends on `service` value:
* - Service `oracle_business_intelligence_publisher`: Path
*/
path?: string;
}
export interface ConnectorConfigFile {
/**
* Field usage depends on `service` value:
* - Service `azure_blob_storage`: All Files inside of compressed archives with filenames matching this regular expression will be synced.
* - Service `box`: All Files inside of compressed archives with filenames matching this regular expression will be synced.
* - Service `dropbox`: All Files inside of compressed archives with filenames matching this regular expression will be synced.
* - Service `email`: All Files inside of compressed archives with filenames matching this regular expression will be synced.
* - Service `ftp`: All Files inside of compressed archives with filenames matching this regular expression will be synced.
* - Service `gcs`: All Files inside of compressed archives with filenames matching this regular expression will be synced.
* - Service `google_drive`: All Files inside of compressed archives with filenames matching this regular expression will be synced.
* - Service `s3`: All Files inside of compressed archives with filenames matching this regular expression will be synced.
* - Service `s3_compatible_storage`: All Files inside of compressed archives with filenames matching this regular expression will be synced.
* - Service `sftp`: All Files inside of compressed archives with filenames matching this regular expression will be synced.
* - Service `share_point`: All Files inside of compressed archives with filenames matching this regular expression will be synced.
*/
archivePattern?: string;
/**
* Field usage depends on `service` value:
* - Service `email`: Only attachments from emails with this subject will be synced. Leave this field blank to sync all attachments.
*/
emailSubject?: string;
/**
* Field usage depends on `service` value:
* - Service `azure_blob_storage`: All files in your search path matching this regular expression will be synced per table. We have discontinued this field, and will delete it by August 31, 2025.
* - Service `box`: All files in your search path matching this regular expression will be synced per table.
* - Service `dropbox`: All files in your search path matching this regular expression will be synced per table.
* - Service `email`: All files in your search path matching this regular expression will be synced per table.
* - Service `ftp`: All files in your search path matching this regular expression will be synced per table.
* - Service `gcs`: All files in your search path matching this regular expression will be synced per table.
* - Service `google_drive`: All files in your search path matching this regular expression will be synced per table.
* - Service `s3`: All files in your search path matching this regular expression will be synced per table.
* - Service `s3_compatible_storage`: All files in your search path matching this regular expression will be synced per table.
* - Service `sftp`: All files in your search path matching this regular expression will be synced per table.
* - Service `share_point`: All files in your search path matching this regular expression will be synced per table.
*/
filePattern?: string;
/**
* Field usage depends on `service` value:
* - Service `azure_blob_storage`: Cell reference that will be used to sync all contiguous data starting from the top-left cell in all the spreadsheets matching the name. Cell reference is in the `'sheetName'!startColumnNamestartRowNumber` format.
* - Service `box`: Cell reference that will be used to sync all contiguous data starting from the top-left cell in all the spreadsheets matching the name. Cell reference is in the `'sheetName'!startColumnNamestartRowNumber` format.
* - Service `dropbox`: Cell reference that will be used to sync all contiguous data starting from the top-left cell in all the spreadsheets matching the name. Cell reference is in the `'sheetName'!startColumnNamestartRowNumber` format.
* - Service `email`: Cell reference that will be used to sync all contiguous data starting from the top-left cell in all the spreadsheets matching the name. Cell reference is in the `'sheetName'!startColumnNamestartRowNumber` format.
* - Service `ftp`: Cell reference that will be used to sync all contiguous data starting from the top-left cell in all the spreadsheets matching the name. Cell reference is in the `'sheetName'!startColumnNamestartRowNumber` format.
* - Service `gcs`: Cell reference that will be used to sync all contiguous data starting from the top-left cell in all the spreadsheets matching the name. Cell reference is in the `'sheetName'!startColumnNamestartRowNumber` format.
* - Service `google_drive`: Cell reference that will be used to sync all contiguous data starting from the top-left cell in all the spreadsheets matching the name. Cell reference is in the `'sheetName'!startColumnNamestartRowNumber` format.
* - Service `s3`: Cell reference that will be used to sync all contiguous data starting from the top-left cell in all the spreadsheets matching the name. Cell reference is in the `'sheetName'!startColumnNamestartRowNumber` format.
* - Service `s3_compatible_storage`: Cell reference that will be used to sync all contiguous data starting from the top-left cell in all the spreadsheets matching the name. Cell reference is in the `'sheetName'!startColumnNamestartRowNumber` format.
* - Service `sftp`: Cell reference that will be used to sync all contiguous data starting from the top-left cell in all the spreadsheets matching the name. Cell reference is in the `'sheetName'!startColumnNamestartRowNumber` format.
* - Service `share_point`: Cell reference that will be used to sync all contiguous data starting from the top-left cell in all the spreadsheets matching the name. Cell reference is in the `'sheetName'!startColumnNamestartRowNumber` format.
*/
selectedRange?: string;
/**
* Field usage depends on `service` value:
* - Service `azure_blob_storage`: All files matching the above pattern will be synced to this table.
* - Service `box`: All files matching the above pattern will be synced to this table.
* - Service `dropbox`: All files matching the above pattern will be synced to this table.
* - Service `email`: All files matching the above pattern will be synced to this table.
* - Service `ftp`: All files matching the above pattern will be synced to this table.
* - Service `gcs`: All files matching the above pattern will be synced to this table.
* - Service `google_drive`: All files matching the above pattern will be synced to this table.
* - Service `s3`: All files matching the above pattern will be synced to this table.
* - Service `s3_compatible_storage`: All files matching the above pattern will be synced to this table.
* - Service `sftp`: All files matching the above pattern will be synced to this table.
* - Service `share_point`: All files matching the above pattern will be synced to this table.
*/
tableName?: string;
}
export interface ConnectorConfigGcsCredentials {
/**
* Field usage depends on `service` value:
* - Service `amplitude`: Your GCS bucket name
* - Service `pendo`: GCS bucket name
*/
bucketName?: string;
/**
* Field usage depends on `service` value:
* - Service `amplitude`: Prefix to filter out the data
* - Service `pendo`: GCS home folder
*/
homeFolder?: string;
}
export interface ConnectorConfigProjectCredential {
/**
* Field usage depends on `service` value:
* - Service `amplitude`: The API key of the project.
*/
apiKey: string;
/**
* Field usage depends on `service` value:
* - Service `amplitude`: The project name you wish to use with Fivetran.
*/
project: string;
/**
* Field usage depends on `service` value:
* - Service `amplitude`: The project ID you wish to use with Fivetran.
*/
projectId?: string;
/**
* Field usage depends on `service` value:
* - Service `amplitude`: The secret key of the project.
*/
secretKey: string;
}
export interface ConnectorConfigReport {
accounts?: outputs.ConnectorConfigReportAccount[];
/**
* Field usage depends on `service` value:
* - Service `double_click_publishers`: Ad unit view for the report.
*/
adUnitView: string;
/**
* Field usage depends on `service` value:
* - Service `google_display_and_video_360`: The list of advertisers to include into a sync. This parameter only takes effect when `config_method` is set to `CREATE_NEW`.
*/
advertisers?: string[];
/**
* Field usage depends on `service` value:
* - Service `google_search_console`: (Optional) Aggregation type. Supported only for the `SEARCH_RESULTS` report type
*/
aggregation?: string;
/**
* Field usage depends on `service` value:
* - Service `google_search_ads_360`: The report attributes included to sync.
*/
attributes?: string[];
/**
* Field usage depends on `service` value:
* - Service `double_click_publishers`: Columns provide all trafficking statistics and revenue information available for the chosen dimensions.
*/
columns?: string[];
/**
* Field usage depends on `service` value:
* - Service `google_display_and_video_360`: The report configuration method. Specifies whether a new configuration is defined manually or an existing configuration is reused. The default value is `CREATE_NEW`.
*/
configMethod: string;
/**
* Field usage depends on `service` value:
* - Service `google_analytics`: Whether to use the [Prebuilt Reports or Custom Reports](https://fivetran.com/docs/connectors/applications/google-analytics#schemainformation).
* - Service `google_analytics_4`: Whether to use the Prebuilt Reports or Custom Reports.
*/
configType: string;
/**
* Field usage depends on `service` value:
* - Service `double_click_campaign_manager`: Conversion Dimensions.
*/
conversionDimensions?: string[];
/**
* Field usage depends on `service` value:
* - Service `klaviyo`: The ID of the conversion metric.
*/
conversionMetricId?: string;
/**
* Field usage depends on `service` value:
* - Service `workday_adaptive`: List of currencies to sync for the table, if applicable.
*/
currency?: string;
/**
* Field usage depends on `service` value:
* - Service `google_search_ads_360`: The report custom column IDs included to sync.
*/
customColumnIds?: string[];
/**
* Field usage depends on `service` value:
* - Service `double_click_publishers`: The list of custom dimension key IDs included in the report. Custom dimension keys can only be selected with the CUSTOM_DIMENSION dimension.
*/
customDimensionKeyIds?: string[];
/**
* Field usage depends on `service` value:
* - Service `double_click_publishers`: The list of custom field IDs included in the report. Custom fields can only be selected with their corresponding dimensions.
*/
customFieldIds?: string[];
/**
* Field usage depends on `service` value:
* - Service `double_click_campaign_manager`: Custom Floodlight variables enable you to capture information beyond the basics (visits and revenue) that you can collect with standard parameters in your tags.
*/
customFloodlightVariables?: string[];
/**
* Field usage depends on `service` value:
* - Service `double_click_publishers`: Dimension attributes provide additional fields associated with a dimension. Dimension attributes can only be selected with their corresponding dimensions.
*/
dimensionAttributes?: string[];
/**
* Field usage depends on `service` value:
* - Service `double_click_campaign_manager`: Report dimensions to include in a sync. The `date` dimension is mandatory for all report types. The `advertiser` dimension is mandatory for the `REACH` report type
* - Service `double_click_publishers`: Report dimensions to include in the sync. The `date` dimension is mandatory for all the report types.
* - Service `google_analytics`: The report dimensions to include into a sync. The `date` dimension is mandatory for all the report types.
* - Service `google_analytics_4`: The report dimensions to include into a sync.
* - Service `google_display_and_video_360`: The report dimensions (filters) to include into a sync. The dimension names are provided in the API format. This is a required parameter when `config_method` is set to `CREATE_NEW`.
* - Service `google_search_console`: The report dimensions included to sync.
* - Service `workday_adaptive`: List of dimensions to sync for the table, if applicable.
*/
dimensions?: string[];
/**
* Field usage depends on `service` value:
* - Service `workday`: Dynamic parameter field name
*/
dynamicParameterField?: string;
/**
* Field usage depends on `service` value:
* - Service `double_click_campaign_manager`: Specifies whether to enable all reach dimension combinations in the report. Default value: `false`
*/
enableAllDimensionCombinations: boolean;
/**
* Field usage depends on `service` value:
* - Service `workday`: Select this option to enable dynamic report parameters.
*/
enableDynamicParameters: boolean;
/**
* Field usage depends on `service` value:
* - Service `google_ads`: A list of the fields to sync. Must be populated if `config_type` is set to `Custom`.
*/
fields?: string[];
/**
* Field usage depends on `service` value:
* - Service `google_analytics`: String parameter restricts the data returned for your report. To use the filter parameter, specify a dimension or metric on which to filter, followed by the filter expression
*/
filter: string;
/**
* Field usage depends on `service` value:
* - Service `google_analytics_4`: The dimension name to filter on.
*/
filterFieldName?: string;
/**
* Field usage depends on `service` value:
* - Service `google_analytics_4`: Filter type for reports request. Possible values are INCLUDE and EXCLUDE
*/
filterType?: string;
filterValue?: string;
filters?: outputs.ConnectorConfigReportFilter[];
/**
* Field usage depends on `service` value:
* - Service `workday`: Select this option to generate a Primary Key for reports where no single column or combination of columns can be used to form a Primary Key.
*/
generateFivetranPk: boolean;
/**
* Field usage depends on `service` value:
* - Service `workday_adaptive`: Include zero rows in the table sync.
*/
includeZeroRows: boolean;
/**
* Field usage depends on `service` value:
* - Service `klaviyo`: The interval used in the API calls to retrieve the reports.
*/
interval: string;
levels?: outputs.ConnectorConfigReportLevel[];
/**
* Field usage depends on `service` value:
* - Service `double_click_campaign_manager`: Report metrics to include into a sync.
* - Service `google_analytics`: The report metrics to include into a sync.
* - Service `google_analytics_4`: The report metrics to include into a sync.
* - Service `google_display_and_video_360`: The report metrics to include into a sync. The metric names are provided in the API format. This is a required parameter when `config_method` is set to `CREATE_NEW`.
* - Service `google_search_ads_360`: The report metrics included to sync.
*/
metrics?: string[];
/**
* Field usage depends on `service` value:
* - Service `klaviyo`: The name of the custom report. The same name is used to name the table in the destination.
*/
name?: string;
/**
* Field usage depends on `service` value:
* - Service `google_display_and_video_360`: The list of partners to include into a sync. This parameter only takes effect when `config_method` is set to `CREATE_NEW`.
*/
partners?: string[];
/**
* Field usage depends on `service` value:
* - Service `double_click_campaign_manager`: Per Interaction Dimensions.
*/
perInteractionDimensions?: string[];
/**
* Field usage depends on `service` value:
* - Service `google_analytics`: The name of the Prebuilt Report from which the connector will sync the data.
* - Service `google_analytics_4`: The name of the Prebuilt Report from which the connector will sync the data.
*/
prebuiltReport: string;
/**
* Field usage depends on `service` value:
* - Service `workday`: Primary Keys
*/
primaryKeys?: string[];
/**
* Field usage depends on `service` value:
* - Service `google_display_and_video_360`: The ID of the query whose configuration you want to reuse. This is a required parameter when `config_method` is set to `REUSE_EXISTING`.
*/
queryId?: string;
/**
* Field usage depends on `service` value:
* - Service `double_click_campaign_manager`: You can select only one Floodlight Configuration ID per account.
*/
reportConfigurationIds?: string[];
/**
* Field usage depends on `service` value:
* - Service `workday`: This is to select report format from JSON and CSV. By default, report format is JSON.
*/
reportFormatType: string;
/**
* Field usage depends on `service` value:
* - Service `double_click_campaign_manager`: Type of reporting data to sync. Default value: `STANDARD`.
* - Service `google_ads`: The name of the Google Ads report from which the connector will sync the data. [Possible report_type values](https://developers.google.com/adwords/api/docs/appendix/reports#report-types).
* - Service `google_display_and_video_360`: The type of the report to create. This is a required parameter when `config_method` is set to `CREATE_NEW`.
* - Service `google_search_ads_360`: The type of report
* - Service `google_search_console`: The type of report
*/
reportType: string;
/**
* Field usage depends on `service` value:
* - Service `workday`: URL for a live custom report.
*/
reportUrl?: string;
/**
* Field usage depends on `service` value:
* - Service `double_click_campaign_manager`: The custom window size for rollback syncs (between 1 and 90).
* - Service `google_analytics_4`: The custom window size for rollback syncs.
* - Service `google_search_ads_360`: The custom window size for rollback syncs (between 2 and 90).
*/
rollbackWindow: number;
/**
* Field usage depends on `service` value:
* - Service `google_search_console`: Search types included to sync. Supported only for the `SEARCH_RESULTS` report type
*/
searchTypes?: string[];
segmentIds?: string[];
/**
* Field usage depends on `service` value:
* - Service `google_analytics`: A segment is a subset of your Analytics data that is made up of one or more non-destructive filters (filters that do not alter the underlying data). Those filters isolate subsets of users, sessions, and hits.
* - Service `google_search_ads_360`: The report segments included to sync.
*/
segments?: string[];
/**
* Field usage depends on `service` value:
* - Service `google_display_and_video_360`: If enabled, the report will be queried separately for each advertiser, and the FILTER_ADVERTISER dimension will be added automatically if not already selected. This parameter only takes effect when `config_method` is set to `CREATE_NEW`. The default value is `false`.
*/
splitByAdvertiser: boolean;
/**
* Field usage depends on `service` value:
* - Service `workday`: Start date
*/
startDate?: string;
/**
* Field usage depends on `service` value:
* - Service `workday`: Start date parameter field name
*/
startDateParameterField?: string;
/**
* Field usage depends on `service` value:
* - Service `workday_adaptive`: Start month for the table sync, in MM format
*/
startMonth: string;
/**
* Field usage depends on `service` value:
* - Service `workday_adaptive`: Start year for the table sync, in YYYY format
*/
startYear: string;
/**
* Field usage depends on `service` value:
* - Service `klaviyo`: The list of statistics to be retrieved.
*/
statistics?: string[];
/**
* Field usage depends on `service` value:
* - Service `workday`: This option is to unpack the nested columns and sync them separately. By default, we sync the nested columns as JSON objects.
*/
supportNestedColumns: boolean;
/**
* Field usage depends on `service` value:
* - Service `workday`: Dynamic report parameters sync strategy
*/
syncStrategy: string;
/**
* Field usage depends on `service` value:
* - Service `double_click_campaign_manager`: Destination table name. It must be unique within this connection and must comply with Fivetran's naming conventions.
* - Service `double_click_publishers`: The name of the table within the schema storing the data for a given report.
* - Service `google_ads`: The table name within the schema to which connector will sync the data of the specific report.
* - Service `google_analytics`: The table name within the schema to which connector will sync the data of the specific report.
* - Service `google_analytics_4`: The table name within the schema to which connector will sync the data of the specific report.
* - Service `google_search_ads_360`: The name of a table within the schema to which connector syncs the data of a given report.
* - Service `google_search_console`: The name of a table within the schema to which connector syncs the data of a given report.
* - Service `workday`: The table name within the schema to which connector will sync the data of the specific report.
* - Service `workday_adaptive`: Table name to be synced.
*/
table: string;
/**
* Field usage depends on `service` value:
* - Service `google_display_and_video_360`: The table name within the schema to which connector will sync the data of the specific report.
*/
tableName?: string;
/**
* Field usage depends on `service` value:
* - Service `google_analytics_4`: The report data aggregation time granularity.
*/
timeAggregationGranularity: string;
/**
* Field usage depends on `service` value:
* - Service `klaviyo`: The type of the custom report.
*/
type: string;
/**
* Field usage depends on `service` value:
* - Service `google_display_and_video_360`: Specifies whether the configuration is updated before each sync or only when the connector settings are saved. This parameter only takes effect when `config_method` is set to `REUSE_EXISTING`. The default value is `true`.
*/
updateConfigOnEachSync: boolean;
/**
* Field usage depends on `service` value:
* - Service `workday_adaptive`: Version sync strategy for the table, `SYNC_ALL_AND_NEW_VERSIONS` or `SYNC_SELECT_VERSIONS`.
*/
versionSyncStrategy: string;
/**
* Field usage depends on `service` value:
* - Service `workday_adaptive`: List of versions to sync for the table, if versionSyncStrategy is `SYNC_SELECT_VERSIONS`.
*/
versions?: string[];
}
export interface ConnectorConfigReportAccount {
/**
* Field usage depends on `service` value:
* - Service `workday_adaptive`: Flag to indicate if descendants are included or not.
*/
flag: boolean;
/**
* Field usage depends on `service` value:
* - Service `workday_adaptive`: Account ID and `isAssumption` flag (`true` or `false`) are separated by a comma. The `isAssumption` flag indicates whether the account is used for assumptions.
*/
id?: string;
}
export interface ConnectorConfigReportConfig {
/**
* Field usage depends on `service` value:
* - Service `yahoo_dsp`: Set the value to `PREBUILT` if it's one of the preconfigured reports (see the `prebuilt_report_type` option). Otherwise, set to `CUSTOM`.
*/
configType: string;
/**
* Field usage depends on `service` value:
* - Service `yahoo_dsp`: [Currency](https://developer.yahooinc.com/dsp/api/docs/reporting/payloadspec.html) used in a report. Default value: `USD`.
*/
currency: string;
/**
* Field usage depends on `service` value:
* - Service `yahoo_dsp`: [Dimensions](https://developer.yahooinc.com/dsp/api/docs/reporting/dimensions.html) used in a report. Must be populated if `config_type` is set to `CUSTOM`. PUBLISHER, DESKTOP_OS_DEPRECATED, LINE_TYPE, GOAL_TYPE, BID_REQUEST_AD_SIZE, CHANNEL_TYPE, SITE_NAME, and SITE_GROUP_NAME are deprecated dimension, and shouldn't be used anymore
*/
dimensions?: string[];
/**
* Field usage depends on `service` value:
* - Service `yahoo_dsp`: The [granularity](https://developer.yahooinc.com/dsp/api/docs/reporting/range-examples.html#interval-type-id) of data in a report. Default value: `DAY`.
*/
intervalType: string;
/**
* Field usage depends on `service` value:
* - Service `yahoo_dsp`: [Metrics](https://developer.yahooinc.com/dsp/api/docs/reporting/metrics.html) used in a report. Must be populated if `config_type` is set to `CUSTOM`. PUBLISHER_EARNINGS, PUBLISHER_EARNINGS_PERCENTAGE, INVENTORY_ECPM_DEPRECATED, SEAT_TECH_FEE, and SEAT_DATA_FEE are deprecated and shouldn't be used anymore
*/
metrics?: string[];
/**
* Field usage depends on `service` value:
* - Service `yahoo_dsp`: Specific report type to sync. Must be populated if `config_type` is set to `PREBUILT`.
*/
prebuiltReportType: string;
/**
* Field usage depends on `service` value:
* - Service `yahoo_dsp`: Table name in destination.
*/
reportName?: string;
/**
* Field usage depends on `service` value:
* - Service `yahoo_dsp`: Specify the time zone to be used to request report data
*/
timeZone: string;
/**
* Field usage depends on `service` value:
* - Service `yahoo_dsp`: Use advertiser timezone to request report data.
*/
useAdvertiserTimezone: boolean;
}
export interface ConnectorConfigReportFilter {
dimension: string;
expression?: string;
/**
* Field usage depends on `service` value:
* - Service `google_analytics_4`: The dimension name to filter on.
*/
filterDimension?: string;
/**
* Field usage depends on `service` value:
* - Service `google_analytics_4`: Filter type for reports request. Possible values are INCLUDE and EXCLUDE
*/
filterType: string;
/**
* Field usage depends on `service` value:
* - Service `google_analytics_4`: The filter value.
*/
filterValue?: string;
/**
* Field usage depends on `service` value:
* - Service `google_analytics_4`: The filter values for EXACT match type.
*/
filterValues?: string[];
/**
* Field usage depends on `service` value:
* - Service `google_analytics_4`: The filter match type.
*/
matchType: string;
}
export interface ConnectorConfigReportLevel {
/**
* Field usage depends on `service` value:
* - Service `workday_adaptive`: Flag to indicate if descendants are included or not.
*/
flag: boolean;
/**
* Field usage depends on `service` value:
* - Service `workday_adaptive`: Level ID to sync.
*/
id?: string;
/**
* Field usage depends on `service` value:
* - Service `workday_adaptive`: Flag to indicate if descendants are included or not
*/
includeDescendants: boolean;
}
export interface ConnectorConfigReportList {
/**
* Field usage depends on `service` value:
* - Service `spotify_ads`: The dimension (entity_type) to sync.
*/
dimension: string;
/**
* Field usage depends on `service` value:
* - Service `spotify_ads`: A list of the fields (metrics) to sync.
*/
fields?: string[];
/**
* Field usage depends on `service` value:
* - Service `spotify_ads`: The report granularity.
*/
granularity: string;
/**
* Field usage depends on `service` value:
* - Service `spotify_ads`: The table name within the schema to which connector will sync the data of the specific report.
*/
table?: string;
}
export interface ConnectorConfigSecretsList {
/**
* Field usage depends on `service` value:
* - Service `aws_lambda`: Secret Key.
* - Service `azure_function`: Key
* - Service `connector_sdk`: Key
* - Service `google_cloud_function`: Key
*/
key: string;
/**
* Field usage depends on `service` value:
* - Service `aws_lambda`: Secret Value.
* - Service `azure_function`: Value
* - Service `connector_sdk`: Value
* - Service `google_cloud_function`: Value
*/
value: string;
}
export interface ConnectorConfigTenantConfig {
/**
* Field usage depends on `service` value:
* - Service `reltio`: Your Reltio subdomain.
*/
subdomain?: string;
/**
* Field usage depends on `service` value:
* - Service `reltio`: Your Reltio tenant ID.
*/
tenantId?: string;
}
export interface ConnectorDestinationSchema {
/**
* The connector schema name in destination. Has to be unique within the group (destination). Required for connector creation of services:
* `15five`, `360learning`, `6sense`, `7shifts`, `absorb_lms`, `acculynx`, `activecampaign`, `acumatica`, `ada`, `adform`, `adjust`, `adobe_analytics_data_feed`, `adobe_analytics`, `adobe_commerce`, `adobe_experience_platform`, `adobe_workfront`, `adp_workforce_now`, `adroll`, `adyen`, `affinity`, `afterpay`, `aha`, `aircall`, `akamai`, `akeneo`, `alation`, `alchemer`, `algolia`, `alida`, `amazon_ads`, `amazon_attribution`, `amazon_dsp`, `amazon_selling_partner`, `amplitude`, `amqp`, `anaplan`, `anvyl`, `apache_kafka`, `apollo`, `appcues`, `appfigures`, `apple_search_ads`, `applovin`, `appsflyer`, `asana`, `ascend_by_partnerize`, `ashby`, `assembled`, `asset_panda`, `atlassian_jira_align`, `atlassian_ops_genie`, `attentive`, `attio`, `aumni`, `aura_from_unity`, `auth0`, `autodesk_bim_360`, `avantlink`, `aveva_pi`, `awin`, `aws_cloudtrail`, `aws_cost_report`, `aws_cost`, `aws_inventory`, `aws_lambda`, `aws_msk`, `azure_blob_storage`, `azure_boards`, `azure_devops`, `azure_event_hub`, `azure_function`, `azure_service_bus`, `backbone_plm`, `ballotready`, `bamboohr`, `bazaarvoice`, `betterworks`, `big_commerce`, `bigin_by_zoho_crm`, `bigmarker`, `billing_platform`, `bing_webmaster_tools`, `bingads`, `birdeye`, `bitly`, `bizzabo_app`, `bizzabo_v2`, `bizzabo`, `boostr`, `box`, `braintree_sandbox`, `braintree`, `branch`, `brave_ads`, `braze`, `brevo`, `brex`, `brightcove`, `brightflag`, `brightpearl`, `brivo`, `bubble`, `buildium`, `buildkite`, `business_central`, `buzzsprout`, `bynder`, `cabcharge`, `calabrio`, `calendly`, `callrail`, `campaignmonitor`, `campfire`, `canny`, `canvas_by_instructure`, `canvas_data_2_by_instructure`, `care_quality_commission`, `castor_edc`, `centra`, `ceridian_dayforce`, `chameleon`, `channel_advisor`, `chargebee_product_catalog_1`, `chargebee_product_catalog_2`, `chargedesk`, `charthop`, `chartmogul`, `checkout`, `checkr`, `chorusai`, `churnkey`, `churnzero`, `cimis`, `cin7`, `cin7core`, `circleci`, `cj_commission_detail`, `clari`, `classy`, `clazar`, `clickup`, `clockify`, `clockodo`, `close`, `cloudbeds`, `cloudflare_analytics`, `cloudfront`, `cloudtalk`, `clubspeed`, `coalesce`, `coassemble`, `codefresh`, `coheris`, `collibra`, `column`, `commercetools`, `compliance_checkpoint`, `concord`, `concur`, `confluence`, `confluent_cloud`, `connector_sdk`, `consensus_demo_automation_platform`, `constant_contact`, `contrast_security`, `convex`, `copper`, `cornerstone`, `coupa`, `credly`, `criteo_retail_media`, `criteo`, `crossbeam`, `crowddev`, `crunchbase`, `cube_software`, `cube`, `culture_amp`, `customerio`, `cvent`, `d2l_brightspace`, `datadog`, `datastreamer_source`, `dbt_cloud`, `dcl_logistics`, `dear`, `delighted`, `deposco`, `deputy`, `destini`, `device_magic`, `dialpad`, `discourse`, `dixa`, `docebo`, `donus`, `doorloop`, `double_click_campaign_manager`, `double_click_publishers`, `drata`, `drift`, `drip`, `dropbox_sign`, `dropbox`, `dsv`, `duoplane`, `dutchie`, `dynamics_365`, `dynamodb`, `easypost`, `ebay`, `economic`, `elastic_cloud`, `electronic_tenant_solutions`, `eloqua`, `email`, `employment_hero`, `es_self_hosted`, `eventbrite`, `eventsforce`, `everflow`, `everhour`, `exact_online`, `expensein`, `expensify`, `ezofficeinventory`, `facebook_ad_account`, `facebook_ads`, `facebook_pages`, `facebook`, `factbird`, `factorial`, `fillout`, `financial_force`, `firebase`, `fireflies`, `firehydrant`, `fivetran_log`, `flexport`, `float`, `flywheel_digital`, `fone_dynamics`, `forethought`, `forj_community`, `formstack`, `fortnox`, `fountain`, `fourkites`, `freightview`, `freshbooks`, `freshchat`, `freshdesk_contact_center`, `freshdesk`, `freshsales`, `freshservice`, `freshsuccess`, `freshteam`, `friendbuy`, `front`, `ftp`, `fulfil`, `fullstory`, `g2`, `gainsight_customer_success`, `gainsight_product_experience`, `gcs`, `gem`, `genesys`, `getfeedback`, `github`, `gitlab`, `gladly`, `globalmeet`, `gmail`, `gocardless`, `gofundme_pro`, `goldcast`, `gongio`, `google_ads`, `google_analytics_360`, `google_analytics_4_export`, `google_analytics_4`, `google_analytics_mcf`, `google_analytics`, `google_business_profile`, `google_calendar`, `google_classroom`, `google_cloud_function`, `google_display_and_video_360`, `google_drive`, `google_play`, `google_search_ads_360`, `google_search_console`, `google_sheets`, `google_tasks`, `gorgias`, `green_power_monitor`, `greenhouse`, `grepsr`, `grin`, `guru`, `h_level`, `hana_sap_hva_ecc_netweaver`, `hana_sap_hva_s4_netweaver`, `happyfox`, `harvest`, `healthie`, `heap`, `heartland_retail_pos`, `height`, `helpdesk`, `helpjuice`, `helpscout`, `helpshift`, `heroku_kafka`, `hex`, `hibob`, `higher_logic_vanilla`, `hilti_ontrack`, `hopin`, `hubspot`, `ibacos`, `ilevel`, `impact_partner`, `impact`, `incidentio`, `infobip`, `insightly`, `instagram_business`, `instructure`, `integral_ad_science`, `integrate`, `intercom`, `invoiced`, `ironclad`, `ironsource`, `iterable`, `itunes_connect`, `ivanti`, `jama_software`, `jamf`, `jibble`, `jira`, `jobnimbus`, `jotform`, `justcall`, `kandji`, `katana`, `kevel`, `keypay`, `khoros_care`, `khoros_communities`, `khoros_marketing`, `kinesis`, `kisi`, `kissmetrics`, `klarna`, `klaviyo`, `konnect_insights`, `kustomer`, `lattice`, `launchdarkly`, `leap_crm`, `learn_amp`, `learnupon`, `lemlist`, `lessonly`, `lever`, `liftoff`, `light_speed_retail`, `lightspeed_retail_xseries`, `line_ads`, `linear`, `linkedin_ads`, `linkedin_company_pages`, `linksquares`, `listen360`, `livechat_partner`, `livechat`, `lob`, `looker_source`, `loop`, `loopio`, `lucca`, `luma`, `mailchimp`, `maileon`, `mailgun`, `mailjet`, `malomo`, `mambu`, `mandrill`, `marin`, `marketo`, `matomo`, `mavenlink`, `maxio_chargify`, `maxio_saasoptics`, `medallia_agile_research`, `medallia`, `megaphone`, `meltwater`, `mention`, `messagebird`, `microsoft_dynamics_365_fno`, `microsoft_dynamics_365_fo`, `microsoft_entra_id`, `microsoft_lists`, `microsoft_power_bi`, `microsoft_teams`, `missive`, `mixmax`, `mixpanel`, `mode`, `moloco`, `monday`, `mountain`, `mux`, `myosh`, `namely`, `national_heavy_vehicle_regulator`, `navan`, `netsuite_suiteanalytics`, `nice`, `notion`, `nylas`, `odoo`, `okendo`, `okta`, `ometria`, `on24`, `oncehub`, `one_drive`, `onetrust`, `open_data_dc`, `open_exchange_rates`, `openai`, `opendistro`, `opensearch`, `optimizely`, `oracle_fusion_field_service`, `oracle_moat_analytics`, `oracle_netsuite_openair`, `oracle_sap_hva_netweaver`, `orbit`, `ordergroove`, `ordway`, `ortto`, `outbrain`, `outreach`, `packiyo`, `paddle`, `pagerduty`, `pandadoc`, `papershift`, `pardot_sandbox`, `pardot`, `partnerize`, `partnerstack_vendor`, `paychex`, `paylocity`, `paypal_sandbox`, `paypal`, `pendo`, `peopleforce`, `persona`, `personio`, `phoenix_ads`, `picqer`, `pigment`, `pingdom`, `pinpoint`, `pinterest_ads`, `pinterest_organic`, `pipe17`, `pipedrive`, `pivotal_tracker`, `piwik_pro`, `placerai`, `planetscale`, `planful`, `planhat`, `playvox_workforce_management`, `playvox`, `podio`, `poplar`, `posthog`, `postmark`, `power_reviews_enterprise`, `prisma_cloud`, `prive`, `procore`, `productboard`, `productive`, `proofpoint_security_awareness`, `prosperstack`, `purple_dot`, `pylon_support_platform`, `qmatic_data_connect`, `qualaroo`, `qualtrics`, `quickbooks`, `quora_ads`, `quorum`, `rakutenadvertising`, `ramp`, `rarible`, `rebound_returns`, `recharge`, `recurly`, `reddit_ads`, `referralhero`, `refiner`, `reltio`, `replyio`, `resource_management_by_smartsheet`, `retailnext`, `retently`, `revel`, `revenuecat`, `reviewsai`, `reviewsio`, `revops`, `revx`, `ricochet360`, `ringcentral`, `ringover`, `rippling`, `rithum`, `rocketlane`, `rokt`, `rollbar`, `rootly`, `rtb_house`, `ruddr`, `rundeck`, `s3_compatible_storage`, `s3`, `safebase`, `safetyculture`, `sage_hr`, `sage_intacct`, `sailthru`, `salesforce_commerce_cloud`, `salesforce_marketing_cloud`, `salesforce_sandbox`, `salesforce`, `salesloft`, `salsify`, `samsara`, `sana`, `sap_business_by_design`, `sap_hana`, `sap_s4hana`, `sap_success_factors`, `scorm`, `security_journey`, `segment`, `sendgrid`, `sendinblue`, `sensor_tower`, `sentry`, `servicenow`, `servicetitan`, `servicetrade`, `sftp`, `share_point`, `shareasale`, `sharetribe`, `shiphero`, `shipnetwork`, `shipstation`, `shopify`, `shopware`, `shortcut`, `shortio`, `showpad`, `siemens_building_x_openness`, `sigma_computing_source`, `simplecast`, `simplesat`, `singlestore_source`, `sistrix`, `skilljar`, `skillstx`, `skimlinks`, `skuvault`, `slab`, `slack_app`, `slack`, `smadex`, `smarthr`, `smartrecruiters`, `smartsheet`, `smartwaiver`, `snapchat_ads`, `snowplow`, `snyk`, `solarwinds_service_desk`, `sonarqube`, `sparkpost`, `splash`, `splitio`, `splunk`, `spotify_ads`, `sprout`, `square`, `squarespace`, `stackadapt_graphql`, `stackadapt`, `standard_metrics`, `starrez`, `statistics_netherlands_cbs`, `statsig`, `statuspage`, `stickyio`, `stripe_test`, `stripe`, `stylight`, `subscript`, `sugarcrm`, `survey_monkey`, `survicate`, `swoogo`, `tableau_source`, `taboola`, `talkdesk`, `talkwalker`, `teads`, `teamtailor`, `teamwork`, `tempo`, `testrail`, `textus`, `the_movie_database`, `the_trade_desk`, `thinkific`, `ticket_tailor`, `tiktok_ads`, `tiktok_organic_app`, `tiktok_organic`, `tive`, `toast`, `toggl_track`, `totango`, `tracksuit_source`, `transcend`, `trelica`, `trello`, `tremendous`, `triple_whale`, `trisolute`, `twilio`, `twitter_ads`, `twitter`, `tymeshift`, `typeform`, `udemy_business`, `ukg_pro_workforce_management`, `ukg_pro`, `unicommerce`, `upland`, `uppromote`, `uptempo`, `uservoice`, `validio`, `veeqo`, `veeva_vault`, `veevavault`, `venminder`, `vimeo`, `visit_by_ges`, `visma`, `vitally`, `vonage_contact_center`, `vonage`, `vts`, `vwo`, `walmart_dsp`, `walmart_marketplace`, `wasabi_cloud_storage`, `web_scraper`, `webconnex`, `webhooks`, `when_i_work`, `wherefour`, `wicked_reports`, `woocommerce`, `wordpress`, `workable`, `workday_adaptive`, `workday_financial_management`, `workday_hcm`, `workday_strategic_sourcing`, `workday`, `workflowmax`, `workleap_officevibe`, `workramp`, `wrike`, `writesonic`, `xactly`, `xandr`, `xero`, `xray`, `xsolla`, `yahoo_display_ads_on_yahoo_japan`, `yahoo_dsp`, `yahoo_gemini`, `yahoo_search_ads_yahoo_japan`, `yext`, `yotpo_app`, `yotpo`, `yougov_brandindex`, `yougov_sport`, `younium`, `youtube_analytics`, `zendesk_chat`, `zendesk_sell`, `zendesk_sunshine`, `zendesk_workforce_management`, `zendesk`, `zenefits`, `zingtree`, `zip`, `zoho_books`, `zoho_campaigns`, `zoho_crm`, `zoho_desk`, `zoho_inventory`, `zoho_recruit`, `zonka_feedback`, `zoom`, `zuora_sandbox`, `zuora`
*/
name?: string;
/**
* The connector schema prefix has to be unique within the group (destination). Each replicated schema is prefixed with the provided value. Required for connector creation of services:
* `airtable`, `aurora_postgres`, `aurora`, `azure_cosmos_for_mongo`, `azure_postgres`, `azure_sql_db`, `azure_sql_managed_db`, `bigquery_db`, `clarity`, `cockroachdb`, `cosmos`, `databricks_db`, `db2`, `db2i_hva`, `db2i_sap_hva`, `db2luw`, `db2z`, `documentdb`, `dynamics_365_fo`, `ehr`, `epic_clarity`, `google_cloud_mysql`, `google_cloud_postgresql`, `google_cloud_sqlserver`, `hana_sap_hva_b1`, `hana_sap_hva_ecc`, `hana_sap_hva_s4`, `heroku_postgres`, `magento_mysql_rds`, `magento_mysql`, `maria_azure`, `maria_rds`, `maria`, `mongo_sharded`, `mongo`, `mysql_azure`, `mysql_rds`, `mysql`, `oracle_business_intelligence_publisher`, `oracle_ebs`, `oracle_fusion_cloud_apps_crm`, `oracle_fusion_cloud_apps_fscm`, `oracle_fusion_cloud_apps_hcm`, `oracle_hva`, `oracle_rac`, `oracle_rds`, `oracle_sap_hva`, `oracle`, `postgres_rds`, `postgres`, `redshift_db`, `sap_hana_db`, `snowflake_db`, `sql_server_hva`, `sql_server_rds`, `sql_server_sap_ecc_hva`, `sql_server`
*/
prefix?: string;
/**
* The table name unique within the schema to which connector will sync the data. Required for connector creation of services:
* `adroll`, `akamai`, `akeneo`, `algolia`, `amazon_dsp`, `assembled`, `aws_cost_report`, `azure_blob_storage`, `box`, `brave_ads`, `buzzsprout`, `canvas_data_2_by_instructure`, `chargebee_product_catalog_2`, `chargedesk`, `cloudflare_analytics`, `clubspeed`, `constant_contact`, `criteo_retail_media`, `destini`, `double_click_campaign_manager`, `double_click_publishers`, `dropbox_sign`, `dropbox`, `dsv`, `duoplane`, `email`, `eventsforce`, `everflow`, `facebook`, `forj_community`, `freshdesk_contact_center`, `freshsuccess`, `ftp`, `gcs`, `google_analytics`, `google_classroom`, `google_display_and_video_360`, `google_drive`, `google_sheets`, `grin`, `happyfox`, `jama_software`, `jibble`, `justcall`, `kinesis`, `learnupon`, `livechat_partner`, `looker_source`, `mixmax`, `navan`, `open_data_dc`, `paddle`, `referralhero`, `reviewsai`, `revops`, `rollbar`, `s3`, `safebase`, `sftp`, `shiphero`, `sistrix`, `slack`, `sugarcrm`, `teamtailor`, `tive`, `wasabi_cloud_storage`, `webhooks`, `wherefour`, `wordpress`, `workday`, `workleap_officevibe`, `youtube_analytics`
*/
table?: string;
/**
* Table group name. Combined with the schema to form the Fivetran connection name '.'. Required for connector creation of services:
* `azure_blob_storage`, `box`, `dropbox`, `email`, `ftp`, `gcs`, `google_drive`, `s3_compatible_storage`, `s3`, `sftp`, `share_point`, `workday`
*/
tableGroupName?: string;
}
export interface ConnectorFingerprintsFingerprint {
/**
* Hash of the fingerprint.
*/
hash: string;
/**
* The SSH public key.
*/
publicKey: string;
/**
* User name who validated the fingerprint.
*/
validatedBy: string;
/**
* The date when fingerprint was approved.
*/
validatedDate: string;
}
export interface ConnectorScheduleSchedule {
/**
* The cron expression for the sync schedule. Required for CRON schedule type.
*/
cron?: string;
/**
* The days of the week to run the sync. Used with INTERVAL and TIME_OF_DAY schedule types. Supported values: MONDAY, TUESDAY, WEDNESDAY, THURSDAY, FRIDAY, SATURDAY, SUNDAY.
*/
daysOfWeeks?: string[];
/**
* The sync interval in minutes. Required for INTERVAL schedule type.
*/
interval?: number;
/**
* The schedule type. Supported values: INTERVAL, TIME_OF_DAY, CRON, MANUAL.
*/
scheduleType?: string;
/**
* The time of day to run the sync. Required for TIME_OF_DAY schedule type. Supported values: "00:00" to "23:00".
*/
timeOfDay?: string;
}
export interface ConnectorSchemaConfigSchema {
/**
* The boolean value specifying whether the sync for the schema into the destination is enabled.
*/
enabled: boolean;
/**
* The schema name within your destination in accordance with Fivetran conventional rules.
*/
name: string;
tables?: outputs.ConnectorSchemaConfigSchemaTable[];
}
export interface ConnectorSchemaConfigSchemaTable {
columns?: outputs.ConnectorSchemaConfigSchemaTableColumn[];
/**
* The boolean value specifying whether the sync of table into the destination is enabled.
*/
enabled: boolean;
/**
* The table name within your destination in accordance with Fivetran conventional rules.
*/
name: string;
/**
* This field appears in the response if the connector supports switching sync modes for tables.
*/
syncMode: string;
}
export interface ConnectorSchemaConfigSchemaTableColumn {
/**
* The boolean value specifying whether the sync of the column into the destination is enabled.
*/
enabled: boolean;
/**
* The boolean value specifying whether a column should be hashed.
*/
hashed: boolean;
/**
* Boolean value indicating if the column is a primary key. This field is read-only and computed by the API.
*/
isPrimaryKey: boolean;
/**
* The column name within your destination in accordance with Fivetran conventional rules.
*/
name: string;
}
export interface ConnectorSchemaConfigSchemas {
/**
* The boolean value specifying whether the sync for the schema into the destination is enabled.
*/
enabled: boolean;
/**
* Map of table configurations.
*/
tables?: {
[key: string]: outputs.ConnectorSchemaConfigSchemasTables;
};
}
export interface ConnectorSchemaConfigSchemasTables {
/**
* Map of table configurations.
*/
columns?: {
[key: string]: outputs.ConnectorSchemaConfigSchemasTablesColumns;
};
/**
* The boolean value specifying whether the sync for the table into the destination is enabled.
*/
enabled: boolean;
/**
* This field appears in the response if the connector supports switching sync modes for tables.
*/
syncMode: string;
}
export interface ConnectorSchemaConfigSchemasTablesColumns {
/**
* The boolean value specifying whether the sync of the column into the destination is enabled.
*/
enabled: boolean;
/**
* The boolean value specifying whether a column should be hashed.
*/
hashed: boolean;
/**
* Boolean value indicating if the column is a primary key. This field is read-only and computed by the API.
*/
isPrimaryKey: boolean;
}
export interface ConnectorSchemaConfigTimeouts {
/**
* A string that can be [parsed as a duration](https://pkg.go.dev/time#ParseDuration) consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours).
*/
create?: string;
/**
* A string that can be [parsed as a duration](https://pkg.go.dev/time#ParseDuration) consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours). Read operations occur during any refresh or planning operation when refresh is enabled.
*/
read?: string;
/**
* A string that can be [parsed as a duration](https://pkg.go.dev/time#ParseDuration) consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours).
*/
update?: string;
}
export interface ConnectorTimeouts {
/**
* A string that can be [parsed as a duration](https://pkg.go.dev/time#ParseDuration) consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours).
*/
create?: string;
/**
* A string that can be [parsed as a duration](https://pkg.go.dev/time#ParseDuration) consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours).
*/
update?: string;
}
export interface DestinationCertificatesCertificate {
/**
* Base64 encoded certificate.
*/
encodedCert: string;
/**
* Hash of the certificate.
*/
hash: string;
/**
* Certificate name.
*/
name: string;
/**
* The SSH public key.
*/
publicKey: string;
/**
* Certificate sha1.
*/
sha1: string;
/**
* Certificate sha256.
*/
sha256: string;
/**
* Type of the certificate.
*/
type: string;
/**
* User name who validated the certificate.
*/
validatedBy: string;
/**
* The date when certificate was approved.
*/
validatedDate: string;
}
export interface DestinationConfig {
/**
* Field usage depends on `service` value:
* - Service `aurora_postgres_warehouse`: Specifies whether TLS is required. Must be populated if `connection_type` is set to `SshTunnel`.
* - Service `aurora_warehouse`: Specifies whether TLS is required. Must be populated if `connection_type` is set to `SshTunnel`.
* - Service `azure_postgres_warehouse`: Specifies whether TLS is required. Must be populated if `connection_type` is set to `SshTunnel`.
* - Service `azure_sql_data_warehouse`: Specifies whether TLS is required. Must be populated if `connection_type` is set to `SshTunnel`.
* - Service `azure_sql_database`: Specifies whether TLS is required. Must be populated if `connection_type` is set to `SshTunnel`.
* - Service `azure_sql_managed_db_warehouse`: Specifies whether TLS is required. Must be populated if `connection_type` is set to `SshTunnel`.
* - Service `maria_rds_warehouse`: Specifies whether TLS is required. Must be populated if `connection_type` is set to `SshTunnel`.
* - Service `maria_warehouse`: Specifies whether TLS is required. Must be populated if `connection_type` is set to `SshTunnel`.
* - Service `mysql_rds_warehouse`: Specifies whether TLS is required. Must be populated if `connection_type` is set to `SshTunnel`.
* - Service `mysql_warehouse`: Specifies whether TLS is required. Must be populated if `connection_type` is set to `SshTunnel`.
* - Service `oracle_rac_warehouse`: Specifies whether TLS is required. Must be populated if `connection_type` is set to `SshTunnel`.
* - Service `oracle_rds_warehouse`: Specifies whether TLS is required. Must be populated if `connection_type` is set to `SshTunnel`.
* - Service `oracle_warehouse`: Specifies whether TLS is required. Must be populated if `connection_type` is set to `SshTunnel`.
* - Service `panoply`: Specifies whether TLS is required. Must be populated if `connection_type` is set to `SshTunnel`.
* - Service `periscope_warehouse`: Specifies whether TLS is required. Must be populated if `connection_type` is set to `SshTunnel`.
* - Service `postgres_databricks_warehouse`: Specifies whether TLS is required. Must be populated if `connection_type` is set to `SshTunnel`.
* - Service `postgres_gcp_warehouse`: Specifies whether TLS is required. Must be populated if `connection_type` is set to `SshTunnel`.
* - Service `postgres_rds_warehouse`: Specifies whether TLS is required. Must be populated if `connection_type` is set to `SshTunnel`.
* - Service `postgres_warehouse`: Specifies whether TLS is required. Must be populated if `connection_type` is set to `SshTunnel`.
* - Service `redshift`: Require TLS through Tunnel
* - Service `sql_server_rds_warehouse`: Specifies whether TLS is required. Must be populated if `connection_type` is set to `SshTunnel`.
* - Service `sql_server_warehouse`: Specifies whether TLS is required. Must be populated if `connection_type` is set to `SshTunnel`.
*/
alwaysEncrypted: boolean;
/**
* Field usage depends on `service` value:
* - Service `snowflake`: Application ID of your app created in Azure
*/
applicationId?: string;
/**
* Field usage depends on `service` value:
* - Service `snowflake`: Password-based or key-based authentication type
*/
auth: string;
/**
* Field usage depends on `service` value:
* - Service `aurora_postgres_warehouse`: Authentication method. Default value: `PASSWORD`.
* - Service `azure_postgres_warehouse`: Authentication method. Default value: `PASSWORD`.
* - Service `postgres_databricks_warehouse`: Authentication method. Default value: `PASSWORD`.
* - Service `postgres_gcp_warehouse`: Authentication method. Default value: `PASSWORD`.
* - Service `postgres_rds_warehouse`: Authentication method. Default value: `PASSWORD`.
* - Service `postgres_warehouse`: Authentication method. Default value: `PASSWORD`.
*/
authMethod: string;
/**
* Field usage depends on `service` value:
* - Service `adls`: Authentication type
* - Service `databricks`: Authentication type
* - Service `managed_data_lake`: Specifies the authentication types for Fivetran to connect to Databricks. Use this parameter only if you want to use Unity Catalog to manage your Delta Lake tables.
* - Service `new_s3_datalake`: Authentication type
* - Service `onelake`: Authentication type
* - Service `redshift`: Authentication type. Default value: `PASSWORD`.
*/
authType: string;
/**
* Field usage depends on `service` value:
* - Service `databricks`: Your user's access key ID
* - Service `new_s3_datalake`: AWS access key to access the S3 bucket and AWS Glue
* - Service `redshift`: The unique access key ID of the S3 bucket you want to use to stage your data. Use this parameter only if you are using Hybrid Deployment.
* - Service `snowflake`: The unique access key ID of the S3 bucket you want to use to stage your data. Use this parameter only if you are using Hybrid Deployment, want to use an S3 bucket to stage your data, and `awsBucketAuthType` is set to `IAM_USER`.
*/
awsAccessKeyId?: string;
/**
* Field usage depends on `service` value:
* - Service `snowflake`: Type of authentication configured for the S3 bucket you want to use to stage your data. Use this parameter only if you are using Hybrid Deployment and want to use an S3 bucket to stage your data.
*/
awsBucketAuthType: string;
/**
* Field usage depends on `service` value:
* - Service `aurora_postgres_warehouse`: AWS region where the Aurora cluster is located. Required when `auth_method` is set to `AWS_IAM`.
* - Service `azure_postgres_warehouse`: AWS region code. Required when `auth_method` is set to `AWS_IAM`.
* - Service `postgres_databricks_warehouse`: AWS region code. Required when `auth_method` is set to `AWS_IAM`.
* - Service `postgres_gcp_warehouse`: AWS region code. Required when `auth_method` is set to `AWS_IAM`.
* - Service `postgres_rds_warehouse`: AWS region where the RDS instance is located. Required when `auth_method` is set to `AWS_IAM`.
* - Service `postgres_warehouse`: AWS region code. Required when `auth_method` is set to `AWS_IAM`.
*/
awsRegionCode: string;
/**
* Field usage depends on `service` value:
* - Service `databricks`: Your user's secret access key
* - Service `new_s3_datalake`: AWS secret access key to access the S3 bucket and AWS Glue
* - Service `redshift`: The secret access key of the S3 bucket you want to use to stage your data. Use this parameter only if you are using Hybrid Deployment.
* - Service `snowflake`: The secret access key of the S3 bucket you want to use to stage your data. Use this parameter only if you are using Hybrid Deployment , want to use an S3 bucket to stage your data, and `awsBucketAuthType` is set to `IAM_USER`.
*/
awsSecretAccessKey?: string;
/**
* Field usage depends on `service` value:
* - Service `databricks`: Authentication method for the Azure container you want to use as the external staging for Hybrid Deployment.
*/
azureStorageAccountAuthType?: string;
/**
* Field usage depends on `service` value:
* - Service `confluent_cloud_wh`: Comma-separated list of Confluent Cloud servers in the `server:port` format.
*/
bootstrapServers?: string[];
/**
* Field usage depends on `service` value:
* - Service `big_query`: Customer bucket. If specified, your GCS bucket will be used to process the data instead of a Fivetran-managed bucket. The bucket must be present in the same location as the dataset location.
* - Service `big_query_dts`: Customer bucket. If specified, your GCS bucket will be used to process the data instead of a Fivetran-managed bucket. The bucket must be present in the same location as the dataset location.
* - Service `databricks`: Your bucket
* - Service `managed_big_query`: Customer bucket. If specified, your GCS bucket will be used to process the data instead of a Fivetran-managed bucket. The bucket must be present in the same location as the dataset location.
* - Service `managed_data_lake`: (Immutable) Name of the S3 or Google Cloud Storage (GCS) bucket you want to use to store your data. Use this parameter only if you want to deploy your data lake on Amazon Web Services (AWS) or GCS.
* - Service `new_s3_datalake`: (Immutable) The name of the bucket to be used as destination
* - Service `redshift`: The name of the storage bucket you want to use to stage your data. Use this parameter only if you are using Hybrid Deployment.
* - Service `snowflake`: The name of the storage bucket you want to use to stage your data. Use this parameter only if you are using Hybrid Deployment and want to use an S3 or GCS bucket to stage your data.
*/
bucket?: string;
/**
* Field usage depends on `service` value:
* - Service `databricks`: Your bucket's region
* - Service `redshift`: The AWS Region of the S3 bucket you want to use to stage your data. Use this parameter only if you are using Hybrid Deployment.
* - Service `snowflake`: The AWS Region of the S3 bucket you want to use to stage your data. Use this parameter only if you are using Hybrid Deployment and want to use an S3 bucket to stage your data.
*/
bucketRegion?: string;
/**
* Field usage depends on `service` value:
* - Service `adls`: Catalog name
* - Service `databricks`: Catalog name
* - Service `managed_data_lake`: Name of the specific catalog in Unity Catalog that you want to use to manage your Delta Lake tables. Use this parameter only if you want to use Unity Catalog with your data lake.
* - Service `new_s3_datalake`: Catalog name
* - Service `onelake`: Catalog name
*/
catalog?: string;
/**
* Field usage depends on `service` value:
* - Service `adls`: Client id of service principal
* - Service `managed_data_lake`: Client ID of the service principal you created for Fivetran. Use this parameter only if you want to deploy your data lake on ADLS.
* - Service `onelake`: Client ID of service principal
*/
clientId?: string;
/**
* Field usage depends on `service` value:
* - Service `databricks`: Databricks deployment cloud
*/
cloudProvider: string;
/**
* Field usage depends on `service` value:
* - Service `panoply`: Cluster ID.
* - Service `periscope_warehouse`: Cluster ID.
* - Service `redshift`: Cluster ID. Must be populated if `connection_type` is set to `SshTunnel` and `auth_type` is set to `IAM`.
*/
clusterId?: string;
/**
* Field usage depends on `service` value:
* - Service `panoply`: Cluster region.
* - Service `periscope_warehouse`: Cluster region.
* - Service `redshift`: Cluster region. Must be populated if `connection_type` is set to `SshTunnel` and `auth_type` is set to `IAM`.
*/
clusterRegion?: string;
connectionMethod: string;
/**
* Field usage depends on `service` value:
* - Service `adls`: Connection method. Default value: `Directly`.
* - Service `aurora_postgres_warehouse`: Connection method. Default value: `Directly`.
* - Service `aurora_warehouse`: Connection method. Default value: `Directly`.
* - Service `azure_postgres_warehouse`: Connection method. Default value: `Directly`.
* - Service `azure_sql_data_warehouse`: Connection method. Default value: `Directly`.
* - Service `azure_sql_database`: Connection method. Default value: `Directly`.
* - Service `azure_sql_managed_db_warehouse`: Connection method. Default value: `Directly`.
* - Service `databricks`: Connection method. Default value: `Directly`.
* - Service `managed_data_lake`: connection type
* - Service `maria_rds_warehouse`: Connection method. Default value: `Directly`.
* - Service `maria_warehouse`: Connection method. Default value: `Directly`.
* - Service `mysql_rds_warehouse`: Connection method. Default value: `Directly`.
* - Service `mysql_warehouse`: Connection method. Default value: `Directly`.
* - Service `oracle_rac_warehouse`: Connection method. Default value: `Directly`.
* - Service `oracle_rds_warehouse`: Connection method. Default value: `Directly`.
* - Service `oracle_warehouse`: Connection method. Default value: `Directly`.
* - Service `panoply`: Connection method. Default value: `Directly`.
* - Service `periscope_warehouse`: Connection method. Default value: `Directly`.
* - Service `postgres_databricks_warehouse`: Connection method. Default value: `Directly`.
* - Service `postgres_gcp_warehouse`: Connection method. Default value: `Directly`.
* - Service `postgres_rds_warehouse`: Connection method. Default value: `Directly`.
* - Service `postgres_warehouse`: Connection method. Default value: `Directly`.
* - Service `redshift`: Connection method. Default value: `Directly`.
* - Service `snowflake`: Connection method. Default value: `Directly`.
* - Service `sql_server_rds_warehouse`: Connection method. Default value: `Directly`.
* - Service `sql_server_warehouse`: Connection method. Default value: `Directly`.
*/
connectionType: string;
/**
* Field usage depends on `service` value:
* - Service `adls`: (Immutable) Container to store delta table files
* - Service `managed_data_lake`: (Immutable) Name of the ADLS container you want to use to store your data. Use this parameter only if you want to deploy your data lake on ADLS.
* - Service `onelake`: Workspace name to store delta table files
*/
containerName?: string;
controllerId?: string;
/**
* Field usage depends on `service` value:
* - Service `databricks`: Whether to create external tables
*/
createExternalTables: boolean;
/**
* Field usage depends on `service` value:
* - Service `databricks`: Specifies whether you want Fivetran to create external volumes for unstructured data files.
*/
createExternalVolumes: boolean;
/**
* Field usage depends on `service` value:
* - Service `confluent_cloud_wh`: Confluent Cloud message format.
*/
dataFormat: string;
/**
* Field usage depends on `service` value:
* - Service `big_query`: Data location. Datasets will reside in this location.
* - Service `big_query_dts`: Data location. Datasets will reside in this location.
* - Service `managed_big_query`: Data location. Datasets will reside in this location.
*/
dataSetLocation?: string;
/**
* Field usage depends on `service` value:
* - Service `aurora_postgres_warehouse`: Database name
* - Service `aurora_warehouse`: Database name
* - Service `azure_postgres_warehouse`: Database name
* - Service `azure_sql_data_warehouse`: Database name
* - Service `azure_sql_database`: Database name
* - Service `azure_sql_managed_db_warehouse`: Database name
* - Service `maria_rds_warehouse`: Database name
* - Service `maria_warehouse`: Database name
* - Service `mysql_rds_warehouse`: Database name
* - Service `mysql_warehouse`: Database name
* - Service `oracle_rac_warehouse`: Service Name
* - Service `oracle_rds_warehouse`: Database name
* - Service `oracle_warehouse`: Database name
* - Service `panoply`: Database name
* - Service `periscope_warehouse`: Database name
* - Service `postgres_databricks_warehouse`: Database name
* - Service `postgres_gcp_warehouse`: Database name
* - Service `postgres_rds_warehouse`: Database name
* - Service `postgres_warehouse`: Database name
* - Service `redshift`: Database name
* - Service `snowflake`: Database name
* - Service `sql_server_rds_warehouse`: Database name
* - Service `sql_server_warehouse`: Database name
*/
database?: string;
/**
* Field usage depends on `service` value:
* - Service `adls`: Databricks Connection method. Default value: `Directly`.
* - Service `managed_data_lake`: Specifies how you want Fivetran to connect to the Databricks account associated with Unity Catalog. Default value: `Directly`. Use this parameter only if you want to use Unity Catalog with your data lake.
* - Service `new_s3_datalake`: Databricks Connection method. Default value: `Directly`.
* - Service `onelake`: Databricks Connection method. Default value: `Directly`.
*/
databricksConnectionType: string;
/**
* Field usage depends on `service` value:
* - Service `snowflake`: The virtual warehouse to use for running queries.
*/
defaultVirtualWarehouse?: string;
/**
* Field usage depends on `service` value:
* - Service `snowflake`: Tenant ID of your app created in Azure
*/
directoryId?: string;
/**
* Field usage depends on `service` value:
* - Service `databricks`: Specifies whether you want Fivetran to disable Vacuum operations on Delta tables.
*/
disableVacuum: boolean;
/**
* Field usage depends on `service` value:
* - Service `snowflake`: Set to `true` if you want to enable external storage for unstructured files.
*/
enableExternalStorageForUnstructuredFiles: boolean;
enableRemoteExecution: boolean;
/**
* Field usage depends on `service` value:
* - Service `confluent_cloud_wh`: Populate all tables in a single topic.
*/
enableSingleTopic: boolean;
/**
* Field usage depends on `service` value:
* - Service `redshift`: Enable to convert JSON data type to SUPER
*/
enableSuperType: boolean;
/**
* Field usage depends on `service` value:
* - Service `aurora_postgres_warehouse`: AWS external ID for authentication. Required when `auth_method` is set to `AWS_IAM`.
* - Service `aws_msk_wh`: Fivetran generated External ID
* - Service `azure_postgres_warehouse`: AWS external ID for authentication. Required when `auth_method` is set to `AWS_IAM`.
* - Service `panoply`: Fivetran generated External ID
* - Service `periscope_warehouse`: Fivetran generated External ID
* - Service `postgres_databricks_warehouse`: AWS external ID for authentication. Required when `auth_method` is set to `AWS_IAM`.
* - Service `postgres_gcp_warehouse`: AWS external ID for authentication. Required when `auth_method` is set to `AWS_IAM`.
* - Service `postgres_rds_warehouse`: AWS external ID for authentication. Required when `auth_method` is set to `AWS_IAM`.
* - Service `postgres_warehouse`: AWS external ID for authentication. Required when `auth_method` is set to `AWS_IAM`.
* - Service `redshift`: Fivetran generated External ID
*/
externalId: string;
/**
* Field usage depends on `service` value:
* - Service `databricks`: External location to store Delta tables. Default value: `""` (null). By default, the external tables will reside in the `/{schema}/{table}` path, and if you specify an external location in the `{externalLocation}/{schema}/{table}` path.
*/
externalLocation?: string;
/**
* Field usage depends on `service` value:
* - Service `snowflake`: External stage storage provider[Internal, S3, Azure,GCS]
*/
externalStageStorageProvider: string;
/**
* Field usage depends on `service` value:
* - Service `snowflake`: The cloud service provider you want to use for staging data. Use this parameter only if you are using Hybrid Deployment.
*/
externalStorageCloudProvider: string;
/**
* Field usage depends on `service` value:
* - Service `snowflake`: External storage integration name
*/
externalStorageIntegration?: string;
/**
* Field usage depends on `service` value:
* - Service `snowflake`: External storage parent folder URL
*/
externalStorageParentFolderUri?: string;
/**
* Field usage depends on `service` value:
* - Service `databricks`: Specifies the external volume path where you want Fivetran to create the unstructured files.
*/
externalVolumeLocation?: string;
fivetranGlueRoleArn?: string;
fivetranMskRoleArn?: string;
/**
* Field usage depends on `service` value:
* - Service `managed_data_lake`: (Immutable) ARN of the IAM role you created for the IAM policy associated with your S3 bucket or Glue catalog. Use this parameter only if you want to deploy your data lake on AWS.
* - Service `new_s3_datalake`: ARN of the role which you created with different required policy mentioned in our setup guide
*/
fivetranRoleArn?: string;
/**
* Field usage depends on `service` value:
* - Service `snowflake`: The path to the JSON file that contains the service account credentials for the GCS bucket you want to use to stage your data. Use this parameter only if you are using Hybrid Deployment and want to use a GCS bucket to stage your data.
*/
gcsServiceAccountCredentialsPath?: string;
/**
* Field usage depends on `service` value:
* - Service `aurora_postgres_warehouse`: Server name
* - Service `aurora_warehouse`: Server name
* - Service `azure_postgres_warehouse`: Server name
* - Service `azure_sql_data_warehouse`: Server name
* - Service `azure_sql_database`: Server name
* - Service `azure_sql_managed_db_warehouse`: Server name
* - Service `maria_rds_warehouse`: Server name
* - Service `maria_warehouse`: Server name
* - Service `mysql_rds_warehouse`: Server name
* - Service `mysql_warehouse`: Server name
* - Service `oracle_rac_warehouse`: Server name
* - Service `oracle_rds_warehouse`: Server name
* - Service `oracle_warehouse`: Server name
* - Service `panoply`: Server name
* - Service `periscope_warehouse`: Server name
* - Service `postgres_databricks_warehouse`: Server name
* - Service `postgres_gcp_warehouse`: Server name
* - Service `postgres_rds_warehouse`: Server name
* - Service `postgres_warehouse`: Server name
* - Service `redshift`: Server name
* - Service `snowflake`: Server name
* - Service `sql_server_rds_warehouse`: Server name
* - Service `sql_server_warehouse`: Server name
*/
host?: string;
/**
* Field usage depends on `service` value:
* - Service `adls`: HTTP path
* - Service `databricks`: HTTP path
* - Service `managed_data_lake`: HTTP path of the Databricks account associated with Unity Catalog. Use this parameter only if you want to use Unity Catalog to manage your Delta Lake tables.
* - Service `new_s3_datalake`: HTTP path
* - Service `onelake`: HTTP path
*/
httpPath?: string;
/**
* Field usage depends on `service` value:
* - Service `snowflake`: Indicates that a private key is encrypted. The default value: `false`. The field can be specified if authentication type is `KEY_PAIR`.
*/
isPrivateKeyEncrypted: boolean;
/**
* Field usage depends on `service` value:
* - Service `new_s3_datalake`: We use PrivateLink by default if your s3 bucket is in the same region as Fivetran. Turning on this toggle ensures that Fivetran always connects to s3 bucket over PrivateLink. Learn more in our [PrivateLink documentation](https://fivetran.com/docs/connectors/databases/connection-options/aws-private-link).
*/
isPrivateLinkRequired: boolean;
/**
* Field usage depends on `service` value:
* - Service `redshift`: Is your destination Redshift Serverless
*/
isRedshiftServerless: boolean;
/**
* Field usage depends on `service` value:
* - Service `managed_data_lake`: (Immutable) OneLake lakehouse GUID.
* - Service `onelake`: (Immutable) OneLake lakehouse GUID
*/
lakehouseGuid?: string;
/**
* Field usage depends on `service` value:
* - Service `onelake`: (Immutable) Name of your lakehouse
*/
lakehouseName?: string;
mskStsRegion?: string;
/**
* Field usage depends on `service` value:
* - Service `confluent_cloud_wh`: Number of partitions per topic.
*/
numOfPartitions: number;
/**
* Field usage depends on `service` value:
* - Service `adls`: OAuth 2.0 client ID
* - Service `databricks`: OAuth 2.0 client ID
* - Service `managed_data_lake`: The OAuth 2.0 client ID you created for authenticating Fivetran. Use this parameter only if you want to use OAuth 2.0 as the authentication type for Fivetran to connect to Databricks.
* - Service `new_s3_datalake`: OAuth 2.0 client ID
* - Service `onelake`: OAuth 2.0 client ID
*/
oauth2ClientId?: string;
/**
* Field usage depends on `service` value:
* - Service `adls`: OAuth 2.0 secret
* - Service `databricks`: OAuth 2.0 secret
* - Service `managed_data_lake`: OAuth 2.0 secret you created for authenticating Fivetran. Use this parameter only if you want to use OAuth 2.0 as the authentication type for Fivetran to connect to Databricks.
* - Service `new_s3_datalake`: OAuth 2.0 secret
* - Service `onelake`: OAuth 2.0 secret
*/
oauth2Secret?: string;
/**
* Field usage depends on `service` value:
* - Service `managed_data_lake`: (Immutable) Client ID of OneLake service principal.
*/
onelakeClientId?: string;
/**
* Field usage depends on `service` value:
* - Service `managed_data_lake`: Secret value for OneLake service principal.
*/
onelakeClientSecret?: string;
/**
* Field usage depends on `service` value:
* - Service `managed_data_lake`: (Immutable) Tenant ID of OneLake service principal
*/
onelakeTenantId?: string;
/**
* Field usage depends on `service` value:
* - Service `snowflake`: In case private key is encrypted, you are required to enter passphrase that was used to encrypt the private key. The field can be specified if authentication type is `KEY_PAIR`.
*/
passphrase?: string;
/**
* Field usage depends on `service` value:
* - Service `aurora_postgres_warehouse`: Database user password
* - Service `aurora_warehouse`: Database user password
* - Service `azure_postgres_warehouse`: Database user password
* - Service `azure_sql_data_warehouse`: Database user password
* - Service `azure_sql_database`: Database user password
* - Service `azure_sql_managed_db_warehouse`: Database user password
* - Service `maria_rds_warehouse`: Database user password
* - Service `maria_warehouse`: Database user password
* - Service `mysql_rds_warehouse`: Database user password
* - Service `mysql_warehouse`: Database user password
* - Service `oracle_rac_warehouse`: Database user password
* - Service `oracle_rds_warehouse`: Database user password
* - Service `oracle_warehouse`: Database user password
* - Service `panoply`: Database user password
* - Service `periscope_warehouse`: Database user password
* - Service `postgres_databricks_warehouse`: Database user password
* - Service `postgres_gcp_warehouse`: Database user password
* - Service `postgres_rds_warehouse`: Database user password
* - Service `postgres_warehouse`: Database user password
* - Service `redshift`: Database user password. Required if authentication type is `PASSWORD`.
* - Service `snowflake`: Database user password. The field should be specified if authentication type is `PASSWORD`.
* - Service `sql_server_rds_warehouse`: Database user password
* - Service `sql_server_warehouse`: Database user password
*/
password?: string;
/**
* Field usage depends on `service` value:
* - Service `adls`: Personal access token
* - Service `databricks`: Personal access token
* - Service `managed_data_lake`: The personal access token you created for authenticating Fivetran. Use this parameter only if you want to use a personal access token as the authentication type for Fivetran to connect to Databricks.
* - Service `new_s3_datalake`: Personal access token
* - Service `onelake`: Personal access token
*/
personalAccessToken?: string;
/**
* Field usage depends on `service` value:
* - Service `adls`: Server port number
* - Service `aurora_postgres_warehouse`: Server port number
* - Service `aurora_warehouse`: Server port number
* - Service `azure_postgres_warehouse`: Server port number
* - Service `azure_sql_data_warehouse`: Server port number
* - Service `azure_sql_database`: Server port number
* - Service `azure_sql_managed_db_warehouse`: Server port number
* - Service `databricks`: Server port number
* - Service `managed_data_lake`: Server port number of the Databricks account associated with Unity Catalog. Use this parameter only if you want to use Unity Catalog to manage your Delta Lake tables.
* - Service `maria_rds_warehouse`: Server port number
* - Service `maria_warehouse`: Server port number
* - Service `mysql_rds_warehouse`: Server port number
* - Service `mysql_warehouse`: Server port number
* - Service `new_s3_datalake`: Server port number
* - Service `onelake`: Server port number
* - Service `oracle_rac_warehouse`: Server port number
* - Service `oracle_rds_warehouse`: Server port number
* - Service `oracle_warehouse`: Server port number
* - Service `panoply`: Server port number
* - Service `periscope_warehouse`: Server port number
* - Service `postgres_databricks_warehouse`: Server port number
* - Service `postgres_gcp_warehouse`: Server port number
* - Service `postgres_rds_warehouse`: Server port number
* - Service `postgres_warehouse`: Server port number
* - Service `redshift`: Server port number
* - Service `snowflake`: Server port number
* - Service `sql_server_rds_warehouse`: Server port number
* - Service `sql_server_warehouse`: Server port number
*/
port: number;
/**
* Field usage depends on `service` value:
* - Service `adls`: (Immutable) path/to/data within the container
* - Service `managed_data_lake`: (Immutable) Prefix path or virtual folder path within your bucket or container where you want Fivetran to store your data. Skip this parameter for AWS-based data lakes if the IAM policy configured for your S3 bucket grants access to the entire bucket.
* - Service `new_s3_datalake`: (Immutable) Prefix path of the bucket for which you have configured access policy. It is not required if access has been granted to entire Bucket in the access policy
* - Service `onelake`: (Immutable) path/to/data within your lakehouse inside the Files directory
*/
prefixPath?: string;
/**
* Field usage depends on `service` value:
* - Service `snowflake`: Private access key. The field should be specified if authentication type is `KEY_PAIR`.
*/
privateKey?: string;
/**
* Field usage depends on `service` value:
* - Service `big_query`: BigQuery project ID
*/
projectId?: string;
/**
* Field usage depends on `service` value:
* - Service `aurora_postgres_warehouse`: Public Key
* - Service `aurora_warehouse`: Public Key
* - Service `azure_postgres_warehouse`: Public Key
* - Service `azure_sql_data_warehouse`: Public Key
* - Service `azure_sql_database`: Public Key
* - Service `azure_sql_managed_db_warehouse`: Public Key
* - Service `maria_rds_warehouse`: Public Key
* - Service `maria_warehouse`: Public Key
* - Service `mysql_rds_warehouse`: Public Key
* - Service `mysql_warehouse`: Public Key
* - Service `panoply`: Public Key
* - Service `periscope_warehouse`: Public Key
* - Service `postgres_gcp_warehouse`: Public Key
* - Service `postgres_rds_warehouse`: Public Key
* - Service `postgres_warehouse`: Public Key
* - Service `redshift`: Public Key
* - Service `sql_server_rds_warehouse`: Public Key
* - Service `sql_server_warehouse`: Public Key
*/
publicKey: string;
/**
* Field usage depends on `service` value:
* - Service `managed_data_lake`: (Immutable) AWS Region of your S3 bucket. Use this parameter only if you want to deploy your data lake on AWS.
* - Service `new_s3_datalake`: Region of your AWS S3 bucket
*/
region?: string;
registryName?: string;
registryStsRegion?: string;
/**
* Field usage depends on `service` value:
* - Service `confluent_cloud_wh`: Replication factor.
*/
replicationFactor: number;
/**
* Field usage depends on `service` value:
* - Service `aurora_postgres_warehouse`: This field is currently being introduced to test the Self-serve Private Link functionality
* - Service `aurora_warehouse`: This field is currently being introduced to test the Self-serve Private Link functionality
* - Service `azure_postgres_warehouse`: This field is currently being introduced to test the Self-serve Private Link functionality
* - Service `azure_sql_data_warehouse`: This field is currently being introduced to test the Self-serve Private Link functionality
* - Service `azure_sql_database`: Field to test Self serve Private Link
* - Service `azure_sql_managed_db_warehouse`: Field to test Self serve Private Link
* - Service `databricks`: This field is currently being introduced to test the Self-serve Private Link functionality
* - Service `maria_rds_warehouse`: This field is currently being introduced to test the Self-serve Private Link functionality
* - Service `maria_warehouse`: This field is currently being introduced to test the Self-serve Private Link functionality
* - Service `mysql_rds_warehouse`: This field is currently being introduced to test the Self-serve Private Link functionality
* - Service `mysql_warehouse`: This field is currently being introduced to test the Self-serve Private Link functionality
* - Service `panoply`: This field is currently being introduced to test the Self-serve Private Link functionality
* - Service `periscope_warehouse`: This field is currently being introduced to test the Self-serve Private Link functionality
* - Service `postgres_gcp_warehouse`: This field is currently being introduced to test the Self-serve Private Link functionality
* - Service `postgres_rds_warehouse`: This field is currently being introduced to test the Self-serve Private Link functionality
* - Service `postgres_warehouse`: This field is currently being introduced to test the Self-serve Private Link functionality
* - Service `redshift`: This field is currently being introduced to test the Self-serve Private Link functionality
* - Service `snowflake`: This field is currently being introduced to test the Self-serve Private Link functionality
* - Service `sql_server_rds_warehouse`: Field to test Self serve Private Link
* - Service `sql_server_warehouse`: Field to test Self serve Private Link
*/
resourceId?: string;
/**
* Field usage depends on `service` value:
* - Service `snowflake`: If not specified, Fivetran will use the user's default role
*/
role?: string;
/**
* Field usage depends on `service` value:
* - Service `aurora_postgres_warehouse`: AWS IAM role ARN for authentication. Required when `auth_method` is set to `AWS_IAM`.
* - Service `azure_postgres_warehouse`: AWS IAM role ARN for authentication. Required when `auth_method` is set to `AWS_IAM`.
* - Service `postgres_databricks_warehouse`: AWS IAM role ARN for authentication. Required when `auth_method` is set to `AWS_IAM`.
* - Service `postgres_gcp_warehouse`: AWS IAM role ARN for authentication. Required when `auth_method` is set to `AWS_IAM`.
* - Service `postgres_rds_warehouse`: AWS IAM role ARN for authentication. Required when `auth_method` is set to `AWS_IAM`.
* - Service `postgres_warehouse`: AWS IAM role ARN for authentication. Required when `auth_method` is set to `AWS_IAM`.
* - Service `redshift`: Role ARN with Redshift permissions. Required if authentication type is `IAM`.
*/
roleArn?: string;
/**
* Field usage depends on `service` value:
* - Service `databricks`: Authentication method for the S3 bucket you want to use as the external staging for Hybrid Deployment.
* - Service `redshift`: Type of authentication configured for the S3 bucket you want to use to stage your data. Use this parameter only if you are using Hybrid Deployment
*/
s3BucketAuthType: string;
/**
* Field usage depends on `service` value:
* - Service `confluent_cloud_wh`: Security protocol for Confluent Cloud interaction.
*/
saslMechanism: string;
/**
* Field usage depends on `service` value:
* - Service `confluent_cloud_wh`: Confluent Cloud SASL key.
*/
saslPlainKey?: string;
/**
* Field usage depends on `service` value:
* - Service `confluent_cloud_wh`: Confluent Cloud SASL secret.
*/
saslPlainSecret?: string;
schemaCompatibility: string;
/**
* Field usage depends on `service` value:
* - Service `confluent_cloud_wh`: Schema Registry
*/
schemaRegistry: string;
/**
* Field usage depends on `service` value:
* - Service `confluent_cloud_wh`: Schema registry API key.
*/
schemaRegistryApiKey?: string;
/**
* Field usage depends on `service` value:
* - Service `confluent_cloud_wh`: Schema registry API secret.
*/
schemaRegistryApiSecret?: string;
/**
* Field usage depends on `service` value:
* - Service `confluent_cloud_wh`: Schema registry URL.
*/
schemaRegistryUrl?: string;
/**
* Field usage depends on `service` value:
* - Service `big_query`: Private key of the customer service account. If specified, your service account will be used to process the data instead of the Fivetran-managed service account.
* - Service `big_query_dts`: Private key of the customer service account. If specified, your service account will be used to process the data instead of the Fivetran-managed service account.
* - Service `managed_big_query`: Private key of the customer service account. If specified, your service account will be used to process the data instead of the Fivetran-managed service account.
*/
secretKey?: string;
/**
* Field usage depends on `service` value:
* - Service `adls`: Secret value for service principal
* - Service `managed_data_lake`: Secret value of the service principal you created for Fivetran. Use this parameter only if you want to deploy your data lake on ADLS.
* - Service `onelake`: Secret value for service principal
*/
secretValue?: string;
/**
* Field usage depends on `service` value:
* - Service `confluent_cloud_wh`: Security protocol for Confluent Cloud interaction.
*/
securityProtocol: string;
/**
* Field usage depends on `service` value:
* - Service `adls`: Server Host name
* - Service `databricks`: Server name
* - Service `managed_data_lake`: Server host name of the Databricks account associated with Unity Catalog. Use this parameter only if you want to use Unity Catalog to manage your Delta Lake tables.
* - Service `new_s3_datalake`: Server host name
* - Service `onelake`: Server Host name
*/
serverHostName?: string;
/**
* Field usage depends on `service` value:
* - Service `adls`: Should maintain tables in Databricks
* - Service `managed_data_lake`: Specifies whether you want to manage your Delta Lake tables in Databricks Unity Catalog.
* - Service `new_s3_datalake`: Should maintain tables in Databricks
* - Service `onelake`: Should maintain tables in Databricks
*/
shouldMaintainTablesInDatabricks: boolean;
/**
* Field usage depends on `service` value:
* - Service `managed_data_lake`: Specifies whether you want to manage your Iceberg tables in AWS Glue. Use this parameter only if you want to deploy your data lake on AWS.
*/
shouldMaintainTablesInGlue: boolean;
/**
* Field usage depends on `service` value:
* - Service `managed_data_lake`: Specifies whether you want to create shortcut for you table in OneLake. Use this parameter only if you want to deploy your data lake on ADLS.
*/
shouldMaintainTablesInOneLake: boolean;
/**
* Field usage depends on `service` value:
* - Service `adls`: Snapshots older than the retention period are deleted every week. Default value: `ONE_WEEK`.
* - Service `managed_data_lake`: Specifies how long you want us to retain your table snapshots. We delete the snapshots that are older than the retention period during our table maintenance operations. Default value: `ONE_WEEK`.
* - Service `new_s3_datalake`: Snapshots older than the retention period are deleted every week. Default value: `ONE_WEEK`.
* - Service `onelake`: Snapshots older than the retention period are deleted every week. Default value: `ONE_WEEK`.
*/
snapshotRetentionPeriod: string;
snowflakeCloud: string;
snowflakeRegion?: string;
/**
* Field usage depends on `service` value:
* - Service `azure_sql_data_warehouse`: The access key of the Azure storage account you want to use to stage your data. Use this parameter only if you are using Hybrid Deployment.
* - Service `databricks`: Your storage account key
* - Service `snowflake`: The access key of the Azure storage account you want to use to stage your data. Use this parameter only if you are using Hybrid Deployment and want to use an Azure Blob storage container to stage your data.
*/
storageAccountKey?: string;
/**
* Field usage depends on `service` value:
* - Service `adls`: (Immutable) Storage account for Azure Data Lake Storage Gen2 name
* - Service `azure_sql_data_warehouse`: The name of the Azure storage account you want to use to stage your data. Use this parameter only if you are using Hybrid Deployment.
* - Service `databricks`: Your storage account name
* - Service `managed_data_lake`: (Immutable) Name of your Azure Data Lake Storage Gen2 (ADLS Gen2) storage account. Use this parameter only if you want to deploy your data lake on ADLS.
* - Service `onelake`: (Immutable) Storage account for Azure Data Lake Storage Gen2 name
* - Service `snowflake`: The name of the Azure storage account you want to use to stage your data. Use this parameter only if you are using Hybrid Deployment and want to use an Azure Blob storage container to stage your data.
*/
storageAccountName?: string;
/**
* Field usage depends on `service` value:
* - Service `managed_data_lake`: The cloud storage provider you want to use for your data lake.
*/
storageProvider: string;
/**
* Field usage depends on `service` value:
* - Service `big_query`: Stores JSON columns as JSON instead of STRING. This parameter is applicable only to destinations created before August 1, 2025.
* - Service `big_query_dts`: Stores JSON columns as JSON instead of STRING. This parameter is applicable only to destinations created before August 1, 2025.
* - Service `managed_big_query`: Stores JSON columns as JSON instead of STRING. This parameter is applicable only to destinations created before August 1, 2025.
*/
supportJsonType: boolean;
/**
* Field usage depends on `service` value:
* - Service `new_s3_datalake`: (Immutable) The table format in which you want to sync your tables. Valid values are ICEBERG and DELTA_LAKE
*/
tableFormat: string;
/**
* Field usage depends on `service` value:
* - Service `adls`: Tenant id of service principal
* - Service `managed_data_lake`: Tenant ID of the service principal you created for Fivetran. Use this parameter only if you want to deploy your data lake on ADLS.
* - Service `onelake`: Tenant ID of service principal
*/
tenantId?: string;
/**
* Field usage depends on `service` value:
* - Service `aurora_postgres_warehouse`: SSH server name. Must be populated if `connection_type` is set to `SshTunnel`.
* - Service `aurora_warehouse`: SSH server name. Must be populated if `connection_type` is set to `SshTunnel`.
* - Service `azure_postgres_warehouse`: SSH server name. Must be populated if `connection_type` is set to `SshTunnel`.
* - Service `azure_sql_data_warehouse`: SSH server name. Must be populated if `connection_type` is set to `SshTunnel`.
* - Service `azure_sql_database`: SSH server name. Must be populated if `connection_type` is set to `SshTunnel`.
* - Service `azure_sql_managed_db_warehouse`: SSH server name. Must be populated if `connection_type` is set to `SshTunnel`.
* - Service `maria_rds_warehouse`: SSH server name. Must be populated if `connection_type` is set to `SshTunnel`.
* - Service `maria_warehouse`: SSH server name. Must be populated if `connection_type` is set to `SshTunnel`.
* - Service `mysql_rds_warehouse`: SSH server name. Must be populated if `connection_type` is set to `SshTunnel`.
* - Service `mysql_warehouse`: SSH server name. Must be populated if `connection_type` is set to `SshTunnel`.
* - Service `oracle_rac_warehouse`: SSH server name. Must be populated if `connection_type` is set to `SshTunnel`.
* - Service `oracle_rds_warehouse`: SSH server name. Must be populated if `connection_type` is set to `SshTunnel`.
* - Service `oracle_warehouse`: SSH server name. Must be populated if `connection_type` is set to `SshTunnel`.
* - Service `panoply`: SSH server name. Must be populated if `connection_type` is set to `SshTunnel`.
* - Service `periscope_warehouse`: SSH server name. Must be populated if `connection_type` is set to `SshTunnel`.
* - Service `postgres_databricks_warehouse`: SSH server name. Must be populated if `connection_type` is set to `SshTunnel`.
* - Service `postgres_gcp_warehouse`: SSH server name. Must be populated if `connection_type` is set to `SshTunnel`.
* - Service `postgres_rds_warehouse`: SSH server name. Must be populated if `connection_type` is set to `SshTunnel`.
* - Service `postgres_warehouse`: SSH server name. Must be populated if `connection_type` is set to `SshTunnel`.
* - Service `redshift`: SSH server name. Must be populated if `connection_type` is set to `SshTunnel`.
* - Service `sql_server_rds_warehouse`: SSH server name. Must be populated if `connection_type` is set to `SshTunnel`.
* - Service `sql_server_warehouse`: SSH server name. Must be populated if `connection_type` is set to `SshTunnel`.
*/
tunnelHost?: string;
/**
* Field usage depends on `service` value:
* - Service `aurora_postgres_warehouse`: SSH server port name. Must be populated if `connection_type` is set to `SshTunnel`.
* - Service `aurora_warehouse`: SSH server port name. Must be populated if `connection_type` is set to `SshTunnel`.
* - Service `azure_postgres_warehouse`: SSH server port name. Must be populated if `connection_type` is set to `SshTunnel`.
* - Service `azure_sql_data_warehouse`: SSH server port name. Must be populated if `connection_type` is set to `SshTunnel`.
* - Service `azure_sql_database`: SSH server port name. Must be populated if `connection_type` is set to `SshTunnel`.
* - Service `azure_sql_managed_db_warehouse`: SSH server port name. Must be populated if `connection_type` is set to `SshTunnel`.
* - Service `maria_rds_warehouse`: SSH server port name. Must be populated if `connection_type` is set to `SshTunnel`.
* - Service `maria_warehouse`: SSH server port name. Must be populated if `connection_type` is set to `SshTunnel`.
* - Service `mysql_rds_warehouse`: SSH server port name. Must be populated if `connection_type` is set to `SshTunnel`.
* - Service `mysql_warehouse`: SSH server port name. Must be populated if `connection_type` is set to `SshTunnel`.
* - Service `oracle_rac_warehouse`: SSH server port name. Must be populated if `connection_type` is set to `SshTunnel`.
* - Service `oracle_rds_warehouse`: SSH server port name. Must be populated if `connection_type` is set to `SshTunnel`.
* - Service `oracle_warehouse`: SSH server port name. Must be populated if `connection_type` is set to `SshTunnel`.
* - Service `panoply`: SSH server port name. Must be populated if `connection_type` is set to `SshTunnel`.
* - Service `periscope_warehouse`: SSH server port name. Must be populated if `connection_type` is set to `SshTunnel`.
* - Service `postgres_databricks_warehouse`: SSH server port name. Must be populated if `connection_type` is set to `SshTunnel`.
* - Service `postgres_gcp_warehouse`: SSH server port name. Must be populated if `connection_type` is set to `SshTunnel`.
* - Service `postgres_rds_warehouse`: SSH server port name. Must be populated if `connection_type` is set to `SshTunnel`.
* - Service `postgres_warehouse`: SSH server port name. Must be populated if `connection_type` is set to `SshTunnel`.
* - Service `redshift`: SSH server port name. Must be populated if `connection_type` is set to `SshTunnel`.
* - Service `sql_server_rds_warehouse`: SSH server port name. Must be populated if `connection_type` is set to `SshTunnel`.
* - Service `sql_server_warehouse`: SSH server port name. Must be populated if `connection_type` is set to `SshTunnel`.
*/
tunnelPort: number;
/**
* Field usage depends on `service` value:
* - Service `aurora_postgres_warehouse`: SSH user name. Must be populated if `connection_type` is set to `SshTunnel`.
* - Service `aurora_warehouse`: SSH user name. Must be populated if `connection_type` is set to `SshTunnel`.
* - Service `azure_postgres_warehouse`: SSH user name. Must be populated if `connection_type` is set to `SshTunnel`.
* - Service `azure_sql_data_warehouse`: SSH user name. Must be populated if `connection_type` is set to `SshTunnel`.
* - Service `azure_sql_database`: SSH user name. Must be populated if `connection_type` is set to `SshTunnel`.
* - Service `azure_sql_managed_db_warehouse`: SSH user name. Must be populated if `connection_type` is set to `SshTunnel`.
* - Service `maria_rds_warehouse`: SSH user name. Must be populated if `connection_type` is set to `SshTunnel`.
* - Service `maria_warehouse`: SSH user name. Must be populated if `connection_type` is set to `SshTunnel`.
* - Service `mysql_rds_warehouse`: SSH user name. Must be populated if `connection_type` is set to `SshTunnel`.
* - Service `mysql_warehouse`: SSH user name. Must be populated if `connection_type` is set to `SshTunnel`.
* - Service `oracle_rac_warehouse`: SSH user name. Must be populated if `connection_type` is set to `SshTunnel`.
* - Service `oracle_rds_warehouse`: SSH user name. Must be populated if `connection_type` is set to `SshTunnel`.
* - Service `oracle_warehouse`: SSH user name. Must be populated if `connection_type` is set to `SshTunnel`.
* - Service `panoply`: SSH user name. Must be populated if `connection_type` is set to `SshTunnel`.
* - Service `periscope_warehouse`: SSH user name. Must be populated if `connection_type` is set to `SshTunnel`.
* - Service `postgres_databricks_warehouse`: SSH user name. Must be populated if `connection_type` is set to `SshTunnel`.
* - Service `postgres_gcp_warehouse`: SSH user name. Must be populated if `connection_type` is set to `SshTunnel`.
* - Service `postgres_rds_warehouse`: SSH user name. Must be populated if `connection_type` is set to `SshTunnel`.
* - Service `postgres_warehouse`: SSH user name. Must be populated if `connection_type` is set to `SshTunnel`.
* - Service `redshift`: SSH user name. Must be populated if `connection_type` is set to `SshTunnel`.
* - Service `sql_server_rds_warehouse`: SSH user name. Must be populated if `connection_type` is set to `SshTunnel`.
* - Service `sql_server_warehouse`: SSH user name. Must be populated if `connection_type` is set to `SshTunnel`.
*/
tunnelUser?: string;
/**
* Field usage depends on `service` value:
* - Service `snowflake`: Set to `true` if you want to use an S3 bucket to stage your data. Use this parameter only if you are using Hybrid Deployment and want to use an S3 bucket to stage your data.
*/
useCustomerStaging: boolean;
/**
* Field usage depends on `service` value:
* - Service `aurora_postgres_warehouse`: Database user name
* - Service `aurora_warehouse`: Database user name
* - Service `azure_postgres_warehouse`: Database user name
* - Service `azure_sql_data_warehouse`: Database user name
* - Service `azure_sql_database`: Database user name
* - Service `azure_sql_managed_db_warehouse`: Database user name
* - Service `maria_rds_warehouse`: Database user name
* - Service `maria_warehouse`: Database user name
* - Service `mysql_rds_warehouse`: Database user name
* - Service `mysql_warehouse`: Database user name
* - Service `oracle_rac_warehouse`: Database user name
* - Service `oracle_rds_warehouse`: Database user name
* - Service `oracle_warehouse`: Database user name
* - Service `panoply`: Database user name
* - Service `periscope_warehouse`: Database user name
* - Service `postgres_databricks_warehouse`: Database user name
* - Service `postgres_gcp_warehouse`: Database user name
* - Service `postgres_rds_warehouse`: Database user name
* - Service `postgres_warehouse`: Database user name
* - Service `redshift`: Database user name
* - Service `snowflake`: Database user name
* - Service `sql_server_rds_warehouse`: Database user name
* - Service `sql_server_warehouse`: Database user name
*/
user?: string;
/**
* Field usage depends on `service` value:
* - Service `managed_data_lake`: (Immutable) OneLake workspace GUID.
* - Service `onelake`: (Immutable) OneLake workspace GUID
*/
workspaceGuid?: string;
/**
* Field usage depends on `service` value:
* - Service `onelake`: OneLake workspace name
*/
workspaceName?: string;
}
export interface DestinationFingerprintsFingerprint {
/**
* Hash of the fingerprint.
*/
hash: string;
/**
* The SSH public key.
*/
publicKey: string;
/**
* User name who validated the fingerprint.
*/
validatedBy: string;
/**
* The date when fingerprint was approved.
*/
validatedDate: string;
}
export interface DestinationTimeouts {
/**
* A string that can be [parsed as a duration](https://pkg.go.dev/time#ParseDuration) consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours).
*/
create?: string;
/**
* A string that can be [parsed as a duration](https://pkg.go.dev/time#ParseDuration) consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours).
*/
update?: string;
}
export interface ExternalLoggingConfig {
accessKeyId?: string;
accessKeySecret?: string;
apiKey?: string;
channel?: string;
/**
* Enable SSL
*/
enableSsl: boolean;
externalId?: string;
host?: string;
hostname?: string;
logGroupName?: string;
/**
* Port
*/
port: number;
primaryKey?: string;
projectId?: string;
region?: string;
roleArn?: string;
serviceAccountKey?: string;
subDomain: string;
token?: string;
workspaceId?: string;
}
export interface GetConnectionCertificatesCertificate {
/**
* Hash of the certificate.
*/
hash: string;
/**
* Certificate name.
*/
name: string;
/**
* The SSH public key.
*/
publicKey: string;
/**
* Certificate sha1.
*/
sha1: string;
/**
* Certificate sha256.
*/
sha256: string;
/**
* Type of the certificate.
*/
type: string;
/**
* User name who validated the certificate.
*/
validatedBy: string;
/**
* The date when certificate was approved.
*/
validatedDate: string;
}
export interface GetConnectionDestinationSchema {
/**
* The connection schema name in destination. Has to be unique within the group (destination). Required for connection creation.
*/
name: string;
/**
* The connection schema prefix has to be unique within the group (destination). Each replicated schema is prefixed with the provided value. Required for connection creation.
*/
prefix: string;
/**
* The table name unique within the schema to which connection will sync the data. Required for connection creation.
*/
table: string;
/**
* Table group name.
*/
tableGroupName: string;
}
export interface GetConnectionFingerprintsFingerprint {
/**
* Hash of the fingerprint.
*/
hash: string;
/**
* The SSH public key.
*/
publicKey: string;
/**
* User name who validated the fingerprint.
*/
validatedBy: string;
/**
* The date when fingerprint was approved.
*/
validatedDate: string;
}
export interface GetConnectionStatus {
/**
* The boolean specifying whether the connection should be triggered to re-sync all historical data. If you set this parameter to TRUE, the next scheduled sync will be historical. If the value is FALSE or not specified, the connection will not re-sync historical data. NOTE: When the value is TRUE, only the next scheduled sync will be historical, all subsequent ones will be incremental. This parameter is set to FALSE once the historical sync is completed.
*/
isHistoricalSync: boolean;
/**
* The current setup state of the connection. The available values are:
- incomplete - the setup config is incomplete, the setup tests never succeeded `connected` - the connection is properly set up, `broken` - the connection setup config is broken.
*/
setupState: string;
/**
* The current sync state of the connection. The available values are: `scheduled` - the sync is waiting to be run, `syncing` - the sync is currently running, `paused` - the sync is currently paused, `rescheduled` - the sync is waiting until more API calls are available in the source service.
*/
syncState: string;
/**
* The collection of tasks for the connection.
*/
tasks: outputs.GetConnectionStatusTask[];
/**
* The current data update state of the connection. The available values are: `on_schedule` - the sync is running smoothly, no delays, `delayed` - the data is delayed for a longer time than expected for the update.
*/
updateState: string;
/**
* The collection of warnings for the connection.
*/
warnings: outputs.GetConnectionStatusWarning[];
}
export interface GetConnectionStatusTask {
/**
* Task code.
*/
code: string;
/**
* Task message.
*/
message: string;
}
export interface GetConnectionStatusWarning {
/**
* Warning code.
*/
code: string;
/**
* Warning message.
*/
message: string;
}
export interface GetConnectionsConnection {
/**
* The unique identifier of the user who has created the connection in your account.
*/
connectedBy: string;
/**
* The timestamp of the time the connection was created in your account.
*/
createdAt: string;
/**
* The optional parameter that defines the sync start time when the sync frequency is already set or being set by the current request to 1440. It can be specified in one hour increments starting from 00:00 to 23:00. If not specified, we will use [the baseline sync start time](https://fivetran.com/docs/getting-started/syncoverview#syncfrequencyandscheduling). This parameter has no effect on the [0 to 60 minutes offset](https://fivetran.com/docs/getting-started/syncoverview#syncstarttimesandoffsets) used to determine the actual sync start time.
*/
dailySyncTime: string;
/**
* The level of data delay notification threshold. Possible values: LOW, NORMAL, HIGH, CUSTOM, SYNC_FREQUENCY. The default value NORMAL. CUSTOM is only available for customers using the [Enterprise plan](https://fivetran.com/docs/getting-started/pricing#fivetranplans) or above.
*/
dataDelaySensitivity: string;
/**
* Custom sync delay notification threshold in minutes. The default value is 0. This parameter is only used when data_delay_sensitivity set to CUSTOM.
*/
dataDelayThreshold: number;
/**
* The timestamp of the time the connection sync failed last time.
*/
failedAt: string;
/**
* The unique identifier for the Group (Destination) within the Fivetran system.
*/
groupId: string;
/**
* The hybrid deployment agent ID that refers to the controller created for the group the connection belongs to. If the value is specified, the system will try to associate the connection with an existing agent.
*/
hybridDeploymentAgentId: string;
/**
* The unique identifier for the connection within the Fivetran system.
*/
id: string;
/**
* The name used both as the connection's name within the Fivetran system and as the source schema's name within your destination.
*/
name: string;
/**
* The networking method for the connection. Possible values: `Directly`, `SshTunnel`, `ProxyAgent`, `PrivateLink`.
*/
networkingMethod: string;
/**
* Specifies whether the connection should be paused after the free trial period has ended.
*/
pauseAfterTrial: boolean;
/**
* Specifies whether the connection is paused.
*/
paused: boolean;
/**
* The private link ID. Required when `networking_method` is `PrivateLink`.
*/
privateLinkId: string;
/**
* The ID of the proxy agent to use. Required when `networking_method` is `ProxyAgent`.
*/
proxyAgentId: string;
/**
* The connection schedule configuration type. Supported values: auto, manual.
*/
scheduleType: string;
/**
* The connection service type (e.g., `postgres`, `mysql`, `s3`, `snowflake`). See [Fivetran connection types documentation](https://fivetran.com/docs/connectors) for available services.
*/
service: string;
/**
* The connection type version within the Fivetran system.
*/
serviceVersion: string;
/**
* The timestamp of the time the connection sync succeeded last time.
*/
succeededAt: string;
/**
* The connection sync frequency in minutes.
*/
syncFrequency: number;
}
export interface GetConnectorCertificatesCertificate {
/**
* Hash of the certificate.
*/
hash: string;
/**
* Certificate name.
*/
name: string;
/**
* The SSH public key.
*/
publicKey: string;
/**
* Certificate sha1.
*/
sha1: string;
/**
* Certificate sha256.
*/
sha256: string;
/**
* Type of the certificate.
*/
type: string;
/**
* User name who validated the certificate.
*/
validatedBy: string;
/**
* The date when certificate was approved.
*/
validatedDate: string;
}
export interface GetConnectorConfig {
/**
* Field usage depends on `service` value:
* - Service `adobe_analytics_data_feed`: Azure Blob Storage connection method
*/
absConnectionMethod: string;
/**
* Field usage depends on `service` value:
* - Service `adobe_analytics_data_feed`: Azure Blob Storage connection string.
* - Service `braze`: Connection String
*/
absConnectionString: string;
/**
* Field usage depends on `service` value:
* - Service `adobe_analytics_data_feed`: Azure Blob Storage container address
*/
absContainerAddress: string;
/**
* Field usage depends on `service` value:
* - Service `adobe_analytics_data_feed`: Azure Blob Storage container name.
* - Service `braze`: Container Name
*/
absContainerName: string;
/**
* Field usage depends on `service` value:
* - Service `adobe_analytics_data_feed`: Azure Blob Storage host IP
*/
absHostIp: string;
/**
* Field usage depends on `service` value:
* - Service `adobe_analytics_data_feed`: Azure Blob Storage username
*/
absHostUser: string;
/**
* Field usage depends on `service` value:
* - Service `braze`: Prefix
*/
absPrefix: string;
/**
* Field usage depends on `service` value:
* - Service `adobe_analytics_data_feed`: Azure Blob Storage public key
*/
absPublicKey: string;
/**
* Field usage depends on `service` value:
* - Service `workramp`: Your WorkRamp academy ID.
*/
academyId: string;
/**
* Field usage depends on `service` value:
* - Service `ceridian_dayforce`: Your confirmation that you have granted Fivetran access to all the RESTful services and fields you want to sync. Possible values: `true`, `false`.
*/
accessConfirmation: string;
/**
* Field usage depends on `service` value:
* - Service `planful`: Your Planful access ID.
*/
accessId: string;
/**
* Field usage depends on `service` value:
* - Service `gainsight_customer_success`: The access key for API authentication.
* - Service `gongio`: Your Gongio Access key.
* - Service `line_ads`: Your LINE Ads access key.
* - Service `planful`: Your Planful access key.
* - Service `retailnext`: Your RetailNext access key.
*/
accessKey: string;
/**
* Field usage depends on `service` value:
* - Service `appsflyer`: Your AWS access key ID.
* - Service `aws_cost_report`: Access Key ID
* - Service `checkout`: Your Checkout.com access key ID.
* - Service `cloudtalk`: Your CloudTalk Access Key ID.
* - Service `nice`: Your NICE access key ID.
* - Service `s3`: Access Key ID
* - Service `s3_compatible_storage`: Access Key ID
* - Service `validio`: Your Validio access key ID.
* - Service `wasabi_cloud_storage`: Access Key ID
*/
accessKeyId: string;
/**
* Field usage depends on `service` value:
* - Service `aws_cost_report`: Access Key Secret
* - Service `checkout`: Your Checkout.com access key secret.
* - Service `cloudtalk`: Your CloudTalk Access Key Secret.
* - Service `gongio`: Your Gongio Access Key Secret.
* - Service `nice`: Your NICE access key secret.
* - Service `s3`: Access Key Secret
* - Service `s3_compatible_storage`: Access Key Secret
* - Service `wasabi_cloud_storage`: Access Key Secret
*/
accessKeySecret: string;
/**
* Field usage depends on `service` value:
* - Service `7shifts`: Your 7shifts access token.
* - Service `attio`: Your Attio bearer token
* - Service `big_commerce`: Your [API access token ](https://fivetran.com/docs/connectors/applications/big-commerce/setup-guide#createaccesstoken).
* - Service `bitly`: Your Bitly access token.
* - Service `calabrio`: Your Calabrio access token.
* - Service `coalesce`: Your Coalesce access token.
* - Service `coheris`: Your Coheris access token.
* - Service `coupa`: Your Coupa access token fetched using client_id and client_secret
* - Service `deputy`: Your Deputy API access token.
* - Service `getfeedback`: Your GetFeedback Access token.
* - Service `gocardless`: Your GoCardless API token.
* - Service `higher_logic_vanilla`: Your Higher Logic Vanilla access token.
* - Service `ironclad`: Your Ironclad access token.
* - Service `khoros_marketing`: Your Khoros Marketing access token.
* - Service `kustomer`: Your Kustomer API key.
* - Service `lattice`: Your Lattice API access token.
* - Service `launchdarkly`: Your LaunchDarkly access token.
* - Service `leap_crm`: Your Leap CRM access token.
* - Service `nylas`: Your Nylas access_token.
* - Service `planhat`: Your Planhat access token.
* - Service `poplar`: Your Poplar access token.
* - Service `rollbar`: Your Rollbar Access Token.
* - Service `samsara`: Your Samsara API token.
* - Service `slab`: Your Slab API key.
* - Service `stripe`: The Stripe API Restricted Key
* - Service `stripe_test`: The Stripe API Restricted Key
* - Service `talkwalker`: Your Talkwalker access token.
* - Service `workable`: Your Workable Access Token.
* - Service `workramp`: Your WorkRamp access token.
*/
accessToken: string;
/**
* Field usage depends on `service` value:
* - Service `share_point`: Access Type
*/
accessType: string;
/**
* Field usage depends on `service` value:
* - Service `netsuite_suiteanalytics`: The NetSuite Account ID.
* - Service `ordway`: Your Ordway account type.
*/
account: string;
/**
* Field usage depends on `service` value:
* - Service `rollbar`: Your Rollbar account access token.
*/
accountAccessToken: string;
/**
* Field usage depends on `service` value:
* - Service `appcues`: Your Appcues Account ID.
* - Service `bizzabo_app`: Your Bizzabo account ID.
* - Service `bizzabo_v2`: Your Bizzabo account ID.
* - Service `brightcove`: Your Brightcove account ID.
* - Service `cin7core`: Your Cin7 Core account ID.
* - Service `dear`: Your Dear Account ID.
* - Service `harvest`: Your Harvest Account ID.
* - Service `optimizely`: Your Optimizely account ID.
* - Service `rokt`: Your Rokt account ID.
* - Service `udemy_business`: Your Udemy Business account ID.
*/
accountId: string;
/**
* Field usage depends on `service` value:
* - Service `taboola`: Specific Account IDs to sync. Must be populated if `syncMode` is set to `SpecificAccounts`.
*/
accountIds: string[];
/**
* Field usage depends on `service` value:
* - Service `cosmos`: The read-only primary or secondary account key for the database account. Required for the `ACCOUNT_KEY` data access method.
* - Service `simplesat`: Your Simplesat account key.
*/
accountKey: string;
/**
* Field usage depends on `service` value:
* - Service `eventsforce`: Your Eventsforce account name.
* - Service `freshdesk_contact_center`: Your Freshdesk Contact Center account name.
* - Service `happyfox`: Your HappyFox account name.
* - Service `helpjuice`: Your Helpjuice account name.
* - Service `maxio_saasoptics`: Your Maxio SaaSOptics account name.
* - Service `talkdesk`: Your Talkdesk Account Name.
* - Service `udemy_business`: Your Udemy Business account name.
*/
accountName: string;
/**
* Field usage depends on `service` value:
* - Service `tymeshift`: Your Tymeshift account plan.
*/
accountPlan: string;
/**
* Field usage depends on `service` value:
* - Service `iterable`: If your Iterable account URL starts with `https://app.eu.iterable.com` then provide `EU` else `US`
*/
accountRegion: string;
/**
* Field usage depends on `service` value:
* - Service `fone_dynamics`: Your Fone Dynamics account SID.
* - Service `impact_partner`: Your Impact Partner account SID
*/
accountSid: string;
/**
* Field usage depends on `service` value:
* - Service `itunes_connect`: Account Sync Mode
* - Service `snapchat_ads`: Whether to sync all accounts or specific accounts. Default value: `AllAccounts`.
*/
accountSyncMode: string;
/**
* Field usage depends on `service` value:
* - Service `konnect_insights`: Your Konnect Insights Account Token.
*/
accountToken: string;
/**
* Field usage depends on `service` value:
* - Service `freightview`: Your Freightview account type.
*/
accountType: string;
/**
* Field usage depends on `service` value:
* - Service `bingads`: Specific accounts to sync. Must be populated if `syncMode` is set to `SpecificAccounts`.
* - Service `facebook`: List of accounts of which connector will sync the data.
* - Service `facebook_ad_account`: Specific accounts to sync. Must be populated if `sync_mode` is set to `SpecificAccounts`.
* - Service `facebook_ads`: List of accounts of which connector will sync the data.
* - Service `google_ads`: The list of Account IDs to sync. Must be populated if `sync_mode` is set to `SpecificAccounts`.
* - Service `google_analytics`: The list of specific Account IDs to sync. Must be populated if `syncMode` is set to `SpecificAccounts`.
* - Service `google_analytics_4`: The list of specific Account IDs to sync. Must be populated if `sync_mode` is set to `SPECIFIC_ACCOUNTS`.
* - Service `google_analytics_mcf`: Specific Account IDs to sync. Must be populated if `sync_mode` is set to `SPECIFIC_ACCOUNTS`.
* - Service `google_search_ads_360`: Specific accounts to sync. Must be populated if `accountsSyncMode` is set to `SPECIFIC_ACCOUNTS`.
* - Service `instagram_business`: Specific accounts to sync. Must be populated if `sync_mode` is set to `SpecificAccounts`.
* - Service `itunes_connect`: Accounts
* - Service `linkedin_ads`: Specific Account IDs to sync. Must be populated if `syncMode` is set to `SpecificAccounts`.
* - Service `snapchat_ads`: Specific accounts IDs to sync. Must be populated if `accountSyncMode` is set to `SpecificAccounts`.
* - Service `spotify_ads`: The list of Ad Account IDs to sync. Must be populated if `sync_mode` is set to `SPECIFIC_ACCOUNTS`.
* - Service `tiktok_ads`: Specific accounts to sync. Must be populated if `sync_mode` is set to `SpecificAccounts`.
* - Service `twilio`: Specific Accounts to sync. Must be populated if `sync_mode` is set to `SpecificAccounts`.
* - Service `twitter`: Specific accounts to sync. Must be populated if `sync_mode` is set to `SpecificAccounts`.
* - Service `twitter_ads`: Specific Accounts to sync. Must be populated if `sync_mode` is set to `SpecificAccounts`.
*/
accounts: string[];
/**
* Field usage depends on `service` value:
* - Service `reddit_ads`: Accounts
*/
accountsRedditAds: outputs.GetConnectorConfigAccountsRedditAd[];
/**
* Field usage depends on `service` value:
* - Service `google_search_ads_360`: Whether to sync all accounts or specific.
*/
accountsSyncMode: string;
/**
* Field usage depends on `service` value:
* - Service `facebook`: List of action_breakdowns which connector will sync. [Possible action_breakdowns values](https://fivetran.com/docs/applications/facebook-ad-insights/api-config#actionbreakdowns).
*/
actionBreakdowns: string[];
/**
* Field usage depends on `service` value:
* - Service `facebook`: The report time of action stats. [Possible action_report time values](https://fivetran.com/docs/applications/facebook-ad-insights/api-config#actionreporttime).
*/
actionReportTime: string;
/**
* Field usage depends on `service` value:
* - Service `linkedin_ads`: Whether to sync all analytic reports or specific. Default value: `AllReports`
*/
adAnalytics: string;
/**
* Field usage depends on `service` value:
* - Service `double_click_publishers`: Ad unit view for the report.
*/
adUnitView: string;
/**
* Field usage depends on `service` value:
* - Service `splitio`: Your Split admin api key.
*/
adminApiKey: string;
/**
* Field usage depends on `service` value:
* - Service `brivo`: Your Brivo Admin username.
*/
adminUsername: string;
/**
* Field usage depends on `service` value:
* - Service `adobe_analytics`: The list of configurations of tables you want to sync. The number of tables and their configurations is limited to 5. Required for connector creation.
*/
adobeAnalyticsConfigurations: outputs.GetConnectorConfigAdobeAnalyticsConfiguration[];
/**
* Field usage depends on `service` value:
* - Service `adroll`: Specific advertisables to sync. Must be populated if `sync_mode` is set to `SpecificAdvertisables`.
*/
advertisables: string[];
/**
* Field usage depends on `service` value:
* - Service `google_display_and_video_360`: The list of advertisers to include into a sync. This parameter only takes effect when `config_method` is set to `CREATE_NEW`.
* - Service `google_search_ads_360`: Specific advertisers to sync. Must be populated if `advertisersSyncMode` is set to `SPECIFIC_ADVERTISERS`.
* - Service `pinterest_ads`: Specific Advertisers to sync. Must be populated if `sync_mode` is set to `SpecificAdvertisers`.
*/
advertisers: string[];
/**
* Field usage depends on `service` value:
* - Service `yahoo_gemini`: Specific Advertiser IDs to sync. Must be populated if `syncMode` is set to `SpecificAccounts`.
*/
advertisersIds: string[];
/**
* Field usage depends on `service` value:
* - Service `google_search_ads_360`: Whether to sync all or specific advertisers.
*/
advertisersSyncMode: string;
/**
* Field usage depends on `service` value:
* - Service `yahoo_dsp`: Specific Advertisers to sync. Must be populated if `sync_mode_advertiser` is set to `SPECIFIC_ADVERTISERS`. Pay attention to the format: `AdvertiserId:SeatId`
*/
advertisersWithSeats: string[];
agentConfigMethod: string;
/**
* Field usage depends on `service` value:
* - Service `db2i_hva`: The agent host.
* - Service `db2i_sap_hva`: The host of the agent. This is the same as the database host, since the agent must be installed on the same machine as the source database.
* - Service `hana_sap_hva_b1`: The host of the agent. This is the same as the database host, since the agent must be installed on the same machine as the source database.
* - Service `hana_sap_hva_ecc`: The host of the agent. This is the same as the database host, since the agent must be installed on the same machine as the source database.
* - Service `hana_sap_hva_ecc_netweaver`: The host of the agent. This is the same as the database host, since the agent must be installed on the same machine as the source database.
* - Service `hana_sap_hva_s4`: The host of the agent. This is the same as the database host, since the agent must be installed on the same machine as the source database.
* - Service `hana_sap_hva_s4_netweaver`: The host of the agent. This is the same as the database host, since the agent must be installed on the same machine as the source database.
* - Service `oracle_hva`: The host of the agent. This is the same as database host, since the agent must be installed in the same machine as source database.
* - Service `oracle_sap_hva`: The host of the agent. This is the same as the database host, since the agent must be installed on the same machine as the source database.
* - Service `oracle_sap_hva_netweaver`: The host of the agent. This is the same as the database host, since the agent must be installed on the same machine as the source database.
* - Service `sql_server_hva`: The host address of the machine running the agent. Often the same as the DB host.
* - Service `sql_server_sap_ecc_hva`: The host address of the machine running the agent. Often the same as the DB host.
*/
agentHost: string;
/**
* Field usage depends on `service` value:
* - Service `phoenix_ads`: Your Phoenix Ads Agent ID.
*/
agentId: string;
/**
* Field usage depends on `service` value:
* - Service `oracle_hva`: The home directory of the Oracle database.
* - Service `oracle_sap_hva`: The home directory of the Oracle database.
*/
agentOraHome: string;
/**
* Field usage depends on `service` value:
* - Service `db2i_hva`: The agent password.
* - Service `db2i_sap_hva`: The agent user's password. It must have a minimum length of 10 characters.
* - Service `hana_sap_hva_b1`: The agent user's password. It must have a minimum length of 10 characters.
* - Service `hana_sap_hva_ecc`: The agent user's password. It must have a minimum length of 10 characters.
* - Service `hana_sap_hva_ecc_netweaver`: The agent user's password. It must have a minimum length of 10 characters.
* - Service `hana_sap_hva_s4`: The agent user's password. It must have a minimum length of 10 characters.
* - Service `hana_sap_hva_s4_netweaver`: The agent user's password. It must have a minimum length of 10 characters.
* - Service `oracle_hva`: The agent user's password. It should have a minimum length of 10 characters.
* - Service `oracle_sap_hva`: The agent user's password. It must have a minimum length of 10 characters.
* - Service `oracle_sap_hva_netweaver`: The agent user's password. It must have a minimum length of 10 characters.
* - Service `sql_server_hva`: The password for the agent user.
* - Service `sql_server_sap_ecc_hva`: The password for the agent user.
*/
agentPassword: string;
/**
* Field usage depends on `service` value:
* - Service `db2i_hva`: The agent port.
* - Service `db2i_sap_hva`: The port number of the agent.
* - Service `hana_sap_hva_b1`: The port number of the agent.
* - Service `hana_sap_hva_ecc`: The port number of the agent.
* - Service `hana_sap_hva_ecc_netweaver`: The port number of the agent.
* - Service `hana_sap_hva_s4`: The port number of the agent.
* - Service `hana_sap_hva_s4_netweaver`: The port number of the agent.
* - Service `oracle_hva`: The port number of the agent.
* - Service `oracle_sap_hva`: The port number of the agent.
* - Service `oracle_sap_hva_netweaver`: The port number of the agent.
* - Service `sql_server_hva`: The port that the agent has open for Fivetran's connection. Default value is 4343.
* - Service `sql_server_sap_ecc_hva`: The port that the agent has open for Fivetran's connection. Default value is 4343.
*/
agentPort: number;
/**
* Field usage depends on `service` value:
* - Service `db2i_hva`: The public certificate for the agent.
* - Service `db2i_sap_hva`: The agent public certificate.
* - Service `hana_sap_hva_b1`: The agent public certificate.
* - Service `hana_sap_hva_ecc`: The agent public certificate.
* - Service `hana_sap_hva_ecc_netweaver`: The agent public certificate.
* - Service `hana_sap_hva_s4`: The agent public certificate.
* - Service `hana_sap_hva_s4_netweaver`: The agent public certificate.
* - Service `oracle_hva`: The agent public certificate.
* - Service `oracle_sap_hva`: The agent public certificate.
* - Service `oracle_sap_hva_netweaver`: The agent public certificate.
* - Service `sql_server_hva`: The public certificate generated by the agent.
* - Service `sql_server_sap_ecc_hva`: The public certificate generated by the agent.
*/
agentPublicCert: string;
/**
* Field usage depends on `service` value:
* - Service `db2i_hva`: The agent user name.
* - Service `db2i_sap_hva`: The agent's user.
* - Service `hana_sap_hva_b1`: The agent's user.
* - Service `hana_sap_hva_ecc`: The agent's user.
* - Service `hana_sap_hva_ecc_netweaver`: The agent's user.
* - Service `hana_sap_hva_s4`: The agent's user.
* - Service `hana_sap_hva_s4_netweaver`: The agent's user.
* - Service `oracle_hva`: The agent's user.
* - Service `oracle_sap_hva`: The agent's user.
* - Service `oracle_sap_hva_netweaver`: The agent's user.
* - Service `sql_server_hva`: The agent's username.
* - Service `sql_server_sap_ecc_hva`: The agent's username.
*/
agentUser: string;
/**
* Field usage depends on `service` value:
* - Service `facebook`: Options to select aggregation duration. [Possible aggregation values](https://fivetran.com/docs/applications/facebook-ad-insights/api-config#aggregation).
*/
aggregation: string;
/**
* Field usage depends on `service` value:
* - Service `economic`: Your E-conomic X-AgreementGrantToken goes here.
*/
agreementGrantToken: string;
/**
* Field usage depends on `service` value:
* - Service `webhooks`: HMAC algorithm used for generating the HMAC signature. Supported algorithms INFER_FROM_HEADER, MD5, SHA_1, SHA_224, SHA_256, SHA_384, SHA_512. Default: SHA_256
*/
algorithm: string;
/**
* Field usage depends on `service` value:
* - Service `aurora`: Require TLS through Tunnel
* - Service `aurora_postgres`: Require TLS through Tunnel
* - Service `aveva_pi`: Require TLS.
* - Service `azure_cosmos_for_mongo`: Require TLS
* - Service `azure_postgres`: Require TLS through Tunnel
* - Service `azure_sql_db`: Require TLS through Tunnel.
* - Service `azure_sql_managed_db`: Require TLS.
* - Service `clarity`: Require TLS through Tunnel.
* - Service `cockroachdb`: Require TLS
* - Service `db2i_hva`: Require TLS through Tunnel
* - Service `db2i_sap_hva`: Require TLS through Tunnel
* - Service `db2luw`: Require TLS through Tunnel
* - Service `db2z`: Require TLS
* - Service `documentdb`: Require TLS encryption.
* - Service `dynamics_365_fo`: Require TLS through Tunnel.
* - Service `ehr`: Require TLS through Tunnel.
* - Service `elastic_cloud`: Default value: true. Set to false if TLS is not required when using an SSH tunnel.
* - Service `epic_clarity`: Require TLS through Tunnel.
* - Service `es_self_hosted`: Default value: true. Set to false if TLS is not required when using an SSH tunnel.
* - Service `google_cloud_mysql`: Require TLS through Tunnel
* - Service `google_cloud_postgresql`: Require TLS through Tunnel
* - Service `google_cloud_sqlserver`: Require TLS.
* - Service `heroku_postgres`: Require TLS through Tunnel
* - Service `magento_mysql`: Require TLS through Tunnel
* - Service `magento_mysql_rds`: Require TLS through Tunnel
* - Service `maria`: Require TLS through Tunnel
* - Service `maria_azure`: Require TLS through Tunnel
* - Service `maria_rds`: Require TLS through Tunnel
* - Service `mongo`: Require TLS
* - Service `mongo_sharded`: Require TLS through Tunnel
* - Service `mysql`: Require TLS through Tunnel
* - Service `mysql_azure`: Require TLS through Tunnel
* - Service `mysql_rds`: Require TLS through Tunnel
* - Service `opendistro`: Default value: true. Set to false if TLS is not required when using an SSH tunnel.
* - Service `opensearch`: Default value: true. Set to false if TLS is not required when using an SSH tunnel.
* - Service `oracle`: Require TLS through Tunnel
* - Service `oracle_ebs`: Require TLS through Tunnel
* - Service `oracle_hva`: Require TLS through Tunnel
* - Service `oracle_rac`: Require TLS through Tunnel
* - Service `oracle_rds`: Require TLS through Tunnel
* - Service `oracle_sap_hva`: Require TLS through Tunnel
* - Service `oracle_sap_hva_netweaver`: Require TLS.
* - Service `postgres`: Require TLS through Tunnel
* - Service `postgres_rds`: Require TLS through Tunnel
* - Service `sql_server`: Require TLS.
* - Service `sql_server_hva`: Require TLS.
* - Service `sql_server_rds`: Require TLS.
* - Service `sql_server_sap_ecc_hva`: Require TLS.
*/
alwaysEncrypted: boolean;
/**
* Field usage depends on `service` value:
* - Service `freshsuccess`: Set this parameter to `api`.
*/
api: string;
/**
* Field usage depends on `service` value:
* - Service `device_magic`: Your Device Magic API access token.
* - Service `flywheel_digital`: Your Flywheel Digital API access token.
* - Service `shopify`: API access token of your custom app.
* - Service `square`: The Square API access token of your application.
*/
apiAccessToken: string;
/**
* Field usage depends on `service` value:
* - Service `afterpay`: Your Afterpay API environment.
* - Service `tiktok_organic`: Your TikTok Organic API environment.
* - Service `tiktok_organic_app`: Your TikTok Organic API environment.
*/
apiEnvironment: string;
/**
* Field usage depends on `service` value:
* - Service `aircall`: Your Aircall API ID.
*/
apiId: string;
/**
* Field usage depends on `service` value:
* - Service `onetrust`: Your OneTrust API integration type.
*/
apiIntegrationType: string;
/**
* Field usage depends on `service` value:
* - Service `15five`: Your 15five API key.
* - Service `360learning`: Your 360Learning API Key.
* - Service `6sense`: Your 6sense API Key.
* - Service `acculynx`: Your Acculynx API key.
* - Service `activecampaign`: Your ActiveCampaign API key.
* - Service `affinity`: Your Affinity API key.
* - Service `airtable`: API key of the Airtable account.
* - Service `algolia`: Your Algolia API key.
* - Service `alida`: Your Alida API key.
* - Service `anvyl`: Your Anvyl API key.
* - Service `apollo`: Your Apollo API key.
* - Service `appcues`: Your Appcues API key.
* - Service `applovin`: Your AppLovin API key.
* - Service `ascend_by_partnerize`: Your Ascend by Partnerize API Key
* - Service `ashby`: Your Ashby API key.
* - Service `assembled`: Your Assembled API key.
* - Service `atlassian_jira_align`: Your Jira Align API key.
* - Service `atlassian_ops_genie`: Your Opsgenie API key
* - Service `attentive`: Your Attentive API key.
* - Service `aumni`: Your Aumni API key.
* - Service `avantlink`: Your AvantLink API key.
* - Service `ballotready`: Your BallotReady API token.
* - Service `bamboohr`: Your API Key.
* - Service `bazaarvoice`: Your Bazaarvoice API key.
* - Service `betterworks`: Your Betterworks API key.
* - Service `bigmarker`: Your BigMarker API key.
* - Service `bizzabo`: Your Bizzabo API key.
* - Service `brave_ads`: Your Brave Ads API key
* - Service `braze`: Your Braze API Key.
* - Service `brevo`: Your Brevo API key.
* - Service `brivo`: Your Brivo API key.
* - Service `bubble`: Your Bubble API token.
* - Service `buildium`: Your Buildium private API key.
* - Service `callrail`: Your CallRail API key.
* - Service `campaignmonitor`: Your Campaign Monitor API key.
* - Service `campfire`: Your Campfire API key.
* - Service `canny`: Your Canny API key.
* - Service `chargebee_product_catalog_1`: Your Chargebee Product Catalog 1 API key.
* - Service `chargebee_product_catalog_2`: Your Chargebee API key.
* - Service `charthop`: Your ChartHop app API key.
* - Service `chartmogul`: Your ChartMogul API key.
* - Service `chorusai`: Your Chorus API key.
* - Service `churnkey`: Your Churnkey API Key.
* - Service `churnzero`: Your ChurnZero API key.
* - Service `cimis`: Your Cimis API key.
* - Service `circleci`: Your CircleCI API Key.
* - Service `clickup`: Your ClickUp API key.
* - Service `clockify`: Your Clockify API key.
* - Service `clockodo`: Your Clockodo API key.
* - Service `close`: Your Close API key.
* - Service `cloudbeds`: Your Cloudbeds API key.
* - Service `clubspeed`: Your Clubspeed API key.
* - Service `coassemble`: Your Coassemble API key.
* - Service `codefresh`: Your Codefresh API Key.
* - Service `column`: Your Column API key.
* - Service `concord`: Your Concord API key.
* - Service `confluent_cloud`: API Key
* - Service `consensus_demo_automation_platform`: Your Consensus Demo Automation Platform API key.
* - Service `contrast_security`: Your Contrast Security API Key.
* - Service `copper`: Your Copper API key.
* - Service `coupa`: Your Coupa API key.
* - Service `crunchbase`: Your Crunchbase API key.
* - Service `datadog`: Your Datadog API key.
* - Service `dbt_cloud`: Your dbt Cloud service token.
* - Service `dcl_logistics`: Your DCL Logistics API key.
* - Service `delighted`: API Key for your Delighted account
* - Service `destini`: Your Destini API Key.
* - Service `discourse`: Your Discourse API key.
* - Service `donus`: Your Donus API key.
* - Service `doorloop`: Your DoorLoop API key.
* - Service `drata`: Your Drata API Key.
* - Service `dropbox_sign`: Your Dropbox Sign API key.
* - Service `duoplane`: Your Duoplane API key.
* - Service `dutchie`: Your Dutchie API key.
* - Service `easypost`: Your EasyPost API Key.
* - Service `electronic_tenant_solutions`: Your Electronic Tenant Solutions API key.
* - Service `eventsforce`: Your Eventsforce API secret key.
* - Service `everflow`: Your Everflow API key.
* - Service `everhour`: Your Everhour API Token.
* - Service `expensein`: Your ExpenseIn API key.
* - Service `factorial`: Your Factorial API key.
* - Service `fireflies`: Your Fireflies API key.
* - Service `firehydrant`: Your FireHydrant API key.
* - Service `float`: Your Float API key.
* - Service `forj_community`: Your Forj Community API key.
* - Service `fourkites`: Your FourKites API key.
* - Service `freightview`: Your Freightview API key.
* - Service `freshdesk`: Your Freshdesk API Key.
* - Service `freshdesk_contact_center`: Your Freshdesk Contact Center API key.
* - Service `freshsales`: Your Freshsales API key.
* - Service `freshservice`: Your Freshservice API Key.
* - Service `freshsuccess`: Your Freshsuccess API key.
* - Service `freshteam`: Your Freshteam API key.
* - Service `friendbuy`: Your Friendbuy API key.
* - Service `fulfil`: Your Fulfil API key.
* - Service `fullstory`: Your Fullstory API key.
* - Service `gainsight_product_experience`: Your Gainsight Product Experience API key.
* - Service `gem`: Your Gem API key.
* - Service `goldcast`: Your Goldcast API key.
* - Service `gorgias`: Your Gorgias API key.
* - Service `greenhouse`: Your Greenhouse API key.
* - Service `grepsr`: Your Grepsr API Key.
* - Service `grin`: Your Grin API key.
* - Service `happyfox`: Your HappyFox API key.
* - Service `healthie`: Your Healthie API key.
* - Service `height`: Your Height API key.
* - Service `helpjuice`: Your Helpjuice API key.
* - Service `helpshift`: Your Helpshift API Key.
* - Service `incidentio`: Your incident.io API key.
* - Service `infobip`: Your Infobip API key.
* - Service `insightly`: Your Insightly API key.
* - Service `integrate`: Your Integrate API key.
* - Service `invoiced`: Your Invoiced API key.
* - Service `iterable`: Your Iterable API key.
* - Service `ivanti`: Your Ivanti API Key.
* - Service `jobnimbus`: Your JobNimbus API key.
* - Service `jotform`: Your Jotform API key.
* - Service `justcall`: Your JustCall API key.
* - Service `katana`: Your Katana API key.
* - Service `kevel`: Your Kevel API key.
* - Service `keypay`: Your KeyPay API key.
* - Service `kisi`: Your Kisi API key.
* - Service `klaviyo`: Your Klaviyo API key.
* - Service `learnupon`: Your LearnUpon API key.
* - Service `lemlist`: Your Lemlist API key.
* - Service `lever`: Your Lever API key.
* - Service `liftoff`: Your Liftoff API key.
* - Service `linear`: Your Linear API key.
* - Service `linksquares`: Your LinkSquares API key.
* - Service `listen360`: Your Listen360 API key.
* - Service `lob`: Your Lob API key.
* - Service `loop`: Your Loop API key.
* - Service `lucca`: Your Lucca API key.
* - Service `luma`: Your Luma API key.
* - Service `maileon`: Your Maileon API key.
* - Service `mailgun`: Your Mailgun API key.
* - Service `mailjet`: Your Mailjet API key.
* - Service `malomo`: Your Malomo API key.
* - Service `mambu`: Your Mambu API key.
* - Service `mandrill`: Your Mandrill API key.
* - Service `maxio_chargify`: Enter Your API Key.
* - Service `messagebird`: Your MessageBird API key.
* - Service `moloco`: Your Moloco api_key
* - Service `mountain`: Your MNTN API key.
* - Service `myosh`: Your myosh API key.
* - Service `okendo`: Your Okendo API key.
* - Service `ometria`: Your Ometria API Key.
* - Service `oncehub`: Your OnceHub API key.
* - Service `openai`: Your OpenAI Admin API key.
* - Service `ordergroove`: Your Ordergroove API key.
* - Service `ordway`: Your Ordway API key.
* - Service `ortto`: Your Ortto API key.
* - Service `paddle`: Your Paddle API key.
* - Service `pagerduty`: Your PagerDuty API key.
* - Service `pandadoc`: Your PandaDoc API key.
* - Service `papershift`: Your Papershift API Key
* - Service `partnerize`: Your Partnerize user API key.
* - Service `peopleforce`: Your PeopleForce API key.
* - Service `persona`: Your Persona API key.
* - Service `picqer`: Your Picqer API key.
* - Service `pigment`: Your Pigment API key.
* - Service `pinpoint`: Your Pinpoint API key.
* - Service `pipe17`: The Pipe17 API key.
* - Service `placerai`: Your Placer.ai API key.
* - Service `playvox`: Your Playvox API Key.
* - Service `posthog`: Your PostHog API key.
* - Service `prive`: Your Prive API key.
* - Service `prosperstack`: Your ProsperStack API key.
* - Service `qualaroo`: Your Qualaroo API Key.
* - Service `quorum`: Your Quorum API key.
* - Service `rebound_returns`: Your ReBound Returns API key.
* - Service `recurly`: The Recurly API key.
* - Service `refiner`: Your Refiner API key.
* - Service `replyio`: Your Reply API key.
* - Service `revenuecat`: Your RevenueCat API key.
* - Service `reviewsio`: Your REVIEWS.io API key.
* - Service `revops`: Your RevOps bearer token.
* - Service `ricochet360`: Your Ricochet360 API key.
* - Service `ringover`: Your Ringover API key.
* - Service `rippling`: Your Rippling API token.
* - Service `rocketlane`: Your Rocketlane API key.
* - Service `rootly`: Your Rootly API key.
* - Service `ruddr`: Your Ruddr API key.
* - Service `safebase`: Your SafeBase API key.
* - Service `sage_hr`: Your Sage HR API key.
* - Service `sailthru`: The Sailthru API key.
* - Service `salsify`: Your Salsify API Key.
* - Service `security_journey`: Your Security Journey API key.
* - Service `sendgrid`: The SendGrid API key.
* - Service `sendinblue`: Your Sendinblue API key.
* - Service `shortcut`: Your Shortcut API token.
* - Service `shortio`: Your Short.io API key.
* - Service `simplesat`: Your Simplesat API key.
* - Service `sistrix`: Your SISTRIX API key.
* - Service `skilljar`: Your Skilljar API key.
* - Service `smartwaiver`: Your Smartwaiver API key.
* - Service `snyk`: Your Snyk API key.
* - Service `sonarqube`: Your Sonarqube API key.
* - Service `sparkpost`: Your SparkPost API key.
* - Service `squarespace`: Your Squarespace API key.
* - Service `stackadapt`: Your StackAdapt API key.
* - Service `stackadapt_graphql`: Your StackAdapt API key.
* - Service `statuspage`: Your Statuspage API Key.
* - Service `stripe`: Restricted API key
* - Service `stripe_test`: Restricted API key
* - Service `subscript`: Your Subscript API key.
* - Service `survicate`: Your Survicate API Key.
* - Service `teads`: Your Teads API key.
* - Service `teamtailor`: Your Teamtailor API key.
* - Service `testrail`: Your TestRail API key.
* - Service `ticket_tailor`: Your Ticket Tailor API key.
* - Service `transcend`: Your Transcend API key.
* - Service `trello`: Your TRELLO api key.
* - Service `triple_whale`: Your Triple Whale API key.
* - Service `upland`: Your Upland Software API key.
* - Service `uppromote`: Your UpPromote API key.
* - Service `veeqo`: Your Veeqo API key.
* - Service `venminder`: Your Venminder API key.
* - Service `visit_by_ges`: Your Visit by GES API key.
* - Service `vitally`: Your Vitally API key.
* - Service `vonage`: Your Vonage API Key.
* - Service `vts`: Your VTS API key.
* - Service `webconnex`: Your Webconnex API key.
* - Service `wicked_reports`: Your Wicked Reports API key.
* - Service `workleap_officevibe`: Your Workleap Officevibe API key.
* - Service `writesonic`: Your Writesonic API key.
* - Service `xsolla`: Your Xsolla API key.
* - Service `yext`: Your Yext API key.
* - Service `yougov_sport`: Your Yougov Sport API key.
* - Service `zingtree`: Your Zingtree API key.
* - Service `zip`: Your Zip API key.
*/
apiKey: string;
/**
* Field usage depends on `service` value:
* - Service `revel`: Your Revel Systems API Key and API Secret.
*/
apiKeyApiSecret: string;
/**
* Field usage depends on `service` value:
* - Service `mandrill`: Comma-separated list of API keys. Required if `use_api_keys` is set to `true`.
*/
apiKeys: string[];
/**
* Field usage depends on `service` value:
* - Service `duoplane`: Your Duoplane API password.
*/
apiPassword: string;
/**
* Field usage depends on `service` value:
* - Service `marketo`: Allowed number of API requests to Marketo instance per day, the default value is 10000.
*/
apiQuota: number;
/**
* Field usage depends on `service` value:
* - Service `the_movie_database`: Your The Movie Database API read access token.
*/
apiReadAccessToken: string;
/**
* Field usage depends on `service` value:
* - Service `qualtrics`: Allowed number of API requests to Qualtrics per minute, the default value is 2000. Maximum allowed number is 3000 because brands may make up to 3000 API requests per minute across all of its API calls.
*/
apiRequestsPerMinute: number;
/**
* Field usage depends on `service` value:
* - Service `zuora`: The API role assigned to the integration user.
* - Service `zuora_sandbox`: The API role assigned to the integration user.
*/
apiRole: string;
/**
* Field usage depends on `service` value:
* - Service `confluent_cloud`: API Secret
* - Service `consensus_demo_automation_platform`: Your Consensus Demo Automation Platform API secret.
* - Service `forj_community`: Your Forj Community API secret.
* - Service `friendbuy`: Your Friendbuy API secret.
* - Service `integrate`: Your Integrate API secret.
* - Service `justcall`: Your JustCall API secret.
* - Service `liftoff`: Your Liftoff API secret.
* - Service `mixpanel`: Mixpanel API Secret.
* - Service `qualaroo`: Your Qualaroo API Secret.
* - Service `sailthru`: The Sailthru API secret.
* - Service `shareasale`: Your ShareASale API secret.
* - Service `vonage`: Your Vonage API Secret.
*/
apiSecret: string;
/**
* Field usage depends on `service` value:
* - Service `alchemer`: Your Alchemer API Secret key.
*/
apiSecretKey: string;
/**
* Field usage depends on `service` value:
* - Service `sigma_computing_source`: Your Sigma Computing api server.
*/
apiServer: string;
/**
* Field usage depends on `service` value:
* - Service `aha`: Your Aha! API key.
* - Service `aircall`: Your Aircall API token.
* - Service `appsflyer`: API Token for AppsFlyer's PULL API.
* - Service `aura_from_unity`: Your Aura from Unity API token.
* - Service `awin`: Your Awin API Token.
* - Service `backbone_plm`: Your Backbone PLM API token.
* - Service `brex`: Your Brex API token
* - Service `buildkite`: Your Buildkite API token.
* - Service `buzzsprout`: Your Buzzsprout API token.
* - Service `centra`: Your Centra API token.
* - Service `chameleon`: Your Chameleon API token.
* - Service `clari`: Your Clari API token.
* - Service `cloudflare_analytics`: Your Cloudflare Analytics API token.
* - Service `confluence`: The Confluence API token.
* - Service `dixa`: Your Dixa API token.
* - Service `drip`: Your Drip API Token.
* - Service `factbird`: Your Factbird API token.
* - Service `fone_dynamics`: Your Fone Dynamics API token.
* - Service `forethought`: Your Forethought API token.
* - Service `fountain`: Your Fountain API token.
* - Service `g2`: Your G2 API token.
* - Service `gladly`: Your Gladly API Token.
* - Service `hibob`: Your Hibob API token.
* - Service `kandji`: Your Kandji API token.
* - Service `livechat`: Your Livechat Access token.
* - Service `livechat_partner`: Your Livechat Partner API Token.
* - Service `maxio_saasoptics`: Your Maxio SaaSOptics API token.
* - Service `megaphone`: Your Megaphone API token.
* - Service `missive`: Your Missive API token.
* - Service `mixmax`: Mixmax API token.
* - Service `okta`: Your Okta API token.
* - Service `ordway`: Your Ordway API token.
* - Service `packiyo`: Your Packiyo API token.
* - Service `pipedrive`: (Optional)Your Pipedrive personal API token
* - Service `pivotal_tracker`: Pivotal Tracker API token.
* - Service `postmark`: Your Postmark account API token.
* - Service `productive`: Your Productive API token.
* - Service `pylon_support_platform`: Your Pylon Support Platform API token.
* - Service `qualtrics`: API token of the Qualtrics account.
* - Service `rakutenadvertising`: Your Rakuten Advertising API token.
* - Service `recharge`: The Recharge API token.
* - Service `referralhero`: Your Referralhero API token.
* - Service `resource_management_by_smartsheet`: Your Resource Management by Smartsheet API token.
* - Service `retently`: Your Retently API token.
* - Service `reviewsai`: Your REVIEWS.ai API token.
* - Service `rundeck`: Your Rundeck API token.
* - Service `safetyculture`: Your SafetyCulture API token.
* - Service `sensor_tower`: Your Sensor Tower API token.
* - Service `sentry`: Your Sentry auth token.
* - Service `simplecast`: Your Simplecast API token.
* - Service `smartsheet`: API token generated from your Smartsheet account.
* - Service `snyk`: Your Snyk API token.
* - Service `textus`: Your TextUs API token.
* - Service `toggl_track`: Your Toggl Track API token
* - Service `trello`: Your TRELLO api token.
* - Service `trisolute`: Your Trisolute API token.
* - Service `vwo`: Your VWO API token.
* - Service `web_scraper`: Your Web Scraper API token.
* - Service `zendesk`: Deprecated: Use Confidential OAuth client authentication instead. Zendesk API tokens are auto-generated passwords in the Support admin interface.
* - Service `zendesk_sunshine`: Zendesk API tokens are auto-generated passwords in the Support admin interface.
* - Service `zendesk_workforce_management`: Your Zendesk Workforce Management API token.
*/
apiToken: string;
apiType: string;
/**
* Field usage depends on `service` value:
* - Service `braze`: Your Braze API URL.
*/
apiUrl: string;
/**
* Field usage depends on `service` value:
* - Service `amazon_dsp`: Your Amazon DSP API URL region.
*/
apiUrlRegion: string;
/**
* Field usage depends on `service` value:
* - Service `zendesk`: Maximum Zendesk Api Usage allowed
*/
apiUsage: string;
/**
* Field usage depends on `service` value:
* - Service `salesforce`: (Optional) The percentage of your Salesforce [daily API limit](https://developer.salesforce.com/docs/atlas.en-us.salesforce_app_limits_cheatsheet.meta/salesforce_app_limits_cheatsheet/salesforce_app_limits_platform_api.htm) that Fivetran should consume. Value must be between 50 and 90 (default value = `90`)
* - Service `salesforce_sandbox`: (Optional) The percentage of your Salesforce [daily API limit](https://developer.salesforce.com/docs/atlas.en-us.salesforce_app_limits_cheatsheet.meta/salesforce_app_limits_cheatsheet/salesforce_app_limits_platform_api.htm) that Fivetran should consume. Value must be between 50 and 90 (default value = `90`)
*/
apiUsageLimit: number;
/**
* Field usage depends on `service` value:
* - Service `shipnetwork`: Your ShipNetwork API user identifier.
*/
apiUserIdentifier: string;
/**
* Field usage depends on `service` value:
* - Service `shipnetwork`: Your ShipNetwork API user secret.
*/
apiUserSecret: string;
/**
* Field usage depends on `service` value:
* - Service `discourse`: Your Discourse API username.
*/
apiUsername: string;
/**
* Field usage depends on `service` value:
* - Service `kustomer`: Api Utilization Percentage
*/
apiUtilizationPercentage: string;
/**
* Field usage depends on `service` value:
* - Service `pardot`: API Version
* - Service `pardot_sandbox`: API Version
*/
apiVersion: string;
/**
* Field usage depends on `service` value:
* - Service `churnkey`: Your Churnkey APP ID.
* - Service `open_exchange_rates`: Your Open Exchange Rates App Id.
* - Service `rokt`: Your Rokt app ID.
* - Service `tiktok_organic`: Your Tiktok Organic app ID.
*/
appId: string;
/**
* Field usage depends on `service` value:
* - Service `pendo`: Specific App IDs to sync. Must be populated if `sync_mode` is set to `SpecificAppIds`.
*/
appIds: string[];
/**
* Field usage depends on `service` value:
* - Service `appsflyer`: * App ID(s)
*/
appIdsAppsflyers: outputs.GetConnectorConfigAppIdsAppsflyer[];
/**
* Field usage depends on `service` value:
* - Service `loopio`: Your Loopio App Key.
* - Service `servicetitan`: Your ServiceTitan app key.
* - Service `yotpo`: Your Yotpo app key.
* - Service `yotpo_app`: Your Yotpo App key.
*/
appKey: string;
/**
* Field usage depends on `service` value:
* - Service `brightpearl`: Your Brightpearl app reference.
*/
appReference: string;
/**
* Field usage depends on `service` value:
* - Service `rokt`: Your Rokt app secret.
*/
appSecret: string;
/**
* Field usage depends on `service` value:
* - Service `economic`: Your E-conomic X-AppSecretToken goes here.
*/
appSecretToken: string;
/**
* Field usage depends on `service` value:
* - Service `itunes_connect`: Your app-specific password
*/
appSpecificPassword: string;
/**
* Field usage depends on `service` value:
* - Service `itunes_connect`: Whether to sync all apps or specific apps.
*/
appSyncMode: string;
/**
* Field usage depends on `service` value:
* - Service `shopify`: App store url of your public app
*/
appUrl: string;
/**
* Field usage depends on `service` value:
* - Service `aws_cost_report`: If you know that the source completely overwrites the same file with new data, you can append the changes instead of upserting based on filename and line number.
* - Service `azure_blob_storage`: If you know that the source completely over-writes the same file with new data, you can append the changes instead of upserting based on filename and line number.
* - Service `box`: If you know that the source completely over-writes the same file with new data, you can append the changes instead of upserting based on filename and line number.
* - Service `dropbox`: If you know that the source completely over-writes the same file with new data, you can append the changes instead of upserting based on filename and line number.
* - Service `email`: If you know that the source completely over-writes the same file with new data, you can append the changes instead of upserting based on filename and line number.
* - Service `ftp`: If you know that the source completely over-writes the same file with new data, you can append the changes instead of upserting based on filename and line number.
* - Service `gcs`: If you know that the source completely over-writes the same file with new data, you can append the changes instead of upserting based on filename and line number.
* - Service `google_drive`: If you know that the source completely over-writes the same file with new data, you can append the changes instead of upserting based on filename and line number.
* - Service `kinesis`: If you know that the source completely over-writes the same file with new data, you can append the changes instead of upserting based on filename and line number.
* - Service `s3`: If you know that the source completely over-writes the same file with new data, you can append the changes instead of upserting based on filename and line number.
* - Service `s3_compatible_storage`: If you know that the source completely over-writes the same file with new data, you can append the changes instead of upserting based on filename and line number.
* - Service `sftp`: If you know that the source completely over-writes the same file with new data, you can append the changes instead of upserting based on filename and line number.
* - Service `share_point`: If you know that the source completely over-writes the same file with new data, you can append the changes instead of upserting based on filename and line number.
* - Service `wasabi_cloud_storage`: If you know that the source completely over-writes the same file with new data, you can append the changes instead of upserting based on filename and line number.
*/
appendFileOption: string;
/**
* Field usage depends on `service` value:
* - Service `algolia`: Your Algolia application ID.
* - Service `xactly`: Your Xactly Application ID.
*/
applicationId: string;
/**
* Field usage depends on `service` value:
* - Service `cin7core`: Your Cin7 Core application key.
* - Service `datadog`: Your Datadog application key.
* - Service `dear`: Your Dear Application key.
* - Service `partnerize`: Your Partnerize user application key.
*/
applicationKey: string;
/**
* Field usage depends on `service` value:
* - Service `db2z`: The application name used to generate an RACF PassTicket for user authentication. Specify only when `authentication_method` is `LEGACY_PASS_TICKET` or `ENHANCED_PASS_TICKET`.
*/
applicationName: string;
/**
* Field usage depends on `service` value:
* - Service `itunes_connect`: Specific apps to sync. Must be populated if `app_sync_mode` is set to `SpecificApps`.
*/
apps: string[];
/**
* Field usage depends on `service` value:
* - Service `oracle_hva`: Archive log format.
* - Service `oracle_sap_hva`: Archive log format.
* - Service `oracle_sap_hva_netweaver`: Archive log format.
* - Service `sql_server_hva`: Format for archive log file names
* - Service `sql_server_sap_ecc_hva`: Format for archive log file names
*/
archiveLogFormat: string;
/**
* Field usage depends on `service` value:
* - Service `oracle_hva`: Archive log path.
* - Service `oracle_sap_hva`: Archive log path.
* - Service `oracle_sap_hva_netweaver`: Archive log path.
* - Service `sql_server_hva`: Directory where archive logs are located
* - Service `sql_server_sap_ecc_hva`: Directory where archive logs are located
*/
archiveLogPath: string;
/**
* Field usage depends on `service` value:
* - Service `aws_cost_report`: Optional. Files inside of compressed archives with filenames matching this regular expression will be synced.
* - Service `azure_blob_storage`: Files inside of compressed archives with filenames matching this regular expression will be synced.
* - Service `box`: Files inside of compressed archives with filenames matching this regular expression will be synced.
* - Service `dropbox`: Files inside of compressed archives with filenames matching this regular expression will be synced.
* - Service `email`: Files inside of compressed archives with filenames matching this regular expression will be synced.
* - Service `ftp`: Files inside of compressed archives with filenames matching this regular expression will be synced.
* - Service `gcs`: Files inside of compressed archives with filenames matching this regular expression will be synced.
* - Service `google_drive`: Files inside of compressed archives with filenames matching this regular expression will be synced.
* - Service `kinesis`: Optional. Files inside of compressed archives with filenames matching this regular expression will be synced.
* - Service `s3`: Files inside compressed archives with filenames matching this regular expression will be synced.
* - Service `s3_compatible_storage`: Files inside compressed archives with filenames matching this regular expression will be synced.
* - Service `sftp`: Files inside of compressed archives with filenames matching this regular expression will be synced.
* - Service `share_point`: Files inside of compressed archives with filenames matching this regular expression will be synced.
* - Service `wasabi_cloud_storage`: Files inside compressed archives with filenames matching this regular expression will be synced.
*/
archivePattern: string;
/**
* Field usage depends on `service` value:
* - Service `marketo`: Marketo SOAP credentials provided.
*/
areSoapCredentialsProvided: boolean;
/**
* Field usage depends on `service` value:
* - Service `azure_service_bus`: The IP address (or) the URL of ASB namespace
*/
asbIp: string;
/**
* Field usage depends on `service` value:
* - Service `oracle_hva`: Default value: `false`. Set to `true` if you're using ASM on a non-RAC instance.
* - Service `oracle_sap_hva`: Default value: `false`. Set to `true` if you are using ASM on a non-RAC instance.
*/
asmOption: boolean;
/**
* Field usage depends on `service` value:
* - Service `oracle_hva`: ASM Oracle Home path.
* - Service `oracle_sap_hva`: The Oracle ASM home directory.
*/
asmOracleHome: string;
/**
* Field usage depends on `service` value:
* - Service `oracle_hva`: ASM password. Mandatory if `use_oracle_rac` or `asm_option` is set to `true`.
* - Service `oracle_sap_hva`: The ASM user's password. Mandatory if `use_oracle_rac` or `asm_option` is set to `true`.
*/
asmPassword: string;
/**
* Field usage depends on `service` value:
* - Service `oracle_hva`: ASM TNS.
* - Service `oracle_sap_hva`: ASM TNS.
*/
asmTns: string;
/**
* Field usage depends on `service` value:
* - Service `oracle_hva`: ASM user. Mandatory if `use_oracle_rac` or `asm_option` is set to `true`.
* - Service `oracle_sap_hva`: The ASM user. Mandatory if `use_oracle_rac` or `asm_option` is set to `true`.
*/
asmUser: string;
/**
* Field usage depends on `service` value:
* - Service `amazon_ads`: Time period used to attribute conversions based on clicks.
*/
attributionWindow: string;
/**
* Field usage depends on `service` value:
* - Service `tiktok_ads`: Rollback sync duration to capture conversions. Set this to your configured attribution window in TikTok Ads. The default value is 7 days.
*/
attributionWindowSize: string;
/**
* Field usage depends on `service` value:
* - Service `auth0`: Your Auth0 API audience.
*/
audience: string;
/**
* Field usage depends on `service` value:
* - Service `databricks_db`: Token-based authentication type
* - Service `gitlab`: Your GitLab auth type.
* - Service `redshift_db`: Password-based authentication type
* - Service `snowflake_db`: Password-based or key-based authentication type
*/
auth: string;
/**
* Field usage depends on `service` value:
* - Service `happyfox`: Your HappyFox auth code.
*/
authCode: string;
/**
* Field usage depends on `service` value:
* - Service `younium`: Your Younium auth environment.
*/
authEnvironment: string;
/**
* Field usage depends on `service` value:
* - Service `webhooks`: Set if you use HMAC/token-based auth methods. This is used to retrieve a key in headers
*/
authHeaderKey: string;
/**
* Field usage depends on `service` value:
* - Service `aurora`: Database authentication method
* - Service `aurora_postgres`: Database authentication method
* - Service `azure_blob_storage`: Authentication Method
* - Service `azure_postgres`: Database authentication method
* - Service `azure_sql_db`: Authentication Method.
* - Service `azure_sql_managed_db`: Authentication Method.
* - Service `google_cloud_mysql`: Database authentication method
* - Service `google_cloud_postgresql`: Database authentication method
* - Service `heroku_postgres`: Database authentication method
* - Service `magento_mysql`: Database authentication method
* - Service `magento_mysql_rds`: Database authentication method
* - Service `maria`: Database authentication method
* - Service `maria_azure`: Database authentication method
* - Service `maria_rds`: Database authentication method
* - Service `microsoft_dynamics_365_fno`: Authentication Method
* - Service `microsoft_lists`: Authentication Method
* - Service `mysql`: Database authentication method
* - Service `mysql_azure`: Database authentication method
* - Service `mysql_rds`: Database authentication method
* - Service `postgres`: Database authentication method
* - Service `postgres_rds`: Database authentication method
* - Service `sql_server_hva`: Authentication Method
* - Service `sql_server_sap_ecc_hva`: Authentication Method
* - Service `webhooks`: The authentication mechanism you want to use
*/
authMethod: string;
/**
* Field usage depends on `service` value:
* - Service `anaplan`: The Anaplan authentication method.
* - Service `concur`: The Authentication Mode used by SAP Concur. It can be PasswordGrant or CompanyLevel auth mode
* - Service `github`: Authorization type.
* - Service `smartsheet`: Authorization type.
* - Service `workday`: Authentication Mode
* - Service `workday_financial_management`: Authentication Mode
* - Service `workday_hcm`: Authentication Mode
*/
authMode: string;
/**
* Field usage depends on `service` value:
* - Service `webhooks`: The secret you want to use for HMAC/token-based auth methods
*/
authSecret: string;
/**
* Field usage depends on `service` value:
* - Service `impact_partner`: Your Impact Partner auth token
* - Service `zonka_feedback`: Your Zonka Feedback auth token.
*/
authToken: string;
/**
* Field usage depends on `service` value:
* - Service `360learning`: Your 360Learning auth type.
* - Service `airtable`: Type of authentication being used by connector
* - Service `amqp`: Authentication method (BasicAuth or MutualTLS).
* - Service `aws_cost_report`: Access approach
* - Service `azure_service_bus`: The authentication mode to access the topic
* - Service `dynamics_365`: Authentication mechanism. Either one of `OAUTH2`, or `SERVICE_PRINCIPAL`. Default value `OAUTH2`
* - Service `gcs`: Authorization type. Required for storage bucket authentication.
* - Service `google_sheets`: The `OAuth` value must be specified for this type of authorization.
* - Service `jira`: Authorization type.
* - Service `mixpanel`: Authentication Method
* - Service `pardot`: Authenticate using OAuth or HTTP Basic
* - Service `pardot_sandbox`: Authenticate using OAuth or HTTP Basic
* - Service `qualtrics`: Type of authentication being used by connector
* - Service `s3`: Access approach
* - Service `s3_compatible_storage`: Access approach
* - Service `upland`: Authentication method you want to use for your connection.
* - Service `wasabi_cloud_storage`: The Wasabi Cloud Storage Access approach. Required for connector creation. Default value: `ACCESS_KEY`.
*/
authType: string;
/**
* Field usage depends on `service` value:
* - Service `amazon_dsp`: Your Amazon DSP auth grant URL region.
*/
authUrlRegion: string;
/**
* Field usage depends on `service` value:
* - Service `adobe_analytics`: Authentication Method
* - Service `db2z`: User authentication method. Supported values:`PASSWORD`- Authenticate with the database server using an RACF user ID and password. If the parameter is omitted, `PASSWORD` is used by default. `LEGACY_PASS_TICKET`- Authenticate with the database server using an RACF user ID and legacy PassTicket. `ENHANCED_PASS_TICKET`- Authenticate with the database server using an RACF user ID and an enhanced PassTicket. Enhanced PassTickets are more secure than legacy PassTickets.
* - Service `elastic_cloud`: The authentication method used to connect to your cluster.
* - Service `es_self_hosted`: The authentication method used to connect to your cluster.
* - Service `gainsight_customer_success`: The authentication method to use. Can be either OAUTH or API_KEY.
* - Service `opendistro`: The authentication method used to connect to your cluster.
* - Service `opensearch`: The authentication method used to connect to your cluster.
* - Service `oracle_fusion_cloud_apps_crm`: The Oracle Fusion Cloud authentication method.
* - Service `oracle_fusion_cloud_apps_fscm`: The Oracle Fusion Cloud authentication method.
* - Service `oracle_fusion_cloud_apps_hcm`: The Oracle Fusion Cloud authentication method.
* - Service `salesforce`: (Optional) Authentication type (default value = `STANDARD`)
* - Service `salesforce_sandbox`: (Optional) Authentication type (default value = `STANDARD`)
*/
authenticationMethod: string;
authorizationMethod: string;
/**
* Field usage depends on `service` value:
* - Service `tiktok_organic`: The authorization URL of the app registered in your TikTok developer account.
* - Service `workday`: Authorization URL
*/
authorizationUrl: string;
/**
* Field usage depends on `service` value:
* - Service `amplitude`: Amazon S3 Credentials
* - Service `pendo`: Configuration for AWS S3 Storage
*/
awsCredentials: outputs.GetConnectorConfigAwsCredentials;
/**
* Field usage depends on `service` value:
* - Service `aurora`: The AWS region code for your RDS instance. Required if the authentication method is `AWS_IAM`.
* - Service `dynamodb`: The AWS region code for the DynamoDB instance, e.g. `us-east-1`.
* - Service `magento_mysql_rds`: The AWS region code for your RDS instance. Required if the authentication method is `AWS_IAM`.
* - Service `maria_rds`: The AWS region code for your RDS instance. Required if the authentication method is `AWS_IAM`.
* - Service `mysql_rds`: The AWS region code for your RDS instance. Required if the authentication method is `AWS_IAM`.
*/
awsRegionCode: string;
/**
* Field usage depends on `service` value:
* - Service `pendo`: Configuration for Azure Blob Storage
*/
azureCredentials: outputs.GetConnectorConfigAzureCredentials;
backintConfigurationPath: string;
backintExecutablePath: string;
/**
* Field usage depends on `service` value:
* - Service `sql_server`: Filename pattern for transaction log backup files.
*/
backupLogFormat: string;
/**
* Field usage depends on `service` value:
* - Service `sql_server`: Full path to the local directory containing transaction log backup files. Required if `backup_storage_type` is `ALTERNATE_LOCATION`
*/
backupLogPath: string;
/**
* Field usage depends on `service` value:
* - Service `sql_server`: Location of transaction log backup files when using BACKUP binary log type. Possible values: `"AZURE"`, `"ALTERNATE_LOCATION"`, `"AWS"`.
*/
backupStorageType: string;
/**
* Field usage depends on `service` value:
* - Service `amazon_selling_partner`: The earliest date to sync data from, in YYYY-MM-DD format. Cannot be before 1994-01-01 or in the future.
* - Service `shopify`: Limit of the Historical Sync Time for selected tables
* - Service `stripe`: Limit of the Historical Sync Time for selected tables
* - Service `stripe_test`: Limit of the Historical Sync Time for selected tables
* - Service `zendesk`: Date Limit of the Historical Sync Time for selected tables. The format should be YYYY-MM-DD.
*/
backwardSyncLimit: string;
/**
* Field usage depends on `service` value:
* - Service `hubspot`: Date Limit of the Historical Sync Time for selected tables. The Format should be YYYY-MM-DD.
* - Service `mixpanel`: Date from which data needs to be synced.
* - Service `pendo`: The start date (YYYY-MM-DD) from which to sync historical data.
*/
backwardSyncLimitDate: string;
/**
* Field usage depends on `service` value:
* - Service `open_exchange_rates`: Your Open Exchange Rates Base Currency.
*/
baseCurrency: string;
/**
* Field usage depends on `service` value:
* - Service `freshteam`: Your company's Freshteam base domain name (usually **company**.freshteam.com).
*/
baseDomain: string;
/**
* Field usage depends on `service` value:
* - Service `airtable`: ID of base in Airtable
*/
baseId: string;
/**
* Field usage depends on `service` value:
* - Service `360learning`: Your 360Learning base URL.
* - Service `aha`: Your Aha! subdomain.
* - Service `akeneo`: Your Akeneo base URL.
* - Service `bigmarker`: Your BigMarker base URL.
* - Service `billing_platform`: Your BillingPlatform subdomain.
* - Service `boostr`: Your Boostr base URL.
* - Service `brex`: Your Brex Base URL
* - Service `centra`: Your Centra base URL.
* - Service `coalesce`: Your Coalesce base URL.
* - Service `coheris`: Your Coheris base URL.
* - Service `cornerstone`: Your Cornerstone base URL.
* - Service `culture_amp`: Your Culture Amp base URL.
* - Service `datadog`: Your Datadog base url.
* - Service `factbird`: Your Factbird base url.
* - Service `fillout`: Your Fillout Base URL.
* - Service `financial_force`: (Optional) The custom Salesforce domain. Make sure that the `base_url` starts with `https://`.
* - Service `freshsales`: Your Freshsales product.
* - Service `gitlab`: Your GitLab base URL.
* - Service `gongio`: Your Gong API Base URL.
* - Service `higher_logic_vanilla`: Your Higher Logic Vanilla base URL.
* - Service `ironclad`: Your Ironclad base url.
* - Service `jotform`: Your Jotform base URL.
* - Service `mailgun`: Your Mailgun base URL.
* - Service `nice`: Your NICE base URL.
* - Service `ortto`: Your Ortto base URL. Possible values: `api`, `api.au`, `api.eu`.
* - Service `prisma_cloud`: Your Prisma Cloud admin console URL.
* - Service `salesforce`: (Optional) The custom Salesforce domain. Make sure that the `base_url` starts with `https://`.
* - Service `salesforce_sandbox`: (Optional) The custom Salesforce domain. Make sure that the `base_url` starts with `https://`.
* - Service `stickyio`: Your sticky.io base URL .
* - Service `veeva_vault`: Base URL
* - Service `veevavault`: Your Veeva Vault base URL.
* - Service `vitally`: Your Vitally base URL.
*/
baseUrl: string;
/**
* Field usage depends on `service` value:
* - Service `ada`: Your Ada API key.
* - Service `crowddev`: Your crowd.dev Auth Token.
* - Service `customerio`: Your Customer.io App API Key.
* - Service `freshchat`: Your Freshchat API Token.
* - Service `hopin`: Your Hopin API key.
* - Service `orbit`: Your Orbit API Token.
* - Service `productboard`: Your Productboard API key.
* - Service `smarthr`: Your SmartHR access token.
* - Service `sprout`: Your Sprout Social API Access Token.
* - Service `zenefits`: Your Zenefits bearer token.
*/
bearerToken: string;
/**
* Field usage depends on `service` value:
* - Service `sql_server`: Determine who is responsible for truncating the online transaction log. Possible values: `"FIVETRAN"`, `"USER_MANAGED"`, `"SQL_SERVER_AGENT"`. Default value is `"FIVETRAN"`.
*/
binaryLogTruncater: string;
/**
* Field usage depends on `service` value:
* - Service `sql_server`: Source of transaction log data when using Binary Log Reader. Possible values: `"ONLINE"`, `"BACKUP"`. Default value is `"ONLINE"`.
*/
binaryLogType: string;
/**
* Field usage depends on `service` value:
* - Service `azure_cosmos_for_mongo`: How binary data is represented in the database. Possible values: 'Base64' (default), 'Uuid'.
* - Service `mongo`: How binary data is represented in the database. Possible values: 'Base64' (default), 'Uuid'.
* - Service `mongo_sharded`: How binary data is represented in the database. Possible values: 'Base64' (default), 'Uuid'.
*/
binaryRepresentation: string;
/**
* Field usage depends on `service` value:
* - Service `webhooks`: The blob SAS URL of your Azure container. Required if `bucket_service` is set to `AZURE`.
*/
blobSasUrl: string;
/**
* Field usage depends on `service` value:
* - Service `rarible`: Your Rarible Blockchain.
*/
blockchain: string;
/**
* Field usage depends on `service` value:
* - Service `oracle_moat_analytics`: Your Oracle Moat Analytics Brand ID.
*/
brandId: string;
/**
* Field usage depends on `service` value:
* - Service `facebook`: List of breakdowns which connector will sync. [Possible breakdowns values](https://fivetran.com/docs/applications/facebook-ad-insights/api-config#breakdowns).
*/
breakdowns: string[];
/**
* Field usage depends on `service` value:
* - Service `appsflyer`: Customer S3 Bucket
* - Service `aws_cloudtrail`: The AWS bucket name which is configured for AWS CloudTrail.
* - Service `aws_cost_report`: The S3 bucket name with the AWS Cost and Usage Report
* - Service `aws_inventory`: The AWS bucket name that is configured for AWS Config.
* - Service `aws_lambda`: S3 Bucket
* - Service `cloudfront`: The bucket name for CloudFront.
* - Service `gcs`: The name of the GCS bucket.
* - Service `google_play`: The Google Cloud Storage source bucket.
* - Service `heap`: The S3 bucket name.
* - Service `kinesis`: The name of the Kinesis bucket.
* - Service `s3`: The S3 bucket name. Required for connector creation.
* - Service `s3_compatible_storage`: The S3-Compatible Storage bucket name. Required for connector creation.
* - Service `segment`: The name of the Segment bucket. Must be populated if `sync_type` is set to `S3`.
* - Service `sql_server`: The name of the S3 bucket.
* - Service `wasabi_cloud_storage`: The Wasabi Cloud Storage bucket name. Required for connector creation.
*/
bucket: string;
/**
* Field usage depends on `service` value:
* - Service `adjust`: Your AWS S3 or GCS bucket.
* - Service `google_analytics_360`: The name of the bucket.
* - Service `google_analytics_4_export`: The name of the bucket.
*/
bucketName: string;
/**
* Field usage depends on `service` value:
* - Service `webhooks`: Whether to store the events in Fivetran's container service or your S3 bucket. Default value: `Fivetran`.
*/
bucketService: string;
/**
* Field usage depends on `service` value:
* - Service `reddit_ads`: Specific Accounts to sync. Must be populated if `sync_mode` is set to `SpecificAccounts`.
*/
businessAccounts: string[];
/**
* Field usage depends on `service` value:
* - Service `tiktok_organic_app`: The TikTok business category whose data you want to sync.
*/
businessCategory: string;
/**
* Field usage depends on `service` value:
* - Service `birdeye`: Your Birdeye Business ID.
*/
businessId: string;
/**
* Field usage depends on `service` value:
* - Service `deposco`: Your Deposco business unit.
*/
businessUnit: string;
/**
* Field usage depends on `service` value:
* - Service `pardot`: Business Unit Id
* - Service `pardot_sandbox`: Business Unit Id
*/
businessUnitId: string;
/**
* Field usage depends on `service` value:
* - Service `sailthru`: The number of days to look back for campaign query data during incremental syncs. Valid range: 2-90. Default: 60.
*/
campaignQueryLookbackWindowInDays: number;
/**
* Field usage depends on `service` value:
* - Service `databricks_db`: catalog to sync
*/
catalog: string;
/**
* Field usage depends on `service` value:
* - Service `anaplan`: The contents of your PEM certificate file. Must be populated if `auth_mode` is set to `Certificate`.
* - Service `db2z`: Db2 for z/OS host certificate
* - Service `qualtrics`: Your Client Certificate
* - Service `salesforce`: Provide content of the `.pem` certificate (only when authentication_method = `ADVANCED`).
* - Service `salesforce_sandbox`: Provide content of the `.pem` certificate (only when authentication_method = `ADVANCED`).
*/
certificate: string;
/**
* Field usage depends on `service` value:
* - Service `netsuite_suiteanalytics`: Certificate Id
*/
certificateId: string;
/**
* Field usage depends on `service` value:
* - Service `facebook`: Time period to attribute conversions based on clicks. [Possible click_attribution_window values](https://fivetran.com/docs/applications/facebook-ad-insights/api-config#clickattributionwindow).
* - Service `pinterest_ads`: The number of days to use as the conversion attribution window for a 'click' action.
*/
clickAttributionWindow: string;
client: string;
/**
* Field usage depends on `service` value:
* - Service `apache_kafka`: Kafka client certificate.
* - Service `heroku_kafka`: Heroku Kafka client certificate. Required for `TLS` security protocol.
*/
clientCert: string;
/**
* Field usage depends on `service` value:
* - Service `apache_kafka`: Kafka client certificate key.
* - Service `heroku_kafka`: Heroku Kafka client certificate key. Required for `TLS` security protocol.
*/
clientCertKey: string;
/**
* Field usage depends on `service` value:
* - Service `amqp`: Client certificate for mutual TLS authentication.
* - Service `gitlab`: Your GitLab client certificate content.
* - Service `share_point`: `Client Certificate` of your Microsoft client application.
*/
clientCertificate: string;
/**
* Field usage depends on `service` value:
* - Service `share_point`: `Certificate Private Key` of your Microsoft client application.
*/
clientCertificatePrivateKey: string;
/**
* Field usage depends on `service` value:
* - Service `ceridian_dayforce`: Your Ceridian Dayforce client host.
*/
clientHost: string;
/**
* Field usage depends on `service` value:
* - Service `360learning`: Your 360Learning client ID.
* - Service `acumatica`: Your Acumatica client ID.
* - Service `adform`: Your Adform client ID.
* - Service `adobe_analytics`: Client ID from the OAuth Server-to-Server credentials of your Adobe Project.
* - Service `adobe_experience_platform`: Your Adobe Experience Platform client ID.
* - Service `adobe_workfront`: Your Adobe Workfront client ID.
* - Service `adp_workforce_now`: Your ADP Client ID.
* - Service `akamai`: Your Akamai client ID.
* - Service `akeneo`: Your Akeneo client ID.
* - Service `alation`: Client ID of the OAuth client application registered in Alation for this connection.
* - Service `auth0`: Your Auth0 client ID.
* - Service `autodesk_bim_360`: Your Autodesk BIM 360 & Construction Cloud client ID.
* - Service `bigin_by_zoho_crm`: Your Bigin by Zoho CRM Client Id
* - Service `billing_platform`: Your BillingPlatform client ID.
* - Service `bing_webmaster_tools`: Your Bing Webmaster Tools client ID.
* - Service `bizzabo_app`: Your Bizzabo client ID.
* - Service `bizzabo_v2`: Your Bizzabo client ID.
* - Service `brightcove`: Your Brightcove client ID.
* - Service `brightflag`: Your Brightflag client ID.
* - Service `brightpearl`: Your Brightpearl client ID.
* - Service `brivo`: Your Brivo client ID.
* - Service `buildium`: Your Buildium API client ID.
* - Service `bynder`: Client ID of the OAuth app that you created in Bynder for the connection.
* - Service `cabcharge`: Your Cabcharge client ID.
* - Service `canvas_by_instructure`: Your Canvas by Instructure client ID.
* - Service `canvas_data_2_by_instructure`: Your Canvas Data 2 by Instructure client ID.
* - Service `castor_edc`: Your Castor EDC client Id.
* - Service `classy`: Your Classy client ID.
* - Service `clazar`: Your Clazar client ID.
* - Service `cloudbeds`: Your Cloudbeds client ID.
* - Service `commercetools`: Your commercetools client ID.
* - Service `concur`: The SAP Concur Client ID.
* - Service `constant_contact`: Your Constant Contact client ID.
* - Service `cornerstone`: Your Cornerstone client ID.
* - Service `coupa`: Your Coupa client_id
* - Service `credly`: Enter your Credly Client ID
* - Service `criteo`: Your Criteo Client ID.
* - Service `criteo_retail_media`: Your Criteo Retail Media client ID.
* - Service `cube`: Your Cube client ID.
* - Service `cube_software`: Your Cube client ID.
* - Service `culture_amp`: Your Culture Amp client ID.
* - Service `cvent`: Your Cvent client ID.
* - Service `d2l_brightspace`: Your D2L Brightspace client ID.
* - Service `dialpad`: Your Dialpad client ID.
* - Service `ebay`: Your eBay app ID.
* - Service `exact_online`: Your Exact Online client ID.
* - Service `fillout`: Your Fillout client ID.
* - Service `flexport`: The Flexport API Key.
* - Service `formstack`: Your Formstack client ID.
* - Service `fortnox`: Your Fortnox client ID.
* - Service `genesys`: Your Genesys client ID.
* - Service `github`: GitHub App Client ID
* - Service `gofundme_pro`: Client ID of the API application in your GoFundMe Pro account.
* - Service `h_level`: Your HighLevel client ID.
* - Service `hana_sap_hva_ecc_netweaver`: Three-digit (000-999) identifier of the SAP client, which is sent to an AS ABAP upon logon.
* - Service `hana_sap_hva_s4_netweaver`: Three-digit (000-999) identifier of the SAP client, which is sent to an AS ABAP upon logon.
* - Service `helpdesk`: Your HelpDesk client ID.
* - Service `hilti_ontrack`: Your Hilti On!Track client ID.
* - Service `ibacos`: Your Ibacos Client ID.
* - Service `ilevel`: Your iLevel Client ID.
* - Service `instructure`: Your Instructure client ID.
* - Service `integral_ad_science`: Your integral_ad_science client id.
* - Service `ironclad`: Your Ironclad client ID.
* - Service `jama_software`: Your Jama Software client ID.
* - Service `jibble`: Your Jibble client ID.
* - Service `khoros_communities`: Your Khoros Communities client ID.
* - Service `learn_amp`: Your Learn Amp client ID.
* - Service `looker_source`: Your Looker Client ID.
* - Service `marketo`: Marketo REST API Client Id.
* - Service `medallia`: Medallia Client ID
* - Service `microsoft_entra_id`: Your Microsoft Entra ID Client ID.
* - Service `microsoft_power_bi`: Your Microsoft Power BI client ID.
* - Service `microsoft_teams`: Your Microsoft Teams client ID.
* - Service `navan`: Your Navan client ID.
* - Service `nice`: Your NICE client ID.
* - Service `on24`: Your ON24 client ID.
* - Service `onetrust`: Your OneTrust client ID.
* - Service `oracle_fusion_field_service`: Your Oracle Fusion Field Service client ID.
* - Service `oracle_netsuite_openair`: Your NetSuite SuiteProjects Pro client ID.
* - Service `oracle_sap_hva_netweaver`: Three-digit (000-999) identifier of the SAP client, which is sent to an AS ABAP upon logon.
* - Service `paychex`: Your Paychex client ID.
* - Service `paylocity`: Your Paylocity client ID.
* - Service `paypal`: `Client ID` of your PayPal client application.
* - Service `paypal_sandbox`: Client ID of your PayPal client application.
* - Service `personio`: Your Personio Client ID.
* - Service `piwik_pro`: Your Piwik PRO client ID.
* - Service `podio`: Your Podio client ID.
* - Service `power_reviews_enterprise`: Your PowerReviews Enterprise Client ID.
* - Service `prisma_cloud`: Your Prisma Cloud access key ID.
* - Service `procore`: Your Procore client ID.
* - Service `quickbooks`: Client ID of your QuickBooks client application.
* - Service `quora_ads`: Your Quora Ads client ID.
* - Service `reltio`: Your Reltio client ID.
* - Service `salesforce_commerce_cloud`: The Salesforce Commerce Cloud Client ID.
* - Service `salesforce_marketing_cloud`: The Salesforce Marketing Cloud client ID.
* - Service `salesloft`: `Client ID` of your Salesloft client application.
* - Service `sana`: Your Sana client ID.
* - Service `sap_success_factors`: Your SAP SuccessFactors Client ID.
* - Service `servicenow`: ServiceNow Client ID.
* - Service `servicetitan`: Your ServiceTitan client ID.
* - Service `sharetribe`: Your Sharetribe client ID.
* - Service `shipnetwork`: Your ShipNetwork client ID.
* - Service `shopify`: Client ID of your public app
* - Service `showpad`: Your Showpad client ID.
* - Service `siemens_building_x_openness`: Your Siemens Building X Openness client ID.
* - Service `sigma_computing_source`: Your Sigma Computing client ID.
* - Service `skillstx`: Your SkillsTX client ID.
* - Service `skimlinks`: Your Skimlinks client ID.
* - Service `slack_app`: Your Slack app Client ID.
* - Service `smartrecruiters`: Your SmartRecruiters client ID.
* - Service `splash`: Your Splash client ID.
* - Service `square`: The Application ID of your organization.
* - Service `standard_metrics`: Your Standard Metrics Client ID.
* - Service `sugarcrm`: Your SugarCRM client ID.
* - Service `swoogo`: Your Swoogo client Id.
* - Service `taboola`: The Taboola client ID.
* - Service `talkdesk`: The Client ID of your OAuth Client
* - Service `tive`: Your Tive client ID.
* - Service `toast`: Your Toast client ID.
* - Service `trelica`: Your Trelica client ID.
* - Service `tremendous`: Your Tremendous client ID.
* - Service `tymeshift`: Your Tymeshift email.
* - Service `udemy_business`: Your Udemy Business client ID.
* - Service `ukg_pro_workforce_management`: Your UKG Pro Workforce Management client ID.
* - Service `vimeo`: Your Vimeo client ID.
* - Service `visma`: Your Visma client ID.
* - Service `vonage_contact_center`: Your Vonage Contact Center client ID.
* - Service `walmart_marketplace`: Your Walmart Marketplace client ID.
* - Service `xero`: your clientId
* - Service `xray`: Your Xray Client ID.
* - Service `yahoo_display_ads_on_yahoo_japan`: Your Yahoo Display Ads on Yahoo Japan client ID.
* - Service `yougov_sport`: Your Yougov Sport client ID.
* - Service `zendesk_chat`: Your Zendesk client ID.
* - Service `zoho_books`: Your Zoho Books Client ID.
* - Service `zoho_campaigns`: Your Zoho Campaigns Client ID.
* - Service `zoho_desk`: Your Zoho Desk Client Id.
* - Service `zoho_inventory`: Your Zoho Inventory client ID.
* - Service `zoho_recruit`: Your Zoho Recruit client ID.
* - Service `zuora`: Zuora Client ID.
* - Service `zuora_sandbox`: Zuora Client ID.
*/
clientId: string;
/**
* Field usage depends on `service` value:
* - Service `appfigures`: Your Appfigures Client Key.
* - Service `thinkific`: Your Thinkific client key.
* - Service `yougov_sport`: Your Yougov Sport client key.
*/
clientKey: string;
/**
* Field usage depends on `service` value:
* - Service `destini`: Your Destini Client Name.
* - Service `medallia`: Medallia company name
* - Service `zuora`: The name of your organization as registered with Zuora Revenue.
* - Service `zuora_sandbox`: The name of your organization as registered with Zuora Revenue.
*/
clientName: string;
/**
* Field usage depends on `service` value:
* - Service `ceridian_dayforce`: Your Ceridian Dayforce client namespace.
*/
clientNamespace: string;
/**
* Field usage depends on `service` value:
* - Service `amqp`: Client private key for mutual TLS authentication.
* - Service `aurora`: Client Private Key in .pem format.
* - Service `aurora_postgres`: Client Private Key in .pem format.
* - Service `azure_postgres`: Client Private Key in .pem format.
* - Service `gitlab`: Your GitLab client private key content.
* - Service `google_cloud_mysql`: Client Private Key in .pem format.
* - Service `google_cloud_postgresql`: Client Private Key in .pem format.
* - Service `heroku_postgres`: Client Private Key in .pem format.
* - Service `magento_mysql`: Client Private Key in .pem format.
* - Service `magento_mysql_rds`: Client Private Key in .pem format.
* - Service `maria`: Client Private Key in .pem format.
* - Service `maria_azure`: Client Private Key in .pem format.
* - Service `maria_rds`: Client Private Key in .pem format.
* - Service `mysql`: Client Private Key in .pem format.
* - Service `mysql_azure`: Client Private Key in .pem format.
* - Service `mysql_rds`: Client Private Key in .pem format.
* - Service `postgres`: Client Private Key in .pem format.
* - Service `postgres_rds`: Client Private Key in .pem format.
*/
clientPrivateKey: string;
/**
* Field usage depends on `service` value:
* - Service `aurora`: Client Certificate in .pem format.
* - Service `aurora_postgres`: Client Certificate in .pem format.
* - Service `azure_postgres`: Client Certificate in .pem format.
* - Service `google_cloud_mysql`: Client Certificate in .pem format.
* - Service `google_cloud_postgresql`: Client Certificate in .pem format.
* - Service `heroku_postgres`: Client Certificate in .pem format.
* - Service `magento_mysql`: Client Certificate in .pem format.
* - Service `magento_mysql_rds`: Client Certificate in .pem format.
* - Service `maria`: Client Certificate in .pem format.
* - Service `maria_azure`: Client Certificate in .pem format.
* - Service `maria_rds`: Client Certificate in .pem format.
* - Service `mysql`: Client Certificate in .pem format.
* - Service `mysql_azure`: Client Certificate in .pem format.
* - Service `mysql_rds`: Client Certificate in .pem format.
* - Service `postgres`: Client Certificate in .pem format.
* - Service `postgres_rds`: Client Certificate in .pem format.
*/
clientPublicCertificate: string;
/**
* Field usage depends on `service` value:
* - Service `360learning`: Your 360Learning client secret.
* - Service `acumatica`: Your Acumatica client secret.
* - Service `adform`: Your Adform client secret.
* - Service `adobe_analytics`: Client Secret from the OAuth Server-to-Server credentials of your Adobe Project.
* - Service `adobe_experience_platform`: Your Adobe Experience Platform client secret.
* - Service `adobe_workfront`: Your Adobe Workfront client secret.
* - Service `adp_workforce_now`: Your ADP Client Secret.
* - Service `akamai`: Your Akamai client secret.
* - Service `akeneo`: Your Akeneo client secret.
* - Service `alation`: Client secret of the OAuth client application registered in Alation for this connection.
* - Service `auth0`: Your Auth0 client secret.
* - Service `autodesk_bim_360`: Your Autodesk BIM 360 & Construction Cloud client secret.
* - Service `bigin_by_zoho_crm`: Your Bigin by Zoho CRM Client Secret
* - Service `billing_platform`: Your BillingPlatform client secret.
* - Service `bing_webmaster_tools`: Your Bing Webmaster Tools client secret.
* - Service `bizzabo_app`: Your Bizzabo client secret.
* - Service `bizzabo_v2`: Your Bizzabo client secret.
* - Service `brightcove`: Your Brightcove client secret.
* - Service `brightflag`: Your Brightflag client secret.
* - Service `brightpearl`: Your Brightpearl client secret.
* - Service `brivo`: Your Brivo client secret.
* - Service `bynder`: Client secret of the OAuth app that you created in Bynder for the connection.
* - Service `canvas_by_instructure`: Your Canvas by Instructure client secret.
* - Service `castor_edc`: Your Castor EDC client secret.
* - Service `classy`: Your Classy client secret.
* - Service `clazar`: Your Clazar client secret.
* - Service `cloudbeds`: Your Cloudbeds client secret.
* - Service `commercetools`: Your commercetools client secret.
* - Service `concur`: The SAP Concur Client secret.
* - Service `constant_contact`: Your Constant Contact client secret.
* - Service `cornerstone`: Your Cornerstone client secret.
* - Service `coupa`: Your Coupa client_id
* - Service `credly`: Enter your Credly Client Secret
* - Service `criteo`: Your Criteo client secret key.
* - Service `criteo_retail_media`: Your Criteo Retail Media client secret.
* - Service `cube`: Your Cube client secret.
* - Service `cube_software`: Your Cube client secret.
* - Service `culture_amp`: Your Culture Amp client secret.
* - Service `cvent`: Your Cvent client secret.
* - Service `d2l_brightspace`: Your D2L Brightspace client secret.
* - Service `dialpad`: Your Dialpad client secret.
* - Service `ebay`: Your eBay cert ID.
* - Service `exact_online`: Your Exact Online client secret.
* - Service `fillout`: Your Fillout client secret
* - Service `flexport`: The Flexport API Secret.
* - Service `formstack`: Your Formstack client secret.
* - Service `fortnox`: Your Fortnox client secret.
* - Service `genesys`: Your Genesys client secret.
* - Service `gofundme_pro`: Client secret of the API application in your GoFundMe Pro account.
* - Service `h_level`: Your HighLevel client secret.
* - Service `helpdesk`: Your HelpDesk client secret.
* - Service `hilti_ontrack`: Your Hilti On!Track client secret.
* - Service `hubspot`: Client secret for private custom app authentication.
* - Service `ibacos`: Your Ibacos Client secret.
* - Service `ilevel`: Your iLevel Client Secret.
* - Service `instructure`: Your Instructure client secret.
* - Service `integral_ad_science`: Your integral_ad_science client secret.
* - Service `ironclad`: Your Ironclad client secret.
* - Service `jama_software`: Your Jama Software client secret.
* - Service `jibble`: Your Jibble client secret.
* - Service `learn_amp`: Your Learn Amp client secret.
* - Service `looker_source`: Your Looker Client Secret.
* - Service `marketo`: Marketo REST API Client Secret.
* - Service `medallia`: Medallia Client Secret key
* - Service `microsoft_entra_id`: Your Microsoft Entra ID Client Secret.
* - Service `microsoft_power_bi`: Your Microsoft Power BI client secret.
* - Service `microsoft_teams`: Your Microsoft Teams client secret.
* - Service `navan`: Your Navan client secret.
* - Service `nice`: Your NICE client secret.
* - Service `onetrust`: Your OneTrust client secret.
* - Service `oracle_fusion_field_service`: Your Oracle Fusion Field Service client secret.
* - Service `oracle_netsuite_openair`: Your NetSuite SuiteProjects Pro client secret.
* - Service `paychex`: Your Paychex client secret.
* - Service `paylocity`: Your Paylocity client secret.
* - Service `personio`: Your Personio secret.
* - Service `piwik_pro`: Your Piwik PRO client secret.
* - Service `podio`: Your Podio client secret.
* - Service `power_reviews_enterprise`: Your PowerReviews Enterprise Client Secret.
* - Service `prisma_cloud`: Your Prisma Cloud secret access Key.
* - Service `procore`: Your Procore client secret.
* - Service `quickbooks`: Client Secret of your QuickBooks client application.
* - Service `quora_ads`: Your Quora Ads client secret.
* - Service `reltio`: Your Reltio client secret.
* - Service `salesforce_commerce_cloud`: The Salesforce Commerce Cloud Client secret.
* - Service `salesforce_marketing_cloud`: The Salesforce Marketing Cloud client secret.
* - Service `salesloft`: `Client Secret` of your Salesloft client application.
* - Service `sana`: Your Sana client secret.
* - Service `sap_success_factors`: Your SAP SuccessFactors Client Secret that you generated through SAML Assertion.
* - Service `servicenow`: ServiceNow Client Secret.
* - Service `servicetitan`: Your ServiceTitan secret key.
* - Service `sharetribe`: Your Sharetribe client secret.
* - Service `shopify`: Client secret of your public app
* - Service `showpad`: Your Showpad client secret.
* - Service `siemens_building_x_openness`: Your Siemens Building X Openness client secret.
* - Service `sigma_computing_source`: Your Sigma Computing client secret.
* - Service `skillstx`: Your SkillsTX client secret.
* - Service `skimlinks`: Your Skimlinks client secret.
* - Service `slack_app`: Your Slack app Client Secret.
* - Service `smartrecruiters`: Your SmartRecruiters client secret.
* - Service `splash`: Your Splash client secret.
* - Service `square`: The Application Secret of your organization.
* - Service `standard_metrics`: Your Standard Metrics Client secret.
* - Service `sugarcrm`: Your SugarCRM client secret.
* - Service `swoogo`: Your Swoogo Client Secret.
* - Service `taboola`: The Taboola client secret.
* - Service `talkdesk`: The Client Secret of your OAuth Client
* - Service `thinkific`: Your Thinkific client secret.
* - Service `tive`: Your Tive client secret.
* - Service `toast`: Your Toast client secret.
* - Service `trelica`: Your Trelica client secret.
* - Service `tremendous`: Your Tremendous client secret.
* - Service `tymeshift`: Your Tymeshift password.
* - Service `udemy_business`: Your Udemy Business client secret.
* - Service `ukg_pro_workforce_management`: Your UKG Pro Workforce Management client secret.
* - Service `vimeo`: Your Vimeo client secret.
* - Service `visma`: Your Visma client secret.
* - Service `vonage_contact_center`: Your Vonage Contact Center client secret.
* - Service `walmart_marketplace`: Your Walmart Marketplace client secret.
* - Service `xero`: your clientSecret
* - Service `xray`: Your Xray Client Secret.
* - Service `yahoo_display_ads_on_yahoo_japan`: Your Yahoo Display Ads on Yahoo Japan client secret.
* - Service `zendesk_chat`: Your Zendesk client secret.
* - Service `zoho_books`: Your Zoho Books Client Secret.
* - Service `zoho_campaigns`: Your Zoho Campaigns Client Secret.
* - Service `zoho_desk`: Your Zoho Desk Client secret.
* - Service `zoho_inventory`: Your Zoho Inventory client secret.
* - Service `zoho_recruit`: Your Zoho Recruit client secret.
* - Service `zuora`: Zuora Client Secret.
* - Service `zuora_sandbox`: Zuora Client Secret.
*/
clientSecret: string;
/**
* Field usage depends on `service` value:
* - Service `braze`: Cloud storage type Braze Current is connected to.
*/
cloudStorageType: string;
/**
* Field usage depends on `service` value:
* - Service `rarible`: Your Rarible Collection Address.
*/
collectionAddress: string;
/**
* Field usage depends on `service` value:
* - Service `double_click_publishers`: Columns provide all trafficking statistics and revenue information available for the chosen Dimensions.
*/
columns: string[];
/**
* Field usage depends on `service` value:
* - Service `alida`: Your Alida community API key name.
*/
communityApiKeyName: string;
/**
* Field usage depends on `service` value:
* - Service `khoros_communities`: Your Khoros Communities community domain.
*/
communityDomain: string;
/**
* Field usage depends on `service` value:
* - Service `khoros_communities`: Your Khoros Communities community ID.
*/
communityId: string;
/**
* Field usage depends on `service` value:
* - Service `business_central`: List of companies to sync
*/
companies: string[];
/**
* Field usage depends on `service` value:
* - Service `ordway`: Your Ordway company name.
*/
company: string;
/**
* Field usage depends on `service` value:
* - Service `360learning`: Your 360Learning company ID.
* - Service `cube`: Your Cube company ID.
* - Service `cube_software`: Your Cube company ID.
* - Service `oracle_netsuite_openair`: Your NetSuite SuiteProjects Pro company ID.
* - Service `paylocity`: Your Paylocity company ID.
* - Service `sage_intacct`: Company ID
* - Service `sap_success_factors`: Your SAP SuccessFactors Company ID.
*/
companyId: string;
/**
* Field usage depends on `service` value:
* - Service `cj_commission_detail`: Your CJ Commission Detail company IDs.
*/
companyIds: string;
/**
* Field usage depends on `service` value:
* - Service `khoros_care`: Your Khoros Care companyKey.
* - Service `upland`: Your Upland Software company key.
*/
companyKey: string;
/**
* Field usage depends on `service` value:
* - Service `clockodo`: Your Clockodo company name.
*/
companyName: string;
/**
* Field usage depends on `service` value:
* - Service `concur`: The SAP Concur Company Request Token
*/
companyRequestToken: string;
/**
* Field usage depends on `service` value:
* - Service `concur`: The SAP Concur Company UUID
*/
companyUuid: string;
/**
* Field usage depends on `service` value:
* - Service `aws_cost_report`: If your files are compressed, but do not have extensions indicating the compression method, you can force them to be uncompressed according to the selected compression algorithm. Leave the value as infer if your files are saved with the correct compression extensions.
* - Service `azure_blob_storage`: The secrets that should be passed to the function at runtime.
* - Service `box`: The compression format is used to let Fivetran know that even files without a compression extension should be decompressed using the selected compression format.
* - Service `dropbox`: The compression format is used to let Fivetran know that even files without a compression extension should be decompressed using the selected compression format.
* - Service `email`: The secrets that should be passed to the function at runtime.
* - Service `ftp`: The secrets that should be passed to the function at runtime.
* - Service `gcs`: The secrets that should be passed to the function at runtime.
* - Service `google_drive`: The compression format is used to let Fivetran know that even files without a compression extension should be decompressed using the selected compression format.
* - Service `kinesis`: If your files are compressed, but do not have extensions indicating the compression method, you can force them to be uncompressed according to the selected compression algorithm. Leave the value as infer if your files are saved with the correct compression extensions.
* - Service `s3`: The compression format is used to let Fivetran know that even files without a compression extension should be decompressed using the selected compression format.
* - Service `s3_compatible_storage`: The compression format is used to let Fivetran know that even files without a compression extension should be decompressed using the selected compression format.
* - Service `sftp`: The secrets that should be passed to the function at runtime.
* - Service `share_point`: The compression format is used to let Fivetran know that even files without a compression extension should be decompressed using the selected compression format.
* - Service `wasabi_cloud_storage`: The compression format is used to let Fivetran know that even files without a compression extension should be decompressed using the selected compression format.
*/
compression: string;
/**
* Field usage depends on `service` value:
* - Service `google_display_and_video_360`: The report configuration method. Specifies whether a new configuration is defined manually or an existing configuration is reused. The default value is `CREATE_NEW`.
*/
configMethod: string;
/**
* Field usage depends on `service` value:
* - Service `snowplow`: Public repository URL containing JSON configuration files.
*/
configRepositoryUrl: string;
/**
* Field usage depends on `service` value:
* - Service `facebook`: Option to select Prebuilt Reports or Custom Reports. [Possible config_type values](https://fivetran.com/docs/applications/facebook-ad-insights/api-config#configtype).
* - Service `google_analytics`: Whether to use the [Prebuilt Reports or Custom Reports](https://fivetran.com/docs/connectors/applications/google-analytics#schemainformation).
*/
configType: string;
/**
* Field usage depends on `service` value:
* - Service `xactly`: Your Xactly Connect password.
*/
connectPassword: string;
/**
* Field usage depends on `service` value:
* - Service `xactly`: Your Xactly Connect username.
*/
connectUsername: string;
connectingUser: string;
connectingUserEmail: string;
/**
* Field usage depends on `service` value:
* - Service `aws_msk`: How Fivetran connects to your message brokers in the cluster
* - Service `azure_blob_storage`: Connection Method. Possible values: `DIRECT`: Fivetran will connect directly to your storage container, `SSH_TUNNEL`: Fivetran will connect to your storage container using a host machine (commonly used for VPN connections), `PRIVATE_LINK`: Fivetran will connect to your storage container using PrivateLink.
* - Service `azure_function`: Connection Method. Possible values: `DIRECT`: Fivetran will connect directly to your function, `PRIVATE_LINK`: Fivetran will connect to your storage container using PrivateLink.
* - Service `azure_service_bus`: The connection method
* - Service `sftp`: The connection method used to connect to SFTP Server.
*/
connectionMethod: string;
/**
* Field usage depends on `service` value:
* - Service `appsflyer`: Your Data Locker Connection Name. Default value: `data-locker-hourly/
*/
connectionName: string;
/**
* Field usage depends on `service` value:
* - Service `azure_blob_storage`: The blob storage container connection string.
* - Service `azure_event_hub`: Connection string of the Event Hub Namespace you want to sync.
* - Service `azure_service_bus`: The connection string used for authentication. Required if the authentication type is `ConnectionString`
* - Service `microsoft_dynamics_365_fno`: The blob storage container's connection string.
* - Service `microsoft_dynamics_365_fo`: The blob storage container connection string.
* - Service `sql_server`: The Azure Blob Storage container connection string.
*/
connectionString: string;
/**
* Field usage depends on `service` value:
* - Service `aurora`: Possible values:`Directly`, `PrivateLink`, `SshTunnel`. `SshTunnel` is used as a value if this parameter is omitted in the request and any of the following parameter's values is specified: `tunnel_host`, `tunnel_port`, `tunnel_user`. Otherwise, `Directly` is used as a value if the parameter is omitted.
* - Service `aurora_postgres`: Possible values:`Directly`, `PrivateLink`, `SshTunnel`. `SshTunnel` is used as a value if this parameter is omitted in the request and any of the following parameter's values is specified: `tunnel_host`, `tunnel_port`, `tunnel_user`. Otherwise, `Directly` is used as a value if the parameter is omitted.
* - Service `aveva_pi`: Possible values: `Directly`, `PrivateLink`
* - Service `aws_cost_report`: Connection method. Default value: `Directly`.
* - Service `aws_lambda`: Connection method. Default value: `Directly`.
* - Service `azure_blob_storage`: Connection method. Default value: `Directly`.
* - Service `azure_cosmos_for_mongo`: Possible values:`Directly`, `PrivateLink`. `Directly` is the default value
* - Service `azure_postgres`: Possible values:`Directly`, `PrivateLink`, `SshTunnel`. `SshTunnel` is used as a value if this parameter is omitted in the request and any of the following parameter's values is specified: `tunnel_host`, `tunnel_port`, `tunnel_user`. Otherwise, `Directly` is used as a value if the parameter is omitted.
* - Service `azure_sql_db`: Possible values: `Directly`, `PrivateLink`, `SshTunnel`. `SshTunnel` is used as a value if this parameter is omitted in the request and any of the following parameter's values is specified: `tunnel_host`, `tunnel_port`, `tunnel_user`. Otherwise, `Directly` is used as a value if the parameter is omitted.
* - Service `azure_sql_managed_db`: Possible values: `Directly`, `PrivateLink`, `SshTunnel`. `SshTunnel` is used as a value if this parameter is omitted in the request and any of the following parameter's values is specified: `tunnel_host`, `tunnel_port`, `tunnel_user`. Otherwise, `Directly` is used as a value if the parameter is omitted.
* - Service `bigquery_db`: Direct or PrivateLink connection
* - Service `clarity`: Possible values: `Directly`, `PrivateLink`, `SshTunnel`. `SshTunnel` is used as a value if this parameter is omitted in the request and any of the following parameter's values is specified: `tunnel_host`, `tunnel_port`, `tunnel_user`. Otherwise, `Directly` is used as a value if the parameter is omitted.
* - Service `cockroachdb`: Possible values:`Directly`, `SshTunnel`. `SshTunnel` is used as a value if this parameter is omitted in the request and any of the following parameter's values is specified: `tunnel_host`, `tunnel_port`, `tunnel_user`. Otherwise, `Directly` is used as a value if the parameter is omitted.
* - Service `db2i_hva`: Possible values:`SshTunnel`. `SshTunnel` is used as a value if this parameter is omitted in the request and the following parameter's values are specified: `tunnel_host`, `tunnel_port`, `tunnel_user`.
* - Service `db2i_sap_hva`: Possible values:`SshTunnel`. `SshTunnel` is used as a value if this parameter is omitted in the request and any of the following parameter's values is specified: `tunnel_host`, `tunnel_port`, `tunnel_user`.
* - Service `db2luw`: Possible values:`SshTunnel`. `SshTunnel` is used as a value if this parameter is omitted in the request and the following parameter's values are specified: `tunnel_host`, `tunnel_port`, `tunnel_user`.
* - Service `db2z`: Possible values: `Directly`, `SshTunnel`. `SshTunnel` is used as a value if this parameter is omitted in the request and any of the following parameter's values is specified: `tunnel_host`, `tunnel_port`, `tunnel_user`. Otherwise, `Directly` is used as a value if the parameter is omitted.
* - Service `documentdb`: Possible values:`SshTunnel`, `PrivateLink` . `SshTunnel` is used as a value if this parameter is omitted in the request and the following parameter's values are specified: `tunnel_host`, `tunnel_port`, `tunnel_user`.
* - Service `dynamics_365_fo`: Possible values: `Directly`, `PrivateLink`, `SshTunnel`. `SshTunnel` is used as a value if this parameter is omitted in the request and any of the following parameter's values is specified: `tunnel_host`, `tunnel_port`, `tunnel_user`. Otherwise, `Directly` is used as a value if the parameter is omitted.
* - Service `ehr`: Possible values: `Directly`, `PrivateLink`, `SshTunnel`. `SshTunnel` is used as a value if this parameter is omitted in the request and any of the following parameter's values is specified: `tunnel_host`, `tunnel_port`, `tunnel_user`. Otherwise, `Directly` is used as a value if the parameter is omitted.
* - Service `elastic_cloud`: Possible values:`Directly`, `SshTunnel`. `SshTunnel` is used as a value if this parameter is omitted in the request and any of the following parameter's values is specified: `tunnel_host`, `tunnel_port`, `tunnel_user`. Otherwise, `Directly` is used as a value if the parameter is omitted.
* - Service `email`: Connection method. Default value: `Directly`.
* - Service `epic_clarity`: Possible values: `Directly`, `PrivateLink`, `SshTunnel`. `SshTunnel` is used as a value if this parameter is omitted in the request and any of the following parameter's values is specified: `tunnel_host`, `tunnel_port`, `tunnel_user`. Otherwise, `Directly` is used as a value if the parameter is omitted.
* - Service `es_self_hosted`: Possible values:`Directly`, `SshTunnel`. `SshTunnel` is used as a value if this parameter is omitted in the request and any of the following parameter's values is specified: `tunnel_host`, `tunnel_port`, `tunnel_user`. Otherwise, `Directly` is used as a value if the parameter is omitted.
* - Service `google_cloud_mysql`: Possible values:`Directly`, `PrivateLink`, `SshTunnel`. `SshTunnel` is used as a value if this parameter is omitted in the request and any of the following parameter's values is specified: `tunnel_host`, `tunnel_port`, `tunnel_user`. Otherwise, `Directly` is used as a value if the parameter is omitted.
* - Service `google_cloud_postgresql`: Possible values:`Directly`, `PrivateLink`, `SshTunnel`. `SshTunnel` is used as a value if this parameter is omitted in the request and any of the following parameter's values is specified: `tunnel_host`, `tunnel_port`, `tunnel_user`. Otherwise, `Directly` is used as a value if the parameter is omitted.
* - Service `google_cloud_sqlserver`: Possible values: `Directly`, `PrivateLink`, `SshTunnel`. `SshTunnel` is used as a value if this parameter is omitted in the request and any of the following parameter's values is specified: `tunnel_host`, `tunnel_port`, `tunnel_user`. Otherwise, `Directly` is used as a value if the parameter is omitted.
* - Service `hana_sap_hva_b1`: Possible values: `Directly`, `PrivateLink`, `SshTunnel`. `SshTunnel` is used as a value if this parameter is omitted in the request and any of the following parameter's values is specified: `tunnel_host`, `tunnel_port`, `tunnel_user`. Otherwise, `Directly` is used as a value if the parameter is omitted.
* - Service `hana_sap_hva_ecc`: Possible values: `Directly`, `PrivateLink`, `SshTunnel`. `SshTunnel` is used as a value if this parameter is omitted in the request and any of the following parameter's values is specified: `tunnel_host`, `tunnel_port`, `tunnel_user`. Otherwise, `Directly` is used as a value if the parameter is omitted.
* - Service `hana_sap_hva_ecc_netweaver`: Possible values: `Directly`, `PrivateLink`, `SshTunnel`. `SshTunnel` is used as a value if this parameter is omitted in the request and any of the following parameter's values is specified: `tunnel_host`, `tunnel_port`, `tunnel_user`. Otherwise, `Directly` is used as a value if the parameter is omitted.
* - Service `hana_sap_hva_s4`: Possible values: `Directly`, `PrivateLink`, `SshTunnel`. `SshTunnel` is used as a value if this parameter is omitted in the request and any of the following parameter's values is specified: `tunnel_host`, `tunnel_port`, `tunnel_user`. Otherwise, `Directly` is used as a value if the parameter is omitted.
* - Service `hana_sap_hva_s4_netweaver`: Possible values: `Directly`, `PrivateLink`, `SshTunnel`. `SshTunnel` is used as a value if this parameter is omitted in the request and any of the following parameter's values is specified: `tunnel_host`, `tunnel_port`, `tunnel_user`. Otherwise, `Directly` is used as a value if the parameter is omitted.
* - Service `heroku_postgres`: Possible values:`Directly`, `PrivateLink`, `SshTunnel`. `SshTunnel` is used as a value if this parameter is omitted in the request and any of the following parameter's values is specified: `tunnel_host`, `tunnel_port`, `tunnel_user`. Otherwise, `Directly` is used as a value if the parameter is omitted.
* - Service `kinesis`: Connection method. Default value: `Directly`.
* - Service `magento_mysql`: Possible values:`Directly`, `PrivateLink`, `SshTunnel`. `SshTunnel` is used as a value if this parameter is omitted in the request and any of the following parameter's values is specified: `tunnel_host`, `tunnel_port`, `tunnel_user`. Otherwise, `Directly` is used as a value if the parameter is omitted.
* - Service `magento_mysql_rds`: Possible values:`Directly`, `PrivateLink`, `SshTunnel`. `SshTunnel` is used as a value if this parameter is omitted in the request and any of the following parameter's values is specified: `tunnel_host`, `tunnel_port`, `tunnel_user`. Otherwise, `Directly` is used as a value if the parameter is omitted.
* - Service `maria`: Possible values:`Directly`, `PrivateLink`, `SshTunnel`. `SshTunnel` is used as a value if this parameter is omitted in the request and any of the following parameter's values is specified: `tunnel_host`, `tunnel_port`, `tunnel_user`. Otherwise, `Directly` is used as a value if the parameter is omitted.
* - Service `maria_azure`: Possible values:`Directly`, `PrivateLink`, `SshTunnel`. `SshTunnel` is used as a value if this parameter is omitted in the request and any of the following parameter's values is specified: `tunnel_host`, `tunnel_port`, `tunnel_user`. Otherwise, `Directly` is used as a value if the parameter is omitted.
* - Service `maria_rds`: Possible values:`Directly`, `PrivateLink`, `SshTunnel`. `SshTunnel` is used as a value if this parameter is omitted in the request and any of the following parameter's values is specified: `tunnel_host`, `tunnel_port`, `tunnel_user`. Otherwise, `Directly` is used as a value if the parameter is omitted.
* - Service `mongo`: Possible values:`Directly`, `PrivateLink`, `SshTunnel`. `SshTunnel` is used as a value if this parameter is omitted in the request and any of the following parameter's values is specified: `tunnel_host`, `tunnel_port`, `tunnel_user`. Otherwise, `Directly` is used as a value if the parameter is omitted.
* - Service `mongo_sharded`: Possible values:`Directly`, `PrivateLink`, `SshTunnel`. `SshTunnel` is used as a value if this parameter is omitted in the request and any of the following parameter's values is specified: `tunnel_host`, `tunnel_port`, `tunnel_user`. Otherwise, `Directly` is used as a value if the parameter is omitted.
* - Service `mysql`: Possible values:`Directly`, `PrivateLink`, `SshTunnel`. `SshTunnel` is used as a value if this parameter is omitted in the request and any of the following parameter's values is specified: `tunnel_host`, `tunnel_port`, `tunnel_user`. Otherwise, `Directly` is used as a value if the parameter is omitted.
* - Service `mysql_azure`: Possible values:`Directly`, `PrivateLink`, `SshTunnel`. `SshTunnel` is used as a value if this parameter is omitted in the request and any of the following parameter's values is specified: `tunnel_host`, `tunnel_port`, `tunnel_user`. Otherwise, `Directly` is used as a value if the parameter is omitted.
* - Service `mysql_rds`: Possible values:`Directly`, `PrivateLink`, `SshTunnel`. `SshTunnel` is used as a value if this parameter is omitted in the request and any of the following parameter's values is specified: `tunnel_host`, `tunnel_port`, `tunnel_user`. Otherwise, `Directly` is used as a value if the parameter is omitted.
* - Service `opendistro`: Possible values:`Directly`, `SshTunnel`. `SshTunnel` is used as a value if this parameter is omitted in the request and any of the following parameter's values is specified: `tunnel_host`, `tunnel_port`, `tunnel_user`. Otherwise, `Directly` is used as a value if the parameter is omitted.
* - Service `opensearch`: Possible values:`Directly`, `SshTunnel`. `SshTunnel` is used as a value if this parameter is omitted in the request and any of the following parameter's values is specified: `tunnel_host`, `tunnel_port`, `tunnel_user`. Otherwise, `Directly` is used as a value if the parameter is omitted.
* - Service `oracle`: Possible values:`Directly`, `PrivateLink`, `SshTunnel`. `SshTunnel` is used as a value if this parameter is omitted in the request and any of the following parameter's values is specified: `tunnel_host`, `tunnel_port`, `tunnel_user`. Otherwise, `Directly` is used as a value if the parameter is omitted.
* - Service `oracle_ebs`: Possible values:`Directly`, `PrivateLink`, `SshTunnel`. `SshTunnel` is used as a value if this parameter is omitted in the request and any of the following parameter's values is specified: `tunnel_host`, `tunnel_port`, `tunnel_user`. Otherwise, `Directly` is used as a value if the parameter is omitted.
* - Service `oracle_hva`: Possible values:`Directly`, `PrivateLink`, `SshTunnel`. `SshTunnel` is used as a value if this parameter is omitted in the request and any of the following parameter's values is specified: `tunnel_host`, `tunnel_port`, `tunnel_user`. Otherwise, `Directly` is used as a value if the parameter is omitted.
* - Service `oracle_rac`: Possible values:`Directly`, `PrivateLink`, `SshTunnel`. `SshTunnel` is used as a value if this parameter is omitted in the request and any of the following parameter's values is specified: `tunnel_host`, `tunnel_port`, `tunnel_user`. Otherwise, `Directly` is used as a value if the parameter is omitted.
* - Service `oracle_rds`: Possible values:`Directly`, `PrivateLink`, `SshTunnel`. `SshTunnel` is used as a value if this parameter is omitted in the request and any of the following parameter's values is specified: `tunnel_host`, `tunnel_port`, `tunnel_user`. Otherwise, `Directly` is used as a value if the parameter is omitted.
* - Service `oracle_sap_hva`: Possible values: `Directly`, `PrivateLink`, `SshTunnel`. `SshTunnel` is used as a value if this parameter is omitted in the request and any of the following parameter's values is specified: `tunnel_host`, `tunnel_port`, `tunnel_user`. Otherwise, `Directly` is used as a value if the parameter is omitted.
* - Service `oracle_sap_hva_netweaver`: Possible values: `Directly`, `PrivateLink`, `SshTunnel`. `SshTunnel` is used as a value if this parameter is omitted in the request and any of the following parameter's values is specified: `tunnel_host`, `tunnel_port`, `tunnel_user`. Otherwise, `Directly` is used as a value if the parameter is omitted.
* - Service `postgres`: Possible values:`Directly`, `PrivateLink`, `SshTunnel`. `SshTunnel` is used as a value if this parameter is omitted in the request and any of the following parameter's values is specified: `tunnel_host`, `tunnel_port`, `tunnel_user`. Otherwise, `Directly` is used as a value if the parameter is omitted.
* - Service `postgres_rds`: Possible values:`Directly`, `PrivateLink`, `SshTunnel`. `SshTunnel` is used as a value if this parameter is omitted in the request and any of the following parameter's values is specified: `tunnel_host`, `tunnel_port`, `tunnel_user`. Otherwise, `Directly` is used as a value if the parameter is omitted.
* - Service `redshift_db`: Directly or Private Link
* - Service `s3`: Connection method. Default value: `Directly`.
* - Service `sap_hana`: Possible values:`Directly`, `PrivateLink`, `SshTunnel`. `SshTunnel` is used as a value if this parameter is omitted in the request and any of the following parameter's values is specified: `tunnel_host`, `tunnel_port`, `tunnel_user`. Otherwise, `Directly` is used as a value if the parameter is omitted.
* - Service `sap_s4hana`: Connection Method
* - Service `snowflake_db`: Directly or Private Link
* - Service `sql_server`: Possible values: `Directly`, `PrivateLink`, `SshTunnel`. `SshTunnel` is used as a value if this parameter is omitted in the request and any of the following parameter's values is specified: `tunnel_host`, `tunnel_port`, `tunnel_user`. Otherwise, `Directly` is used as a value if the parameter is omitted.
* - Service `sql_server_hva`: Possible values: `Directly`, `PrivateLink`, `SshTunnel`. `SshTunnel` is used as a value if this parameter is omitted in the request and any of the following parameter's values is specified: `tunnel_host`, `tunnel_port`, `tunnel_user`. Otherwise, `Directly` is used as a value if the parameter is omitted.
* - Service `sql_server_rds`: Possible values: `Directly`, `PrivateLink`, `SshTunnel`. `SshTunnel` is used as a value if this parameter is omitted in the request and any of the following parameter's values is specified: `tunnel_host`, `tunnel_port`, `tunnel_user`. Otherwise, `Directly` is used as a value if the parameter is omitted.
* - Service `sql_server_sap_ecc_hva`: Possible values: `Directly`, `PrivateLink`, `SshTunnel`. `SshTunnel` is used as a value if this parameter is omitted in the request and any of the following parameter's values is specified: `tunnel_host`, `tunnel_port`, `tunnel_user`. Otherwise, `Directly` is used as a value if the parameter is omitted.
*/
connectionType: string;
/**
* Field usage depends on `service` value:
* - Service `prisma_cloud`: Your Prisma Cloud console URL.
*/
consoleUrl: string;
/**
* Field usage depends on `service` value:
* - Service `apache_kafka`: Kafka consumer group name.
* - Service `aws_msk`: The name of consumer group created for Fivetran.
* - Service `azure_event_hub`: Name of consumer group created for Fivetran.
* - Service `confluent_cloud`: Confluent Cloud consumer group name.
* - Service `heroku_kafka`: Heroku Kafka consumer group name.
*/
consumerGroup: string;
/**
* Field usage depends on `service` value:
* - Service `netsuite_suiteanalytics`: Consumer Key
* - Service `odoo`: Your Odoo consumer key.
* - Service `twitter`: API Key of your app
* - Service `twitter_ads`: The Twitter App consumer key.
* - Service `woocommerce`: Your WooCommerce Consumer key.
*/
consumerKey: string;
/**
* Field usage depends on `service` value:
* - Service `xactly`: Your Xactly Connect consumer name.
*/
consumerName: string;
/**
* Field usage depends on `service` value:
* - Service `netsuite_suiteanalytics`: Consumer Secret
* - Service `odoo`: Your Odoo consumer secret.
* - Service `twitter`: API Secret of your app
* - Service `twitter_ads`: The Twitter App consumer secret.
* - Service `woocommerce`: Your WooCommerce Consumer secret.
*/
consumerSecret: string;
/**
* Field usage depends on `service` value:
* - Service `azure_blob_storage`: IP address of the Azure Storage Container which is accessible from host machine.
*/
containerAddress: string;
/**
* Field usage depends on `service` value:
* - Service `azure_blob_storage`: The name of the blob container.
* - Service `microsoft_dynamics_365_fno`: The name of the blob container.
* - Service `microsoft_dynamics_365_fo`: The name of the blob container.
* - Service `sql_server`: The name of the Azure Blob Storage container.
*/
containerName: string;
/**
* Field usage depends on `service` value:
* - Service `youtube_analytics`: Used only for Content Owner reports. The ID of the content owner for whom the API request is being made.
*/
contentOwnerId: string;
/**
* Field usage depends on `service` value:
* - Service `acumatica`: Your Acumatica contract version.
*/
contractVersion: string;
/**
* Field usage depends on `service` value:
* - Service `helpscout`: Your conversation webhook URL
*/
conversationWebhookUrl: string;
/**
* Field usage depends on `service` value:
* - Service `double_click_campaign_manager`: Conversion Dimensions.
*/
conversionDimensions: string[];
/**
* Field usage depends on `service` value:
* - Service `pinterest_ads`: The date that the user interacted with the ad OR completed a conversion event.
*/
conversionReportTime: string;
/**
* Field usage depends on `service` value:
* - Service `google_ads`: A period of time in days during which a conversion is recorded.
*/
conversionWindowSize: number;
convertDatsTypeToDate: boolean;
/**
* Field usage depends on `service` value:
* - Service `sistrix`: Your SISTRIX country code.
*/
country: string;
/**
* Field usage depends on `service` value:
* - Service `adjust`: CSV definition for the CSV export (https://help.adjust.com/en/article/csv-uploads#how-do-i-format-my-csv-definition).
*/
csvDefinition: string;
/**
* Field usage depends on `service` value:
* - Service `criteo`: Currency
* - Service `rokt`: Your Rokt currency.
*/
currency: string;
/**
* Field usage depends on `service` value:
* - Service `coalesce`: Your Coalesce custom base URL.
* - Service `datadog`: Your Datadog custom base url.
* - Service `deposco`: Your Deposco custom base URL.
* - Service `gitlab`: Your GitLab custom base URL.
*/
customBaseUrl: string;
/**
* Field usage depends on `service` value:
* - Service `double_click_publishers`: The list of custom dimension key IDs included in the report. Custom dimension keys can only be selected with the CUSTOM_DIMENSION dimension.
*/
customDimensionKeyIds: string[];
/**
* Field usage depends on `service` value:
* - Service `iterable`: Custom Events Sync Mode.
*/
customEventSyncMode: string;
/**
* Field usage depends on `service` value:
* - Service `iterable`: List of custom events to sync. Should be specified when `custom_event_sync_mode` is `SelectedEvents`
*/
customEvents: string[];
/**
* Field usage depends on `service` value:
* - Service `double_click_publishers`: The list of custom field IDs included in the report. Custom fields can only be selected with their corresponding dimensions.
*/
customFieldIds: string[];
/**
* Field usage depends on `service` value:
* - Service `double_click_campaign_manager`: Custom Floodlight variables enable you to capture information beyond the basics (visits and revenue) that you can collect with standard parameters in your tags.
*/
customFloodlightVariables: string[];
/**
* Field usage depends on `service` value:
* - Service `aws_lambda`: The list of key-value pairs that can be used to specify custom information to the function at runtime.
* - Service `azure_function`: The list of key-value pairs that can be used to specify custom information to the function at runtime.
* - Service `google_cloud_function`: The list of key-value pairs that can be used to specify custom information to the function at runtime.
*/
customPayloads: outputs.GetConnectorConfigCustomPayload[];
/**
* Field usage depends on `service` value:
* - Service `toggl_track`: Your Toggl Track custom rate limit. Supports only numeric characters (0-9).
*/
customRateLimit: string;
/**
* Field usage depends on `service` value:
* - Service `learnupon`: Your LearnUpon custom region.
*/
customRegion: string;
/**
* Field usage depends on `service` value:
* - Service `reddit_ads`: The list of custom report configurations. Each report corresponds to a table within the schema to which connector will sync the data.
* - Service `snapchat_ads`: [Custom reports for Snapchat Ads connector](https://fivetran.com/docs/connectors/applications/snapchat-ads/custom-reports).
* - Service `tiktok_ads`: Title of Custom Report
*/
customReports: outputs.GetConnectorConfigCustomReport[];
/**
* Field usage depends on `service` value:
* - Service `facebook_ads`: List of custom tables. Each custom table corresponds to a table within the schema to which connector will sync the data.
*/
customTables: outputs.GetConnectorConfigCustomTable[];
/**
* Field usage depends on `service` value:
* - Service `dbt_cloud`: Your dbt Cloud access url.
* - Service `factbird`: Your Factbird custom base url.
* - Service `jotform`: Your Jotform custom base URL.
*/
customUrl: string;
/**
* Field usage depends on `service` value:
* - Service `ukg_pro`: Your UKG Pro Customer API key.
*/
customerApiKey: string;
/**
* Field usage depends on `service` value:
* - Service `google_ads`: ID of the customer, can be retrieved from your AdWords dashboard.
*/
customerId: string;
/**
* Field usage depends on `service` value:
* - Service `salesforce_commerce_cloud`: The parameter to retrieve customer details.
*/
customerListId: string;
dailyApiCallLimit: number;
/**
* Field usage depends on `service` value:
* - Service `cosmos`: The source data access method. Supported values:`ACCOUNT_KEY`- Data access method that uses account keys to authenticate to the source database. It comes in both read-write and read-only variants.`RESOURCE_TOKEN`- Fine-grained permission model based on native Azure Cosmos DB users and permissions. Learn more in our [Azure Cosmos DB Data Access Methods documentation](https://fivetran.com/docs/connectors/databases/cosmos#dataaccessmethods).
*/
dataAccessMethod: string;
/**
* Field usage depends on `service` value:
* - Service `brightpearl`: Your Brightpearl data center.
* - Service `qualtrics`: Data center ID of the Qualtrics account. Can be found in the URL before `qualtrics.com`. (For example, if your URL is `youraccount.ca1.qualtrics.com`, then the data center is `ca1`.)
* - Service `zoho_crm`: Data Center, depending on the Domain name
*/
dataCenter: string;
/**
* Field usage depends on `service` value:
* - Service `zonka_feedback`: Your Zonka Feedback data center ID.
*/
dataCenterId: string;
/**
* Field usage depends on `service` value:
* - Service `oracle_business_intelligence_publisher`: Data Model Paths (Optional)
*/
dataModelPathAliasLists: outputs.GetConnectorConfigDataModelPathAliasList[];
/**
* Field usage depends on `service` value:
* - Service `intercom`: The Intercom region for your app. Options - empty string (US/default), 'eu' (Europe), 'au' (Australia). Based on your Intercom app URL (app.intercom.io for US, app.eu.intercom.io for EU, app.au.intercom.io for AU). Cannot be changed after initial connection creation.
*/
dataRegion: string;
/**
* Field usage depends on `service` value:
* - Service `bigquery_db`: Data set name
*/
dataSetName: string;
/**
* Field usage depends on `service` value:
* - Service `aurora`: The database name.
* - Service `aurora_postgres`: The database name.
* - Service `azure_cosmos_for_mongo`: Authentication database for the source. Usually 'admin'.
* - Service `azure_postgres`: The database name.
* - Service `azure_sql_db`: The database name.
* - Service `azure_sql_managed_db`: The database name.
* - Service `clarity`: The database name.
* - Service `cockroachdb`: The database name.
* - Service `db2i_hva`: The database name.
* - Service `db2i_sap_hva`: The database name.
* - Service `db2luw`: The database name.
* - Service `db2z`: The database name.
* - Service `dynamics_365_fo`: The database name.
* - Service `ehr`: The database name.
* - Service `epic_clarity`: The database name.
* - Service `google_cloud_mysql`: The database name.
* - Service `google_cloud_postgresql`: The database name.
* - Service `google_cloud_sqlserver`: The database name.
* - Service `hana_sap_hva_b1`: The Hana database name.
* - Service `hana_sap_hva_ecc`: The Hana database name.
* - Service `hana_sap_hva_ecc_netweaver`: The Hana database name.
* - Service `hana_sap_hva_s4`: The Hana database name.
* - Service `hana_sap_hva_s4_netweaver`: The Hana database name.
* - Service `heroku_postgres`: The database name.
* - Service `magento_mysql`: The database name.
* - Service `magento_mysql_rds`: The database name.
* - Service `maria`: The database name.
* - Service `maria_azure`: The database name.
* - Service `maria_rds`: The database name.
* - Service `mysql`: The database name.
* - Service `mysql_azure`: The database name.
* - Service `mysql_rds`: The database name.
* - Service `oracle`: The database name.
* - Service `oracle_ebs`: The database name.
* - Service `oracle_hva`: The database name.
* - Service `oracle_rac`: The database name.
* - Service `oracle_rds`: The database name.
* - Service `oracle_sap_hva`: The database name.
* - Service `postgres`: The database name.
* - Service `postgres_rds`: The database name.
* - Service `redshift_db`: The database name: Redshift
* - Service `sap_hana`: The database name.
* - Service `sap_s4hana`: The database name.
* - Service `snowflake_db`: The database name: Snowflake
* - Service `sql_server`: The database name.
* - Service `sql_server_hva`: The database name.
* - Service `sql_server_rds`: The database name.
* - Service `sql_server_sap_ecc_hva`: The database name.
*/
database: string;
/**
* Field usage depends on `service` value:
* - Service `firebase`: Database Name
*/
databaseName: string;
/**
* Field usage depends on `service` value:
* - Service `google_analytics_360`: The dataset ID.
* - Service `google_analytics_4_export`: The Dataset ID.
*/
datasetId: string;
/**
* Field usage depends on `service` value:
* - Service `netsuite_suiteanalytics`: The NetSuite data source value: `NetSuite.com`.
*/
datasource: string;
/**
* Field usage depends on `service` value:
* - Service `adobe_analytics`: The aggregation duration you want. Default value: `HOUR` .
*/
dateGranularity: string;
/**
* Field usage depends on `service` value:
* - Service `myosh`: Your Myosh Server variables/db .
*/
db: string;
/**
* Field usage depends on `service` value:
* - Service `discourse`: Your Discourse default host.
*/
defaultHost: string;
/**
* Field usage depends on `service` value:
* - Service `aws_cost_report`: Optional. You can specify your the delimiter that your CSVs use here. Fivetran generally tries to infer the delimiter, but in some cases this is impossible. If your files sync with the wrong number of columns, consider setting this value
* - Service `azure_blob_storage`: You can specify your the delimiter that your CSVs use here. Fivetran generally tries to infer the delimiter, but in some cases this is impossible.
* - Service `box`: You can specify the delimiter that your CSVs use here. Fivetran generally tries to infer the delimiter, but in some cases this is impossible.
* - Service `dropbox`: You can specify the delimiter that your CSVs use here. Fivetran generally tries to infer the delimiter, but in some cases this is impossible.
* - Service `email`: You can specify your the delimiter that your CSVs use here. Fivetran generally tries to infer the delimiter, but in some cases this is impossible.
* - Service `ftp`: You can specify your the delimiter that your CSVs use here. Fivetran generally tries to infer the delimiter, but in some cases this is impossible.
* - Service `gcs`: You can specify your the delimiter that your CSVs use here. Fivetran generally tries to infer the delimiter, but in some cases this is impossible.
* - Service `google_drive`: You can specify the delimiter that your CSVs use here. Fivetran generally tries to infer the delimiter, but in some cases this is impossible.
* - Service `kinesis`: Optional. You can specify your the delimiter that your CSVs use here. Fivetran generally tries to infer the delimiter, but in some cases this is impossible. If your files sync with the wrong number of columns, consider setting this value
* - Service `s3`: You can specify the delimiter that your CSVs use here. Fivetran generally tries to infer the delimiter, but in some cases this is impossible.
* - Service `s3_compatible_storage`: You can specify the delimiter that your CSVs use here. Fivetran generally tries to infer the delimiter, but in some cases this is impossible.
* - Service `sftp`: You can specify your the delimiter that your CSVs use here. Fivetran generally tries to infer the delimiter, but in some cases this is impossible.
* - Service `share_point`: You can specify the delimiter that your CSVs use here. Fivetran generally tries to infer the delimiter, but in some cases this is impossible.
* - Service `wasabi_cloud_storage`: You can specify the delimiter that your CSVs use here. Fivetran generally tries to infer the delimiter, but in some cases this is impossible.
*/
delimiter: string;
/**
* Field usage depends on `service` value:
* - Service `brightpearl`: Your Brightpearl dev reference.
*/
developerReference: string;
/**
* Field usage depends on `service` value:
* - Service `double_click_publishers`: Dimension attributes provide additional fields associated with a Dimension. Dimension attributes can only be selected with their corresponding Dimensions.
*/
dimensionAttributes: string[];
/**
* Field usage depends on `service` value:
* - Service `adroll`: The dimenstions that you want to sync.
* - Service `double_click_campaign_manager`: Report dimensions to include into a sync. The `date` dimension is mandatory for all the report types. The `advertiser` dimension is mandatory for `REACH` report type
* - Service `double_click_publishers`: Report dimensions to include in the sync. The `date` dimension is mandatory for all the report types.
* - Service `google_analytics`: The report dimensions to include into a sync. The `date` dimension is mandatory for all the report types.
* - Service `google_display_and_video_360`: The report dimensions (filters) to include into a sync. The dimension names are provided in the API format. This is a required parameter when `config_method` is set to `CREATE_NEW`.
*/
dimensions: string[];
/**
* Field usage depends on `service` value:
* - Service `oracle_hva`: Possible values:`DIRECT`, `BFILE`, `ASM`, `ARCHIVE_ONLY`
* - Service `oracle_sap_hva`: Possible values:`DIRECT`, `BFILE`, `ASM`, `ARCHIVE_ONLY`
*/
directCaptureMethod: string;
/**
* Field usage depends on `service` value:
* - Service `qualtrics`: Set of directories to be synced when syncMode is CUSTOM
*/
directories: string[];
/**
* Field usage depends on `service` value:
* - Service `qualtrics`: Sync mode to be used for fetching select directories. The Allowed Values are ALL and CUSTOM. If CUSTOM add the directories to be synced in the `directories` field.
*/
directorySyncMode: string;
/**
* Field usage depends on `service` value:
* - Service `cosmos`: Specifies the total number of connectors in the Distributed Connector Cluster running in parallel.
* - Service `dynamodb`: Specifies the total number of connectors in the Distributed Connector Cluster running in parallel.
*/
distributedConnectorClusterSize: number;
/**
* Field usage depends on `service` value:
* - Service `qualtrics`: Can be used to set the distributions fetch window for incremental sync. Fetch window cannot be lesser than 60 days.
*/
distributionIncrementalFetchWindowDays: number;
/**
* Field usage depends on `service` value:
* - Service `adobe_experience_platform`: Your Adobe Experience Platform environment.
* - Service `auth0`: Your Auth0 domain.
* - Service `bubble`: Your Bubble app name or domain name.
* - Service `confluence`: Your Confluence domain.
* - Service `kustomer`: Domain is the beginning of your kustomer URL going before .kustomerapp.com, e.g. for yourcompany.kustomerapp.com the domain name is yourcompany
* - Service `okta`: Your Okta domain.
* - Service `pipedrive`: Your Pipedrive domain.
* - Service `shopware`: Your Shopware domain.
* - Service `sistrix`: Your SISTRIX domain.
* - Service `solarwinds_service_desk`: Your SolarWinds Service Desk domain.
* - Service `uservoice`: Domain of your UserVoice site. If it ends with ".uservoice.com", you can specify just the subdomain ("mydomain.uservoice.com" - "mydomain")
* - Service `zendesk`: Zendesk domain.
* - Service `zendesk_sunshine`: Zendesk domain.
*/
domain: string;
/**
* Field usage depends on `service` value:
* - Service `workday`: Workday host name.
* - Service `workday_financial_management`: Workday host name.
* - Service `workday_hcm`: Workday host name.
*/
domainHostName: string;
/**
* Field usage depends on `service` value:
* - Service `calabrio`: Your Calabrio domain name
* - Service `dynamics_365`: The custom domain name associated with Dynamics 365.
* - Service `helpshift`: Your Helpshift domain name.
*/
domainName: string;
/**
* Field usage depends on `service` value:
* - Service `lightspeed_retail_xseries`: Your Lightspeed Retail X-Series store domain prefix.
*/
domainPrefix: string;
/**
* Field usage depends on `service` value:
* - Service `medallia`: Domain type of your Medallia URL
*/
domainType: string;
/**
* Field usage depends on `service` value:
* - Service `dsv`: Your DSV Password.
*/
dsvPassword: string;
dsvServiceAuth: string;
dsvSubscriptionKey: string;
/**
* Field usage depends on `service` value:
* - Service `dsv`: Your DSV Username
*/
dsvUsername: string;
/**
* Field usage depends on `service` value:
* - Service `mailchimp`: List of IDs of the Mailchimp E-Commerce Stores to Sync
*/
ecommerceStores: string[];
/**
* Field usage depends on `service` value:
* - Service `bigin_by_zoho_crm`: Your Bigin by Zoho CRM pricing plan
*/
edition: string;
/**
* Field usage depends on `service` value:
* - Service `oracle_fusion_cloud_apps_crm`: Select this option to extract all historical records without applying a date filter. Console allows setting this option for all datastores in the connector.
* - Service `oracle_fusion_cloud_apps_fscm`: Select this option to extract all historical records without applying a date filter. Console allows setting this option for all datastores in the connector.
* - Service `oracle_fusion_cloud_apps_hcm`: Select this option to extract all historical records without applying a date filter. Console allows setting this option for all datastores in the connector.
*/
effectiveDateDisabled: boolean;
/**
* Field usage depends on `service` value:
* - Service `sql_server`: The list of Azure Key Vault key identifiers used for TDE. Each identifier should be in the format `https://vault-name.vault.azure.net/keys/key-name` or `https://vault-name.vault.azure.net/keys/key-name/version`.
*/
ekmKeyIdentifiers: string[];
elements: string[];
/**
* Field usage depends on `service` value:
* - Service `appcues`: Your Appcues Email.
* - Service `asset_panda`: Your Asset Panda email.
* - Service `boostr`: Your Boostr email.
* - Service `consensus_demo_automation_platform`: The email address of the Consensus Demo Automation Platform account you want Fivetran to use to access your data.
* - Service `copper`: Your Copper email address.
* - Service `email`: Send your emails to this address.
* - Service `moloco`: Your Moloco account email.
* - Service `netsuite_suiteanalytics`: The NetSuite user's email address.
* - Service `pardot`: The email of the Pardot user.
* - Service `pardot_sandbox`: The email of the Pardot user.
* - Service `skuvault`: Your SkuVault email.
* - Service `smadex`: Your Smadex account's email ID.
* - Service `zendesk`: Zendesk email.
* - Service `zendesk_sunshine`: Zendesk email.
*/
email: string;
/**
* Field usage depends on `service` value:
* - Service `clockodo`: Your Clockodo email address.
*/
emailAddress: string;
/**
* Field usage depends on `service` value:
* - Service `cabcharge`: Your Cabcharge email ID.
* - Service `ordway`: Your Ordway user email ID.
* - Service `planful`: Your Planful email ID.
* - Service `zendesk_workforce_management`: Email ID associated with the Zendesk Workforce Management account you want Fivetran to use to access your data.
*/
emailId: string;
/**
* Field usage depends on `service` value:
* - Service `aws_cost_report`: Optional. If your CSV generating software doesn't provide header line for the documents, Fivetran can generate the generic column names and sync data rows with them.
* - Service `azure_blob_storage`: Optional. If your CSV generating software doesn't provide header line for the documents, Fivetran can generate the generic column names and sync data rows with them.
* - Service `box`: Optional. If your CSV generating software doesn't provide header line for the documents, Fivetran can generate the generic column names and sync data rows with them.
* - Service `dropbox`: Optional. If your CSV generating software doesn't provide header line for the documents, Fivetran can generate the generic column names and sync data rows with them.
* - Service `email`: Optional. If your CSV generating software doesn't provide header line for the documents, Fivetran can generate the generic column names and sync data rows with them.
* - Service `ftp`: Optional. If your CSV generating software doesn't provide header line for the documents, Fivetran can generate the generic column names and sync data rows with them.
* - Service `gcs`: Optional. If your CSV generating software doesn't provide header line for the documents, Fivetran can generate the generic column names and sync data rows with them.
* - Service `google_drive`: Optional. If your CSV generating software doesn't provide header line for the documents, Fivetran can generate the generic column names and sync data rows with them.
* - Service `kinesis`: Optional. If your CSV generating software doesn't provide header line for the documents, Fivetran can generate the generic column names and sync data rows with them.
* - Service `s3`: If your CSVs are headerless, set this is as `true`. When `true`, we will generate generic column names following the convention of `column_0`, `column_1`, ... `column_n` to map the rows. Default value: `false`.
* - Service `s3_compatible_storage`: If your CSVs are headerless, set this is as `true`. When `true`, we will generate generic column names following the convention of `column_0`, `column_1`, ... `column_n` to map the rows. Default value: `false`.
* - Service `sftp`: Optional. If your CSV generating software doesn't provide header line for the documents, Fivetran can generate the generic column names and sync data rows with them.
* - Service `share_point`: Optional. If your CSV generating software doesn't provide header line for the documents, Fivetran can generate the generic column names and sync data rows with them.
* - Service `wasabi_cloud_storage`: If your CSVs are headerless, set this is as `true`. When `true`, we will generate generic column names following the convention of `column_0`, `column_1`, ... `column_n` to map the rows. Default value: `false`.
*/
emptyHeader: boolean;
/**
* Field usage depends on `service` value:
* - Service `double_click_campaign_manager`: Whether to enable all reach dimension combinations in the report. Default value: `false`
*/
enableAllDimensionCombinations: boolean;
/**
* Field usage depends on `service` value:
* - Service `oracle_hva`: Default value: `false`. Set to `true` if you're using archive log only mode.
* - Service `oracle_sap_hva`: Default value: `false`. Set to `true` if you're using archive log only mode.
* - Service `oracle_sap_hva_netweaver`: Default value: `false`. Set to `true` if you're using archive log only mode.
* - Service `sql_server_hva`: Use archive log only mode
* - Service `sql_server_sap_ecc_hva`: Use archive log only mode
*/
enableArchiveLogOnly: boolean;
enableDataExtensionsSyncing: boolean;
/**
* Field usage depends on `service` value:
* - Service `cosmos`: Enable to allow the connector to join a cluster of connectors forming a Distributed Connector Cluster. This cluster allows parallel syncs from the same source to the same destination using multiple connectors.
* - Service `dynamodb`: Enable to allow the connector to join a cluster of connectors forming a Distributed Connector Cluster. This cluster allows parallel syncs from the same source to the same destination using multiple connectors.
*/
enableDistributedConnectorMode: boolean;
/**
* Field usage depends on `service` value:
* - Service `snowplow`: Enable Enrichments
*/
enableEnrichments: boolean;
/**
* Field usage depends on `service` value:
* - Service `braze`: Enable User Profile Exports
*/
enableExports: boolean;
/**
* Field usage depends on `service` value:
* - Service `gitlab`: The confirmation that you have allowed Fivetran to connect with your self-hosted instance. Possible values: `true`, `false`.
*/
enableMtlsConnection: string;
/**
* Field usage depends on `service` value:
* - Service `sql_server`: Use transparent data encryption (TDE)
* - Service `sql_server_hva`: Using Transparent Data Encryption (TDE)
* - Service `sql_server_sap_ecc_hva`: Using Transparent Data Encryption (TDE)
*/
enableTde: boolean;
/**
* Field usage depends on `service` value:
* - Service `oracle_hva`: Default value: `false`. Set to `true` if you're using TDE encryption.
* - Service `oracle_sap_hva`: Default value: `false`. Set to `true` if you're using TDE encryption.
* - Service `oracle_sap_hva_netweaver`: Default value: `false`. Set to `true` if you're using TDE encryption.
*/
enableTdeEncryption: boolean;
/**
* Field usage depends on `service` value:
* - Service `apple_search_ads`: Use the public key to grant Fivetran access to Apple Search Ads api.
*/
encodedPublicKey: string;
/**
* Field usage depends on `service` value:
* - Service `marketo`: Marketo SOAP API Encryption Key (Discontinued).
*/
encryptionKey: string;
/**
* Field usage depends on `service` value:
* - Service `branch`: Webhook Endpoint
* - Service `iterable`: Register the following URL for webhooks on your Iterable dashboard.
* - Service `marketo`: Marketo REST API endpoint.
* - Service `snowplow`: Connection-specific collector endpoint. The collector endpoint will have the `webhooks.fivetran.com/snowplow/endpoint_ID` format. You will need it to configure Snowplow to connect with Fivetran.
* - Service `webhooks`: You can send your events to https://webhooks.fivetran.com/webhooks/{endpoint}
*/
endpoint: string;
/**
* Field usage depends on `service` value:
* - Service `s3_compatible_storage`: S3-Compatible Storage Endpoint URL.
*/
endpointUrl: string;
/**
* Field usage depends on `service` value:
* - Service `pinterest_ads`: The number of days to use as the conversion attribution window for an engagement (i.e. closeup or save) action.
*/
engagementAttributionWindow: string;
/**
* Field usage depends on `service` value:
* - Service `db2z`: Determines whether the Enhanced PassTicket is sent in mixed case or uppercase before authentication. Specify only when `authentication_method` is `ENHANCED_PASS_TICKET`. Supported values:`UPPER`- The generated PassTicket consist of uppercase alphanumeric characters.`MIXED`- The generated PassTicket consists of mixed-case alphanumeric characters and may include '-' and '_'.
*/
enhancedPassTicketType: string;
/**
* Field usage depends on `service` value:
* - Service `optimizely`: Enriched Events S3 bucket
*/
enrichedExport: string;
/**
* Field usage depends on `service` value:
* - Service `checkout`: Your Checkout.com entity ID.
* - Service `zuora`: If `is_multi_entity_feature_enabled` is `true`, then it's `EntityId`.
* - Service `zuora_sandbox`: If `is_multi_entity_feature_enabled` is `true`, then it's `EntityId`.
*/
entityId: string;
/**
* Field usage depends on `service` value:
* - Service `aurora_postgres`: Registered Application ID (for Entra ID authentication).
* - Service `azure_postgres`: Registered Application ID (for Entra ID authentication).
* - Service `google_cloud_postgresql`: Registered Application ID (for Entra ID authentication).
* - Service `heroku_postgres`: Registered Application ID (for Entra ID authentication).
* - Service `postgres`: Registered Application ID (for Entra ID authentication).
* - Service `postgres_rds`: Registered Application ID (for Entra ID authentication).
*/
entraAppId: string;
/**
* Field usage depends on `service` value:
* - Service `aurora_postgres`: Azure Tenant ID (for Entra ID authentication).
* - Service `azure_postgres`: Azure Tenant ID (for Entra ID authentication).
* - Service `google_cloud_postgresql`: Azure Tenant ID (for Entra ID authentication).
* - Service `heroku_postgres`: Azure Tenant ID (for Entra ID authentication).
* - Service `postgres`: Azure Tenant ID (for Entra ID authentication).
* - Service `postgres_rds`: Azure Tenant ID (for Entra ID authentication).
*/
entraTenantId: string;
/**
* Field usage depends on `service` value:
* - Service `bazaarvoice`: Your Bazaarvoice environment.
* - Service `buildium`: Your Buildium environment.
* - Service `checkout`: Your Checkout.com environment.
* - Service `concord`: Your Concord environment.
* - Service `deposco`: Your Deposco environment.
* - Service `dialpad`: Your Dialpad environment.
* - Service `dsv`: Your API Development Environment.
* - Service `healthie`: Your Healthie environment.
* - Service `invoiced`: Your Invoiced environment.
* - Service `jibble`: Your Jibble environment.
* - Service `lucca`: Your Lucca environment.
* - Service `oracle_netsuite_openair`: Your NetSuite SuiteProjects Pro environment.
* - Service `ordergroove`: Your Ordergroove environment.
* - Service `paddle`: Your Paddle environment.
* - Service `procore`: Your Procore account environment.
* - Service `reltio`: Your Reltio environment.
* - Service `servicetitan`: Your ServiceTitan environment.
* - Service `smarthr`: Your SmartHR environment.
* - Service `stackadapt_graphql`: Your StackAdapt environment.
* - Service `trelica`: Your Trelica environment.
* - Service `tremendous`: Your Tremendous environment.
* - Service `vts`: Your VTS environment.
* - Service `xactly`: Your Xactly environment.
* - Service `younium`: Your Younium API environment.
* - Service `zip`: Your Zip environment.
* - Service `zuora`: Zuora Sandbox Environment. This accepts either of the two values Sandbox or Central Sandbox based on your subscription. The default environment is Sandbox.
* - Service `zuora_sandbox`: Zuora Sandbox Environment. This accepts either of the two values Sandbox or Central Sandbox based on your subscription. The default environment is Sandbox.
*/
environment: string;
/**
* Field usage depends on `service` value:
* - Service `xactly`: Your Xactly environment host.
*/
environmentHost: string;
/**
* Field usage depends on `service` value:
* - Service `business_central`: Name of the environment
*/
environmentName: string;
/**
* Field usage depends on `service` value:
* - Service `aws_cost_report`: Optional. If your CSV generator follows non-standard rules for escaping quotation marks, you can set the escape character here.
* - Service `azure_blob_storage`: If your CSV generator follows non-standard rules for escaping quotation marks, you can set the escape character here.
* - Service `box`: If your CSV generator follows non-standard rules for escaping quotation marks, you can set the escape character here.
* - Service `dropbox`: If your CSV generator follows non-standard rules for escaping quotation marks, you can set the escape character here.
* - Service `email`: If your CSV generator follows non-standard rules for escaping quotation marks, you can set the escape character here.
* - Service `ftp`: If your CSV generator follows non-standard rules for escaping quotation marks, you can set the escape character here.
* - Service `gcs`: If your CSV generator follows non-standard rules for escaping quotation marks, you can set the escape character here.
* - Service `google_drive`: If your CSV generator follows non-standard rules for escaping quotation marks, you can set the escape character here.
* - Service `kinesis`: Optional. If your CSV generator follows non-standard rules for escaping quotation marks, you can set the escape character here.
* - Service `s3`: If your CSV generator follows non-standard rules for escaping quotation marks, you can set the escape character here.
* - Service `s3_compatible_storage`: If your CSV generator follows non-standard rules for escaping quotation marks, you can set the escape character here.
* - Service `sftp`: If your CSV generator follows non-standard rules for escaping quotation marks, you can set the escape character here.
* - Service `share_point`: If your CSV generator follows non-standard rules for escaping quotation marks, you can set the escape character here.
* - Service `wasabi_cloud_storage`: If your CSV generator follows non-standard rules for escaping quotation marks, you can set the escape character here.
*/
escapeChar: string;
/**
* Field usage depends on `service` value:
* - Service `gcs`: Approach used by CSV parser. Default value: `CUSTOM_ESCAPE_CHAR`. required for CSV parsing when `non_standard_escape_char` is `true`.
* - Service `s3`: Approach used by CSV parser. Default value: `CUSTOM_ESCAPE_CHAR`. required for CSV parsing when `non_standard_escape_char` is `true`.
*/
escapeCharOptions: string;
/**
* Field usage depends on `service` value:
* - Service `kustomer`: Turn it on if your app is on EU region
* - Service `survey_monkey`: The SurveyMonkey account region. Specify `true`, if your account is hosted in the EU region. Default value is `false`.
*/
euRegion: boolean;
/**
* Field usage depends on `service` value:
* - Service `iterable`: List of events to sync. Should be specified when `sync_mode` is `SelectedEvents`
*/
events: string[];
/**
* Field usage depends on `service` value:
* - Service `google_drive`: Optional. Set to true to export your Google Docs and Slides as PDF documents. By default, we export Google Docs and Slides as .docx and .pptx files, respectively.
*/
exportNativeTypesAsPdf: boolean;
/**
* Field usage depends on `service` value:
* - Service `adjust`: Your cloud storage.
* - Service `amplitude`: Your cloud storage type
* - Service `braze`: Export Storage. Required if `enable_exports` is `true`
* - Service `pendo`: Denotes which storage option is chosen
*/
exportStorageType: string;
/**
* Field usage depends on `service` value:
* - Service `appsflyer`: The external ID is a string that designates who can assume the role. For more information, click a href="http://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_create_for-user_externalid.html"here/a
* - Service `aws_cloudtrail`: This is the same as your `group_id`, used for authentication along with the `role_arn`.
* - Service `aws_cost_report`: The external ID is a string that designates who can assume the role. For more information, click a href="http://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_create_for-user_externalid.html"here/a
* - Service `aws_lambda`: The external ID is a string that designates who can assume the role.
* - Service `aws_msk`: This is the same as your `group_id`. This is required when `sasl_mechanism` is set to `IAM`.
* - Service `azure_function`: External ID.
* - Service `cloudfront`: This is the same as your `group_id`, used for authentication along with the `role_arn`.
* - Service `dynamodb`: This is the same as your `group_id`, used for authentication along with the `role_arn`.
* - Service `kinesis`: The external ID is a string that designates who can assume the role. For more information, click a href="http://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_create_for-user_externalid.html"here/a
* - Service `s3`: Used for authentication along with the `role_arn`. If not provided, it uses connector's `group_id`. Use the [List All Groups endpoint](https://fivetran.com/docs/rest-api/groups#listallgroups) to find the `group_id`.
* - Service `segment`: The external ID is a string that designates who can assume the role. For more information, see a href="http://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_create_for-user_externalid.html"Amazon's AWS Identity and Access Management User Guide/a.
* - Service `sql_server`: The external ID to be used when assuming the IAM role.
*/
externalId: string;
/**
* Field usage depends on `service` value:
* - Service `azure_blob_storage`: A regular expression with a named capture group `(?table...)` to extract table names from file paths.
* - Service `gcs`: A regular expression with a named capture group `(?table...)` to extract table names from file paths.
* - Service `s3`: A regular expression with a named capture group `(?table...)` to extract table names from file paths.
* - Service `sftp`: A regular expression with a named capture group `(?table...)` to extract table names from file paths.
*/
extractionPattern: string;
/**
* Field usage depends on `service` value:
* - Service `unicommerce`: Your uniware facility codes.
*/
facilityCodes: string;
/**
* Field usage depends on `service` value:
* - Service `facebook`: List of fields which connector will sync. [Possible field values](https://fivetran.com/docs/applications/facebook-ad-insights/api-config#fields).
*/
fields: string[];
/**
* Field usage depends on `service` value:
* - Service `box`: Files will be processed and synced according to the selected file handling option. Supported values:`structured`- (Default) Extract structured data into destination tables for analysis. Commonly used.`unstructured`- Replicate files in their original format. Best for PDFs, images, and other unstructured content. Learn more about unstructured file replication in our [documentation.](https://fivetran.com/docs/using-fivetran/features/unstructured-file-replication).
* - Service `google_drive`: Files will be processed and synced according to the selected file handling option. Supported values:`structured`- (Default) Extract structured data into destination tables for analysis. Commonly used.`unstructured`- Replicate files in their original format. Best for PDFs, images, and other unstructured content. Learn more about unstructured file replication in our [documentation.](https://fivetran.com/docs/using-fivetran/features/unstructured-file-replication).
* - Service `sftp`: Files will be processed and synced according to the selected file handling option. Supported values:`structured`- (Default) Extract structured data into destination tables for analysis. Commonly used.`unstructured`- Replicate files in their original format. Best for PDFs, images, and other unstructured content. Learn more about unstructured file replication in our [documentation.](https://fivetran.com/docs/using-fivetran/features/unstructured-file-replication).
* - Service `share_point`: Files will be processed and synced according to the selected file handling option. Supported values:`structured`- (Default) Extract structured data into destination tables for analysis. Commonly used.`unstructured`- Replicate files in their original format. Best for PDFs, images, and other unstructured content. Learn more about unstructured file replication in our [documentation.](https://fivetran.com/docs/using-fivetran/features/unstructured-file-replication).
*/
fileHandling: string;
/**
* Field usage depends on `service` value:
* - Service `azure_blob_storage`: The method used to map files to destination tables. Use `DEFINE_PER_TABLE` to manually configure each table with its own file pattern, or `EXTRACT_TABLES` to automatically discover tables based on a single extraction pattern.
* - Service `gcs`: The method used to map files to destination tables. Use `DEFINE_PER_TABLE` to manually configure each table with its own file pattern, or `EXTRACT_TABLES` to automatically discover tables based on a single extraction pattern.
* - Service `s3`: The method used to map files to destination tables. Use `DEFINE_PER_TABLE` to manually configure each table with its own file pattern, or `EXTRACT_TABLES` to automatically discover tables based on a single extraction pattern.
* - Service `sftp`: The method used to map files to destination tables. Use `DEFINE_PER_TABLE` to manually configure each table with its own file pattern, or `EXTRACT_TABLES` to automatically discover tables based on a single extraction pattern.
*/
fileMappingMethod: string;
/**
* Field usage depends on `service` value:
* - Service `aws_cost_report`: If your files are saved with improper extensions, you can force them to by synced as the selected filetype. Leave the value as infer if your files have the correct extensions
* - Service `azure_blob_storage`: If your files are saved with improper extensions, you can force them to by synced as the selected file type.
* - Service `box`: If your files are saved with improper extensions, you can force them to be synced as the selected filetype.
* - Service `dropbox`: If your files are saved with improper extensions, you can force them to be synced as the selected filetype.
* - Service `email`: If your files are saved with improper extensions, you can force them to by synced as the selected file type.
* - Service `ftp`: If your files are saved with improper extensions, you can force them to by synced as the selected file type.
* - Service `gcs`: If your files are saved with improper extensions, you can force them to by synced as the selected file type.
* - Service `google_drive`: If your files are saved with improper extensions, you can force them to be synced as the selected filetype.
* - Service `kinesis`: If your files are saved with improper extensions, you can force them to by synced as the selected filetype. Leave the value as infer if your files have the correct extensions
* - Service `s3`: If your files are saved with improper extensions, you can force them to be synced as the selected file type.
* - Service `s3_compatible_storage`: If your files are saved with improper extensions, you can force them to be synced as the selected file type.
* - Service `sftp`: If your files are saved with improper extensions, you can force them to by synced as the selected file type.
* - Service `share_point`: If your files are saved with improper extensions, you can force them to be synced as the selected file type.
* - Service `wasabi_cloud_storage`: If your files are saved with improper extensions, you can force them to be synced as the selected file type.
*/
fileType: string;
/**
* Field usage depends on `service` value:
* - Service `azure_blob_storage`: Mapped file name patterns to a destination table.
* - Service `box`: Mapped file name patterns to a destination table.
* - Service `dropbox`: Mapped file name patterns to a destination table.
* - Service `email`: Mapped file name patterns to a destination table.
* - Service `ftp`: Mapped file name patterns to a destination table.
* - Service `gcs`: Mapped file name patterns to a destination table.
* - Service `google_drive`: Mapped file name patterns to a destination table.
* - Service `s3`: Mapped file name patterns to a destination table.
* - Service `s3_compatible_storage`: Mapped file name patterns to a destination table.
* - Service `sftp`: Mapped file name patterns to a destination table.
* - Service `share_point`: Mapped file name patterns to a destination table.
*/
files: outputs.GetConnectorConfigFile[];
/**
* Field usage depends on `service` value:
* - Service `google_analytics`: String parameter restricts the data returned for your report. To use the filter parameter, specify a dimension or metric on which to filter, followed by the filter expression
*/
filter: string;
/**
* Field usage depends on `service` value:
* - Service `itunes_connect`: Whether to sync all finance accounts or specific finance accounts.
*/
financeAccountSyncMode: string;
/**
* Field usage depends on `service` value:
* - Service `itunes_connect`: Specific finance accounts to sync. Must be populated if `finance_account_sync_mode` is set to `SpecificFinanceAccounts`.
*/
financeAccounts: string[];
/**
* Field usage depends on `service` value:
* - Service `dropbox`: Your Dropbox Folder URL.
*/
folder: string;
/**
* Field usage depends on `service` value:
* - Service `box`: Folder URL
* - Service `google_drive`: Folder URL
*/
folderId: string;
/**
* Field usage depends on `service` value:
* - Service `adobe_analytics_data_feed`: Folder Path
* - Service `one_drive`: Your OneDrive folder URL
* - Service `oracle_business_intelligence_publisher`: The folder path to save data models and reports.
*/
folderPath: string;
/**
* Field usage depends on `service` value:
* - Service `clari`: Your Clari Forecast id .
*/
forecastId: string;
/**
* Field usage depends on `service` value:
* - Service `adobe_analytics_data_feed`: FTP host.
*/
ftpHost: string;
/**
* Field usage depends on `service` value:
* - Service `adobe_analytics_data_feed`: FTP password.
*/
ftpPassword: string;
/**
* Field usage depends on `service` value:
* - Service `adobe_analytics_data_feed`: FTP port.
*/
ftpPort: number;
/**
* Field usage depends on `service` value:
* - Service `adobe_analytics_data_feed`: FTP user.
*/
ftpUser: string;
/**
* Field usage depends on `service` value:
* - Service `aws_lambda`: The name of your AWS Lambda Function.
*/
function: string;
/**
* Field usage depends on `service` value:
* - Service `azure_function`: Function app name in Azure portal.
*/
functionApp: string;
/**
* Field usage depends on `service` value:
* - Service `azure_function`: Function key used for authorization.
*/
functionKey: string;
/**
* Field usage depends on `service` value:
* - Service `azure_function`: Name of the function to be triggered.
*/
functionName: string;
/**
* Field usage depends on `service` value:
* - Service `google_cloud_function`: The trigger URL of the cloud function.
*/
functionTrigger: string;
/**
* Field usage depends on `service` value:
* - Service `braze`: Your GCS bucket. Required if `GCS` is the `cloud_storage_type`
* - Service `webhooks`: The GCS bucket name. Required if `bucket_service` is set to `GCS`.
*/
gcsBucket: string;
/**
* Field usage depends on `service` value:
* - Service `amplitude`: GCS Credentials
* - Service `pendo`: Configuration for GCS Bucket
*/
gcsCredentials: outputs.GetConnectorConfigGcsCredentials;
/**
* Field usage depends on `service` value:
* - Service `braze`: Your GCS bucket. Required if `GCS` is the `export_storage_type`
*/
gcsExportBucket: string;
/**
* Field usage depends on `service` value:
* - Service `braze`: Your GCS folder name. Required if `GCS` is the `export_storage_type`
*/
gcsExportFolder: string;
/**
* Field usage depends on `service` value:
* - Service `braze`: Your GCS folder name. Required if `GCS` is the `cloud_storage_type`
*/
gcsFolder: string;
/**
* Field usage depends on `service` value:
* - Service `workday`: Select this option to generate a Primary Key for reports where no single column or combination of columns can be used to form a Primary Key.
*/
generateFivetranPk: boolean;
/**
* Field usage depends on `service` value:
* - Service `sap_hana_db`: SAP Logon Group name for load balancing
*/
group: string;
/**
* Field usage depends on `service` value:
* - Service `line_ads`: Your LINE Ads group ID(s).
*/
groupId: string;
/**
* Field usage depends on `service` value:
* - Service `fivetran_log`: (Optional) The group name of the `target_group_id`.
*/
groupName: string;
hanaBackupPassword: string;
/**
* Field usage depends on `service` value:
* - Service `sap_hana_db`: Port number of the SAP HANA database
*/
hanaDbPort: number;
/**
* Field usage depends on `service` value:
* - Service `hana_sap_hva_b1`: The mode for connecting to HANA server. Available options: Single container (default), Multiple containers - Tenant database, Multiple containers - System database, Manual port selection - This option is used only if the database port needs to be specified manually.
* - Service `hana_sap_hva_ecc`: The mode for connecting to HANA server. Available options: Single container (default), Multiple containers - Tenant database, Multiple containers - System database, Manual port selection - This option is used only if the database port needs to be specified manually.
* - Service `hana_sap_hva_ecc_netweaver`: The mode for connecting to HANA server. Available options: Single container (default), Multiple containers - Tenant database, Multiple containers - System database, Manual port selection - This option is used only if the database port needs to be specified manually.
* - Service `hana_sap_hva_s4`: The mode for connecting to HANA server. Available options: Single container (default), Multiple containers - Tenant database, Multiple containers - System database, Manual port selection - This option is used only if the database port needs to be specified manually.
* - Service `hana_sap_hva_s4_netweaver`: The mode for connecting to HANA server. Available options: Single container (default), Multiple containers - Tenant database, Multiple containers - System database, Manual port selection - This option is used only if the database port needs to be specified manually.
*/
hanaMode: string;
/**
* Field usage depends on `service` value:
* - Service `azure_service_bus`: The boolean value specifying whether the connection string has manage permissions
*/
hasManagePermissions: boolean;
/**
* Field usage depends on `service` value:
* - Service `braze`: Range of data in history you would like to include in the initial sync.
* - Service `iterable`: The time range for which historical data should be synced. Default value: `All Time`.
* - Service `klaviyo`: Range of data in history you would like to include in the initial sync. Default value: `ALL_TIME`.
* - Service `marketo`: Range of data in history you would like to include in the initial sync. Default value: `ALL_TIME`.
* - Service `sailthru`: Range of historical data you would like to include in the initial sync. Default value: `ALL_TIME`.
* - Service `salesforce_marketing_cloud`: Range of data in history you would like to include in the initial sync. Default value: `ALL_TIME`.
*/
historicSyncTimeFrame: string;
/**
* Field usage depends on `service` value:
* - Service `braze`: Range of data in history you would like to include in the initial sync. Valid values are `ALL_TIME` and `DATE_LIMIT`
* - Service `concur`: Historical Sync Limit for the Sync
* - Service `eloqua`: Range of data in history you would like to include in the initial sync. Default value: `ALL_TIME`.
* - Service `iterable`: The time range for which historical data should be synced. Default value: `All Time`.
* - Service `klaviyo`: The time range for which historical data should be synced. Default value: `ALL_TIME`.
* - Service `marketo`: The time range for which historical data should be synced. Default value: `All Time`.
* - Service `pardot`: The time range for which historical data should be synced. Default value: `All Time`.
* - Service `pardot_sandbox`: The time range for which historical data should be synced. Default value: `All Time`.
* - Service `sage_intacct`: Historical Sync Limit for the Sync
* - Service `sailthru`: The time range for which historical data should be synced. Default value: `All Time`.
* - Service `salesforce_marketing_cloud`: The time range for which historical data should be synced. Default value: `All Time`.
*/
historicalSyncLimit: string;
/**
* Field usage depends on `service` value:
* - Service `braze`: The start date (in YYYY-MM-DD) from which to sync historical data. Only used when `historicalSyncLimit` is set to `DATE_LIMIT`.
* - Service `iterable`: The start date (YYYY-MM-DD) from which to sync historical data.
* - Service `klaviyo`: The start date (YYYY-MM-DD) from which to sync historical data.
* - Service `marketo`: The start date (YYYY-MM-DD) from which to sync historical data.
* - Service `pardot`: The start date (YYYY-MM-DD) from which to sync historical data.
* - Service `pardot_sandbox`: The start date (YYYY-MM-DD) from which to sync historical data.
* - Service `sailthru`: The start date (YYYY-MM-DD) from which to sync historical data.
* - Service `salesforce_marketing_cloud`: The start date (YYYY-MM-DD) from which to sync historical data.
*/
historicalSyncLimitDate: string;
/**
* Field usage depends on `service` value:
* - Service `pardot`: The options for time range for which historical data should be synced. Default value: `All Time`.
* - Service `pardot_sandbox`: The options for time range for which historical data should be synced. Default value: `All Time`.
*/
historicalSyncLimitTimeFrame: string;
/**
* Field usage depends on `service` value:
* - Service `amazon_selling_partner`: The time frame for historical data synchronization. Default value: `ALL_TIME`.
* - Service `ascend_by_partnerize`: Your Ascend by Partnerize Historical sync time frame
* - Service `hubspot`: Used to configure Historical sync timeframe for selected tables.
* - Service `mixpanel`: Should sync all data or adhere to `backward_sync_limit_date`
* - Service `pendo`: The time range for which historical data should be synced. Default value: `All Time`.
* - Service `rokt`: Your Rokt historical sync time frame.
* - Service `shopify`: Used to configure Historical sync timeframe for selected tables
* - Service `skimlinks`: Your Skimlinks Historical sync time frame.
* - Service `stripe`: Used to configure Historical sync timeframe for selected tables
* - Service `stripe_test`: Used to configure Historical sync timeframe for selected tables
* - Service `vimeo`: Your Vimeo Historical sync time frame.
* - Service `zendesk`: Used to configure Historical sync timeframe for selected tables.
*/
historicalSyncTimeFrame: string;
/**
* Field usage depends on `service` value:
* - Service `appsflyer`: Your S3 home folder path of the Data Locker.
*/
homeFolder: string;
/**
* Field usage depends on `service` value:
* - Service `amqp`: AMQP broker host address.
* - Service `aurora`: DB instance host or IP address.
* - Service `aurora_postgres`: DB instance host or IP address.
* - Service `aveva_pi`: IP address of the AF Server
* - Service `azure_postgres`: DB instance host or IP address.
* - Service `azure_sql_db`: DB instance host or IP address.
* - Service `azure_sql_managed_db`: DB instance host or IP address.
* - Service `clarity`: DB instance host or IP address.
* - Service `cockroachdb`: DB instance host or IP address.
* - Service `commercetools`: Your commercetools host.
* - Service `databricks_db`: The host URL for your Databricks account.
* - Service `db2i_hva`: A host address of the primary node. It should be a DB instance host/IP address with a port number.
* - Service `db2i_sap_hva`: DB instance host or IP address.
* - Service `db2luw`: A host address of the primary node. It should be a DB instance host/IP address with a port number.
* - Service `db2z`: DB instance host or IP address.
* - Service `documentdb`: Host IP address of the primary node. Ignored if `hosts` value is provided.
* - Service `dynamics_365_fo`: DB instance host or IP address.
* - Service `ehr`: DB instance host or IP address.
* - Service `elastic_cloud`: DB instance host or IP address.
* - Service `epic_clarity`: DB instance host or IP address.
* - Service `es_self_hosted`: DB instance host or IP address.
* - Service `ftp`: FTP host address.
* - Service `google_cloud_mysql`: DB instance host or IP address.
* - Service `google_cloud_postgresql`: DB instance host or IP address.
* - Service `google_cloud_sqlserver`: DB instance host or IP address.
* - Service `hana_sap_hva_b1`: DB instance host or IP address.
* - Service `hana_sap_hva_ecc`: DB instance host or IP address.
* - Service `hana_sap_hva_ecc_netweaver`: DB instance host or IP address.
* - Service `hana_sap_hva_s4`: DB instance host or IP address.
* - Service `hana_sap_hva_s4_netweaver`: DB instance host or IP address.
* - Service `heroku_postgres`: DB instance host or IP address.
* - Service `jira`: The Jira service host address.
* - Service `magento_mysql`: DB instance host or IP address.
* - Service `magento_mysql_rds`: DB instance host or IP address.
* - Service `maria`: DB instance host or IP address.
* - Service `maria_azure`: DB instance host or IP address.
* - Service `maria_rds`: DB instance host or IP address.
* - Service `marin`: The Marin host address.
* - Service `mysql`: DB instance host or IP address.
* - Service `mysql_azure`: DB instance host or IP address.
* - Service `mysql_rds`: DB instance host or IP address.
* - Service `netsuite_suiteanalytics`: The NetSuite service host address.
* - Service `opendistro`: DB instance host or IP address.
* - Service `opensearch`: DB instance host or IP address.
* - Service `oracle`: DB instance host or IP address.
* - Service `oracle_ebs`: DB instance host or IP address.
* - Service `oracle_hva`: DB instance host or IP address.
* - Service `oracle_rac`: DB instance host or IP address.
* - Service `oracle_rds`: DB instance host or IP address.
* - Service `oracle_sap_hva`: DB instance host or IP address.
* - Service `oracle_sap_hva_netweaver`: DB instance host or IP address.
* - Service `postgres`: DB instance host or IP address.
* - Service `postgres_rds`: DB instance host or IP address.
* - Service `redshift_db`: Host name
* - Service `sap_hana`: The SAP HANA host or IP address.
* - Service `sap_s4hana`: The SAP S/4 host or IP address.
* - Service `sftp`: SFTP host address.
* - Service `snowflake_db`: Host name
* - Service `splunk`: The Splunk service host address.
* - Service `sql_server`: DB instance host or IP address.
* - Service `sql_server_hva`: DB instance host or IP address.
* - Service `sql_server_rds`: DB instance host or IP address.
* - Service `sql_server_sap_ecc_hva`: DB instance host or IP address.
*/
host: string;
/**
* Field usage depends on `service` value:
* - Service `azure_blob_storage`: IP address of host tunnel machine which is used to connect to the Storage container.
* - Service `azure_service_bus`: The IP address of the host machine which we use to connect to ASB via ssh
*/
hostIp: string;
/**
* Field usage depends on `service` value:
* - Service `coassemble`: Your Coassemble Hostname.
* - Service `datadog`: Your Datadog host name.
* - Service `ukg_pro_workforce_management`: Your UKG Pro Workforce Management hostname.
* - Service `zuora`: The domain or URL of your Zuora Revenue instance.
* - Service `zuora_sandbox`: The domain or URL of your Zuora Revenue instance.
*/
hostName: string;
/**
* Field usage depends on `service` value:
* - Service `adobe_commerce`: Your Adobe Commerce host url.
* - Service `github`: The GHES instance host address. Only for on-premises installations.
* - Service `sparkpost`: Your SparkPost host URL.
*/
hostUrl: string;
/**
* Field usage depends on `service` value:
* - Service `azure_blob_storage`: Username in the host machine.
* - Service `azure_service_bus`: The username on the host machine which we use to connect to ASB via ssh
*/
hostUser: string;
/**
* Field usage depends on `service` value:
* - Service `akamai`: Your Akamai hostname.
* - Service `discourse`: Your Discourse hostname.
* - Service `national_heavy_vehicle_regulator`: Your National Heavy Vehicle Regulator hostname.
* - Service `ukg_pro`: Your UKG Pro hostname.
*/
hostname: string;
/**
* Field usage depends on `service` value:
* - Service `azure_cosmos_for_mongo`: A list of host addresses for Azure Cosmos DB for Mongo DB.
* - Service `mongo`: A list of host addresses of the primary node and all replicas. Each list item is either: a DB instance host/IP address with a port number, or SRV host record.
* - Service `mongo_sharded`: A list of host addresses of the primary node and all replicas. Each list item is either: a DB instance host/IP address with a port number, or SRV host record.
*/
hosts: string[];
/**
* Field usage depends on `service` value:
* - Service `databricks_db`: http path
*/
httpPath: string;
/**
* Field usage depends on `service` value:
* - Service `playvox_workforce_management`: Your Playvox Workforce Management client identifier.
* - Service `statistics_netherlands_cbs`: Your Statistics Netherlands CBS catalog identifier.
*/
identifier: string;
/**
* Field usage depends on `service` value:
* - Service `marketo`: Marketo REST API identity url.
*/
identity: string;
/**
* Field usage depends on `service` value:
* - Service `servicenow`: (Immutable) Include inherited columns.
*/
includeInheritedColumns: boolean;
/**
* Field usage depends on `service` value:
* - Service `salesforce_commerce_cloud`: Whether to sync data through OCAPI endpoints.
*/
includeOcapiEndpoints: boolean;
/**
* Field usage depends on `service` value:
* - Service `acumatica`: Your Acumatica instance name.
* - Service `coupa`: The instance name of your Coupa account in the URL.
* - Service `flywheel_digital`: Your Flywheel Digital instance.
* - Service `salesforce_marketing_cloud`: The Salesforce Marketing Cloud instance ID
* - Service `servicenow`: ServiceNow Instance ID.
*/
instance: string;
/**
* Field usage depends on `service` value:
* - Service `workday_adaptive`: Instance code for Workday Adaptive Planning.
*/
instanceCode: string;
/**
* Field usage depends on `service` value:
* - Service `hana_sap_hva_b1`: Two-digit number (00-97) of the SAP instance within its host.
* - Service `hana_sap_hva_ecc`: Two-digit number (00-97) of the SAP instance within its host.
* - Service `hana_sap_hva_ecc_netweaver`: Two-digit number (00-97) of the SAP instance within its host.
* - Service `hana_sap_hva_s4`: Two-digit number (00-97) of the SAP instance within its host.
* - Service `hana_sap_hva_s4_netweaver`: Two-digit number (00-97) of the SAP instance within its host.
* - Service `oracle_sap_hva_netweaver`: Two-digit number (00-97) of the SAP instance within its host.
*/
instanceNumber: string;
/**
* Field usage depends on `service` value:
* - Service `sap_business_by_design`: The SAP Business ByDesign instance URL.
*/
instanceUrl: string;
/**
* Field usage depends on `service` value:
* - Service `pendo`: The integration key of the Pendo account.
*/
integrationKey: string;
/**
* Field usage depends on `service` value:
* - Service `aveva_pi`: IP address of the AF Server
*/
ipAddress: string;
/**
* Field usage depends on `service` value:
* - Service `fivetran_log`: (Optional) Retrieve account-level logs.
*/
isAccountLevelConnector: boolean;
/**
* Field usage depends on `service` value:
* - Service `apple_search_ads`: The contents of your PEM certificate file. Default value: `false`
*/
isAuth2Enabled: boolean;
/**
* Field usage depends on `service` value:
* - Service `twitter_ads`: Custom API credentials
*/
isCustomApiCredentials: boolean;
/**
* Field usage depends on `service` value:
* - Service `pardot`: Whether the `EXTERNAL_ACTIVITY` table must be synced or not.
* - Service `pardot_sandbox`: Whether the `EXTERNAL_ACTIVITY` table must be synced or not.
*/
isExternalActivitiesEndpointSelected: boolean;
/**
* Field usage depends on `service` value:
* - Service `adobe_analytics_data_feed`: Use Secure FTP (FTPS).
*/
isFtps: boolean;
/**
* Field usage depends on `service` value:
* - Service `sftp`: Whether to use a key pair for authentication. When `true`, do not use `password`.
*/
isKeypair: boolean;
/**
* Field usage depends on `service` value:
* - Service `zuora`: Set to `true` if there are multiple entities in your Zuora account and you only want to use one entity. Otherwise, set to `false`.
* - Service `zuora_sandbox`: Set to `true` if there are multiple entities in your Zuora account and you only want to use one entity. Otherwise, set to `false`.
*/
isMultiEntityFeatureEnabled: boolean;
/**
* Field usage depends on `service` value:
* - Service `salesforce_marketing_cloud`: Indicates that that your installed package uses OAuth 2.0. Default value: `false`
*/
isNewPackage: boolean;
/**
* Field usage depends on `service` value:
* - Service `snowflake_db`: Indicates that a private key is encrypted. The default value: `false`. The field can be specified if authentication type is `KEY_PAIR`.
*/
isPrivateKeyEncrypted: boolean;
/**
* Field usage depends on `service` value:
* - Service `aws_lambda`: We use PrivateLink by default if your AWS Lambda is in the same region as Fivetran. Turning on this toggle ensures that Fivetran always connects to AWS lambda over PrivateLink. Learn more in our [PrivateLink documentation](https://fivetran.com/docs/connectors/databases/connection-options/aws-private-link).
* - Service `dynamodb`: We use PrivateLink by default if your DynamoDB instance is in the same region as Fivetran. Turning on this toggle ensures that Fivetran always connects to DynamoDB over PrivateLink. Learn more in our [PrivateLink documentation](https://fivetran.com/docs/connectors/databases/connection-options/aws-private-link).
* - Service `s3`: Set to `true` if you want to connect to S3 bucket over PrivateLink. Default value: `false`.
*/
isPrivateLinkRequired: boolean;
/**
* Field usage depends on `service` value:
* - Service `aws_cost_report`: Whether you are syncing from a public bucket. Default value: `false`.
* - Service `kinesis`: Is the bucket public? (you don't need an AWS account for syncing public buckets!)
* - Service `s3`: Whether you are syncing from a public bucket. Default value: `false`.
*/
isPublic: boolean;
/**
* Field usage depends on `service` value:
* - Service `sailthru`: Enable this if you want to sync Sailthru Connect
*/
isSailthruConnectEnabled: boolean;
/**
* Field usage depends on `service` value:
* - Service `ftp`: Whether the server supports FTPS.
*/
isSecure: boolean;
/**
* Field usage depends on `service` value:
* - Service `salesforce_marketing_cloud`: Provide SFTP credentials
*/
isSftpCredsAvailable: boolean;
/**
* Field usage depends on `service` value:
* - Service `box`: Allows the creation of connector using Merge Mode strategy.
* - Service `dropbox`: Allows the creation of connector using Merge Mode strategy.
* - Service `google_drive`: Allows the creation of connector using Merge Mode strategy.
* - Service `sftp`: Allows the creation of connector using the specified Sync strategy.
* - Service `share_point`: Allows the creation of connector using Merge Mode strategy.
*/
isSingleTableMode: boolean;
/**
* Field usage depends on `service` value:
* - Service `adyen`: Whether or not your Adyen Account is a Test Account. Default value: `false`.
*/
isTestAccount: boolean;
/**
* Field usage depends on `service` value:
* - Service `amazon_selling_partner`: Whether or not you have a Vendor Account. Default value: `false`.
*/
isVendor: boolean;
/**
* Field usage depends on `service` value:
* - Service `oracle_fusion_cloud_apps_crm`: The Oracle Fusion Cloud issuer name.
* - Service `oracle_fusion_cloud_apps_fscm`: The Oracle Fusion Cloud issuer name.
* - Service `oracle_fusion_cloud_apps_hcm`: The Oracle Fusion Cloud issuer name.
*/
issuer: string;
/**
* Field usage depends on `service` value:
* - Service `itunes_connect`: Your Issuer ID
*/
issuerId: string;
/**
* Field usage depends on `service` value:
* - Service `amqp`: JSON delivery mode (Packed or Unpacked).
* - Service `aws_cost_report`: Control how your JSON data is delivered into your destination
* - Service `azure_blob_storage`: Control how your JSON data is delivered into your destination
* - Service `box`: Control how your JSON data is delivered into your destination
* - Service `dropbox`: Control how your JSON data is delivered into your destination
* - Service `email`: Control how your JSON data is delivered into your destination
* - Service `ftp`: Control how your JSON data is delivered into your destination
* - Service `gcs`: Control how your JSON data is delivered into your destination
* - Service `google_drive`: Control how your JSON data is delivered into your destination
* - Service `kinesis`: Control how your JSON data is delivered into your destination
* - Service `s3`: Control how your JSON data is delivered into your destination
* - Service `s3_compatible_storage`: Control how your JSON data is delivered into your destination
* - Service `sftp`: Control how your JSON data is delivered into your destination
* - Service `share_point`: Control how your JSON data is delivered into your destination
* - Service `wasabi_cloud_storage`: Specifies how Fivetran should handle your JSON data. Default value: `Packed`.
*/
jsonDeliveryMode: string;
/**
* Field usage depends on `service` value:
* - Service `uservoice`: The UserVoice API key.
*/
key: string;
/**
* Field usage depends on `service` value:
* - Service `itunes_connect`: Your Key ID
*/
keyId: string;
/**
* Field usage depends on `service` value:
* - Service `aws_msk`: If `security_protocol` is set to `TLS`, enter your `Key Password`.
*/
keyPassword: string;
/**
* Field usage depends on `service` value:
* - Service `heroku_kafka`: Key Store Type
*/
keyStoreType: string;
/**
* Field usage depends on `service` value:
* - Service `aws_msk`: If `security_protocol` is set to `TLS`, add the `Keystore File` as Base64 encoded string.
*/
keystore: string;
/**
* Field usage depends on `service` value:
* - Service `aws_msk`: If `security_protocol` is set to `TLS`, enter your `Keystore Password`.
*/
keystorePassword: string;
lastSyncedChangesUtc_: string;
latestVersion: string;
/**
* Field usage depends on `service` value:
* - Service `younium`: Your Younium legal entity ID.
*/
legalEntityId: string;
/**
* Field usage depends on `service` value:
* - Service `pardot`: API limit for the external activities endpoint.
* - Service `pardot_sandbox`: API limit for the external activities endpoint.
*/
limitForApiCallsToExternalActivitiesEndpoint: number;
/**
* Field usage depends on `service` value:
* - Service `aws_cost_report`: You can specify the custom line separator for your CSV files. The line separator is used in files to separate one row from the next.
* - Service `azure_blob_storage`: You can specify the custom line separator for your CSV files. The line separator is used in files to separate one row from the next.
* - Service `box`: You can specify the custom line separator for your CSV files. The line separator is used in files to separate one row from the next.
* - Service `dropbox`: You can specify the custom line separator for your CSV files. The line separator is used in files to separate one row from the next.
* - Service `email`: You can specify the custom line separator for your CSV files. The line separator is used in files to separate one row from the next.
* - Service `ftp`: You can specify the custom line separator for your CSV files. The line separator is used in files to separate one row from the next.
* - Service `gcs`: You can specify the custom line separator for your CSV files. The line separator is used in files to separate one row from the next.
* - Service `google_drive`: You can specify the custom line separator for your CSV files. The line separator is used in files to separate one row from the next.
* - Service `kinesis`: You can specify the custom line separator for your CSV files. The line separator is used in files to separate one row from the next.
* - Service `s3`: You can specify the custom line separator for your CSV files. The line separator is used in files to separate one row from the next.
* - Service `s3_compatible_storage`: You can specify the custom line separator for your CSV files. The line separator is used in files to separate one row from the next.
* - Service `sftp`: You can specify the custom line separator for your CSV files. The line separator is used in files to separate one row from the next.
* - Service `share_point`: You can specify the custom line separator for your CSV files. The line separator is used in files to separate one row from the next.
* - Service `wasabi_cloud_storage`: You can specify the custom line separator for your CSV files. The line separator is used in files to separate one row from the next.
*/
lineSeparator: string;
/**
* Field usage depends on `service` value:
* - Service `pigment`: Your Pigment list ID.
*/
listId: string;
/**
* Field usage depends on `service` value:
* - Service `cj_commission_detail`: Your CJ Commission Detail list of company IDs.
*/
listOfCompanyIds: string;
/**
* Field usage depends on `service` value:
* - Service `aws_cost_report`: Optional. If you have a file structure where new files are always named in lexicographically increasing order such as files being named in increasing order of time, you can select codetime_based_pattern_listing/code.
* - Service `kinesis`: Optional. If you have a file structure where new files are always named in lexicographically increasing order such as files being named in increasing order of time, you can select codetime_based_pattern_listing/code.
* - Service `s3`: The listing strategy you want to use. Default value: `complete_listing`.
* - Service `s3_compatible_storage`: The listing strategy you want to use. Default value: `complete_listing`.
*/
listStrategy: string;
/**
* Field usage depends on `service` value:
* - Service `google_analytics_4_export`: The Sync Mode
*/
listSyncMode: string;
/**
* Field usage depends on `service` value:
* - Service `h_level`: Your HighLevel location ID.
*/
locationIds: string;
/**
* Field usage depends on `service` value:
* - Service `db2i_hva`: The log journal name.
* - Service `db2i_sap_hva`: The log journal name.
*/
logJournal: string;
/**
* Field usage depends on `service` value:
* - Service `db2i_hva`: The log journal schema.
* - Service `db2i_sap_hva`: The log journal schema.
*/
logJournalSchema: string;
/**
* Field usage depends on `service` value:
* - Service `hana_sap_hva_ecc_netweaver`: Name of the SAP logon group. The default value is PUBLIC. This field is optional.
* - Service `hana_sap_hva_s4_netweaver`: Name of the SAP logon group. The default value is PUBLIC. This field is optional.
*/
logOnGroup: string;
/**
* Field usage depends on `service` value:
* - Service `rebound_returns`: Your ReBound Returns login.
* - Service `the_trade_desk`: The Trade Desk email. It is a part of the login credentials.
* - Service `walmart_dsp`: Walmart DSP email. It is a part of the login credentials.
* - Service `workday_adaptive`: User email address
*/
login: string;
/**
* Field usage depends on `service` value:
* - Service `concur`: The SAP Concur password.
* - Service `sage_intacct`: The login password. It is a part of the login credentials.
*/
loginPassword: string;
/**
* Field usage depends on `service` value:
* - Service `sage_intacct`: Lookback window for GL Batch endpoint lookback sync
*/
lookBackWindowForGlBatchEndpoint: number;
/**
* Field usage depends on `service` value:
* - Service `google_ads`: The list of the Manager Account IDs whose clients will be synced. Must be populated if `sync_mode` is set to `ManagerAccounts`.
*/
managerAccounts: string[];
/**
* Field usage depends on `service` value:
* - Service `reltio`: Maximum API requests per day
*/
maxApiRequestsPerDay: number;
/**
* Field usage depends on `service` value:
* - Service `afterpay`: Your Afterpay Merchant ID.
* - Service `amazon_selling_partner`: The Merchant ID or Vendor Code.
* - Service `avantlink`: Your AvantLink Merchant ID.
* - Service `braintree`: Your Braintree merchant ID.
* - Service `braintree_sandbox`: Your Braintree merchant ID.
* - Service `shareasale`: Your ShareASale merchant ID.
* - Service `xsolla`: Your Xsolla Merchant ID.
*/
merchantId: string;
/**
* Field usage depends on `service` value:
* - Service `amqp`: Message type (Text or JSON).
* - Service `apache_kafka`: Kafka message type.
* - Service `aws_msk`: The Message type.
* - Service `azure_event_hub`: Message type.
* - Service `azure_service_bus`: The format of messages in the topic
* - Service `confluent_cloud`: Confluent Cloud message type.
* - Service `heroku_kafka`: Heroku Kafka message type.
*/
messageType: string;
/**
* Field usage depends on `service` value:
* - Service `pigment`: Your Pigment metric ID.
*/
metricId: string;
/**
* Field usage depends on `service` value:
* - Service `adroll`: The metrics that you want to sync.
* - Service `criteo`: Metrics
* - Service `double_click_campaign_manager`: Report metrics to include into a sync.
* - Service `google_analytics`: The report metrics to include into a sync.
* - Service `google_display_and_video_360`: The report metrics to include into a sync. The metric names are provided in the API format. This is a required parameter when `config_method` is set to `CREATE_NEW`.
*/
metrics: string[];
/**
* Field usage depends on `service` value:
* - Service `sap_hana_db`: SAP Message Server host name
*/
msHost: string;
/**
* Field usage depends on `service` value:
* - Service `sap_hana_db`: SAP Message Server service port number
*/
msServ: string;
/**
* Field usage depends on `service` value:
* - Service `google_sheets`: The name of the named data range on the sheet that contains the data to be synced.
*/
namedRange: string;
/**
* Field usage depends on `service` value:
* - Service `amqp`: AMQP namespace or virtual host.
* - Service `azure_service_bus`: The ASB namespace which we have to sync. Required for `AzureActiveDirectory` authentication.
*/
namespace: string;
/**
* Field usage depends on `service` value:
* - Service `double_click_publishers`: Network code is a unique, numeric identifier for your Ad Manager network.
*/
networkCode: number;
/**
* Field usage depends on `service` value:
* - Service `gcs`: Use this if your CSV generator uses non-standard ways of escaping characters. Default value: `false`.
* - Service `s3`: Use this if your CSV generator uses non-standard ways of escaping characters. Default value: `false`.
*/
nonStandardEscapeChar: boolean;
/**
* Field usage depends on `service` value:
* - Service `aws_cost_report`: Optional. If your CSVs use a special value indicating null, you can specify it here.
* - Service `azure_blob_storage`: If your CSVs use a special value indicating null, you can specify it here.
* - Service `box`: If your CSVs use a special value indicating null, you can specify it here.
* - Service `dropbox`: If your CSVs use a special value indicating null, you can specify it here.
* - Service `email`: If your CSVs use a special value indicating null, you can specify it here.
* - Service `ftp`: If your CSVs use a special value indicating null, you can specify it here.
* - Service `gcs`: If your CSVs use a special value indicating null, you can specify it here.
* - Service `google_drive`: If your CSVs use a special value indicating null, you can specify it here.
* - Service `kinesis`: Optional. If your CSVs use a special value indicating null, you can specify it here.
* - Service `s3`: If your CSVs use a special value indicating null, you can specify it here.
* - Service `s3_compatible_storage`: If your CSVs use a special value indicating null, you can specify it here.
* - Service `sftp`: If your CSVs use a special value indicating null, you can specify it here.
* - Service `share_point`: If your CSVs use a special value indicating null, you can specify it here.
* - Service `wasabi_cloud_storage`: If your CSVs use a special value indicating null, you can specify it here.
*/
nullSequence: string;
/**
* Field usage depends on `service` value:
* - Service `dsv`: Your OAuth subscription key.
*/
oauthSubscriptionKey: string;
oauthToken: string;
oauthTokenSecret: string;
/**
* Field usage depends on `service` value:
* - Service `salesforce_commerce_cloud`: The Salesforce Commerce Cloud OCAPI Client ID.
*/
ocapiClientId: string;
/**
* Field usage depends on `service` value:
* - Service `salesforce_commerce_cloud`: The Salesforce Commerce Cloud OCAPI Client secret.
*/
ocapiClientSecret: string;
/**
* Field usage depends on `service` value:
* - Service `salesforce_commerce_cloud`: The Salesforce Commerce Cloud OCAPI custom object types.
*/
ocapiCustomObjectTypes: string;
/**
* Field usage depends on `service` value:
* - Service `salesforce_commerce_cloud`: The Salesforce Commerce Cloud OCAPI hostname.
*/
ocapiHostname: string;
/**
* Field usage depends on `service` value:
* - Service `hana_sap_hva_b1`: ODBC manager library path
* - Service `hana_sap_hva_ecc`: ODBC manager library path
* - Service `hana_sap_hva_s4`: ODBC manager library path
*/
odbcDriverManagerLibraryPath: string;
/**
* Field usage depends on `service` value:
* - Service `hana_sap_hva_b1`: odbc.ini and odbcsinst.ini location
* - Service `hana_sap_hva_ecc`: odbc.ini and odbcsinst.ini location
* - Service `hana_sap_hva_s4`: odbc.ini and odbcsinst.ini location
*/
odbcSysIniPath: string;
/**
* Field usage depends on `service` value:
* - Service `aws_cost_report`: If you know that your files contain some errors, you can choose to have poorly formatted lines skipped. We recommend leaving the value as fail unless you are certain that you have undesirable, malformed data.
* - Service `azure_blob_storage`: If you know that your files contain some errors, you can choose to have poorly formatted lines skipped. We recommend leaving the value as fail unless you are certain that you have undesirable, malformed data.
* - Service `box`: If you know that your files contain some errors, you can choose to have poorly formatted lines skipped. We recommend leaving the value as fail unless you are certain that you have undesirable, malformed data.
* - Service `dropbox`: If you know that your files contain some errors, you can choose to have poorly formatted lines skipped. We recommend leaving the value as fail unless you are certain that you have undesirable, malformed data.
* - Service `ftp`: If you know that your files contain some errors, you can choose to have poorly formatted lines skipped. We recommend leaving the value as fail unless you are certain that you have undesirable, malformed data.
* - Service `gcs`: If you know that your files contain some errors, you can choose to have poorly formatted lines skipped. We recommend leaving the value as fail unless you are certain that you have undesirable, malformed data.
* - Service `google_drive`: If you know that your files contain some errors, you can choose to have poorly formatted lines skipped. We recommend leaving the value as fail unless you are certain that you have undesirable, malformed data.
* - Service `kinesis`: If you know that your files contain some errors, you can choose to have poorly formatted lines skipped. We recommend leaving the value as fail unless you are certain that you have undesirable, malformed data.
* - Service `s3`: If you know that your files contain some errors, you can choose to have poorly formatted lines skipped. We recommend leaving the value as `fail` unless you are certain that you have undesirable, malformed data.
* - Service `s3_compatible_storage`: If you know that your files contain some errors, you can choose to have poorly formatted lines skipped. We recommend leaving the value as `fail` unless you are certain that you have undesirable, malformed data.
* - Service `sftp`: If you know that your files contain some errors, you can choose to have poorly formatted lines skipped. We recommend leaving the value as fail unless you are certain that you have undesirable, malformed data.
* - Service `share_point`: If you know that your files contain some errors, you can choose to have poorly formatted lines skipped. We recommend leaving the value as fail unless you are certain that you have undesirable, malformed data.
* - Service `wasabi_cloud_storage`: If you know that your files contain some errors, you can choose to have poorly formatted lines skipped. We recommend leaving the value as `fail` unless you are certain that you have undesirable, malformed data.
*/
onError: string;
/**
* Field usage depends on `service` value:
* - Service `jira`: Whether the Jira instance is local or in cloud.
*/
onPremise: boolean;
/**
* Field usage depends on `service` value:
* - Service `adobe_experience_platform`: Your Adobe Experience Platform organization ID.
*/
orgId: string;
/**
* Field usage depends on `service` value:
* - Service `gladly`: Your Gladly Organization Name.
* - Service `statuspage`: Your Statuspage Organization ID.
*/
organization: string;
/**
* Field usage depends on `service` value:
* - Service `adobe_workfront`: Your Adobe Workfront organization domain.
*/
organizationDomain: string;
/**
* Field usage depends on `service` value:
* - Service `adobe_analytics`: Organization ID from the Service Account (JWT) credentials of your Adobe Project.
* - Service `device_magic`: Your Device Magic organization ID.
* - Service `integrate`: Your Integrate organization ID.
* - Service `megaphone`: Your Megaphone organization ID.
* - Service `productive`: Your Productive Organization ID.
* - Service `salesforce_commerce_cloud`: The organization ID from Salesforce Commerce Cloud account.
* - Service `sentry`: Your Sentry organization ID.
* - Service `zoho_books`: Your Zoho Books Organization ID.
* - Service `zoho_inventory`: Your Zoho Inventory organization ID.
*/
organizationId: string;
/**
* Field usage depends on `service` value:
* - Service `brightpearl`: Your Brightpearl organization name.
* - Service `confluence`: Your Confluence organization name.
*/
organizationName: string;
/**
* Field usage depends on `service` value:
* - Service `apple_search_ads`: Organizations
* - Service `snapchat_ads`: Specific organizations IDs to sync. Must be populated if `syncMode` is set to `SpecificOrganizations`.
*/
organizations: string[];
packageId: string;
/**
* Field usage depends on `service` value:
* - Service `azure_cosmos_for_mongo`: List of tables to be synced in packed mode; format:`db.table`(case-sensitive).
* - Service `dynamodb`: List of tables to be synced in packed mode.
* - Service `firebase`: Specific tables to sync. Must be populated if `packing_mode` is set to `SelectTablesForPackedMode`.
* - Service `mongo`: List of tables to be synced in packed mode; format:`db.table`(case-sensitive).
* - Service `mongo_sharded`: List of tables to be synced in packed mode; format:`db.table`(case-sensitive).
*/
packedModeTables: string[];
/**
* Field usage depends on `service` value:
* - Service `azure_cosmos_for_mongo`: Indicates the desired sync pack mode. Accepted values are `UsePackedModeOnly` and `UseUnpackedModeOnly`. `SelectTablesForPackedMode` is deprecated.
* - Service `firebase`: Whether to sync all tables in unpacked mode or specific tables in packed mode. Default value: `UseUnpackedModeOnly`.
* - Service `klaviyo`: Packing mode for EVENT and PERSON tables.
* - Service `mongo`: Whether to sync all tables in unpacked mode only, all tables in packed mode only, or specific tables in packed mode. Default value: `UseUnpackedModeOnly`.
* - Service `mongo_sharded`: Whether to sync all tables in unpacked mode only, all tables in packed mode only, or specific tables in packed mode. Default value: `UseUnpackedModeOnly`.
* - Service `optimizely`: Packing mode for conversion and decision tables.
* - Service `sailthru`: Packing mode for LIST_STATE and USER tables.
*/
packingMode: string;
/**
* Field usage depends on `service` value:
* - Service `facebook_pages`: Specific pages to sync. Must be populated if `sync_mode` is set to `SpecificPages`.
*/
pages: string[];
/**
* Field usage depends on `service` value:
* - Service `care_quality_commission`: Your Care Quality Commission partner code.
*/
partnerCode: string;
/**
* Field usage depends on `service` value:
* - Service `expensify`: Your Expensify partnerUserID.
*/
partnerUserId: string;
/**
* Field usage depends on `service` value:
* - Service `expensify`: Your Expensify partnerUserSecret.
*/
partnerUserSecret: string;
/**
* Field usage depends on `service` value:
* - Service `google_display_and_video_360`: The list of partners to include into a sync. This parameter only takes effect when `config_method` is set to `CREATE_NEW`.
* - Service `the_trade_desk`: Specific Partner IDs to sync. Must be populated if `syncMode` is set to `SpecificAccounts`.
* - Service `walmart_dsp`: Specific Partner IDs to sync. Must be populated if `syncMode` is set to `SpecificAccounts`.
*/
partners: string[];
/**
* Field usage depends on `service` value:
* - Service `qualtrics`: Pass Phrase
*/
passPhrase: string;
/**
* Field usage depends on `service` value:
* - Service `snowflake_db`: In case private key is encrypted, you are required to enter passphrase that was used to encrypt the private key. The field can be specified if authentication type is `KEY_PAIR`.
*/
passphrase: string;
/**
* Field usage depends on `service` value:
* - Service `absorb_lms`: Your Absorb LMS password.
* - Service `adobe_commerce`: Your Adobe Commerce password.
* - Service `akeneo`: Your Akeneo password.
* - Service `alida`: Your Alida client secret.
* - Service `amqp`: Password for basic authentication.
* - Service `anaplan`: Your Anaplan password. Must be populated if `auth_mode` is set to `Basic`.
* - Service `appfigures`: Your Appfigures Password.
* - Service `asset_panda`: Your Asset Panda password.
* - Service `aurora`: The user's password.
* - Service `aurora_postgres`: The user's password.
* - Service `azure_cosmos_for_mongo`: Password used for source database authentication.
* - Service `azure_postgres`: The user's password.
* - Service `azure_sql_db`: The user's password.
* - Service `azure_sql_managed_db`: The user's password.
* - Service `boostr`: Your Boostr password.
* - Service `brivo`: Your Brivo password.
* - Service `cabcharge`: Your Cabcharge password.
* - Service `ceridian_dayforce`: Your Ceridian Dayforce password.
* - Service `cin7`: Your Cin7 API Key.
* - Service `clarity`: The user's password.
* - Service `cockroachdb`: The user's password.
* - Service `collibra`: Your collibra password.
* - Service `compliance_checkpoint`: Your Compliance Checkpoint account password.
* - Service `contrast_security`: Your Contrast Security API Password.
* - Service `db2i_hva`: The user's password.
* - Service `db2i_sap_hva`: The user's password.
* - Service `db2luw`: The user's password.
* - Service `db2z`: The user's password. Specify only when `authentication_method` is `PASSWORD`.
* - Service `delighted`: Pass an empty string
* - Service `deposco`: Your Deposco password.
* - Service `documentdb`: The user's password.
* - Service `dynamics_365_fo`: The user's password.
* - Service `ehr`: The user's password.
* - Service `elastic_cloud`: The user's password.
* - Service `epic_clarity`: The user's password.
* - Service `es_self_hosted`: The user's password.
* - Service `ftp`: FTP password.
* - Service `globalmeet`: Your GlobalMeet Password.
* - Service `google_cloud_mysql`: The user's password.
* - Service `google_cloud_postgresql`: The user's password.
* - Service `google_cloud_sqlserver`: The user's password.
* - Service `green_power_monitor`: Your GreenPowerMonitor password.
* - Service `guru`: Your Guru password.
* - Service `hana_sap_hva_b1`: The user's password.
* - Service `hana_sap_hva_ecc`: The user's password.
* - Service `hana_sap_hva_ecc_netweaver`: The user's password.
* - Service `hana_sap_hva_s4`: The user's password.
* - Service `hana_sap_hva_s4_netweaver`: The user's password.
* - Service `heroku_postgres`: The user's password.
* - Service `hilti_ontrack`: Your Hilti On!Track password.
* - Service `impact`: Your Impact Brand Account Token
* - Service `integral_ad_science`: Your integral_ad_science password.
* - Service `itunes_connect`: Your password
* - Service `jamf`: Your Jamf password.
* - Service `jira`: The Jira user's password.
* - Service `khoros_care`: Your Khoros Care password.
* - Service `kissmetrics`: Your Kissmetrics API Password.
* - Service `klarna`: Your Klarna Password.
* - Service `lessonly`: Your Lessonly password.
* - Service `magento_mysql`: The user's password.
* - Service `magento_mysql_rds`: The user's password.
* - Service `maria`: The user's password.
* - Service `maria_azure`: The user's password.
* - Service `maria_rds`: The user's password.
* - Service `marin`: The Marin user's password.
* - Service `moloco`: Your Moloco account password.
* - Service `mongo`: The user's password.
* - Service `mongo_sharded`: The user's password.
* - Service `myosh`: Your myosh password.
* - Service `mysql`: The user's password.
* - Service `mysql_azure`: The user's password.
* - Service `mysql_rds`: The user's password.
* - Service `netsuite_suiteanalytics`: The NetSuite user's password.
* - Service `opendistro`: The user's password.
* - Service `opensearch`: The user's password.
* - Service `oracle`: The user's password.
* - Service `oracle_business_intelligence_publisher`: The Oracle Business Intelligence user password.
* - Service `oracle_ebs`: The user's password.
* - Service `oracle_fusion_cloud_apps_crm`: The Oracle Fusion Cloud user password.
* - Service `oracle_fusion_cloud_apps_fscm`: The Oracle Fusion Cloud user password.
* - Service `oracle_fusion_cloud_apps_hcm`: The Oracle Fusion Cloud user password.
* - Service `oracle_hva`: The user's password.
* - Service `oracle_rac`: The user's password.
* - Service `oracle_rds`: The user's password.
* - Service `oracle_sap_hva`: The user's password.
* - Service `oracle_sap_hva_netweaver`: The user's password.
* - Service `outbrain`: The Outbrain user's password.
* - Service `pardot`: The Pardot user's password.
* - Service `pardot_sandbox`: The Pardot user's password.
* - Service `partnerize`: Your Partnerize account's password.
* - Service `podio`: Your Podio account password.
* - Service `postgres`: The user's password.
* - Service `postgres_rds`: The user's password.
* - Service `qmatic_data_connect`: Your Qmatic Data Connect password.
* - Service `redshift_db`: The Redshift user's password.
* - Service `revx`: Your RevX Password.
* - Service `rtb_house`: Your RTB House password.
* - Service `sap_business_by_design`: The SAP Business ByDesign password.
* - Service `sap_hana`: Your SAP HANA password.
* - Service `sap_s4hana`: Your SAP S/4 password.
* - Service `scorm`: Your Scorm Secret Key.
* - Service `servicenow`: Your account password.
* - Service `servicetrade`: Your ServiceTrade password.
* - Service `sftp`: SFTP password.
* - Service `shiphero`: Your ShipHero password.
* - Service `shipstation`: Your ShipStation password.
* - Service `shopware`: Your Shopware password.
* - Service `skuvault`: Your SkuVault password.
* - Service `smadex`: Your Smadex Password.
* - Service `snowflake_db`: The Snowflake user's password.
* - Service `splash`: Your Splash password.
* - Service `splunk`: The Splunk user's password.
* - Service `sql_server`: The user's password.
* - Service `sql_server_hva`: The user's password.
* - Service `sql_server_rds`: The user's password.
* - Service `sql_server_sap_ecc_hva`: The user's password.
* - Service `starrez`: Your StarRez API password
* - Service `stickyio`: Your sticky.io password.
* - Service `stylight`: Your Stylight Password.
* - Service `sugarcrm`: Your SugarCRM password.
* - Service `teamwork`: Your Teamwork password.
* - Service `the_trade_desk`: The Trade Desk password. It is a part of the login credentials.
* - Service `toggl_track`: Your Toggl Track Password
* - Service `ukg_pro`: Your UKG Pro password.
* - Service `ukg_pro_workforce_management`: Your UKG Pro Workforce Management password.
* - Service `unicommerce`: Your uniware login password.
* - Service `upland`: Your Upland Software password.
* - Service `uptempo`: Your Uptempo password.
* - Service `veeva_vault`: Password
* - Service `veevavault`: Your Veeva Vault password.
* - Service `walmart_dsp`: Walmart DSP password. It is a part of the login credentials.
* - Service `when_i_work`: Your When I Work password.
* - Service `wherefour`: Your Wherefour password.
* - Service `workday`: Workday password.
* - Service `workday_adaptive`: User password
* - Service `workday_financial_management`: Workday password.
* - Service `workday_hcm`: Workday password.
* - Service `xandr`: Your Xandr password.
* - Service `yougov_brandindex`: Your YouGov BrandIndex password.
* - Service `younium`: Your Younium password.
* - Service `zuora`: The corresponding password for the API user.
* - Service `zuora_sandbox`: The corresponding password for the API user.
*/
password: string;
/**
* Field usage depends on `service` value:
* - Service `github`: The `Personal Access Token` generated in Github.
*/
pat: string;
/**
* Field usage depends on `service` value:
* - Service `tableau_source`: Your Tableau Source PAT Name.
*/
patName: string;
/**
* Field usage depends on `service` value:
* - Service `tableau_source`: Your Tableau Source PAT Secret.
*/
patSecret: string;
/**
* Field usage depends on `service` value:
* - Service `jira`: A URL subdirectory where the Jira instance is working.
*/
path: string;
/**
* Field usage depends on `service` value:
* - Service `github`: The `Personal Access Tokens`.
*/
pats: string[];
/**
* Field usage depends on `service` value:
* - Service `aws_cost_report`: Optional. All files in your search path matching this regular expression will be synced. This parameter is optional.
* - Service `azure_blob_storage`: All files in your search path matching this regular expression will be synced.
* - Service `box`: All files in your search path matching this regular expression will be synced.
* - Service `dropbox`: All files in your search path matching this regular expression will be synced.
* - Service `email`: All files in your search path matching this regular expression will be synced. We have discontinued this field, and will delete it by Oct 31, 2025.
* - Service `ftp`: All files in your search path matching this regular expression will be synced.
* - Service `gcs`: All files in your search path matching this regular expression will be synced. We have discontinued this field, and will delete it by August 31, 2025.
* - Service `google_drive`: All files in your search path matching this regular expression will be synced. We have discontinued this field, and will delete it by August 31, 2025.
* - Service `kinesis`: Optional. All files in your search path matching this regular expression will be synced. This parameter is optional.
* - Service `s3`: All files in your search path matching this regular expression will be synced. We have discontinued this field, and will delete it by August 31, 2025.
* - Service `sftp`: All files in your search path matching this regular expression will be synced. We have discontinued this field, and will delete it by August 31, 2025.
* - Service `share_point`: All files in your search path matching this regular expression will be synced.
* - Service `wasabi_cloud_storage`: All files in your search path matching this regular expression will be synced.
*/
pattern: string;
/**
* Field usage depends on `service` value:
* - Service `oracle`: Optional: Required only for containerized database.
* - Service `oracle_ebs`: Optional: Required only for containerized database.
* - Service `oracle_hva`: (Multi-tenant databases only) The database's PDB name. Omit this parameter for single-tenant databases.
* - Service `oracle_rac`: Optional: Required only for containerized database.
* - Service `oracle_rds`: Optional: Required only for containerized database.
* - Service `oracle_sap_hva`: (Multi-tenant databases only) The database's PDB name. Exclude this parameter for single-tenant databases.
*/
pdbName: string;
/**
* Field usage depends on `service` value:
* - Service `apple_search_ads`: The contents of your PEM certificate file. Must be populated if `is_auth2_enabled` is set to `false`.
*/
pemCertificate: string;
/**
* Field usage depends on `service` value:
* - Service `apple_search_ads`: The contents of your PEM secret key file. Must be populated if `is_auth2_enabled` is set to `true`.
*/
pemPrivateKey: string;
/**
* Field usage depends on `service` value:
* - Service `double_click_campaign_manager`: Per Interaction Dimensions.
*/
perInteractionDimensions: string[];
/**
* Field usage depends on `service` value:
* - Service `cj_commission_detail`: Your CJ Commission Detail personal access token.
* - Service `databricks_db`: Access Token
* - Service `gitlab`: Your GitLab personal access token.
* - Service `harvest`: Your Harvest Personal Access Token.
* - Service `productive`: Your Productive personal access token.
* - Service `totango`: Your Totango personal access token.
*/
personalAccessToken: string;
/**
* Field usage depends on `service` value:
* - Service `circleci`: Your CircleCI Personal API token.
* - Service `monday`: Your Monday.com Personal API Token.
*/
personalApiToken: string;
/**
* Field usage depends on `service` value:
* - Service `azure_blob_storage`: The PGP passphrase used to create the key. Must be populated if `use_pgp_encryption_options` is set to `true`.
* - Service `ftp`: The PGP passphrase used to create the key. Must be populated if `use_pgp_encryption_options` is set to `true`.
* - Service `gcs`: The PGP passphrase used to create the key. Must be populated if `use_pgp_encryption_options` is set to `true`.
* - Service `s3`: The PGP passphrase used to create the key. Must be populated if `use_pgp_encryption_options` is set to `true`.
* - Service `s3_compatible_storage`: The PGP passphrase used to create the key. Must be populated if `use_pgp_encryption_options` is set to `true`.
* - Service `sftp`: The PGP passphrase used to create the key. Must be populated if `use_pgp_encryption_options` is set to `true`.
* - Service `wasabi_cloud_storage`: The PGP passphrase used to create the key. Must be populated if `use_pgp_encryption_options` is set to `true`.
*/
pgpPassPhrase: string;
/**
* Field usage depends on `service` value:
* - Service `azure_blob_storage`: The contents of your PGP secret key file. Must be populated if `use_pgp_encryption_options` is set to `true`.
* - Service `ftp`: The contents of your PGP secret key file. Must be populated if `use_pgp_encryption_options` is set to `true`.
* - Service `gcs`: The contents of your PGP secret key file. Must be populated if `use_pgp_encryption_options` is set to `true`.
* - Service `s3`: The contents of your PGP secret key file. Must be populated if `use_pgp_encryption_options` is set to `true`.
* - Service `s3_compatible_storage`: The contents of your PGP secret key file. Must be populated if `use_pgp_encryption_options` is set to `true`.
* - Service `sftp`: The contents of your PGP secret key file. Must be populated if `use_pgp_encryption_options` is set to `true`.
* - Service `wasabi_cloud_storage`: The contents of your PGP secret key file. Must be populated if `use_pgp_encryption_options` is set to `true`.
*/
pgpSecretKey: string;
/**
* Field usage depends on `service` value:
* - Service `itunes_connect`: Register the number on AppleId Account Page for 2FA
*/
phoneNumber: string;
/**
* Field usage depends on `service` value:
* - Service `wrike`: Your Wrike Subscription Plan.
*/
plan: string;
/**
* Field usage depends on `service` value:
* - Service `justcall`: Your JustCall Plan Type.
*/
planType: string;
/**
* Field usage depends on `service` value:
* - Service `amqp`: AMQP broker port.
* - Service `aurora`: The port number.
* - Service `aurora_postgres`: The port number.
* - Service `aveva_pi`: Port number at which the AF Server is running
* - Service `azure_postgres`: The port number.
* - Service `azure_sql_db`: The port number.
* - Service `azure_sql_managed_db`: The port number.
* - Service `clarity`: The port number.
* - Service `cockroachdb`: The port number.
* - Service `databricks_db`: The port of your SQL warehouse.
* - Service `db2i_hva`: The port number.
* - Service `db2i_sap_hva`: The port number.
* - Service `db2luw`: The port number.
* - Service `db2z`: The port number.
* - Service `documentdb`: Port of the primary node. Ignored if `hosts` value is provided.
* - Service `dynamics_365_fo`: The port number.
* - Service `ehr`: The port number.
* - Service `elastic_cloud`: The port number.
* - Service `epic_clarity`: The port number.
* - Service `es_self_hosted`: The port number.
* - Service `ftp`: FTP port.
* - Service `google_cloud_mysql`: The port number.
* - Service `google_cloud_postgresql`: The port number.
* - Service `google_cloud_sqlserver`: The port number.
* - Service `hana_sap_hva_b1`: The port number.
* - Service `hana_sap_hva_ecc`: The port number.
* - Service `hana_sap_hva_ecc_netweaver`: The port number.
* - Service `hana_sap_hva_s4`: The port number.
* - Service `hana_sap_hva_s4_netweaver`: The port number.
* - Service `heroku_postgres`: The port number.
* - Service `jira`: The Jira service host port.
* - Service `magento_mysql`: The port number.
* - Service `magento_mysql_rds`: The port number.
* - Service `maria`: The port number.
* - Service `maria_azure`: The port number.
* - Service `maria_rds`: The port number.
* - Service `mysql`: The port number.
* - Service `mysql_azure`: The port number.
* - Service `mysql_rds`: The port number.
* - Service `netsuite_suiteanalytics`: The NetSuite service host port.
* - Service `opendistro`: The port number.
* - Service `opensearch`: The port number.
* - Service `oracle`: The port number.
* - Service `oracle_ebs`: The port number.
* - Service `oracle_hva`: The port number.
* - Service `oracle_rac`: The port number.
* - Service `oracle_rds`: The port number.
* - Service `oracle_sap_hva`: The port number.
* - Service `postgres`: The port number.
* - Service `postgres_rds`: The port number.
* - Service `redshift_db`: Port number
* - Service `sap_hana`: The SAP HANA port number.
* - Service `sap_s4hana`: The SAP S/4 port number.
* - Service `sftp`: SFTP port.
* - Service `snowflake_db`: The Snowflake optional port number.
* - Service `splunk`: The Splunk service host port.
* - Service `sql_server`: The port number.
* - Service `sql_server_hva`: The port number.
* - Service `sql_server_rds`: The port number.
* - Service `sql_server_sap_ecc_hva`: The port number.
*/
port: number;
/**
* Field usage depends on `service` value:
* - Service `linkedin_ads`: The time period to attribute conversions based on clicks. Default value: `DAY_30`
*/
postClickAttributionWindowSize: string;
/**
* Field usage depends on `service` value:
* - Service `facebook`: The name of report of which connector will sync the data. [Possible prebuilt_report values](https://fivetran.com/docs/applications/facebook-ad-insights/api-config#prebuiltreport).
* - Service `google_analytics`: The name of the Prebuilt Report from which the connector will sync the data.
*/
prebuiltReport: string;
/**
* Field usage depends on `service` value:
* - Service `aws_cloudtrail`: If prefix is present when configuring the bucket.
* - Service `aws_cost_report`: Folder path to the aws_cost_report files within the bucket.
* - Service `aws_inventory`: The prefix if you used one when configuring the bucket.
* - Service `azure_blob_storage`: All files and folders under this folder path will be searched for files to sync.
* - Service `box`: All files and folders under this folder path will be searched for files to sync.
* - Service `cloudfront`: The name of the CloudFront folder in the bucket.
* - Service `dropbox`: All files and folders under this folder path will be searched for files to sync.
* - Service `ftp`: All files and folders under this folder path will be searched for files to sync.
* - Service `gcs`: All files and folders under this folder path will be searched for files to sync.
* - Service `google_drive`: All files and folders under this folder path will be searched for files to sync, this can be the entire drive link or a folder URL
* - Service `kinesis`: Folder path to the Kinesis files within the bucket.
* - Service `marin`: Folder path to the Marin manifest file.
* - Service `microsoft_dynamics_365_fo`: Folder name in which the exported dynamics 365 data resides.
* - Service `s3`: All files and folders under this folder path will be searched for files to sync.
* - Service `s3_compatible_storage`: All files and folders under this folder path will be searched for files to sync.
* - Service `segment`: Folder path to the Segment files within the bucket. Must be populated if `sync_type` is set to `S3`.
* - Service `sftp`: All files and folders under this folder path will be searched for files to sync.
* - Service `share_point`: All files and folders under this folder path link will be searched for files to sync. This can be any shared folder link.
* - Service `wasabi_cloud_storage`: All files and folders under this folder path will be searched for files to sync.
*/
prefix: string;
/**
* Field usage depends on `service` value:
* - Service `care_quality_commission`: Your Care Quality Commission primary key.
*/
primaryKey: string;
/**
* Field usage depends on `service` value:
* - Service `workday`: Primary Keys
*/
primaryKeys: string[];
/**
* Field usage depends on `service` value:
* - Service `marketo`: Use BULK for both LEAD and ACTIITIES
*/
prioritiseBulkExportOverRest: boolean;
/**
* Field usage depends on `service` value:
* - Service `purple_dot`: Your PurpleDot Private access token.
*/
privateAccessToken: string;
/**
* Field usage depends on `service` value:
* - Service `absorb_lms`: Your Absorb LMS REST API private key.
* - Service `adobe_analytics`: The complete contents of your private key file including the start and end tags (`----BEGIN PRIVATE KEY----` to `----END PRIVATE KEY----`).
* - Service `adp_workforce_now`: Private Key.
* - Service `anaplan`: The contents of your private key file. Must be populated if `auth_mode` is set to `Certificate`.
* - Service `apple_search_ads`: The contents of your secret key file. Must be populated if `is_auth2_enabled` is set to `false`.
* - Service `braintree`: The contents of your secret key file.
* - Service `braintree_sandbox`: The contents of your secret key file.
* - Service `github`: Your Private Key
* - Service `itunes_connect`: Your Private Key
* - Service `netsuite_suiteanalytics`: Private Key
* - Service `oracle_fusion_cloud_apps_crm`: The Oracle Fusion Cloud private key.
* - Service `oracle_fusion_cloud_apps_fscm`: The Oracle Fusion Cloud private key.
* - Service `oracle_fusion_cloud_apps_hcm`: The Oracle Fusion Cloud private key.
* - Service `qualtrics`: Your private key
* - Service `salesforce`: Provide content of the `.key` private key (only when authentication_method = `ADVANCED`).
* - Service `salesforce_sandbox`: Provide content of the `.key` private key (only when authentication_method = `ADVANCED`).
* - Service `snowflake_db`: Private access key. The field should be specified if authentication type is `KEY_PAIR`.
*/
privateKey: string;
/**
* Field usage depends on `service` value:
* - Service `eventbrite`: Your Eventbrite private token.
*/
privateToken: string;
/**
* Field usage depends on `service` value:
* - Service `webconnex`: Your Webconnex product.
*/
product: string;
/**
* Field usage depends on `service` value:
* - Service `amazon_ads`: Specific User Profile IDs to sync. Must be populated if `sync_mode` is set to `SpecificProfiles`.
* - Service `google_analytics`: Specific User Profile IDs to sync. Must be populated if `syncMode` is set to `SpecificAccounts`.
* - Service `google_analytics_mcf`: Specific User Profile IDs to sync. Must be populated if `sync_mode` is set to `SPECIFIC_ACCOUNTS`.
*/
profiles: string[];
/**
* Field usage depends on `service` value:
* - Service `amazon_dsp`: your Amazon DSP profiles pass it inside an Array list.
*/
profilesAmazonDsp: string;
/**
* Field usage depends on `service` value:
* - Service `rollbar`: Your Rollbar project access token.
*/
projectAccessToken: string;
/**
* Field usage depends on `service` value:
* - Service `amplitude`: * Project(s)
*/
projectCredentials: outputs.GetConnectorConfigProjectCredential[];
/**
* Field usage depends on `service` value:
* - Service `bigquery_db`: BigQuery project ID
* - Service `google_analytics_360`: The project ID.
* - Service `google_analytics_4_export`: The Project ID.
* - Service `mixpanel`: Project ID
*/
projectId: string;
/**
* Field usage depends on `service` value:
* - Service `sentry`: Your Sentry project IDs.
*/
projectIds: string;
/**
* Field usage depends on `service` value:
* - Service `commercetools`: Your commercetools project key.
*/
projectKey: string;
/**
* Field usage depends on `service` value:
* - Service `writesonic`: Website URL of your Writesonic project.
*/
projectWebsiteUrl: string;
/**
* Field usage depends on `service` value:
* - Service `asana`: Specific Project IDs to sync. Must be populated if `syncMode` is set to `SpecificProjects`.
* - Service `jira`: Specific projects to sync. Must be populated if `syncMode` is set to `CUSTOM`.
*/
projects: string[];
/**
* Field usage depends on `service` value:
* - Service `google_analytics_4`: The array of strings in the `properties/{id}` format where `id` is a Google Analytics 4 property identifier. Must be populated if `sync_mode` is set to `SPECIFIC_ACCOUNTS`.
*/
properties: string[];
/**
* Field usage depends on `service` value:
* - Service `cloudbeds`: Your Cloudbeds property IDs.
*/
propertyId: string;
/**
* Field usage depends on `service` value:
* - Service `aurora`: Public Key
* - Service `aurora_postgres`: Public Key
* - Service `azure_blob_storage`: Public key generated by Fivetran to be copied into the host-machine's authorized keys file.
* - Service `azure_cosmos_for_mongo`: Public Key
* - Service `azure_postgres`: Public Key
* - Service `azure_service_bus`: Public key generated by Fivetran to be copied into the host-machine's authorized keys file.
* - Service `azure_sql_db`: Public Key.
* - Service `azure_sql_managed_db`: Public Key.
* - Service `braintree`: The contents of your PEM certificate file.
* - Service `braintree_sandbox`: The contents of your PEM certificate file.
* - Service `clarity`: Public Key.
* - Service `cockroachdb`: Public Key
* - Service `db2i_hva`: Public Key
* - Service `db2i_sap_hva`: Public Key
* - Service `documentdb`: Public Key
* - Service `dynamics_365_fo`: Public Key.
* - Service `ehr`: Public Key.
* - Service `elastic_cloud`: Public Key
* - Service `es_self_hosted`: Public Key
* - Service `google_cloud_mysql`: Public Key
* - Service `google_cloud_postgresql`: Public Key
* - Service `google_cloud_sqlserver`: Public Key.
* - Service `hana_sap_hva_b1`: Public Key
* - Service `hana_sap_hva_ecc`: Public Key
* - Service `hana_sap_hva_ecc_netweaver`: Public Key
* - Service `hana_sap_hva_s4`: Public Key
* - Service `hana_sap_hva_s4_netweaver`: Public Key
* - Service `heroku_postgres`: Public Key
* - Service `magento_mysql`: Public Key
* - Service `magento_mysql_rds`: Public Key
* - Service `maria`: Public Key
* - Service `maria_azure`: Public Key
* - Service `maria_rds`: Public Key
* - Service `mongo`: Public Key
* - Service `mongo_sharded`: Public Key
* - Service `mysql`: Public Key
* - Service `mysql_azure`: Public Key
* - Service `mysql_rds`: Public Key
* - Service `opendistro`: Public Key
* - Service `opensearch`: Public Key
* - Service `oracle`: Public Key
* - Service `oracle_ebs`: Public Key
* - Service `oracle_fusion_cloud_apps_crm`: The Oracle Fusion Cloud public key.
* - Service `oracle_fusion_cloud_apps_fscm`: The Oracle Fusion Cloud public key.
* - Service `oracle_fusion_cloud_apps_hcm`: The Oracle Fusion Cloud public key.
* - Service `oracle_hva`: Public Key
* - Service `oracle_rac`: Public Key
* - Service `oracle_rds`: Public Key
* - Service `oracle_sap_hva`: Public Key
* - Service `partnerstack_vendor`: Your PartnerStack Vendor Public key.
* - Service `postgres`: Public Key
* - Service `postgres_rds`: Public Key
* - Service `sap_hana`: Public Key
* - Service `sap_s4hana`: Public Key
* - Service `sftp`: Public Key
* - Service `sql_server`: Public Key.
* - Service `sql_server_hva`: Public Key.
* - Service `sql_server_rds`: Public Key.
* - Service `sql_server_sap_ecc_hva`: Public Key.
*/
publicKey: string;
/**
* Field usage depends on `service` value:
* - Service `aurora_postgres`: Publication name. Specify only for `"updated_method": "WAL_PGOUTPUT"`.
* - Service `azure_postgres`: Publication name. Specify only for `"updated_method": "WAL_PGOUTPUT"`.
* - Service `google_cloud_postgresql`: Publication name. Specify only for `"updated_method": "WAL_PGOUTPUT"`.
* - Service `heroku_postgres`: Publication name. Specify only for `"updated_method": "WAL_PGOUTPUT"`.
* - Service `postgres`: Publication name. Specify only for `"updated_method": "WAL_PGOUTPUT"`.
* - Service `postgres_rds`: Publication name. Specify only for `"updated_method": "WAL_PGOUTPUT"`.
*/
publicationName: string;
/**
* Field usage depends on `service` value:
* - Service `skimlinks`: Your Skimlinks publisher ID.
*/
publisherId: string;
/**
* Field usage depends on `service` value:
* - Service `outbrain`: Include or ignore results from archived campaigns
*/
pullArchivedCampaigns: boolean;
/**
* Field usage depends on `service` value:
* - Service `connector_sdk`: The Python version to be used at runtime.
*/
pythonVersion: string;
/**
* Field usage depends on `service` value:
* - Service `google_display_and_video_360`: The ID of the query whose configuration you want to reuse. This is a required parameter when `config_method` is set to `REUSE_EXISTING`.
*/
queryId: string;
/**
* Field usage depends on `service` value:
* - Service `alchemer`: Your Alchemer API key.
* - Service `birdeye`: Your Birdeye query-param-value.
*/
queryParamValue: string;
/**
* Field usage depends on `service` value:
* - Service `amqp`: AMQP queue name to consume messages from.
*/
queueName: string;
/**
* Field usage depends on `service` value:
* - Service `bigquery_db`: Specify a different project ID to account for quota and billing of Fivetran query workload
*/
quotaProjectId: string;
/**
* Field usage depends on `service` value:
* - Service `azure_blob_storage`: You can specify the enclosing character used in your CSVs here. Fivetran will consider " as the quote character if this field is empty and quote_character_enabled is set to true.
* - Service `box`: You can specify the enclosing character used in your CSVs here. Fivetran will consider " as the quote character if this field is empty and quote_character_enabled is set to true.
* - Service `dropbox`: You can specify the enclosing character used in your CSVs here. Fivetran will consider " as the quote character if this field is empty and quote_character_enabled is set to true.
* - Service `email`: You can specify the enclosing character used in your CSVs here. Fivetran will consider " as the quote character if this field is empty and quote_character_enabled is set to true.
* - Service `ftp`: You can specify the enclosing character used in your CSVs here. Fivetran will consider " as the quote character if this field is empty and quote_character_enabled is set to true.
* - Service `gcs`: You can specify the enclosing character used in your CSVs here. Fivetran will consider " as the quote character if this field is empty and quote_character_enabled is set to true.
* - Service `google_drive`: You can specify the enclosing character used in your CSVs here. Fivetran will consider " as the quote character if this field is empty and quote_character_enabled is set to true.
* - Service `s3`: You can specify the enclosing character used in your CSVs here. Fivetran will consider " as the quote character if this field is empty and quote_character_enabled is set to true.
* - Service `s3_compatible_storage`: You can specify the enclosing character used in your CSVs here. Fivetran will consider " as the quote character if this field is empty and quote_character_enabled is set to true.
* - Service `sftp`: You can specify the enclosing character used in your CSVs here. Fivetran will consider " as the quote character if this field is empty and quote_character_enabled is set to true.
* - Service `share_point`: You can specify the enclosing character used in your CSVs here. Fivetran will consider " as the quote character if this field is empty and quote_character_enabled is set to true.
*/
quoteChar: string;
/**
* Field usage depends on `service` value:
* - Service `azure_blob_storage`: If you don’t want to use an enclosing character while processing the files, set the value to false. By default, the value is set to true and is considered " as a quote character.
* - Service `box`: If you don’t want to use an enclosing character while processing the files, set the value to false. By default, the value is set to true and is considered " as quote character.
* - Service `dropbox`: If you don’t want to use an enclosing character while processing the files, set the value to false. By default, the value is set to true and is considered " as quote character.
* - Service `email`: If you don’t want to use an enclosing character while processing the files, set the value to false. By default, the value is set to true and is considered " as quote character.
* - Service `ftp`: If you don’t want to use an enclosing character while processing the files, set the value to false. By default, the value is set to true and is considered " as quote character.
* - Service `gcs`: If you don’t want to use an enclosing character while processing the files, set the value to false. By default, the value is set to true and is considered " as quote character.
* - Service `google_drive`: If you don’t want to use an enclosing character while processing the files, set the value to false. By default, the value is set to true and is considered " as quote character.
* - Service `s3`: If you don’t want to use an enclosing character while processing the files, set the value to false. By default, the value is set to true and is considered " as quote character.
* - Service `s3_compatible_storage`: If you don’t want to use an enclosing character while processing the files, set the value to false. By default, the value is set to true and is considered " as quote character.
* - Service `sftp`: If you don’t want to use an enclosing character while processing the files, set the value to false. By default, the value is set to true and is considered " as quote character.
* - Service `share_point`: If you don’t want to use an enclosing character while processing the files, set the value to false. By default, the value is set to true and is considered " as quote character.
*/
quoteCharacterEnabled: boolean;
/**
* Field usage depends on `service` value:
* - Service `sap_hana_db`: SAP System ID (SID)
*/
r3Name: string;
/**
* Field usage depends on `service` value:
* - Service `toggl_track`: Your Toggl Track plan type.
* - Service `vimeo`: Your Vimeo rate limit plan.
*/
rateLimitPlan: string;
/**
* Field usage depends on `service` value:
* - Service `ironsource`: Your Ironsource `Client Secret`.
*/
refreshToken: string;
/**
* Field usage depends on `service` value:
* - Service `pinterest_ads`: The expiration date of the refresh token. Unix timestamp in seconds
*/
refreshTokenExpiresAt: string;
/**
* Field usage depends on `service` value:
* - Service `algolia`: Your Algolia analytics region.
* - Service `alida`: Your Alida region.
* - Service `amazon_ads`: The region used by the Amazon Ads profile.
* - Service `amazon_selling_partner`: The region used by the Amazon Selling Partner profile.
* - Service `anaplan`: Your Anaplan account region
* - Service `appcues`: Your Appcues region.
* - Service `atlassian_ops_genie`: Your company's Osgenie region (usually **company**.opsgenie.com)
* - Service `awin`: Your Awin Region.
* - Service `aws_lambda`: The AWS region code for the DynamoDB instance.
* - Service `bigin_by_zoho_crm`: Your Bigin by Zoho CRM Region
* - Service `brightflag`: Your Brightflag region.
* - Service `concur`: The region.
* - Service `cvent`: Your Cvent region.
* - Service `everflow`: Your Everflow region.
* - Service `exact_online`: Your Exact Online region.
* - Service `getfeedback`: Your GetFeedback region.
* - Service `happyfox`: Your HappyFox region.
* - Service `keypay`: Your KeyPay region.
* - Service `learnupon`: Your LearnUpon region.
* - Service `medallia_agile_research`: Your Medallia Agile region.
* - Service `messagebird`: Your MessageBird Account region.
* - Service `mixpanel`: Data Region
* - Service `navan`: Your Navan region.
* - Service `on24`: Your ON24 region.
* - Service `pendo`: The Pendo account region.
* - Service `proofpoint_security_awareness`: Your Proofpoint Security Awareness Region.
* - Service `recurly`: Your Recurly region.
* - Service `ringover`: Your Ringover region.
* - Service `samsara`: The region of your Samsara account. For instance, if your region is `EUROPE`, provide `eu.samsara` in the `Region` field. If your region is not in Europe, provide `samsara`.
* - Service `snyk`: Your Snyk region.
* - Service `talkdesk`: Your Talkdesk region (".com",".eu","ca.com")
* - Service `totango`: Your Totango region.
* - Service `transcend`: Your Transcend region.
* - Service `vonage_contact_center`: Your Vonage Contact Center region.
* - Service `wasabi_cloud_storage`: The Wasabi Cloud Storage bucket region. Required for connector creation. Default value: `US_EAST_1`.
* - Service `workday_strategic_sourcing`: Your Workday Strategic Sourcing Region.
* - Service `xray`: Your Xray region.
* - Service `zoho_books`: Your Zoho Books application host region.
* - Service `zoho_campaigns`: Your Zoho Campaigns application host region.
* - Service `zoho_desk`: Your Zoho Desk domain.
* - Service `zoho_inventory`: Your Zoho Inventory application host region.
* - Service `zoho_recruit`: Your Zoho Recruit region.
*/
region: string;
/**
* Field usage depends on `service` value:
* - Service `amazon_attribution`: Your Amazon Attribution API URL region.
*/
regionApiUrl: string;
/**
* Field usage depends on `service` value:
* - Service `amazon_attribution`: Your Amazon Attribution auth URL region.
*/
regionAuthUrl: string;
/**
* Field usage depends on `service` value:
* - Service `amazon_attribution`: Your Amazon Attribution token URL region.
*/
regionTokenUrl: string;
/**
* Field usage depends on `service` value:
* - Service `playvox_workforce_management`: Your Playvox Workforce Management region URL.
*/
regionUrl: string;
/**
* Field usage depends on `service` value:
* - Service `aurora`: Unique ID within the MySQL replica set. Must be an integer different from all other master and replica servers within the same group.
* - Service `google_cloud_mysql`: Unique ID within the MySQL replica set. Must be an integer different from all other master and replica servers within the same group.
* - Service `magento_mysql`: Unique ID within the MySQL replica set. Must be an integer different from all other master and replica servers within the same group.
* - Service `magento_mysql_rds`: Unique ID within the MySQL replica set. Must be an integer different from all other master and replica servers within the same group.
* - Service `maria`: Unique ID within the MySQL replica set. Must be an integer different from all other master and replica servers within the same group.
* - Service `maria_azure`: Unique ID within the MySQL replica set. Must be an integer different from all other master and replica servers within the same group.
* - Service `maria_rds`: Unique ID within the MySQL replica set. Must be an integer different from all other master and replica servers within the same group.
* - Service `mysql`: Unique ID within the MySQL replica set. Must be an integer different from all other master and replica servers within the same group.
* - Service `mysql_azure`: Unique ID within the MySQL replica set. Must be an integer different from all other master and replica servers within the same group.
* - Service `mysql_rds`: Unique ID within the MySQL replica set. Must be an integer different from all other master and replica servers within the same group.
*/
replicaId: number;
/**
* Field usage depends on `service` value:
* - Service `aurora_postgres`: Replication slot name. Specify only for `"updated_method": "WAL"` or `"WAL_PGOUTPUT"`.
* - Service `azure_postgres`: Replication slot name. Specify only for `"updated_method": "WAL_PGOUTPUT"`.
* - Service `google_cloud_postgresql`: Replication slot name. Specify only for `"updated_method": "WAL_PGOUTPUT"`.
* - Service `heroku_postgres`: Replication slot name. Specify only for `"updated_method": "WAL_PGOUTPUT"`.
* - Service `postgres`: Replication slot name. Specify only for `"updated_method": "WAL_PGOUTPUT"`.
* - Service `postgres_rds`: Replication slot name. Specify only for `"updated_method": "WAL_PGOUTPUT"`.
*/
replicationSlot: string;
/**
* Field usage depends on `service` value:
* - Service `yahoo_dsp`: Specify the reports you want to sync. This is optional.
*/
reportConfigs: outputs.GetConnectorConfigReportConfig[];
/**
* Field usage depends on `service` value:
* - Service `double_click_campaign_manager`: You can select only one Floodlight Configuration ID per account.
*/
reportConfigurationIds: string[];
/**
* Field usage depends on `service` value:
* - Service `workday`: This is to select report format from JSON and CSV. By default, report format is JSON.
*/
reportFormatType: string;
/**
* Field usage depends on `service` value:
* - Service `pinterest_ads`: Granularity at which reports will be
*/
reportGranularity: string;
/**
* Field usage depends on `service` value:
* - Service `rakutenadvertising`: Your Rakuten Advertising report keys.
*/
reportKeys: string;
/**
* Field usage depends on `service` value:
* - Service `spotify_ads`: The list of reports. Each report corresponds to a table within the schema to which connector will sync the data.
*/
reportLists: outputs.GetConnectorConfigReportList[];
/**
* Field usage depends on `service` value:
* - Service `adyen`: Your Report Service API key.
*/
reportServiceApiKey: string;
reportSuites: string[];
/**
* Field usage depends on `service` value:
* - Service `criteo`: Report Timezone
*/
reportTimezone: string;
/**
* Field usage depends on `service` value:
* - Service `adroll`: The report type you want. Default value: `ALL_ADS`.
* - Service `double_click_campaign_manager`: Type of reporting data to sync. Default value: `STANDARD`.
* - Service `google_display_and_video_360`: The type of the report to create. This is a required parameter when `config_method` is set to `CREATE_NEW`.
* - Service `youtube_analytics`: The name of report of which connector will sync the data.
*/
reportType: string;
/**
* Field usage depends on `service` value:
* - Service `workday`: URL for a live custom report.
*/
reportUrl: string;
/**
* Field usage depends on `service` value:
* - Service `double_click_campaign_manager`: List of reports
* - Service `double_click_publishers`: The list of reports. We create a table within the schema for each report.
* - Service `google_ads`: The list of reports. Each report corresponds to a table within the schema to which connector will sync the data.
* - Service `google_analytics`: The list of reports. Each report corresponds to a table within the schema to which connector will sync the data.
* - Service `google_analytics_4`: The list of reports. Each report corresponds to a table within the schema to which connector will sync the data.
* - Service `google_display_and_video_360`: The list of reports. Each report corresponds to a table within the schema to which connector will sync the data.
* - Service `google_search_ads_360`: The list of reports. Each report corresponds to a table within the schema to which connector syncs the data.
* - Service `google_search_console`: The list of reports. Each report corresponds to a table within the schema to which connector syncs the data.
* - Service `klaviyo`: * custom report(s)
* - Service `workday`: The list of reports. Each report corresponds to a table within the schema to which connector will sync the data.
* - Service `workday_adaptive`: Custom Report
*/
reports: outputs.GetConnectorConfigReport[];
/**
* Field usage depends on `service` value:
* - Service `linkedin_ads`: Specific analytics reports to sync. Must be populated if adAnalytics is set to 'SpecificReports'.
*/
reportsLinkedinAds: string[];
/**
* Field usage depends on `service` value:
* - Service `github`: Specific Repository IDs to sync. Must be populated if `syncMode` is set to `SpecificRepositories`.
*/
repositories: string[];
/**
* Field usage depends on `service` value:
* - Service `cosmos`: A token that provides access to a specific Azure Cosmos DB resource. Required for the `RESOURCE_TOKEN` data access method.
*/
resourceToken: string;
/**
* Field usage depends on `service` value:
* - Service `dynamics_365`: URL at which Dynamics 365 is accessed
*/
resourceUrl: string;
/**
* Field usage depends on `service` value:
* - Service `pardot`: The number of API calls that the connector should not exceed in a day. Default REST API call limit per day: 150,000.
* - Service `pardot_sandbox`: The number of API calls that the connector should not exceed in a day. Default REST API call limit per day: 150,000.
*/
restApiLimit: number;
/**
* Field usage depends on `service` value:
* - Service `hana_sap_hva_ecc_netweaver`: Directory path containing the SAP NetWeaver RFC SDK library files.
* - Service `hana_sap_hva_s4_netweaver`: Directory path containing the SAP NetWeaver RFC SDK library files.
* - Service `oracle_sap_hva_netweaver`: Directory path containing the SAP NetWeaver RFC SDK library files.
*/
rfcLibraryPath: string;
/**
* Field usage depends on `service` value:
* - Service `netsuite_suiteanalytics`: The NetSuite Role ID for connection.
* - Service `snowflake_db`: Snowflake Connector role name
*/
role: string;
/**
* Field usage depends on `service` value:
* - Service `appsflyer`: S3 Role ARN
* - Service `aurora`: The ARN of the IAM role with RDS permissions. Required if the authentication method is `AWS_IAM` in the SaaS Deployment model.
* - Service `aws_cloudtrail`: The Role ARN required for authentication.
* - Service `aws_cost`: The Role ARN required for authentication.
* - Service `aws_cost_report`: The Role ARN required for authentication.
* - Service `aws_inventory`: The Role ARN required for authentication.
* - Service `aws_lambda`: The Role ARN required for authentication.
* - Service `aws_msk`: If `sasl_mechanism` is set to `IAM`, enter your Role ARN
* - Service `cloudfront`: The Role ARN required for authentication.
* - Service `dynamodb`: Role ARN
* - Service `heap`: The Role ARN required for authentication.
* - Service `kinesis`: The Role ARN required for authentication.
* - Service `magento_mysql_rds`: The ARN of the IAM role with RDS permissions. Required if the authentication method is `AWS_IAM` in the SaaS Deployment model.
* - Service `maria_rds`: The ARN of the IAM role with RDS permissions. Required if the authentication method is `AWS_IAM` in the SaaS Deployment model.
* - Service `mysql_rds`: The ARN of the IAM role with RDS permissions. Required if the authentication method is `AWS_IAM` in the SaaS Deployment model.
* - Service `s3`: The Role ARN required for authentication. Required for connector creation when syncing using private bucket.
* - Service `segment`: The Role ARN required for authentication. Must be populated if `sync_type` is set to `S3`.
* - Service `sql_server`: The ARN of the IAM role that has access to the S3 bucket.
*/
roleArn: string;
/**
* Field usage depends on `service` value:
* - Service `appsflyer`: Rollback window
* - Service `servicenow`: Set a rollback window between 0 and 7 days. The default is 0 days.
*/
rollbackWindow: number;
/**
* Field usage depends on `service` value:
* - Service `bingads`: A period of time in days during which a conversion is recorded.
*/
rollbackWindowSize: number;
/**
* Field usage depends on `service` value:
* - Service `oracle_fusion_field_service`: Your Oracle Fusion Field Service rootresourceId.
*/
rootResourceId: string;
/**
* Field usage depends on `service` value:
* - Service `webhooks`: The S3 bucket name. Required if `bucket_service` is set to `S3`.
*/
s3Bucket: string;
/**
* Field usage depends on `service` value:
* - Service `braze`: Your S3 user export bucket. Required if `AWS_S3` is the `export_storage_type`
*/
s3ExportBucket: string;
/**
* Field usage depends on `service` value:
* - Service `braze`: This is the same as your `group_id`, used if `export_storage_type` is `AWS_S3`
*/
s3ExportExternalId: string;
/**
* Field usage depends on `service` value:
* - Service `braze`: Your S3 user export folder name. Required if `AWS_S3` is the `export_storage_type`
*/
s3ExportFolder: string;
/**
* Field usage depends on `service` value:
* - Service `braze`: The Role ARN required for authentication required if `AWS_S3` is the `export_storage_type`
*/
s3ExportRoleArn: string;
/**
* Field usage depends on `service` value:
* - Service `adjust`: Used if the `export_storage_type` is `AWS_S3`, the Role ARN required for authentication.
* - Service `webhooks`: The Role ARN required for authentication. Required if `bucket_service` is set to `S3`.
*/
s3RoleArn: string;
/**
* Field usage depends on `service` value:
* - Service `adobe_analytics_data_feed`: The S3 bucket name.
* - Service `braze`: Your S3 bucket required if `AWS_S3` is the `cloud_storage_type`
* - Service `sailthru`: Name of the bucket configured to receive sailthru connect data.
*/
s3bucket: string;
/**
* Field usage depends on `service` value:
* - Service `braze`: This is the same as your `group_id`, used for authentication along with the `role_arn` required if `AWS_S3` is the `cloud_storage_type`
* - Service `sailthru`: The external ID is a string that designates who can assume the role.
*/
s3externalId: string;
/**
* Field usage depends on `service` value:
* - Service `braze`: Your S3 folder name required if `AWS_S3` is the `cloud_storage_type`
*/
s3folder: string;
/**
* Field usage depends on `service` value:
* - Service `sailthru`: Copy and use this to configure Sailthru Connect in your sailthru account.
*/
s3path: string;
/**
* Field usage depends on `service` value:
* - Service `adobe_analytics_data_feed`: The Role ARN required for authentication.
* - Service `braze`: The Role ARN required for authentication required if `AWS_S3` is the `cloud_storage_type`
* - Service `sailthru`: Role ARN of the IAM role created for Fivetran.
*/
s3roleArn: string;
/**
* Field usage depends on `service` value:
* - Service `itunes_connect`: Whether to sync all sales accounts or specific sales accounts.
*/
salesAccountSyncMode: string;
/**
* Field usage depends on `service` value:
* - Service `itunes_connect`: Specific sales account to sync. Must be populated if `sales_account_sync_mode` is set to `SpecificSalesAccounts`.
*/
salesAccounts: string[];
/**
* Field usage depends on `service` value:
* - Service `pardot`: The Pardot user's Salesforce SSO Account Security Token.
* - Service `pardot_sandbox`: The Pardot user's Salesforce SSO Account Security Token.
*/
salesforceSecurityToken: string;
/**
* Field usage depends on `service` value:
* - Service `gocardless`: Your GoCardless account type.
*/
sandboxAccount: string;
/**
* Field usage depends on `service` value:
* - Service `adobe_experience_platform`: Your Adobe Experience Platform sandbox name.
*/
sandboxName: string;
/**
* Field usage depends on `service` value:
* - Service `sap_hana_db`: SAP Router connection string (format: /H/hostname/S/port)
*/
sapRouter: string;
/**
* Field usage depends on `service` value:
* - Service `db2i_hva`: The SAP schema.
* - Service `db2i_sap_hva`: SAP schema name.
* - Service `sql_server_hva`: SAP Schema Name. Required only for High-Volume Agent SAP ECC connector.
* - Service `sql_server_sap_ecc_hva`: SAP Schema Name.
*/
sapSchema: string;
/**
* Field usage depends on `service` value:
* - Service `hana_sap_hva_b1`: The schema name where the HANA tables reside.
* - Service `hana_sap_hva_ecc`: The Hana schema name where the SAP tables reside.
* - Service `hana_sap_hva_ecc_netweaver`: The Hana schema name where the SAP tables reside.
* - Service `hana_sap_hva_s4`: The Hana schema name where the SAP tables reside.
* - Service `hana_sap_hva_s4_netweaver`: The Hana schema name where the SAP tables reside.
*/
sapSourceSchema: string;
/**
* Field usage depends on `service` value:
* - Service `oracle_sap_hva`: The Oracle schema name where the SAP tables reside.
*/
sapUser: string;
/**
* Field usage depends on `service` value:
* - Service `apache_kafka`: SASL Mechanism
* - Service `aws_msk`: If `security_protocol` is set to `SASL`, enter the SASL Mechanism
*/
saslMechanism: string;
/**
* Field usage depends on `service` value:
* - Service `apache_kafka`: API Key
*/
saslPlainKey: string;
/**
* Field usage depends on `service` value:
* - Service `apache_kafka`: API Secret
*/
saslPlainSecret: string;
/**
* Field usage depends on `service` value:
* - Service `apache_kafka`: API Key
*/
saslScram256Key: string;
/**
* Field usage depends on `service` value:
* - Service `apache_kafka`: API Secret
*/
saslScram256Secret: string;
/**
* Field usage depends on `service` value:
* - Service `apache_kafka`: API Key
* - Service `aws_msk`: If `sasl_mechanism` is set to `SCRAM_SHA_512`, enter your secret's `saslScram512Key`.
*/
saslScram512Key: string;
/**
* Field usage depends on `service` value:
* - Service `apache_kafka`: API Secret
* - Service `aws_msk`: If `sasl_mechanism` is set to `SCRAM_SHA_512`, enter your secret's `saslScram512Key`.
*/
saslScram512Secret: string;
/**
* Field usage depends on `service` value:
* - Service `sap_hana_db`: SAP schema name
*/
schemaName: string;
/**
* Field usage depends on `service` value:
* - Service `apache_kafka`: Schema Registry Credentials source
* - Service `aws_msk`: Schema Registry Credentials source
* - Service `confluent_cloud`: Schema Registry Credentials source
*/
schemaRegistryCredentialsSource: string;
/**
* Field usage depends on `service` value:
* - Service `apache_kafka`: Schema Registry Key
* - Service `aws_msk`: Schema Registry Key
* - Service `azure_service_bus`: The key used to access the schema registry. Required for the `avro` and `protobuf` message types
* - Service `confluent_cloud`: Schema Registry Key
*/
schemaRegistryKey: string;
/**
* Field usage depends on `service` value:
* - Service `apache_kafka`: Schema Registry Secret
* - Service `aws_msk`: Schema Registry Secret
* - Service `azure_service_bus`: The secret used to access the schema registry. Required for the `avro` and `protobuf` message types
* - Service `confluent_cloud`: Schema Registry Secret
*/
schemaRegistrySecret: string;
/**
* Field usage depends on `service` value:
* - Service `apache_kafka`: Your schema registry URLs
* - Service `aws_msk`: Your schema registry URLs
* - Service `azure_service_bus`: The comma-separated list of schema registry servers in the `server:port` format
* - Service `confluent_cloud`: Your schema registry URLs
*/
schemaRegistryUrls: string[];
/**
* Field usage depends on `service` value:
* - Service `ebay`: Your eBay scopes.
*/
scope: string;
/**
* Field usage depends on `service` value:
* - Service `cornerstone`: Your Cornerstone scopes.
* - Service `fortnox`: Your Fortnox app scopes.
*/
scopes: string;
/**
* Field usage depends on `service` value:
* - Service `yahoo_dsp`: Specific Seats to sync. Must be populated if `sync_mode_seat` is set to `SPECIFIC_SEATS`.
*/
seats: string[];
/**
* Field usage depends on `service` value:
* - Service `appcues`: Your Appcues Secret.
* - Service `buildium`: Your Buildium API secret.
* - Service `canvas_data_2_by_instructure`: Your Canvas Data 2 by Instructure secret.
* - Service `loopio`: Your Loopio Secret.
* - Service `mode`: Your Mode Secret.
* - Service `playvox_workforce_management`: Your Playvox Workforce Management client secret.
* - Service `tiktok_organic`: The secret of the app registered in your TikTok developer account.
* - Service `twilio`: The Twilio API secret
* - Service `uservoice`: The UserVoice API secret.
* - Service `venminder`: Your Venminder secret.
* - Service `vts`: Your VTS secret.
*/
secret: string;
/**
* Field usage depends on `service` value:
* - Service `validio`: Your Validio secret access key.
*/
secretAccessKey: string;
/**
* Field usage depends on `service` value:
* - Service `afterpay`: Your Afterpay Secret Key.
* - Service `appsflyer`: Your AWS secret key.
* - Service `bigquery_db`: Private key of the customer service account. If specified, your service account will be used to process the data instead of the Fivetran-managed service account.
* - Service `checkr`: Your Checkr secret key.
* - Service `ezofficeinventory`: Your EZOfficeInventory API secret key.
* - Service `gcs`: Your JSON Private Key. Used to authorize service account. Required if you use a Custom Service Account to authenticate the storage bucket.
* - Service `ironsource`: Your Ironsource `Client ID`.
* - Service `line_ads`: Your LINE Ads secret key.
* - Service `mailjet`: Your Mailjet secret key.
* - Service `partnerstack_vendor`: Your PartnerStack Vendor Secret key.
* - Service `paypal`: `Secret Key` of your PayPal client application.
* - Service `paypal_sandbox`: Secret key of your PayPal client application.
* - Service `phoenix_ads`: Your Phoenix Ads Secret key.
* - Service `retailnext`: Your RetailNext secret key.
* - Service `statsig`: Your Statsig secret key.
* - Service `yotpo`: Your Yotpo Secret key
*/
secretKey: string;
/**
* Field usage depends on `service` value:
* - Service `aws_lambda`: The secrets that should be passed to the function at runtime.
* - Service `azure_function`: The secrets that should be passed to the function at runtime.
* - Service `google_cloud_function`: The secrets that should be passed to the function at runtime.
*/
secrets: string;
/**
* Field usage depends on `service` value:
* - Service `aws_lambda`: List of Secrets that should be passed to the function at runtime.
* - Service `azure_function`: The list of secrets that should be passed to the function at runtime.
* - Service `connector_sdk`: The list of secrets that should be passed to the function at runtime.
* - Service `google_cloud_function`: The list of secrets that should be passed to the function at runtime.
*/
secretsLists: outputs.GetConnectorConfigSecretsList[];
/**
* Field usage depends on `service` value:
* - Service `db2z`: Application secret key registered in RACF for the application. Used to generate a PassTicket when `authentication_method` is `LEGACY_PASS_TICKET` or `ENHANCED_PASS_TICKET`.
*/
securedSignonKey: string;
/**
* Field usage depends on `service` value:
* - Service `apache_kafka`: Security protocol for Kafka interaction.
* - Service `aws_msk`: The security protocol for Kafka interaction.
* - Service `confluent_cloud`: Security protocol for Confluent Cloud interaction.
* - Service `heroku_kafka`: Security protocol for Heroku Kafka interaction.
*/
securityProtocol: string;
/**
* Field usage depends on `service` value:
* - Service `google_analytics`: A segment is a subset of your Analytics data that is made up of one or more non-destructive filters (filters that do not alter the underlying data). Those filters isolate subsets of users, sessions, and hits.
*/
segments: string[];
/**
* Field usage depends on `service` value:
* - Service `salesforce_marketing_cloud`: Select the event types to be synced.
*/
selectedEventTypes: string[];
/**
* Field usage depends on `service` value:
* - Service `anaplan`: The list of export IDs in the format `workspace_id_model_id_export_id` that the connector will sync. Must be populated if `sync_mode` is set to `SpecificExports`.
*/
selectedExports: string[];
/**
* Field usage depends on `service` value:
* - Service `azure_blob_storage`: Cell reference that will be used to sync all contiguous data starting from the top-left cell in all the spreadsheets matching the name. Cell reference is in the `'sheetName'!startColumnNamestartRowName` format.
* - Service `box`: Cell reference that will be used to sync all contiguous data starting from the top-left cell in all the spreadsheets matching the name. Cell reference is in the `'sheetName'!startColumnNamestartRowName` format.
* - Service `dropbox`: Cell reference that will be used to sync all contiguous data starting from the top-left cell in all the spreadsheets matching the name. Cell reference is in the `'sheetName'!startColumnNamestartRowName` format.
* - Service `email`: Cell reference that will be used to sync all contiguous data starting from the top-left cell in all the spreadsheets matching the name. Cell reference is in the `'sheetName'!startColumnNamestartRowName` format.
* - Service `ftp`: Cell reference that will be used to sync all contiguous data starting from the top-left cell in all the spreadsheets matching the name. Cell reference is in the `'sheetName'!startColumnNamestartRowName` format.
* - Service `gcs`: Cell reference that will be used to sync all contiguous data starting from the top-left cell in all the spreadsheets matching the name. Cell reference is in the `'sheetName'!startColumnNamestartRowName` format.
* - Service `s3`: Cell reference that will be used to sync all contiguous data starting from the top-left cell in all the spreadsheets matching the name. Cell reference is in the `'sheetName'!startColumnNamestartRowName` format.
* - Service `sftp`: Cell reference that will be used to sync all contiguous data starting from the top-left cell in all the spreadsheets matching the name. Cell reference is in the `'sheetName'!startColumnNamestartRowName` format.
* - Service `share_point`: Cell reference that will be used to sync all contiguous data starting from the top-left cell in all the spreadsheets matching the name. Cell reference is in the `'sheetName'!startColumnNamestartRowName` format.
*/
selectedRange: string;
/**
* Field usage depends on `service` value:
* - Service `sage_intacct`: Your Sender ID
*/
senderId: string;
/**
* Field usage depends on `service` value:
* - Service `sage_intacct`: Your Sender Password
*/
senderPassword: string;
/**
* Field usage depends on `service` value:
* - Service `castor_edc`: Your Castor EDC server.
*/
server: string;
/**
* Field usage depends on `service` value:
* - Service `tableau_source`: Your Tableau Source server address.
*/
serverAddress: string;
/**
* Field usage depends on `service` value:
* - Service `clockify`: Your Clockify server region.
*/
serverRegion: string;
/**
* Field usage depends on `service` value:
* - Service `oracle_business_intelligence_publisher`: The Oracle Business Intelligence Instance URL.
* - Service `oracle_fusion_cloud_apps_crm`: The Oracle Fusion Cloud Instance URL.
* - Service `oracle_fusion_cloud_apps_fscm`: The Oracle Fusion Cloud Instance URL.
* - Service `oracle_fusion_cloud_apps_hcm`: The Oracle Fusion Cloud Instance URL.
*/
serverUrl: string;
/**
* Field usage depends on `service` value:
* - Service `myosh`: Your myosh server variable.
*/
serverVariable: string;
/**
* Field usage depends on `service` value:
* - Service `apache_kafka`: Comma-separated list of Kafka servers in the format `server:port`.
* - Service `aws_msk`: Comma-separated list of Kafka servers in the `server:port` format.
* - Service `confluent_cloud`: Comma-separated list of Confluent Cloud servers in the format `server:port`.
* - Service `heroku_kafka`: Comma-separated list of Heroku Kafka servers in the format `server:port`.
*/
servers: string[];
/**
* Field usage depends on `service` value:
* - Service `google_drive`: Share the folder with the email address
*/
serviceAccount: string;
/**
* Field usage depends on `service` value:
* - Service `google_cloud_function`: Provide Invoker role to this service account.
*/
serviceAccountEmail: string;
/**
* Field usage depends on `service` value:
* - Service `firebase`: The contents of your service account key file. Required for authentication.
*/
serviceAccountKey: string;
/**
* Field usage depends on `service` value:
* - Service `mixpanel`: Service Account Secret
*/
serviceAccountSecret: string;
/**
* Field usage depends on `service` value:
* - Service `mixpanel`: Service Account Username
*/
serviceAccountUsername: string;
/**
* Field usage depends on `service` value:
* - Service `dsv`: A base64 encoded variant of your `username:password` string. Required for authentication.
*/
serviceAuthentication: string;
/**
* Field usage depends on `service` value:
* - Service `hana_sap_hva_ecc_netweaver`: Unique identifier sapsid of the SAP system. This field is displayed only when the REMOTE SERVICE IDENTIFICATION is set to Service.
* - Service `hana_sap_hva_s4_netweaver`: Unique identifier sapsid of the SAP system. This field is displayed only when the REMOTE SERVICE IDENTIFICATION is set to Service.
* - Service `walmart_marketplace`: Your Walmart Marketplace service name.
*/
serviceName: string;
serviceVersion: string;
/**
* Field usage depends on `service` value:
* - Service `adobe_analytics_data_feed`: SFTP host.
* - Service `salesforce_marketing_cloud`: Host
*/
sftpHost: string;
/**
* Field usage depends on `service` value:
* - Service `adobe_analytics_data_feed`: Log in with key pair or password
* - Service `salesforce_marketing_cloud`: Set this field if you use a key pair for logging into your SFTP server. Don't set it if you use a username and password
*/
sftpIsKeyPair: boolean;
/**
* Field usage depends on `service` value:
* - Service `adobe_analytics_data_feed`: SFTP password required if sftp_is_key_pair is false
* - Service `salesforce_marketing_cloud`: Password
*/
sftpPassword: string;
/**
* Field usage depends on `service` value:
* - Service `adobe_analytics_data_feed`: SFTP port.
* - Service `salesforce_marketing_cloud`: Port
*/
sftpPort: number;
/**
* Field usage depends on `service` value:
* - Service `adobe_analytics_data_feed`: Public Key
* - Service `salesforce_marketing_cloud`: Public Key
*/
sftpPublicKey: string;
/**
* Field usage depends on `service` value:
* - Service `adobe_analytics_data_feed`: SFTP user.
* - Service `salesforce_marketing_cloud`: User
*/
sftpUser: string;
/**
* Field usage depends on `service` value:
* - Service `share_point`: Your SharePoint folder URL. You can find the folder URL by following the steps mentioned [here](https://fivetran.com/docs/connectors/files/share-point/setup-guide).
*/
shareUrl: string;
/**
* Field usage depends on `service` value:
* - Service `google_sheets`: The URL of the sheet that can be copied from the browser address bar, or the ID of the sheet that can be found in the sheet's URL between **/d/** and **/edit**.
*/
sheetId: string;
/**
* Field usage depends on `service` value:
* - Service `shopify`: The Shopify shop name. Can be found in the URL before **.myshopify.com**.
*/
shop: string;
/**
* Field usage depends on `service` value:
* - Service `triple_whale`: Your Triple Whale shop domain.
*/
shopDomain: string;
/**
* Field usage depends on `service` value:
* - Service `salesforce_commerce_cloud`: The Salesforce eight-character string assigned to a realm for routing purposes.
*/
shortCode: string;
/**
* Field usage depends on `service` value:
* - Service `klaviyo`: Sync events linked to deleted profiles
*/
shouldSyncEventsWithDeletedProfiles: boolean;
/**
* Field usage depends on `service` value:
* - Service `netsuite_suiteanalytics`: Re-sync re-import tables during every sync
*/
shouldSyncReimportTables: boolean;
/**
* Field usage depends on `service` value:
* - Service `apple_search_ads`: Turn the toggle on if you want the reports to also return records without metrics.
*/
showRecordsWithNoMetrics: boolean;
/**
* Field usage depends on `service` value:
* - Service `twilio`: The Twilio API key SID
*/
sid: string;
/**
* Field usage depends on `service` value:
* - Service `webhooks`: This is used in HMAC auth method to decode and verify the signature. Supported encodings BASE64 and HEXA_DECIMAL. Default: BASE64
*/
signatureEncoding: string;
/**
* Field usage depends on `service` value:
* - Service `azure_blob_storage`: The contents of the signer's public key file. Must be populated if `use_pgp_encryption_options` is set to `true` and PGP encrypted files are signed.
* - Service `ftp`: The contents of the signer's public key file. Must be populated if `use_pgp_encryption_options` is set to `true` and PGP encrypted files are signed.
* - Service `gcs`: The contents of the signer's public key file. Must be populated if `use_pgp_encryption_options` is set to `true` and PGP encrypted files are signed.
* - Service `s3`: The contents of the signer's public key file. Must be populated if `use_pgp_encryption_options` is set to `true` and PGP encrypted files are signed.
* - Service `s3_compatible_storage`: The contents of the signer's public key file. Must be populated if `use_pgp_encryption_options` is set to `true` and PGP encrypted files are signed.
* - Service `sftp`: The contents of the signer's public key file. Must be populated if `use_pgp_encryption_options` is set to `true` and PGP encrypted files are signed.
* - Service `wasabi_cloud_storage`: The contents of the signer's public key file. Must be populated if `use_pgp_encryption_options` is set to `true` and PGP encrypted files are signed.
*/
signerPublicKey: string;
/**
* Field usage depends on `service` value:
* - Service `teamwork`: Your Teamwork site address.
*/
siteAddress: string;
/**
* Field usage depends on `service` value:
* - Service `microsoft_lists`: The Site ID of the SharePoint site from which you want to sync your lists. The Site ID is the `id` field in the [Graph API](https://docs.microsoft.com/en-us/graph/api/site-search?view=graph-rest-1.0&tabs=http) response for sites.
* - Service `salesforce_commerce_cloud`: The name of the site from which you want to sync data.
*/
siteId: string;
/**
* Field usage depends on `service` value:
* - Service `microsoft_lists`: The Name of the SharePoint site. The Site Name is the `name` field in the Graph API response for sites.
* - Service `tableau_source`: Your Tableau Source site name.
*/
siteName: string;
/**
* Field usage depends on `service` value:
* - Service `google_search_console`: Specific Site URLs to sync. Must be populated if `sync_mode` is set to `SpecificSites`.
*/
siteUrls: string[];
/**
* Field usage depends on `service` value:
* - Service `aws_cost_report`: Enter 1 or greater
* - Service `azure_blob_storage`: We will skip over the number of lines specified at the end so as to not introduce aberrant data into your destination.
* - Service `box`: We will skip over the number of lines specified at the end so as to not introduce aberrant data into your destination.
* - Service `dropbox`: We will skip over the number of lines specified at the end so as to not introduce aberrant data into your destination.
* - Service `email`: We will skip over the number of lines specified at the end so as to not introduce aberrant data into your destination.
* - Service `ftp`: We will skip over the number of lines specified at the end so as to not introduce aberrant data into your destination.
* - Service `gcs`: We will skip over the number of lines specified at the end so as to not introduce aberrant data into your destination.
* - Service `google_drive`: We will skip over the number of lines specified at the end so as to not introduce aberrant data into your destination.
* - Service `kinesis`: Enter 1 or greater
* - Service `s3`: We will skip over the number of lines specified at the end to avoid introducing aberrant data into your destination.
* - Service `s3_compatible_storage`: We will skip over the number of lines specified at the end to avoid introducing aberrant data into your destination.
* - Service `sftp`: We will skip over the number of lines specified at the end so as to not introduce aberrant data into your destination.
* - Service `share_point`: We will skip over the number of lines specified at the end so as to not introduce aberrant data into your destination.
* - Service `wasabi_cloud_storage`: We will skip over the number of lines specified at the end to avoid introducing aberrant data into your destination.
*/
skipAfter: number;
/**
* Field usage depends on `service` value:
* - Service `aws_cost_report`: Enter 1 or greater
* - Service `azure_blob_storage`: We will skip over the number of lines specified before syncing data.
* - Service `box`: We will skip over the number of lines specified before syncing data.
* - Service `dropbox`: We will skip over the number of lines specified before syncing data.
* - Service `email`: We will skip over the number of lines specified before syncing data.
* - Service `ftp`: We will skip over the number of lines specified before syncing data.
* - Service `gcs`: We will skip over the number of lines specified before syncing data.
* - Service `google_drive`: We will skip over the number of lines specified before syncing data.
* - Service `kinesis`: Enter 1 or greater
* - Service `s3`: We will skip over the number of lines specified before syncing data.
* - Service `s3_compatible_storage`: We will skip over the number of lines specified before syncing data.
* - Service `sftp`: We will skip over the number of lines specified before syncing data.
* - Service `share_point`: We will skip over the number of lines specified before syncing data.
* - Service `wasabi_cloud_storage`: We will skip over the number of lines specified before syncing data.
*/
skipBefore: number;
/**
* Field usage depends on `service` value:
* - Service `google_ads`: Toggles the ["Skip empty reports"](https://fivetran.com/docs/connectors/applications/google-ads#skipemptyreports) feature. Enabled by default
*/
skipEmptyReports: boolean;
sncCertificate: string;
sncCertificateSource: string;
sncFivetranName: string;
/**
* Field usage depends on `service` value:
* - Service `hana_sap_hva_ecc_netweaver`: Path to the external security product's library.
* - Service `hana_sap_hva_s4_netweaver`: Path to the external security product's library.
*/
sncLibraryPath: string;
sncMode: string;
sncMyName: string;
/**
* Field usage depends on `service` value:
* - Service `hana_sap_hva_ecc_netweaver`: Client SNC name.
* - Service `hana_sap_hva_s4_netweaver`: Client SNC name.
*/
sncName: string;
/**
* Field usage depends on `service` value:
* - Service `hana_sap_hva_ecc_netweaver`: Communication partner's SNC name.
* - Service `hana_sap_hva_s4_netweaver`: Communication partner's SNC name.
*/
sncPartnerName: string;
sncSourceName: string;
/**
* Field usage depends on `service` value:
* - Service `marketo`: Marketo SOAP API Endpoint (Discontinued).
*/
soapUri: string;
/**
* Field usage depends on `service` value:
* - Service `linkedin_company_pages`: The social data (UGCPosts, Shares, Comments) sync time frame in months. Default value: `SIX` .
*/
socialDataSyncTimeframe: string;
/**
* Field usage depends on `service` value:
* - Service `adobe_analytics_data_feed`: The data source.
*/
source: string;
/**
* Field usage depends on `service` value:
* - Service `microsoft_dynamics_365_fno`: The file type of the source files. Supported file types are `CSV` and `PARQUET`.
*/
sourceFileType: string;
/**
* Field usage depends on `service` value:
* - Service `consensus_demo_automation_platform`: Your Consensus Demo Automation Platform source name.
*/
sourceName: string;
/**
* Field usage depends on `service` value:
* - Service `azure_blob_storage`: The name of the Azure Storage account.
* - Service `microsoft_dynamics_365_fno`: The name of the Azure Storage account.
*/
storageAccountName: string;
/**
* Field usage depends on `service` value:
* - Service `big_commerce`: The [store hash](https://fivetran.com/docs/connectors/applications/big-commerce/setup-guide#createaccesstoken) in your API path.
*/
storeHash: string;
/**
* Field usage depends on `service` value:
* - Service `reviewsio`: Your REVIEWS.io store ID
*/
storeId: string;
/**
* Field usage depends on `service` value:
* - Service `firebase`: List of nested collections to sync. Only specified subCollections can be synced.
*/
subCollections: string[];
/**
* Field usage depends on `service` value:
* - Service `absorb_lms`: Your Absorb LMS subdomain.
* - Service `activecampaign`: Your ActiveCampaign sub-domain.
* - Service `acumatica`: Your Acumatica subdomain.
* - Service `ada`: Your Ada sub-domain.
* - Service `alchemer`: Your Alchemer sub-domain.
* - Service `atlassian_jira_align`: Your Jira Align base URL.
* - Service `azure_boards`: Your Azure Boards Organization Name.
* - Service `azure_devops`: Your Azure Organization Name
* - Service `betterworks`: Your Betterworks subdomain.
* - Service `bubble`: Your Bubble subdomain.
* - Service `buildium`: Your Buildium subdomain.
* - Service `canvas_by_instructure`: Your Canvas by Instructure domain.
* - Service `chargebee_product_catalog_1`: Your Chargebee Product Catalog 1 subdomain.
* - Service `chargebee_product_catalog_2`: Your Chargebee subdomain.
* - Service `checkr`: Your Checkr subdomain.
* - Service `churnzero`: Your ChurnZero subdomain
* - Service `clubspeed`: Your Clubspeed subdomain.
* - Service `collibra`: Your collibra subdomain.
* - Service `compliance_checkpoint`: Your Compliance Checkpoint subdomain.
* - Service `concord`: Your Concord Sub Domain.
* - Service `contrast_security`: Your Contrast Security subdomain.
* - Service `customerio`: Your Customer.io region-specific Subdomain.
* - Service `dbt_cloud`: Your dbt Cloud API server region.
* - Service `deputy`: Your Deputy subdomain.
* - Service `docebo`: Your Docebo subdomain.
* - Service `drata`: Your Drata sub_domain.
* - Service `eventsforce`: Your Eventsforce subdomain.
* - Service `ezofficeinventory`: Your EZOfficeInventory Subdomain.
* - Service `fountain`: Your Fountain subdomain.
* - Service `freshchat`: Your Freshchat Sub Domain
* - Service `gainsight_customer_success`: The subdomain of your Gainsight account.
* - Service `gainsight_product_experience`: Your Gainsight Product Experience subdomain.
* - Service `genesys`: Your Genesys subdomain.
* - Service `green_power_monitor`: Your GreenPowerMonitor subdomain.
* - Service `h_level`: Your HighLevel subdomain.
* - Service `heartland_retail_pos`: Your Heartland Retail POS subdomain.
* - Service `ilevel`: Your iLevel Environment.
* - Service `infobip`: Your Infobip sub_domain.
* - Service `insightly`: Your company's Insightly subdomain name.
* - Service `instructure`: The Sub domain in which your Instructure account is hosted.
* - Service `jamf`: Your Jamf subdomain.
* - Service `kandji`: Your Kandji Subdomain.
* - Service `khoros_care`: Your Khoros Care subDomain.
* - Service `lattice`: Your Lattice subdomain.
* - Service `looker_source`: Your looker SubDomain name.
* - Service `lucca`: Your Lucca subdomain.
* - Service `mailgun`: Your Mailgun subdomain.
* - Service `matomo`: Your Matomo subdomain.
* - Service `maxio_chargify`: Enter Your Subdomain.
* - Service `myosh`: Your myosh subdomain.
* - Service `namely`: Your Namely subdomain.
* - Service `nylas`: Your Nylas subdomain.
* - Service `odoo`: Your Odoo subdomain.
* - Service `okta`: Your Okta subdomain.
* - Service `onetrust`: Your OneTrust subdomain.
* - Service `oracle_fusion_field_service`: Your Oracle Fusion Field Service subDomain.
* - Service `paylocity`: Your Paylocity subdomain.
* - Service `picqer`: Your Picqer subdomain.
* - Service `pinpoint`: Your Pinpoint sub domain name.
* - Service `piwik_pro`: Your Piwik PRO subdomain.
* - Service `playvox`: Your Playvox Subdomain.
* - Service `posthog`: Your PostHog data region (`app` or `eu`).
* - Service `recurly`: Your company's Recurly subdomain.
* - Service `reltio`: Your Reltio subdomain.
* - Service `revel`: Your Revel Systems subDomain.
* - Service `rundeck`: Your Rundeck subdomain.
* - Service `sage_hr`: Your Sage HR subdomain.
* - Service `salesforce_marketing_cloud`: Your Salesforce Marketing Cloud subdomain.
* - Service `salsify`: Your Salsify Organization ID.
* - Service `sap_success_factors`: Your SAP SuccessFactors Subdomain.
* - Service `sonarqube`: Your Sonarqube subdomain.
* - Service `starrez`: Your StarRez subdomain
* - Service `sugarcrm`: Your SugarCRM subdomain.
* - Service `tableau_source`: Your Tableau Source subdomain.
* - Service `tempo`: Your Tempo subdomain.
* - Service `testrail`: Your TestRail subdomain.
* - Service `thinkific`: Your Thinkific subdomain.
* - Service `totango`: Your Totango Subdomain.
* - Service `tymeshift`: Your Tymeshift subdomain.
* - Service `upland`: Your Upland Software subdomain.
* - Service `validio`: Your Validio subdomain.
* - Service `wordpress`: Your WordPress subdomain.
* - Service `workable`: Your Workable Subdomain.
* - Service `wrike`: Your Wrike Subdomain.
*/
subDomain: string;
/**
* Field usage depends on `service` value:
* - Service `adobe_experience_platform`: Your Adobe Experience Platform IMS region.
* - Service `alation`: Your Alation base URL.
* - Service `bamboohr`: The subdomain used to access your account. If you access BambooHR at 'https://mycompany.bamboohr.com', then the subdomain is 'mycompany'.
* - Service `bynder`: Your Bynder subdomain.
* - Service `datadog`: Your Datadog subdomain.
* - Service `ebay`: Your eBay environment.
* - Service `freshdesk`: Your company's freshdesk subdomain (usually **company**.freshdesk.com).
* - Service `freshsales`: Your Freshsales domain.
* - Service `freshservice`: Your company's freshservice subdomain (usually **company**.freshservice.com).
* - Service `freshsuccess`: Your Freshsuccess subdomain.
* - Service `gorgias`: Your Gorgias subdomain.
* - Service `hex`: Your Hex subdomain.
* - Service `ibacos`: Your Ibacos subdomain.
* - Service `jama_software`: Your Jama Software subdomain.
* - Service `klarna`: Your Klarna subdomain.
* - Service `learnupon`: Your LearnUpon subdomain.
* - Service `maxio_saasoptics`: Your Maxio SaaSOptics subdomain.
* - Service `medallia`: Medallia subdomain
* - Service `packiyo`: Your Packiyo subdomain.
* - Service `qmatic_data_connect`: Your Qmatic Data Connect subdomain.
* - Service `sana`: Your Sana subdomain.
* - Service `showpad`: Your Showpad subdomain.
* - Service `skillstx`: Your SkillsTX subdomain.
* - Service `smarthr`: Your SmartHR subdomain.
* - Service `sonarqube`: Your Sonarqube subdomain.
* - Service `toast`: Your Toast domain.
* - Service `uptempo`: Your Uptempo subdomain.
* - Service `vts`: Your VTS Subdomain.
* - Service `yext`: Your Yext subdomain.
* - Service `zendesk_chat`: Your Zendesk domain.
* - Service `zendesk_workforce_management`: Your Zendesk Workforce Management subdomain.
*/
subdomain: string;
/**
* Field usage depends on `service` value:
* - Service `azure_service_bus`: The subscriber name. If the connection string does not have manage permission, you need to specify a subscriber name we can use to fetch data. If not specified, we default to `fivetran_sub_schema`
*/
subscriberName: string;
/**
* Field usage depends on `service` value:
* - Service `retailnext`: Your RetailNext subscription.
*/
subscription: string;
/**
* Field usage depends on `service` value:
* - Service `cabcharge`: Your Cabcharge subscription key.
* - Service `dsv`: Your DSV subscription key.
* - Service `national_heavy_vehicle_regulator`: Your NHVR Portal API subscription key.
*/
subscriptionKey: string;
/**
* Field usage depends on `service` value:
* - Service `stripe`: Sync Connected Accounts. Connected Account Documentation - https://stripe.com/docs/api/connected_accounts.
* - Service `stripe_test`: Sync Connected Accounts. Connected Account Documentation - https://stripe.com/docs/api/connected_accounts.
*/
supportConnectedAccountsSync: boolean;
/**
* Field usage depends on `service` value:
* - Service `workday`: This option is to unpack the nested columns and sync them separately. By default, we sync the nested columns as JSON objects.
*/
supportNestedColumns: boolean;
/**
* Field usage depends on `service` value:
* - Service `qualaroo`: Array of Qualaroo Survey IDs.
*/
surveyIds: string;
/**
* Field usage depends on `service` value:
* - Service `snapchat_ads`: The time period to attribute conversions based on swipes. Default value: `DAY_28`
*/
swipeAttributionWindow: string;
/**
* Field usage depends on `service` value:
* - Service `microsoft_dynamics_365_fno`: Specify if all versions of the records should be synced. If set to `true`, all versions of the records will be synced. If set to `false`, only the latest version of the records will be synced.
*/
syncAllVersions: boolean;
/**
* Field usage depends on `service` value:
* - Service `appsflyer`: Sync AppsFlyer Data Locker. Default value is `true`, set it to `false` to sync AppsFlyer data using only webhooks.
*/
syncDataLocker: boolean;
/**
* Field usage depends on `service` value:
* - Service `webhooks`: The webhooks sync format. Default value: `Unpacked`. Unpacked messages must be valid JSON.
*/
syncFormat: string;
/**
* Field usage depends on `service` value:
* - Service `financial_force`: Enable this option to sync formula fields directly (default value = `false`)
* - Service `salesforce`: Enable this option to sync formula fields directly (default value = `false`)
* - Service `salesforce_sandbox`: Enable this option to sync formula fields directly (default value = `false`)
*/
syncFormulaFields: boolean;
/**
* Field usage depends on `service` value:
* - Service `facebook_ads`: Parameter defining whether to enable or disable metadata synchronisation. Default value: `TRUE`.
*/
syncMetadata: boolean;
/**
* Field usage depends on `service` value:
* - Service `aws_lambda`: Sync Method
*/
syncMethod: string;
/**
* Field usage depends on `service` value:
* - Service `adroll`: Whether to sync all advertisables or specific advertisables. Default value: `AllAdvertisables`.
* - Service `amazon_ads`: Option to select connector should sync all profiles or specific profiles.
* - Service `anaplan`: Whether to sync all exports or specific exports.
* - Service `apple_search_ads`: Sync Mode
* - Service `asana`: Whether to sync all projects or specific projects.
* - Service `bingads`: Whether to sync all accounts or specific accounts. Default value: `AllAccounts`.
* - Service `double_click_campaign_manager`: Whether to sync all user profiles or specific ones. Default value: `AllAccounts`.
* - Service `dynamodb`: Which packed mode setting to use. Default value: `UsePackedModeOnly`.
* - Service `facebook`: Option to select connector should sync all accounts or specific accounts. [Possible sync_mode values](https://fivetran.com/docs/applications/facebook-ad-insights/api-config#syncmode).
* - Service `facebook_ad_account`: Whether to sync all accounts or specific accounts. Default value: `AllAccounts`.
* - Service `facebook_ads`: Option to select connector should sync all accounts or specific accounts. [Possible sync_mode values](https://fivetran.com/docs/connectors/applications/facebook-ads#syncmode).
* - Service `facebook_pages`: Whether to sync all accounts or specific accounts. Default value: `AllPages`.
* - Service `github`: Whether to sync all repositories or specific repositories.
* - Service `google_ads`: Whether to sync all accounts or specific accounts.
* - Service `google_analytics`: Whether to sync all accounts or specific accounts.
* - Service `google_analytics_4`: Whether to sync all accounts or specific accounts.
* - Service `google_analytics_mcf`: Whether to sync all accounts or specific accounts. Default value: `ALL_ACCOUNTS`
* - Service `google_search_console`: Whether to sync all sites or specific sites.
* - Service `instagram_business`: Whether to sync all accounts or specific accounts. Default value: `AllAccounts`.
* - Service `iterable`: Events Sync Mode.
* - Service `jira`: Whether to sync all projects or specific projects.
* - Service `linkedin_ads`: Whether to sync all accounts or specific accounts. Default value: `AllAccounts`
* - Service `pendo`: Whether to sync all App IDs or specific App IDs. Default value: `AllAppIds`.
* - Service `pinterest_ads`: Whether to sync all advertisers or specific advertisers.
* - Service `reddit_ads`: Whether to sync all accounts or specific accounts.
* - Service `salesforce_marketing_cloud`: Select the sync mode.
* - Service `snapchat_ads`: Whether to sync all organizations or specific organizations. Default value: `AllOrganizations`.
* - Service `spotify_ads`: Whether to sync all ad accounts or specific ad accounts.
* - Service `taboola`: Whether to sync all accounts or specific accounts.
* - Service `the_trade_desk`: Whether to sync all accounts or specific accounts.
* - Service `tiktok_ads`: Whether to sync all advertiser accounts or specific accounts.
* - Service `twilio`: Whether to sync all accounts or specific accounts.
* - Service `twitter`: Whether to sync all accounts or specific accounts. Default value: `AllAccounts`.
* - Service `twitter_ads`: Whether to sync all accounts or specific accounts.
* - Service `walmart_dsp`: Whether to sync all accounts or specific accounts.
* - Service `yahoo_gemini`: Whether to sync all accounts or specific accounts. Default value: `SpecificAccounts`.
* - Service `zuora`: Select `Zuora Billing` to sync exclusively Zuora Billing related records. Choose `Zuora Revenue` for syncing only Zuora Revenue reports. If both Zuora Billing records and Zuora Revenue reports are to be synced, opt for `Both`.
* - Service `zuora_sandbox`: Select `Zuora Billing` to sync exclusively Zuora Billing related records. Choose `Zuora Revenue` for syncing only Zuora Revenue reports. If both Zuora Billing records and Zuora Revenue reports are to be synced, opt for `Both`.
*/
syncMode: string;
/**
* Field usage depends on `service` value:
* - Service `yahoo_dsp`: Whether to sync all advertisers or specific advertisers. Default value: `ALL_ADVERTISERS`.
*/
syncModeAdvertiser: string;
/**
* Field usage depends on `service` value:
* - Service `yahoo_dsp`: Whether to sync all seats or specific seats. Default value: `ALL_SEATS`.
*/
syncModeSeat: string;
/**
* Field usage depends on `service` value:
* - Service `reddit_ads`: When this parameter is set to `true`, we sync the data of the additional linked accounts. When this parameter is set to `false`, we sync only the data from the main account that was used for authorization
*/
syncMultipleAccounts: boolean;
/**
* Field usage depends on `service` value:
* - Service `box`: Optional. Set this to true to sync files from nested folders within the specified folder.
* - Service `dropbox`: Optional. Set this to true to sync files from nested folders within the specified folder.
* - Service `google_drive`: Optional. Set to true to sync files from nested folders within the specified folder.
* - Service `sftp`: Optional. Set to true to sync files from nested folders within the specified folder.
* - Service `share_point`: Optional. Set to true to sync files from nested folders within the specified folder.
*/
syncNestedFiles: boolean;
/**
* Field usage depends on `service` value:
* - Service `cosmos`: The packing mode type. Supported values:`STANDARD_UNPACKED_MODE`- Unpacks _one_ layer of nested fields and infers types.`PACKED_MODE`- Delivers packed data as a single destination column value.Learn more in our [Azure Cosmos DB Sync Pack Mode Options documentation](https://fivetran.com/docs/connectors/databases/cosmos#packmodeoptions).
* - Service `documentdb`: Indicates whether synced data will be packed into a single entry(column), or unpacked with one layer of nested fields.
*/
syncPackMode: string;
/**
* Field usage depends on `service` value:
* - Service `google_drive`: Optional. Set to true to sync per-user file access permissions to control visibility in downstream applications.
* - Service `share_point`: Optional. Set to true to sync per-user file access permissions to control visibility in downstream applications.
*/
syncPermissions: boolean;
/**
* Field usage depends on `service` value:
* - Service `appsflyer`: These options are for Appsflyer's Pull API, and are only necessary for syncing events from Pull API.
*/
syncPullApi: boolean;
/**
* Field usage depends on `service` value:
* - Service `google_analytics_4_export`: Sync Table
*/
syncTables: string;
/**
* Field usage depends on `service` value:
* - Service `apache_kafka`: Kafka sync type. Unpacked messages must be valid JSON.
* - Service `aws_msk`: The sync type. Unpacked messages must be valid JSON.
* - Service `azure_event_hub`: Sync type. Unpacked messages must be valid JSON.
* - Service `azure_service_bus`: The sync type, which is based on the message type. For `text` and `xml`, `packed` is supported. For `protobuf` and `avro`, `unpacked` is supported. For `json`, both `packed` and `unpacked` are supported
* - Service `confluent_cloud`: Kafka sync type. Unpacked messages must be valid JSON.
* - Service `heroku_kafka`: Heroku Kafka sync type. Unpacked messages must be valid JSON.
* - Service `segment`: The Segment connector sync type.
*/
syncType: string;
sysnr: string;
/**
* Field usage depends on `service` value:
* - Service `hana_sap_hva_ecc_netweaver`: Unique identifier sapsid of the SAP system. This field is displayed only when the REMOTE SERVICE IDENTIFICATION is set to System ID.
* - Service `hana_sap_hva_s4_netweaver`: Unique identifier sapsid of the SAP system. This field is displayed only when the REMOTE SERVICE IDENTIFICATION is set to System ID.
*/
systemId: string;
/**
* Field usage depends on `service` value:
* - Service `pigment`: Your Pigment table ID.
*/
tableId: string;
/**
* Field usage depends on `service` value:
* - Service `airtable`: Name of table in Airtable
*/
tableName: string;
/**
* Field usage depends on `service` value:
* - Service `hubspot`: Timestamp to indicate when tables without access was updated.
*/
tablesWithoutAccessUpdatedAt: string;
/**
* Field usage depends on `service` value:
* - Service `culture_amp`: Your Culture Amp Target entity ID.
*/
targetEntityId: string;
/**
* Field usage depends on `service` value:
* - Service `d2l_brightspace`: Your D2L Brightspace target host.
*/
targetHost: string;
/**
* Field usage depends on `service` value:
* - Service `sql_server`: Certificate file path used to protect a database encryption key
* - Service `sql_server_hva`: Certificate used to protect a database encryption key
* - Service `sql_server_sap_ecc_hva`: Certificate used to protect a database encryption key
*/
tdeCertificate: string;
/**
* Field usage depends on `service` value:
* - Service `sql_server`: Certificate file used to protect a database encryption key. Used when decrypting backup logs.
*/
tdeCertificateBackup: string;
/**
* Field usage depends on `service` value:
* - Service `sql_server_hva`: Name of the Certificate used to protect a database encryption key
* - Service `sql_server_sap_ecc_hva`: Name of the Certificate used to protect a database encryption key
*/
tdeCertificateName: string;
/**
* Field usage depends on `service` value:
* - Service `sql_server`: Certificate file path used to protect a database encryption key. Used when decrypting online logs
*/
tdeCertificatePath: string;
/**
* Field usage depends on `service` value:
* - Service `sql_server`: Password of the TDE private key
* - Service `sql_server_hva`: Password of the TDE private key
* - Service `sql_server_sap_ecc_hva`: Password of the TDE private key
*/
tdePassword: string;
/**
* Field usage depends on `service` value:
* - Service `sql_server`: Private key file path associated with the TDE certificate
* - Service `sql_server_hva`: Private key associated with the TDE certificate
* - Service `sql_server_sap_ecc_hva`: Private key associated with the TDE certificate
*/
tdePrivateKey: string;
/**
* Field usage depends on `service` value:
* - Service `sql_server`: Private key file associated with the TDE certificate. Used when decrypting backup logs.
*/
tdePrivateKeyBackup: string;
/**
* Field usage depends on `service` value:
* - Service `sql_server`: Private key file path associated with the TDE certificate. Used when decrypting online logs.
*/
tdePrivateKeyPath: string;
/**
* Field usage depends on `service` value:
* - Service `sql_server`: Transparent Data Encryption (TDE) setting. Possible values: `"OFF"`, `"CERTIFICATE"`. Default value is `"OFF"`.
*/
tdeSetting: string;
/**
* Field usage depends on `service` value:
* - Service `oracle_hva`: TDE wallet password. Required for password based wallet.
* - Service `oracle_sap_hva`: TDE wallet password. Required for password based wallet.
* - Service `oracle_sap_hva_netweaver`: TDE wallet password. Required for password based wallet.
*/
tdeWalletPassword: string;
/**
* Field usage depends on `service` value:
* - Service `asana`: Team ID
*/
teamId: string;
/**
* Field usage depends on `service` value:
* - Service `adobe_analytics`: Technical Account ID from the Service Account (JWT) credentials of your Adobe Project.
*/
technicalAccountId: string;
/**
* Field usage depends on `service` value:
* - Service `mandrill`: Provide the labels to filter the templates
*/
templateLabels: string[];
/**
* Field usage depends on `service` value:
* - Service `microsoft_entra_id`: Your Microsoft Entra ID Tenant.
* - Service `microsoft_power_bi`: Your Microsoft Power BI tenant.
* - Service `microsoft_teams`: Your Microsoft Teams Tenant.
* - Service `unicommerce`: Your uniware tenant.
* - Service `workday`: Workday tenant name
* - Service `workday_financial_management`: Workday tenant name
* - Service `workday_hcm`: Workday tenant name
*/
tenant: string;
/**
* Field usage depends on `service` value:
* - Service `planful`: Your Planful tenant app URL.
*/
tenantAppUrl: string;
/**
* Field usage depends on `service` value:
* - Service `deposco`: Your Deposco tenant code.
*/
tenantCode: string;
/**
* Field usage depends on `service` value:
* - Service `reltio`: * tenant(s)
*/
tenantConfigs: outputs.GetConnectorConfigTenantConfig[];
/**
* Field usage depends on `service` value:
* - Service `azure_sql_db`: Azure AD tenant ID.
* - Service `azure_sql_managed_db`: Azure AD tenant ID.
* - Service `business_central`: `Tenant ID` of your Business Central application
* - Service `crowddev`: Your crowd.dev Tenant ID.
* - Service `microsoft_teams`: Your Microsoft Teams tenant ID.
* - Service `reltio`: Your Reltio tenant ID.
* - Service `servicetitan`: Your ServiceTitan tenant ID.
* - Service `share_point`: `Tenant ID` of your Microsoft client application.
* - Service `visma`: Your Visma tenant ID.
*/
tenantId: string;
/**
* Field usage depends on `service` value:
* - Service `mambu`: Your Mambu tenant name.
*/
tenantName: string;
/**
* Field usage depends on `service` value:
* - Service `ivanti`: Your Ivanti Tenant URL.
* - Service `playvox_workforce_management`: Your Playvox Workforce Management tenant URL.
* - Service `reltio`: Your Reltio tenant URL.
*/
tenantUrl: string;
/**
* Field usage depends on `service` value:
* - Service `sap_hana`: testTableName
* - Service `sap_s4hana`: testTableName
*/
testTableName: string;
/**
* Field usage depends on `service` value:
* - Service `pardot`: The time zone configured in your Pardot instance. An empty value defaults to `UTC+00:00`.
* - Service `pardot_sandbox`: The time zone configured in your Pardot instance. An empty value defaults to `UTC+00:00`.
*/
timeZone: string;
/**
* Field usage depends on `service` value:
* - Service `adobe_analytics`: Number of months' worth of reporting data you'd like to include in your initial sync. This cannot be modified once the connector has been created. Default value: `TWELVE` .
* - Service `adroll`: Number of months' worth of reporting data you'd like to include in your initial sync. This cannot be modified once the connector is created. Default value: `TWELVE`.
* - Service `apple_search_ads`: Number of months' worth of reporting data you'd like to include in your initial sync. This cannot be modified once connection is created. NOTE: The more months of reporting data you sync, the longer your initial sync will take.
* - Service `bingads`: Number of months' worth of reporting data you'd like to include in your initial sync. This cannot be modified once the connector is created. Default value: `SIX`.
* - Service `criteo`: The number of months' worth of reporting data you'd like to include in your initial sync. This cannot be modified once the connector is created. NOTE: The greater number of months means the initial sync will take more time.
* - Service `double_click_campaign_manager`: Number of months' worth of reporting data you'd like to include in your initial sync. A change of this value will trigger a re-sync for enabled reports during the next connector sync. Default value: `TWELVE`.
* - Service `double_click_publishers`: Number of months' worth of reporting data you'd like to include in your initial sync. A change of this value will trigger a re-sync for enabled reports during the next connector sync.
* - Service `facebook`: Number of months' worth of reporting data you'd like to include in your initial sync. This cannot be modified once the connector is created. Default value: `THREE`.
* - Service `facebook_ads`: Number of months' worth of reporting data you'd like to include in your initial sync. This cannot be modified once the connector is created. Default value: `THREE`.
* - Service `google_ads`: The number of months' worth of reporting data you'd like to include in your initial sync. A change of this value will trigger a re-sync for enabled custom and prebuilt reports during the next connector sync. Default value: `TWELVE`.
* - Service `google_analytics`: Number of months' worth of reporting data you'd like to include in your initial sync. A change of this value will trigger a re-sync for enabled reports during the next connector sync. The default value: `TWELVE`.
* - Service `google_analytics_4`: The number of months' worth of reporting data you'd like to include in your initial sync. A change of this value will trigger a re-sync for enabled reports during the next connector sync. The default value: `TWELVE`.
* - Service `google_analytics_mcf`: Number of months' worth of reporting data you'd like to include in your initial sync. A change of this value will trigger a re-sync for enabled reports during the next connector sync. Default value: `TWELVE`.
* - Service `google_display_and_video_360`: Number of months' worth of reporting data you'd like to include in your initial sync. A change of this value will trigger a re-sync for enabled reports during the next connector sync. NOTE: The more months of reporting data you sync, the longer your initial sync will take.
* - Service `google_search_ads_360`: Number of months' worth of reporting data you'd like to include in your initial sync. A change of this value will trigger a re-sync for enabled reports during the next connector sync.
* - Service `google_search_console`: Number of months' worth of reporting data you'd like to include in your initial sync. A change of this value will trigger a re-sync for enabled reports during the next connector sync.
* - Service `instagram_business`: Number of months' worth of data you'd like to include in your initial sync. This cannot be modified once the connector is created. Default value: `SIX`.
* - Service `itunes_connect`: Historical sync time frame in months.
* - Service `linkedin_ads`: Number of months for which to query reporting data included in the initial sync. This number cannot be modified once the connector is created. Default value: `ALL_TIME`.
* - Service `outbrain`: Number of months' worth of reporting data you'd like to include in your initial sync. This cannot be modified once connection is created. NOTE: The more months of reporting data you sync, the longer your initial sync will take.
* - Service `pinterest_ads`: Number of months' worth of reporting data you'd like to include in your initial sync. This cannot be modified once the connector is created. Default value: `THREE`.
* - Service `reddit_ads`: Number of months' worth of reporting data you'd like to include in your initial sync. This cannot be modified once the connector is created. Default value: `TWELVE`.
* - Service `snapchat_ads`: Number of months' worth of reporting data you'd like to include in your initial sync. This cannot be modified once the connector is created. Default value: `TWELVE`.
* - Service `spotify_ads`: The number of months' worth of reporting data you'd like to include in your initial sync. This cannot be modified once the connector is created. Default value: `SIX`.
* - Service `taboola`: Number of months' worth of reporting data you'd like to include in your initial sync. This cannot be modified once connection is created. NOTE: The more months of reporting data you sync, the longer your initial sync will take.
* - Service `the_trade_desk`: Number of months' worth of data you'd like to include in your initial sync. This cannot be modified once the connector is created. Default value: `THREE`.
* - Service `tiktok_ads`: Number of months' worth of reporting data you'd like to include in your initial sync. This cannot be modified once the connector is created. Default value: `THREE`.
* - Service `twitter`: Number of months' worth of data you'd like to include in your initial sync. This cannot be modified once the connector is created. Default value: `THREE`.
* - Service `twitter_ads`: Historical sync timeframe in months.
* - Service `walmart_dsp`: Number of months' worth of data you'd like to include in your initial sync. This cannot be modified once the connector is created. Default value: `THREE`.
* - Service `yahoo_dsp`: Number of months` worth of reporting data you'd like to include in your initial sync. This cannot be modified once the connector is created. Default value: `THREE`.
* - Service `yahoo_gemini`: Number of months' worth of reporting data you'd like to include in your initial sync. This cannot be modified once the connector is created. Default value: `TWELVE`.
*/
timeframeMonths: string;
/**
* Field usage depends on `service` value:
* - Service `rokt`: Your Rokt timezone.
*/
timezone: string;
/**
* Field usage depends on `service` value:
* - Service `apple_search_ads`: Determines whether to use UTC or the users timezone from the apple account
*/
timezoneMode: string;
/**
* Field usage depends on `service` value:
* - Service `oracle_hva`: Single-tenant database: The database's SID. Multi-tenant database: The database's TNS.
* - Service `oracle_sap_hva`: Single-tenant database: The database SID. Multi-tenant database: The database TNS.
*/
tns: string;
/**
* Field usage depends on `service` value:
* - Service `toast`: Your Toast Restaurant External ID.
*/
toastId: string;
/**
* Field usage depends on `service` value:
* - Service `khoros_communities`: Your Khoros Communities token.
* - Service `matomo`: Your Matomo auth token.
* - Service `mode`: Your Mode Token.
* - Service `oracle_moat_analytics`: Your Oracle Moat Analytics Token.
* - Service `shareasale`: Your ShareASale token.
* - Service `solarwinds_service_desk`: Your SolarWinds Service Desk token.
*/
token: string;
/**
* Field usage depends on `service` value:
* - Service `cosmos`: The container name. Required for the `RESOURCE_TOKEN` data access method.
*/
tokenAuthenticatedContainer: string;
/**
* Field usage depends on `service` value:
* - Service `cosmos`: The database name. Required for the `RESOURCE_TOKEN` data access method.
*/
tokenAuthenticatedDatabase: string;
/**
* Field usage depends on `service` value:
* - Service `chargedesk`: Your ChargeDesk token ID.
* - Service `mux`: Your Mux token ID
*/
tokenId: string;
/**
* Field usage depends on `service` value:
* - Service `netsuite_suiteanalytics`: Token ID
* - Service `on24`: Your ON24 token key.
* - Service `proofpoint_security_awareness`: Your Proofpoint Security Awareness Token Key.
*/
tokenKey: string;
/**
* Field usage depends on `service` value:
* - Service `netsuite_suiteanalytics`: Token Secret
* - Service `on24`: Your ON24 token secret.
*/
tokenSecret: string;
/**
* Field usage depends on `service` value:
* - Service `mux`: Your Mux token secret key
*/
tokenSecretKey: string;
/**
* Field usage depends on `service` value:
* - Service `amazon_dsp`: Your Amazon DSP token URL region.
*/
tokenUrlRegion: string;
/**
* Field usage depends on `service` value:
* - Service `azure_service_bus`: The comma-separated list of topics which should be synced. Required if you do not have manage permissions
*/
topics: string[];
/**
* Field usage depends on `service` value:
* - Service `dsv`: Your DSV Tracking subscription key.
*/
trackingSubscriptionKey: string;
/**
* Field usage depends on `service` value:
* - Service `heroku_kafka`: Trust Store Type
*/
trustStoreType: string;
/**
* Field usage depends on `service` value:
* - Service `apache_kafka`: Kafka trusted certificate.
* - Service `heroku_kafka`: Heroku Kafka trusted certificate. Required for `TLS` security protocol.
*/
trustedCert: string;
/**
* Field usage depends on `service` value:
* - Service `aws_msk`: If `security_protocol` is set to `TLS`, add the `Truststore File` as Base64 encoded string.
*/
truststore: string;
/**
* Field usage depends on `service` value:
* - Service `aurora`: SSH host, specify only to connect via an SSH tunnel (do not use a load balancer).
* - Service `aurora_postgres`: SSH host, specify only to connect via an SSH tunnel (do not use a load balancer).
* - Service `aveva_pi`: SSH host, specify only to connect via an SSH tunnel (do not use a load balancer).
* - Service `azure_cosmos_for_mongo`: SSH host, specify only to connect via an SSH tunnel (do not use a load balancer).
* - Service `azure_postgres`: SSH host, specify only to connect via an SSH tunnel (do not use a load balancer).
* - Service `azure_sql_db`: SSH host, specify only to connect via an SSH tunnel (do not use a load balancer).
* - Service `azure_sql_managed_db`: SSH host, specify only to connect via an SSH tunnel (do not use a load balancer).
* - Service `clarity`: SSH host, specify only to connect via an SSH tunnel (do not use a load balancer).
* - Service `cockroachdb`: SSH host, specify only to connect via an SSH tunnel (do not use a load balancer).
* - Service `db2i_hva`: SSH host, only specify when connecting via an SSH tunnel (do not use a load balancer). Required for connector creation.
* - Service `db2i_sap_hva`: SSH host, specify only to connect via an SSH tunnel (do not use a load balancer).
* - Service `db2luw`: SSH host, only specify when connecting via an SSH tunnel (do not use a load balancer). Required for connector creation.
* - Service `db2z`: SSH host, specify only to connect via an SSH tunnel (do not use a load balancer).
* - Service `documentdb`: SSH host, only specify when connecting via an SSH tunnel (do not use a load balancer). Required for connector creation.
* - Service `dynamics_365_fo`: SSH host, specify only to connect via an SSH tunnel (do not use a load balancer).
* - Service `ehr`: SSH host, specify only to connect via an SSH tunnel (do not use a load balancer).
* - Service `elastic_cloud`: SSH host, specify only to connect using an SSH tunnel (do not use a load balancer).
* - Service `epic_clarity`: SSH host, specify only to connect via an SSH tunnel (do not use a load balancer).
* - Service `es_self_hosted`: SSH host, specify only to connect using an SSH tunnel (do not use a load balancer).
* - Service `google_cloud_mysql`: SSH host, specify only to connect via an SSH tunnel (do not use a load balancer).
* - Service `google_cloud_postgresql`: SSH host, specify only to connect via an SSH tunnel (do not use a load balancer).
* - Service `google_cloud_sqlserver`: SSH host, only specify when connecting via an SSH tunnel (do not use a load balancer).
* - Service `hana_sap_hva_b1`: SSH host, specify only to connect via an SSH tunnel (do not use a load balancer).
* - Service `hana_sap_hva_ecc`: SSH host, specify only to connect via an SSH tunnel (do not use a load balancer).
* - Service `hana_sap_hva_ecc_netweaver`: SSH host, specify only to connect via an SSH tunnel (do not use a load balancer).
* - Service `hana_sap_hva_s4`: SSH host, specify only to connect via an SSH tunnel (do not use a load balancer).
* - Service `hana_sap_hva_s4_netweaver`: SSH host, specify only to connect via an SSH tunnel (do not use a load balancer).
* - Service `heroku_postgres`: SSH host, specify only to connect via an SSH tunnel (do not use a load balancer).
* - Service `magento_mysql`: SSH host, specify only to connect via an SSH tunnel (do not use a load balancer).
* - Service `magento_mysql_rds`: SSH host, specify only to connect via an SSH tunnel (do not use a load balancer).
* - Service `maria`: SSH host, specify only to connect via an SSH tunnel (do not use a load balancer).
* - Service `maria_azure`: SSH host, specify only to connect via an SSH tunnel (do not use a load balancer).
* - Service `maria_rds`: SSH host, specify only to connect via an SSH tunnel (do not use a load balancer).
* - Service `mongo`: SSH host, specify only to connect via an SSH tunnel (do not use a load balancer).
* - Service `mongo_sharded`: SSH host, specify only to connect via an SSH tunnel (do not use a load balancer).
* - Service `mysql`: SSH host, specify only to connect via an SSH tunnel (do not use a load balancer).
* - Service `mysql_azure`: SSH host, specify only to connect via an SSH tunnel (do not use a load balancer).
* - Service `mysql_rds`: SSH host, specify only to connect via an SSH tunnel (do not use a load balancer).
* - Service `opendistro`: SSH host, specify only to connect using an SSH tunnel (do not use a load balancer).
* - Service `opensearch`: SSH host, specify only to connect using an SSH tunnel (do not use a load balancer).
* - Service `oracle`: SSH host, specify only to connect via an SSH tunnel (do not use a load balancer).
* - Service `oracle_ebs`: SSH host, specify only to connect via an SSH tunnel (do not use a load balancer).
* - Service `oracle_hva`: SSH host, specify only to connect via an SSH tunnel (do not use a load balancer).
* - Service `oracle_rac`: SSH host, specify only to connect via an SSH tunnel (do not use a load balancer).
* - Service `oracle_rds`: SSH host, specify only to connect via an SSH tunnel (do not use a load balancer).
* - Service `oracle_sap_hva`: SSH host, specify only to connect via an SSH tunnel (do not use a load balancer).
* - Service `oracle_sap_hva_netweaver`: SSH host, specify only to connect via an SSH tunnel (do not use a load balancer).
* - Service `postgres`: SSH host, specify only to connect via an SSH tunnel (do not use a load balancer).
* - Service `postgres_rds`: SSH host, specify only to connect via an SSH tunnel (do not use a load balancer).
* - Service `sap_hana`: SSH host, specify only to connect via an SSH tunnel (do not use a load balancer).
* - Service `sap_hana_db`: SSH host, specify only to connect via an SSH tunnel (do not use a load balancer).
* - Service `sap_s4hana`: SSH host, specify only to connect via an SSH tunnel (do not use a load balancer).
* - Service `sftp`: Tunnel host address, specify only to connect via SSH tunnel.
* - Service `sql_server`: SSH host, specify only to connect via an SSH tunnel (do not use a load balancer).
* - Service `sql_server_hva`: SSH host, specify only to connect via an SSH tunnel (do not use a load balancer).
* - Service `sql_server_rds`: SSH host, specify only to connect via an SSH tunnel (do not use a load balancer).
* - Service `sql_server_sap_ecc_hva`: SSH host, specify only to connect via an SSH tunnel (do not use a load balancer).
*/
tunnelHost: string;
/**
* Field usage depends on `service` value:
* - Service `aurora`: SSH port, specify only to connect via an SSH tunnel.
* - Service `aurora_postgres`: SSH port, specify only to connect via an SSH tunnel.
* - Service `aveva_pi`: SSH port, specify only to connect via an SSH tunnel.
* - Service `azure_cosmos_for_mongo`: SSH port, specify only to connect via an SSH tunnel.
* - Service `azure_postgres`: SSH port, specify only to connect via an SSH tunnel.
* - Service `azure_sql_db`: SSH port, specify only to connect via an SSH tunnel.
* - Service `azure_sql_managed_db`: SSH port, specify only to connect via an SSH tunnel.
* - Service `clarity`: SSH port, specify only to connect via an SSH tunnel.
* - Service `cockroachdb`: SSH port, specify only to connect via an SSH tunnel.
* - Service `db2i_hva`: SSH port, only specify when connecting via an SSH tunnel. Required for connector creation.
* - Service `db2i_sap_hva`: SSH port, specify only to connect via an SSH tunnel.
* - Service `db2luw`: SSH port, only specify when connecting via an SSH tunnel. Required for connector creation.
* - Service `db2z`: SSH port, specify only to connect via an SSH tunnel.
* - Service `documentdb`: SSH port, only specify when connecting via an SSH tunnel. Required for connector creation.
* - Service `dynamics_365_fo`: SSH port, specify only to connect via an SSH tunnel.
* - Service `ehr`: SSH port, specify only to connect via an SSH tunnel.
* - Service `elastic_cloud`: SSH port, specify only to connect using an SSH tunnel.
* - Service `epic_clarity`: SSH port, specify only to connect via an SSH tunnel.
* - Service `es_self_hosted`: SSH port, specify only to connect using an SSH tunnel.
* - Service `google_cloud_mysql`: SSH port, specify only to connect via an SSH tunnel.
* - Service `google_cloud_postgresql`: SSH port, specify only to connect via an SSH tunnel.
* - Service `google_cloud_sqlserver`: SSH port, only specify when connecting via an SSH tunnel.
* - Service `hana_sap_hva_b1`: SSH port, specify only to connect via an SSH tunnel.
* - Service `hana_sap_hva_ecc`: SSH port, specify only to connect via an SSH tunnel.
* - Service `hana_sap_hva_ecc_netweaver`: SSH port, specify only to connect via an SSH tunnel.
* - Service `hana_sap_hva_s4`: SSH port, specify only to connect via an SSH tunnel.
* - Service `hana_sap_hva_s4_netweaver`: SSH port, specify only to connect via an SSH tunnel.
* - Service `heroku_postgres`: SSH port, specify only to connect via an SSH tunnel.
* - Service `magento_mysql`: SSH port, specify only to connect via an SSH tunnel.
* - Service `magento_mysql_rds`: SSH port, specify only to connect via an SSH tunnel.
* - Service `maria`: SSH port, specify only to connect via an SSH tunnel.
* - Service `maria_azure`: SSH port, specify only to connect via an SSH tunnel.
* - Service `maria_rds`: SSH port, specify only to connect via an SSH tunnel.
* - Service `mongo`: SSH port, specify only to connect via an SSH tunnel.
* - Service `mongo_sharded`: SSH port, specify only to connect via an SSH tunnel.
* - Service `mysql`: SSH port, specify only to connect via an SSH tunnel.
* - Service `mysql_azure`: SSH port, specify only to connect via an SSH tunnel.
* - Service `mysql_rds`: SSH port, specify only to connect via an SSH tunnel.
* - Service `opendistro`: SSH port, specify only to connect using an SSH tunnel.
* - Service `opensearch`: SSH port, specify only to connect using an SSH tunnel.
* - Service `oracle`: SSH port, specify only to connect via an SSH tunnel.
* - Service `oracle_ebs`: SSH port, specify only to connect via an SSH tunnel.
* - Service `oracle_hva`: SSH port, specify only to connect via an SSH tunnel.
* - Service `oracle_rac`: SSH port, specify only to connect via an SSH tunnel.
* - Service `oracle_rds`: SSH port, specify only to connect via an SSH tunnel.
* - Service `oracle_sap_hva`: SSH port, specify only to connect via an SSH tunnel.
* - Service `oracle_sap_hva_netweaver`: SSH port, specify only to connect via an SSH tunnel.
* - Service `postgres`: SSH port, specify only to connect via an SSH tunnel.
* - Service `postgres_rds`: SSH port, specify only to connect via an SSH tunnel.
* - Service `sap_hana`: SSH port, specify only to connect via an SSH tunnel.
* - Service `sap_hana_db`: SSH port, specify only to connect via an SSH tunnel.
* - Service `sap_s4hana`: SSH port, specify only to connect via an SSH tunnel.
* - Service `sftp`: Tunnel port, specify only to connect via SSH tunnel.
* - Service `sql_server`: SSH port, specify only to connect via an SSH tunnel.
* - Service `sql_server_hva`: SSH port, specify only to connect via an SSH tunnel.
* - Service `sql_server_rds`: SSH port, specify only to connect via an SSH tunnel.
* - Service `sql_server_sap_ecc_hva`: SSH port, specify only to connect via an SSH tunnel.
*/
tunnelPort: number;
/**
* Field usage depends on `service` value:
* - Service `aurora`: SSH user, specify only to connect via an SSH tunnel.
* - Service `aurora_postgres`: SSH user, specify only to connect via an SSH tunnel.
* - Service `aveva_pi`: SSH user, specify only to connect via an SSH tunnel.
* - Service `azure_cosmos_for_mongo`: SSH user, specify only to connect via an SSH tunnel.
* - Service `azure_postgres`: SSH user, specify only to connect via an SSH tunnel.
* - Service `azure_sql_db`: SSH user, specify only to connect via an SSH tunnel.
* - Service `azure_sql_managed_db`: SSH user, specify only to connect via an SSH tunnel.
* - Service `clarity`: SSH user, specify only to connect via an SSH tunnel.
* - Service `cockroachdb`: SSH user, specify only to connect via an SSH tunnel.
* - Service `db2i_hva`: SSH user, specify only to connect via an SSH tunnel. Required for connector creation.
* - Service `db2i_sap_hva`: SSH user, specify only to connect via an SSH tunnel.
* - Service `db2luw`: SSH user, specify only to connect via an SSH tunnel. Required for connector creation.
* - Service `db2z`: SSH user, specify only to connect via an SSH tunnel.
* - Service `documentdb`: SSH user, specify only to connect via an SSH tunnel. Required for connector creation.
* - Service `dynamics_365_fo`: SSH user, specify only to connect via an SSH tunnel.
* - Service `ehr`: SSH user, specify only to connect via an SSH tunnel.
* - Service `elastic_cloud`: SSH user, specify only to connect using an SSH tunnel.
* - Service `epic_clarity`: SSH user, specify only to connect via an SSH tunnel.
* - Service `es_self_hosted`: SSH user, specify only to connect using an SSH tunnel.
* - Service `google_cloud_mysql`: SSH user, specify only to connect via an SSH tunnel.
* - Service `google_cloud_postgresql`: SSH user, specify only to connect via an SSH tunnel.
* - Service `google_cloud_sqlserver`: SSH user, only specify when connecting via an SSH tunnel.
* - Service `hana_sap_hva_b1`: SSH user, specify only to connect via an SSH tunnel.
* - Service `hana_sap_hva_ecc`: SSH user, specify only to connect via an SSH tunnel.
* - Service `hana_sap_hva_ecc_netweaver`: SSH user, specify only to connect via an SSH tunnel.
* - Service `hana_sap_hva_s4`: SSH user, specify only to connect via an SSH tunnel.
* - Service `hana_sap_hva_s4_netweaver`: SSH user, specify only to connect via an SSH tunnel.
* - Service `heroku_postgres`: SSH user, specify only to connect via an SSH tunnel.
* - Service `magento_mysql`: SSH user, specify only to connect via an SSH tunnel.
* - Service `magento_mysql_rds`: SSH user, specify only to connect via an SSH tunnel.
* - Service `maria`: SSH user, specify only to connect via an SSH tunnel.
* - Service `maria_azure`: SSH user, specify only to connect via an SSH tunnel.
* - Service `maria_rds`: SSH user, specify only to connect via an SSH tunnel.
* - Service `mongo`: SSH user, specify only to connect via an SSH tunnel.
* - Service `mongo_sharded`: SSH user, specify only to connect via an SSH tunnel.
* - Service `mysql`: SSH user, specify only to connect via an SSH tunnel.
* - Service `mysql_azure`: SSH user, specify only to connect via an SSH tunnel.
* - Service `mysql_rds`: SSH user, specify only to connect via an SSH tunnel.
* - Service `opendistro`: SSH user, specify only to connect using an SSH tunnel.
* - Service `opensearch`: SSH user, specify only to connect using an SSH tunnel.
* - Service `oracle`: SSH user, specify only to connect via an SSH tunnel.
* - Service `oracle_ebs`: SSH user, specify only to connect via an SSH tunnel.
* - Service `oracle_hva`: SSH user, specify only to connect via an SSH tunnel.
* - Service `oracle_rac`: SSH user, specify only to connect via an SSH tunnel.
* - Service `oracle_rds`: SSH user, specify only to connect via an SSH tunnel.
* - Service `oracle_sap_hva`: SSH user, specify only to connect via an SSH tunnel.
* - Service `oracle_sap_hva_netweaver`: SSH user, specify only to connect via an SSH tunnel.
* - Service `postgres`: SSH user, specify only to connect via an SSH tunnel.
* - Service `postgres_rds`: SSH user, specify only to connect via an SSH tunnel.
* - Service `sap_hana`: SSH user, specify only to connect via an SSH tunnel.
* - Service `sap_hana_db`: SSH user, specify only to connect via an SSH tunnel.
* - Service `sap_s4hana`: SSH user, specify only to connect via an SSH tunnel.
* - Service `sftp`: Tunnel user, specify only to connect via SSH tunnel.
* - Service `sql_server`: SSH user, specify only to connect via an SSH tunnel.
* - Service `sql_server_hva`: SSH user, specify only to connect via an SSH tunnel.
* - Service `sql_server_rds`: SSH user, specify only to connect via an SSH tunnel.
* - Service `sql_server_sap_ecc_hva`: SSH user, specify only to connect via an SSH tunnel.
*/
tunnelUser: string;
/**
* Field usage depends on `service` value:
* - Service `akamai`: Your Akamai type name.
* - Service `bubble`: Your Bubble type name.
*/
typeName: string;
uniqueId: string;
/**
* Field usage depends on `service` value:
* - Service `google_display_and_video_360`: Specifies whether the configuration is updated before each sync or only when the connector settings are saved. This parameter only takes effect when `config_method` is set to `REUSE_EXISTING`. The default value is `true`.
*/
updateConfigOnEachSync: boolean;
/**
* Field usage depends on `service` value:
* - Service `aurora`: The method to detect new or changed rows. Supported values:`BINLOG` - Fivetran uses your binary logs (also called binlogs) to request only the data that has changed since our last sync. This is the default value if no value is specified. `TELEPORT` - Fivetran's proprietary replication method that uses compressed snapshots to detect and apply changes.
* - Service `aurora_postgres`: The method to detect new or changed rows. Specify only for `"service": "postgres"` or `"service": "postgres_rds"`. Supported values:`WAL_PGOUTPUT` - logical replication of the WAL using the pgoutput plugin. This method replicates new, changed, and deleted rows by tailing the write-ahead log (WAL) using a logical slot. This is more efficient than the query-based method, but requires more setup and monitoring.`QUERY_BASED` - this method replicates new, changed and deleted rows via the `xmin` and `ctid` system columns
* - Service `azure_postgres`: The method to detect new or changed rows. Specify only for `"service": "postgres"` or `"service": "postgres_rds"`. Supported values:`WAL_PGOUTPUT` - logical replication of the WAL using the pgoutput plugin. This method replicates new, changed, and deleted rows by tailing the write-ahead log (WAL) using a logical slot. This is more efficient than the query-based method, but requires more setup and monitoring.`QUERY_BASED` - this method replicates new, changed and deleted rows via the `xmin` and `ctid` system columns
* - Service `azure_sql_db`: (Optional) The incremental update method the connector will use. The possible values are `"TELEPORT"` or `"NATIVE_UPDATE"`. The type defaults to `"NATIVE_UPDATE"` if the value is set to `null` or not specified.
* - Service `azure_sql_managed_db`: (Optional) The incremental update method the connector will use. The possible values are `"TELEPORT"` or `"NATIVE_UPDATE"`. The type defaults to `"NATIVE_UPDATE"` if the value is set to `null` or not specified.
* - Service `clarity`: (Optional) The incremental update method the connector will use. The possible values are `"TELEPORT"` or `"NATIVE_UPDATE"`. The type defaults to `"NATIVE_UPDATE"` if the value is set to `null` or not specified.
* - Service `dynamics_365_fo`: Update Method
* - Service `ehr`: (Optional) The incremental update method the connector will use. The possible values are `"TELEPORT"` or `"NATIVE_UPDATE"`. The type defaults to `"NATIVE_UPDATE"` if the value is set to `null` or not specified.
* - Service `epic_clarity`: (Optional) The incremental update method the connector will use. The possible values are `"TELEPORT"` or `"NATIVE_UPDATE"`. The type defaults to `"NATIVE_UPDATE"` if the value is set to `null` or not specified.
* - Service `google_cloud_mysql`: The method to detect new or changed rows. Supported values:`BINLOG` - Fivetran uses your binary logs (also called binlogs) to request only the data that has changed since our last sync. This is the default value if no value is specified. `TELEPORT` - Fivetran's proprietary replication method that uses compressed snapshots to detect and apply changes.
* - Service `google_cloud_postgresql`: The method to detect new or changed rows. Specify only for `"service": "postgres"` or `"service": "postgres_rds"`. Supported values:`WAL_PGOUTPUT` - logical replication of the WAL using the pgoutput plugin. This method replicates new, changed, and deleted rows by tailing the write-ahead log (WAL) using a logical slot. This is more efficient than the query-based method, but requires more setup and monitoring.`QUERY_BASED` - this method replicates new, changed and deleted rows via the `xmin` and `ctid` system columns
* - Service `google_cloud_sqlserver`: (Optional) The incremental update method the connector will use. The possible values are `"TELEPORT"` or `"NATIVE_UPDATE"`. The type defaults to `"NATIVE_UPDATE"` if the value is set to `null` or not specified.
* - Service `heroku_postgres`: The method to detect new or changed rows. Specify only for `"service": "postgres"` or `"service": "postgres_rds"`. Supported values:`WAL_PGOUTPUT` - logical replication of the WAL using the pgoutput plugin. This method replicates new, changed, and deleted rows by tailing the write-ahead log (WAL) using a logical slot. This is more efficient than the query-based method, but requires more setup and monitoring.`QUERY_BASED` - this method replicates new, changed and deleted rows via the `xmin` and `ctid` system columns
* - Service `magento_mysql`: The method to detect new or changed rows. Supported values:`BINLOG` - Fivetran uses your binary logs (also called binlogs) to request only the data that has changed since our last sync. This is the default value if no value is specified. `TELEPORT` - Fivetran's proprietary replication method that uses compressed snapshots to detect and apply changes.
* - Service `magento_mysql_rds`: The method to detect new or changed rows. Supported values:`BINLOG` - Fivetran uses your binary logs (also called binlogs) to request only the data that has changed since our last sync. This is the default value if no value is specified. `TELEPORT` - Fivetran's proprietary replication method that uses compressed snapshots to detect and apply changes.
* - Service `maria`: The method to detect new or changed rows. Supported values:`BINLOG` - Fivetran uses your binary logs (also called binlogs) to request only the data that has changed since our last sync. This is the default value if no value is specified. `TELEPORT` - Fivetran's proprietary replication method that uses compressed snapshots to detect and apply changes.
* - Service `maria_azure`: The method to detect new or changed rows. Supported values:`BINLOG` - Fivetran uses your binary logs (also called binlogs) to request only the data that has changed since our last sync. This is the default value if no value is specified. `TELEPORT` - Fivetran's proprietary replication method that uses compressed snapshots to detect and apply changes.
* - Service `maria_rds`: The method to detect new or changed rows. Supported values:`BINLOG` - Fivetran uses your binary logs (also called binlogs) to request only the data that has changed since our last sync. This is the default value if no value is specified. `TELEPORT` - Fivetran's proprietary replication method that uses compressed snapshots to detect and apply changes.
* - Service `mysql`: The method to detect new or changed rows. Supported values:`BINLOG` - Fivetran uses your binary logs (also called binlogs) to request only the data that has changed since our last sync. This is the default value if no value is specified. `TELEPORT` - Fivetran's proprietary replication method that uses compressed snapshots to detect and apply changes.
* - Service `mysql_azure`: The method to detect new or changed rows. Supported values:`BINLOG` - Fivetran uses your binary logs (also called binlogs) to request only the data that has changed since our last sync. This is the default value if no value is specified. `TELEPORT` - Fivetran's proprietary replication method that uses compressed snapshots to detect and apply changes.
* - Service `mysql_rds`: The method to detect new or changed rows. Supported values:`BINLOG` - Fivetran uses your binary logs (also called binlogs) to request only the data that has changed since our last sync. This is the default value if no value is specified. `TELEPORT` - Fivetran's proprietary replication method that uses compressed snapshots to detect and apply changes.
* - Service `oracle`: The method used to detect new or changed rows. Supported values: - `LOGMINER` - Fivetran uses LogMiner, a utility that is part of Oracle Database, to detect modified rows in the source tables. - `TELEPORT` - Fivetran's proprietary replication method that uses compressed snapshots to detect and apply changes.
* - Service `oracle_ebs`: The method used to detect new or changed rows. Supported values: - `LOGMINER` - Fivetran uses LogMiner, a utility that is part of Oracle Database, to detect modified rows in the source tables. - `TELEPORT` - Fivetran's proprietary replication method that uses compressed snapshots to detect and apply changes.
* - Service `oracle_hva`: The method used to detect new or changed rows. Supported values: - `LOGMINER` - Fivetran uses LogMiner, a utility that is part of Oracle Database, to detect modified rows in the source tables. - `TELEPORT` - Fivetran's proprietary replication method that uses compressed snapshots to detect and apply changes.
* - Service `oracle_rac`: The method used to detect new or changed rows. Supported values: - `LOGMINER` - Fivetran uses LogMiner, a utility that is part of Oracle Database, to detect modified rows in the source tables. - `TELEPORT` - Fivetran's proprietary replication method that uses compressed snapshots to detect and apply changes.
* - Service `oracle_rds`: The method used to detect new or changed rows. Supported values: - `LOGMINER` - Fivetran uses LogMiner, a utility that is part of Oracle Database, to detect modified rows in the source tables. - `TELEPORT` - Fivetran's proprietary replication method that uses compressed snapshots to detect and apply changes.
* - Service `oracle_sap_hva`: The method used to detect new or changed rows. Supported values: - `LOGMINER` - Fivetran uses LogMiner, a utility that is part of Oracle Database, to detect modified rows in the source tables. - `TELEPORT` - Fivetran's proprietary replication method that uses compressed snapshots to detect and apply changes.
* - Service `postgres`: The method to detect new or changed rows. Specify only for `"service": "postgres"` or `"service": "postgres_rds"`. Supported values:`WAL_PGOUTPUT` - logical replication of the WAL using the pgoutput plugin. This method replicates new, changed, and deleted rows by tailing the write-ahead log (WAL) using a logical slot.This is more efficient than the query-based method, but requires more setup and monitoring.`QUERY_BASED` - this method replicates new, changed and deleted rows via the `xmin` and `ctid` system columns
* - Service `postgres_rds`: The method to detect new or changed rows. Specify only for `"service": "postgres"` or `"service": "postgres_rds"`. Supported values:`WAL_PGOUTPUT` - logical replication of the WAL using the pgoutput plugin. This method replicates new, changed, and deleted rows by tailing the write-ahead log (WAL) using a logical slot. This is more efficient than the query-based method, but requires more setup and monitoring.`QUERY_BASED` - this method replicates new, changed and deleted rows via the `xmin` and `ctid` system columns
* - Service `redshift_db`: Default value: `Teleport`
* - Service `snowflake_db`: Default value: `Teleport`
* - Service `sql_server`: (Optional) The incremental update method the connector will use. The possible values are `"TELEPORT"` or `"NATIVE_UPDATE"`. The type defaults to `"NATIVE_UPDATE"` if the value is set to `null` or not specified.
* - Service `sql_server_hva`: (Optional) The incremental update method the connector will use. The possible values are `"TELEPORT"` or `"NATIVE_UPDATE"`. The type defaults to `"NATIVE_UPDATE"` if the value is set to `null` or not specified.
* - Service `sql_server_rds`: (Optional) The incremental update method the connector will use. The possible values are `"TELEPORT"` or `"NATIVE_UPDATE"`. The type defaults to `"NATIVE_UPDATE"` if the value is set to `null` or not specified.
* - Service `sql_server_sap_ecc_hva`: (Optional) The incremental update method the connector will use. The possible values are `"TELEPORT"` or `"NATIVE_UPDATE"`. The type defaults to `"NATIVE_UPDATE"` if the value is set to `null` or not specified.
*/
updateMethod: string;
/**
* Field usage depends on `service` value:
* - Service `cosmos`: Cosmos resource instance address.
*/
uri: string;
/**
* Field usage depends on `service` value:
* - Service `fountain`: Your Fountain URL format.
*/
urlFormat: string;
/**
* Field usage depends on `service` value:
* - Service `mandrill`: Whether to use multiple API keys for interaction.
*/
useApiKeys: boolean;
/**
* Field usage depends on `service` value:
* - Service `amplitude`: Sync events from cloud storage
*/
useCloudStorage: boolean;
/**
* Field usage depends on `service` value:
* - Service `appsflyer`: Use Custom Bucket. Set it to 'true' if the data is being synced to your S3 bucket instead of an AppsFlyer-managed bucket.
*/
useCustomerBucket: boolean;
/**
* Field usage depends on `service` value:
* - Service `sailthru`: Enable this if you want to sync Sailthru Connect using your own" S3 bucket.
*/
useCustomerS3Bucket: boolean;
/**
* Field usage depends on `service` value:
* - Service `pendo`: Toggle field to determine whether connector is syncing from API or from Data Sync
*/
useDataSync: boolean;
/**
* Field usage depends on `service` value:
* - Service `sap_hana_db`: Enable connection via SAP Message Server for load balancing
*/
useMessageServer: boolean;
/**
* Field usage depends on `service` value:
* - Service `oracle_hva`: Default value: `false`. Set to `true` if you're using a RAC instance.
* - Service `oracle_sap_hva`: Default value: `false`. Set to `true` if you're using a RAC instance.
*/
useOracleRac: boolean;
/**
* Field usage depends on `service` value:
* - Service `oracle_hva`: Default value: `false`. Set to `true` to connect directly to a single PDB. When `true`, set `database` to the PDB name and omit the `pdbName` field. Use only for Direct or Archive Log Only capture. Not supported with TDE, ASM, or RAC.
*/
usePdbOnly: boolean;
/**
* Field usage depends on `service` value:
* - Service `azure_blob_storage`: Set to `true` if files present in the Azure Blob Storage container are encrypted using PGP. Default value: `false`.
* - Service `ftp`: Set to `true` if files are encrypted using PGP in the S3 bucket. Default value: `false`.
* - Service `gcs`: Set to `true` if files are encrypted using PGP in the GCS bucket. Default value: `false`.
* - Service `s3`: Set to `true` if files are encrypted using PGP in the S3 bucket. Default value: `false`.
* - Service `s3_compatible_storage`: Set to `true` if files are encrypted using PGP in the S3-Compatible Storage bucket. Default value: `false`.
* - Service `sftp`: Set to `true` if files present in SFTP server are encrypted using PGP. Default value: `false`.
* - Service `wasabi_cloud_storage`: Set to `true` if files are encrypted using PGP in the Wasabi Cloud Storage bucket. Default value: `false`.
*/
usePgpEncryptionOptions: boolean;
/**
* Field usage depends on `service` value:
* - Service `sap_hana_db`: Enable connection via SAP Router
*/
useSapRouter: boolean;
/**
* Field usage depends on `service` value:
* - Service `bigquery_db`: BigQuery use service account; default is false
*/
useServiceAccount: boolean;
/**
* Field usage depends on `service` value:
* - Service `mandrill`: Use template labels to filter templates for sync
*/
useTemplateLabels: boolean;
/**
* Field usage depends on `service` value:
* - Service `github`: Set to `true` to capture deletes.
* - Service `xero`: Updates to few fields like sent_to_contact in Invoice table might be missed if you don't enable this.
*/
useWebhooks: boolean;
/**
* Field usage depends on `service` value:
* - Service `bigquery_db`: Create and drop tables in a query results dataset. Default is false
* - Service `snowflake_db`: Choose a database and schema to create temporary tables for syncs.
*/
useWorkspace: boolean;
/**
* Field usage depends on `service` value:
* - Service `aurora`: The user name.
* - Service `aurora_postgres`: The user name.
* - Service `aveva_pi`: Username for the user to authenticate as with the AF Server
* - Service `azure_cosmos_for_mongo`: Username for source database access.
* - Service `azure_postgres`: The user name.
* - Service `azure_sql_db`: The user name. For Azure Databases, the format must be `user@domain`.
* - Service `azure_sql_managed_db`: The user name. For Azure Databases, the format must be `user@domain`.
* - Service `clarity`: The user name. For Azure Databases, the format must be `user@domain`.
* - Service `cockroachdb`: The user name.
* - Service `db2i_hva`: The user name.
* - Service `db2i_sap_hva`: The username.
* - Service `db2luw`: The user name.
* - Service `db2z`: The user name.
* - Service `documentdb`: The user name.
* - Service `dynamics_365_fo`: The user name. The format must be `user@domain`.
* - Service `ehr`: The user name. For Azure Databases, the format must be `user@domain`.
* - Service `elastic_cloud`: The user name.
* - Service `epic_clarity`: The user name. For Azure Databases, the format must be `user@domain`.
* - Service `es_self_hosted`: The user name.
* - Service `ftp`: FTP user.
* - Service `google_cloud_mysql`: The user name.
* - Service `google_cloud_postgresql`: The user name.
* - Service `google_cloud_sqlserver`: The user name. For Azure Databases, the format must be `user@domain`.
* - Service `hana_sap_hva_b1`: The username.
* - Service `hana_sap_hva_ecc`: The username.
* - Service `hana_sap_hva_ecc_netweaver`: The username.
* - Service `hana_sap_hva_s4`: The username.
* - Service `hana_sap_hva_s4_netweaver`: The username.
* - Service `heroku_postgres`: The user name.
* - Service `jira`: The Jira username.
* - Service `magento_mysql`: The user name.
* - Service `magento_mysql_rds`: The user name.
* - Service `maria`: The user name.
* - Service `maria_azure`: The user name.
* - Service `maria_rds`: The user name.
* - Service `marin`: The Marin username.
* - Service `mongo`: The user name.
* - Service `mongo_sharded`: The user name.
* - Service `mysql`: The user name.
* - Service `mysql_azure`: The user name.
* - Service `mysql_rds`: The user name.
* - Service `opendistro`: The user name.
* - Service `opensearch`: The user name.
* - Service `oracle`: The user name.
* - Service `oracle_ebs`: The user name.
* - Service `oracle_hva`: The user name.
* - Service `oracle_rac`: The user name.
* - Service `oracle_rds`: The user name.
* - Service `oracle_sap_hva`: The username.
* - Service `oracle_sap_hva_netweaver`: The username.
* - Service `outbrain`: The username or email of the Outbrain user.
* - Service `postgres`: The user name.
* - Service `postgres_rds`: The user name.
* - Service `redshift_db`: The Redshift username.
* - Service `sap_hana`: Your SAP HANA user name.
* - Service `sap_s4hana`: Your SAP S/4 user name.
* - Service `sftp`: SFTP user.
* - Service `snowflake_db`: The Snowflake username.
* - Service `splunk`: The Splunk username.
* - Service `sql_server`: The user name. For Azure Databases, the format must be `user@domain`.
* - Service `sql_server_hva`: The user name. For Azure Databases, the format must be `user@domain`.
* - Service `sql_server_rds`: The user name. For Azure Databases, the format must be `user@domain`.
* - Service `sql_server_sap_ecc_hva`: The user name. For Azure Databases, the format must be `user@domain`.
*/
user: string;
/**
* Field usage depends on `service` value:
* - Service `coassemble`: Your Coassemble user ID.
* - Service `gmail`: (DEPRECATED) Your Gmail user ID.
* - Service `hibob`: Your HiBob Service User Token.
* - Service `marketo`: Marketo SOAP API User Id (Discontinued).
* - Service `okendo`: Your Okendo user ID.
* - Service `playvox`: Your Playvox User ID.
* - Service `sage_intacct`: User ID
* - Service `vimeo`: Your Vimeo user ID.
*/
userId: string;
userKey: string;
/**
* Field usage depends on `service` value:
* - Service `workday`: Workday username.
*/
userName: string;
/**
* Field usage depends on `service` value:
* - Service `double_click_campaign_manager`: IDs of specific User Profiles to sync. Must be populated if `sync_mode` is set to `SpecificAccounts`.
*/
userProfiles: string[];
/**
* Field usage depends on `service` value:
* - Service `hibob`: Your HiBob Service User ID.
* - Service `konnect_insights`: Your Konnect Insights User Token.
* - Service `sonarqube`: Your Sonarqube user token.
*/
userToken: string;
/**
* Field usage depends on `service` value:
* - Service `absorb_lms`: Your Absorb LMS username.
* - Service `adobe_commerce`: Your Adobe Commerce username.
* - Service `akeneo`: Your Akeneo username.
* - Service `alida`: Your Alida client ID.
* - Service `amqp`: Username for basic authentication.
* - Service `anaplan`: Your Anaplan user ID. Must be populated if `auth_mode` is set to `Basic`.
* - Service `appfigures`: Your Appfigures Username.
* - Service `aveva_pi`: Username for the user to authenticate as with the AF Server
* - Service `ceridian_dayforce`: Your Ceridian Dayforce username.
* - Service `churnzero`: Your ChurnZero username.
* - Service `cin7`: Your Cin7 API Username.
* - Service `collibra`: Your collibra username.
* - Service `compliance_checkpoint`: Your Compliance Checkpoint account username.
* - Service `concur`: The SAP Concur username.
* - Service `confluence`: Your Confluence username.
* - Service `contrast_security`: Your Contrast Security API Username.
* - Service `dcl_logistics`: Your DCL Logistics username.
* - Service `deposco`: Your Deposco username.
* - Service `github`: `Login` of your GitHub profile.
* - Service `gladly`: Your Gladly Username.
* - Service `globalmeet`: Your GlobalMeet Username.
* - Service `gorgias`: Your Gorgias username.
* - Service `green_power_monitor`: Your GreenPowerMonitor username.
* - Service `guru`: Your Guru username.
* - Service `hilti_ontrack`: Your Hilti On!Track username.
* - Service `impact`: Your Impact Brand Account SID
* - Service `integral_ad_science`: Your integral_ad_science username.
* - Service `itunes_connect`: Your Apple ID
* - Service `jamf`: Your Jamf username.
* - Service `khoros_care`: Your Khoros Care username.
* - Service `kissmetrics`: Your Kissmetrics API Username.
* - Service `klarna`: Your Klarna Username.
* - Service `learnupon`: Your LearnUpon username.
* - Service `lessonly`: Your Lessonly username.
* - Service `mailgun`: Your Mailgun API username.
* - Service `myosh`: Your myosh username.
* - Service `oracle_business_intelligence_publisher`: The Oracle Business Intelligence username.
* - Service `oracle_fusion_cloud_apps_crm`: The Oracle Fusion Cloud username.
* - Service `oracle_fusion_cloud_apps_fscm`: The Oracle Fusion Cloud username.
* - Service `oracle_fusion_cloud_apps_hcm`: The Oracle Fusion Cloud username.
* - Service `partnerize`: Your Partnerize account's username.
* - Service `pingdom`: Your Pingdom Username.
* - Service `podio`: Your Podio account username.
* - Service `qmatic_data_connect`: Your Qmatic Data Connect username.
* - Service `quorum`: Your Quorum username .
* - Service `revx`: Your RevX Username.
* - Service `rtb_house`: Your RTB House username.
* - Service `sap_business_by_design`: The SAP Business ByDesign username.
* - Service `scorm`: Your Scorm App ID.
* - Service `servicenow`: Your ServiceNow User ID (username).
* - Service `servicetrade`: Your ServiceTrade username.
* - Service `shiphero`: Your ShipHero username.
* - Service `shipstation`: Your ShipStation username.
* - Service `shopware`: Your Shopware username.
* - Service `splash`: Your Splash username.
* - Service `starrez`: Your StarRez API username
* - Service `stickyio`: Your sticky.io username .
* - Service `stylight`: Your Stylight Username.
* - Service `sugarcrm`: Your SugarCRM username.
* - Service `teamwork`: Your Teamwork username.
* - Service `testrail`: Your TestRail username.
* - Service `ukg_pro`: Your UKG Pro username.
* - Service `ukg_pro_workforce_management`: Your UKG Pro Workforce Management username.
* - Service `unicommerce`: Your uniware login username.
* - Service `upland`: Your Upland Software username.
* - Service `uptempo`: Your Uptempo username.
* - Service `veeva_vault`: Username
* - Service `veevavault`: Your Veeva Vault username.
* - Service `when_i_work`: Your When I Work username.
* - Service `wherefour`: Your Wherefour username.
* - Service `workday_financial_management`: Workday username.
* - Service `workday_hcm`: Username of your Workday Integration System User account
* - Service `xandr`: Your Xandr username.
* - Service `yougov_brandindex`: Your YouGov BrandIndex username.
* - Service `younium`: Your Younium username.
* - Service `zuora`: The API username with the necessary access permissions.
* - Service `zuora_sandbox`: The API username with the necessary access permissions.
*/
username: string;
/**
* Field usage depends on `service` value:
* - Service `itunes_connect`: Your vendors id
*/
vendorsIds: string[];
/**
* Field usage depends on `service` value:
* - Service `criteo_retail_media`: Your Criteo Retail Media version.
*/
version: string;
/**
* Field usage depends on `service` value:
* - Service `facebook`: Time period to attribute conversions based on views. [Possible view_attribution_window values](https://fivetran.com/docs/applications/facebook-ad-insights/api-config#viewattributionwindow).
* - Service `pinterest_ads`: The number of days to use as the conversion attribution window for a 'view' action.
* - Service `snapchat_ads`: The time period to attribute conversions based on views. Default value: `DAY_1`
*/
viewAttributionWindow: string;
/**
* Field usage depends on `service` value:
* - Service `pigment`: Your Pigment view ID.
*/
viewId: string;
/**
* Field usage depends on `service` value:
* - Service `linkedin_ads`: The time period to attribute conversions based on views. Default value: `DAY_7`
*/
viewThroughAttributionWindowSize: string;
/**
* Field usage depends on `service` value:
* - Service `adyen`: Your Adyen Web Service API key.
*/
webServiceApiKey: string;
/**
* Field usage depends on `service` value:
* - Service `appsflyer`: Webhook Url
*/
webhookEndpoint: string;
/**
* Field usage depends on `service` value:
* - Service `xero`: Webhook Key
*/
webhookKey: string;
/**
* Field usage depends on `service` value:
* - Service `ordway`: Your Ordway Webhook name.
*/
webhookName: string;
/**
* Field usage depends on `service` value:
* - Service `branch`: Webhook URL
* - Service `pipedrive`: The registered URL for webhooks in your Pipedrive dashboard.
* - Service `segment`: Webhook URL.
* - Service `xero`: (ReadOnly) The Webhook URL generated by Fivetran. You can configure this in XERO.
*/
webhookUrl: string;
/**
* Field usage depends on `service` value:
* - Service `woocommerce`: The Site ID of your WordPress hosted WooCommerce instance or the subdomain of your self-hosted WooCommerce instance.
*/
wordPressSiteIdOrWoocommerceDomainName: string;
/**
* Field usage depends on `service` value:
* - Service `moloco`: Your Moloco workplace ID.
*/
workplaceId: string;
/**
* Field usage depends on `service` value:
* - Service `mode`: Your Mode Workspace.
*/
workspace: string;
/**
* Field usage depends on `service` value:
* - Service `fulfil`: Your Fulfil workspace ID.
*/
workspaceId: string;
/**
* Field usage depends on `service` value:
* - Service `bigquery_db`: Workspace Dataset Name
* - Service `snowflake_db`: The name of the database where the temporary tables will be created.
*/
workspaceName: string;
/**
* Field usage depends on `service` value:
* - Service `bigquery_db`: Use the source dataset as the workspace dataset
*/
workspaceSameAsSource: boolean;
/**
* Field usage depends on `service` value:
* - Service `snowflake_db`: The name of the schema that belongs to the workspace database where the temporary tables will be created.
*/
workspaceSchema: string;
/**
* Field usage depends on `service` value:
* - Service `hex`: Your Hex workspace token.
*/
workspaceToken: string;
/**
* Field usage depends on `service` value:
* - Service `adp_workforce_now`: Web Services Certificate.
*/
wsCertificate: string;
/**
* Field usage depends on `service` value:
* - Service `workday_strategic_sourcing`: Your Workday Strategic Sourcing X API key.
*/
xApiKey: string;
/**
* Field usage depends on `service` value:
* - Service `medallia_agile_research`: Your Medallia Agile Research key.
*/
xKey: string;
/**
* Field usage depends on `service` value:
* - Service `medallia_agile_research`: Your Medallia Agile Research master key.
*/
xMasterKey: string;
/**
* Field usage depends on `service` value:
* - Service `workday_strategic_sourcing`: Your Workday Strategic Sourcing X User Email.
*/
xUserEmail: string;
/**
* Field usage depends on `service` value:
* - Service `workday_strategic_sourcing`: Your Workday Strategic Sourcing X User Token.
*/
xUserToken: string;
}
export interface GetConnectorConfigAccountsRedditAd {
/**
* Field usage depends on `service` value:
* - Service `reddit_ads`: Reddit username of the additional linked account.
*/
name: string;
}
export interface GetConnectorConfigAdobeAnalyticsConfiguration {
/**
* Field usage depends on `service` value:
* - Service `adobe_analytics`: The calculated_metrics that you want to sync.
*/
calculatedMetrics: string[];
/**
* Field usage depends on `service` value:
* - Service `adobe_analytics`: The elements that you want to sync.
*/
elements: string[];
/**
* Field usage depends on `service` value:
* - Service `adobe_analytics`: The metrics that you want to sync.
*/
metrics: string[];
/**
* Field usage depends on `service` value:
* - Service `adobe_analytics`: Specific report suites to sync. Must be populated if `sync_mode` is set to `SpecificReportSuites`.
*/
reportSuites: string[];
/**
* Field usage depends on `service` value:
* - Service `adobe_analytics`: The segments that you want to sync.
*/
segments: string[];
/**
* Field usage depends on `service` value:
* - Service `adobe_analytics`: Whether to sync all report suites or specific report suites. Default value: `AllReportSuites` .
*/
syncMode: string;
/**
* Field usage depends on `service` value:
* - Service `adobe_analytics`: The table name unique within the schema to which connector will sync the data. Required for connector creation.
*/
table: string;
}
export interface GetConnectorConfigAppIdsAppsflyer {
/**
* Field usage depends on `service` value:
* - Service `appsflyer`: Your App ID
*/
appId: string;
}
export interface GetConnectorConfigAwsCredentials {
/**
* Field usage depends on `service` value:
* - Service `amplitude`: Your AWS S3 bucket name
* - Service `pendo`: AWS bucket name
*/
bucketName: string;
/**
* Field usage depends on `service` value:
* - Service `amplitude`: Prefix to filter out the data
* - Service `pendo`: AWS home folder
*/
homeFolder: string;
/**
* Field usage depends on `service` value:
* - Service `amplitude`: Role ARN required for authentication
* - Service `pendo`: AWS s3 Role Arn
*/
s3RoleArn: string;
}
export interface GetConnectorConfigAzureCredentials {
/**
* Field usage depends on `service` value:
* - Service `pendo`: Azure connection string
*/
connectionString: string;
/**
* Field usage depends on `service` value:
* - Service `pendo`: Azure container name
*/
containerName: string;
/**
* Field usage depends on `service` value:
* - Service `pendo`: Azure home folder
*/
homeFolder: string;
}
export interface GetConnectorConfigCustomPayload {
/**
* Field usage depends on `service` value:
* - Service `aws_lambda`: Payload Key
* - Service `azure_function`: Payload Key
* - Service `google_cloud_function`: Payload Key
*/
key: string;
/**
* Field usage depends on `service` value:
* - Service `aws_lambda`: Payload Value
* - Service `azure_function`: Payload Value
* - Service `google_cloud_function`: Payload Value
*/
value: string;
}
export interface GetConnectorConfigCustomReport {
/**
* Field usage depends on `service` value:
* - Service `snapchat_ads`: [Determines if reports will be based on imression on coversion time](https://fivetran.com/docs/connectors/applications/snapchat-ads/custom-reports)
*/
actionReportTime: string;
/**
* Field usage depends on `service` value:
* - Service `snapchat_ads`: Add fields for separate \"swipe-up\" and \"view\" variants of selected metrics
*/
addMetricVariants: boolean;
/**
* Field usage depends on `service` value:
* - Service `tiktok_ads`: Time aggregation of report
*/
aggregate: string;
/**
* Field usage depends on `service` value:
* - Service `snapchat_ads`: [List of Core, Additional and Conversion Metrics Stats Fields](https://fivetran.com/docs/connectors/applications/snapchat-ads/custom-reports#basemetricsfields).
*/
baseMetricsFields: string[];
/**
* Field usage depends on `service` value:
* - Service `snapchat_ads`: [Sets Breakdown on custom report](https://fivetran.com/docs/connectors/applications/snapchat-ads/custom-reports#breakdown).
*/
breakdown: string;
/**
* Field usage depends on `service` value:
* - Service `reddit_ads`: Breakdowns are now used instead of level and segmentation. They provide a filter for report data.
*/
breakdowns: string[];
/**
* Field usage depends on `service` value:
* - Service `snapchat_ads`: [Sets Breakout on custom report](https://fivetran.com/docs/connectors/applications/snapchat-ads/custom-reports#breakout).
*/
breakout: string;
/**
* Field usage depends on `service` value:
* - Service `reddit_ads`: The boolean value specifying whether to enable or disable event conversions data synchronisation. Default value: `false`
*/
conversionsReportIncluded: boolean;
/**
* Field usage depends on `service` value:
* - Service `reddit_ads`: The boolean value specifying whether the custom events are included in event conversions report. Default value: `false`
*/
customEventsIncluded: boolean;
/**
* Field usage depends on `service` value:
* - Service `snapchat_ads`: [Sets Dimension on custom report](https://fivetran.com/docs/connectors/applications/snapchat-ads/custom-reports#dimension).
*/
dimension: string;
/**
* Field usage depends on `service` value:
* - Service `tiktok_ads`: Dimensions to synced
*/
dimensions: string[];
/**
* Field usage depends on `service` value:
* - Service `reddit_ads`: The list of events the conversion data will be synchronised for
*/
eventNames: string[];
/**
* Field usage depends on `service` value:
* - Service `snapchat_ads`: [Sets Granularity on custom report](https://fivetran.com/docs/connectors/applications/snapchat-ads/custom-reports#granularity).
*/
granularity: string;
/**
* Field usage depends on `service` value:
* - Service `reddit_ads`: Level of custom report.
*/
level: string;
/**
* Field usage depends on `service` value:
* - Service `tiktok_ads`: Metrics to be synced
*/
metrics: string[];
/**
* Field usage depends on `service` value:
* - Service `reddit_ads`: The list of fields included in custom report
*/
reportFields: string[];
/**
* Field usage depends on `service` value:
* - Service `reddit_ads`: The table name within the schema to which connector syncs the data of the specific report.
* - Service `snapchat_ads`: Custom report name (must be unique)
*/
reportName: string;
/**
* Field usage depends on `service` value:
* - Service `tiktok_ads`: Type of report to be generated
*/
reportType: string;
/**
* Field usage depends on `service` value:
* - Service `reddit_ads`: Level of custom report.
*/
segmentation: string;
/**
* Field usage depends on `service` value:
* - Service `snapchat_ads`: [List of SKAd Metrics fields in custom report](https://fivetran.com/docs/connectors/applications/snapchat-ads/custom-reports#skadmetricsfields).
*/
skAdMetricsFields: string[];
/**
* Field usage depends on `service` value:
* - Service `tiktok_ads`: Destination Table name of report
*/
tableName: string;
/**
* Field usage depends on `service` value:
* - Service `reddit_ads`: The specific time zone to sync report data if `useAccountTimeZone` set to `false`.
*/
timeZone: string;
/**
* Field usage depends on `service` value:
* - Service `reddit_ads`: When this parameter is set to `ACCOUNT`, connector will use account related time zone to sync report data. Default value: `ACCOUNT`. Possible values: `ACCOUNT`, `USER`
*/
timeZoneMode: string;
}
export interface GetConnectorConfigCustomTable {
/**
* Field usage depends on `service` value:
* - Service `facebook_ads`: List of action_breakdowns which connector will sync. [Possible action_breakdowns values](https://fivetran.com/docs/connectors/applications/facebook-ads#actionbreakdowns).
*/
actionBreakdowns: string[];
/**
* Field usage depends on `service` value:
* - Service `facebook_ads`: The report time of action stats. [Possible action_report time values](https://fivetran.com/docs/connectors/applications/facebook-ads#actionreporttime).
*/
actionReportTime: string;
/**
* Field usage depends on `service` value:
* - Service `facebook_ads`: Options to select aggregation duration. [Possible aggregation values](https://fivetran.com/docs/connectors/applications/facebook-ads#aggregation).
*/
aggregation: string;
/**
* Field usage depends on `service` value:
* - Service `facebook_ads`: List of breakdowns which connector will sync. [Possible breakdowns values](https://fivetran.com/docs/connectors/applications/facebook-ads#breakdowns).
*/
breakdowns: string[];
/**
* Field usage depends on `service` value:
* - Service `facebook_ads`: Time period to attribute conversions based on clicks. [Possible click_attribution_window values](https://fivetran.com/docs/connectors/applications/facebook-ads#clickattributionwindow).
*/
clickAttributionWindow: string;
/**
* Field usage depends on `service` value:
* - Service `facebook_ads`: Option to select Prebuilt Reports or Custom Reports. [Possible config_type values](https://fivetran.com/docs/connectors/applications/facebook-ads#configtype).
*/
configType: string;
/**
* Field usage depends on `service` value:
* - Service `facebook_ads`: Time period to attribute conversions based on engaged views. [Possible view_attribution_window values](https://fivetran.com/docs/connectors/applications/facebook-ads#engagedviewattributionwindow).
*/
engagedViewAttributionWindow: string;
/**
* Field usage depends on `service` value:
* - Service `facebook_ads`: List of fields which connector will sync. [Possible field values](https://fivetran.com/docs/connectors/applications/facebook-ads#fields).
*/
fields: string[];
level: string;
/**
* Field usage depends on `service` value:
* - Service `facebook_ads`: The report name to which connector will sync the data. [Possible prebuilt_report values](https://fivetran.com/docs/connectors/applications/facebook-ads#prebuiltreport).
*/
prebuiltReportName: string;
/**
* Field usage depends on `service` value:
* - Service `facebook_ads`: The table name within the schema to which the connector will sync the data. It must be unique within the connector and must comply with [Fivetran's naming conventions](https://fivetran.com/docs/getting-started/core-concepts#namingconventions).
*/
tableName: string;
useUnifiedAttributionSetting: boolean;
/**
* Field usage depends on `service` value:
* - Service `facebook_ads`: Time period to attribute conversions based on views. [Possible view_attribution_window values](https://fivetran.com/docs/connectors/applications/facebook-ads#viewattributionwindow).
*/
viewAttributionWindow: string;
}
export interface GetConnectorConfigDataModelPathAliasList {
/**
* Field usage depends on `service` value:
* - Service `oracle_business_intelligence_publisher`: Schema name
*/
alias: string;
/**
* Field usage depends on `service` value:
* - Service `oracle_business_intelligence_publisher`: Path
*/
path: string;
}
export interface GetConnectorConfigFile {
/**
* Field usage depends on `service` value:
* - Service `azure_blob_storage`: All Files inside of compressed archives with filenames matching this regular expression will be synced.
* - Service `box`: All Files inside of compressed archives with filenames matching this regular expression will be synced.
* - Service `dropbox`: All Files inside of compressed archives with filenames matching this regular expression will be synced.
* - Service `email`: All Files inside of compressed archives with filenames matching this regular expression will be synced.
* - Service `ftp`: All Files inside of compressed archives with filenames matching this regular expression will be synced.
* - Service `gcs`: All Files inside of compressed archives with filenames matching this regular expression will be synced.
* - Service `google_drive`: All Files inside of compressed archives with filenames matching this regular expression will be synced.
* - Service `s3`: All Files inside of compressed archives with filenames matching this regular expression will be synced.
* - Service `s3_compatible_storage`: All Files inside of compressed archives with filenames matching this regular expression will be synced.
* - Service `sftp`: All Files inside of compressed archives with filenames matching this regular expression will be synced.
* - Service `share_point`: All Files inside of compressed archives with filenames matching this regular expression will be synced.
*/
archivePattern: string;
/**
* Field usage depends on `service` value:
* - Service `email`: Only attachments from emails with this subject will be synced. Leave this field blank to sync all attachments.
*/
emailSubject: string;
/**
* Field usage depends on `service` value:
* - Service `azure_blob_storage`: All files in your search path matching this regular expression will be synced per table. We have discontinued this field, and will delete it by August 31, 2025.
* - Service `box`: All files in your search path matching this regular expression will be synced per table.
* - Service `dropbox`: All files in your search path matching this regular expression will be synced per table.
* - Service `email`: All files in your search path matching this regular expression will be synced per table.
* - Service `ftp`: All files in your search path matching this regular expression will be synced per table.
* - Service `gcs`: All files in your search path matching this regular expression will be synced per table.
* - Service `google_drive`: All files in your search path matching this regular expression will be synced per table.
* - Service `s3`: All files in your search path matching this regular expression will be synced per table.
* - Service `s3_compatible_storage`: All files in your search path matching this regular expression will be synced per table.
* - Service `sftp`: All files in your search path matching this regular expression will be synced per table.
* - Service `share_point`: All files in your search path matching this regular expression will be synced per table.
*/
filePattern: string;
/**
* Field usage depends on `service` value:
* - Service `azure_blob_storage`: Cell reference that will be used to sync all contiguous data starting from the top-left cell in all the spreadsheets matching the name. Cell reference is in the `'sheetName'!startColumnNamestartRowNumber` format.
* - Service `box`: Cell reference that will be used to sync all contiguous data starting from the top-left cell in all the spreadsheets matching the name. Cell reference is in the `'sheetName'!startColumnNamestartRowNumber` format.
* - Service `dropbox`: Cell reference that will be used to sync all contiguous data starting from the top-left cell in all the spreadsheets matching the name. Cell reference is in the `'sheetName'!startColumnNamestartRowNumber` format.
* - Service `email`: Cell reference that will be used to sync all contiguous data starting from the top-left cell in all the spreadsheets matching the name. Cell reference is in the `'sheetName'!startColumnNamestartRowNumber` format.
* - Service `ftp`: Cell reference that will be used to sync all contiguous data starting from the top-left cell in all the spreadsheets matching the name. Cell reference is in the `'sheetName'!startColumnNamestartRowNumber` format.
* - Service `gcs`: Cell reference that will be used to sync all contiguous data starting from the top-left cell in all the spreadsheets matching the name. Cell reference is in the `'sheetName'!startColumnNamestartRowNumber` format.
* - Service `google_drive`: Cell reference that will be used to sync all contiguous data starting from the top-left cell in all the spreadsheets matching the name. Cell reference is in the `'sheetName'!startColumnNamestartRowNumber` format.
* - Service `s3`: Cell reference that will be used to sync all contiguous data starting from the top-left cell in all the spreadsheets matching the name. Cell reference is in the `'sheetName'!startColumnNamestartRowNumber` format.
* - Service `s3_compatible_storage`: Cell reference that will be used to sync all contiguous data starting from the top-left cell in all the spreadsheets matching the name. Cell reference is in the `'sheetName'!startColumnNamestartRowNumber` format.
* - Service `sftp`: Cell reference that will be used to sync all contiguous data starting from the top-left cell in all the spreadsheets matching the name. Cell reference is in the `'sheetName'!startColumnNamestartRowNumber` format.
* - Service `share_point`: Cell reference that will be used to sync all contiguous data starting from the top-left cell in all the spreadsheets matching the name. Cell reference is in the `'sheetName'!startColumnNamestartRowNumber` format.
*/
selectedRange: string;
/**
* Field usage depends on `service` value:
* - Service `azure_blob_storage`: All files matching the above pattern will be synced to this table.
* - Service `box`: All files matching the above pattern will be synced to this table.
* - Service `dropbox`: All files matching the above pattern will be synced to this table.
* - Service `email`: All files matching the above pattern will be synced to this table.
* - Service `ftp`: All files matching the above pattern will be synced to this table.
* - Service `gcs`: All files matching the above pattern will be synced to this table.
* - Service `google_drive`: All files matching the above pattern will be synced to this table.
* - Service `s3`: All files matching the above pattern will be synced to this table.
* - Service `s3_compatible_storage`: All files matching the above pattern will be synced to this table.
* - Service `sftp`: All files matching the above pattern will be synced to this table.
* - Service `share_point`: All files matching the above pattern will be synced to this table.
*/
tableName: string;
}
export interface GetConnectorConfigGcsCredentials {
/**
* Field usage depends on `service` value:
* - Service `amplitude`: Your GCS bucket name
* - Service `pendo`: GCS bucket name
*/
bucketName: string;
/**
* Field usage depends on `service` value:
* - Service `amplitude`: Prefix to filter out the data
* - Service `pendo`: GCS home folder
*/
homeFolder: string;
}
export interface GetConnectorConfigProjectCredential {
/**
* Field usage depends on `service` value:
* - Service `amplitude`: The API key of the project.
*/
apiKey: string;
/**
* Field usage depends on `service` value:
* - Service `amplitude`: The project name you wish to use with Fivetran.
*/
project: string;
/**
* Field usage depends on `service` value:
* - Service `amplitude`: The project ID you wish to use with Fivetran.
*/
projectId: string;
/**
* Field usage depends on `service` value:
* - Service `amplitude`: The secret key of the project.
*/
secretKey: string;
}
export interface GetConnectorConfigReport {
/**
* Field usage depends on `service` value:
* - Service `workday_adaptive`: List of accounts to sync for the table, if applicable.
*/
accounts: outputs.GetConnectorConfigReportAccount[];
/**
* Field usage depends on `service` value:
* - Service `double_click_publishers`: Ad unit view for the report.
*/
adUnitView: string;
/**
* Field usage depends on `service` value:
* - Service `google_display_and_video_360`: The list of advertisers to include into a sync. This parameter only takes effect when `config_method` is set to `CREATE_NEW`.
*/
advertisers: string[];
/**
* Field usage depends on `service` value:
* - Service `google_search_console`: (Optional) Aggregation type. Supported only for the `SEARCH_RESULTS` report type
*/
aggregation: string;
/**
* Field usage depends on `service` value:
* - Service `google_search_ads_360`: The report attributes included to sync.
*/
attributes: string[];
/**
* Field usage depends on `service` value:
* - Service `double_click_publishers`: Columns provide all trafficking statistics and revenue information available for the chosen dimensions.
*/
columns: string[];
/**
* Field usage depends on `service` value:
* - Service `google_display_and_video_360`: The report configuration method. Specifies whether a new configuration is defined manually or an existing configuration is reused. The default value is `CREATE_NEW`.
*/
configMethod: string;
/**
* Field usage depends on `service` value:
* - Service `google_analytics`: Whether to use the [Prebuilt Reports or Custom Reports](https://fivetran.com/docs/connectors/applications/google-analytics#schemainformation).
* - Service `google_analytics_4`: Whether to use the Prebuilt Reports or Custom Reports.
*/
configType: string;
/**
* Field usage depends on `service` value:
* - Service `double_click_campaign_manager`: Conversion Dimensions.
*/
conversionDimensions: string[];
/**
* Field usage depends on `service` value:
* - Service `klaviyo`: The ID of the conversion metric.
*/
conversionMetricId: string;
/**
* Field usage depends on `service` value:
* - Service `workday_adaptive`: List of currencies to sync for the table, if applicable.
*/
currency: string;
/**
* Field usage depends on `service` value:
* - Service `google_search_ads_360`: The report custom column IDs included to sync.
*/
customColumnIds: string[];
/**
* Field usage depends on `service` value:
* - Service `double_click_publishers`: The list of custom dimension key IDs included in the report. Custom dimension keys can only be selected with the CUSTOM_DIMENSION dimension.
*/
customDimensionKeyIds: string[];
/**
* Field usage depends on `service` value:
* - Service `double_click_publishers`: The list of custom field IDs included in the report. Custom fields can only be selected with their corresponding dimensions.
*/
customFieldIds: string[];
/**
* Field usage depends on `service` value:
* - Service `double_click_campaign_manager`: Custom Floodlight variables enable you to capture information beyond the basics (visits and revenue) that you can collect with standard parameters in your tags.
*/
customFloodlightVariables: string[];
/**
* Field usage depends on `service` value:
* - Service `double_click_publishers`: Dimension attributes provide additional fields associated with a dimension. Dimension attributes can only be selected with their corresponding dimensions.
*/
dimensionAttributes: string[];
/**
* Field usage depends on `service` value:
* - Service `double_click_campaign_manager`: Report dimensions to include in a sync. The `date` dimension is mandatory for all report types. The `advertiser` dimension is mandatory for the `REACH` report type
* - Service `double_click_publishers`: Report dimensions to include in the sync. The `date` dimension is mandatory for all the report types.
* - Service `google_analytics`: The report dimensions to include into a sync. The `date` dimension is mandatory for all the report types.
* - Service `google_analytics_4`: The report dimensions to include into a sync.
* - Service `google_display_and_video_360`: The report dimensions (filters) to include into a sync. The dimension names are provided in the API format. This is a required parameter when `config_method` is set to `CREATE_NEW`.
* - Service `google_search_console`: The report dimensions included to sync.
* - Service `workday_adaptive`: List of dimensions to sync for the table, if applicable.
*/
dimensions: string[];
/**
* Field usage depends on `service` value:
* - Service `workday`: Dynamic parameter field name
*/
dynamicParameterField: string;
/**
* Field usage depends on `service` value:
* - Service `double_click_campaign_manager`: Specifies whether to enable all reach dimension combinations in the report. Default value: `false`
*/
enableAllDimensionCombinations: boolean;
/**
* Field usage depends on `service` value:
* - Service `workday`: Select this option to enable dynamic report parameters.
*/
enableDynamicParameters: boolean;
/**
* Field usage depends on `service` value:
* - Service `google_ads`: A list of the fields to sync. Must be populated if `config_type` is set to `Custom`.
*/
fields: string[];
/**
* Field usage depends on `service` value:
* - Service `google_analytics`: String parameter restricts the data returned for your report. To use the filter parameter, specify a dimension or metric on which to filter, followed by the filter expression
*/
filter: string;
/**
* Field usage depends on `service` value:
* - Service `google_analytics_4`: The dimension name to filter on.
*/
filterFieldName: string;
/**
* Field usage depends on `service` value:
* - Service `google_analytics_4`: Filter type for reports request. Possible values are INCLUDE and EXCLUDE
*/
filterType: string;
filterValue: string;
/**
* Field usage depends on `service` value:
* - Service `google_analytics_4`: The list of filters to apply to the report data.
* - Service `google_search_console`: The list of filters to be applied to the report.
*/
filters: outputs.GetConnectorConfigReportFilter[];
/**
* Field usage depends on `service` value:
* - Service `workday`: Select this option to generate a Primary Key for reports where no single column or combination of columns can be used to form a Primary Key.
*/
generateFivetranPk: boolean;
/**
* Field usage depends on `service` value:
* - Service `workday_adaptive`: Include zero rows in the table sync.
*/
includeZeroRows: boolean;
/**
* Field usage depends on `service` value:
* - Service `klaviyo`: The interval used in the API calls to retrieve the reports.
*/
interval: string;
/**
* Field usage depends on `service` value:
* - Service `workday_adaptive`: List of levels to sync for the table, if applicable.
*/
levels: outputs.GetConnectorConfigReportLevel[];
/**
* Field usage depends on `service` value:
* - Service `double_click_campaign_manager`: Report metrics to include into a sync.
* - Service `google_analytics`: The report metrics to include into a sync.
* - Service `google_analytics_4`: The report metrics to include into a sync.
* - Service `google_display_and_video_360`: The report metrics to include into a sync. The metric names are provided in the API format. This is a required parameter when `config_method` is set to `CREATE_NEW`.
* - Service `google_search_ads_360`: The report metrics included to sync.
*/
metrics: string[];
/**
* Field usage depends on `service` value:
* - Service `klaviyo`: The name of the custom report. The same name is used to name the table in the destination.
*/
name: string;
/**
* Field usage depends on `service` value:
* - Service `google_display_and_video_360`: The list of partners to include into a sync. This parameter only takes effect when `config_method` is set to `CREATE_NEW`.
*/
partners: string[];
/**
* Field usage depends on `service` value:
* - Service `double_click_campaign_manager`: Per Interaction Dimensions.
*/
perInteractionDimensions: string[];
/**
* Field usage depends on `service` value:
* - Service `google_analytics`: The name of the Prebuilt Report from which the connector will sync the data.
* - Service `google_analytics_4`: The name of the Prebuilt Report from which the connector will sync the data.
*/
prebuiltReport: string;
/**
* Field usage depends on `service` value:
* - Service `workday`: Primary Keys
*/
primaryKeys: string[];
/**
* Field usage depends on `service` value:
* - Service `google_display_and_video_360`: The ID of the query whose configuration you want to reuse. This is a required parameter when `config_method` is set to `REUSE_EXISTING`.
*/
queryId: string;
/**
* Field usage depends on `service` value:
* - Service `double_click_campaign_manager`: You can select only one Floodlight Configuration ID per account.
*/
reportConfigurationIds: string[];
/**
* Field usage depends on `service` value:
* - Service `workday`: This is to select report format from JSON and CSV. By default, report format is JSON.
*/
reportFormatType: string;
/**
* Field usage depends on `service` value:
* - Service `double_click_campaign_manager`: Type of reporting data to sync. Default value: `STANDARD`.
* - Service `google_ads`: The name of the Google Ads report from which the connector will sync the data. [Possible report_type values](https://developers.google.com/adwords/api/docs/appendix/reports#report-types).
* - Service `google_display_and_video_360`: The type of the report to create. This is a required parameter when `config_method` is set to `CREATE_NEW`.
* - Service `google_search_ads_360`: The type of report
* - Service `google_search_console`: The type of report
*/
reportType: string;
/**
* Field usage depends on `service` value:
* - Service `workday`: URL for a live custom report.
*/
reportUrl: string;
/**
* Field usage depends on `service` value:
* - Service `double_click_campaign_manager`: The custom window size for rollback syncs (between 1 and 90).
* - Service `google_analytics_4`: The custom window size for rollback syncs.
* - Service `google_search_ads_360`: The custom window size for rollback syncs (between 2 and 90).
*/
rollbackWindow: number;
/**
* Field usage depends on `service` value:
* - Service `google_search_console`: Search types included to sync. Supported only for the `SEARCH_RESULTS` report type
*/
searchTypes: string[];
segmentIds: string[];
/**
* Field usage depends on `service` value:
* - Service `google_analytics`: A segment is a subset of your Analytics data that is made up of one or more non-destructive filters (filters that do not alter the underlying data). Those filters isolate subsets of users, sessions, and hits.
* - Service `google_search_ads_360`: The report segments included to sync.
*/
segments: string[];
/**
* Field usage depends on `service` value:
* - Service `google_display_and_video_360`: If enabled, the report will be queried separately for each advertiser, and the FILTER_ADVERTISER dimension will be added automatically if not already selected. This parameter only takes effect when `config_method` is set to `CREATE_NEW`. The default value is `false`.
*/
splitByAdvertiser: boolean;
/**
* Field usage depends on `service` value:
* - Service `workday`: Start date
*/
startDate: string;
/**
* Field usage depends on `service` value:
* - Service `workday`: Start date parameter field name
*/
startDateParameterField: string;
/**
* Field usage depends on `service` value:
* - Service `workday_adaptive`: Start month for the table sync, in MM format
*/
startMonth: string;
/**
* Field usage depends on `service` value:
* - Service `workday_adaptive`: Start year for the table sync, in YYYY format
*/
startYear: string;
/**
* Field usage depends on `service` value:
* - Service `klaviyo`: The list of statistics to be retrieved.
*/
statistics: string[];
/**
* Field usage depends on `service` value:
* - Service `workday`: This option is to unpack the nested columns and sync them separately. By default, we sync the nested columns as JSON objects.
*/
supportNestedColumns: boolean;
/**
* Field usage depends on `service` value:
* - Service `workday`: Dynamic report parameters sync strategy
*/
syncStrategy: string;
/**
* Field usage depends on `service` value:
* - Service `double_click_campaign_manager`: Destination table name. It must be unique within this connection and must comply with Fivetran's naming conventions.
* - Service `double_click_publishers`: The name of the table within the schema storing the data for a given report.
* - Service `google_ads`: The table name within the schema to which connector will sync the data of the specific report.
* - Service `google_analytics`: The table name within the schema to which connector will sync the data of the specific report.
* - Service `google_analytics_4`: The table name within the schema to which connector will sync the data of the specific report.
* - Service `google_search_ads_360`: The name of a table within the schema to which connector syncs the data of a given report.
* - Service `google_search_console`: The name of a table within the schema to which connector syncs the data of a given report.
* - Service `workday`: The table name within the schema to which connector will sync the data of the specific report.
* - Service `workday_adaptive`: Table name to be synced.
*/
table: string;
/**
* Field usage depends on `service` value:
* - Service `google_display_and_video_360`: The table name within the schema to which connector will sync the data of the specific report.
*/
tableName: string;
/**
* Field usage depends on `service` value:
* - Service `google_analytics_4`: The report data aggregation time granularity.
*/
timeAggregationGranularity: string;
/**
* Field usage depends on `service` value:
* - Service `klaviyo`: The type of the custom report.
*/
type: string;
/**
* Field usage depends on `service` value:
* - Service `google_display_and_video_360`: Specifies whether the configuration is updated before each sync or only when the connector settings are saved. This parameter only takes effect when `config_method` is set to `REUSE_EXISTING`. The default value is `true`.
*/
updateConfigOnEachSync: boolean;
/**
* Field usage depends on `service` value:
* - Service `workday_adaptive`: Version sync strategy for the table, `SYNC_ALL_AND_NEW_VERSIONS` or `SYNC_SELECT_VERSIONS`.
*/
versionSyncStrategy: string;
/**
* Field usage depends on `service` value:
* - Service `workday_adaptive`: List of versions to sync for the table, if versionSyncStrategy is `SYNC_SELECT_VERSIONS`.
*/
versions: string[];
}
export interface GetConnectorConfigReportAccount {
/**
* Field usage depends on `service` value:
* - Service `workday_adaptive`: Flag to indicate if descendants are included or not.
*/
flag: boolean;
/**
* Field usage depends on `service` value:
* - Service `workday_adaptive`: Account ID and `isAssumption` flag (`true` or `false`) are separated by a comma. The `isAssumption` flag indicates whether the account is used for assumptions.
*/
id: string;
}
export interface GetConnectorConfigReportConfig {
/**
* Field usage depends on `service` value:
* - Service `yahoo_dsp`: Set the value to `PREBUILT` if it's one of the preconfigured reports (see the `prebuilt_report_type` option). Otherwise, set to `CUSTOM`.
*/
configType: string;
/**
* Field usage depends on `service` value:
* - Service `yahoo_dsp`: [Currency](https://developer.yahooinc.com/dsp/api/docs/reporting/payloadspec.html) used in a report. Default value: `USD`.
*/
currency: string;
/**
* Field usage depends on `service` value:
* - Service `yahoo_dsp`: [Dimensions](https://developer.yahooinc.com/dsp/api/docs/reporting/dimensions.html) used in a report. Must be populated if `config_type` is set to `CUSTOM`. PUBLISHER, DESKTOP_OS_DEPRECATED, LINE_TYPE, GOAL_TYPE, BID_REQUEST_AD_SIZE, CHANNEL_TYPE, SITE_NAME, and SITE_GROUP_NAME are deprecated dimension, and shouldn't be used anymore
*/
dimensions: string[];
/**
* Field usage depends on `service` value:
* - Service `yahoo_dsp`: The [granularity](https://developer.yahooinc.com/dsp/api/docs/reporting/range-examples.html#interval-type-id) of data in a report. Default value: `DAY`.
*/
intervalType: string;
/**
* Field usage depends on `service` value:
* - Service `yahoo_dsp`: [Metrics](https://developer.yahooinc.com/dsp/api/docs/reporting/metrics.html) used in a report. Must be populated if `config_type` is set to `CUSTOM`. PUBLISHER_EARNINGS, PUBLISHER_EARNINGS_PERCENTAGE, INVENTORY_ECPM_DEPRECATED, SEAT_TECH_FEE, and SEAT_DATA_FEE are deprecated and shouldn't be used anymore
*/
metrics: string[];
/**
* Field usage depends on `service` value:
* - Service `yahoo_dsp`: Specific report type to sync. Must be populated if `config_type` is set to `PREBUILT`.
*/
prebuiltReportType: string;
/**
* Field usage depends on `service` value:
* - Service `yahoo_dsp`: Table name in destination.
*/
reportName: string;
/**
* Field usage depends on `service` value:
* - Service `yahoo_dsp`: Specify the time zone to be used to request report data
*/
timeZone: string;
/**
* Field usage depends on `service` value:
* - Service `yahoo_dsp`: Use advertiser timezone to request report data.
*/
useAdvertiserTimezone: boolean;
}
export interface GetConnectorConfigReportFilter {
dimension: string;
expression: string;
/**
* Field usage depends on `service` value:
* - Service `google_analytics_4`: The dimension name to filter on.
*/
filterDimension: string;
/**
* Field usage depends on `service` value:
* - Service `google_analytics_4`: Filter type for reports request. Possible values are INCLUDE and EXCLUDE
*/
filterType: string;
/**
* Field usage depends on `service` value:
* - Service `google_analytics_4`: The filter value.
*/
filterValue: string;
/**
* Field usage depends on `service` value:
* - Service `google_analytics_4`: The filter values for EXACT match type.
*/
filterValues: string[];
/**
* Field usage depends on `service` value:
* - Service `google_analytics_4`: The filter match type.
*/
matchType: string;
}
export interface GetConnectorConfigReportLevel {
/**
* Field usage depends on `service` value:
* - Service `workday_adaptive`: Flag to indicate if descendants are included or not.
*/
flag: boolean;
/**
* Field usage depends on `service` value:
* - Service `workday_adaptive`: Level ID to sync.
*/
id: string;
/**
* Field usage depends on `service` value:
* - Service `workday_adaptive`: Flag to indicate if descendants are included or not
*/
includeDescendants: boolean;
}
export interface GetConnectorConfigReportList {
/**
* Field usage depends on `service` value:
* - Service `spotify_ads`: The dimension (entity_type) to sync.
*/
dimension: string;
/**
* Field usage depends on `service` value:
* - Service `spotify_ads`: A list of the fields (metrics) to sync.
*/
fields: string[];
/**
* Field usage depends on `service` value:
* - Service `spotify_ads`: The report granularity.
*/
granularity: string;
/**
* Field usage depends on `service` value:
* - Service `spotify_ads`: The table name within the schema to which connector will sync the data of the specific report.
*/
table: string;
}
export interface GetConnectorConfigSecretsList {
/**
* Field usage depends on `service` value:
* - Service `aws_lambda`: Secret Key.
* - Service `azure_function`: Key
* - Service `connector_sdk`: Key
* - Service `google_cloud_function`: Key
*/
key: string;
/**
* Field usage depends on `service` value:
* - Service `aws_lambda`: Secret Value.
* - Service `azure_function`: Value
* - Service `connector_sdk`: Value
* - Service `google_cloud_function`: Value
*/
value: string;
}
export interface GetConnectorConfigTenantConfig {
/**
* Field usage depends on `service` value:
* - Service `reltio`: Your Reltio subdomain.
*/
subdomain: string;
/**
* Field usage depends on `service` value:
* - Service `reltio`: Your Reltio tenant ID.
*/
tenantId: string;
}
export interface GetConnectorDestinationSchema {
/**
* The connector schema name in destination. Has to be unique within the group (destination). Required for connector creation of services:
* `15five`, `360learning`, `6sense`, `7shifts`, `absorb_lms`, `acculynx`, `activecampaign`, `acumatica`, `ada`, `adform`, `adjust`, `adobe_analytics_data_feed`, `adobe_analytics`, `adobe_commerce`, `adobe_experience_platform`, `adobe_workfront`, `adp_workforce_now`, `adroll`, `adyen`, `affinity`, `afterpay`, `aha`, `aircall`, `akamai`, `akeneo`, `alation`, `alchemer`, `algolia`, `alida`, `amazon_ads`, `amazon_attribution`, `amazon_dsp`, `amazon_selling_partner`, `amplitude`, `amqp`, `anaplan`, `anvyl`, `apache_kafka`, `apollo`, `appcues`, `appfigures`, `apple_search_ads`, `applovin`, `appsflyer`, `asana`, `ascend_by_partnerize`, `ashby`, `assembled`, `asset_panda`, `atlassian_jira_align`, `atlassian_ops_genie`, `attentive`, `attio`, `aumni`, `aura_from_unity`, `auth0`, `autodesk_bim_360`, `avantlink`, `aveva_pi`, `awin`, `aws_cloudtrail`, `aws_cost_report`, `aws_cost`, `aws_inventory`, `aws_lambda`, `aws_msk`, `azure_blob_storage`, `azure_boards`, `azure_devops`, `azure_event_hub`, `azure_function`, `azure_service_bus`, `backbone_plm`, `ballotready`, `bamboohr`, `bazaarvoice`, `betterworks`, `big_commerce`, `bigin_by_zoho_crm`, `bigmarker`, `billing_platform`, `bing_webmaster_tools`, `bingads`, `birdeye`, `bitly`, `bizzabo_app`, `bizzabo_v2`, `bizzabo`, `boostr`, `box`, `braintree_sandbox`, `braintree`, `branch`, `brave_ads`, `braze`, `brevo`, `brex`, `brightcove`, `brightflag`, `brightpearl`, `brivo`, `bubble`, `buildium`, `buildkite`, `business_central`, `buzzsprout`, `bynder`, `cabcharge`, `calabrio`, `calendly`, `callrail`, `campaignmonitor`, `campfire`, `canny`, `canvas_by_instructure`, `canvas_data_2_by_instructure`, `care_quality_commission`, `castor_edc`, `centra`, `ceridian_dayforce`, `chameleon`, `channel_advisor`, `chargebee_product_catalog_1`, `chargebee_product_catalog_2`, `chargedesk`, `charthop`, `chartmogul`, `checkout`, `checkr`, `chorusai`, `churnkey`, `churnzero`, `cimis`, `cin7`, `cin7core`, `circleci`, `cj_commission_detail`, `clari`, `classy`, `clazar`, `clickup`, `clockify`, `clockodo`, `close`, `cloudbeds`, `cloudflare_analytics`, `cloudfront`, `cloudtalk`, `clubspeed`, `coalesce`, `coassemble`, `codefresh`, `coheris`, `collibra`, `column`, `commercetools`, `compliance_checkpoint`, `concord`, `concur`, `confluence`, `confluent_cloud`, `connector_sdk`, `consensus_demo_automation_platform`, `constant_contact`, `contrast_security`, `convex`, `copper`, `cornerstone`, `coupa`, `credly`, `criteo_retail_media`, `criteo`, `crossbeam`, `crowddev`, `crunchbase`, `cube_software`, `cube`, `culture_amp`, `customerio`, `cvent`, `d2l_brightspace`, `datadog`, `datastreamer_source`, `dbt_cloud`, `dcl_logistics`, `dear`, `delighted`, `deposco`, `deputy`, `destini`, `device_magic`, `dialpad`, `discourse`, `dixa`, `docebo`, `donus`, `doorloop`, `double_click_campaign_manager`, `double_click_publishers`, `drata`, `drift`, `drip`, `dropbox_sign`, `dropbox`, `dsv`, `duoplane`, `dutchie`, `dynamics_365`, `dynamodb`, `easypost`, `ebay`, `economic`, `elastic_cloud`, `electronic_tenant_solutions`, `eloqua`, `email`, `employment_hero`, `es_self_hosted`, `eventbrite`, `eventsforce`, `everflow`, `everhour`, `exact_online`, `expensein`, `expensify`, `ezofficeinventory`, `facebook_ad_account`, `facebook_ads`, `facebook_pages`, `facebook`, `factbird`, `factorial`, `fillout`, `financial_force`, `firebase`, `fireflies`, `firehydrant`, `fivetran_log`, `flexport`, `float`, `flywheel_digital`, `fone_dynamics`, `forethought`, `forj_community`, `formstack`, `fortnox`, `fountain`, `fourkites`, `freightview`, `freshbooks`, `freshchat`, `freshdesk_contact_center`, `freshdesk`, `freshsales`, `freshservice`, `freshsuccess`, `freshteam`, `friendbuy`, `front`, `ftp`, `fulfil`, `fullstory`, `g2`, `gainsight_customer_success`, `gainsight_product_experience`, `gcs`, `gem`, `genesys`, `getfeedback`, `github`, `gitlab`, `gladly`, `globalmeet`, `gmail`, `gocardless`, `gofundme_pro`, `goldcast`, `gongio`, `google_ads`, `google_analytics_360`, `google_analytics_4_export`, `google_analytics_4`, `google_analytics_mcf`, `google_analytics`, `google_business_profile`, `google_calendar`, `google_classroom`, `google_cloud_function`, `google_display_and_video_360`, `google_drive`, `google_play`, `google_search_ads_360`, `google_search_console`, `google_sheets`, `google_tasks`, `gorgias`, `green_power_monitor`, `greenhouse`, `grepsr`, `grin`, `guru`, `h_level`, `hana_sap_hva_ecc_netweaver`, `hana_sap_hva_s4_netweaver`, `happyfox`, `harvest`, `healthie`, `heap`, `heartland_retail_pos`, `height`, `helpdesk`, `helpjuice`, `helpscout`, `helpshift`, `heroku_kafka`, `hex`, `hibob`, `higher_logic_vanilla`, `hilti_ontrack`, `hopin`, `hubspot`, `ibacos`, `ilevel`, `impact_partner`, `impact`, `incidentio`, `infobip`, `insightly`, `instagram_business`, `instructure`, `integral_ad_science`, `integrate`, `intercom`, `invoiced`, `ironclad`, `ironsource`, `iterable`, `itunes_connect`, `ivanti`, `jama_software`, `jamf`, `jibble`, `jira`, `jobnimbus`, `jotform`, `justcall`, `kandji`, `katana`, `kevel`, `keypay`, `khoros_care`, `khoros_communities`, `khoros_marketing`, `kinesis`, `kisi`, `kissmetrics`, `klarna`, `klaviyo`, `konnect_insights`, `kustomer`, `lattice`, `launchdarkly`, `leap_crm`, `learn_amp`, `learnupon`, `lemlist`, `lessonly`, `lever`, `liftoff`, `light_speed_retail`, `lightspeed_retail_xseries`, `line_ads`, `linear`, `linkedin_ads`, `linkedin_company_pages`, `linksquares`, `listen360`, `livechat_partner`, `livechat`, `lob`, `looker_source`, `loop`, `loopio`, `lucca`, `luma`, `mailchimp`, `maileon`, `mailgun`, `mailjet`, `malomo`, `mambu`, `mandrill`, `marin`, `marketo`, `matomo`, `mavenlink`, `maxio_chargify`, `maxio_saasoptics`, `medallia_agile_research`, `medallia`, `megaphone`, `meltwater`, `mention`, `messagebird`, `microsoft_dynamics_365_fno`, `microsoft_dynamics_365_fo`, `microsoft_entra_id`, `microsoft_lists`, `microsoft_power_bi`, `microsoft_teams`, `missive`, `mixmax`, `mixpanel`, `mode`, `moloco`, `monday`, `mountain`, `mux`, `myosh`, `namely`, `national_heavy_vehicle_regulator`, `navan`, `netsuite_suiteanalytics`, `nice`, `notion`, `nylas`, `odoo`, `okendo`, `okta`, `ometria`, `on24`, `oncehub`, `one_drive`, `onetrust`, `open_data_dc`, `open_exchange_rates`, `openai`, `opendistro`, `opensearch`, `optimizely`, `oracle_fusion_field_service`, `oracle_moat_analytics`, `oracle_netsuite_openair`, `oracle_sap_hva_netweaver`, `orbit`, `ordergroove`, `ordway`, `ortto`, `outbrain`, `outreach`, `packiyo`, `paddle`, `pagerduty`, `pandadoc`, `papershift`, `pardot_sandbox`, `pardot`, `partnerize`, `partnerstack_vendor`, `paychex`, `paylocity`, `paypal_sandbox`, `paypal`, `pendo`, `peopleforce`, `persona`, `personio`, `phoenix_ads`, `picqer`, `pigment`, `pingdom`, `pinpoint`, `pinterest_ads`, `pinterest_organic`, `pipe17`, `pipedrive`, `pivotal_tracker`, `piwik_pro`, `placerai`, `planetscale`, `planful`, `planhat`, `playvox_workforce_management`, `playvox`, `podio`, `poplar`, `posthog`, `postmark`, `power_reviews_enterprise`, `prisma_cloud`, `prive`, `procore`, `productboard`, `productive`, `proofpoint_security_awareness`, `prosperstack`, `purple_dot`, `pylon_support_platform`, `qmatic_data_connect`, `qualaroo`, `qualtrics`, `quickbooks`, `quora_ads`, `quorum`, `rakutenadvertising`, `ramp`, `rarible`, `rebound_returns`, `recharge`, `recurly`, `reddit_ads`, `referralhero`, `refiner`, `reltio`, `replyio`, `resource_management_by_smartsheet`, `retailnext`, `retently`, `revel`, `revenuecat`, `reviewsai`, `reviewsio`, `revops`, `revx`, `ricochet360`, `ringcentral`, `ringover`, `rippling`, `rithum`, `rocketlane`, `rokt`, `rollbar`, `rootly`, `rtb_house`, `ruddr`, `rundeck`, `s3_compatible_storage`, `s3`, `safebase`, `safetyculture`, `sage_hr`, `sage_intacct`, `sailthru`, `salesforce_commerce_cloud`, `salesforce_marketing_cloud`, `salesforce_sandbox`, `salesforce`, `salesloft`, `salsify`, `samsara`, `sana`, `sap_business_by_design`, `sap_hana`, `sap_s4hana`, `sap_success_factors`, `scorm`, `security_journey`, `segment`, `sendgrid`, `sendinblue`, `sensor_tower`, `sentry`, `servicenow`, `servicetitan`, `servicetrade`, `sftp`, `share_point`, `shareasale`, `sharetribe`, `shiphero`, `shipnetwork`, `shipstation`, `shopify`, `shopware`, `shortcut`, `shortio`, `showpad`, `siemens_building_x_openness`, `sigma_computing_source`, `simplecast`, `simplesat`, `singlestore_source`, `sistrix`, `skilljar`, `skillstx`, `skimlinks`, `skuvault`, `slab`, `slack_app`, `slack`, `smadex`, `smarthr`, `smartrecruiters`, `smartsheet`, `smartwaiver`, `snapchat_ads`, `snowplow`, `snyk`, `solarwinds_service_desk`, `sonarqube`, `sparkpost`, `splash`, `splitio`, `splunk`, `spotify_ads`, `sprout`, `square`, `squarespace`, `stackadapt_graphql`, `stackadapt`, `standard_metrics`, `starrez`, `statistics_netherlands_cbs`, `statsig`, `statuspage`, `stickyio`, `stripe_test`, `stripe`, `stylight`, `subscript`, `sugarcrm`, `survey_monkey`, `survicate`, `swoogo`, `tableau_source`, `taboola`, `talkdesk`, `talkwalker`, `teads`, `teamtailor`, `teamwork`, `tempo`, `testrail`, `textus`, `the_movie_database`, `the_trade_desk`, `thinkific`, `ticket_tailor`, `tiktok_ads`, `tiktok_organic_app`, `tiktok_organic`, `tive`, `toast`, `toggl_track`, `totango`, `tracksuit_source`, `transcend`, `trelica`, `trello`, `tremendous`, `triple_whale`, `trisolute`, `twilio`, `twitter_ads`, `twitter`, `tymeshift`, `typeform`, `udemy_business`, `ukg_pro_workforce_management`, `ukg_pro`, `unicommerce`, `upland`, `uppromote`, `uptempo`, `uservoice`, `validio`, `veeqo`, `veeva_vault`, `veevavault`, `venminder`, `vimeo`, `visit_by_ges`, `visma`, `vitally`, `vonage_contact_center`, `vonage`, `vts`, `vwo`, `walmart_dsp`, `walmart_marketplace`, `wasabi_cloud_storage`, `web_scraper`, `webconnex`, `webhooks`, `when_i_work`, `wherefour`, `wicked_reports`, `woocommerce`, `wordpress`, `workable`, `workday_adaptive`, `workday_financial_management`, `workday_hcm`, `workday_strategic_sourcing`, `workday`, `workflowmax`, `workleap_officevibe`, `workramp`, `wrike`, `writesonic`, `xactly`, `xandr`, `xero`, `xray`, `xsolla`, `yahoo_display_ads_on_yahoo_japan`, `yahoo_dsp`, `yahoo_gemini`, `yahoo_search_ads_yahoo_japan`, `yext`, `yotpo_app`, `yotpo`, `yougov_brandindex`, `yougov_sport`, `younium`, `youtube_analytics`, `zendesk_chat`, `zendesk_sell`, `zendesk_sunshine`, `zendesk_workforce_management`, `zendesk`, `zenefits`, `zingtree`, `zip`, `zoho_books`, `zoho_campaigns`, `zoho_crm`, `zoho_desk`, `zoho_inventory`, `zoho_recruit`, `zonka_feedback`, `zoom`, `zuora_sandbox`, `zuora`
*/
name: string;
/**
* The connector schema prefix has to be unique within the group (destination). Each replicated schema is prefixed with the provided value. Required for connector creation of services:
* `airtable`, `aurora_postgres`, `aurora`, `azure_cosmos_for_mongo`, `azure_postgres`, `azure_sql_db`, `azure_sql_managed_db`, `bigquery_db`, `clarity`, `cockroachdb`, `cosmos`, `databricks_db`, `db2`, `db2i_hva`, `db2i_sap_hva`, `db2luw`, `db2z`, `documentdb`, `dynamics_365_fo`, `ehr`, `epic_clarity`, `google_cloud_mysql`, `google_cloud_postgresql`, `google_cloud_sqlserver`, `hana_sap_hva_b1`, `hana_sap_hva_ecc`, `hana_sap_hva_s4`, `heroku_postgres`, `magento_mysql_rds`, `magento_mysql`, `maria_azure`, `maria_rds`, `maria`, `mongo_sharded`, `mongo`, `mysql_azure`, `mysql_rds`, `mysql`, `oracle_business_intelligence_publisher`, `oracle_ebs`, `oracle_fusion_cloud_apps_crm`, `oracle_fusion_cloud_apps_fscm`, `oracle_fusion_cloud_apps_hcm`, `oracle_hva`, `oracle_rac`, `oracle_rds`, `oracle_sap_hva`, `oracle`, `postgres_rds`, `postgres`, `redshift_db`, `sap_hana_db`, `snowflake_db`, `sql_server_hva`, `sql_server_rds`, `sql_server_sap_ecc_hva`, `sql_server`
*/
prefix: string;
/**
* The table name unique within the schema to which connector will sync the data. Required for connector creation of services:
* `adroll`, `akamai`, `akeneo`, `algolia`, `amazon_dsp`, `assembled`, `aws_cost_report`, `azure_blob_storage`, `box`, `brave_ads`, `buzzsprout`, `canvas_data_2_by_instructure`, `chargebee_product_catalog_2`, `chargedesk`, `cloudflare_analytics`, `clubspeed`, `constant_contact`, `criteo_retail_media`, `destini`, `double_click_campaign_manager`, `double_click_publishers`, `dropbox_sign`, `dropbox`, `dsv`, `duoplane`, `email`, `eventsforce`, `everflow`, `facebook`, `forj_community`, `freshdesk_contact_center`, `freshsuccess`, `ftp`, `gcs`, `google_analytics`, `google_classroom`, `google_display_and_video_360`, `google_drive`, `google_sheets`, `grin`, `happyfox`, `jama_software`, `jibble`, `justcall`, `kinesis`, `learnupon`, `livechat_partner`, `looker_source`, `mixmax`, `navan`, `open_data_dc`, `paddle`, `referralhero`, `reviewsai`, `revops`, `rollbar`, `s3`, `safebase`, `sftp`, `shiphero`, `sistrix`, `slack`, `sugarcrm`, `teamtailor`, `tive`, `wasabi_cloud_storage`, `webhooks`, `wherefour`, `wordpress`, `workday`, `workleap_officevibe`, `youtube_analytics`
*/
table: string;
/**
* Table group name. Combined with the schema to form the Fivetran connection name '.'. Required for connector creation of services:
* `azure_blob_storage`, `box`, `dropbox`, `email`, `ftp`, `gcs`, `google_drive`, `s3_compatible_storage`, `s3`, `sftp`, `share_point`, `workday`
*/
tableGroupName: string;
}
export interface GetConnectorFingerprintsFingerprint {
/**
* Hash of the fingerprint.
*/
hash: string;
/**
* The SSH public key.
*/
publicKey: string;
/**
* User name who validated the fingerprint.
*/
validatedBy: string;
/**
* The date when fingerprint was approved.
*/
validatedDate: string;
}
export interface GetConnectorStatus {
/**
* The boolean specifying whether the connector should be triggered to re-sync all historical data. If you set this parameter to TRUE, the next scheduled sync will be historical. If the value is FALSE or not specified, the connector will not re-sync historical data. NOTE: When the value is TRUE, only the next scheduled sync will be historical, all subsequent ones will be incremental. This parameter is set to FALSE once the historical sync is completed.
*/
isHistoricalSync: boolean;
/**
* The current setup state of the connector. The available values are:
- incomplete - the setup config is incomplete, the setup tests never succeeded `connected` - the connector is properly set up, `broken` - the connector setup config is broken.
*/
setupState: string;
/**
* The current sync state of the connector. The available values are: `scheduled` - the sync is waiting to be run, `syncing` - the sync is currently running, `paused` - the sync is currently paused, `rescheduled` - the sync is waiting until more API calls are available in the source service.
*/
syncState: string;
/**
* The collection of tasks for the connector.
*/
tasks: outputs.GetConnectorStatusTask[];
/**
* The current data update state of the connector. The available values are: `on_schedule` - the sync is running smoothly, no delays, `delayed` - the data is delayed for a longer time than expected for the update.
*/
updateState: string;
/**
* The collection of warnings for the connector.
*/
warnings: outputs.GetConnectorStatusWarning[];
}
export interface GetConnectorStatusTask {
/**
* Task code.
*/
code: string;
/**
* Task message.
*/
message: string;
}
export interface GetConnectorStatusWarning {
/**
* Warning code.
*/
code: string;
/**
* Warning message.
*/
message: string;
}
export interface GetConnectorsConnector {
/**
* The unique identifier of the user who has created the connector in your account.
*/
connectedBy: string;
/**
* The timestamp of the time the connector was created in your account.
*/
createdAt: string;
/**
* The optional parameter that defines the sync start time when the sync frequency is already set or being set by the current request to 1440. It can be specified in one hour increments starting from 00:00 to 23:00. If not specified, we will use [the baseline sync start time](https://fivetran.com/docs/getting-started/syncoverview#syncfrequencyandscheduling). This parameter has no effect on the [0 to 60 minutes offset](https://fivetran.com/docs/getting-started/syncoverview#syncstarttimesandoffsets) used to determine the actual sync start time.
*/
dailySyncTime: string;
/**
* The level of data delay notification threshold. Possible values: LOW, NORMAL, HIGH, CUSTOM. The default value NORMAL. CUSTOM is only available for customers using the Enterprise plan or above.
*/
dataDelaySensitivity: string;
/**
* Custom sync delay notification threshold in minutes. The default value is 0. This parameter is only used when data_delay_sensitivity set to CUSTOM.
*/
dataDelayThreshold: number;
/**
* The timestamp of the time the connector sync failed last time.
*/
failedAt: string;
/**
* The unique identifier for the Group (Destination) within the Fivetran system.
*/
groupId: string;
/**
* The hybrid deployment agent ID that refers to the controller created for the group the connection belongs to. If the value is specified, the system will try to associate the connection with an existing agent.
*/
hybridDeploymentAgentId: string;
/**
* The unique identifier for the connector within the Fivetran system.
*/
id: string;
/**
* The name used both as the connector's name within the Fivetran system and as the source schema's name within your destination.
*/
name: string;
/**
* Possible values: Directly, SshTunnel, ProxyAgent, PrivateLink.
*/
networkingMethod: string;
/**
* Specifies whether the connector should be paused after the free trial period has ended.
*/
pauseAfterTrial: boolean;
/**
* Specifies whether the connector is paused.
*/
paused: boolean;
/**
* The private link ID.
*/
privateLinkId: string;
/**
* The proxy agent ID.
*/
proxyAgentId: string;
/**
* The connector schedule configuration type. Supported values: auto, manual.
*/
scheduleType: string;
/**
* The connector type id within the Fivetran system.
*/
service: string;
/**
* The connector type version within the Fivetran system.
*/
serviceVersion: string;
/**
* The timestamp of the time the connector sync succeeded last time.
*/
succeededAt: string;
/**
* The connector sync frequency in minutes.
*/
syncFrequency: number;
}
export interface GetConnectorsMetadataSource {
/**
* The description characterizing the purpose of the connector.
*/
description: string;
/**
* The icon resource URL.
*/
iconUrl: string;
/**
* The unique identifier for the connector within the Fivetran system
*/
id: string;
/**
* The link to the connector documentation.
*/
linkToDocs: string;
/**
* The link to the connector ERD (entity–relationship diagram).
*/
linkToErd: string;
/**
* The connector service name within the Fivetran system.
*/
name: string;
/**
* The connector service type within the Fivetran system.
*/
type: string;
}
export interface GetDestinationCertificatesCertificate {
/**
* Hash of the certificate.
*/
hash: string;
/**
* Certificate name.
*/
name: string;
/**
* The SSH public key.
*/
publicKey: string;
/**
* Certificate sha1.
*/
sha1: string;
/**
* Certificate sha256.
*/
sha256: string;
/**
* Type of the certificate.
*/
type: string;
/**
* User name who validated the certificate.
*/
validatedBy: string;
/**
* The date when certificate was approved.
*/
validatedDate: string;
}
export interface GetDestinationConfig {
/**
* Field usage depends on `service` value:
* - Service `aurora_postgres_warehouse`: Specifies whether TLS is required. Must be populated if `connection_type` is set to `SshTunnel`.
* - Service `aurora_warehouse`: Specifies whether TLS is required. Must be populated if `connection_type` is set to `SshTunnel`.
* - Service `azure_postgres_warehouse`: Specifies whether TLS is required. Must be populated if `connection_type` is set to `SshTunnel`.
* - Service `azure_sql_data_warehouse`: Specifies whether TLS is required. Must be populated if `connection_type` is set to `SshTunnel`.
* - Service `azure_sql_database`: Specifies whether TLS is required. Must be populated if `connection_type` is set to `SshTunnel`.
* - Service `azure_sql_managed_db_warehouse`: Specifies whether TLS is required. Must be populated if `connection_type` is set to `SshTunnel`.
* - Service `maria_rds_warehouse`: Specifies whether TLS is required. Must be populated if `connection_type` is set to `SshTunnel`.
* - Service `maria_warehouse`: Specifies whether TLS is required. Must be populated if `connection_type` is set to `SshTunnel`.
* - Service `mysql_rds_warehouse`: Specifies whether TLS is required. Must be populated if `connection_type` is set to `SshTunnel`.
* - Service `mysql_warehouse`: Specifies whether TLS is required. Must be populated if `connection_type` is set to `SshTunnel`.
* - Service `oracle_rac_warehouse`: Specifies whether TLS is required. Must be populated if `connection_type` is set to `SshTunnel`.
* - Service `oracle_rds_warehouse`: Specifies whether TLS is required. Must be populated if `connection_type` is set to `SshTunnel`.
* - Service `oracle_warehouse`: Specifies whether TLS is required. Must be populated if `connection_type` is set to `SshTunnel`.
* - Service `panoply`: Specifies whether TLS is required. Must be populated if `connection_type` is set to `SshTunnel`.
* - Service `periscope_warehouse`: Specifies whether TLS is required. Must be populated if `connection_type` is set to `SshTunnel`.
* - Service `postgres_databricks_warehouse`: Specifies whether TLS is required. Must be populated if `connection_type` is set to `SshTunnel`.
* - Service `postgres_gcp_warehouse`: Specifies whether TLS is required. Must be populated if `connection_type` is set to `SshTunnel`.
* - Service `postgres_rds_warehouse`: Specifies whether TLS is required. Must be populated if `connection_type` is set to `SshTunnel`.
* - Service `postgres_warehouse`: Specifies whether TLS is required. Must be populated if `connection_type` is set to `SshTunnel`.
* - Service `redshift`: Require TLS through Tunnel
* - Service `sql_server_rds_warehouse`: Specifies whether TLS is required. Must be populated if `connection_type` is set to `SshTunnel`.
* - Service `sql_server_warehouse`: Specifies whether TLS is required. Must be populated if `connection_type` is set to `SshTunnel`.
*/
alwaysEncrypted: boolean;
/**
* Field usage depends on `service` value:
* - Service `snowflake`: Application ID of your app created in Azure
*/
applicationId: string;
/**
* Field usage depends on `service` value:
* - Service `snowflake`: Password-based or key-based authentication type
*/
auth: string;
/**
* Field usage depends on `service` value:
* - Service `aurora_postgres_warehouse`: Authentication method. Default value: `PASSWORD`.
* - Service `azure_postgres_warehouse`: Authentication method. Default value: `PASSWORD`.
* - Service `postgres_databricks_warehouse`: Authentication method. Default value: `PASSWORD`.
* - Service `postgres_gcp_warehouse`: Authentication method. Default value: `PASSWORD`.
* - Service `postgres_rds_warehouse`: Authentication method. Default value: `PASSWORD`.
* - Service `postgres_warehouse`: Authentication method. Default value: `PASSWORD`.
*/
authMethod: string;
/**
* Field usage depends on `service` value:
* - Service `adls`: Authentication type
* - Service `databricks`: Authentication type
* - Service `managed_data_lake`: Specifies the authentication types for Fivetran to connect to Databricks. Use this parameter only if you want to use Unity Catalog to manage your Delta Lake tables.
* - Service `new_s3_datalake`: Authentication type
* - Service `onelake`: Authentication type
* - Service `redshift`: Authentication type. Default value: `PASSWORD`.
*/
authType: string;
/**
* Field usage depends on `service` value:
* - Service `databricks`: Your user's access key ID
* - Service `new_s3_datalake`: AWS access key to access the S3 bucket and AWS Glue
* - Service `redshift`: The unique access key ID of the S3 bucket you want to use to stage your data. Use this parameter only if you are using Hybrid Deployment.
* - Service `snowflake`: The unique access key ID of the S3 bucket you want to use to stage your data. Use this parameter only if you are using Hybrid Deployment, want to use an S3 bucket to stage your data, and `awsBucketAuthType` is set to `IAM_USER`.
*/
awsAccessKeyId: string;
/**
* Field usage depends on `service` value:
* - Service `snowflake`: Type of authentication configured for the S3 bucket you want to use to stage your data. Use this parameter only if you are using Hybrid Deployment and want to use an S3 bucket to stage your data.
*/
awsBucketAuthType: string;
/**
* Field usage depends on `service` value:
* - Service `aurora_postgres_warehouse`: AWS region where the Aurora cluster is located. Required when `auth_method` is set to `AWS_IAM`.
* - Service `azure_postgres_warehouse`: AWS region code. Required when `auth_method` is set to `AWS_IAM`.
* - Service `postgres_databricks_warehouse`: AWS region code. Required when `auth_method` is set to `AWS_IAM`.
* - Service `postgres_gcp_warehouse`: AWS region code. Required when `auth_method` is set to `AWS_IAM`.
* - Service `postgres_rds_warehouse`: AWS region where the RDS instance is located. Required when `auth_method` is set to `AWS_IAM`.
* - Service `postgres_warehouse`: AWS region code. Required when `auth_method` is set to `AWS_IAM`.
*/
awsRegionCode: string;
/**
* Field usage depends on `service` value:
* - Service `databricks`: Your user's secret access key
* - Service `new_s3_datalake`: AWS secret access key to access the S3 bucket and AWS Glue
* - Service `redshift`: The secret access key of the S3 bucket you want to use to stage your data. Use this parameter only if you are using Hybrid Deployment.
* - Service `snowflake`: The secret access key of the S3 bucket you want to use to stage your data. Use this parameter only if you are using Hybrid Deployment , want to use an S3 bucket to stage your data, and `awsBucketAuthType` is set to `IAM_USER`.
*/
awsSecretAccessKey: string;
/**
* Field usage depends on `service` value:
* - Service `databricks`: Authentication method for the Azure container you want to use as the external staging for Hybrid Deployment.
*/
azureStorageAccountAuthType: string;
/**
* Field usage depends on `service` value:
* - Service `confluent_cloud_wh`: Comma-separated list of Confluent Cloud servers in the `server:port` format.
*/
bootstrapServers: string[];
/**
* Field usage depends on `service` value:
* - Service `big_query`: Customer bucket. If specified, your GCS bucket will be used to process the data instead of a Fivetran-managed bucket. The bucket must be present in the same location as the dataset location.
* - Service `big_query_dts`: Customer bucket. If specified, your GCS bucket will be used to process the data instead of a Fivetran-managed bucket. The bucket must be present in the same location as the dataset location.
* - Service `databricks`: Your bucket
* - Service `managed_big_query`: Customer bucket. If specified, your GCS bucket will be used to process the data instead of a Fivetran-managed bucket. The bucket must be present in the same location as the dataset location.
* - Service `managed_data_lake`: (Immutable) Name of the S3 or Google Cloud Storage (GCS) bucket you want to use to store your data. Use this parameter only if you want to deploy your data lake on Amazon Web Services (AWS) or GCS.
* - Service `new_s3_datalake`: (Immutable) The name of the bucket to be used as destination
* - Service `redshift`: The name of the storage bucket you want to use to stage your data. Use this parameter only if you are using Hybrid Deployment.
* - Service `snowflake`: The name of the storage bucket you want to use to stage your data. Use this parameter only if you are using Hybrid Deployment and want to use an S3 or GCS bucket to stage your data.
*/
bucket: string;
/**
* Field usage depends on `service` value:
* - Service `databricks`: Your bucket's region
* - Service `redshift`: The AWS Region of the S3 bucket you want to use to stage your data. Use this parameter only if you are using Hybrid Deployment.
* - Service `snowflake`: The AWS Region of the S3 bucket you want to use to stage your data. Use this parameter only if you are using Hybrid Deployment and want to use an S3 bucket to stage your data.
*/
bucketRegion: string;
/**
* Field usage depends on `service` value:
* - Service `adls`: Catalog name
* - Service `databricks`: Catalog name
* - Service `managed_data_lake`: Name of the specific catalog in Unity Catalog that you want to use to manage your Delta Lake tables. Use this parameter only if you want to use Unity Catalog with your data lake.
* - Service `new_s3_datalake`: Catalog name
* - Service `onelake`: Catalog name
*/
catalog: string;
/**
* Field usage depends on `service` value:
* - Service `adls`: Client id of service principal
* - Service `managed_data_lake`: Client ID of the service principal you created for Fivetran. Use this parameter only if you want to deploy your data lake on ADLS.
* - Service `onelake`: Client ID of service principal
*/
clientId: string;
/**
* Field usage depends on `service` value:
* - Service `databricks`: Databricks deployment cloud
*/
cloudProvider: string;
/**
* Field usage depends on `service` value:
* - Service `panoply`: Cluster ID.
* - Service `periscope_warehouse`: Cluster ID.
* - Service `redshift`: Cluster ID. Must be populated if `connection_type` is set to `SshTunnel` and `auth_type` is set to `IAM`.
*/
clusterId: string;
/**
* Field usage depends on `service` value:
* - Service `panoply`: Cluster region.
* - Service `periscope_warehouse`: Cluster region.
* - Service `redshift`: Cluster region. Must be populated if `connection_type` is set to `SshTunnel` and `auth_type` is set to `IAM`.
*/
clusterRegion: string;
connectionMethod: string;
/**
* Field usage depends on `service` value:
* - Service `adls`: Connection method. Default value: `Directly`.
* - Service `aurora_postgres_warehouse`: Connection method. Default value: `Directly`.
* - Service `aurora_warehouse`: Connection method. Default value: `Directly`.
* - Service `azure_postgres_warehouse`: Connection method. Default value: `Directly`.
* - Service `azure_sql_data_warehouse`: Connection method. Default value: `Directly`.
* - Service `azure_sql_database`: Connection method. Default value: `Directly`.
* - Service `azure_sql_managed_db_warehouse`: Connection method. Default value: `Directly`.
* - Service `databricks`: Connection method. Default value: `Directly`.
* - Service `managed_data_lake`: connection type
* - Service `maria_rds_warehouse`: Connection method. Default value: `Directly`.
* - Service `maria_warehouse`: Connection method. Default value: `Directly`.
* - Service `mysql_rds_warehouse`: Connection method. Default value: `Directly`.
* - Service `mysql_warehouse`: Connection method. Default value: `Directly`.
* - Service `oracle_rac_warehouse`: Connection method. Default value: `Directly`.
* - Service `oracle_rds_warehouse`: Connection method. Default value: `Directly`.
* - Service `oracle_warehouse`: Connection method. Default value: `Directly`.
* - Service `panoply`: Connection method. Default value: `Directly`.
* - Service `periscope_warehouse`: Connection method. Default value: `Directly`.
* - Service `postgres_databricks_warehouse`: Connection method. Default value: `Directly`.
* - Service `postgres_gcp_warehouse`: Connection method. Default value: `Directly`.
* - Service `postgres_rds_warehouse`: Connection method. Default value: `Directly`.
* - Service `postgres_warehouse`: Connection method. Default value: `Directly`.
* - Service `redshift`: Connection method. Default value: `Directly`.
* - Service `snowflake`: Connection method. Default value: `Directly`.
* - Service `sql_server_rds_warehouse`: Connection method. Default value: `Directly`.
* - Service `sql_server_warehouse`: Connection method. Default value: `Directly`.
*/
connectionType: string;
/**
* Field usage depends on `service` value:
* - Service `adls`: (Immutable) Container to store delta table files
* - Service `managed_data_lake`: (Immutable) Name of the ADLS container you want to use to store your data. Use this parameter only if you want to deploy your data lake on ADLS.
* - Service `onelake`: Workspace name to store delta table files
*/
containerName: string;
controllerId: string;
/**
* Field usage depends on `service` value:
* - Service `databricks`: Whether to create external tables
*/
createExternalTables: boolean;
/**
* Field usage depends on `service` value:
* - Service `databricks`: Specifies whether you want Fivetran to create external volumes for unstructured data files.
*/
createExternalVolumes: boolean;
/**
* Field usage depends on `service` value:
* - Service `confluent_cloud_wh`: Confluent Cloud message format.
*/
dataFormat: string;
/**
* Field usage depends on `service` value:
* - Service `big_query`: Data location. Datasets will reside in this location.
* - Service `big_query_dts`: Data location. Datasets will reside in this location.
* - Service `managed_big_query`: Data location. Datasets will reside in this location.
*/
dataSetLocation: string;
/**
* Field usage depends on `service` value:
* - Service `aurora_postgres_warehouse`: Database name
* - Service `aurora_warehouse`: Database name
* - Service `azure_postgres_warehouse`: Database name
* - Service `azure_sql_data_warehouse`: Database name
* - Service `azure_sql_database`: Database name
* - Service `azure_sql_managed_db_warehouse`: Database name
* - Service `maria_rds_warehouse`: Database name
* - Service `maria_warehouse`: Database name
* - Service `mysql_rds_warehouse`: Database name
* - Service `mysql_warehouse`: Database name
* - Service `oracle_rac_warehouse`: Service Name
* - Service `oracle_rds_warehouse`: Database name
* - Service `oracle_warehouse`: Database name
* - Service `panoply`: Database name
* - Service `periscope_warehouse`: Database name
* - Service `postgres_databricks_warehouse`: Database name
* - Service `postgres_gcp_warehouse`: Database name
* - Service `postgres_rds_warehouse`: Database name
* - Service `postgres_warehouse`: Database name
* - Service `redshift`: Database name
* - Service `snowflake`: Database name
* - Service `sql_server_rds_warehouse`: Database name
* - Service `sql_server_warehouse`: Database name
*/
database: string;
/**
* Field usage depends on `service` value:
* - Service `adls`: Databricks Connection method. Default value: `Directly`.
* - Service `managed_data_lake`: Specifies how you want Fivetran to connect to the Databricks account associated with Unity Catalog. Default value: `Directly`. Use this parameter only if you want to use Unity Catalog with your data lake.
* - Service `new_s3_datalake`: Databricks Connection method. Default value: `Directly`.
* - Service `onelake`: Databricks Connection method. Default value: `Directly`.
*/
databricksConnectionType: string;
/**
* Field usage depends on `service` value:
* - Service `snowflake`: The virtual warehouse to use for running queries.
*/
defaultVirtualWarehouse: string;
/**
* Field usage depends on `service` value:
* - Service `snowflake`: Tenant ID of your app created in Azure
*/
directoryId: string;
/**
* Field usage depends on `service` value:
* - Service `databricks`: Specifies whether you want Fivetran to disable Vacuum operations on Delta tables.
*/
disableVacuum: boolean;
/**
* Field usage depends on `service` value:
* - Service `snowflake`: Set to `true` if you want to enable external storage for unstructured files.
*/
enableExternalStorageForUnstructuredFiles: boolean;
enableRemoteExecution: boolean;
/**
* Field usage depends on `service` value:
* - Service `confluent_cloud_wh`: Populate all tables in a single topic.
*/
enableSingleTopic: boolean;
/**
* Field usage depends on `service` value:
* - Service `redshift`: Enable to convert JSON data type to SUPER
*/
enableSuperType: boolean;
/**
* Field usage depends on `service` value:
* - Service `aurora_postgres_warehouse`: AWS external ID for authentication. Required when `auth_method` is set to `AWS_IAM`.
* - Service `aws_msk_wh`: Fivetran generated External ID
* - Service `azure_postgres_warehouse`: AWS external ID for authentication. Required when `auth_method` is set to `AWS_IAM`.
* - Service `panoply`: Fivetran generated External ID
* - Service `periscope_warehouse`: Fivetran generated External ID
* - Service `postgres_databricks_warehouse`: AWS external ID for authentication. Required when `auth_method` is set to `AWS_IAM`.
* - Service `postgres_gcp_warehouse`: AWS external ID for authentication. Required when `auth_method` is set to `AWS_IAM`.
* - Service `postgres_rds_warehouse`: AWS external ID for authentication. Required when `auth_method` is set to `AWS_IAM`.
* - Service `postgres_warehouse`: AWS external ID for authentication. Required when `auth_method` is set to `AWS_IAM`.
* - Service `redshift`: Fivetran generated External ID
*/
externalId: string;
/**
* Field usage depends on `service` value:
* - Service `databricks`: External location to store Delta tables. Default value: `""` (null). By default, the external tables will reside in the `/{schema}/{table}` path, and if you specify an external location in the `{externalLocation}/{schema}/{table}` path.
*/
externalLocation: string;
/**
* Field usage depends on `service` value:
* - Service `snowflake`: External stage storage provider[Internal, S3, Azure,GCS]
*/
externalStageStorageProvider: string;
/**
* Field usage depends on `service` value:
* - Service `snowflake`: The cloud service provider you want to use for staging data. Use this parameter only if you are using Hybrid Deployment.
*/
externalStorageCloudProvider: string;
/**
* Field usage depends on `service` value:
* - Service `snowflake`: External storage integration name
*/
externalStorageIntegration: string;
/**
* Field usage depends on `service` value:
* - Service `snowflake`: External storage parent folder URL
*/
externalStorageParentFolderUri: string;
/**
* Field usage depends on `service` value:
* - Service `databricks`: Specifies the external volume path where you want Fivetran to create the unstructured files.
*/
externalVolumeLocation: string;
fivetranGlueRoleArn: string;
fivetranMskRoleArn: string;
/**
* Field usage depends on `service` value:
* - Service `managed_data_lake`: (Immutable) ARN of the IAM role you created for the IAM policy associated with your S3 bucket or Glue catalog. Use this parameter only if you want to deploy your data lake on AWS.
* - Service `new_s3_datalake`: ARN of the role which you created with different required policy mentioned in our setup guide
*/
fivetranRoleArn: string;
/**
* Field usage depends on `service` value:
* - Service `snowflake`: The path to the JSON file that contains the service account credentials for the GCS bucket you want to use to stage your data. Use this parameter only if you are using Hybrid Deployment and want to use a GCS bucket to stage your data.
*/
gcsServiceAccountCredentialsPath: string;
/**
* Field usage depends on `service` value:
* - Service `aurora_postgres_warehouse`: Server name
* - Service `aurora_warehouse`: Server name
* - Service `azure_postgres_warehouse`: Server name
* - Service `azure_sql_data_warehouse`: Server name
* - Service `azure_sql_database`: Server name
* - Service `azure_sql_managed_db_warehouse`: Server name
* - Service `maria_rds_warehouse`: Server name
* - Service `maria_warehouse`: Server name
* - Service `mysql_rds_warehouse`: Server name
* - Service `mysql_warehouse`: Server name
* - Service `oracle_rac_warehouse`: Server name
* - Service `oracle_rds_warehouse`: Server name
* - Service `oracle_warehouse`: Server name
* - Service `panoply`: Server name
* - Service `periscope_warehouse`: Server name
* - Service `postgres_databricks_warehouse`: Server name
* - Service `postgres_gcp_warehouse`: Server name
* - Service `postgres_rds_warehouse`: Server name
* - Service `postgres_warehouse`: Server name
* - Service `redshift`: Server name
* - Service `snowflake`: Server name
* - Service `sql_server_rds_warehouse`: Server name
* - Service `sql_server_warehouse`: Server name
*/
host: string;
/**
* Field usage depends on `service` value:
* - Service `adls`: HTTP path
* - Service `databricks`: HTTP path
* - Service `managed_data_lake`: HTTP path of the Databricks account associated with Unity Catalog. Use this parameter only if you want to use Unity Catalog to manage your Delta Lake tables.
* - Service `new_s3_datalake`: HTTP path
* - Service `onelake`: HTTP path
*/
httpPath: string;
/**
* Field usage depends on `service` value:
* - Service `snowflake`: Indicates that a private key is encrypted. The default value: `false`. The field can be specified if authentication type is `KEY_PAIR`.
*/
isPrivateKeyEncrypted: boolean;
/**
* Field usage depends on `service` value:
* - Service `new_s3_datalake`: We use PrivateLink by default if your s3 bucket is in the same region as Fivetran. Turning on this toggle ensures that Fivetran always connects to s3 bucket over PrivateLink. Learn more in our [PrivateLink documentation](https://fivetran.com/docs/connectors/databases/connection-options/aws-private-link).
*/
isPrivateLinkRequired: boolean;
/**
* Field usage depends on `service` value:
* - Service `redshift`: Is your destination Redshift Serverless
*/
isRedshiftServerless: boolean;
/**
* Field usage depends on `service` value:
* - Service `managed_data_lake`: (Immutable) OneLake lakehouse GUID.
* - Service `onelake`: (Immutable) OneLake lakehouse GUID
*/
lakehouseGuid: string;
/**
* Field usage depends on `service` value:
* - Service `onelake`: (Immutable) Name of your lakehouse
*/
lakehouseName: string;
mskStsRegion: string;
/**
* Field usage depends on `service` value:
* - Service `confluent_cloud_wh`: Number of partitions per topic.
*/
numOfPartitions: number;
/**
* Field usage depends on `service` value:
* - Service `adls`: OAuth 2.0 client ID
* - Service `databricks`: OAuth 2.0 client ID
* - Service `managed_data_lake`: The OAuth 2.0 client ID you created for authenticating Fivetran. Use this parameter only if you want to use OAuth 2.0 as the authentication type for Fivetran to connect to Databricks.
* - Service `new_s3_datalake`: OAuth 2.0 client ID
* - Service `onelake`: OAuth 2.0 client ID
*/
oauth2ClientId: string;
/**
* Field usage depends on `service` value:
* - Service `adls`: OAuth 2.0 secret
* - Service `databricks`: OAuth 2.0 secret
* - Service `managed_data_lake`: OAuth 2.0 secret you created for authenticating Fivetran. Use this parameter only if you want to use OAuth 2.0 as the authentication type for Fivetran to connect to Databricks.
* - Service `new_s3_datalake`: OAuth 2.0 secret
* - Service `onelake`: OAuth 2.0 secret
*/
oauth2Secret: string;
/**
* Field usage depends on `service` value:
* - Service `managed_data_lake`: (Immutable) Client ID of OneLake service principal.
*/
onelakeClientId: string;
/**
* Field usage depends on `service` value:
* - Service `managed_data_lake`: Secret value for OneLake service principal.
*/
onelakeClientSecret: string;
/**
* Field usage depends on `service` value:
* - Service `managed_data_lake`: (Immutable) Tenant ID of OneLake service principal
*/
onelakeTenantId: string;
/**
* Field usage depends on `service` value:
* - Service `snowflake`: In case private key is encrypted, you are required to enter passphrase that was used to encrypt the private key. The field can be specified if authentication type is `KEY_PAIR`.
*/
passphrase: string;
/**
* Field usage depends on `service` value:
* - Service `aurora_postgres_warehouse`: Database user password
* - Service `aurora_warehouse`: Database user password
* - Service `azure_postgres_warehouse`: Database user password
* - Service `azure_sql_data_warehouse`: Database user password
* - Service `azure_sql_database`: Database user password
* - Service `azure_sql_managed_db_warehouse`: Database user password
* - Service `maria_rds_warehouse`: Database user password
* - Service `maria_warehouse`: Database user password
* - Service `mysql_rds_warehouse`: Database user password
* - Service `mysql_warehouse`: Database user password
* - Service `oracle_rac_warehouse`: Database user password
* - Service `oracle_rds_warehouse`: Database user password
* - Service `oracle_warehouse`: Database user password
* - Service `panoply`: Database user password
* - Service `periscope_warehouse`: Database user password
* - Service `postgres_databricks_warehouse`: Database user password
* - Service `postgres_gcp_warehouse`: Database user password
* - Service `postgres_rds_warehouse`: Database user password
* - Service `postgres_warehouse`: Database user password
* - Service `redshift`: Database user password. Required if authentication type is `PASSWORD`.
* - Service `snowflake`: Database user password. The field should be specified if authentication type is `PASSWORD`.
* - Service `sql_server_rds_warehouse`: Database user password
* - Service `sql_server_warehouse`: Database user password
*/
password: string;
/**
* Field usage depends on `service` value:
* - Service `adls`: Personal access token
* - Service `databricks`: Personal access token
* - Service `managed_data_lake`: The personal access token you created for authenticating Fivetran. Use this parameter only if you want to use a personal access token as the authentication type for Fivetran to connect to Databricks.
* - Service `new_s3_datalake`: Personal access token
* - Service `onelake`: Personal access token
*/
personalAccessToken: string;
/**
* Field usage depends on `service` value:
* - Service `adls`: Server port number
* - Service `aurora_postgres_warehouse`: Server port number
* - Service `aurora_warehouse`: Server port number
* - Service `azure_postgres_warehouse`: Server port number
* - Service `azure_sql_data_warehouse`: Server port number
* - Service `azure_sql_database`: Server port number
* - Service `azure_sql_managed_db_warehouse`: Server port number
* - Service `databricks`: Server port number
* - Service `managed_data_lake`: Server port number of the Databricks account associated with Unity Catalog. Use this parameter only if you want to use Unity Catalog to manage your Delta Lake tables.
* - Service `maria_rds_warehouse`: Server port number
* - Service `maria_warehouse`: Server port number
* - Service `mysql_rds_warehouse`: Server port number
* - Service `mysql_warehouse`: Server port number
* - Service `new_s3_datalake`: Server port number
* - Service `onelake`: Server port number
* - Service `oracle_rac_warehouse`: Server port number
* - Service `oracle_rds_warehouse`: Server port number
* - Service `oracle_warehouse`: Server port number
* - Service `panoply`: Server port number
* - Service `periscope_warehouse`: Server port number
* - Service `postgres_databricks_warehouse`: Server port number
* - Service `postgres_gcp_warehouse`: Server port number
* - Service `postgres_rds_warehouse`: Server port number
* - Service `postgres_warehouse`: Server port number
* - Service `redshift`: Server port number
* - Service `snowflake`: Server port number
* - Service `sql_server_rds_warehouse`: Server port number
* - Service `sql_server_warehouse`: Server port number
*/
port: number;
/**
* Field usage depends on `service` value:
* - Service `adls`: (Immutable) path/to/data within the container
* - Service `managed_data_lake`: (Immutable) Prefix path or virtual folder path within your bucket or container where you want Fivetran to store your data. Skip this parameter for AWS-based data lakes if the IAM policy configured for your S3 bucket grants access to the entire bucket.
* - Service `new_s3_datalake`: (Immutable) Prefix path of the bucket for which you have configured access policy. It is not required if access has been granted to entire Bucket in the access policy
* - Service `onelake`: (Immutable) path/to/data within your lakehouse inside the Files directory
*/
prefixPath: string;
/**
* Field usage depends on `service` value:
* - Service `snowflake`: Private access key. The field should be specified if authentication type is `KEY_PAIR`.
*/
privateKey: string;
/**
* Field usage depends on `service` value:
* - Service `big_query`: BigQuery project ID
*/
projectId: string;
/**
* Field usage depends on `service` value:
* - Service `aurora_postgres_warehouse`: Public Key
* - Service `aurora_warehouse`: Public Key
* - Service `azure_postgres_warehouse`: Public Key
* - Service `azure_sql_data_warehouse`: Public Key
* - Service `azure_sql_database`: Public Key
* - Service `azure_sql_managed_db_warehouse`: Public Key
* - Service `maria_rds_warehouse`: Public Key
* - Service `maria_warehouse`: Public Key
* - Service `mysql_rds_warehouse`: Public Key
* - Service `mysql_warehouse`: Public Key
* - Service `panoply`: Public Key
* - Service `periscope_warehouse`: Public Key
* - Service `postgres_gcp_warehouse`: Public Key
* - Service `postgres_rds_warehouse`: Public Key
* - Service `postgres_warehouse`: Public Key
* - Service `redshift`: Public Key
* - Service `sql_server_rds_warehouse`: Public Key
* - Service `sql_server_warehouse`: Public Key
*/
publicKey: string;
/**
* Field usage depends on `service` value:
* - Service `managed_data_lake`: (Immutable) AWS Region of your S3 bucket. Use this parameter only if you want to deploy your data lake on AWS.
* - Service `new_s3_datalake`: Region of your AWS S3 bucket
*/
region: string;
registryName: string;
registryStsRegion: string;
/**
* Field usage depends on `service` value:
* - Service `confluent_cloud_wh`: Replication factor.
*/
replicationFactor: number;
/**
* Field usage depends on `service` value:
* - Service `aurora_postgres_warehouse`: This field is currently being introduced to test the Self-serve Private Link functionality
* - Service `aurora_warehouse`: This field is currently being introduced to test the Self-serve Private Link functionality
* - Service `azure_postgres_warehouse`: This field is currently being introduced to test the Self-serve Private Link functionality
* - Service `azure_sql_data_warehouse`: This field is currently being introduced to test the Self-serve Private Link functionality
* - Service `azure_sql_database`: Field to test Self serve Private Link
* - Service `azure_sql_managed_db_warehouse`: Field to test Self serve Private Link
* - Service `databricks`: This field is currently being introduced to test the Self-serve Private Link functionality
* - Service `maria_rds_warehouse`: This field is currently being introduced to test the Self-serve Private Link functionality
* - Service `maria_warehouse`: This field is currently being introduced to test the Self-serve Private Link functionality
* - Service `mysql_rds_warehouse`: This field is currently being introduced to test the Self-serve Private Link functionality
* - Service `mysql_warehouse`: This field is currently being introduced to test the Self-serve Private Link functionality
* - Service `panoply`: This field is currently being introduced to test the Self-serve Private Link functionality
* - Service `periscope_warehouse`: This field is currently being introduced to test the Self-serve Private Link functionality
* - Service `postgres_gcp_warehouse`: This field is currently being introduced to test the Self-serve Private Link functionality
* - Service `postgres_rds_warehouse`: This field is currently being introduced to test the Self-serve Private Link functionality
* - Service `postgres_warehouse`: This field is currently being introduced to test the Self-serve Private Link functionality
* - Service `redshift`: This field is currently being introduced to test the Self-serve Private Link functionality
* - Service `snowflake`: This field is currently being introduced to test the Self-serve Private Link functionality
* - Service `sql_server_rds_warehouse`: Field to test Self serve Private Link
* - Service `sql_server_warehouse`: Field to test Self serve Private Link
*/
resourceId: string;
/**
* Field usage depends on `service` value:
* - Service `snowflake`: If not specified, Fivetran will use the user's default role
*/
role: string;
/**
* Field usage depends on `service` value:
* - Service `aurora_postgres_warehouse`: AWS IAM role ARN for authentication. Required when `auth_method` is set to `AWS_IAM`.
* - Service `azure_postgres_warehouse`: AWS IAM role ARN for authentication. Required when `auth_method` is set to `AWS_IAM`.
* - Service `postgres_databricks_warehouse`: AWS IAM role ARN for authentication. Required when `auth_method` is set to `AWS_IAM`.
* - Service `postgres_gcp_warehouse`: AWS IAM role ARN for authentication. Required when `auth_method` is set to `AWS_IAM`.
* - Service `postgres_rds_warehouse`: AWS IAM role ARN for authentication. Required when `auth_method` is set to `AWS_IAM`.
* - Service `postgres_warehouse`: AWS IAM role ARN for authentication. Required when `auth_method` is set to `AWS_IAM`.
* - Service `redshift`: Role ARN with Redshift permissions. Required if authentication type is `IAM`.
*/
roleArn: string;
/**
* Field usage depends on `service` value:
* - Service `databricks`: Authentication method for the S3 bucket you want to use as the external staging for Hybrid Deployment.
* - Service `redshift`: Type of authentication configured for the S3 bucket you want to use to stage your data. Use this parameter only if you are using Hybrid Deployment
*/
s3BucketAuthType: string;
/**
* Field usage depends on `service` value:
* - Service `confluent_cloud_wh`: Security protocol for Confluent Cloud interaction.
*/
saslMechanism: string;
/**
* Field usage depends on `service` value:
* - Service `confluent_cloud_wh`: Confluent Cloud SASL key.
*/
saslPlainKey: string;
/**
* Field usage depends on `service` value:
* - Service `confluent_cloud_wh`: Confluent Cloud SASL secret.
*/
saslPlainSecret: string;
schemaCompatibility: string;
/**
* Field usage depends on `service` value:
* - Service `confluent_cloud_wh`: Schema Registry
*/
schemaRegistry: string;
/**
* Field usage depends on `service` value:
* - Service `confluent_cloud_wh`: Schema registry API key.
*/
schemaRegistryApiKey: string;
/**
* Field usage depends on `service` value:
* - Service `confluent_cloud_wh`: Schema registry API secret.
*/
schemaRegistryApiSecret: string;
/**
* Field usage depends on `service` value:
* - Service `confluent_cloud_wh`: Schema registry URL.
*/
schemaRegistryUrl: string;
/**
* Field usage depends on `service` value:
* - Service `big_query`: Private key of the customer service account. If specified, your service account will be used to process the data instead of the Fivetran-managed service account.
* - Service `big_query_dts`: Private key of the customer service account. If specified, your service account will be used to process the data instead of the Fivetran-managed service account.
* - Service `managed_big_query`: Private key of the customer service account. If specified, your service account will be used to process the data instead of the Fivetran-managed service account.
*/
secretKey: string;
/**
* Field usage depends on `service` value:
* - Service `adls`: Secret value for service principal
* - Service `managed_data_lake`: Secret value of the service principal you created for Fivetran. Use this parameter only if you want to deploy your data lake on ADLS.
* - Service `onelake`: Secret value for service principal
*/
secretValue: string;
/**
* Field usage depends on `service` value:
* - Service `confluent_cloud_wh`: Security protocol for Confluent Cloud interaction.
*/
securityProtocol: string;
/**
* Field usage depends on `service` value:
* - Service `adls`: Server Host name
* - Service `databricks`: Server name
* - Service `managed_data_lake`: Server host name of the Databricks account associated with Unity Catalog. Use this parameter only if you want to use Unity Catalog to manage your Delta Lake tables.
* - Service `new_s3_datalake`: Server host name
* - Service `onelake`: Server Host name
*/
serverHostName: string;
/**
* Field usage depends on `service` value:
* - Service `adls`: Should maintain tables in Databricks
* - Service `managed_data_lake`: Specifies whether you want to manage your Delta Lake tables in Databricks Unity Catalog.
* - Service `new_s3_datalake`: Should maintain tables in Databricks
* - Service `onelake`: Should maintain tables in Databricks
*/
shouldMaintainTablesInDatabricks: boolean;
/**
* Field usage depends on `service` value:
* - Service `managed_data_lake`: Specifies whether you want to manage your Iceberg tables in AWS Glue. Use this parameter only if you want to deploy your data lake on AWS.
*/
shouldMaintainTablesInGlue: boolean;
/**
* Field usage depends on `service` value:
* - Service `managed_data_lake`: Specifies whether you want to create shortcut for you table in OneLake. Use this parameter only if you want to deploy your data lake on ADLS.
*/
shouldMaintainTablesInOneLake: boolean;
/**
* Field usage depends on `service` value:
* - Service `adls`: Snapshots older than the retention period are deleted every week. Default value: `ONE_WEEK`.
* - Service `managed_data_lake`: Specifies how long you want us to retain your table snapshots. We delete the snapshots that are older than the retention period during our table maintenance operations. Default value: `ONE_WEEK`.
* - Service `new_s3_datalake`: Snapshots older than the retention period are deleted every week. Default value: `ONE_WEEK`.
* - Service `onelake`: Snapshots older than the retention period are deleted every week. Default value: `ONE_WEEK`.
*/
snapshotRetentionPeriod: string;
snowflakeCloud: string;
snowflakeRegion: string;
/**
* Field usage depends on `service` value:
* - Service `azure_sql_data_warehouse`: The access key of the Azure storage account you want to use to stage your data. Use this parameter only if you are using Hybrid Deployment.
* - Service `databricks`: Your storage account key
* - Service `snowflake`: The access key of the Azure storage account you want to use to stage your data. Use this parameter only if you are using Hybrid Deployment and want to use an Azure Blob storage container to stage your data.
*/
storageAccountKey: string;
/**
* Field usage depends on `service` value:
* - Service `adls`: (Immutable) Storage account for Azure Data Lake Storage Gen2 name
* - Service `azure_sql_data_warehouse`: The name of the Azure storage account you want to use to stage your data. Use this parameter only if you are using Hybrid Deployment.
* - Service `databricks`: Your storage account name
* - Service `managed_data_lake`: (Immutable) Name of your Azure Data Lake Storage Gen2 (ADLS Gen2) storage account. Use this parameter only if you want to deploy your data lake on ADLS.
* - Service `onelake`: (Immutable) Storage account for Azure Data Lake Storage Gen2 name
* - Service `snowflake`: The name of the Azure storage account you want to use to stage your data. Use this parameter only if you are using Hybrid Deployment and want to use an Azure Blob storage container to stage your data.
*/
storageAccountName: string;
/**
* Field usage depends on `service` value:
* - Service `managed_data_lake`: The cloud storage provider you want to use for your data lake.
*/
storageProvider: string;
/**
* Field usage depends on `service` value:
* - Service `big_query`: Stores JSON columns as JSON instead of STRING. This parameter is applicable only to destinations created before August 1, 2025.
* - Service `big_query_dts`: Stores JSON columns as JSON instead of STRING. This parameter is applicable only to destinations created before August 1, 2025.
* - Service `managed_big_query`: Stores JSON columns as JSON instead of STRING. This parameter is applicable only to destinations created before August 1, 2025.
*/
supportJsonType: boolean;
/**
* Field usage depends on `service` value:
* - Service `new_s3_datalake`: (Immutable) The table format in which you want to sync your tables. Valid values are ICEBERG and DELTA_LAKE
*/
tableFormat: string;
/**
* Field usage depends on `service` value:
* - Service `adls`: Tenant id of service principal
* - Service `managed_data_lake`: Tenant ID of the service principal you created for Fivetran. Use this parameter only if you want to deploy your data lake on ADLS.
* - Service `onelake`: Tenant ID of service principal
*/
tenantId: string;
/**
* Field usage depends on `service` value:
* - Service `aurora_postgres_warehouse`: SSH server name. Must be populated if `connection_type` is set to `SshTunnel`.
* - Service `aurora_warehouse`: SSH server name. Must be populated if `connection_type` is set to `SshTunnel`.
* - Service `azure_postgres_warehouse`: SSH server name. Must be populated if `connection_type` is set to `SshTunnel`.
* - Service `azure_sql_data_warehouse`: SSH server name. Must be populated if `connection_type` is set to `SshTunnel`.
* - Service `azure_sql_database`: SSH server name. Must be populated if `connection_type` is set to `SshTunnel`.
* - Service `azure_sql_managed_db_warehouse`: SSH server name. Must be populated if `connection_type` is set to `SshTunnel`.
* - Service `maria_rds_warehouse`: SSH server name. Must be populated if `connection_type` is set to `SshTunnel`.
* - Service `maria_warehouse`: SSH server name. Must be populated if `connection_type` is set to `SshTunnel`.
* - Service `mysql_rds_warehouse`: SSH server name. Must be populated if `connection_type` is set to `SshTunnel`.
* - Service `mysql_warehouse`: SSH server name. Must be populated if `connection_type` is set to `SshTunnel`.
* - Service `oracle_rac_warehouse`: SSH server name. Must be populated if `connection_type` is set to `SshTunnel`.
* - Service `oracle_rds_warehouse`: SSH server name. Must be populated if `connection_type` is set to `SshTunnel`.
* - Service `oracle_warehouse`: SSH server name. Must be populated if `connection_type` is set to `SshTunnel`.
* - Service `panoply`: SSH server name. Must be populated if `connection_type` is set to `SshTunnel`.
* - Service `periscope_warehouse`: SSH server name. Must be populated if `connection_type` is set to `SshTunnel`.
* - Service `postgres_databricks_warehouse`: SSH server name. Must be populated if `connection_type` is set to `SshTunnel`.
* - Service `postgres_gcp_warehouse`: SSH server name. Must be populated if `connection_type` is set to `SshTunnel`.
* - Service `postgres_rds_warehouse`: SSH server name. Must be populated if `connection_type` is set to `SshTunnel`.
* - Service `postgres_warehouse`: SSH server name. Must be populated if `connection_type` is set to `SshTunnel`.
* - Service `redshift`: SSH server name. Must be populated if `connection_type` is set to `SshTunnel`.
* - Service `sql_server_rds_warehouse`: SSH server name. Must be populated if `connection_type` is set to `SshTunnel`.
* - Service `sql_server_warehouse`: SSH server name. Must be populated if `connection_type` is set to `SshTunnel`.
*/
tunnelHost: string;
/**
* Field usage depends on `service` value:
* - Service `aurora_postgres_warehouse`: SSH server port name. Must be populated if `connection_type` is set to `SshTunnel`.
* - Service `aurora_warehouse`: SSH server port name. Must be populated if `connection_type` is set to `SshTunnel`.
* - Service `azure_postgres_warehouse`: SSH server port name. Must be populated if `connection_type` is set to `SshTunnel`.
* - Service `azure_sql_data_warehouse`: SSH server port name. Must be populated if `connection_type` is set to `SshTunnel`.
* - Service `azure_sql_database`: SSH server port name. Must be populated if `connection_type` is set to `SshTunnel`.
* - Service `azure_sql_managed_db_warehouse`: SSH server port name. Must be populated if `connection_type` is set to `SshTunnel`.
* - Service `maria_rds_warehouse`: SSH server port name. Must be populated if `connection_type` is set to `SshTunnel`.
* - Service `maria_warehouse`: SSH server port name. Must be populated if `connection_type` is set to `SshTunnel`.
* - Service `mysql_rds_warehouse`: SSH server port name. Must be populated if `connection_type` is set to `SshTunnel`.
* - Service `mysql_warehouse`: SSH server port name. Must be populated if `connection_type` is set to `SshTunnel`.
* - Service `oracle_rac_warehouse`: SSH server port name. Must be populated if `connection_type` is set to `SshTunnel`.
* - Service `oracle_rds_warehouse`: SSH server port name. Must be populated if `connection_type` is set to `SshTunnel`.
* - Service `oracle_warehouse`: SSH server port name. Must be populated if `connection_type` is set to `SshTunnel`.
* - Service `panoply`: SSH server port name. Must be populated if `connection_type` is set to `SshTunnel`.
* - Service `periscope_warehouse`: SSH server port name. Must be populated if `connection_type` is set to `SshTunnel`.
* - Service `postgres_databricks_warehouse`: SSH server port name. Must be populated if `connection_type` is set to `SshTunnel`.
* - Service `postgres_gcp_warehouse`: SSH server port name. Must be populated if `connection_type` is set to `SshTunnel`.
* - Service `postgres_rds_warehouse`: SSH server port name. Must be populated if `connection_type` is set to `SshTunnel`.
* - Service `postgres_warehouse`: SSH server port name. Must be populated if `connection_type` is set to `SshTunnel`.
* - Service `redshift`: SSH server port name. Must be populated if `connection_type` is set to `SshTunnel`.
* - Service `sql_server_rds_warehouse`: SSH server port name. Must be populated if `connection_type` is set to `SshTunnel`.
* - Service `sql_server_warehouse`: SSH server port name. Must be populated if `connection_type` is set to `SshTunnel`.
*/
tunnelPort: number;
/**
* Field usage depends on `service` value:
* - Service `aurora_postgres_warehouse`: SSH user name. Must be populated if `connection_type` is set to `SshTunnel`.
* - Service `aurora_warehouse`: SSH user name. Must be populated if `connection_type` is set to `SshTunnel`.
* - Service `azure_postgres_warehouse`: SSH user name. Must be populated if `connection_type` is set to `SshTunnel`.
* - Service `azure_sql_data_warehouse`: SSH user name. Must be populated if `connection_type` is set to `SshTunnel`.
* - Service `azure_sql_database`: SSH user name. Must be populated if `connection_type` is set to `SshTunnel`.
* - Service `azure_sql_managed_db_warehouse`: SSH user name. Must be populated if `connection_type` is set to `SshTunnel`.
* - Service `maria_rds_warehouse`: SSH user name. Must be populated if `connection_type` is set to `SshTunnel`.
* - Service `maria_warehouse`: SSH user name. Must be populated if `connection_type` is set to `SshTunnel`.
* - Service `mysql_rds_warehouse`: SSH user name. Must be populated if `connection_type` is set to `SshTunnel`.
* - Service `mysql_warehouse`: SSH user name. Must be populated if `connection_type` is set to `SshTunnel`.
* - Service `oracle_rac_warehouse`: SSH user name. Must be populated if `connection_type` is set to `SshTunnel`.
* - Service `oracle_rds_warehouse`: SSH user name. Must be populated if `connection_type` is set to `SshTunnel`.
* - Service `oracle_warehouse`: SSH user name. Must be populated if `connection_type` is set to `SshTunnel`.
* - Service `panoply`: SSH user name. Must be populated if `connection_type` is set to `SshTunnel`.
* - Service `periscope_warehouse`: SSH user name. Must be populated if `connection_type` is set to `SshTunnel`.
* - Service `postgres_databricks_warehouse`: SSH user name. Must be populated if `connection_type` is set to `SshTunnel`.
* - Service `postgres_gcp_warehouse`: SSH user name. Must be populated if `connection_type` is set to `SshTunnel`.
* - Service `postgres_rds_warehouse`: SSH user name. Must be populated if `connection_type` is set to `SshTunnel`.
* - Service `postgres_warehouse`: SSH user name. Must be populated if `connection_type` is set to `SshTunnel`.
* - Service `redshift`: SSH user name. Must be populated if `connection_type` is set to `SshTunnel`.
* - Service `sql_server_rds_warehouse`: SSH user name. Must be populated if `connection_type` is set to `SshTunnel`.
* - Service `sql_server_warehouse`: SSH user name. Must be populated if `connection_type` is set to `SshTunnel`.
*/
tunnelUser: string;
/**
* Field usage depends on `service` value:
* - Service `snowflake`: Set to `true` if you want to use an S3 bucket to stage your data. Use this parameter only if you are using Hybrid Deployment and want to use an S3 bucket to stage your data.
*/
useCustomerStaging: boolean;
/**
* Field usage depends on `service` value:
* - Service `aurora_postgres_warehouse`: Database user name
* - Service `aurora_warehouse`: Database user name
* - Service `azure_postgres_warehouse`: Database user name
* - Service `azure_sql_data_warehouse`: Database user name
* - Service `azure_sql_database`: Database user name
* - Service `azure_sql_managed_db_warehouse`: Database user name
* - Service `maria_rds_warehouse`: Database user name
* - Service `maria_warehouse`: Database user name
* - Service `mysql_rds_warehouse`: Database user name
* - Service `mysql_warehouse`: Database user name
* - Service `oracle_rac_warehouse`: Database user name
* - Service `oracle_rds_warehouse`: Database user name
* - Service `oracle_warehouse`: Database user name
* - Service `panoply`: Database user name
* - Service `periscope_warehouse`: Database user name
* - Service `postgres_databricks_warehouse`: Database user name
* - Service `postgres_gcp_warehouse`: Database user name
* - Service `postgres_rds_warehouse`: Database user name
* - Service `postgres_warehouse`: Database user name
* - Service `redshift`: Database user name
* - Service `snowflake`: Database user name
* - Service `sql_server_rds_warehouse`: Database user name
* - Service `sql_server_warehouse`: Database user name
*/
user: string;
/**
* Field usage depends on `service` value:
* - Service `managed_data_lake`: (Immutable) OneLake workspace GUID.
* - Service `onelake`: (Immutable) OneLake workspace GUID
*/
workspaceGuid: string;
/**
* Field usage depends on `service` value:
* - Service `onelake`: OneLake workspace name
*/
workspaceName: string;
}
export interface GetDestinationFingerprintsFingerprint {
/**
* Hash of the fingerprint.
*/
hash: string;
/**
* The SSH public key.
*/
publicKey: string;
/**
* User name who validated the fingerprint.
*/
validatedBy: string;
/**
* The date when fingerprint was approved.
*/
validatedDate: string;
}
export interface GetDestinationsDestination {
/**
* Shift my UTC offset with daylight savings time (US Only)
*/
daylightSavingTimeEnabled: boolean;
/**
* The unique identifier for the Group within the Fivetran system.
*/
groupId: string;
/**
* The hybrid deployment agent ID that refers to the controller created for the group the connection belongs to. If the value is specified, the system will try to associate the connection with an existing agent.
*/
hybridDeploymentAgentId: string;
/**
* The unique identifier for the destination within the Fivetran system.
*/
id: string;
/**
* Possible values: Directly, SshTunnel, ProxyAgent, PrivateLink.
*/
networkingMethod: string;
/**
* The private link ID.
*/
privateLinkId: string;
/**
* The proxy agent ID.
*/
proxyAgentId: string;
/**
* Data processing location. This is where Fivetran will operate and run computation on data.
*/
region: string;
/**
* The destination type id within the Fivetran system.
*/
service: string;
/**
* Destination setup status.
*/
setupStatus: string;
/**
* Determines the time zone for the Fivetran sync schedule.
*/
timeZoneOffset: string;
}
export interface GetExternalLoggingConfig {
accessKeyId: string;
accessKeySecret: string;
apiKey: string;
channel: string;
enableSsl: boolean;
externalId: string;
host: string;
hostname: string;
logGroupName: string;
port: number;
primaryKey: string;
projectId: string;
region: string;
roleArn: string;
serviceAccountKey: string;
subDomain: string;
token: string;
workspaceId: string;
}
export interface GetExternalLogsLog {
/**
* The boolean value specifying whether the log service is enabled.
*/
enabled: boolean;
/**
* The unique identifier for the log service within the Fivetran system.
*/
id: string;
/**
* The name for the log service type within the Fivetran system. We support the following log services: azure_monitor_log, cloudwatch, datadog_log, new_relic_log, splunkLog, stackdriver.
*/
service: string;
}
export interface GetGroupConnectionsConnection {
/**
* The unique identifier of the user who has created the connection in your account
*/
connectedBy: string;
/**
* The timestamp of the time the connection was created in your account
*/
createdAt: string;
/**
* The optional parameter that defines the sync start time when the sync frequency is already set or being set by the current request to 1440. It can be specified in one hour increments starting from 00:00 to 23:00. If not specified, we will use [the baseline sync start time](https://fivetran.com/docs/getting-started/syncoverview#syncfrequencyandscheduling). This parameter has no effect on the [0 to 60 minutes offset](https://fivetran.com/docs/getting-started/syncoverview#syncstarttimesandoffsets) used to determine the actual sync start time
*/
dailySyncTime: string;
/**
* The timestamp of the time the connection sync failed last time
*/
failedAt: string;
/**
* The unique identifier for the Group within the Fivetran system.
*/
groupId: string;
/**
* The unique identifier for the Connector within the Fivetran system.
*/
id: string;
/**
* The connection schedule configuration type. Supported values: auto, manual
*/
scheduleType: string;
/**
* The name used both as the connection's name within the Fivetran system and as the source schema's name within your destination
*/
schema: string;
/**
* The connector type name within the Fivetran system
*/
service: string;
/**
* The connector type version within the Fivetran system
*/
serviceVersion: number;
status?: outputs.GetGroupConnectionsConnectionStatus;
/**
* The timestamp of the time the connection sync succeeded last time
*/
succeededAt: string;
/**
* The connection sync frequency in minutes
*/
syncFrequency: number;
}
export interface GetGroupConnectionsConnectionStatus {
/**
* The boolean specifying whether the connection should be triggered to re-sync all historical data. If you set this parameter to TRUE, the next scheduled sync will be historical. If the value is FALSE or not specified, the connection will not re-sync historical data. NOTE: When the value is TRUE, only the next scheduled sync will be historical, all subsequent ones will be incremental. This parameter is set to FALSE once the historical sync is completed.
*/
isHistoricalSync: boolean;
/**
* The current setup state of the connection. The available values are:
- incomplete - the setup config is incomplete, the setup tests never succeeded
- connected - the connection is properly set up
- broken - the connection setup config is broken.
*/
setupState: string;
/**
* The current sync state of the connection. The available values are:
- scheduled - the sync is waiting to be run
- syncing - the sync is currently running
- paused - the sync is currently paused
- rescheduled - the sync is waiting until more API calls are available in the source service.
*/
syncState: string;
/**
* The collection of tasks for the connection
*/
tasks?: outputs.GetGroupConnectionsConnectionStatusTask[];
/**
* The current data update state of the connection. The available values are:
- on_schedule - the sync is running smoothly, no delays
- delayed - the data is delayed for a longer time than expected for the update.
*/
updateState: string;
/**
* The collection of warnings for the connection.
*/
warnings?: outputs.GetGroupConnectionsConnectionStatusWarning[];
}
export interface GetGroupConnectionsConnectionStatusTask {
/**
* Response status code
*/
code: string;
/**
* Response status text
*/
message: string;
}
export interface GetGroupConnectionsConnectionStatusWarning {
/**
* Response status code
*/
code: string;
/**
* Response status text
*/
message: string;
}
export interface GetGroupConnectorsConnector {
/**
* The unique identifier of the user who has created the connector in your account
*/
connectedBy: string;
/**
* The timestamp of the time the connector was created in your account
*/
createdAt: string;
/**
* The optional parameter that defines the sync start time when the sync frequency is already set or being set by the current request to 1440. It can be specified in one hour increments starting from 00:00 to 23:00. If not specified, we will use [the baseline sync start time](https://fivetran.com/docs/getting-started/syncoverview#syncfrequencyandscheduling). This parameter has no effect on the [0 to 60 minutes offset](https://fivetran.com/docs/getting-started/syncoverview#syncstarttimesandoffsets) used to determine the actual sync start time
*/
dailySyncTime: string;
/**
* The timestamp of the time the connector sync failed last time
*/
failedAt: string;
/**
* The unique identifier for the Group within the Fivetran system.
*/
groupId: string;
/**
* The unique identifier for the Connector within the Fivetran system.
*/
id: string;
/**
* The connector schedule configuration type. Supported values: auto, manual
*/
scheduleType: string;
/**
* The name used both as the connector's name within the Fivetran system and as the source schema's name within your destination
*/
schema: string;
/**
* The connector type name within the Fivetran system
*/
service: string;
/**
* The connector type version within the Fivetran system
*/
serviceVersion: number;
status?: outputs.GetGroupConnectorsConnectorStatus;
/**
* The timestamp of the time the connector sync succeeded last time
*/
succeededAt: string;
/**
* The connector sync frequency in minutes
*/
syncFrequency: number;
}
export interface GetGroupConnectorsConnectorStatus {
/**
* The boolean specifying whether the connector should be triggered to re-sync all historical data. If you set this parameter to TRUE, the next scheduled sync will be historical. If the value is FALSE or not specified, the connector will not re-sync historical data. NOTE: When the value is TRUE, only the next scheduled sync will be historical, all subsequent ones will be incremental. This parameter is set to FALSE once the historical sync is completed.
*/
isHistoricalSync: boolean;
/**
* The current setup state of the connector. The available values are:
- incomplete - the setup config is incomplete, the setup tests never succeeded
- connected - the connector is properly set up
- broken - the connector setup config is broken.
*/
setupState: string;
/**
* The current sync state of the connector. The available values are:
- scheduled - the sync is waiting to be run
- syncing - the sync is currently running
- paused - the sync is currently paused
- rescheduled - the sync is waiting until more API calls are available in the source service.
*/
syncState: string;
/**
* The collection of tasks for the connector
*/
tasks?: outputs.GetGroupConnectorsConnectorStatusTask[];
/**
* The current data update state of the connector. The available values are:
- on_schedule - the sync is running smoothly, no delays
- delayed - the data is delayed for a longer time than expected for the update.
*/
updateState: string;
/**
* The collection of warnings for the connector.
*/
warnings?: outputs.GetGroupConnectorsConnectorStatusWarning[];
}
export interface GetGroupConnectorsConnectorStatusTask {
/**
* Response status code
*/
code: string;
/**
* Response status text
*/
message: string;
}
export interface GetGroupConnectorsConnectorStatusWarning {
/**
* Response status code
*/
code: string;
/**
* Response status text
*/
message: string;
}
export interface GetGroupUsersUser {
/**
* The timestamp that the user created their Fivetran account
*/
createdAt: string;
/**
* The email address that the user has associated with their user profile.
*/
email: string;
/**
* The last name of the user.
*/
familyName: string;
/**
* The first name of the user.
*/
givenName: string;
/**
* The unique identifier for the user within the account.
*/
id: string;
/**
* The field indicates whether the user has verified their email address in the account creation process.
*/
invited: boolean;
/**
* The last time that the user has logged into their Fivetran account.
*/
loggedInAt: string;
/**
* The phone number of the user.
*/
phone: string;
/**
* The user's avatar as a URL link (for example, 'http://mycompany.com/avatars/john_white.png') or base64 data URI (for example, 'data:image/png;base64,aHR0cDovL215Y29tcGFueS5jb20vYXZhdGFycy9qb2huX3doaXRlLnBuZw==')
*/
picture: string;
/**
* The group role that you would like to assign this new user to. Supported group roles: ‘Manage Destination‘, ‘View Destination‘, ‘Edit Destination‘, ‘Create Connection‘, or a custom destination role
*/
role: string;
/**
* The field indicates whether the user has verified their email address in the account creation process.
*/
verified: boolean;
}
export interface GetGroupsGroup {
/**
* The timestamp of when the group was created in your account.
*/
createdAt: string;
/**
* The unique identifier for the group within the Fivetran system.
*/
id: string;
/**
* The timestamp of when the resource/datasource was updated last time.
*/
lastUpdated: string;
/**
* The name of the group within your account.
*/
name: string;
}
export interface GetHybridDeploymentAgentsItem {
/**
* The unique name for the hybrid deployment agent.
*/
displayName: string;
/**
* The unique identifier for the Group within the Fivetran system.
*/
groupId: string;
/**
* The unique identifier for the hybrid deployment agent within your account.
*/
id: string;
/**
* The timestamp of the time the hybrid deployment agent was created in your account.
*/
registeredAt: string;
}
export interface GetPrivateLinksItem {
/**
* The cloud provider name.
*/
cloudProvider: string;
/**
* The date and time the membership was created.
*/
createdAt: string;
/**
* The unique identifier for the User within the Fivetran system.
*/
createdBy: string;
/**
* The private link host.
*/
host: string;
/**
* The unique identifier for the private link within the Fivetran system.
*/
id: string;
/**
* The private link name within the account. The name must start with a letter or underscore and can only contain letters, numbers, or underscores. Maximum size of name is 23 characters.
*/
name: string;
/**
* Data processing location. This is where Fivetran will operate and run computation on data.
*/
region: string;
/**
* Service type.
*/
service: string;
/**
* The state of the private link.
*/
state: string;
/**
* The state of the private link.
*/
stateSummary: string;
}
export interface GetProxyAgentsItem {
/**
* The actor who created the proxy agent.
*/
createdBy: string;
/**
* Proxy agent name.
*/
displayName: string;
/**
* Data processing location. This is where Fivetran will operate and run computation on data.
*/
groupRegion: string;
/**
* The unique identifier for the proxy within your account.
*/
id: string;
/**
* The timestamp of the time the proxy agent was created in your account.
*/
registredAt: string;
}
export interface GetQuickstartPackagesPackage {
/**
* The set of connector types
*/
connectorTypes: string[];
/**
* The unique identifier for the Quickstart transformation package definition within the Fivetran system
*/
id: string;
/**
* The Quickstart transformation package name
*/
name: string;
/**
* The list of transformation output models
*/
outputModelNames: string[];
/**
* The Quickstart package definition version
*/
version: string;
}
export interface GetRolesRole {
/**
* The role description
*/
description: string;
/**
* Defines whether the role is standard or custom
*/
isCustom: boolean;
/**
* Defines whether the role is deprecated
*/
isDeprecated: boolean;
/**
* The role name
*/
name: string;
/**
* The name of the new role replacing the deprecated role
*/
replacementRoleName: string;
/**
* Defines the list of resources the role manages. Supported values: ACCOUNT, DESTINATION, CONNECTOR, and TEAM
*/
scopes: string[];
}
export interface GetTeamConnectionMembershipsConnection {
/**
* The connection unique identifier
*/
connectionId: string;
/**
* The date and time the membership was created
*/
createdAt: string;
/**
* The team's role that links the team and the connection
*/
role: string;
}
export interface GetTeamConnectorMembershipsConnector {
/**
* The connector unique identifier
*/
connectorId: string;
/**
* The date and time the membership was created
*/
createdAt: string;
/**
* The team's role that links the team and the connector
*/
role: string;
}
export interface GetTeamGroupMembershipsGroup {
/**
* The date and time the membership was created
*/
createdAt: string;
/**
* The group unique identifier
*/
groupId: string;
/**
* The team's role that links the team and the group
*/
role: string;
}
export interface GetTeamUserMembershipsUser {
/**
* The team's role that links the team and the user
*/
role: string;
/**
* The user unique identifier
*/
userId: string;
}
export interface GetTeamsTeam {
/**
* The description of the team within your account.
*/
description: string;
/**
* The unique identifier for the team within your account.
*/
id: string;
/**
* The name of the team within your account.
*/
name: string;
/**
* The account role of the team.
*/
role: string;
}
export interface GetTransformationProjectProjectConfig {
/**
* The version of transformation that should run the project
*/
dbtVersion: string;
/**
* Default schema in destination. This production schema will contain your transformed data.
*/
defaultSchema: string;
/**
* List of environment variables defined as key-value pairs in the raw string format using = as a separator. The variable name should have the DBT_ prefix and can contain A-Z, 0-9, dash, underscore, or dot characters. Example: "DBT_VARIABLE=variable_value"
*/
environmentVars: string[];
/**
* Folder in Git repo with your transformation project
*/
folderPath: string;
/**
* Git branch
*/
gitBranch: string;
/**
* Git remote URL with your transformation project
*/
gitRemoteUrl: string;
/**
* Public key to grant Fivetran SSH access to git repository.
*/
publicKey: string;
/**
* Target name to set or override the value from the deployment.yaml
*/
targetName: string;
/**
* The number of threads transformation will use (from 1 to 32). Make sure this value is compatible with your destination type. For example, Snowflake supports only 8 concurrent queries on an X-Small warehouse.
*/
threads: number;
}
export interface GetTransformationProjectsProject {
/**
* The timestamp of when the project was created in your account.
*/
createdAt: string;
/**
* The unique identifier for the User within the Fivetran system who created the transformation Project.
*/
createdById: string;
/**
* The name of the group within your account related to the project.
*/
groupId: string;
/**
* The unique identifier for the transformation project within the Fivetran system.
*/
id: string;
/**
* Transformation project type.
*/
type: string;
}
export interface GetTransformationSchedule {
/**
* The list of the connection identifiers to be used for the integrated schedule. Not expected for QUICKSTART transformations
*/
connectionIds: string[];
/**
* Cron schedule: list of CRON strings. Used for for CRON schedule type
*/
crons: string[];
/**
* The set of the days of the week the transformation should be launched on. The following values are supported: MONDAY, TUESDAY, WEDNESDAY, THURSDAY, FRIDAY, SATURDAY, SUNDAY. Used for for INTEGRATED schedule type
*/
daysOfWeeks: string[];
/**
* The time interval in minutes between subsequent transformation runs. Used for for INTERVAL schedule type
*/
interval: number;
/**
* The type of the schedule to run the Transformation on. The following values are supported: INTEGRATED, TIME_OF_DAY, INTERVAL, CRON.
*/
scheduleType: string;
/**
* The boolean flag that enables the Smart Syncing schedule
*/
smartSyncing: boolean;
/**
* The time of the day the transformation should be launched at. Supported values are: "00:00", "01:00", "02:00", "03:00", "04:00", "05:00", "06:00", "07:00", "08:00", "09:00", "10:00", "11:00", "12:00", "13:00", "14:00", "15:00", "16:00", "17:00", "18:00", "19:00", "20:00", "21:00", "22:00", "23:00". Used for for TIME_OF_DAY schedule type
*/
timeOfDay: string;
}
export interface GetTransformationTransformationConfig {
/**
* The list of the connection identifiers to be used for the integrated schedule. Also used to identify package_name automatically if package_name was not specified
*/
connectionIds: string[];
/**
* The list of excluded output model names
*/
excludedModels: string[];
/**
* The transformation name
*/
name: string;
/**
* The Quickstart transformation package name
*/
packageName: string;
/**
* The unique identifier for the dbt Core project within the Fivetran system
*/
projectId: string;
steps: outputs.GetTransformationTransformationConfigStep[];
/**
* The boolean flag indicating that a newer version is available for the transformation package
*/
upgradeAvailable: boolean;
}
export interface GetTransformationTransformationConfigStep {
/**
* The dbt command in the transformation step
*/
command: string;
/**
* The step name
*/
name: string;
}
export interface GetTransformationsTransformation {
/**
* The timestamp of when the transformation was created in your account.
*/
createdAt: string;
/**
* The unique identifier for the User within the Fivetran system who created the transformation.
*/
createdById: string;
/**
* The unique identifier for the Transformation within the Fivetran system.
*/
id: string;
/**
* Identifiers of related models.
*/
outputModelNames: string[];
/**
* The field indicating whether the transformation will be set into the paused state. By default, the value is false.
*/
paused: boolean;
schedule?: outputs.GetTransformationsTransformationSchedule;
/**
* Status of transformation Project (NOT_READY, READY, ERROR).
*/
status: string;
transformationConfig?: outputs.GetTransformationsTransformationTransformationConfig;
/**
* Transformation type. The following values are supported: DBT_CORE, QUICKSTART.
*/
type: string;
}
export interface GetTransformationsTransformationSchedule {
/**
* The list of the connection identifiers to be used for the integrated schedule. Not expected for QUICKSTART transformations
*/
connectionIds: string[];
/**
* Cron schedule: list of CRON strings. Used for for CRON schedule type
*/
crons: string[];
/**
* The set of the days of the week the transformation should be launched on. The following values are supported: MONDAY, TUESDAY, WEDNESDAY, THURSDAY, FRIDAY, SATURDAY, SUNDAY. Used for for INTEGRATED schedule type
*/
daysOfWeeks: string[];
/**
* The time interval in minutes between subsequent transformation runs. Used for for INTERVAL schedule type
*/
interval: number;
/**
* The type of the schedule to run the Transformation on. The following values are supported: INTEGRATED, TIME_OF_DAY, INTERVAL, CRON.
*/
scheduleType: string;
/**
* The boolean flag that enables the Smart Syncing schedule
*/
smartSyncing: boolean;
/**
* The time of the day the transformation should be launched at. Supported values are: "00:00", "01:00", "02:00", "03:00", "04:00", "05:00", "06:00", "07:00", "08:00", "09:00", "10:00", "11:00", "12:00", "13:00", "14:00", "15:00", "16:00", "17:00", "18:00", "19:00", "20:00", "21:00", "22:00", "23:00". Used for for TIME_OF_DAY schedule type
*/
timeOfDay: string;
}
export interface GetTransformationsTransformationTransformationConfig {
/**
* The list of the connection identifiers to be used for the integrated schedule. Also used to identify package_name automatically if package_name was not specified
*/
connectionIds: string[];
/**
* The list of excluded output model names
*/
excludedModels: string[];
/**
* The transformation name
*/
name: string;
/**
* The Quickstart transformation package name
*/
packageName: string;
/**
* The unique identifier for the dbt Core project within the Fivetran system
*/
projectId: string;
steps: outputs.GetTransformationsTransformationTransformationConfigStep[];
/**
* The boolean flag indicating that a newer version is available for the transformation package
*/
upgradeAvailable: boolean;
}
export interface GetTransformationsTransformationTransformationConfigStep {
/**
* The dbt command in the transformation step
*/
command: string;
/**
* The step name
*/
name: string;
}
export interface GetUserConnectionMembershipsConnection {
/**
* The connection unique identifier
*/
connectionId: string;
/**
* The date and time the membership was created
*/
createdAt: string;
/**
* The user's role that links the user and the connection
*/
role: string;
}
export interface GetUserConnectorMembershipsConnector {
/**
* The connector unique identifier
*/
connectorId: string;
/**
* The date and time the membership was created
*/
createdAt: string;
/**
* The user's role that links the user and the connector
*/
role: string;
}
export interface GetUserGroupMembershipsGroup {
/**
* The date and time the membership was created
*/
createdAt: string;
/**
* The group unique identifier
*/
groupId: string;
/**
* The user's role that links the user and the group
*/
role: string;
}
export interface GetUsersUser {
/**
* The timestamp that the user created their Fivetran account
*/
createdAt: string;
/**
* The email address that the user has associated with their user profile.
*/
email: string;
/**
* The last name of the user.
*/
familyName: string;
/**
* The first name of the user.
*/
givenName: string;
/**
* The unique identifier for the user within your account.
*/
id: string;
/**
* The field indicates whether the user has been invited to your account.
*/
invited: boolean;
/**
* The last time that the user has logged into their Fivetran account.
*/
loggedInAt: string;
/**
* The phone number of the user.
*/
phone: string;
/**
* The user's avatar as a URL link (for example, 'http://mycompany.com/avatars/john_white.png') or base64 data URI (for example, 'data:image/png;base64,aHR0cDovL215Y29tcGFueS5jb20vYXZhdGFycy9qb2huX3doaXRlLnBuZw==')
*/
picture: string;
/**
* The field indicates whether the user has verified their email address in the account creation process.
*/
verified: boolean;
}
export interface GetWebhooksWebhook {
/**
* Boolean, if set to true, webhooks are immediately sent in response to events
*/
active: boolean;
/**
* The webhook creation timestamp
*/
createdAt: string;
/**
* The ID of the user who created the webhook.
*/
createdBy: string;
/**
* The array of event types
*/
events: string[];
/**
* The group ID
*/
groupId: string;
/**
* The webhook ID
*/
id: string;
/**
* Specifies whether the setup tests should be run
*/
runTests: boolean;
/**
* The secret string used for payload signing and masked in the response.
*/
secret: string;
/**
* The webhook type (group, account)
*/
type: string;
/**
* Your webhooks URL endpoint for your application
*/
url: string;
}
export interface GroupUsersUser {
/**
* The email address that the user has associated with their user profile.
*/
email: string;
/**
* The unique identifier for the user within the account.
*/
id: string;
/**
* The group role that you would like to assign this new user to. Supported group roles: ‘Destination Administrator‘, ‘Destination Reviewer‘, ‘Destination Analyst‘, ‘Connector Creator‘, or a custom destination role
*/
role: string;
}
export interface TeamConnectorMembershipConnector {
/**
* The connector unique identifier
*/
connectorId: string;
/**
* The date and time the membership was created
*/
createdAt: string;
/**
* The team's role that links the team and the connector
*/
role: string;
}
export interface TeamGroupMembershipGroup {
/**
* The date and time the membership was created
*/
createdAt: string;
/**
* The group unique identifier
*/
groupId: string;
/**
* The team's role that links the team and the group
*/
role: string;
}
export interface TeamUserMembershipUser {
/**
* The team's role that links the team and the user
*/
role: string;
/**
* The user unique identifier
*/
userId: string;
}
export interface TransformationProjectProjectConfig {
/**
* The version of transformation that should run the project
*/
dbtVersion?: string;
/**
* Default schema in destination. This production schema will contain your transformed data.
*/
defaultSchema?: string;
/**
* List of environment variables defined as key-value pairs in the raw string format using = as a separator. The variable name should have the DBT_ prefix and can contain A-Z, 0-9, dash, underscore, or dot characters. Example: "DBT_VARIABLE=variable_value"
*/
environmentVars?: string[];
/**
* Folder in Git repo with your transformation project
*/
folderPath?: string;
/**
* Git branch
*/
gitBranch?: string;
/**
* Git remote URL with your transformation project
*/
gitRemoteUrl?: string;
/**
* Public key to grant Fivetran SSH access to git repository.
*/
publicKey: string;
/**
* Target name to set or override the value from the deployment.yaml
*/
targetName?: string;
/**
* The number of threads transformation will use (from 1 to 32). Make sure this value is compatible with your destination type. For example, Snowflake supports only 8 concurrent queries on an X-Small warehouse.
*/
threads: number;
}
export interface TransformationSchedule {
/**
* The list of the connection identifiers to be used for the integrated schedule. Not expected for QUICKSTART transformations
*/
connectionIds?: string[];
/**
* Cron schedule: list of CRON strings. Used for for CRON schedule type
*/
crons?: string[];
/**
* The set of the days of the week the transformation should be launched on. The following values are supported: MONDAY, TUESDAY, WEDNESDAY, THURSDAY, FRIDAY, SATURDAY, SUNDAY. Used for for INTEGRATED schedule type
*/
daysOfWeeks?: string[];
/**
* The time interval in minutes between subsequent transformation runs. Used for for INTERVAL schedule type
*/
interval: number;
/**
* The type of the schedule to run the Transformation on. The following values are supported: INTEGRATED, TIME_OF_DAY, INTERVAL, CRON.
*/
scheduleType: string;
/**
* The boolean flag that enables the Smart Syncing schedule
*/
smartSyncing: boolean;
/**
* The time of the day the transformation should be launched at. Supported values are: "00:00", "01:00", "02:00", "03:00", "04:00", "05:00", "06:00", "07:00", "08:00", "09:00", "10:00", "11:00", "12:00", "13:00", "14:00", "15:00", "16:00", "17:00", "18:00", "19:00", "20:00", "21:00", "22:00", "23:00". Used for for TIME_OF_DAY schedule type
*/
timeOfDay?: string;
}
export interface TransformationTransformationConfig {
/**
* The list of the connection identifiers to be used for the integrated schedule. Also used to identify package_name automatically if package_name was not specified
*/
connectionIds?: string[];
/**
* The list of excluded output model names
*/
excludedModels?: string[];
/**
* The transformation name
*/
name?: string;
/**
* The Quickstart transformation package name
*/
packageName?: string;
/**
* The unique identifier for the dbt Core project within the Fivetran system
*/
projectId?: string;
steps?: outputs.TransformationTransformationConfigStep[];
/**
* The boolean flag indicating that a newer version is available for the transformation package
*/
upgradeAvailable: boolean;
}
export interface TransformationTransformationConfigStep {
/**
* The dbt command in the transformation step
*/
command?: string;
/**
* The step name
*/
name?: string;
}
export interface UserConnectorMembershipConnector {
/**
* The connector unique identifier
*/
connectorId: string;
/**
* The date and time the membership was created
*/
createdAt: string;
/**
* The user's role that links the user and the connector
*/
role: string;
}
export interface UserGroupMembershipGroup {
/**
* The date and time the membership was created
*/
createdAt: string;
/**
* The group unique identifier
*/
groupId: string;
/**
* The user's role that links the user and the group
*/
role: string;
}