Connector file
| File name | Resource |
|---|---|
*.connector.yaml | Connector |
GitOps file for a single space.
Identity
originKey: GitOps identity of the resource this file owns. The same value as the API's originKey.id: Server-assigned id. Absent until the resource exists.
Fields
| Field | Type | Required | Description |
|---|---|---|---|
config | object (four variants) | Required | |
config[ObjectStorageConnector].bucket | string | Required | Pattern: ^(?!xn--|sthree-|amzn-s3-demo-)(?!.*(?:-s3alias|--x-s3|--ol-s3|--table-s3)$)[a-z0-9][a-z0-9-]{1,61}[a-z0-9]$. At most 63 characters. |
config[ObjectStorageConnector].initialLookbackDays | integer | Optional | Greater than 0. Defaults to 14. |
config[ObjectStorageConnector].manageBucketNotifications | boolean | Optional | Whether the data plane configures S3 event notifications on the bucket. Defaults to true when absent. When false the data plane ingests via periodic scans only. Defaults to true. |
config[ObjectStorageConnector].objectStore | object | Required | |
config[ObjectStorageConnector].objectStore.auth | object | Required | |
config[ObjectStorageConnector].objectStore.auth.roleArn | string | Optional | Pattern: ^$|^(?:\w+:){3}([^:]*):(\d{12}):role\/(.*)$. Defaults to . |
config[ObjectStorageConnector].prefix | string | Required | |
config[ObjectStorageConnector].region | string | Optional | Defaults to not-used. |
config[ObjectStorageConnector].scanIntervalMinutes | integer | Optional | How often the data plane rescans the bucket, in minutes. Defaults to 1440 (daily) when absent. The scan is a safety net for objects that arrive without an event notification. Minimum 5. Defaults to 1440. |
config[ObjectStorageConnector].type | string | Required | Always ObjectStorageConnector. |
config[ApiPollingConnector].connectorKind | string | Required | Catalog connector kind (e.g. "google-workspace", "gcp-pubsub") or "custom" for a customer ECR image. Must not be empty. |
config[ApiPollingConnector].credentialIds | map of string | Optional | |
config[ApiPollingConnector].ecrImageUrl | string | Optional | ECR image URL for a custom connector Lambda container. Pattern: ^[0-9]+\.dkr\.ecr\.[a-z0-9-]+\.amazonaws\.com\/.+$. Must not be empty. |
config[ApiPollingConnector].initialLookbackDays | integer | Optional | Greater than 0. |
config[ApiPollingConnector].intervalMinutes | integer | Required | Minimum 1. |
config[ApiPollingConnector].settings | object | Required | |
config[ApiPollingConnector].type | string | Required | Always ApiPollingConnector. |
config[StreamingConnector].connectorKind | string | Required | Catalog connector kind (e.g. "google-workspace", "gcp-pubsub") or "custom" for a customer ECR image. Must not be empty. |
config[StreamingConnector].credentialIds | map of string | Optional | |
config[StreamingConnector].ecrImageUrl | string | Optional | ECR image URL for a custom connector Lambda container. Pattern: ^[0-9]+\.dkr\.ecr\.[a-z0-9-]+\.amazonaws\.com\/.+$. Must not be empty. |
config[StreamingConnector].settings | object | Required | |
config[StreamingConnector].type | string | Required | Always StreamingConnector. |
config[HttpSourceConnector].authMode | enum | Required | One of bearer, presigned, hmac. |
config[HttpSourceConnector].credentialId | string | Optional | Pattern: ^CRD_[A-Z0-9]{1,7}$. |
config[HttpSourceConnector].type | string | Required | Always HttpSourceConnector. |
datasetKind | enum | Optional | One of event, state. |
deploy | boolean | Required | |
id | string | Optional | Server-assigned id. Absent until the resource exists. Pattern: ^CON_[A-Z0-9]{1,7}$. |
name | string | Required | Pattern: ^connectors?\.([a-zA-Z_][a-zA-Z0-9_]{0,255})(\.([a-zA-Z_][a-zA-Z0-9_]{0,255}))?$. |
originKey | string | Required | GitOps identity of the resource this file owns. The same value as the API's originKey. Pattern: ^(?!perpetual:)[a-z][a-z0-9-]{0,31}:[A-Za-z0-9._~\-/:@]{1,256}$. |
spaceId | string | Required | Space the resource belongs to. Pattern: ^SPC_[A-Z0-9]{1,7}$. |
type | enum | Required | One of ObjectStorageConnector, ApiPollingConnector, StreamingConnector, HttpSourceConnector. |
Related
Perpetual CLI 0.5.0