The Amazon Redshift source is available in the sources catalog to users who have purchased Real-Time Customer Data Platform Ultimate.
A base connection represents the authenticated connection between a source and Adobe Experience Platform.
This tutorial walks you through the steps to create a base connection for Amazon Redshift using the Flow Service API.
This guide requires a working understanding of the following components of Adobe Experience Platform:
The following sections provide additional information that you will need to know in order to successfully connect to Amazon Redshift using the Flow Service API.
In order for Flow Service to connect with Amazon Redshift, you must provide the following connection properties:
Credential | Description |
---|---|
server |
The server associated with your Amazon Redshift account. |
port |
The TCP port that a Amazon Redshift server uses to listen for client connections. |
username |
The username associated with your Amazon Redshift account. |
password |
The password associated with your Amazon Redshift account. |
database |
The Amazon Redshift database you are accessing. |
connectionSpec.id |
The connection specification returns a source’s connector properties, including authentication specifications related to creating the base and source connections. The connection specification ID for Amazon Redshift is 3416976c-a9ca-4bba-901a-1f08f66978ff . |
For more information about getting started, refer to this Amazon Redshift document.
For information on how to successfully make calls to Platform APIs, see the guide on getting started with Platform APIs.
The default encoding standard for Redshift is Unicode. This cannot be changed.
A base connection retains information between your source and Platform, including your source’s authentication credentials, the current state of the connection, and your unique base connection ID. The base connection ID allows you to explore and navigate files from within your source and identify the specific items that you want to ingest, including information regarding their data types and formats.
To create a base connection ID, make a POST request to the /connections
endpoint while providing your Amazon Redshift authentication credentials as part of the request parameters.
API format
POST /connections
Request
The following request creates a base connection for Amazon Redshift:
curl -X POST \
'https://platform.adobe.io/data/foundation/flowservice/connections' \
-H 'Authorization: Bearer {ACCESS_TOKEN}' \
-H 'x-api-key: {API_KEY}' \
-H 'x-gw-ims-org-id: {ORG_ID}' \
-H 'x-sandbox-name: {SANDBOX_NAME}' \
-H 'Content-Type: application/json' \
-d '{
"name": "amazon-redshift base connection",
"description": "base connection for amazon-redshift,
"auth": {
"specName": "Basic Authentication",
"params": {
"server": "{SERVER}",
"port": "{PORT},
"username": "{USERNAME}",
"password": "{PASSWORD}",
"database": "{DATABASE}"
}
},
"connectionSpec": {
"id": "3416976c-a9ca-4bba-901a-1f08f66978ff",
"version": "1.0"
}
}'
Property | Description |
---|---|
auth.params.server |
Your Amazon Redshift server. |
auth.params.port |
The TCP port that the Amazon Redshift server uses to listen for client connections. |
auth.params.database |
The database associated with your Amazon Redshift account. |
auth.params.password |
The password associated with your Amazon Redshift account. |
auth.params.username |
The username associated with your Amazon Redshift account. |
connectionSpec.id |
The Amazon Redshift connection specification ID: 3416976c-a9ca-4bba-901a-1f08f66978ff |
Response
A successful response returns the newly created connection, including its unique identifier (id
). This ID is required to explore your data in the next tutorial.
{
"id": "373e88fc-43da-4e3c-be88-fc43da3e3c0f",
"etag": "\"1700ce7b-0000-0200-0000-5e3b405e0000\""
}
By following this tutorial, you have created an Amazon Redshift base connection using the Flow Service API. You can use this base connection ID in the following tutorials: