Skip to main content
Properties for Amazon Redshift connections are specified in the properties object when creating or updating a connection. All properties are nested within the connection request body.

​
Properties

​
server
string
required
Redshift cluster endpoint hostname or fully qualified domain name.Example: cluster-name.us-east-1.redshift.amazonaws.com
​
port
string
required
Port number for the Redshift cluster connection.Typically 5439 for Redshift database connections.
​
username
string
required
Username for authenticating to the Redshift cluster.
​
password
object
required
Reference to a Prophecy secret containing the Redshift password.
  • When using the create connection API, the secret must be stored in Prophecy before creating the connection.
  • When using the create fabric API, replace this whole object with the string {{SECRET}}, which references the secret being created in parallel to the connection.
​
database
string
required
Name of the Redshift database to connect to.
​
kgConfig
object
Knowledge graph configuration settings for the connection. See the Knowledge graph indexer properties for more information.