Argo Workflows · JSON Structure

Argo Workflows Github Com Argoproj Argo Events Pkg Apis Events V1Alpha1 Sqs Event Source Structure

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

Type: object Properties: 13
CNCFContainersData ProcessingKubernetesMachine LearningOpen SourceWorkflow Engine

github.com.argoproj.argo_events.pkg.apis.events.v1alpha1.SQSEventSource is a JSON Structure definition published by Argo Workflows, describing 13 properties. It conforms to the https://json-structure.org/meta/core/v0/# meta-schema.

Properties

accessKey dlq endpoint filter jsonBody metadata queue queueAccountId region roleARN secretKey sessionToken waitTimeSeconds

Meta-schema: https://json-structure.org/meta/core/v0/#

JSON Structure

Raw ↑
{
  "$schema": "https://json-structure.org/meta/core/v0/#",
  "$id": "https://raw.githubusercontent.com/api-evangelist/argo-workflows/refs/heads/main/json-structure/argo-workflows-github-com-argoproj-argo-events-pkg-apis-events-v1alpha1-sqs-event-source-structure.json",
  "name": "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": {
      "name": "AccessKey refers K8s secret containing aws access key",
      "$ref": "#/definitions/io.k8s.api.core.v1.SecretKeySelector"
    },
    "dlq": {
      "type": "boolean",
      "name": "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",
      "name": "Endpoint configures connection to a specific SQS endpoint instead of Amazons servers\n+optional"
    },
    "filter": {
      "name": "Filter\n+optional",
      "$ref": "#/definitions/github.com.argoproj.argo_events.pkg.apis.events.v1alpha1.EventSourceFilter"
    },
    "jsonBody": {
      "type": "boolean",
      "name": "JSONBody specifies that all event body payload coming from this\nsource will be JSON\n+optional"
    },
    "metadata": {
      "type": "object",
      "name": "Metadata holds the user defined metadata which will passed along the event payload.\n+optional",
      "additionalProperties": {
        "type": "string"
      }
    },
    "queue": {
      "type": "string",
      "name": "Queue is AWS SQS queue to listen to for messages"
    },
    "queueAccountId": {
      "type": "string",
      "name": "QueueAccountID is the ID of the account that created the queue to monitor\n+optional"
    },
    "region": {
      "type": "string",
      "name": "Region is AWS region"
    },
    "roleARN": {
      "type": "string",
      "name": "RoleARN is the Amazon Resource Name (ARN) of the role to assume.\n+optional"
    },
    "secretKey": {
      "name": "SecretKey refers K8s secret containing aws secret key",
      "$ref": "#/definitions/io.k8s.api.core.v1.SecretKeySelector"
    },
    "sessionToken": {
      "name": "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"
    }
  }
}