Before you start
To get the most out of this guide, you will need to:- Either create an account in our managed instance or deploy your own hoop.dev instance
- You must be your account administrator to perform the following commands
Requirements
This connection uses a wrapper script available in the hoophq/hoopdev image called ecs-exec.sh. This script requires the following permissions to work:- ecs:ListTasks
- ecs:DescribeTasks
- ecs:ExecuteCommand
Features
The table below outlines the features available for this type of connection.- Native - This refers to when a database client connects through a specific protocol, such as an IDE or client libraries through
hoop connect <connection-name>. - One Off - This term refers to accessing this connection from hoop web panel.
| Feature | Native | One Off | Description |
|---|---|---|---|
| TLS Termination Proxy | The local proxy terminates the connection with TLS, enabling the connection with the remote server to be TLS encrypted. | ||
| Audit | The gateway stores and audits the queries being issued by the client. | ||
| Data Masking (Google DLP) | A policy can be enabled to mask sensitive fields dynamically when performing queries in the database. | ||
| Data Masking (MS Presidio) | A policy can be enabled to mask sensitive fields dynamically when performing queries in the database. | ||
| Credentials Offload | The user authenticates via SSO instead of using database credentials. | ||
| Interactive Access | Interactive access is available when using an IDE or connecting via a terminal to perform analysis exploration. |
Configuration
| Name | Type | Required | Description |
|---|---|---|---|
| CLUSTER_NAME | env-var | yes | The name or arn of the ECS Cluster |
| SERVICE_NAME | env-var | yes | The name of the service on ECS |
| CONTAINER | env-var | yes | The name of the container defaults to the first one. |
| AWS_ACCESS_KEY_ID | env-var | yes | The access key credential |
| AWS_SECRET_ACCESS_KEY | env-var | yes | The secret key credential |
| AWS_DEFAULT_REGION | env-var | yes | The AWS region |