Integrations
An integration is a connection configuration for an external service (REST API or AWS) that scripts can use to consume data or invoke services.
What it is used for
- Connect scripts with REST APIs or AWS services (S3, Athena)
- Centralize credentials and connection parameters per account
- Allow scripts to access external data or send results to the cloud
Configuration
API type
| Field | Description |
|---|---|
| Name | Unique integration identifier within the account |
| URL | API address |
| Authentication type | No authorization, Bearer, Basic, or Authorization |
| Headers | Key-value pairs of HTTP headers |
AWS type
| Field | Description |
|---|---|
| Name | Unique integration identifier within the account |
| AWS service | S3 or Athena |
| Region | AWS region |
| Access key | Access Key ID |
| Secret key | Secret Access Key |
| S3: Bucket | Bucket name (S3 only) |
| Athena: s3_output | S3 output configuration (Athena only) |
Usage
Scripts that use an integration receive its configuration (URL, headers, auth, or AWS credentials) at runtime. Sensitive credentials are stored encrypted and decrypted when building the configuration for the script.
Relationship with other modules
- Belongs to an Account
- Scripts (Ruby or Python) can reference an integration by name
- Access to integration configuration is controlled by Roles