Aurora PostgreSQL API Configuration

Request

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

{
  "group_id": "group_id",
  "service": "aurora_postgres_warehouse",
  "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": {
    "connection_type": "Directly | PrivateLink | SshTunnel | ProxyAgent",
    "external_id": "external-id-12345",
    "always_encrypted": true,
    "tunnel_user": "Fivetran",
    "tunnel_port": 564,
    "database": "production",
    "password": "fresh_air_267@83",
    "auth_method": "PASSWORD | AWS_IAM",
    "role_arn": "arn:aws:iam::123456789012:role/MyRole",
    "port": 443,
    "host": "87a8z-3da23-3da8d-cloud.sql.com",
    "tunnel_host": "ssh.server.com",
    "aws_region_code": "us-east-1",
    "user": "admin"
  }
}

Config parameters

Name	Description
`connection_type`	Connection method. Default value: `Directly`.
`external_id`	AWS external ID for authentication. Required when `auth_method` is set to `AWS_IAM`.
`always_encrypted`	Specifies whether TLS is required. Must be populated if `connection_type` is set to `SshTunnel`.
`tunnel_user`	SSH user name. Must be populated if `connection_type` is set to `SshTunnel`.
`tunnel_port`	SSH server port name. Must be populated if `connection_type` is set to `SshTunnel`.
`database`	Database name
`password`	Database user password
`auth_method`	Authentication method. Default value: `PASSWORD`.
`role_arn`	AWS IAM role ARN for authentication. Required when `auth_method` is set to `AWS_IAM`.
`port`	Server port number
`host`	Server name
`tunnel_host`	SSH server name. Must be populated if `connection_type` is set to `SshTunnel`.
`aws_region_code`	AWS region where the Aurora cluster is located. Required when `auth_method` is set to `AWS_IAM`.
`user`	Database user name