Argo Workflows · Schema

github.com.argoproj.argo_events.pkg.apis.events.v1alpha1.SQSEventSource

github.com.argoproj.argo_events.pkg.apis.events.v1alpha1.SQSEventSource schema from Argo Workflows API

CNCFContainersData ProcessingKubernetesMachine LearningOpen SourceWorkflow Engine

Properties

Name Type Description
accessKey object
dlq boolean
endpoint string
filter object
jsonBody boolean
metadata object
queue string
queueAccountId string
region string
roleARN string
secretKey object
sessionToken object
waitTimeSeconds string WaitTimeSeconds is The duration (in seconds) for which the call waits for a message to arrive in the queue before returning.
View JSON Schema on GitHub

JSON Schema

argo-workflows-github-com-argoproj-argo-events-pkg-apis-events-v1alpha1-sqs-event-source-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/argo-workflows/refs/heads/main/json-schema/argo-workflows-github-com-argoproj-argo-events-pkg-apis-events-v1alpha1-sqs-event-source-schema.json",
  "title": "github.com.argoproj.argo_events.pkg.apis.events.v1alpha1.SQSEventSource",
  "description": "github.com.argoproj.argo_events.pkg.apis.events.v1alpha1.SQSEventSource schema from Argo Workflows API",
  "type": "object",
  "properties": {
    "accessKey": {
      "title": "AccessKey refers K8s secret containing aws access key",
      "$ref": "#/definitions/io.k8s.api.core.v1.SecretKeySelector"
    },
    "dlq": {
      "type": "boolean",
      "title": "DLQ specifies if a dead-letter queue is configured for messages that can't be processed successfully.\nIf set to true, messages with invalid payload won't be acknowledged to allow to forward them farther to the dead-letter queue.\nThe default value is false.\n+optional"
    },
    "endpoint": {
      "type": "string",
      "title": "Endpoint configures connection to a specific SQS endpoint instead of Amazons servers\n+optional"
    },
    "filter": {
      "title": "Filter\n+optional",
      "$ref": "#/definitions/github.com.argoproj.argo_events.pkg.apis.events.v1alpha1.EventSourceFilter"
    },
    "jsonBody": {
      "type": "boolean",
      "title": "JSONBody specifies that all event body payload coming from this\nsource will be JSON\n+optional"
    },
    "metadata": {
      "type": "object",
      "title": "Metadata holds the user defined metadata which will passed along the event payload.\n+optional",
      "additionalProperties": {
        "type": "string"
      }
    },
    "queue": {
      "type": "string",
      "title": "Queue is AWS SQS queue to listen to for messages"
    },
    "queueAccountId": {
      "type": "string",
      "title": "QueueAccountID is the ID of the account that created the queue to monitor\n+optional"
    },
    "region": {
      "type": "string",
      "title": "Region is AWS region"
    },
    "roleARN": {
      "type": "string",
      "title": "RoleARN is the Amazon Resource Name (ARN) of the role to assume.\n+optional"
    },
    "secretKey": {
      "title": "SecretKey refers K8s secret containing aws secret key",
      "$ref": "#/definitions/io.k8s.api.core.v1.SecretKeySelector"
    },
    "sessionToken": {
      "title": "SessionToken refers to K8s secret containing AWS temporary credentials(STS) session token\n+optional",
      "$ref": "#/definitions/io.k8s.api.core.v1.SecretKeySelector"
    },
    "waitTimeSeconds": {
      "description": "WaitTimeSeconds is The duration (in seconds) for which the call waits for a message to arrive\nin the queue before returning.",
      "type": "string"
    }
  }
}