Amazon Kinesis Firehose API Configuration

For more information about authentication, accessing the Fivetran REST API, and request and response formats, see Getting Started with the Fivetran REST API.

Request

POST https://api.fivetran.com/v1/connections

{
  "group_id": "group_id",
  "service": "kinesis",
  "trust_certificates": true,
  "trust_fingerprints": true,
  "run_setup_tests": true,
  "paused": false,
  "pause_after_trial": false,
  "sync_frequency": 1440,
  "data_delay_sensitivity": "NORMAL",
  "data_delay_threshold": 0,
  "daily_sync_time": "14:00",
  "schedule_type": "auto",
  "connect_card_config": {
    "redirect_uri": "https://your.site/path",
    "hide_setup_guide": true,
    "all_fields": true
  },
  "proxy_agent_id": "proxy_agent_id",
  "private_link_id": "private_link_id",
  "networking_method": "Directly",
  "hybrid_deployment_agent_id": "hybrid_deployment_agent_id",
  "destination_configuration": {
    "virtual_warehouse": "virtual_warehouse"
  },
  "destination_schema_names": "FIVETRAN_NAMING",
  "external_secrets_manager_id": "esm_id",
  "config": {
    "bucket": "aws_region_code",
    "json_delivery_mode": "Packed | Unpacked",
    "prefix": "folder_path",
    "role_arn": "arn::your_role_arn",
    "schema": "schema_name",
    "table": "table_name"
  }
}

Config parameters

Name	Description
`bucket`	The name of the Kinesis bucket.
`json_delivery_mode`	Control how your JSON data is delivered into your destination
`prefix`	Folder path to the Kinesis files within the bucket.
`role_arn`	The Role ARN required for authentication.
`schema` (required)	Destination schema name. Schema name is permanent and cannot be changed after connection creation
`table` (required)	Destination table. Table is permanent and cannot be changed after connection creation

Authorization

There are two ways to authorize this connector type:

By specifying the values for the role_arn and bucket parameters in the request.

POST https://api.fivetran.com/v1/connections

{
  "service": "kinesis",
  "group_id": "group_id",
  "config": {
    "role_arn": "arn::your_role_arn",
    "bucket": "aws_region_code"
  }
}

By using the Connect Card or the Fivetran dashboard.