Data Bridges

Data Bridge Name

Cloud Provider: AWS

Network Transport: The selected cloud provider determines the private connectivity service. When you select AWS, Alteryx uses AWS PrivateLink. This value is populated automatically and can’t be edited.

Region: The region must match your VPC region and should default to the region you are currently in.

Availability Zone ID: The Availability Zone ID identifies the AWS availability zones where this endpoint is available.

Port: The port is used to connect the Data Bridge to Alteryx. The default is 9001.

Download the Bridge Client binary file from the Licensing Portal.

Import Bridge Client to EC2 with AWS Secret Access:

In AWS, create an EC2 instance using the Amazon Linux 2023 AMI that can connect to your private data source and has permission to read or write secrets in AWS Secrets Manager. For more information on how to create an EC2 instance, refer to the AWS documentation Get started with Amazon EC2.

Then, import the Bridge Client into /home/ec2-user directory at /.

Make the binary executable. The Bridge Client binary must have executable permissions before it can be run.

chmod +x bridge-client

Save configuration snippet to a file:

Copy and paste the snippet into a configuration file named bridge-client-config.json inside of the /home/ec2-user directory, which will be referenced by the Bridge Client.

Example:

{
  "logging": {
    "logLevel": "info",
    "logFormat": "json"
  },
  "bootstrap" : {
    "storageType": "secretsManager",
    "secretName": "<Name of the AWS Secrets Manager secret where the Bridge Client will store its private key. The Bridge Client will create and populate this secret automatically.>"
  },
  "libp2pPort": 9001,
  "libp2pBindIP": "<Private IPv4 address of the EC2 Instance>",
  "resourceFile": "/home/ec2-user/resources.json"
}

{
  ...
  "bootstrap": {
    "storageType": "aws",
    "secretName": "<Name of the AWS Secrets Manager secret where the Bridge Client will store its private key. The Bridge Client will create and populate this secret automatically.>",
    "aws": {
      "kmsKeyID": "arn:aws:kms:<region>:<account-id>:key/<key-id>"
    }
  }
  ...
}

