Redshift API Configuration
Request
POST https://api.fivetran.com/v1/destinations
{
"group_id": "group_id",
"service": "redshift",
"region": "GCP_US_WEST1",
"time_zone_offset": "+3",
"trust_certificates": true,
"trust_fingerprints": true,
"run_setup_tests": true,
"daylight_saving_time_enabled": true,
"hybrid_deployment_agent_id": "hybrid_deployment_agent_id",
"private_link_id": "private_link_id",
"networking_method": "Directly",
"proxy_agent_id": "proxy_agent_id",
"config": {
"auth_type": "PASSWORD | IAM",
"connection_type": "Directly | PrivateLink | SshTunnel",
"cluster_region": "us-east-1",
"aws_secret_access_key": "string",
"external_id": "string",
"always_encrypted": true,
"tunnel_user": "Fivetran",
"bucket": "string",
"tunnel_port": 564,
"cluster_id": "clu5734-id",
"database": "production",
"password": "fresh_air_267@83",
"aws_access_key_id": "string",
"enable_super_type": true,
"role_arn": "arn",
"bucket_region": "string",
"port": 443,
"host": "87a8z-3da23-3da8d-cloud.sql.com",
"tunnel_host": "ssh.server.com",
"is_redshift_serverless": true,
"user": "admin"
}
}
Config parameters
Name | Description |
---|---|
auth_type | Authentication type. Default value: PASSWORD . |
connection_type | Connection method. Default value: Directly . |
cluster_region | Cluster region. Must be populated if connection_type is set to SshTunnel and auth_type is set to IAM . |
aws_secret_access_key | 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. |
external_id | Fivetran generated External ID |
always_encrypted | Require TLS through Tunnel |
tunnel_user | SSH user name. Must be populated if connection_type is set to SshTunnel . |
bucket | The name of the storage bucket you want to use to stage your data. Use this parameter only if you are using Hybrid Deployment. |
tunnel_port | SSH server port name. Must be populated if connection_type is set to SshTunnel . |
cluster_id | Cluster ID. Must be populated if connection_type is set to SshTunnel and auth_type is set to IAM . |
database | Database name |
password | Database user password. Required if authentication type is PASSWORD . |
aws_access_key_id | 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. |
enable_super_type | Enable to convert JSON data type to SUPER |
role_arn | Role ARN with Redshift permissions. Required if authentication type is IAM . |
bucket_region | 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. |
port | Server port number |
host | Server name |
tunnel_host | SSH server name. Must be populated if connection_type is set to SshTunnel . |
is_redshift_serverless | Is your destination Redshift Serverless |
user | Database user name |