Ultimate

Connect AWS Redshift to Experience Platform using the Flow Service API

Read this guide to learn how you can connect your AWS Redshift source account to Adobe Experience Platform using the Flow Service API.

Getting started

This guide requires a working understanding of the following components of Adobe Experience Platform:

• Sources: Experience Platform allows data to be ingested from various sources while providing you with the ability to structure, label, and enhance incoming data using Platform services.
• Sandboxes: Experience Platform provides virtual sandboxes which partition a single Platform instance into separate virtual environments to help develop and evolve digital experience applications.

Using Platform APIs

For information on how to successfully make calls to Platform APIs, see the guide on getting started with Platform APIs.

Connect AWS Redshift to Experience Platform on Azure

Read the steps below for information on how to connect your AWS Redshift source to Experience Platform on Azure.

Gather required credentials

In order for Flow Service to connect with AWS Redshift, you must provide the following connection properties:

| Credential | Description |
| server | The server name of your AWS Redshift instance. |
| port | The TCP port that a AWS Redshift server uses to listen for client connections. |
| username | The username associated with your AWS Redshift account. |
| password | The password that corresponds with the user account. |
| database | The AWS Redshift database where data is to be fetched from. |
| 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 AWS Redshift is 3416976c-a9ca-4bba-901a-1f08f66978ff. |

For more information about getting started, refer to this AWS Redshift document.

Create a base connection for AWS Redshift on Experience Platform on Azure [#azure-base]

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 AWS Redshift authentication credentials as part of the request parameters.

API format

POST /connections

Request

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": "AWS-redshift base connection",
      "description": "base connection for AWS-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"
      }
  }'

Response

{
    "id": "373e88fc-43da-4e3c-be88-fc43da3e3c0f",
    "etag": "\"1700ce7b-0000-0200-0000-5e3b405e0000\""
}

Connect AWS Redshift to Experience Platform on AWS Web Services (AWS)

Read the steps below for information on how to connect your AWS Redshift source to Experience Platform on AWS.

Create a base connection for AWS Redshift on Experience Platform on AWS

API format

POST /connections

Request

The following request creates a base connection for AWS 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": "AWS Redshift base connection for Experience Platform on AWS",
      "description": "AWS Redshift base connection for Experience Platform on AWS",
      "auth": {
          "specName": "Basic Authentication",
          "params": {
              "server": "{SERVER}",
              "port": "5439",
              "username": "{USERNAME}",
              "password": "{PASSWORD}",
              "database": "{DATABASE}",
              "schema": "{SCHEMA}"
          }
      },
      "connectionSpec": {
          "id": "3416976c-a9ca-4bba-901a-1f08f66978ff",
          "version": "1.0"
      }
  }'

Response

A successful response returns details of the newly created connection, including its unique identifier (id). This ID is required to explore your storage in the next tutorial.

{
    "id": "4cb0c374-d3bb-4557-b139-5712880adc55",
    "etag": "\"1700d77b-0000-0200-0000-5e3b41a10000\""
}

Next steps

By following this tutorial, you have created an AWS Redshift base connection using the Flow Service API. You can use this base connection ID in the following tutorials:

• Explore the structure and contents of your data tables using the Flow Service API
• Create a dataflow to bring database data to Platform using the Flow Service API