{
  "Effect": "Allow",
  "Action": [
    "kms:Decrypt",
    "kms:Encrypt",
    "kms:GenerateDataKey",
    "kms:DescribeKey"
  ],
  "Resource": "arn:aws:kms:<region>:<account-id>:key/<key-id>",
  "Condition": {
    "StringEquals": {
      "kms:ViaService": "secretsmanager.<region>.amazonaws.com"
    }
  }

Create the resources.json file:

Create a file named resources.json in the /home/ec2-user directory. This file is required for the Bridge Client to start and manage resources at runtime.

The file must contain an empty JSON object ({}) and must not be blank.

{}

Run Bridge Client as a process:

Setup PrivateLink Endpoint Service:

Once the installation is complete, set up the PrivateLink Endpoint Service in your VPC.

The Endpoint Service Name

The Bridge Client peer ID recorded in step 2.

Select a Workspace from the dropdown. Only workspaces with Workspace Execution enabled are shown. Then select Next.

The IAM role is displayed. Copy and paste it to the Allow Principals list in your private VPC. For more information on configuring the AWS IAM Identity Center, refer to Getting started with IAM Identity Center or Configuring IAM Identity Center authentication with the AWS CLI.

Once done, select Confirm to trigger a creation of a PrivateLink Endpoint.

Go to the PrivateLink service in your AWS Console, then accept the private endpoint connection from the Alteryx account. Make sure the status is green before you continue.

Go to the 3-dot menu next to the workspace entry, then select Test Connection for that workspace. A toast message appears in the lower-left corner and shows the test status and result.

Data Bridge Name

Cloud Provider: Google Cloud, if shown.

Network Transport: The selected cloud provider determines the private connectivity service. When you select GCP, Alteryx uses Private Service Connect. This value is populated automatically and can’t be edited.

Region: The region must match the region where you will deploy the Bridge Client and Private Service Connect service attachment.

Availability Zone ID: The Availability Zone ID identifies the AWS availability zones where this endpoint is available.

Port: The port used to connect the Data Bridge to Alteryx. The default is 9001.

Download the Bridge Client binary file from the Licensing Portal.

Create a Compute Engine VM that can connect to your private data source. The VM should be deployed without a public IP address unless your organization explicitly requires one.

Attach a service account that can access the configured Google Cloud Secret Manager secret.

Make sure the VM has Cloud API access scopes that allow Secret Manager calls.

Import Bridge Client to the VM:

Import the Bridge Client binary to the VM, for example under /etc/ayx/bridge-client directory.

Make the binary executable. The Bridge Client binary must have executable permissions before it can be run.

sudo chmod +x /etc/ayx/bridge-client/bridge-client

Save configuration snippet to a file:

Copy and paste the snippet into a configuration file named bridge-client-config.json inside of the /etc/ayx/bridge-client directory.

Example:

{
  "logging": {
    "logLevel": "info",
    "logFormat": "json"
  },
  "bootstrap": {
    "storageType": "gcp",
    "secretName": "<Name of the GCP Secret Manager secret where the Bridge Client will store its private key>",
    "gcp": {
      "projectID": "<GCP project ID that owns the Secret Manager secret>"
    }
  },
  "libp2pPort": 9001,
  "peerLibp2pPort": 9001,
  "libp2pBindIP": "<Internal TCP load balancer forwarding rule IP>",
  "resourceFile": "/etc/ayx/bridge-client/resources.json",
  "stateStorage": {
    "type": "file",
    "path": "/etc/ayx/bridge-client/resources.json"
  },
  "rest": {
    "port": "8081"
  }
}

{
  ...
  "bootstrap": {
    "storageType": "gcp",
    "secretName": "<Name of the GCP Secret Manager secret where the Bridge Client will store its private key.>",
    "gcp": {
      "projectID": "<GCP project ID that owns the Secret Manager secret>",
      "kmsKeyID": "projects/<kms-project-id>/locations/<location>/keyRings/<key-ring>/cryptoKeys/<key-name>"
    }
  }
  ...
}

gcloud kms keys add-iam-policy-binding "<key-name>" \
  --project "<kms-project-id>" \
  --location "<location>" \
  --keyring "<key-ring>" \
  --member "serviceAccount:service-<secret-manager-project-number>@gcp-sa-secretmanager.iam.gserviceaccount.com" \
  --role "roles/cloudkms.cryptoKeyEncrypterDecrypter"

Create the resources.json file:

Create a file named resources.json in the /etc/ayx/bridge-client directory. This file is required for the Bridge Client to start and manage resources at runtime.

The file must contain an empty JSON object ({}) and must not be blank.

{}

Run Bridge Client as a process:

Set up the internal TCP load balancer:

In Google Cloud, create these resources in the same region as the Bridge Client deployment.

Configure firewall rules to allow:

Create a PSC NAT subnet:

Create a dedicated subnet in the producer VPC with purpose PRIVATE_SERVICE_CONNECT.

The PSC NAT subnet...

Create the Private Service Connect service attachment:

Create a PSC service attachment that points to the internal TCP load balancer forwarding rule.

Use the service attachment URI from the selected Google Cloud region. Example:

projects/PROJECT_ID/regions/REGION_ID/serviceAttachments/bridge-client-psc

For stricter access control, configure the service attachment to accept connections manually and add the Alteryx-provided consumer project, VPC network, or endpoint to the consumer accept list.

Leave PROXY protocol disabled unless Alteryx explicitly instructs you to enable it for Bridge Client.

After the service attachment is created, record the service attachment URI.

The PSC service attachment URI

The Bridge Client peer ID recorded from the Bridge Client logs.

Select a Workspace from the dropdown. Only workspaces with Workspace Execution enabled are shown. Then select Next.

Copy the Alteryx-provided GCP consumer identifier. Depending on the configuration, this might be a consumer project, VPC network, or PSC endpoint identifier.

In Google Cloud, update the PSC service attachment consumer accept list or approve the pending connection request.

If the test fails, the setup might not be complete and the remaining steps won’t work.

After the connection test succeeds, you can create a new data source network mapping.