AWS Lambda API Configuration

Fivetran users who signed up on or after July 22, 2025, no longer have access to Function connections. Older Fivetran users can continue to create and use Function connections as before. All our users can use Connector SDK to build custom connectors. Connector SDK provides a streamlined development experience, and we'll host your custom connector for you.

Request

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

{
  "group_id": "group_id",
  "service": "aws_lambda",
  "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
  },
  "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"
  },
  "config": {
    "bucket": "bucket",
    "sync_method": "CLOUD_STORAGE | DIRECT",
    "role_arn": "arn::your_role_arn",
    "connection_type": "Directly | PrivateLink | SshTunnel | ProxyAgent",
    "custom_payloads": [
      {
        "value": "string",
        "key": "string"
      }
    ],
    "secrets_list": [
      {
        "value": "apiSecret",
        "key": "apiKey"
      }
    ],
    "function": "function_name",
    "region": "us-east-1",
    "secrets": "string",
    "is_private_link_required": true,
    "schema": "schema_name"
  }
}

Config parameters

Name	Description
`bucket`	S3 Bucket
`sync_method`	Sync Method
`role_arn`	The Role ARN required for authentication.
`connection_type`	Connection method. Default value: `Directly`.
`custom_payloads`	The list of key-value pairs that can be used to specify custom information to the function at runtime.
`custom_payloads[0].value`	Payload Value
`custom_payloads[0].key`	Payload Key
`secrets_list`	List of Secrets that should be passed to the function at runtime.
`secrets_list[0].value`	Secret Value.
`secrets_list[0].key`	Secret Key.
`function`	The name of your AWS Lambda Function.
`region`	The AWS region code for the DynamoDB instance.
`secrets`	The secrets that should be passed to the function at runtime.
`is_private_link_required`	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.
`schema` (required)	Destination schema name. Schema name 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 function, role_arn and secrets_list parameters in the request.

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

{
  "service": "aws_lambda",
  "group_id": "group_id",
  "config": {
    "function": "function_name",
    "role_arn": "arn::your_role_arn",
    "secrets_list": [
      {
        "value": "apiSecret",
        "key": "apiKey"
      }
    ]
  }
}

By using the Connect Card or the Fivetran dashboard.